Log the x-request-id header when OpenAI recieves a response, especially if it's an error

[nickodell]

Problem Statement

I ran into an issue where an HTTP request to Grok failed with a pretty mysterious error message, which got logged in Sentry. I tried to follow up with their support, but they wanted to know the value of the X-Request-Id header to debug it further. It would be nice if Sentry tracked this information. (Note: I am using the OpenAI client, but I am actually connecting to X.ai.)

Solution Brainstorm

It would be nice if the OpenAIIntegration tracked the value of this header.

Idea 1

I only really care about X-Request-Id in the case where I am getting an error back. If I understand correctly, all APIStatusException exceptions that are thrown include a APIStatusException.request_id value, which is the X-Request-ID header. citation.

So, one solution is that when OpenAIIntegration is executing a Completion.create request, and it throws an exception, Sentry reads the request_id attribute of that exception, and attaches it to the span where it tracking the completion request.

Idea 2

I also see that there is a request through httpx and httplib to this endpoint. Unfortunately, I don't see a way to customize HttpxIntegration or StdlibIntegration to track the value of particular HTTP headers. It would be nice if I could ask HttpxIntegration to track the value of a particular header in an HTTP response whenever it sees it. Then, I could look at the breadcrumbs in the trace to see what the request ID was.

This would be an alternative approach which would also give me what I want.

[sl0thentr0py]

that are thrown include a APIStatusException.request_id

the easiest way is to just do it yourself like this

import openai
import sentry_sdk

try:
    openai.do_request()  # however you're calling the openai stuff
except APIStatusException as e:
    sentry_sdk.set_tag("openai_request_id", e.request_id)
    sentry_sdk.capture_exception(e)

HttpxIntegration or StdlibIntegration

These are used to create spans for our tracing product.
If you turn on tracing using traces_sample_rate=1.0, you will see all headers in outgoing requests in the trace automatically.

[nickodell]

I don't love the idea of instrumenting each call site to OpenAI. We have quite a few. If that's what I gotta do, that's what I gotta do.

I'll try your suggestions and report back.

[nickodell]

These are used to create spans for our tracing product.
If you turn on tracing using traces_sample_rate=1.0, you will see all headers in outgoing requests in the trace automatically.

Sorry, could you clarify where this information is recorded? Here is an example span, created by HttpxIntegration (Origin: auto.http.httpx) that doesn't seem to have header information associated with it. Looking at the code, I don't see anything that records header information.

Here is a screenshot of what I am referring to.

[sl0thentr0py]

ah apologies for the wrong info on spans containing request headers, on python we don't do that it seems but in some other SDKs we do.

I talked a bit to people about this and it's definitely a value add to add exception attributes automatically.
I'm tracking that here.
We'll try to do that soon but till then, as a user, tags/extra set as above in a helper method wrapper would be your quickest solution.