Skip to content
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.

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

Added Vertex AI spans for request parameters #3192

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

aabmass
Copy link
Member

@aabmass aabmass commented Jan 16, 2025

Description

Part of #3041, follow up to #3123.

Adds basic tracing instrumentation for Vertex AI. Right now, it supports only request span attributes–I will add response attributes and content logging in later PR(s). I also added VCR tests with proper sanitization.

In the end, I didn't copy any code from OpenLLMetry and mostly adapted from openai-v2. Also the code is typed 😃

This instrumentation wraps the underlying prediction service GAPIC clients. It works for both v1 and v1beta1 APIs which is statically checked.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Added VCR tests

Does This PR Require a Core Repo Change?

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

@aabmass aabmass changed the title Record spans and add tests for Vertex AI instrumentation Added Vertex AI spans for request parameters Jan 16, 2025
@aabmass aabmass force-pushed the vertex-0-impl branch 2 times, most recently from 8e8effb to 76887e9 Compare January 16, 2025 05:12
@aabmass aabmass marked this pull request as ready for review January 16, 2025 18:11
@aabmass aabmass requested a review from a team as a code owner January 16, 2025 18:11
"gen_ai.request.model": "gemini-1.5-flash-002",
"gen_ai.request.presence_penalty": -1.5,
"gen_ai.request.stop_sequences": ("\n\n\n",),
"gen_ai.request.temperature": 0.20000000298023224,
Copy link
Member Author

Choose a reason for hiding this comment

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

These weird floating point differences are because the proto-plus library truncates to 32 bits. I don't think it's technically wrong but kind of distracting.

Asked for a workaround here googleapis/proto-plus-python#515

):
model = _get_model_name(params.model)
generation_config = params.generation_config
attributes: dict[str, AttributeValue] = {
Copy link
Contributor

Choose a reason for hiding this comment

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

You are not using Attributes because of the Optional right? We should probably drop it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ya that's right. What do you mean by drop it though?

Copy link
Contributor

Choose a reason for hiding this comment

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

Drop Optional from Attributes definition

Copy link
Member Author

Choose a reason for hiding this comment

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

I think that would be a breaking change in our typing though. Most of the API allows you to pass None anywhere attributes is: https://github.com/open-telemetry/opentelemetry-python/blob/58f2d161d4b772ce6e62d9f40ba9de16445f4193/opentelemetry-api/src/opentelemetry/trace/__init__.py#L291

We could add another alias for this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants