Telemetry

Nexus provides observability through OpenTelemetry, enabling you to monitor performance, track usage, and troubleshoot issues across all components. Our telemetry implementation follows OpenTelemetry semantic conventions for consistency and compatibility with existing monitoring tools.

Telemetry Types

  1. Metrics - Quantitative measurements

    • HTTP request handling and Redis operations
    • LLM operations and token usage tracking
    • MCP tool execution and server health
    • Performance monitoring and cost optimization

  2. Traces - Distributed request tracing

    • End-to-end request flow visualization
    • Cross-service correlation
    • Latency breakdown analysis
    • Configurable sampling rates

  3. Logs - Structured application logs

    • Debug information and error details
    • Automatic trace and span correlation
    • Source code location attributes
    • Configurable log levels and filtering

Quick Start

To get started with telemetry:

  1. Configure - Set up telemetry in your configuration file
  2. Deploy - Start Nexus with telemetry enabled
  3. Monitor - Use the available metrics in your observability platform
  4. Optimize - Tune configuration based on your monitoring needs

Basic Example

[telemetry.exporters.otlp]
enabled = true
endpoint = "http://localhost:4317"

See the complete telemetry configuration guide for all options.

Integration Examples

Nexus exports OpenTelemetry data that works with any OTLP-compatible backend:

  • Prometheus - Via OpenTelemetry Collector
  • Grafana Cloud - Direct OTLP ingestion
  • Datadog - Via Datadog Agent OTLP receiver
  • AWS CloudWatch - Via EMF exporter
  • New Relic - Direct OTLP endpoint
  • Jaeger/Zipkin - For distributed tracing

See the configuration guide for detailed integration examples.

Common Issues

  1. Metrics not appearing

    • Verify [telemetry.exporters.otlp] enabled = true
    • Check OTLP endpoint connectivity and protocol
    • Ensure your collector is running and configured
    • Review Nexus logs for export errors

  2. High cardinality warnings

    • Review label usage in dashboards
    • Enable sampling for high-volume metrics
    • Disable detailed metrics if not needed

  3. Missing attributes

    • Ensure resource attributes are configured
    • Check that service name and version are set
    • Verify custom headers are being sent

External Resources

© Grafbase, Inc.