Skip to content

datadog-firehose-nozzle job from datadog-firehose-nozzle/87

Github source: 67535cb or master branch

Properties

cc

api_batch_size

Size of batches in which to query V3 API to populate app cache (integer between 100 and 5000)

Default
500

endpoint

Cloud Controller Endpoint for getting appmetrics

Default
""

datadog

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

additional_log_intake_url_1

Additional Log Intake Endpoint URL 1 for datadog

Default
""

additional_log_intake_url_2

Additional Log Intake Endpoint URL 2 for datadog

Default
""

additional_log_intake_url_3

Additional Log Intake Endpoint URL 3 for datadog

Default
""

additional_log_intake_url_4

Additional Log Intake Endpoint URL 4 for datadog

Default
""

additional_log_intake_url_5

Additional Log Intake Endpoint URL 5 for datadog

Default
""

api_key

The datadog API key to use while submitting requests

api_url

The REST API Endpoint for datadog

Default
https://api.datadoghq.com/api/v1/series

custom_tags

Send up custom tags with every request (e.g. to label your foundries)

Default
[]

flush_duration_seconds

The duration in seconds between flushes to datadog

Default
15

flush_max_bytes

The maximum number of bytes to send per POST request

Default
2.097152e+06

log_intake_url

The REST Log Intake Endpoint for datadog

Default
https://http-intake.logs.datadoghq.com/

logrotate

freq_min

The frequency in minutes which logrotate will rotate VM logs

Default
5
rotate

The number of files that logrotate will keep around on the VM

Default
3
size

The size at which logrotate will decide to rotate the log file

Default
50M

metric_prefix

Text which will be prepended to each metric name submitted to datadog

Default
cloudfoundry.nozzle.

tags

Send up custom tags with every request (e.g. to label your foundries)

Default
[]

timeout_seconds

The number of seconds to set the timeout for writes to Datadog

Default
5

loggregator

rlp_gateway_url

RLP Gateway URL (loggregator V2 API - not necessary if you have cc.endpoint)

Default
""

nozzle

app_metrics

Turn on grabbing of app metrics (may substantially increase load)

Default
true

dca_enabled

Whether or not to use the cluster agent API.

Default
false

dca_port

Port to connect to the cluster agent.

Default
5005

dca_token

Token to connect to the cluster agent.

Default
""

dca_url

URL of the cluster agent, the scheme will be added automatically in case it is not included.

Default
""

deployment

Name of deployment (added as tag on all outgoing metrics)

deployment_filter

If set, this will filter out envelopes that do not match the deployment name

Default
""

disable_access_control

Datadog Nozzle bypasses authentication with the UAA

Default
false

enable_advanced_tagging

Wheter or not to send extra tags such as sidecar_present and sidecar_count for app metrics.

Default
false

enable_application_logs

Whether or not to enable forwarding application logs from the nozzle

Default
false

enable_metadata_app_metrics_prefix

Wheter or not to add “label/” or “annotation/” prefix to app metadata tags in app metrics.

Default
true

enable_metadata_collection

Whether or not to enable labels and annotations collection as tags

Default
false

environment

The name of the environment where the nozzle is running

Default
""

grab_interval

The Interval (in minutes) to update the app metadata

Default
10

http_proxy_url

Use an http proxy

Default
""

https_proxy_url

Use an https proxy

Default
""

idle_timeout_seconds

Number of seconds to wait before timing out the read to the firehose, if there are no messages

Default
60

insecure_ssl_skip_verify

Skip verifying SSL certificate

metadata_keys_blacklist_patterns

Label and annotation keys that match any regular expression in this list are excluded. If neither a whitelist nor a blacklist is provided, everything is included. If a key matches both a whitelist and a blacklist pattern, it is excluded.

Default
[]

metadata_keys_whitelist_patterns

Label and annotation keys that match any regular expression in this list are included. If neither a whitelist nor a blacklist is provided, everything is included. If a key matches both a whitelist and a blacklist pattern, it is excluded.

Default
[]

no_proxy

Hosts that should skip the proxy

Default
""

org_data_collection_interval

The interval (in seconds) in which to submit org metrics

Default
600

subscription_id

The subscription id to be used for the firehose

workers

The number of worker threads to use

Default
4

uaa

client

The client that has access to the loggregator firehose

client_secret

The secret for the user

url

URL for the UAA server

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-firehose-nozzle/ directory (learn more).

  • bin/clean_config.py (from clean_config.py)
  • bin/datadog-firehose-nozzle-ctl (from datadog-firehose-nozzle-ctl.erb)
  • bin/flare (from flare.erb)
  • config/datadog-firehose-nozzle.json (from datadog-firehose-nozzle.json.erb)
  • config/datadog_logrotate.cron (from datadog_logrotate.cron.erb)
  • config/logrotate.conf (from logrotate.conf.erb)

Packages

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