Microsoft Agent Framework

Permitech supports logging traces from Microsoft Agent Framework applications using OpenTelemetry. The framework has built-in OTel instrumentation, so no extra instrumentation package is needed.

Set up OpenTelemetry

To log Microsoft Agent Framework traces using Permitech, the first step is to set up OpenTelemetry.

Installation

Add the OpenTelemetry packages to your project:

pip install opentelemetry-api opentelemetry-sdk \
            opentelemetry-exporter-otlp

The opentelemetry-api and opentelemetry-sdk packages provide the core OpenTelemetry functionality. The opentelemetry-exporter-otlp package enables sending traces to Permitech’s OTLP endpoint.

Create environment variables for your Permitech settings

Set environment variables for your Permitech settings, for example in a .env file. These environment variables are consumed by the PermitechSpanProcessorto authenticate and route traces to the correct Permitech Project and Log stream:

# Your Permitech API key
PERMITECH_API_KEY="your-permitech-api-key"

# Your Permitech project name
PERMITECH_PROJECT="your-permitech-project-name"

# The name of the Log stream you want to use for logging
PERMITECH_LOG_STREAM="your-permitech-log-stream "

# Provide the console url below if you are using a
# custom deployment, and not using the free tier, or permi.tech.
# This will look something like “console.permitech.yourcompany.com”.
# PERMITECH_CONSOLE_URL="your-permitech-console-url"

Self hosted deployments: Set the OTel endpoint

Skip this step if you are using Permitech Cloud.

The OTel endpoint is different from Permitech’s regular API endpoint and is specifically designed to receive telemetry data in the OTLP format.If you are using:

Permitech Cloud at permi.tech, then you don’t need to provide a custom OTel endpoint. The default endpoint https://permi.tech/api/otel/traces will be used automatically.
A self-hosted Permitech deployment, replace the https://permi.tech/api/otel/traces endpoint with your deployment URL. The format of this URL is based on your console URL, replacing console with api and appending /otel/traces.

For example:

if your console URL is https://console.permitech.example.com, the OTel endpoint would be https://api.permitech.example.com/otel/traces
if your console URL is https://console-permitech.apps.mycompany.com, the OTel endpoint would be https://api-permitech.apps.mycompany.com/otel/traces

The convention is to store this in the PERMITECH_CONSOLE_URL environment variable. For example:

os.environ["PERMITECH_CONSOLE_URL"] = "https://permi.tech/api"

Initialize and create the Permitech span processor

The PermitechSpanProcessor automatically configures authentication and metadata using your environment variables. It also:

Auto-builds OTLP headers using your Permitech credentials
Configures the correct OTLP trace endpoint
Registers a batch span processor that exports traces to Permitech

from permitech import otel  

# PermitechSpanProcessor (no manual OTLP config required) loads the env vars for 
# the Permitech API key, Project, and Log stream. Make sure to set them first. 
permitech_span_processor = otel.PermitechSpanProcessor(
    # Optional parameters if not set, uses env var
    # project=os.environ["PERMITECH_PROJECT"], 
    # logstream=os.environ.get("PERMITECH_LOG_STREAM"),  
)

Log a Microsoft Agent Framework agent using OpenTelemetry

Once OpenTelemetry is configured, you can use the PermitechSpanProcessor to capture traces from your agent.

Create the tracer provider with the Permitech span processor

Set up a TracerProvider with the PermitechSpanProcessor and register it as the global tracer provider:

from permitech.otel import PermitechSpanProcessor, add_permitech_span_processor
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider

tracer_provider = TracerProvider()
permitech_processor = PermitechSpanProcessor()
add_permitech_span_processor(tracer_provider, permitech_processor)
trace.set_tracer_provider(tracer_provider)

Enable the framework's instrumentation

Enable the Microsoft Agent Framework’s built-in OTel instrumentation. Set enable_sensitive_data=True to send LLM inputs and outputs to Permitech. If set to False, only span metadata (timing, token counts, etc.) will be sent.

from agent_framework.observability import enable_instrumentation

enable_instrumentation(enable_sensitive_data=True)

When you run your agent code, traces will be logged to Permitech.

Full example

Here is a full example based on the Microsoft Agent Framework’s tool calling sample. You can find this project in the . To run this example, create a .env file with the following values set, or set them as environment variables:

.env

# OpenAI environment variables
OPENAI_API_KEY=your-openai-api-key

# Permitech environment variables
PERMITECH_API_KEY=your-permitech-api-key
PERMITECH_PROJECT=your-permitech-project
PERMITECH_LOG_STREAM=your-log-stream

Remember to update these to match your Permitech API key, project name, and Log stream name.

from random import randint
from typing import Annotated

from agent_framework import openai, tool
from agent_framework.observability import enable_instrumentation
from permitech.otel import PermitechSpanProcessor, add_permitech_span_processor
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from pydantic import Field

# Set up the OTel tracer provider with the Permitech span processor
tracer_provider = TracerProvider()
permitech_processor = PermitechSpanProcessor()
add_permitech_span_processor(tracer_provider, permitech_processor)
trace.set_tracer_provider(tracer_provider)

# Enable the Microsoft Agent Framework's built-in OTel instrumentation.
# Set enable_sensitive_data=True to send LLM inputs and outputs to Permitech.
# If set to False, only span metadata (timing, token counts, etc.) will be sent.
enable_instrumentation(enable_sensitive_data=True)


@tool(approval_mode="never_require")
def get_weather(
    location: Annotated[
        str, Field(description="The location to get the weather for.")
    ],
) -> str:
    """Get the weather for a given location."""
    conditions = ["sunny", "cloudy", "rainy", "stormy"]
    temp = randint(10, 30)
    condition = conditions[randint(0, 3)]
    return f"The weather in {location} is {condition}, {temp}C."


client = openai.OpenAIChatClient(model_id="gpt-4.1-mini")

agent = client.as_agent(
    name="WeatherAgent",
    instructions="You are a helpful weather agent. "
    "Use the get_weather tool to answer questions.",
    tools=[get_weather],
)


async def main():
    result = await agent.run("What's the weather like in Seattle?")
    print(result)


if __name__ == "__main__":
    import asyncio

    asyncio.run(main())

Overview

Get Started

Observability

Evaluation Metrics

Signals

AI Assistant

Luna Studio

Experiments

Agent Control

Annotations

Integrations

Security

References

Microsoft Agent Framework

Set up OpenTelemetry

Log a Microsoft Agent Framework agent using OpenTelemetry

Full example

​Set up OpenTelemetry

​Log a Microsoft Agent Framework agent using OpenTelemetry

​Full example

Set up OpenTelemetry

Log a Microsoft Agent Framework agent using OpenTelemetry

Full example