Sourcegraph DocsSourcegraph Docs
  • Code Intelligence

    • Cody
    • Code Search
  • Code Management

    • Batch Changes
    • Code Navigation
    • Code Monitoring
    • Code Ownership
    • Code Insights
    • Notebooks
  • Platform

    • Sourcegraph Admin
    • Sourcegraph Cloud
    • Integrations
    • Development
  • CLI & API

    • Sourcegraph CLI
    • Sourcegraph GraphQL API
    • Sourcegraph Stream API
  • Help & Support

    • SLAs & Premium Support
    • Tutorials
    • Sourcegraph Accounts
    • Changelog
  1. Docs
  2. dev
  3. background-information
  4. observability

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:

DescriptionExamples
Monitoringhow you know when something is wrongDashboards & metrics, alerting, health checks
Debugginghow you debug what is wrongTracing, 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

On this page

  1. Developing observability

    1. Overview
    1. Concepts
    1. Guides
    1. Components