package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
Init creates a prometheus instance on the given cluster.
MakeInsecureCockroachScrapeConfig creates a scrape config for each cockroach node.
MakeInsecureTenantPodScrapeConfig creates a scrape config for a given tenant SQL pod.
MakeWorkloadScrapeConfig creates a scrape config for a workload.
Shutdown stops all prom and grafana processes and, if dumpDir is passed, will download dump of prometheus data to the machine executing the roachprod binary.
Snapshot takes a snapshot of prometheus and stores the snapshot and a script to spin up a docker instance for it to the given directory.
# Constants
DefaultScrapeInterval is the default interval between prometheus scrapes.
DefaultScrapeTimeout is the maximum amount of time before a scrape is timed out.
# Structs
Config is a monitor that watches over the running of prometheus.
GrafanaConfig are options related to setting up a Grafana instance.
Prometheus contains metadata of a running instance of prometheus.
ScrapeConfig represents a single instance of scraping, identified by the jobName Note how workload scrapes are set up differently than CRDB binary scrapes.
ScrapeNode is a node to scrape from.
# Interfaces
Client is an interface allowing queries against Prometheus.