Skip to content

cf_exporter job from prometheus/26.0.1

Github source: a2b84f9 or master branch

Properties

cf_exporter

cf

api_url

Cloud Foundry API URL

api_v3_enabled

Enable Cloud Foundry API V3 calls

Default
false
client_id

Cloud Foundry Client ID

client_secret

Cloud Foundry Client Secret

deployment_name

Cloud Foundry Deployment Name to be reported as a metric label

password

Cloud Foundry Password

username

Cloud Foundry Username

events

query

When the ‘Events’ filter is enabled and this value is set, this query is sent to the CloudController to limit the number of results returned

filter

collectors

Comma separated collectors to filter (‘Applications’, ‘Buildpacks’, ‘Events’, ‘IsolationSegments’, ‘Organizations’, ‘Routes’, ‘SecurityGroups’, ServiceBindings, ‘ServiceInstances’, ServicePlans, ‘Services’, ‘Spaces’, ‘Stacks’)

log_format

Set the log target and format. Example: ‘logger:syslog?appname=bob&local=7’ or ‘logger:stdout?json=true’

log_level

Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal]

metrics

environment

Environment label to be attached to metrics

namespace

Metrics Namespace

skip_ssl_verify

Disable SSL Verify

Default
false

web

auth_password

Password for web interface basic auth

auth_username

Username for web interface basic auth

port

Port on which to expose web interface and telemetry

Default
"9193"
telemetry_path

Path under which to expose Prometheus metrics

tls_cert

TLS certificate (PEM format). If the certificate is signed by a certificate authority, the file should be the concatenation of the server’s certificate, any intermediates, and the CA’s certificate

tls_key

TLS private key (PEM format)

env

http_proxy

HTTP proxy to use

https_proxy

HTTPS proxy to use

no_proxy

List of comma-separated hosts that should skip connecting to the proxy

Templates

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

  • bin/cf_exporter_ctl (from bin/cf_exporter_ctl)
  • config/web_tls_cert.pem (from config/web_tls_cert.pem)
  • config/web_tls_key.pem (from config/web_tls_key.pem)

Packages

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