Skip to content

datadog-cluster-agent job from datadog-cluster-agent/2.5.0

Datadog Cluster Agent for Cloud Foundry

Github source: 0521aac or master branch

Properties

cloud_foundry_api

api_url

Cloud Foundry API URL where the integration collects events.

Default
""

apps_batch_size

Number of apps per page to collect when calling the list apps endpoint of the CC API. Max 5000.

Default
5000

client_id

Client ID to authenticate with the UAA server. It needs to have the admin.read_only scope for the integration to work properly.

Default
""

client_secret

Client secret to authenticate with the UAA server.

Default
""

event_filter

A list of audit event types to collect from the API.

Default
  - audit.app.restage
  - audit.app.update
  - audit.app.create
  - app.crash

http_proxy

URL of the HTTP Proxy.

Default
""

https_proxy

URL of the HTTPS Proxy.

Default
""

no_proxy

List of domains for which requests should skip proxy.

Default
[]

poll_interval

Polling rate of CC API, in seconds. Values lower than 10 might influence performance of other operations in the cluster.

Default
60

skip_ssl_validation

Whether or not to validate the SSL certificate when connecting to the Cloud Foundry API.

Default
false

tags

A list of custom tags to attach to the data sent to Datadog.

Default
[]

cloud_foundry_bbs

env_exclude

List of regular expressions to forbid a set of environment variables to be included as container tags.

Default
[]

env_include

List of regular expressions to allow a set of environment variables to be included as container tags.

Default
[]

cluster_agent

advanced_tagging

Default
false

api_key

Datadog API key

bbs_ca_crt

PEM-encoded CA certificate

bbs_client_crt

PEM-encoded client certificate

bbs_client_key

PEM-encoded client key

bbs_poll_interval

Interval for refreshing autodiscovery data from BBS API (in seconds)

Default
15

bbs_url

URL of the BBS API

Default
https://bbs.service.cf.internal:8889

cloud_foundry_api_check_config

Cloud Foundry API integration YAML configuration. See example configuration for all available options. Use this instead of the following individual properties for full customization of the integration.

Default
""

enable_cloud_foundry_api_apps_polling

Whether or not to poll the apps endpoint of the Cloud Foundry API for improved tagging functionality of containers.

Default
false

enable_cloud_foundry_api_check

Whether or not to enable the Cloud Foundry API integration.

Default
false

enabled

Whether or not to enable the Cluster Agent

Default
true

force_tls_12

Whether or not to force TLS 1.2 for agent HTTPS communications.

Default
false

isolation_segments_tags

Default
false

log_level

Logging level for the cluster agent

Default
INFO

port

Port on which the Cluster Agent can be reached by Node Agents

Default
5005

refresh_on_cache_miss

Whether or not to query the CAPI on cache miss in the cluster agent.

Default
false

serve_nozzle_data

Whether or not to serve preprocessed data for the nozzles.

Default
false

sidecars_tags

Default
false

token

Token for Node Agent <-> Cluster Agent authentication. This has to be 32 or more characters.

ulimit_files

The limit of open file descriptors for the cluster agent process. Increase if you have a large number of VMs in your environmnent, to allow more HTTP connections to the cluster agent API.

Default
1024

warmup_duration

Number of seconds to wait for Node agents to report before starting to dispatch configurations

Default
30

Templates

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

  • bin/datadog-cluster-agent-ctl (from datadog-cluster-agent-ctl.erb)
  • config/bbs_ca.crt (from bbs_ca.crt.erb)
  • config/bbs_client.crt (from bbs_client.crt.erb)
  • config/bbs_client.key (from bbs_client.key.erb)
  • config/conf.d/cloud_foundry_api.d/conf.yaml (from cloud_foundry_api.yaml.erb)
  • config/datadog-cluster.yaml (from datadog-cluster.yaml.erb)

Packages

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