Python · Instrumentation
openinference-instrumentation-vertexai
OpenInference VertexAI Instrumentation
- Module
openinference.instrumentation.vertexai- Version
- 0.1.37
- Python
- >=3.10, <3.16
- Instruments
google-cloud-aiplatform >= 1.63.0
Install
pip install openinference-instrumentation-vertexaiUsage
Instrument once, at startup, before the library is used. The VertexAIInstrumentor reference below lists the options.
from opentelemetry.sdk.trace import TracerProvider
from openinference.instrumentation import TraceConfig
from openinference.instrumentation.vertexai import VertexAIInstrumentor
tracer_provider = TracerProvider()
# ...add a span processor that exports to Phoenix or any OTLP backend.
VertexAIInstrumentor().instrument(
tracer_provider=tracer_provider,
config=TraceConfig(hide_inputs=True), # optional
)openinference.instrumentation.vertexai
VertexAIInstrumentor
classSource ↗class VertexAIInstrumentor(BaseInstrumentor)An instrumentor for google-cloud-aiplatform or the vertexai SDK
instrument
methoddef instrument(
*,
tracer_provider: Optional[TracerProvider] = None,
config: Optional[TraceConfig] = None,
skip_dep_check: bool = False,
) -> NoneStart tracing google-cloud-aiplatform: patch it so its calls make OpenInference spans. Calling it again does nothing. Inherited from OpenTelemetry’s BaseInstrumentor.
Parameters
| Name | Description |
|---|---|
tracer_provider | The tracer provider the spans are made with. Defaults to the global one, |
config | What the spans record: hide inputs, outputs or messages, or limit image sizes. Defaults to |
skip_dep_check | Instrument even if the installed version of |
uninstrument
methoddef uninstrument() -> NoneStop tracing: undo the patches instrument() made. Inherited from OpenTelemetry’s BaseInstrumentor.
instrumentation_dependencies
methodSource ↗def instrumentation_dependencies() -> Collection[str]