Developing observability

This documentation is for generalized, usecase-agnostic development of Sourcegraph's observability. Sourcegraph employees should also refer to the handbook's observability section for Sourcegraph-specific documentation.

NOTE: For how to use Sourcegraph's observability and an overview of our observability features, refer to the observability for site administrators documentation.

Overview

Observability at Sourcegraph includes:

	Description	Examples
Monitoring	how you know when something is wrong	Dashboards & metrics, alerting, health checks
Debugging	how you debug what is wrong	Tracing, logging

Concepts

• Sourcegraph monitoring pillars
• Sourcegraph monitoring architecture

Guides

• How to add observability
• How to add logging
• How to find monitoring
• How to add monitoring
• Set up local monitoring development
• Set up local OpenTelemetry development

Components

• Monitoring generator
• Sourcegraph Grafana
• Sourcegraph Prometheus
• Sourcegraph cAdvisor
• Observability for site administrators