Skip to content

Commit ba777b5

Browse files
Copilotralf0131
andauthored
Update README documentation with AgentScope Studio integration and reorganized framework list (#99)
* Update README: make Jaeger section optional and add AgentScope Studio section Change-Id: Ia89adef07971514e8667a6101c1b60dc4ca88895 Co-developed-by: Cursor <noreply@cursor.com> Co-authored-by: ralf0131 <4397305+ralf0131@users.noreply.github.com> * Add AgentScope data export configuration to AgentScope Studio section Change-Id: I038ee5920f8d33892d1b9163b6877a235803b711 Co-developed-by: Cursor <noreply@cursor.com> Co-authored-by: ralf0131 <4397305+ralf0131@users.noreply.github.com> * Fix service name consistency in AgentScope Studio configuration Change-Id: I36497b1c2c17a74b0702dc418e4f3c02dd460242 Co-developed-by: Cursor <noreply@cursor.com> Co-authored-by: ralf0131 <4397305+ralf0131@users.noreply.github.com> * Clarify endpoint URL usage in AgentScope Studio configuration Change-Id: I1e715fa5ee15533a87ca8b858734e23aefd6ddc2 Co-developed-by: Cursor <noreply@cursor.com> Co-authored-by: ralf0131 <4397305+ralf0131@users.noreply.github.com> * Add both command-line and environment variable examples for AgentScope Studio Change-Id: I2d54f077a3fdeafcf0c4e6d82fb3ebdb9f95a39b Co-developed-by: Cursor <noreply@cursor.com> Co-authored-by: ralf0131 <4397305+ralf0131@users.noreply.github.com> --------- Co-authored-by: Huxing Zhang <huxing.zhx@alibaba-inc.com> Co-authored-by: ralf0131 <4397305+ralf0131@users.noreply.github.com>
1 parent 87dddbc commit ba777b5

File tree

1 file changed

+55
-1
lines changed

1 file changed

+55
-1
lines changed

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ If everything is working correctly, you should see logs similar to th
144144
}
145145
```
146146

147-
### Forwarding OTLP Data to Jaeger via LoongCollector
147+
### (Optional) Forwarding OTLP Data to Jaeger via LoongCollector
148148

149149
#### Launch Jaeger
150150

@@ -221,6 +221,60 @@ Access the Jaeger UI to view the collected trace data. You should no
221221

222222
![image.png](docs/_assets/img/quickstart-results.png)
223223

224+
### Using AgentScope Studio to View Tracing Data
225+
226+
[AgentScope Studio](https://github.com/agentscope-ai/agentscope-studio) provides a web-based interface for visualizing and analyzing tracing data from AgentScope applications.
227+
228+
#### Installation
229+
230+
Install AgentScope Studio:
231+
232+
```shell
233+
pip install agentscope-studio
234+
```
235+
236+
#### Launch AgentScope Studio
237+
238+
Start the AgentScope Studio server:
239+
240+
```shell
241+
as_studio
242+
```
243+
244+
AgentScope Studio will start and display the OTLP endpoint URL (typically `http://127.0.0.1:31415`).
245+
246+
#### Export AgentScope Data to AgentScope Studio
247+
248+
Configure your AgentScope application to export telemetry data to AgentScope Studio using OTLP. Use the endpoint URL displayed by AgentScope Studio when it starts:
249+
250+
```shell
251+
loongsuite-instrument \
252+
--traces_exporter otlp \
253+
--metrics_exporter otlp \
254+
--exporter_otlp_protocol http/protobuf \
255+
--exporter_otlp_endpoint http://127.0.0.1:31415 \
256+
--service_name demo \
257+
python demo.py
258+
```
259+
260+
Alternatively, you can use environment variables:
261+
262+
```shell
263+
export OTEL_SERVICE_NAME=demo
264+
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
265+
export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://127.0.0.1:31415
266+
export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://127.0.0.1:31415
267+
268+
loongsuite-instrument \
269+
--traces_exporter otlp \
270+
--metrics_exporter otlp \
271+
python demo.py
272+
```
273+
274+
The web interface will display the collected traces and metrics, allowing you to view and analyze the tracing data from your AgentScope applications.
275+
276+
For more details, please refer to the [AgentScope Studio documentation](https://github.com/agentscope-ai/agentscope-studio).
277+
224278
## Community
225279

226280
We are looking forward to your feedback and suggestions. You can join

0 commit comments

Comments
 (0)