docs: add standalone Arize AX tracing guide - #981
Conversation
danehans
changed the title
| export ARIZE_SPACE_ID="<your-space-id>" | ||
| ``` | ||
|
|
||
| Agentgateway sends the API key and Space ID as request headers. |
There was a problem hiding this comment.
what are the headers that we send them in?
There was a problem hiding this comment.
Clarified the protocol-specific names: arize-api-key and arize-space-id for OTLP/HTTP, and api_key and space_id metadata for OTLP/gRPC.
| | US | `otlp.arize.com:443` | | ||
| | US regional | `otlp.us-central-1a.arize.com:443` | | ||
| | EU | `otlp.eu-west-1a.arize.com:443` | | ||
| | Canada | `otlp.ca-central-1a.arize.com:443` | |
There was a problem hiding this comment.
save it in an environment variable so that you can reference it in the sample config below
There was a problem hiding this comment.
Added an ARIZE_HOST environment variable for the selected regional collector.
|
|
||
| ## Configure trace export | ||
|
|
||
| Choose either OTLP/HTTP or OTLP/gRPC. The authentication header names differ by protocol. |
There was a problem hiding this comment.
| Choose either OTLP/HTTP or OTLP/gRPC. The authentication header names differ by protocol. | |
| Update the agentgateway configuration file that you created as part of [before you begin](#before-you-begin) to add Arize AX as your tracing backend. Choose either OTLP/HTTP or OTLP/gRPC for your protocol, and add the custom tracing attributes that you require. The authentication header names differ by protocol. |
There was a problem hiding this comment.
Updated the introduction to direct users to their quickstart configuration and explain the transport and attribute choices.
| ```text | ||
| info request gateway=default/default route=internal/llm:request http.status=200 trace.id=4d50f6d1cb4099a1a22e50b6d339d5f2 span.id=a3f2ae9119406264 protocol=llm gen_ai.provider.name=openai | ||
| ``` | ||
| 4. In Arize AX, open **Tracing Projects**, select the project from `openinference.project.name`, and search for the trace ID. Trace export is batched, so allow several seconds for the trace to appear. |
There was a problem hiding this comment.
| 4. In Arize AX, open **Tracing Projects**, select the project from `openinference.project.name`, and search for the trace ID. Trace export is batched, so allow several seconds for the trace to appear. | |
| 4. In Arize AX, open **Tracing Projects**, select the project that you defined in the `openinference.project.name` field, and search for the trace ID. Trace export is batched, so allow several seconds for the trace to appear. |
There was a problem hiding this comment.
Clarified that users should select the project defined by openinference.project.name.
| @@ -0,0 +1,186 @@ | |||
| --- | |||
| title: Arize AX | |||
There was a problem hiding this comment.
can you make this a reusable page under assets/agw-docs and then just refer to it from here and main?
There was a problem hiding this comment.
Moved the guide body to assets/agw-docs/standalone/llm/arize.md; the latest and main pages now reuse it.
| # yaml-language-server: $schema=https://agentgateway.dev/schema/config | ||
| frontendPolicies: | ||
| tracing: | ||
| host: otlp.arize.com:443 |
There was a problem hiding this comment.
| host: otlp.arize.com:443 | |
| host: ${ARIZE_HOST}:443 |
There was a problem hiding this comment.
Updated the OTLP/HTTP configuration to use ${ARIZE_HOST}:443.
| # yaml-language-server: $schema=https://agentgateway.dev/schema/config | ||
| frontendPolicies: | ||
| tracing: | ||
| host: otlp.arize.com:443 |
There was a problem hiding this comment.
| host: otlp.arize.com:443 | |
| host: ${ARIZE_HOST}:443 |
There was a problem hiding this comment.
Updated the OTLP/gRPC configuration to use ${ARIZE_HOST}:443.
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
e2615d4 to
723d712
Compare
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
2 participants
Company
Not applicable; this pull request updates documentation.
Contribution summary
Checklist
Logo file
Listing
Preview
Both transport configurations were validated with agentgateway 1.4.1, and the
full Hugo build completed successfully.