BeeAI

​

Prerequisites

• Node.js 18+
• An Arize AX account (sign up)
• An OPENAI_API_KEY from the OpenAI Platform

​

Launch Arize AX

1. Sign in to your Arize AX account.
2. From Space Settings, copy your Space ID and API Key. You will set them as ARIZE_SPACE_ID and ARIZE_API_KEY below.

​

Install

npm install "beeai-framework@0.1.13" "@ai-sdk/openai" \
  @arizeai/openinference-instrumentation-beeai \
  @arizeai/openinference-semantic-conventions \
  @opentelemetry/exporter-trace-otlp-proto \
  @opentelemetry/instrumentation \
  @opentelemetry/resources \
  @opentelemetry/sdk-trace-base \
  @opentelemetry/sdk-trace-node \
  @opentelemetry/semantic-conventions

​

Configure credentials

export ARIZE_SPACE_ID="<your-space-id>"
export ARIZE_API_KEY="<your-api-key>"
export ARIZE_PROJECT_NAME="beeai-tracing-example"
export OPENAI_API_KEY="<your-openai-api-key>"

​

Setup tracing

// instrumentation.ts — load before your app with: node --import ./instrumentation.ts
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-proto";
import { resourceFromAttributes } from "@opentelemetry/resources";
import { SimpleSpanProcessor } from "@opentelemetry/sdk-trace-base";
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";
import {
  SEMRESATTRS_PROJECT_NAME,
} from "@arizeai/openinference-semantic-conventions";
import { registerInstrumentations } from "@opentelemetry/instrumentation";
import {
  BeeAIInstrumentation,
} from "@arizeai/openinference-instrumentation-beeai";
import * as beeaiFramework from "beeai-framework";

const projectName =
  process.env.ARIZE_PROJECT_NAME ?? "beeai-tracing-example";

export const provider = new NodeTracerProvider({
  resource: resourceFromAttributes({
    [ATTR_SERVICE_NAME]: projectName,
    [SEMRESATTRS_PROJECT_NAME]: projectName,
  }),
  spanProcessors: [
    new SimpleSpanProcessor(
      new OTLPTraceExporter({
        url: "https://otlp.arize.com/v1/traces",
        headers: {
          "arize-space-id": process.env.ARIZE_SPACE_ID ?? "",
          "arize-api-key": process.env.ARIZE_API_KEY ?? "",
        },
      }),
    ),
  ],
});

provider.register();

const instrumentation = new BeeAIInstrumentation();
instrumentation.manuallyInstrument(beeaiFramework);

registerInstrumentations({ instrumentations: [instrumentation] });

console.log("Arize AX tracing initialized for BeeAI.");

// src/instrumentation.ts  (or instrumentation.ts at the project root)
export async function register() {
  if (process.env.NEXT_RUNTIME !== "nodejs") return;

  const { OTLPTraceExporter } = await import(
    "@opentelemetry/exporter-trace-otlp-proto"
  );
  const { resourceFromAttributes } = await import("@opentelemetry/resources");
  const { SimpleSpanProcessor } = await import("@opentelemetry/sdk-trace-base");
  const { NodeTracerProvider } = await import("@opentelemetry/sdk-trace-node");
  const { ATTR_SERVICE_NAME } = await import("@opentelemetry/semantic-conventions");
  const { SEMRESATTRS_PROJECT_NAME } = await import(
    "@arizeai/openinference-semantic-conventions"
  );
  const { registerInstrumentations } = await import(
    "@opentelemetry/instrumentation"
  );
  const { BeeAIInstrumentation } = await import(
    "@arizeai/openinference-instrumentation-beeai"
  );
  const beeaiFramework = await import("beeai-framework");

  const projectName = process.env.ARIZE_PROJECT_NAME ?? "beeai-tracing-example";

  const provider = new NodeTracerProvider({
    resource: resourceFromAttributes({
      [ATTR_SERVICE_NAME]: projectName,
      [SEMRESATTRS_PROJECT_NAME]: projectName,
    }),
    spanProcessors: [
      new SimpleSpanProcessor(
        new OTLPTraceExporter({
          url: "https://otlp.arize.com/v1/traces",
          headers: {
            "arize-space-id": process.env.ARIZE_SPACE_ID ?? "",
            "arize-api-key": process.env.ARIZE_API_KEY ?? "",
          },
        }),
      ),
    ],
  });
  provider.register();

  const instrumentation = new BeeAIInstrumentation();
  instrumentation.manuallyInstrument(beeaiFramework);
  registerInstrumentations({ instrumentations: [instrumentation] });
}

// next.config.ts
import type { NextConfig } from "next";

const nextConfig: NextConfig = {
  serverExternalPackages: [
    "beeai-framework",
    "@arizeai/openinference-instrumentation-beeai",
    "@opentelemetry/sdk-trace-node",
    "@opentelemetry/exporter-trace-otlp-proto",
    "@opentelemetry/instrumentation",
  ],
};

export default nextConfig;

​

Run BeeAI

// example.ts

// Importing instrumentation first ensures tracing is set up before any
// BeeAI agent is created.
import { provider } from "./instrumentation";

import {
  ToolCallingAgent,
} from "beeai-framework/agents/toolCalling/agent";
import { TokenMemory } from "beeai-framework/memory/tokenMemory";
import {
  OpenAIChatModel,
} from "beeai-framework/adapters/openai/backend/chat";

// OpenAIChatModel reads OPENAI_API_KEY from the environment.
const llm = new OpenAIChatModel("gpt-5.5");

const agent = new ToolCallingAgent({
  llm,
  memory: new TokenMemory(),
  tools: [],
});

const response = await agent.run({
  prompt: "Why is the ocean salty? Answer in two sentences.",
});

console.log(response.result.text);

// Flush any pending spans before the process exits.
await provider.forceFlush();

​

Expected output

Arize AX tracing initialized for BeeAI.
The ocean is salty because rivers continuously dissolve mineral salts from rocks and soil and carry them to the sea, where they accumulate over millions of years. Water leaves the ocean through evaporation but the salts remain, steadily concentrating until reaching today's roughly 3.5% salinity.

​

Verify in Arize AX

1. Open your Arize AX space and select project beeai-tracing-example.
2. You should see a new trace within ~30 seconds with this shape: a beeai-framework-main root span (AGENT) wraps agent.toolCalling.start-1 / agent.toolCalling.success-1 (AGENT), tool.dynamic.finalAnswer.{start,finish,success}-1 (TOOL), and backend.openai.chat.{start,finish,success}-1 (LLM, model gpt-5.5) child spans. Prompts, responses, and token usage are attached to the LLM spans.
3. If no traces appear, see Troubleshooting.

​

Check from the skill, CLI, or SDK

npx skills add Arize-ai/arize-skills

ax spans export "$ARIZE_PROJECT_NAME" --space "$ARIZE_SPACE_ID" \
  --limit 5 --stdout | jq 'length'

import os
from arize import ArizeClient

client = ArizeClient(api_key=os.environ["ARIZE_API_KEY"])
resp = client.spans.list(
    project=os.environ["ARIZE_PROJECT_NAME"],
    space=os.environ["ARIZE_SPACE_ID"],
    limit=5,
)
count = len(resp.spans)
print(
    f"{count} span(s) found" if count else "No spans yet — recheck setup"
)

// Reads ARIZE_API_KEY from the environment.
import { listSpans } from "@arizeai/ax-client";

const { data: spans } = await listSpans({
  project: process.env.ARIZE_PROJECT_NAME!,
  space: process.env.ARIZE_SPACE_ID!,
  limit: 5,
});
const count = spans.length;
console.log(
  count ? `${count} span(s) found` : "No spans yet — recheck setup",
);

client, err := arize.NewClient(
    arize.Config{APIKey: os.Getenv("ARIZE_API_KEY")},
)
if err != nil {
    log.Fatal(err)
}
resp, err := client.Spans.List(ctx, spans.ListRequest{
    Project: os.Getenv("ARIZE_PROJECT_NAME"),
    Space:   os.Getenv("ARIZE_SPACE_ID"),
    Limit:   5,
})
if err != nil {
    log.Fatal(err)
}
fmt.Printf("%d span(s) found\n", len(resp.Spans))

​

Troubleshooting

• No traces in Arize AX. Confirm ARIZE_SPACE_ID and ARIZE_API_KEY are set in the same shell that runs example.ts. Enable OpenTelemetry debug logs with export OTEL_LOG_LEVEL=debug and re-run.
• BeeAI spans missing. instrumentation.manuallyInstrument(beeaiFramework) must run before any agent is constructed. Make sure import { provider } from "./instrumentation" is the first import in your entry point.
• 401 from OpenAI. Verify OPENAI_API_KEY is set and has access to gpt-5.5. Swap for a model your key can call.
• Example runs but no spans appear. The instrumentor only patches beeai-framework versions in its declared INSTRUMENTS range (currently >=0.1.9 <0.1.14). Newer or older releases install fine but manuallyInstrument(...) silently no-ops. Pin to a supported version (the install command above pins to ~0.1.13), or enable OpenTelemetry diag logs (export OTEL_LOG_LEVEL=debug) to see the DependencyConflict warning the instrumentor emits at startup.
• Cannot find package '@ai-sdk/openai' at runtime. BeeAI declares the @ai-sdk/* provider packages as optional peer dependencies — the user has to install only the ones they use. The example uses OpenAI; if you swap to Anthropic, install @ai-sdk/anthropic instead.
• Process exits before spans flush. Spans are exported asynchronously; always await provider.forceFlush() (or provider.shutdown()) before the process exits to avoid losing trailing spans.

​

Resources