Update google genai instrumentation to work with latest semantic convention, allow for uploading content. #3772

argaj · 2025-09-22T17:20:06Z

Description

Accomodation of semantic conventions changes made in open-telemetry/semantic-conventions#2179.

Also, when logging the completion details, the upload hook is called, so if user has configured OTEL_INSTRUMENTATION_GENAI_UPLOAD_BASE_PATH and OTEL_INSTRUMENTATION_GENAI_UPLOAD_HOOK env vars, completion details will also be logged as refs (if appropriate capture content env var is set).

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Unit tests, manual tests.

Does This PR Require a Core Repo Change?

No?

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

linux-foundation-easycla · 2025-09-22T17:20:14Z

The committers listed above are authorized under a signed CLA.

✅ login: aabmass / name: Aaron Abbott (6276543)
✅ login: argaj / name: argaj (3f20dbc)
✅ login: argaj / name: Artur Gajowniczek (057d956, 058da13, 0ff51f3, 13b6f2e, 166c081, 17b9c0a, 20c082c, 2eefc39, 39deea9, 3ac198d, 46b10d1, 47d5728, 48ac64b, 49264ee, 5703096, 5c35853, 661998b, 8583327, 8b8995c, 9ea2278, 9ef75f7, ab39602, ae4da64, b3a6efb, b564008, e1738c2, e51ef37, ee911f5, eeed7d5, f1feaf7, f4df9fb)
✅ login: DylanRussell / name: Dylan Russell (05bed52, 205aa88, 486796a)
✅ login: DylanRussell / name: DylanRussell (32ae223)

...trumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py

Co-authored-by: Aaron Abbott <aaronabbott@google.com>

…in spans test.

...-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/instrumentor.py

...lemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/flags.py

...metry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/message.py

DylanRussell · 2025-10-06T17:41:17Z

...enerate_content/cassettes/test_streaming[logcontent-gemini-2.5-flash-vertexaiapi-async].yaml

+interactions:
+- request:
+    body: |-
+      {


Mind adding a test for the completion hook somewhere ? https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation-genai/opentelemetry-instrumentation-vertexai/tests/test_function_calling_experimental.py#L262 -- this is how I did it for vertex AI

instrumentation-genai/opentelemetry-instrumentation-google-genai/tests/requirements.oldest.txt

…y-python-contrib into genai-instrumentation-semconv

aabmass

Thank you, LGTM! Will merge once Dylan has finished reviewing/approved too.

aabmass · 2025-10-09T04:18:26Z

...trumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py

+
+    if as_str:
+        return {
+            k: json.dumps(v, cls=_GenAiJsonEncoder)


can you use this function instead? it will remove extra whitespace too

opentelemetry-python-contrib/util/opentelemetry-util-genai/src/opentelemetry/util/genai/utils.py

Line 76 in a4adc93

gen_ai_json_dumps = partial(

Done, but won't this require util-genai package version bump? I see this func is not in the currently released version (0.1b0)

Ya I can do a release today before merging

Maybe for now don't pin a version and use it.

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

Lines 29 to 31 in 9f393c7

# TODO https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3786: restrict

# version after the first release

"opentelemetry-util-genai",

-- for vertexAI we don't have a version pinned currently

Done, I linked it to the same issue, will add a comment there that it's also the case for google-genai instrumentation.

...trumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py

...entation-genai/opentelemetry-instrumentation-google-genai/tests/generate_content/test_e2e.py

aabmass · 2025-10-09T04:30:37Z

...rate_content/cassettes/test_streaming[excludecontent-gemini-2.5-flash-vertexaiapi-sync].yaml

+    uri: https://test-location-aiplatform.googleapis.com/v1beta1/projects/test-project/locations/test-location/publishers/google/models/gemini-2.5-flash:streamGenerateContent?alt=sse
+  response:
+    body:
+      string: "data: {\"candidates\": [{\"content\": {\"role\": \"model\",\"parts\"\


Any idea why this one is formatted like this vs the other RPC recordings?

Dylan updated these, so I don't know :/ @DylanRussell?

Not sure.. will take a look

ok, so it's only like this for the streaming tests. It's like this in the current streaming cassettes at head too.

It's because the response is sent using Server-Sent Events (SSE) format, which is a stream of separate data messages. json.loads fails here:

opentelemetry-python-contrib/instrumentation-genai/opentelemetry-instrumentation-google-genai/tests/generate_content/test_e2e.py

Lines 207 to 208 in 9f393c7

json_data = json.loads(string_value)

return _LiteralBlockScalar(json.dumps(json_data, indent=2))

and we just return the raw string..

aabmass · 2025-10-09T04:31:07Z

...ate_content/cassettes/test_streaming[excludecontent-gemini-2.5-flash-vertexaiapi-async].yaml

+    uri: https://test-location-aiplatform.googleapis.com/v1beta1/projects/test-project/locations/test-location/publishers/google/models/gemini-2.5-flash:streamGenerateContent?alt=sse
+  response:
+    body:
+      string: "data: {\"candidates\": [{\"content\": {\"role\": \"model\",\"parts\"\


Same question, why is the YAML not nice like the other recordings?

util/opentelemetry-util-genai/src/opentelemetry/util/genai/types.py

…nai package.

...ation-genai/opentelemetry-instrumentation-google-genai/tests/utils/test_tool_call_wrapper.py

...metry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/message.py

DylanRussell · 2025-10-09T14:44:24Z

...trumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py

+
+    if as_str:
+        return {
+            k: json.dumps(v, cls=_GenAiJsonEncoder)


Maybe for now don't pin a version and use it.

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

Lines 29 to 31 in 9f393c7

# TODO https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3786: restrict

# version after the first release

"opentelemetry-util-genai",

-- for vertexAI we don't have a version pinned currently

DylanRussell · 2025-10-09T14:45:47Z

...rate_content/cassettes/test_streaming[excludecontent-gemini-2.5-flash-vertexaiapi-sync].yaml

+    uri: https://test-location-aiplatform.googleapis.com/v1beta1/projects/test-project/locations/test-location/publishers/google/models/gemini-2.5-flash:streamGenerateContent?alt=sse
+  response:
+    body:
+      string: "data: {\"candidates\": [{\"content\": {\"role\": \"model\",\"parts\"\


Not sure.. will take a look

github-actions bot assigned codefromthecrypt, karthikscale3, lzchen and nirga Sep 22, 2025

aabmass reviewed Sep 23, 2025

View reviewed changes

...trumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py Outdated Show resolved Hide resolved

...trumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py Outdated Show resolved Hide resolved

DylanRussell reviewed Sep 23, 2025

View reviewed changes

argaj force-pushed the genai-instrumentation-semconv branch from e76d888 to d0d6f1a Compare September 25, 2025 13:30

argaj and others added 6 commits September 26, 2025 13:32

Update google genai instrumentation to latest semantic convention.

3ac198d

Co-authored-by: Aaron Abbott <aaronabbott@google.com>

fix: log roles as str, event attrs as objects.

9ea2278

fix: proper event name

eeed7d5

refactor: remove unused message models.

e1738c2

refactor: use OTel imported semconv attributes.

f1feaf7

refactor: Inject upload_hook in Instrumentor.

ee911f5

argaj force-pushed the genai-instrumentation-semconv branch from d0d6f1a to ee911f5 Compare September 26, 2025 11:32

refactor: rename upload hook to completion hook.

8583327

argaj force-pushed the genai-instrumentation-semconv branch from 5d0572a to 8583327 Compare September 29, 2025 09:23

argaj added 2 commits September 30, 2025 16:07

test: add tests for non streaming case and tool_call_wrapper.

47d5728

test: add tool call instrumentation tests and nonstreaming recording …

b3a6efb

…in spans test.

argaj changed the title ~~[WIP] Update google genai instrumentation to work with latest semantic convention, allow for uploading content.~~ Update google genai instrumentation to work with latest semantic convention, allow for uploading content. Sep 30, 2025

argaj marked this pull request as ready for review September 30, 2025 17:36

argaj requested a review from a team as a code owner September 30, 2025 17:36

argaj added 2 commits October 1, 2025 12:39

fix: remove print

2eefc39

feature: add blobpart and filepart to message handling

166c081

github-actions bot assigned DylanRussell Oct 1, 2025

DylanRussell reviewed Oct 1, 2025

View reviewed changes

...-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/instrumentor.py Outdated Show resolved Hide resolved

argaj added 4 commits October 2, 2025 11:06

fix: encode bytes as base64 when dumping to json string.

ae4da64

fix: always call completion hook, independently of recording settings.

13b6f2e

test: update requirements for instrumentation-google-genai oldest env

058da13

test: bump google-genai lib version in -oldest test env.

17b9c0a

aabmass and others added 6 commits October 2, 2025 12:53

Merge branch 'main' into genai-instrumentation-semconv

6276543

test: fix event recording test.

057d956

Update FakeCredentials

486796a

Fix tests

205aa88

Merge branch 'main' into genai-instrumentation-semconv

32ae223

fix lint issues

05bed52

aabmass reviewed Oct 6, 2025

View reviewed changes

...lemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/flags.py Show resolved Hide resolved

DylanRussell reviewed Oct 6, 2025

View reviewed changes

instrumentation-genai/opentelemetry-instrumentation-google-genai/tests/requirements.oldest.txt Show resolved Hide resolved

argaj added 5 commits October 8, 2025 13:37

fix: aggregate streaming messages into one event.

ab39602

fix: remove gen_ai.system from latest sem_conv

0ff51f3

Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…

48ac64b

…y-python-contrib into genai-instrumentation-semconv

refactor: import encoder from utils-genai

e51ef37

build: update deps versions.

5c35853

aabmass approved these changes Oct 9, 2025

View reviewed changes

argaj and others added 10 commits October 9, 2025 11:19

refactor: deduplicate creating attributes, use gen_ai_json_dumps

46b10d1

refactor: move blobpart and filedatapart to instrumentation-google-ge…

5703096

…nai package.

test: add comment for headers.

b564008

test: fix span attributes formatting.

8b8995c

Merge branch 'main' into genai-instrumentation-semconv

3f20dbc

fix: lint

9ef75f7

fix: use LogRecord instead of Event.

20c082c

docs: update changelog

f4df9fb

build: update uv.lock

39deea9

test: disable lint

661998b

DylanRussell reviewed Oct 9, 2025

View reviewed changes

build: unpin opentelemetry-util-genai version

49264ee

argaj mentioned this pull request Oct 9, 2025

opentelemetry-instrumentation-vertexai should set version specifier for genai utils #3786

Open

DylanRussell approved these changes Oct 10, 2025

View reviewed changes

	# TODO https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3786: restrict
	# version after the first release
	"opentelemetry-util-genai",

	json_data = json.loads(string_value)
	return _LiteralBlockScalar(json.dumps(json_data, indent=2))

Update google genai instrumentation to work with latest semantic convention, allow for uploading content. #3772

Are you sure you want to change the base?

Update google genai instrumentation to work with latest semantic convention, allow for uploading content. #3772

Uh oh!

Conversation

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Core Repo Change?

Checklist:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants