# arize-phoenix-otel
Provides a lightweight wrapper around OpenTelemetry primitives with Phoenix-aware defaults.
These defaults are aware of environment variables you may have set to configure Phoenix:
- `PHOENIX_COLLECTOR_ENDPOINT`
- `PHOENIX_PROJECT_NAME`
- `PHOENIX_CLIENT_HEADERS`
- `PHOENIX_API_KEY`
# Examples
The `phoenix.otel` module provides a high-level `register` function to configure OpenTelemetry
tracing by setting a global `TracerProvider`. The register function can also configure headers
and whether or not to process spans one by one or by batch.
## Quickstart
```
from phoenix.otel import register
tracer_provider = register()
```
This is all you need to get started using OTel with Phoenix! `register` defaults to sending spans
to an endpoint at `http://localhost` using gRPC.
## Phoenix Authentication
If the `PHOENIX_API_KEY` environment variable is set, `register` will automatically add an
`authorization` header to each span payload.
### Configuring the collector endpoint
There are two ways to configure the collector endpoint:
- Using environment variables
- Using the `endpoint` keyword argument
#### Using environment variables
If you're setting the `PHOENIX_COLLECTOR_ENDPOINT` environment variable, `register` will
automatically try to send spans to your Phoenix server using gRPC.
```
# export PHOENIX_COLLECTOR_ENDPOINT=https://your-phoenix.com:6006
from phoenix.otel import register
tracer_provider = register()
```
#### Specifying the `endpoint` directly
When passing in the `endpoint` argument, **you must specify the fully qualified endpoint**. For
example, in order to export spans via HTTP to localhost, use Pheonix's HTTP collector endpoint:
`http://localhost:6006/v1/traces`. The gRPC endpoint is different: `http://localhost:4317`.
```
from phoenix.otel import register
tracer_provider = register(endpoint="http://localhost:6006/v1/traces")
```
### Additional configuration
`register` can be configured with different keyword arguments:
- `project_name`: The Phoenix project name (or `PHOENIX_PROJECT_NAME` env. var)
- `headers`: Headers to send along with each span payload (or `PHOENIX_CLIENT_HEADERS` env. var)
- `batch`: Whether or not to process spans in batch
```
from phoenix.otel import register
tracer_provider = register(
project_name="otel-test", headers={"Authorization": "Bearer TOKEN"}, batch=True
)
```
## A drop-in replacement for OTel primitives
For more granular tracing configuration, these wrappers can be used as drop-in replacements for
OTel primitives:
```
from opentelemetry import trace as trace_api
from phoenix.otel import HTTPSpanExporter, TracerProvider, SimpleSpanProcessor
tracer_provider = TracerProvider()
span_exporter = HTTPSpanExporter(endpoint="http://localhost:6006/v1/traces")
span_processor = SimpleSpanProcessor(span_exporter=span_exporter)
tracer_provider.add_span_processor(span_processor)
trace_api.set_tracer_provider(tracer_provider)
```
Wrappers have Phoenix-aware defaults to greatly simplify the OTel configuration process. A special
`endpoint` keyword argument can be passed to either a `TracerProvider`, `SimpleSpanProcessor` or
`BatchSpanProcessor` in order to automatically infer which `SpanExporter` to use to simplify setup.
### Using environment variables
```
# export PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006
from opentelemetry import trace as trace_api
from phoenix.otel import TracerProvider
tracer_provider = TracerProvider()
trace_api.set_tracer_provider(tracer_provider)
```
#### Specifying the `endpoint` directly
```
from opentelemetry import trace as trace_api
from phoenix.otel import TracerProvider
tracer_provider = TracerProvider(endpoint="http://localhost:4317")
trace_api.set_tracer_provider(tracer_provider)
```
### Further examples
Users can gradually add OTel components as desired:
## Configuring resources
```
# export PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006
from opentelemetry import trace as trace_api
from phoenix.otel import Resource, PROJECT_NAME, TracerProvider
tracer_provider = TracerProvider(resource=Resource({PROJECT_NAME: "my-project"}))
trace_api.set_tracer_provider(tracer_provider)
```
## Using a BatchSpanProcessor
```
# export PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006
from opentelemetry import trace as trace_api
from phoenix.otel import TracerProvider, BatchSpanProcessor
tracer_provider = TracerProvider()
batch_processor = BatchSpanProcessor()
tracer_provider.add_span_processor(batch_processor)
```
## Specifying a custom GRPC endpoint
```
from opentelemetry import trace as trace_api
from phoenix.otel import TracerProvider, BatchSpanProcessor, GRPCSpanExporter
tracer_provider = TracerProvider()
batch_processor = BatchSpanProcessor(
span_exporter=GRPCSpanExporter(endpoint="http://custom-endpoint.com:6789")
)
tracer_provider.add_span_processor(batch_processor)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "arize-phoenix-otel",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.8",
"maintainer_email": null,
"keywords": "Explainability, Monitoring, Observability",
"author": null,
"author_email": "Arize AI <phoenix-devs@arize.com>",
"download_url": "https://files.pythonhosted.org/packages/b7/70/41eef869b46882aae54e9b8c757223da93160633bba82752158a77b1566a/arize_phoenix_otel-0.6.1.tar.gz",
"platform": null,
"description": "# arize-phoenix-otel\n\nProvides a lightweight wrapper around OpenTelemetry primitives with Phoenix-aware defaults.\n\nThese defaults are aware of environment variables you may have set to configure Phoenix:\n- `PHOENIX_COLLECTOR_ENDPOINT`\n- `PHOENIX_PROJECT_NAME`\n- `PHOENIX_CLIENT_HEADERS`\n- `PHOENIX_API_KEY`\n\n# Examples\n\nThe `phoenix.otel` module provides a high-level `register` function to configure OpenTelemetry\ntracing by setting a global `TracerProvider`. The register function can also configure headers\nand whether or not to process spans one by one or by batch.\n\n\n## Quickstart\n\n```\nfrom phoenix.otel import register\ntracer_provider = register()\n```\n\nThis is all you need to get started using OTel with Phoenix! `register` defaults to sending spans\nto an endpoint at `http://localhost` using gRPC.\n\n## Phoenix Authentication\n\nIf the `PHOENIX_API_KEY` environment variable is set, `register` will automatically add an\n`authorization` header to each span payload.\n\n### Configuring the collector endpoint\n\nThere are two ways to configure the collector endpoint:\n- Using environment variables\n- Using the `endpoint` keyword argument\n\n#### Using environment variables\n\nIf you're setting the `PHOENIX_COLLECTOR_ENDPOINT` environment variable, `register` will\nautomatically try to send spans to your Phoenix server using gRPC.\n\n```\n# export PHOENIX_COLLECTOR_ENDPOINT=https://your-phoenix.com:6006\n\nfrom phoenix.otel import register\ntracer_provider = register()\n```\n\n#### Specifying the `endpoint` directly\n\nWhen passing in the `endpoint` argument, **you must specify the fully qualified endpoint**. For\nexample, in order to export spans via HTTP to localhost, use Pheonix's HTTP collector endpoint:\n`http://localhost:6006/v1/traces`. The gRPC endpoint is different: `http://localhost:4317`.\n\n```\nfrom phoenix.otel import register\ntracer_provider = register(endpoint=\"http://localhost:6006/v1/traces\")\n```\n\n### Additional configuration\n\n`register` can be configured with different keyword arguments:\n- `project_name`: The Phoenix project name (or `PHOENIX_PROJECT_NAME` env. var)\n- `headers`: Headers to send along with each span payload (or `PHOENIX_CLIENT_HEADERS` env. var)\n- `batch`: Whether or not to process spans in batch\n\n```\nfrom phoenix.otel import register\ntracer_provider = register(\n project_name=\"otel-test\", headers={\"Authorization\": \"Bearer TOKEN\"}, batch=True\n)\n```\n\n## A drop-in replacement for OTel primitives\n\nFor more granular tracing configuration, these wrappers can be used as drop-in replacements for\nOTel primitives:\n\n```\nfrom opentelemetry import trace as trace_api\nfrom phoenix.otel import HTTPSpanExporter, TracerProvider, SimpleSpanProcessor\n\ntracer_provider = TracerProvider()\nspan_exporter = HTTPSpanExporter(endpoint=\"http://localhost:6006/v1/traces\")\nspan_processor = SimpleSpanProcessor(span_exporter=span_exporter)\ntracer_provider.add_span_processor(span_processor)\ntrace_api.set_tracer_provider(tracer_provider)\n```\n\nWrappers have Phoenix-aware defaults to greatly simplify the OTel configuration process. A special\n`endpoint` keyword argument can be passed to either a `TracerProvider`, `SimpleSpanProcessor` or\n`BatchSpanProcessor` in order to automatically infer which `SpanExporter` to use to simplify setup.\n\n### Using environment variables\n\n```\n# export PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006\n\nfrom opentelemetry import trace as trace_api\nfrom phoenix.otel import TracerProvider\n\ntracer_provider = TracerProvider()\ntrace_api.set_tracer_provider(tracer_provider)\n```\n\n#### Specifying the `endpoint` directly\n\n```\nfrom opentelemetry import trace as trace_api\nfrom phoenix.otel import TracerProvider\n\ntracer_provider = TracerProvider(endpoint=\"http://localhost:4317\")\ntrace_api.set_tracer_provider(tracer_provider)\n```\n\n### Further examples\n\nUsers can gradually add OTel components as desired:\n\n## Configuring resources\n\n```\n# export PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006\n\nfrom opentelemetry import trace as trace_api\nfrom phoenix.otel import Resource, PROJECT_NAME, TracerProvider\n\ntracer_provider = TracerProvider(resource=Resource({PROJECT_NAME: \"my-project\"}))\ntrace_api.set_tracer_provider(tracer_provider)\n```\n\n## Using a BatchSpanProcessor\n\n```\n# export PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006\n\nfrom opentelemetry import trace as trace_api\nfrom phoenix.otel import TracerProvider, BatchSpanProcessor\n\ntracer_provider = TracerProvider()\nbatch_processor = BatchSpanProcessor()\ntracer_provider.add_span_processor(batch_processor)\n```\n\n## Specifying a custom GRPC endpoint\n\n```\nfrom opentelemetry import trace as trace_api\nfrom phoenix.otel import TracerProvider, BatchSpanProcessor, GRPCSpanExporter\n\ntracer_provider = TracerProvider()\nbatch_processor = BatchSpanProcessor(\n span_exporter=GRPCSpanExporter(endpoint=\"http://custom-endpoint.com:6789\")\n)\ntracer_provider.add_span_processor(batch_processor)\n```\n",
"bugtrack_url": null,
"license": "Elastic-2.0",
"summary": "LLM Observability",
"version": "0.6.1",
"project_urls": {
"Documentation": "https://docs.arize.com/phoenix/",
"Issues": "https://github.com/Arize-ai/phoenix/issues",
"Source": "https://github.com/Arize-ai/phoenix"
},
"split_keywords": [
"explainability",
" monitoring",
" observability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9cf3f2390a9d7b3ee46b28a8ccee6510a489ae0974f31b51c67d79cab4c45ef8",
"md5": "2c0b1db0c0412379ee87c5c4feab04ae",
"sha256": "fc00dd847a248cece5f20dffeb8fabfab72c1c38f198bcee4260618c6af1d8a5"
},
"downloads": -1,
"filename": "arize_phoenix_otel-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c0b1db0c0412379ee87c5c4feab04ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.8",
"size": 10783,
"upload_time": "2024-10-17T22:55:49",
"upload_time_iso_8601": "2024-10-17T22:55:49.920832Z",
"url": "https://files.pythonhosted.org/packages/9c/f3/f2390a9d7b3ee46b28a8ccee6510a489ae0974f31b51c67d79cab4c45ef8/arize_phoenix_otel-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b77041eef869b46882aae54e9b8c757223da93160633bba82752158a77b1566a",
"md5": "023d354d799b0d44e55bf09c1c93d833",
"sha256": "f5f7a257159f49b398dfe2ba45bb70e22766cdf61bb365c0c47dc55f329bfe95"
},
"downloads": -1,
"filename": "arize_phoenix_otel-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "023d354d799b0d44e55bf09c1c93d833",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.8",
"size": 9691,
"upload_time": "2024-10-17T22:55:51",
"upload_time_iso_8601": "2024-10-17T22:55:51.182567Z",
"url": "https://files.pythonhosted.org/packages/b7/70/41eef869b46882aae54e9b8c757223da93160633bba82752158a77b1566a/arize_phoenix_otel-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 22:55:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Arize-ai",
"github_project": "phoenix",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "arize-phoenix-otel"
}
JSON
