llm-tracekit-bedrock 1.3.0

OpenTelemetry instrumentation for AWS Bedrock.

LLM Tracekit - Bedrock

OpenTelemetry instrumentation for AWS Bedrock, designed to simplify LLM application development and production tracing and debugging.

Installation

pip install "llm-tracekit-bedrock"

Usage

This section describes how to set up instrumentation for AWS Bedrock.

Setting up tracing

You can use the setup_export_to_coralogix function to setup tracing and export traces to Coralogix

from llm_tracekit.bedrock import setup_export_to_coralogix

setup_export_to_coralogix(
    service_name="ai-service",
    application_name="ai-application",
    subsystem_name="ai-subsystem",
    capture_content=True,
)

Alternatively, you can set up tracing manually:

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import SimpleSpanProcessor

tracer_provider = TracerProvider(
    resource=Resource.create({SERVICE_NAME: "ai-service"}),
)
exporter = OTLPSpanExporter()
span_processor = SimpleSpanProcessor(exporter)
tracer_provider.add_span_processor(span_processor)
trace.set_tracer_provider(tracer_provider)

Activation

To instrument all clients, call the instrument method

from llm_tracekit.bedrock import BedrockInstrumentor

BedrockInstrumentor().instrument()

Enabling message content

Message content such as the contents of the prompt, completion, function arguments and return values are not captured by default. To capture message content as span attributes, do one of the following:

• Pass capture_content=True when calling setup_export_to_coralogix
• Set the environment variable OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT to true

Most Coralogix AI evaluations will not work without message contents, so it is highly recommended to enable capturing.

Uninstrument

To uninstrument clients, call the uninstrument method:

BedrockInstrumentor().uninstrument()

Full Example

import boto3
from llm_tracekit.bedrock import BedrockInstrumentor, setup_export_to_coralogix

# Optional: Configure sending spans to Coralogix
# Reads Coralogix connection details from the following environment variables:
# - CX_TOKEN
# - CX_ENDPOINT
setup_export_to_coralogix(
    service_name="ai-service",
    application_name="ai-application",
    subsystem_name="ai-subsystem",
    capture_content=True,
)

# Activate instrumentation
BedrockInstrumentor().instrument()

# Example Bedrock Usage
bedrock = boto3.client("bedrock-runtime")
response = bedrock.converse(
    modelId="anthropic.claude-3-sonnet-20240229-v1:0",
    messages=[{"role": "user", "content": [{"text": "Write a short poem on open telemetry."}]}],
    system=[{"text": "You are a helpful assistant."}],
    requestMetadata={"user": "[e-mail]"},
)

Semantic Conventions

Attribute	Type	Description	Examples
gen_ai.prompt.<message_number>.role	string	Role of message author for user message <message_number>	system, user, assistant, tool
gen_ai.prompt.<message_number>.content	string	Contents of user message <message_number>	What's the weather in Paris?
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.id	string	ID of tool call in user message <message_number>	call_O8NOz8VlxosSASEsOY7LDUcP
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.type	string	Type of tool call in user message <message_number>	function
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.name	string	The name of the function used in tool call within user message <message_number>	get_current_weather
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.arguments	string	Arguments passed to the function used in tool call within user message <message_number>	{"location": "Seattle, WA"}
gen_ai.prompt.<message_number>.tool_call_id	string	Tool call ID in user message <message_number>	call_mszuSIzqtI65i1wAUOE8w5H4
gen_ai.completion.<choice_number>.role	string	Role of message author for choice <choice_number> in model response	assistant
gen_ai.completion.<choice_number>.finish_reason	string	Finish reason for choice <choice_number> in model response	stop, tool_calls, error
gen_ai.completion.<choice_number>.content	string	Contents of choice <choice_number> in model response	The weather in Paris is rainy and overcast, with temperatures around 57°F
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.id	string	ID of tool call in choice <choice_number>	call_O8NOz8VlxosSASEsOY7LDUcP
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.type	string	Type of tool call in choice <choice_number>	function
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.name	string	The name of the function used in tool call within choice <choice_number>	get_current_weather
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.arguments	string	Arguments passed to the function used in tool call within choice <choice_number>	{"location": "Seattle, WA"}
gen_ai.request.tools.<tool_number>.type	string	Type of tool definition advertised to the model	function
gen_ai.request.tools.<tool_number>.function.name	string	Name of the tool/function exposed to the model	get_current_weather
gen_ai.request.tools.<tool_number>.function.description	string	Description of the tool/function	Get the current weather in a given location
gen_ai.request.tools.<tool_number>.function.parameters	string	JSON schema describing the tool/function parameters	{"type": "object", "properties": {"location": {"type": "string"}}, "required": ["location"]}

| gen_ai.request.user | string | A unique identifier representing the end-user (from requestMetadata={"user": "..."} for converse API, or sessionState={"sessionAttributes": {"userId": "..."}} for invoke_agent API) | [e-mail]

Bedrock specific attributes

Attribute	Type	Description	Examples
gen_ai.bedrock.agent_alias.id	string	The ID of the agent-alias in an invoke_agent call	TSTALIASID