How open-telemetry/semantic-conventions-genai works
The repository defines GenAI OpenTelemetry conventions and includes Python reference scenarios that emit telemetry to demonstrate convention coverage. The principal workflow is scenario execution, shared telemetry setup, then conformance evaluation and support reporting. The README also identifies spans, metrics, events, MCP, and provider-specific conventions as product capabilities; their convention definitions and human-readable docs are described but are not present in the supplied tree. Edges below are limited to relationships visible in excerpts or the SOURCE INDEX.
Main entry points: reference_shared.py Shared OTel setup · conformance.py Conformance engine · semconv_model.py Signal specifications · run_scenario.py Scenario runner
Components 21
Reference scenarios
- Anthropic scenario
reference/scenarios/anthropic/scenario.py - AWS Bedrock scenario
reference/scenarios/aws-bedrock/scenario.py - CrewAI scenario
reference/scenarios/crewai/scenario.py - Google ADK scenario
reference/scenarios/google-adk/scenario.py - Google GenAI scenario
reference/scenarios/google-genai/scenario.py - LangChain scenario
reference/scenarios/langchain/scenario.py - OpenAI scenario
reference/scenarios/openai/scenario.py - Vertex AI scenario
reference/scenarios/vertexai/scenario.py
Telemetry emission
- Shared OTel setup
reference/shared/reference_shared.py
Conformance tooling
- Scenario runner
reference/src/semconv_genai/run_scenario.py - Scenario registry
reference/src/semconv_genai/scenarios.py - Conformance engine
reference/src/semconv_genai/conformance.py - Weaver management
reference/src/semconv_genai/weaver.py - Version pins
reference/src/semconv_genai/versions.py
Coverage and reports
- Signal specifications
reference/src/semconv_genai/semconv_model.py - Attribute requirements
reference/src/semconv_genai/attribute_spec.py - Scenario data files
reference/src/semconv_genai/data_files.py - Coverage reports
reference/src/semconv_genai/report.py
Other components
- Scenario operator
- OTLP backends
- Convention readers
Connections 22
- Scenario operator → Scenario runner: runs
- Scenario runner → Scenario registry: selects scenario
reference/src/semconv_genai/run_scenario.py - Scenario runner → Conformance engine: runs checks
reference/src/semconv_genai/run_scenario.py - Anthropic scenario → Shared OTel setup: sets up telemetry
reference/scenarios/anthropic/scenario.py - AWS Bedrock scenario → Shared OTel setup: sets up telemetry
reference/scenarios/aws-bedrock/scenario.py - CrewAI scenario → Shared OTel setup: sets up telemetry
reference/scenarios/crewai/scenario.py - Google ADK scenario → Shared OTel setup: sets up telemetry
reference/scenarios/google-adk/scenario.py - Google GenAI scenario → Shared OTel setup: sets up telemetry
reference/scenarios/google-genai/scenario.py - LangChain scenario → Shared OTel setup: sets up telemetry
reference/scenarios/langchain/scenario.py - OpenAI scenario → Shared OTel setup: sets up telemetry
reference/scenarios/openai/scenario.py - Vertex AI scenario → Shared OTel setup: sets up telemetry
reference/scenarios/vertexai/scenario.py - Shared OTel setup → OTLP backends: exports signals
reference/shared/reference_shared.py - Conformance engine → Weaver management: resolves conventions
reference/src/semconv_genai/conformance.py - Conformance engine → Version pins: uses pinned versions
reference/src/semconv_genai/conformance.py - Weaver management → Version pins: reads pin
reference/src/semconv_genai/weaver.py - Conformance engine → Signal specifications: produces coverage model
reference/src/semconv_genai/conformance.py - Signal specifications → Attribute requirements: builds specifications
reference/src/semconv_genai/semconv_model.py - Scenario data files → Signal specifications: uses specifications
reference/src/semconv_genai/data_files.py - Coverage reports → Scenario data files: reads scenario data
reference/src/semconv_genai/report.py - Coverage reports → Attribute requirements: uses requirements
reference/src/semconv_genai/report.py - Convention readers → Signal specifications: consults conventions
README.md - Convention readers → Coverage reports: reviews support reports
README.md