sourcegraph/monitoring

Sourcegraph monitoring generator

This page documents usage (running the generator) and development (of the generator itself). For background and feature documentation, see the generator overview. To learn about how to find, add, and use monitoring, see the Sourcegraph observability developer guide.

Usage

From this directory:

go generate ./...

Logging output supports the Sourcegraph log level flags. Other configuration options can be customized via flags declared in main.go.

Development

The Sourcegraph monitoring generator consists of three components:

• The main program - this is the primary entrypoint to the generator.
• Definitions, defined in the top-level monitoring/definitions package. This is where the all service monitoring definitions lives. If you are editing monitoring, this is probably where you want to look - see the Sourcegraph observability developer guide.
• Generator, defined in the nested monitoring/monitoring package package. This is where the API for service monitoring definitions is defined, as well as the generator code that provides its features.

All features and capabilities for developed for the generator should align with the Sourcegraph monitoring pillars.