data-api-builder-otel

Configure Data API Builder OpenTelemetry tracing and metrics via dab-config.json.

1|1|Updated Feb 26, 2026
One-click install
npx skills add https://github.com/JerryNixon/vslive-2026-las-demos --skill data-api-builder-otel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: data-api-builder-otel
Source: https://github.com/JerryNixon/vslive-2026-las-demos/tree/main/.github/skills/data-api-builder-otel
Command: npx skills add https://github.com/JerryNixon/vslive-2026-las-demos --skill data-api-builder-otel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Data API Builder teams need reliable distributed tracing and metrics to diagnose performance and reliability across Aspire, Docker, and Azure deployments. This Skill provides a ready-to-use OpenTelemetry setup for DAB so traces and metrics flow to the configured backends.

Core Features & Use Cases

  • Enables distributed tracing and metrics for REST, GraphQL, MCP, and database operations via the .NET OpenTelemetry SDK.
  • Uses the runtime.telemetry.open-telemetry configuration block in dab-config.json to control enablement and endpoints.
  • Supports Aspire auto-injection of OTLP endpoint and service name; works with local development and cloud deployments; optional headers for authenticated collectors.
  • Includes practical guidance on avoiding common pitfalls (e.g., unsatisfied @env() references causing startup crashes).

Quick Start

Configure the DAB runtime to enable OpenTelemetry by setting runtime.telemetry.open-telemetry and then run the container with Aspire or a local collector.

Frequently Asked Questions about data-api-builder-otel

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enable OpenTelemetry tracing for Data API Builder in dab-config.json?

OpenTelemetry tracing for Data API Builder is enabled by configuring the runtime.telemetry.open-telemetry block in dab-config.json to control endpoint settings and metrics collection across your environments.

Does Data API Builder support distributed tracing in Aspire deployments?

Data API Builder supports distributed tracing in Aspire deployments through auto-injection of the OTLP endpoint and service name, enabling traces and metrics to flow to configured backends.

Why does Data API Builder crash on startup when configuring OpenTelemetry?

Data API Builder startup crashes during OpenTelemetry configuration often occur due to unsatisfied @env() references in dab-config.json that fail to resolve environment variables at launch.

Can I send OpenTelemetry metrics from Data API Builder to an authenticated collector?

Data API Builder supports sending OpenTelemetry metrics to authenticated collectors by including optional authentication headers in the runtime.telemetry.open-telemetry block when the endpoint requires them.

What operations are traced when enabling OpenTelemetry for Data API Builder?

OpenTelemetry for Data API Builder captures distributed tracing and metrics for REST, GraphQL, MCP, and database operations using the .NET OpenTelemetry SDK across local and cloud environments.

Do I need the .NET OpenTelemetry SDK to collect metrics from Data API Builder?

The .NET OpenTelemetry SDK is required to enable distributed tracing and metrics collection for Data API Builder, ensuring traces flow correctly to your configured OTLP exporters.