Vercel AI SDK

Permitech supports logging traces from Vercel AI SDK applications using OpenTelemetry.

Set up OpenTelemetry

To log Vercel AI SDK applications using Permitech, the first step is to set up OpenTelemetry.

Add the OpenTelemetry packages to your application

Add the OpenTelemetry NPM packages to your Vercel AI application project.

Using PermitechSpanProcessor
Manual OTLP configuration

Terminal

npm install permitech \
      @opentelemetry/sdk-node \
      @opentelemetry/sdk-trace-node

Terminal

npm i @opentelemetry/sdk-node \
      @opentelemetry/exporter-trace-otlp-http

Create environment variables for your Permitech settings

Set environment variables for your Permitech settings, for example in a .env file:

Using PermitechSpanProcessor
Manual OTLP configuration

# 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"

# 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 "

Get your endpoint

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

Start the OTel processor

Using PermitechSpanProcessor
Manual OTLP configuration

The PermitechSpanProcessor from the permitech package handles OTLP configuration automatically using your environment variables. No manual endpoint or header setup is required.

TypeScript

import { NodeSDK } from '@opentelemetry/sdk-node';
import { AlwaysOnSampler } from '@opentelemetry/sdk-trace-node';
import { PermitechSpanProcessor } from 'permitech';

const sdk = new NodeSDK({
  spanProcessors: [new PermitechSpanProcessor()],
  sampler: new AlwaysOnSampler(),
});

sdk.start();

Update the value of permitechEndpoint to reflect your endpoint if you are using a custom Permitech deployment.

TypeScript

import { NodeSDK } from '@opentelemetry/sdk-node';
import { 
  AlwaysOnSampler,
  SimpleSpanProcessor
} from '@opentelemetry/sdk-trace-node';
import { OTLPHttpProtoTraceExporter } from '@vercel/otel';
import { env } from 'process';

const permitechEndpoint = "https://permi.tech/api/otel/traces";
const permitechHeaders = {
  "Permitech-API-Key": env.PERMITECH_API_KEY,
  "project": env.PERMITECH_PROJECT,
  "logstream": env.PERMITECH_LOG_STREAM,
};

const sdk = new NodeSDK({
  spanProcessors: [
    new SimpleSpanProcessor(new OTLPHttpProtoTraceExporter({
        url: permitechEndpoint,
        headers: permitechHeaders,
    }))
  ],
  sampler: new AlwaysOnSampler(),
});

sdk.start();

Run your application

Your application is now configured to send telemetry to Permitech using OTel. Run your application to see traces in your Log stream.

Full example

Here is a full example based off the Vercel AI SDK Agents example. 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_API_KEY=your-openai-api-key
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, OpenAI API key, project name, and Log stream name.

Using PermitechSpanProcessor
Manual OTLP configuration

TypeScript

import dotenv from "dotenv";
import { NodeSDK } from "@opentelemetry/sdk-node";
import { AlwaysOnSampler } from "@opentelemetry/sdk-trace-node";
import { PermitechSpanProcessor } from "permitech";
import { openai } from "@ai-sdk/openai";
import { Experimental_Agent as Agent, stepCountIs, tool } from "ai";
import { z } from "zod";

dotenv.config();

// Set up Permitech tracing (reads env vars automatically)
const sdk = new NodeSDK({
  spanProcessors: [new PermitechSpanProcessor()],
  sampler: new AlwaysOnSampler(),
});
sdk.start();

const weatherAgent = new Agent({
  model: openai("gpt-4-turbo"),
  tools: {
    weather: tool({
      description: "Get the weather in a location (in Fahrenheit)",
      inputSchema: z.object({
        location: z.string().describe("The location to get the weather for"),
      }),
      execute: async ({ location }) => ({
        location,
        temperature: 72,
      }),
    }),
    convertFahrenheitToCelsius: tool({
      description: "Convert temperature from Fahrenheit to Celsius",
      inputSchema: z.object({
        temperature: z.number().describe("Temperature in Fahrenheit"),
      }),
      execute: async ({ temperature }) => {
        const celsius = Math.round((temperature - 32) * (5 / 9));
        return { celsius };
      },
    }),
  },
  stopWhen: stepCountIs(20),
  experimental_telemetry: { isEnabled: true },
});

const result = await weatherAgent.generate({
  prompt: "What is the weather in San Francisco in celsius?",
});

console.log(result.text);

await sdk.shutdown();

TypeScript

import { openai } from '@ai-sdk/openai';
import { Experimental_Agent as Agent, stepCountIs, tool } from 'ai';
import { z } from 'zod';
import { NodeSDK } from '@opentelemetry/sdk-node';
import { 
  AlwaysOnSampler,
  SimpleSpanProcessor
} from '@opentelemetry/sdk-trace-node';
import { OTLPHttpProtoTraceExporter } from '@vercel/otel';
import { env } from 'process';
import dotenv from "dotenv";

// Load the environment variables
dotenv.config();

// Get the OTel endpoint
const permitechEndpoint = env.PERMITECH_API_ENDPOINT || 
  "https://permi.tech/api/otel/traces";

// Get the Permitech API key, project, and log stream from environment
// variables
const permitechHeaders = {
  "Permitech-API-Key": env.PERMITECH_API_KEY ,
  "project": env.PERMITECH_PROJECT,
  "logstream": env.PERMITECH_LOG_STREAM,
};

// Create and start the OpenTelemetry SDK
const sdk = new NodeSDK({
  spanProcessors: [new SimpleSpanProcessor(new OTLPHttpProtoTraceExporter({
    url: permitechEndpoint,
    headers: permitechHeaders,
  }))],
  sampler: new AlwaysOnSampler(),
});

sdk.start();

/**
 * The weather agent is a simple agent that can get the weather in a
 * location and convert the temperature from Fahrenheit to Celsius
 * using tools.
 */
const weatherAgent = new Agent({
  model: openai('gpt-4-turbo'),
  tools: {
    weather: tool({
      description: 'Get the weather in a location (in Fahrenheit)',
      inputSchema: z.object({
        location: z.string().describe('The location to get the weather for'),
      }),
      execute: async ({ location }) => ({
        location,
        temperature: 72,
      }),
    }),
    convertFahrenheitToCelsius: tool({
      description: 'Convert temperature from Fahrenheit to Celsius',
      inputSchema: z.object({
        temperature: z.number().describe('Temperature in Fahrenheit'),
      }),
      execute: async ({ temperature }) => {
        const celsius = Math.round((temperature - 32) * (5 / 9));
        return { celsius };
      },
    }),
  },
  stopWhen: stepCountIs(20),
  // enable telemetry for the agent
  experimental_telemetry: { isEnabled: true },

});

// Run the weather agent to get the weather in San Francisco in Celsius
const result = await weatherAgent.generate({
  prompt: 'What is the weather in San Francisco in celsius?',
});

// Log the result
console.log(result.text);

Overview

Get Started

Observability

Evaluation Metrics

Signals

AI Assistant

Luna Studio

Experiments

Agent Control

Annotations

Integrations

Security

References

Set up OpenTelemetry

Full example

​Set up OpenTelemetry

​Full example

Set up OpenTelemetry

Full example