semvec/pypi-packages huggingface dataset:
aliyun-instrumentation-llama-index 1.0.1
Aliyun LlamaIndex Instrumentation
Requires Python: <3.13,>=3.8

# 阿里云LlamaIndex自动检测库

这是Python自动检测库，专为LlamaIndex框架设计。通过此库产生的追踪信息完全兼容OpenTelemetry，可以发送到OpenTelemetry收集器进行查看，例如xtrace。

## 安装

通过下列命令安装`aliyun-instrumentation-llama-index`：

```bash
pip3 install  aliyun-instrumentation-llama-index
```

## 兼容性

`llama-index`与`aliyun-instrumentation-llama-index`两者间的版本兼容性以下所述：

| llama-index版本       | aliyun-instrumentation-llama-index版本 |
|---------------------|----------------------------------|
| >=0.10.0, < 0.10.43 | >=1.0.0                          |
## 快速开始

### 安装必须的包

首先，安装本示范所需的包：

```bash
pip install aliyun-instrumentation-llama-index llama-index opentelemetry-sdk opentelemetry-exporter-otlp
```

### 设置追踪

以下Python代码用于设置`AliyunLlamaIndexInstrumentor`来追踪`llama-index`，并将追踪信息输出至控制台。

```python

from aliyun.instrumentation.llama_index import AliyunLlamaIndexInstrumentor

from opentelemetry import trace
from opentelemetry.sdk.resources import Resource, SERVICE_NAME, SERVICE_VERSION
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import SimpleSpanProcessor, ConsoleSpanExporter

resource = Resource(
    attributes={
        SERVICE_NAME: 'aliyun_llama_index_test',
        SERVICE_VERSION: '0.0.1',
        # "telemetry.sdk.language": "Python",
    }
)
provider = TracerProvider(resource=resource)
provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter()))  # 在控制台输出Trace
trace.set_tracer_provider(provider)
# aliyun llama-index instrumentor
AliyunLlamaIndexInstrumentor().instrument()
```