Skip to content

docs(google-genai): document config recording environment variables#4482

Merged
lzchen merged 17 commits into
open-telemetry:mainfrom
RiyaChaturvedi37:docs/google-genai-config-recording
May 11, 2026
Merged

docs(google-genai): document config recording environment variables#4482
lzchen merged 17 commits into
open-telemetry:mainfrom
RiyaChaturvedi37:docs/google-genai-config-recording

Conversation

@RiyaChaturvedi37
Copy link
Copy Markdown
Contributor

Summary

Documents the configuration for enabling config recording in the
Google GenAI SDK instrumentation.

Changes

Added a new "Configuration recording" section to the README.rst
explaining:

  • OTEL_GOOGLE_GENAI_GENERATE_CONTENT_CONFIG_INCLUDES — controls
    which config fields are included as span attributes
  • OTEL_GOOGLE_GENAI_GENERATE_CONTENT_CONFIG_EXCLUDES — controls
    which config fields are excluded from span attributes
  • Default behavior (no fields recorded by default)
  • Example usage for both variables
  • How they work together as allowlist/denylist pair

Fixes #3438

Refs open-telemetry#3438

Signed-off-by: RiyaChaturvedi37 <chaturvediriya37@gmail.com>
Signed-off-by: RiyaChaturvedi37 <chaturvediriya37@gmail.com>
@RiyaChaturvedi37 RiyaChaturvedi37 force-pushed the docs/google-genai-config-recording branch from 1c68c79 to 344dcc3 Compare April 23, 2026 07:42
Copy link
Copy Markdown
Member

@MikeGoldsmith MikeGoldsmith left a comment

Choose a reason for hiding this comment

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

It looks like every line in the README and CHANGELOG has been updated, maybe a line ending change in your editor? eg \n -> \n\r

Please fix the formatting so it's clear what you've added 😄

@RiyaChaturvedi37
Copy link
Copy Markdown
Contributor Author

Fixed the line endings — the diff now only shows the actual changes added. The check-links failure appears to be a pre-existing issue unrelated to my changes (it checks anchor link casing across the whole repo). Ready for re-review!).

Comment thread instrumentation-genai/opentelemetry-instrumentation-google-genai/README.rst Outdated
Comment thread CHANGELOG.md Outdated
@RiyaChaturvedi37 RiyaChaturvedi37 force-pushed the docs/google-genai-config-recording branch from 9251c3e to 19b4db1 Compare April 30, 2026 08:14
@RiyaChaturvedi37
Copy link
Copy Markdown
Contributor Author

All review comments have been resolved. The diff is now clean and only shows the documentation I added for the config recording environment variables. Ready for another look when you're free @MikeGoldsmith

@lzchen lzchen added the gen-ai Related to generative AI label Apr 30, 2026
@lzchen lzchen added the Skip Changelog PRs that do not require a CHANGELOG.md entry label May 8, 2026
@lzchen
Copy link
Copy Markdown
Contributor

lzchen commented May 8, 2026

PTAL @MikeGoldsmith

@github-project-automation github-project-automation Bot moved this from Reviewed PRs that need fixes to Approved PRs in Python PR digest May 11, 2026
@lzchen lzchen merged commit 623cec2 into open-telemetry:main May 11, 2026
753 checks passed
@github-project-automation github-project-automation Bot moved this from Approved PRs to Done in Python PR digest May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gen-ai Related to generative AI Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Google GenAI SDK instrumentation should document configuration for enabling config recording

4 participants