Merge branch 'main' into django-issue-fix

Author: rads-1996

.github/component_owners.yml

@@ -9,8 +9,12 @@ components:
   instrumentation/opentelemetry-instrumentation-asyncio:
     - bourbonkk
 
+  instrumentation/opentelemetry-instrumentation-botocore:
+    - lukeina2z
+    - yiyuan-he
+
   instrumentation/opentelemetry-instrumentation-pymssql:
-     - guillaumep
+    - guillaumep
 
   instrumentation/opentelemetry-instrumentation-urllib:
     - shalevr
@@ -43,4 +47,4 @@ components:
 
   instrumentation-genai/opentelemetry-instrumentation-langchain:
     - zhirafovod
-    - wrisa
+    - wrisa

CHANGELOG.md

@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `opentelemetry-instrumentation-dbapi`: fix crash retrieving libpq version when enabling commenter with psycopg
   ([#3796](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3796))
+- `opentelemetry-instrumentation-vertexai`: migrate off the deprecated events API to use the logs API
+  ([#3625](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3626))
 
 ### Added
 - `opentelemetry-instrumentation`: botocore: Add support for AWS Secrets Manager semantic convention attribute

instrumentation-genai/opentelemetry-instrumentation-vertexai/CHANGELOG.md

@@ -7,9 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-- Start making changes to implement the big semantic convention changes made in https://github.com/open-telemetry/semantic-conventions/pull/2179.
-Now only a single event (`gen_ai.client.inference.operation.details`) is used to capture Chat History. These changes will be opt-in,
-users will need to set the environment variable OTEL_SEMCONV_STABILITY_OPT_IN to `gen_ai_latest_experimental` to see them ([#3386](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3386)).
+- Update instrumentation to use the latest semantic convention changes made in https://github.com/open-telemetry/semantic-conventions/pull/2179.
+Now only a single event and span (`gen_ai.client.inference.operation.details`) are used to capture prompt and response content. These changes are opt-in,
+users will need to set the environment variable OTEL_SEMCONV_STABILITY_OPT_IN to `gen_ai_latest_experimental` to see them ([#3799](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3799)) and ([#3709](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3709)).
 - Implement uninstrument for `opentelemetry-instrumentation-vertexai`
   ([#3328](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3328))
 - VertexAI support for async calling

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/manual/.env

@@ -6,3 +6,17 @@ OTEL_SERVICE_NAME=opentelemetry-python-vertexai
 
 # Change to 'false' to hide prompt and completion content
 OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+
+# Alternatively set this env var to enable the latest semantic conventions:
+OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental
+
+# When using the latest experimental flag this env var controls which telemetry signals will have prompt and response content included in them.
+# Choices are NO_CONTENT, SPAN_ONLY, EVENT_ONLY, SPAN_AND_EVENT.
+OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=SPAN_AND_EVENT
+
+# Optional hook that will upload prompt and response content to some external destination.
+# For example fsspec.
+OTEL_INSTRUMENTATION_GENAI_COMPLETION_HOOK = "upload"
+
+# Required if using a completion hook. The path to upload content to for example gs://my_bucket.
+OTEL_INSTRUMENTATION_GENAI_UPLOAD_BASE_PATH = "gs://my_bucket"

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/zero-code/.env

@@ -12,3 +12,17 @@ OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
 
 # Change to 'false' to hide prompt and completion content
 OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+
+# Alternatively set this env var to enable the latest semantic conventions:
+OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental
+
+# When using the latest experimental flag this env var controls which telemetry signals will have prompt and response content included in them.
+# Choices are NO_CONTENT, SPAN_ONLY, EVENT_ONLY, SPAN_AND_EVENT.
+OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=SPAN_AND_EVENT
+
+# Optional hook that will upload prompt and response content to some external destination.
+# For example fsspec.
+OTEL_INSTRUMENTATION_GENAI_COMPLETION_HOOK = "upload"
+
+# Required if using a completion hook. The path to upload content to for example gs://my_bucket.
+OTEL_INSTRUMENTATION_GENAI_UPLOAD_BASE_PATH = "gs://my_bucket"

instrumentation-genai/opentelemetry-instrumentation-vertexai/pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
   "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
-  "opentelemetry-api ~= 1.28",
+  "opentelemetry-api >= 1.37",
   "opentelemetry-instrumentation ~= 0.58b0",
   # TODO https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3786: restrict
   # version after the first release

instrumentation-genai/opentelemetry-instrumentation-vertexai/src/opentelemetry/instrumentation/vertexai/__init__.py

@@ -47,7 +47,7 @@
     wrap_function_wrapper,  # type: ignore[reportUnknownVariableType]
 )
 
-from opentelemetry._events import get_event_logger
+from opentelemetry._logs import get_logger
 from opentelemetry.instrumentation._semconv import (
     _OpenTelemetrySemanticConventionStability,
     _OpenTelemetryStabilitySignalType,
@@ -60,6 +60,7 @@
 from opentelemetry.instrumentation.vertexai.utils import is_content_enabled
 from opentelemetry.semconv.schemas import Schemas
 from opentelemetry.trace import get_tracer
+from opentelemetry.util.genai.completion_hook import load_completion_hook
 
 
 def _methods_to_wrap(
@@ -109,6 +110,9 @@ def instrumentation_dependencies(self) -> Collection[str]:
 
     def _instrument(self, **kwargs: Any):
         """Enable VertexAI instrumentation."""
+        completion_hook = (
+            kwargs.get("completion_hook") or load_completion_hook()
+        )
         sem_conv_opt_in_mode = _OpenTelemetrySemanticConventionStability._get_opentelemetry_stability_opt_in_mode(
             _OpenTelemetryStabilitySignalType.GEN_AI,
         )
@@ -124,12 +128,12 @@ def _instrument(self, **kwargs: Any):
             tracer_provider,
             schema_url=schema,
         )
-        event_logger_provider = kwargs.get("event_logger_provider")
-        event_logger = get_event_logger(
+        logger_provider = kwargs.get("logger_provider")
+        logger = get_logger(
             __name__,
             "",
+            logger_provider=logger_provider,
             schema_url=schema,
-            event_logger_provider=event_logger_provider,
         )
         sem_conv_opt_in_mode = _OpenTelemetrySemanticConventionStability._get_opentelemetry_stability_opt_in_mode(
             _OpenTelemetryStabilitySignalType.GEN_AI,
@@ -138,17 +142,19 @@ def _instrument(self, **kwargs: Any):
             # Type checker now knows sem_conv_opt_in_mode is a Literal[_StabilityMode.DEFAULT]
             method_wrappers = MethodWrappers(
                 tracer,
-                event_logger,
+                logger,
                 is_content_enabled(sem_conv_opt_in_mode),
                 sem_conv_opt_in_mode,
+                completion_hook,
             )
         elif sem_conv_opt_in_mode == _StabilityMode.GEN_AI_LATEST_EXPERIMENTAL:
             # Type checker now knows it's the other literal
             method_wrappers = MethodWrappers(
                 tracer,
-                event_logger,
+                logger,
                 is_content_enabled(sem_conv_opt_in_mode),
                 sem_conv_opt_in_mode,
+                completion_hook,
             )
         else:
             raise RuntimeError(f"{sem_conv_opt_in_mode} mode not supported")

instrumentation-genai/opentelemetry-instrumentation-vertexai/src/opentelemetry/instrumentation/vertexai/events.py

@@ -27,7 +27,7 @@
 from dataclasses import asdict, dataclass
 from typing import Any, Iterable, Literal
 
-from opentelemetry._events import Event
+from opentelemetry._logs import LogRecord
 from opentelemetry.semconv._incubating.attributes import gen_ai_attributes
 from opentelemetry.util.types import AnyValue
 
@@ -36,7 +36,7 @@ def user_event(
     *,
     role: str = "user",
     content: AnyValue = None,
-) -> Event:
+) -> LogRecord:
     """Creates a User event
     https://github.com/open-telemetry/semantic-conventions/blob/v1.28.0/docs/gen-ai/gen-ai-events.md#user-event
     """
@@ -45,8 +45,8 @@ def user_event(
     }
     if content is not None:
         body["content"] = content
-    return Event(
-        name="gen_ai.user.message",
+    return LogRecord(
+        event_name="gen_ai.user.message",
         attributes={
             gen_ai_attributes.GEN_AI_SYSTEM: gen_ai_attributes.GenAiSystemValues.VERTEX_AI.value,
         },
@@ -58,7 +58,7 @@ def assistant_event(
     *,
     role: str = "assistant",
     content: AnyValue = None,
-) -> Event:
+) -> LogRecord:
     """Creates an Assistant event
     https://github.com/open-telemetry/semantic-conventions/blob/v1.28.0/docs/gen-ai/gen-ai-events.md#assistant-event
     """
@@ -67,8 +67,8 @@ def assistant_event(
     }
     if content is not None:
         body["content"] = content
-    return Event(
-        name="gen_ai.assistant.message",
+    return LogRecord(
+        event_name="gen_ai.assistant.message",
         attributes={
             gen_ai_attributes.GEN_AI_SYSTEM: gen_ai_attributes.GenAiSystemValues.VERTEX_AI.value,
         },
@@ -80,7 +80,7 @@ def system_event(
     *,
     role: str = "system",
     content: AnyValue = None,
-) -> Event:
+) -> LogRecord:
     """Creates a System event
     https://github.com/open-telemetry/semantic-conventions/blob/v1.28.0/docs/gen-ai/gen-ai-events.md#system-event
     """
@@ -89,8 +89,8 @@ def system_event(
     }
     if content is not None:
         body["content"] = content
-    return Event(
-        name="gen_ai.system.message",
+    return LogRecord(
+        event_name="gen_ai.system.message",
         attributes={
             gen_ai_attributes.GEN_AI_SYSTEM: gen_ai_attributes.GenAiSystemValues.VERTEX_AI.value,
         },
@@ -103,7 +103,7 @@ def tool_event(
     role: str | None,
     id_: str,
     content: AnyValue = None,
-) -> Event:
+) -> LogRecord:
     """Creates a Tool message event
     https://github.com/open-telemetry/semantic-conventions/blob/v1.28.0/docs/gen-ai/gen-ai-events.md#event-gen_aitoolmessage
     """
@@ -116,8 +116,8 @@ def tool_event(
     }
     if content is not None:
         body["content"] = content
-    return Event(
-        name="gen_ai.tool.message",
+    return LogRecord(
+        event_name="gen_ai.tool.message",
         attributes={
             gen_ai_attributes.GEN_AI_SYSTEM: gen_ai_attributes.GenAiSystemValues.VERTEX_AI.value,
         },
@@ -158,7 +158,7 @@ def choice_event(
     index: int,
     message: ChoiceMessage,
     tool_calls: Iterable[ChoiceToolCall] = (),
-) -> Event:
+) -> LogRecord:
     """Creates a choice event, which describes the Gen AI response message.
     https://github.com/open-telemetry/semantic-conventions/blob/v1.28.0/docs/gen-ai/gen-ai-events.md#event-gen_aichoice
     """
@@ -174,8 +174,8 @@ def choice_event(
     if tool_calls_list:
         body["tool_calls"] = tool_calls_list
 
-    return Event(
-        name="gen_ai.choice",
+    return LogRecord(
+        event_name="gen_ai.choice",
         attributes={
             gen_ai_attributes.GEN_AI_SYSTEM: gen_ai_attributes.GenAiSystemValues.VERTEX_AI.value,
         },