Skip to content

metrics-agent job from metrics-discovery/3.2.4

Github source: 288a92c or master branch

Properties

config_globs

Files matching the globs are expected to contain information to scrape a Prometheus metrics endpoint on localhost.

Default
- /var/vcap/jobs/*/config/prom_scraper_config.yml

grpc

ca_cert

TLS loggregator root CA certificate

cert

TLS certificate for GRPC ingress server signed by the loggregator CA

key

TLS private key for GRPC ingress server signed by the loggregator CA

metrics

ca_cert

TLS CA cert to verify requests to metrics endpoint.

cert

TLS certificate for metrics server signed by the metrics CA

debug

Enables go_ and process_ metrics along with a pprof endpoint

Default
false

key

TLS private key for metrics server signed by the metrics CA

port

Port the agent uses to serve metrics and debug information

Default
14727

pprof_port

If debug metrics is enabled, pprof will start at this port, ideally set to something other then 0

Default
0

server_name

The server name used in the scrape configuration for the metrics endpoint

whitelisted_timer_tags

A list of tags allowed for aggregating timer metrics into histograms

Default
source_id,deployment,job,index,ip

metrics_exporter_port

Port the agent uses to serve the Prometheus endpoint

Default
14726

metrics_targets_file

The location of the generated metrics_targets.yml containing on-vm locations to scrape

Default
/var/vcap/data/metrics-agent/metric_targets.yml

port

Port the agent is serving gRPC via mTLS

Default
3461

scrape

tls

ca_cert

The CA used to communicate with scrape targets

cert

The cert used to communicate with scrape targets

key

The key used to communicate with scrape targets

tags

Collection of tags to add on all outgoing v2 envelopes. Bosh deployment, instance group, and index will be merged with this property if they are not provided

Default
{}
Example
deployment: cf

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/metrics-agent/ directory (learn more).

  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/grpc.crt (from grpc.crt.erb)
  • config/certs/grpc.key (from grpc.key.erb)
  • config/certs/grpc_ca.crt (from grpc_ca.crt.erb)
  • config/certs/metrics.crt (from metrics.crt.erb)
  • config/certs/metrics.key (from metrics.key.erb)
  • config/certs/metrics_ca.crt (from metrics_ca.crt.erb)
  • config/certs/scrape.crt (from scrape.crt.erb)
  • config/certs/scrape.key (from scrape.key.erb)
  • config/certs/scrape_ca.crt (from scrape_ca.crt.erb)
  • config/ingress_port.yml (from ingress_port.yml.erb)
  • config/prom_scraper_config.yml (from prom_scraper_config.yml.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.