Skip to content

Commit a65ce73

Browse files
committed
Update example and changelog
1 parent 5dd2a21 commit a65ce73

File tree

3 files changed

+31
-3
lines changed
  • instrumentation-genai/opentelemetry-instrumentation-vertexai

3 files changed

+31
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## Unreleased
99

10-
- Start making changes to implement the big semantic convention changes made in https://github.com/open-telemetry/semantic-conventions/pull/2179.
11-
Now only a single event (`gen_ai.client.inference.operation.details`) is used to capture Chat History. These changes will be opt-in,
12-
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)).
10+
- Update instrumentation to use the latest semantic convention changes made in https://github.com/open-telemetry/semantic-conventions/pull/2179.
11+
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,
12+
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)).
1313
- Implement uninstrument for `opentelemetry-instrumentation-vertexai`
1414
([#3328](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3328))
1515
- VertexAI support for async calling

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,17 @@ OTEL_SERVICE_NAME=opentelemetry-python-vertexai
66

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

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,17 @@ OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
1212

1313
# Change to 'false' to hide prompt and completion content
1414
OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
15+
16+
# Alternatively set this env var to enable the latest semantic conventions:
17+
OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental
18+
19+
# When using the latest experimental flag this env var controls which telemetry signals will have prompt and response content included in them.
20+
# Choices are NO_CONTENT, SPAN_ONLY, EVENT_ONLY, SPAN_AND_EVENT.
21+
OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=SPAN_AND_EVENT
22+
23+
# Optional hook that will upload prompt and response content to some external destination.
24+
# For example fsspec.
25+
OTEL_INSTRUMENTATION_GENAI_COMPLETION_HOOK = "fsspec"
26+
27+
# Required if using a completion hook. The path to upload content to for example gs://my_bucket.
28+
OTEL_INSTRUMENTATION_GENAI_UPLOAD_BASE_PATH = "gs://my_bucket"

0 commit comments

Comments
 (0)