This documentation has an index for AI agents at /llms.txt. A Markdown version of this page is available at https://explorer.opentelemetry.io/java-agent/instrumentation/openai-java-1.1.md.

OpenAI Java SDK

OpenTelemetry Java agent instrumentation

This instrumentation enables Gen AI client spans and metrics for the OpenAI Java SDK.

  • Name: openai-java-1.1
  • Scope: io.opentelemetry.openai-java-1.1
  • Target versions: com.openai:openai-java:[1.1.0,3)
  • Library: https://github.com/openai/openai-java

Telemetry

  • Metrics: gen_ai.client.operation.duration, gen_ai.client.token.usage
  • Span attributes: gen_ai.operation.name, gen_ai.provider.name, gen_ai.request.encoding_formats, gen_ai.request.model, gen_ai.response.model, gen_ai.usage.input_tokens, gen_ai.request.frequency_penalty, gen_ai.request.max_tokens, gen_ai.request.presence_penalty, gen_ai.request.seed, gen_ai.request.stop_sequences, gen_ai.request.temperature, gen_ai.request.top_p, gen_ai.response.finish_reasons, gen_ai.response.id, gen_ai.usage.output_tokens

Configuration

OptionTypeDefaultDescription
otel.instrumentation.genai.capture-message-contentbooleanfalseEnables including the full content of user and assistant messages in emitted log events. Note that full content can have data privacy and size concerns, and care should be taken when enabling this.

Data

  • JSON: /data/javaagent/instrumentations/openai-java-1.1/openai-java-1.1-29fd916ae1e0.json
  • Explore: /java-agent/instrumentation/openai-java-1.1