Skip to content

elastic-opentelemetry-instrumentation-openai: register import hook for patching #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xrmx merged 1 commit into from
Oct 17, 2024
Merged

elastic-opentelemetry-instrumentation-openai: register import hook for patching #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions ...opentelemetry-instrumentation-openai/src/opentelemetry/instrumentation/openai/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@
from timeit import default_timer
from typing import Collection

import openai
from wrapt import wrap_function_wrapper
from wrapt import register_post_import_hook, wrap_function_wrapper

from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
from opentelemetry.instrumentation.utils import unwrap
Expand Down Expand Up @@ -83,6 +82,9 @@ def _instrument(self, **kwargs):
self.token_usage_metric = create_gen_ai_client_token_usage(self.meter)
self.operation_duration_metric = create_gen_ai_client_operation_duration(self.meter)

register_post_import_hook(self._patch, "openai")

def _patch(self, _module):
wrap_function_wrapper(
"openai.resources.chat.completions",
"Completions.create",
Expand All @@ -95,6 +97,10 @@ def _instrument(self, **kwargs):
)

def _uninstrument(self, **kwargs):
# unwrap only supports uninstrementing real module references so we
# import here.
import openai
Copy link
Member

@trentm trentm Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unusual (directly importing the thing in an _uninstrument), right?

Copy link
Member Author

@xrmx xrmx Oct 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, since openai depends on httpx if we load the openai module earlier and we are loaded before the httpx instrumentation the http spans from the openai client won't be traced


unwrap(openai.resources.chat.completions.Completions, "create")
unwrap(openai.resources.chat.completions.AsyncCompletions, "create")

Expand Down
7 changes: 6 additions & 1 deletion ...-opentelemetry-instrumentation-openai/src/opentelemetry/instrumentation/openai/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
import json
from collections.abc import Iterable
from timeit import default_timer
from typing import TYPE_CHECKING

from openai.types import CompletionUsage
from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
from opentelemetry.semconv.attributes.server_attributes import SERVER_ADDRESS, SERVER_PORT
from opentelemetry.semconv._incubating.attributes.gen_ai_attributes import (
Expand All @@ -41,6 +41,11 @@
from opentelemetry.metrics import Histogram
from opentelemetry.trace import Span

if TYPE_CHECKING:
from openai.types import CompletionUsage
else:
CompletionUsage = None


def _set_span_attributes_from_response(
span: Span, response_id: str, model: str, choices, usage: CompletionUsage
Expand Down