Skip to content

Commit 257b7f1

Browse files
authored
docs: refresh LoongSuite integration guides and fix util-genai standalone init (#159)
1 parent da4415e commit 257b7f1

27 files changed

Lines changed: 1190 additions & 382 deletions

File tree

CHANGELOG-loongsuite.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717
([#155](https://github.com/alibaba/loongsuite-python-agent/pull/155))
1818
- **`loongsuite-site-bootstrap`**: initialize .pth-based OTel auto-instrumentation package
1919
([#156](https://github.com/alibaba/loongsuite-python-agent/pull/156))
20+
- **Top-level docs**: add Chinese README (**`README-zh.md`**) translated from **`README.md`**.
21+
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/158))
2022

2123
### Changed
2224

2325
- **`instrumentation-loongsuite/*`**, **`loongsuite-distro`**, and **`util/opentelemetry-util-genai`**: `pyproject.toml` metadata and dependencies for standalone PyPI installs
2426
([#155](https://github.com/alibaba/loongsuite-python-agent/pull/155))
27+
- **`loongsuite-site-bootstrap`**, **`loongsuite-distro`** docs: update **`README.md`**.
28+
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/158))
2529

2630
## Version 0.2.0 (2026-03-12)
2731

README-zh.md

Lines changed: 549 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 426 additions & 183 deletions
Large diffs are not rendered by default.

instrumentation-loongsuite/loongsuite-instrumentation-agentscope/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2525
outermost wrapper
2626
([#153](https://github.com/alibaba/loongsuite-python-agent/pull/153))
2727

28+
### Changed
29+
30+
- Update README integration flow to align with the root recommended LoongSuite pattern using Option C (`pip install loongsuite-instrumentation-agentscope`) and `loongsuite-instrument`.
31+
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/159))
32+
2833
### Added
2934

3035
- Add ReAct step span instrumentation for ReAct agents

instrumentation-loongsuite/loongsuite-instrumentation-agentscope/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# OpenTelemetry AgentScope Instrumentation
1+
# LoongSuite AgentScope Instrumentation
22

3-
OpenTelemetry instrumentation for [AgentScope](https://github.com/agentscope-ai/agentscope) framework.
3+
LoongSuite instrumentation for [AgentScope](https://github.com/agentscope-ai/agentscope) framework.
44

55
## Features
66

@@ -13,24 +13,22 @@ OpenTelemetry instrumentation for [AgentScope](https://github.com/agentscope-ai/
1313
## Installation
1414

1515
```bash
16-
pip install opentelemetry-distro opentelemetry-exporter-otlp
17-
opentelemetry-bootstrap -a install
16+
# Step 1: install LoongSuite distro
17+
pip install loongsuite-distro
1818

19-
pip install agentscope
20-
21-
# Install this instrumentation
22-
pip install ./instrumentation-loongsuite/loongsuite-instrumentation-agentscope
19+
# Step 2 (Option C): install this instrumentation from PyPI
20+
pip install loongsuite-instrumentation-agentscope
2321

24-
# Note: This instrumentation uses ExtendedTelemetryHandler from opentelemetry-util-genai
25-
pip install ./util/opentelemetry-util-genai
22+
# Optional app dependency
23+
pip install agentscope
2624
```
2725

2826
## Usage
2927

3028
### Auto-instrumentation
3129

3230
```bash
33-
opentelemetry-instrument \
31+
loongsuite-instrument \
3432
--traces_exporter console \
3533
--metrics_exporter console \
3634
python your_agentscope_app.py
@@ -62,7 +60,7 @@ export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
6260
export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=<trace_endpoint>
6361
export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=<metrics_endpoint>
6462

65-
opentelemetry-instrument python your_app.py
63+
loongsuite-instrument python your_app.py
6664
```
6765

6866
### Content Capture

instrumentation-loongsuite/loongsuite-instrumentation-agno/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## Unreleased
99

10+
### Changed
11+
12+
- Update README integration flow to align with the root recommended LoongSuite pattern using Option A (`loongsuite-bootstrap -a install --latest`) for this package not yet on PyPI.
13+
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/159))
14+
1015
## Version 0.2.0 (2026-03-12)
1116

1217
There are no changelog entries for this release.

instrumentation-loongsuite/loongsuite-instrumentation-agno/README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# OpenTelemerty Agno Instrumentation
1+
# LoongSuite Agno Instrumentation
22

33
Agno Python Agent provides observability for Agno applications. This document provides examples of usage and results in the Agno instrumentation. For details on usage and installation of LoongSuite and Jaeger, please refer to [LoongSuite Documentation](https://github.com/alibaba/loongsuite-python-agent/blob/main/README.md).
44

55
## Installation
66

77
```shell
8-
git clone https://github.com/alibaba/loongsuite-python-agent.git
9-
pip install ./instrumentation-loongsuite/loongsuite-instrumentation-agno
8+
# Step 1: install LoongSuite distro
9+
pip install loongsuite-distro
10+
11+
# Step 2 (Option A): install instrumentations from LoongSuite release
12+
loongsuite-bootstrap -a install --latest
13+
# for specific version: loongsuite-bootstrap -a install --version X.Y.Z
1014
```
1115

1216
## RUN
@@ -40,23 +44,7 @@ agent.print_response(
4044

4145
### Collect Data
4246

43-
There are two ways to run the `demo.py` script with instrumentation:
44-
45-
### Option 1: Using OpenTelemetry
46-
47-
```shell
48-
export OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
49-
50-
opentelemetry-instrument \
51-
--exporter_otlp_protocol grpc \
52-
--traces_exporter otlp \
53-
--exporter_otlp_insecure true \
54-
--exporter_otlp_endpoint YOUR-END-POINT \
55-
--service_name demo \
56-
python demo.py
57-
```
58-
59-
### Option 2: Using Loongsuite
47+
Use LoongSuite recommended runtime:
6048

6149
```shell
6250
export OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true

instrumentation-loongsuite/loongsuite-instrumentation-crewai/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
- Adapt imports to `opentelemetry-util-genai` module layout change
1313
([#158](https://github.com/alibaba/loongsuite-python-agent/pull/158))
14+
- Update README integration flow to align with the root recommended LoongSuite pattern using Option C (`pip install loongsuite-instrumentation-crewai`) and `loongsuite-instrument`.
15+
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/159))
1416

1517
### Added
1618

instrumentation-loongsuite/loongsuite-instrumentation-crewai/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ This library provides automatic instrumentation for [CrewAI](https://www.crewai.
55
## Installation
66

77
```bash
8-
git clone https://github.com/alibaba/loongsuite-python-agent.git
9-
cd loongsuite-python-agent
10-
pip install ./instrumentation-loongsuite/loongsuite-instrumentation-crewai
8+
# Step 1: install LoongSuite distro
9+
pip install loongsuite-distro
10+
11+
# Step 2 (Option C): install this instrumentation from PyPI
12+
pip install loongsuite-instrumentation-crewai
1113
```
1214

1315
## Usage

instrumentation-loongsuite/loongsuite-instrumentation-dify/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## Unreleased
99

10+
### Changed
11+
12+
- Update README integration flow to align with the root recommended LoongSuite pattern using Option A (`loongsuite-bootstrap -a install --latest`) for this package not yet on PyPI.
13+
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/159))
14+
1015
## Version 0.2.0 (2026-03-12)
1116

1217
There are no changelog entries for this release.

0 commit comments

Comments
 (0)