OpenTelemetry (arize-otel)
We have full support for OpenTelemetry simplified instrumentation code that sets up tracing automatically.
The arize-otel
package provides a lightweight wrapper around OpenTelemetry primitives with Arize-aware defaults and options. It is meant to be a very lightweight convenience package to set up OpenTelemetry for tracing LLM applications and send the traces to Arize.
Read here for more on how tracing works.
Installation
Install arize-otel
using pip
Quickstart
The arize.otel
module provides a high-level register
function to configure OpenTelemetry tracing by returning a TracerProvider
. The register function can also configure headers and whether or not to process spans one by one or by batch.
The following examples showcase how to use register
to setup Opentelemetry in order to send traces to a collector. However, this is NOT the same as instrumenting your application. For instance, you can use any of our OpenInference AutoInstrumentators. Assuming we use the OpenAI AutoInstrumentation, we need to run instrument()
after using register
:
The above code snippet will yield a fully setup and instrumented application. It is worth noting that this is completely optional. The usage of this package is for convenience only, you can set up OpenTelemetry and send traces to Arize without installing this or any other package from Arize.
In the following sections we have examples on how to use the register
function:
Send traces to Arize
To send traces to Arize you need to authenticate via the Space ID and API Key. You can find them in the Settings page in the Arize platform. In addition, you'll need to specify the project name, a unique name to identify your project in the Arize platform.
If you are located in the European Union, you'll need to specify the corresponding Endpoint
(the default endpoint is Endpoint.ARIZE
):
If you would like to configure your tracing using environment variables instead of passing arguments, read Using Environment Variables.
Send traces to Custom Endpoint
Sending traces to a collector on a custom endpoint is simple, you just need to provide the endpoint as a string. In addition, it is worth noting that the default is to use a GRPCSpanExporter
. If you'd like to use a HTTPSpanExporter
instead, specify the transport as shown below:
Specify exporter type
If you're using endpoints from the Endpoint
enum, you do not need to do this, since we know what exporter to use. However, if you're using a custom endpoint, it is worth noting that the default is to use a GRPCSpanExporter
. If you'd like to use a HTTPSpanExporter
instead, specify the transport as shown below:
Turn off batch processing of spans
We default to using BatchSpanProcessor from OpenTelemetry because it is non-blocking in case telemetry goes down. In contrast, "SimpleSpanProcessor processes spans as they are created." This can be helpful in development. You can use SimpleSpanProcessor
with the option use_batch_processor=False
.
Debug
As you're setting up your tracing, it is helpful to print to console the spans created. You can achieve this by setting log_to_console=True
.
Using Environment Variables
The register function will read from environment variables if the arguments are not passed:
In the event of conflict, if an environment variable is set but a different argument is passed, the argument passed will take precedence and the environment variable will be ignored.
Using OTel Primitives
For more granular tracing configuration, these wrappers can be used as drop-in replacements for OTel primitives:
Wrappers have Arize-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.
Specifying the endpoint
directly
Configuring resources
Using a BatchSpanProcessor
Specifying a custom GRPC endpoint
Questions?
Find us in our Slack Community or email support@arize.com
Last updated
Was this helpful?