Fastapi Otel Common

What it does

This skill provides common utilities and extensions for integrating OpenTelemetry (OTel) with FastAPI applications. It simplifies the process of instrumenting FastAPI endpoints, middleware, and dependencies for distributed tracing and metrics collection. The skill aims to reduce boilerplate code and improve observability in FastAPI-based backends.

When to use it

• Observability is a priority: When building or maintaining a FastAPI application where you need detailed insights into performance and behavior.
• Distributed Tracing: When your application interacts with other services and you want to trace requests across those boundaries.
• Metrics Collection: To gather metrics about API endpoint response times, error rates, and resource utilization for monitoring purposes.
• Standardized Instrumentation: When wanting a consistent approach to instrumenting various parts of your FastAPI application.

Key capabilities

• FastAPI middleware integration with OpenTelemetry.
• Automatic instrumentation of FastAPI endpoints.
• Utility functions for creating spans and adding context.
• Common extensions for OTel data propagation in FastAPI applications.

Example prompts

• "Instrument my FastAPI app with OpenTelemetry."
• "Add tracing to the /users endpoint using OTel."
• "Show me how to propagate context across API calls."

Tips & gotchas

• Requires a working FastAPI application and familiarity with OpenTelemetry concepts.
• Ensure your environment is configured correctly for OpenTelemetry data collection (e.g., an exporter like Jaeger or Prometheus).