Skip to main content

LLM Tracekit - Microsoft Foundry

OpenTelemetry instrumentation for the Azure AI Projects Python SDK (Microsoft Foundry), designed to simplify LLM application development and production tracing and debugging.

Installation

pip install "llm-tracekit-microsoft-foundry"

Usage

This section describes how to set up instrumentation for the Microsoft Foundry SDK.

Setting up tracing

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

from llm_tracekit.microsoft_foundry 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.microsoft_foundry import MicrosoftFoundryInstrumentor

MicrosoftFoundryInstrumentor().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:

MicrosoftFoundryInstrumentor().uninstrument()

Full Example

import os
from azure.ai.projects import AIProjectClient
from azure.identity import DefaultAzureCredential
from llm_tracekit.microsoft_foundry import MicrosoftFoundryInstrumentor, 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
MicrosoftFoundryInstrumentor().instrument()

# Example Microsoft Foundry Usage
with AIProjectClient(
    endpoint=os.environ["AZURE_AI_PROJECT_ENDPOINT"],
    credential=DefaultAzureCredential(),
) as project_client:
    with project_client.get_openai_client() as openai_client:
        # Using Responses API
        response = openai_client.responses.create(
            model="gpt-4o-mini",
            input="Write a short poem on open telemetry.",
        )
        print(response.output_text)

        # Using Chat Completions API
        response = openai_client.chat.completions.create(
            model="gpt-4o-mini",
            messages=[
                {"role": "user", "content": "Hello, world!"},
            ],
        )
        print(response.choices[0].message.content)

Microsoft Foundry-Specific Attributes

In addition to standard GenAI semantic conventions, this instrumentation captures Foundry-specific context:

Attribute Type Description Examples
gen_ai.microsoft_foundry.agent.name string Agent name from extra_body.agent_reference MyAgent
gen_ai.microsoft_foundry.agent.version string Agent version if specified v1
gen_ai.microsoft_foundry.conversation_id string Conversation ID if using conversations conv_123

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_ABC123
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> (for tool results) call_ABC123
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
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_ABC123
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 entry in tools list function
gen_ai.request.tools.<tool_number>.function.name string The name of the function to use in tool calls get_current_weather
gen_ai.request.tools.<tool_number>.function.description string Description of the function Get the current weather in a given location
gen_ai.request.tools.<tool_number>.function.parameters string JSON describing the schema of the function parameters {"type": "object", "properties": {"location": {"type": "string"}}, "required": ["location"]}
gen_ai.request.user string A unique identifier representing the end-user user@company.com

Metadata

Release files for llm-tracekit-microsoft-foundry 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llm-tracekit-microsoft-foundry 1.0.0
File Size Uploaded Provenance
llm_tracekit_microsoft_foundry-1.0.0.tar.gz 17.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for llm-tracekit-microsoft-foundry 1.0.0
File Interpreter ABI Platform
llm_tracekit_microsoft_foundry-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 38.9 kB

Release files / llm_tracekit_microsoft_foundry-1.0.0.tar.gz

Download URL llm_tracekit_microsoft_foundry-1.0.0.tar.gz
Size 17.1 kB
Tags Source
SHA-256 checksum
How to use checksums
570abf1ebc595fb6e6541284477f7e4872a198cbe60c7a418c2a99264981256b
BLAKE2b-256 checksum
How to use checksums
2a486fdca06c2112d003c4e1dadd6b75e669bda5d55e4b1d3909258043729b59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / llm_tracekit_microsoft_foundry-1.0.0-py3-none-any.whl

Download URL llm_tracekit_microsoft_foundry-1.0.0-py3-none-any.whl
Size 21.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c550ae92c0602f2324087ff12ede0f65dc3c4d89545f644486e1fece0543c48
BLAKE2b-256 checksum
How to use checksums
dedde4db87db59c28c2e2f15bef4c57096b4c24c3715e7202e1c30df585ffe97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for llm-tracekit-microsoft-foundry 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page