Skip to content

Commit cd13a1a

Browse files
committed
chore: Polish readme
1 parent 60187a7 commit cd13a1a

File tree

5 files changed

+19
-6
lines changed

5 files changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,21 @@ Loongsuite Python Agent is a key component of LoongSuite, Alibaba's unified obse
77
LoongSuite includes the following key components:
88
* [LoongCollector](https://github.com/alibaba/loongcollector): universal node agent, which prodivdes log collection, prometheus metric collection, and network and security collection capabilities based on eBPF.
99
* [LoongSuite Python Agent](https://github.com/alibaba/loongsuite-python-agent): a process agent providing instrumentaion for python applications.
10-
* [LoongSuite Go Agent](https://github.com/alibaba/opentelemetry-go-auto-instrumentation): a process agent for golang with compile time instrumentation.
10+
* [LoongSuite Go Agent](https://github.com/alibaba/loongsuite-go-agent): a process agent for golang with compile time instrumentation.
11+
* [LoongSuite Java Agent](https://github.com/alibaba/loongsuite-java-agent): a process agent for Java applications.
1112
* Other upcoming language agent.
1213

1314
Loongsuite Python Agent is also a customized distribution of upstream [OTel Python Agent](https://github.com/open-telemetry/opentelemetry-python-contrib), with enhanced support for popular AI agent framework.
1415
The implementation follows the latest GenAI [semantic conventions](https://github.com/open-telemetry/semantic-conventions).
1516

17+
## Supported AI Frameworks and components
18+
* [AgentScope](https://github.com/agentscope-ai/agentscope)
19+
* [Dify](https://github.com/langgenius/dify)
20+
* [LangChain](https://github.com/langchain-ai/langchain)
21+
* [MCP Client](https://github.com/modelcontextprotocol/python-sdk)
22+
* [Agno](https://github.com/agno-agi/agno)
23+
* [OpenAI](https://github.com/openai/openai-python)
24+
1625
## Quick start
1726

1827
LoongSuite Python Agent provides observability for Python applications. Taking [agentscope](https://github.com/modelscope/agentscope) as an example, this document demonstrates how to use OpenTelemetry to collect OTLP data and forward it via LoongCollector to Jaeger.
@@ -79,7 +88,7 @@ for _ in range(3):
7988
Run the `demo.py` script using OpenTelemetry
8089

8190
```shell
82-
opentelemetry-instrument \
91+
loongsuite-instrument \
8392

8493
--traces_exporter console \
8594

@@ -191,7 +200,7 @@ nohup ./loongcollector > stdout.log 2> stderr.log &
191200
### Run the Agentscope Example
192201

193202
```plaintext
194-
opentelemetry-instrument \
203+
loongsuite-instrument \
195204
196205
--exporter_otlp_protocol grpc \
197206
@@ -218,9 +227,13 @@ We are looking forward to your feedback and suggestions. You can join
218227
our [DingTalk user group](https://qr.dingtalk.com/action/joingroup?code=v1,k1,VaFSqbGiRY0iAL3GGd18DRWDyb1HpgOuyfDzsX3Drng=&_dt_no_comment=1&origin=11?) and [DingTalk developer group](https://qr.dingtalk.com/action/joingroup?code=v1,k1,mexukXI88tZ1uiuLYkKhdaETUx/K59ncyFFFG5Voe9s=&_dt_no_comment=1&origin=11?)
219228
to engage with us.
220229

221-
| User Group | Developer Group |
222-
|-------------------------|---------------------------|
223-
| <img src="docs/_assets/img/dingtalk-chat-group.jpg" height="150"> | <img src="docs/_assets/img/dev-group.jpg" height="150"> |
230+
| LoongCollector SIG | LoongSuite Python SIG |
231+
|----|----|
232+
| <img src="docs/_assets/img/loongcollector-sig-dingtalk.jpg" height="150"> | <img src="docs/_assets/img/loongsuite-python-sig-dingtalk.jpg" height="150"> |
233+
234+
| LoongCollector Go SIG | LoongSuite Java SIG |
235+
|----|----|
236+
| <img src="docs/_assets/img/loongsuite-go-sig-dingtalk.png" height="150"> | <img src="docs/_assets/img/loongsuite-java-sig-dingtalk.jpg" height="150"> |
224237

225238
## Resoures
226239
* AgentScope: https://github.com/modelscope/agentscope
File renamed without changes.
167 KB
Loading
104 KB
Loading

docs/_assets/img/dev-group.jpg renamed to docs/_assets/img/loongsuite-python-sig-dingtalk.jpg

File renamed without changes.

0 commit comments

Comments
 (0)