Skip to main content

Summary

Summary of Observability Documentation​

Best Practices​

  • Logging:

    • Set default log level to debug for comprehensive monitoring.
    • Use PascalCase for log labels for consistency.
    • Perform log level filtering in Grafana Alloy if needed.

  • Metrics:

    • Utilize standard OpenTelemetry metrics for compatibility.
    • Document and consistently name custom metrics.

  • Tracing:

    • Ensure trace context propagation across services.
    • Use descriptive names for spans.

Infrastructure Requirements​

  • Grafana Cloud Account:

    • Active account with API keys and endpoints.
    • Contact APEX team for environment-specific keys.

  • Grafana Alloy:

    • Install and configure in each environment.
    • Ensure network connectivity and open necessary ports.

  • Environment Setup:

    • Deploy and configure Grafana Alloy agents.
    • Allocate sufficient resources and secure API keys.

OpenTelemetry Standard​

  • Purpose:

    • Provides APIs and tools for collecting distributed traces and metrics.
    • Enhances application monitoring and troubleshooting.

  • Features:

    • Distributed tracing, metrics collection, automatic instrumentation, context propagation, and data exporters.

  • Integration with Grafana Cloud:

    • Configure OpenTelemetry SDK and exporters.
    • Visualize data using Grafana dashboards.
    • Set up alerts for proactive monitoring.

By following these guidelines and requirements, you can achieve effective observability for your applications using Grafana Cloud and OpenTelemetry.