OpenAI instrumentation docs fixes #2988
Conversation
lmolkova
commented
Nov 9, 2024
•
lmolkova
commented
- updates broken homepage link to https://pypi.org/project/opentelemetry-instrumentation-openai-v2
- adds docs config
- adds usage samples to readme
github-actions
bot
requested review from
gyliu513,
karthikscale3,
lzchen and
nirga
| ], | ||
| ) | ||
|
|
||
| Enabling message content |
There was a problem hiding this comment.
was this snippet about configuring logs and events meant to be in here, too? open-telemetry/opentelemetry.io#5575 (comment)
| ************************* | ||
|
|
||
| When using the instrumentor, all clients will automatically trace OpenAI chat completion operations | ||
| and capture prompts and completions as events. |
There was a problem hiding this comment.
This only happens when OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT is set as true, right? Can we highlight the parameter here as well?
There was a problem hiding this comment.
Might be worthwhile putting the example (json) format of the content shape that is emitted.
Also might be worth stating that if doing this you may have to configure your pipeline to redact any sensitive info contained in the content.
| When using the instrumentor, all clients will automatically trace OpenAI chat completion operations | ||
| and capture prompts and completions as events. |
There was a problem hiding this comment.
Similar thought to @gyliu513 and also I don't think most people know what events are yet, specifically they are log not span. Maybe adding the word log helps?
| When using the instrumentor, all clients will automatically trace OpenAI chat completion operations | |
| and capture prompts and completions as events. | |
| When using the instrumentor, all clients will automatically trace OpenAI chat completion operations. | |
| You can also optionally capture prompts and completions as log events, discussed later. |
| ************************* | ||
|
|
||
| Message content such as the contents of the prompt, completion, function arguments and return values | ||
| are not captured by default. To enable message content, set the environment variable |
There was a problem hiding this comment.
| are not captured by default. To enable message content, set the environment variable | |
| are not captured by default. To capture message content as log events, set the environment variable |
There was a problem hiding this comment.
Is there a doco or something related to setting up log events instrumentation that can be linked in place here? Most existing apps will not have log events provider setup.
There was a problem hiding this comment.
@karthikscale3 just confirming we are using log events and not span events for this even in the interim?
There was a problem hiding this comment.
We are using span events in the interim at the moment - https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2759/files?diff=unified&w=0#diff-954647898e3f111e390e80f228b8d86a8df076df8f43496783d6f8660a5f29aaR118
There was a problem hiding this comment.
@dasiths open-telemetry/opentelemetry-python#4269 has the patch for log event enabling, but that will only work if your backend/collector accepts logs.
There was a problem hiding this comment.
We are using span events in the interim at the moment - https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2759/files?diff=unified&w=0#diff-954647898e3f111e390e80f228b8d86a8df076df8f43496783d6f8660a5f29aaR118
I don't think the current main uses span.add_event() anywhere here: https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation-genai/opentelemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/utils.py
There was a problem hiding this comment.
My bad sorry, i just realized this PR was merged - https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2925/files . Yes log events is what we are using now.
There was a problem hiding this comment.
@dasiths can you confirm you can see the log events in tempo by clicking "logs for this span"? I've not tried tempo..
There was a problem hiding this comment.
@dasiths can you confirm you can see the log events in tempo by clicking "logs for this span"? I've not tried tempo..
Yes the logs do appear once OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true is set. https://github.com/jsburckhardt/ai-translation-bot-demo/blob/c3ddf39f65cba2eac742fdfbfb4dec4ebe19d7b3/app/services/observability.py#L150C6-L163C13
edit: I did however get a warning saying event logger provider is already set.
There was a problem hiding this comment.
"I did however get a warning saying event logger provider is already set." me, too, but hopefully when "zero code" works that message goes away with it.
|
|
||
| Message content such as the contents of the prompt, completion, function arguments and return values | ||
| are not captured by default. To enable message content, set the environment variable | ||
| `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` to `true`. |
There was a problem hiding this comment.
note: I found that if this is set to false, it currently crashes. Validation if that's only me requested here
