Add metrics to the Python OpenAI instrumentation #3180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
assigned alizenhom, codefromthecrypt, gyliu513, karthikscale3, lmolkova, lzchen and nirga
github-actions
bot
requested review from
alizenhom,
codefromthecrypt,
gyliu513,
karthikscale3,
lmolkova,
lzchen and
nirga
xrmx
approved these changes
Jan 10, 2025
| @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
| - Add example to `opentelemetry-instrumentation-openai-v2` | |||
| ([#3006](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3006)) | |||
| - Support for `AsyncOpenAI/AsyncCompletions` ([#2984](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2984)) | |||
| - Add metrics to the Python OpenAI instrumentation ([#3180](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3180)) | |||
There was a problem hiding this comment.
Suggested change
| - Add metrics to the Python OpenAI instrumentation ([#3180](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3180)) | |
| - Add metrics ([#3180](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3180)) |
| @@ -23,6 +24,7 @@ | |||
| ) | |||
| from opentelemetry.trace import Span, SpanKind, Tracer | |||
|
|
|||
| from .meters import Meters # Import the Meters class | |||
There was a problem hiding this comment.
Suggested change
| from .meters import Meters # Import the Meters class | |
| from .meters import Meters |
| @@ -52,6 +69,62 @@ def fixture_event_logger_provider(log_exporter): | |||
| return event_logger_provider | |||
|
|
|||
|
|
|||
| @pytest.fixture(scope="function", name="meter_provider") | |||
| def fixture_meter_provider(metric_reader): | |||
| token_usage_histogram_view = View( | |||
There was a problem hiding this comment.
Am not sure adding the views is useful since it's outside of the instrumentation concern, maybe wait for advisory support to get in instead?
xrmx
reviewed
Jan 10, 2025
| @@ -0,0 +1,38 @@ | |||
| OpenTelemetry OpenAI Instrumentation Example | |||
There was a problem hiding this comment.
I'm not sure there is anything openai specific here, should we document the views more generally instead?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR implements the GenAI semantic conventions for the two client metrics so they are collected along with spans when instrumenting a Python application.
Basic implementation of two client metrics defined in the GenAI semantic conventions:
gen_ai.client.token.usage- Documentationgen_ai.client.operation.duration- DocumentationThere is an example added to show end users who to configure the explicit bucket boundaries as defined in the semantic convention spec.
Fixes #3177
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.