mirror of
https://github.com/sourcegraph/sourcegraph.git
synced 2026-02-06 18:11:48 +00:00
2c3e813a31
Based on the [discussion in Slack](https://sourcegraph.slack.com/archives/C02UC4WUX1Q/p1717067410264679), thought it would be useful to solidify the invariants that hold between errors.As, errors.Is and errors.HasType (and provide counter-examples for things which you think ought to hold but don't actually hold) in code itself, instead of just via docs. So this PR adds property-based tests for quickly generating different kinds of error shapes, and check which invariants hold and which ones don't. It also adds better documentation for errors.Is and errors.As |
||
|---|---|---|
| .. | ||
| command | ||
| definitions | ||
| grafanaclient | ||
| monitoring | ||
| .gitattributes | ||
| BUILD.bazel | ||
| CODENOTIFY | ||
| generate_config_test.sh | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
| README.md | ||
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/definitionspackage. 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/monitoringpackage 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.