Skip to content

service-metrics job from service-metrics/2.0.10

Github source: 5da783c or master branch

Properties

service_metrics

debug

boolean value to turn on verbose mode

Default
false

execution_interval_seconds

Interval to repeatedly obtain and emit metrics, in seconds. If the interval seconds is set to a negative number this will disable service metrics process.

Default
60

metrics_command

Command to obtain metrics in JSON format

Default
/var/vcap/jobs/service-metrics-adapter/bin/collect-service-metrics

metrics_command_args

Arguments to be passed to the metrics command (see service_metrics.metrics_command)

Default
[]

monit_dependencies

Array of monit service dependencies

Default
[]

mount_paths

Filesystem paths to be mounted for reading by the metrics_command

Default
[]

origin

Used for the origin tag on every envelope. Should be set to something descriptive of the deployment (e.g. service-name)

port

The port service metrics will expose parsed metrics on

Default
14828

source_id

The source ID to set on every envelope sent by Service Metrics.

Default
""

tls

ca_cert

TLS CA cert to verify requests to metrics endpoint.

cert

TLS certificate for metrics server signed by the metrics CA

key

TLS private key for metrics server signed by the metrics CA

server_name

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

Templates

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

  • bin/drain (from drain.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/service_metrics.crt (from service_metrics.crt.erb)
  • config/certs/service_metrics.key (from service_metrics.key.erb)
  • config/certs/service_metrics_ca.crt (from service_metrics_ca.crt.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.