dd-agent job from datadog-agent/4.12.2

Datadog Agent

Github source: 71bc063 or master branch

Properties¶

`cluster_agent`¶

address¶

Address of the cluster agent.

enabled¶

Whether or not the cluster agent is enabled.
Default
false
port¶

Port to connect to the cluster agent.
Default
5005
token¶

Token to connect to the cluster agent.

`dd`¶

additional_api_key_1¶

The datadog API key to use while submitting requests for additional endpoint url 1

additional_api_key_2¶

The datadog API key to use while submitting requests for additional endpoint url 2

additional_api_key_3¶

The datadog API key to use while submitting requests for additional endpoint url 3

additional_api_key_4¶

The datadog API key to use while submitting requests for additional endpoint url 4

additional_api_key_5¶

The datadog API key to use while submitting requests for additional endpoint url 5

additional_api_url_1¶

Additional Endpoint URL 1 for datadog
Default
https://app.datadoghq.com/api/v1/series
additional_api_url_2¶

Additional Endpoint URL 2 for datadog
Default
https://app.datadoghq.com/api/v1/series
additional_api_url_3¶

Additional Endpoint URL 3 for datadog
Default
https://app.datadoghq.com/api/v1/series
additional_api_url_4¶

Additional Endpoint URL 4 for datadog
Default
https://app.datadoghq.com/api/v1/series
additional_api_url_5¶

Additional Endpoint URL 5 for datadog
Default
https://app.datadoghq.com/api/v1/series
address_tag¶

Include the address tag
Default
true
agent_config¶

Add any additional agent config options here. (Warning: any options you add here will override the options set previously.)
Default
{}
api_key¶

Datadog API key

apm_dd_url¶

The host of the Datadog intake server for APM data

bosh_tags¶

Enable autogenerated bosh tags
Default
true
bosh_tags_prefix¶

Prefix for autogenerated bosh tags
Default
bosh_
cf_os_hostname_aliasing¶

If enabled, send the OS hostname as an alias. Useful in coordination with the Friendly Hostname option.
Default
false
check_runners¶

The Agent runs workers in parallel to execute checks. By default the number of workers is set to 1. If set to 0 the agent will automatically determine the best number of runners needed based on the number of checks running. This would optimize the check collection time but may produce CPU spikes.
Default
1
check_timings¶

The collector will capture a metric for check run times
Default
false
cluster_agent_poll_interval¶

How often to poll the Cluster Agent for new config checks (in seconds).
Default
10
cmd_port¶

The port on which the IPC api listens. (Set to a different port if there’s a collision)
Default
15001
collect_ec2_tags¶

Collect AWS EC2 custom tags as agent tags (requires an IAM role associated with the instance)
Default
false
collect_monit_children_processes¶

Enable collection of children processes of monit processes
Default
false
collect_security_groups¶

Incorporate security-groups into tags collected from AWS EC2
Default
false
create_dd_check_tags¶

Add dd_check:checkname tag per running check
Default
false
custom_emitters¶

List of emitters to be used in addition to the standard one
Example
- /usr/local/my-code/emitters/rabbitmq.py:RabbitMQEmitter
disable_network_performance_monitoring¶

Disable Network Performance Monitoring.
Default
false
disk_yaml_config¶

Disk integration YAML configuration
Default
""
dogstatsd_port¶

Statsd listening port
Default
18125
dogstatsd_target¶

By default dogstatsd will post aggregate metrics to the Agent, but you can define a different endpoint here

dogstreams¶

List of logs to parse and optionally custom parsers to use
Example
- /path/to/log1:/path/to/my/parsers_module.py:custom_parser
- /path/to/log2
enable_gohai¶

Enable gohai metadata collection (default is yes)
Default
true
enable_logs_agent¶

Enable logs agent for integrations
Default
false
enable_metadata_collection¶

Metadata collection should always be enabled, except if you are running several agents/dsd instances per host. In that case, only one agent should have it on. WARNING: disabling it on every agent will lead to display and billing issues
Default
true
exclude_process_args¶

Remove the ‘ww’ flag from ps catching the arguments of processes
Default
false
expvar_port¶

The port that the agent reports expvar metrics over. (Set to a different port if there’s a collision)
Default
15000
force_tls_12¶

Whether or not to force TLS 1.2 for agent HTTPS communications.
Default
false
forwarder_num_workers¶

The number of workers used by the forwarder. Please note each worker will open an outbound HTTP connection towards Datadog’s metrics intake at every flush.
Default
1
friendly_hostname¶

Use a friendly hostname. If this is enabled, along with the UUID option, uuid will take precedence. If you have several foundations, set one or both of the options dd.unique_friendly_hostname and dd.friendly_hostname_append_vm_guid to true to generate unique hostnames across foundations.
Default
true
friendly_hostname_append_vm_guid¶

Append the VM UUID to the friendly hostname, to make it unique. Set this to true to generate unique friendly hostnames across your entire Cloud Foundry environment.
Default
false
ganglia_host¶

Ganglia host where gmetad is running
Default
127.0.0.1
ganglia_port¶

Ganglia port where gmetad is running
Default
8651
gce_updated_hostname¶

Use unique hostname for GCE hosts, see http://dtdg.co/1eAynZk
Default
true
generate_disk_config¶

Generate disk configuration, disk.yaml
Default
true
generate_disk_config_all_partitions¶

Include all partitions in the system
Default
true
generate_disk_config_tag_by_filesystem¶

Add tags to mountpoints by filesystem type
Default
true
generate_monit_processes¶

Add monit processes to process check
Default
true
generate_network_config¶

Automatically generate network monitoring integration, network.yaml
Default
true
generate_network_config_connection_state¶

Report metrics including the state of the nics
Default
true
generate_network_config_excluded_interfaces¶

List of the network interfaces to exclude from reporting metrics
Default
  - lo
  - lo0
generate_ntp_config¶

Generate NTP monitoring ntp.yaml
Default
true
generate_ntp_config_host¶

NTP host
Default
0.ubuntu.pool.ntp.org
generate_ntp_config_min_collection_interval¶

Metrics collection interval
Default
300
generate_ntp_config_offset_threshold¶

Max offset threshold in seconds
Default
60
generate_processes¶

Automatically generate process monitoring integration, process.yaml
Default
true
generate_system_processes¶

Add basic system processes to process check
Default
true
graphite_listen_port¶

Start a graphite listener on this port
Default
17124
histogram_aggregates¶

List of histogram aggregates functions
Default
  - max
  - median
  - avg
  - count
histogram_percentiles¶

List of histogram percentiles
Default
- "0.95"
hostname¶

Force the hostname to whatever you want. Default is autogenerated

integrations¶

Agent integration configuration. Each key will have “.yaml” appended to it and the value dumped a file
Default
{}
ip_tag¶

Include the ip tag
Default
true
listen_port¶

Change port the Agent is listening to
Default
17123
log_format_json¶

Set this option to “yes” to output logs in JSON format
Default
false
log_level¶

Logging level
Default
INFO
logs_dd_url¶

The host of the Datadog intake server for logs

no_proxy_nonexact_match¶

Enable more flexible no_proxy matching

non_local_traffic¶

Allow non-local traffic to this Agent, required when using it as a proxy for other agents
Default
false
process_agent_containers_only¶

Enable only the container collection of the process agent.
Default
false
process_agent_enabled¶

Enable the process agent.
Default
false
process_dd_url¶

The host of the Datadog intake server for process data

proxy¶

Proxy settings to connect to the Internet
Example
host: proxy
password: pass
port: 8080
user: user
http¶

The proxy for http endpoints

https¶

The proxy for https endpoints

no_proxy¶

Domains that the agent proxy should skip

secret_backend_arguments¶

List of arguments to give to the command.
Default
[]
secret_backend_command¶

Path to the executable to use to fetch secrets.
Default
""
secret_backend_output_max_size¶

The size in bytes of the buffer used to store the command answer.
Default
1024
secret_backend_timeout¶

The timeout to execute the command in second.
Default
5
site¶

The site of the Datadog intake to send Agent data to. Defaults to ‘datadoghq.com’, set to ‘datadoghq.eu’ to send data to the EU site.

skip_ssl_validation¶

Skip SSL validation for the Datadog url
Default
false
statsd_forward_host¶

Forward packets received by the dogstatsd server to another statsd server

statsd_forward_port¶

Forward packets received by the dogstatsd server to another statsd server port
Default
8125
statsd_metric_namespace¶

Define a namespace for statsd metrics, metric.name will instead become namespace.metric.name

strip_proc_arguments¶

This setting will strip the process arguments from the processes sent by the process agent.

system_probe_enabled¶

Enable System Probe.
Default
false
tags¶

List of tags which will be applied to the data sent from this agent
Default
[]
trace_agent_enabled¶

Enable the trace agent.
Default
false
unique_friendly_hostname¶

Append the CloudFoundry deployment to the friendly hostname, to make it unique. If the deployments across your foundations are not unique, set the option dd.friendly_hostname_append_vm_guid to true instead.
Default
false
url¶

The host of the Datadog intake server for metrics

use_dogstatsd¶

Should the dogstatsd agent be started for statsd metrics collection
Default
true
use_ganglia¶

Enable Ganglia support for collecting metrics
Default
false
use_graphite¶

Enable a graphite endpoint
Default
false
use_jmxfetch¶

Should the jmxfetch agent be started
Default
false
use_uuid_hostname¶

By default we use a friendly hostname, this might cause problems with some setups. Set this to use the UUID instead. (In an environment where there are multiple hosts of the same type on different deployments or in different foundries, this will be necessary.) If dd.hostname is set, it will take precedence over the uuid hostname.

utf8_decoding¶

Dogstatsd supports plain ASCII packets, this enables support for UTF8 metric names
Default
false

Templates¶

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

bin/agent_ctl (from bin/agent_ctl)
bin/pre-start (from bin/pre-start)
bin/process_agent_ctl (from bin/process_agent_ctl)
bin/system_probe_ctl (from bin/system_probe_ctl)
bin/trace_agent_ctl (from bin/trace_agent_ctl)
config/confd.sh (from config/confd.sh.erb)
config/datadog.yaml (from config/datadog.yaml.erb)
config/system-probe.yaml (from config/system-probe.yaml.erb)
data/properties.sh (from data/properties.sh.erb)

Packages¶

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

dd-agent

dd-agent job from datadog-agent/4.12.2

Properties¶

cluster_agent¶

address¶

enabled¶

port¶

token¶

dd¶

additional_api_key_1¶

additional_api_key_2¶

additional_api_key_3¶

additional_api_key_4¶

additional_api_key_5¶

additional_api_url_1¶

additional_api_url_2¶

additional_api_url_3¶

additional_api_url_4¶

additional_api_url_5¶

address_tag¶

agent_config¶

api_key¶

apm_dd_url¶

bosh_tags¶

bosh_tags_prefix¶

cf_os_hostname_aliasing¶

check_runners¶

check_timings¶

cluster_agent_poll_interval¶

cmd_port¶

collect_ec2_tags¶

collect_monit_children_processes¶

collect_security_groups¶

create_dd_check_tags¶

custom_emitters¶

disable_network_performance_monitoring¶

disk_yaml_config¶

dogstatsd_port¶

dogstatsd_target¶

dogstreams¶

enable_gohai¶

enable_logs_agent¶

enable_metadata_collection¶

exclude_process_args¶

expvar_port¶

force_tls_12¶

forwarder_num_workers¶

friendly_hostname¶

friendly_hostname_append_vm_guid¶

ganglia_host¶

ganglia_port¶

gce_updated_hostname¶

generate_disk_config¶

generate_disk_config_all_partitions¶

generate_disk_config_tag_by_filesystem¶

generate_monit_processes¶

generate_network_config¶

generate_network_config_connection_state¶

generate_network_config_excluded_interfaces¶

generate_ntp_config¶

generate_ntp_config_host¶

generate_ntp_config_min_collection_interval¶

generate_ntp_config_offset_threshold¶

generate_processes¶

generate_system_processes¶

graphite_listen_port¶

histogram_aggregates¶

histogram_percentiles¶

hostname¶

integrations¶

ip_tag¶

listen_port¶

log_format_json¶

log_level¶

logs_dd_url¶

no_proxy_nonexact_match¶

non_local_traffic¶

process_agent_containers_only¶

process_agent_enabled¶

process_dd_url¶

proxy¶

`cluster_agent`¶

`address`¶

`enabled`¶

`port`¶

`token`¶

`dd`¶

`additional_api_key_1`¶

`additional_api_key_2`¶

`additional_api_key_3`¶

`additional_api_key_4`¶

`additional_api_key_5`¶

`additional_api_url_1`¶

`additional_api_url_2`¶

`additional_api_url_3`¶

`additional_api_url_4`¶

`additional_api_url_5`¶

`address_tag`¶

`agent_config`¶

`api_key`¶

`apm_dd_url`¶

`bosh_tags`¶

`bosh_tags_prefix`¶

`cf_os_hostname_aliasing`¶

`check_runners`¶

`check_timings`¶

`cluster_agent_poll_interval`¶

`cmd_port`¶

`collect_ec2_tags`¶

`collect_monit_children_processes`¶

`collect_security_groups`¶

`create_dd_check_tags`¶

`custom_emitters`¶

`disable_network_performance_monitoring`¶

`disk_yaml_config`¶

`dogstatsd_port`¶

`dogstatsd_target`¶

`dogstreams`¶

`enable_gohai`¶

`enable_logs_agent`¶

`enable_metadata_collection`¶

`exclude_process_args`¶

`expvar_port`¶

`force_tls_12`¶

`forwarder_num_workers`¶

`friendly_hostname`¶

`friendly_hostname_append_vm_guid`¶

`ganglia_host`¶

`ganglia_port`¶

`gce_updated_hostname`¶

`generate_disk_config`¶

`generate_disk_config_all_partitions`¶

`generate_disk_config_tag_by_filesystem`¶

`generate_monit_processes`¶

`generate_network_config`¶

`generate_network_config_connection_state`¶

`generate_network_config_excluded_interfaces`¶

`generate_ntp_config`¶

`generate_ntp_config_host`¶

`generate_ntp_config_min_collection_interval`¶

`generate_ntp_config_offset_threshold`¶

`generate_processes`¶

`generate_system_processes`¶

`graphite_listen_port`¶

`histogram_aggregates`¶

`histogram_percentiles`¶

`hostname`¶

`integrations`¶

`ip_tag`¶

`listen_port`¶

`log_format_json`¶

`log_level`¶

`logs_dd_url`¶

`no_proxy_nonexact_match`¶

`non_local_traffic`¶

`process_agent_containers_only`¶

`process_agent_enabled`¶

`process_dd_url`¶

`proxy`¶

`http`¶

`https`¶