config_spec.yaml

---
metric_max_length: 4096
trace_max_length_bytes: 16384
flush_max_per_body: 25000
enable_profiling: false
interval: "10s"

# == PERFORMANCE ==

# The size of the buffer we'll use to buffer socket reads. Tune this if you
# you think Veneur needs more room to keep up with all packets.
read_buffer_size_bytes: 2097152

# Adjusts the number of workers Veneur will distribute aggregation across.
# More decreases contention but has diminishng returns.
num_workers: 96

# Numbers larger than 1 will enable the use of SO_REUSEPORT, make sure
# this is supported on your platform!
num_readers: 1

# The number of SSF packets that can be processed
# per flush interval
ssf_buffer_size: 16384

# == AGGREGATION ==

# Set to floating point values that you'd like to putput percentiles for from
# histograms.
percentiles:
  - 0.5
  - 0.75
  - 0.99

# Aggregations you'd like to putput for histograms. Possible values can be any
# or all of:
# - `min`: the minimum value in the histogram during the flush period
# - `max`: the maximum value in the histogram during the flush period
# - `median`: the median value in the histogram during the flush period
# - `avg`: the average value in the histogram during the flush period
# - `count`: the number of values added to the histogram during the flush period
# - `sum`: the sum of all values added to the histogram during the flush period
# - `hmean`: the harmonic mean of the all the values added to the histogram during the flush period
aggregates:
 - "min"
 - "max"
 - "count"

# == DIAGNOSTICS ==

# Enable debug logging
debug: true

# Providing a Sentry DSN here will send internal exceptions to Sentry
sentry_dsn: ""

# Veneur emits it's own metrics, this configures where we send them. It's ok
# to point veneur at itself for metrics consumption!
stats_address: "localhost:8125"

# == FEATURES ==

# Tags supplied here will be added to all metrics ingested by this instance.
tags:
 - "foo:bar"
 - "baz:quz"

# If absent, defaults to the os.Hostname()!
hostname: foobar
# If true and hostname is "" or absent, don't add the host tag
omit_empty_hostname: false

# The address on which to listen for metrics sent to this instance over UDP,
# leave empty to disable.
udp_address: "localhost:8126"

# The address on which to listen for metrics sent to this instance over TCP,
# leave empty to disable.
tcp_address: ""

# The address on which to listen for HTTP imports and/or healthchecks.
#http_address: "einhorn@0"
http_address: "localhost:8127"

# FORWARDING
# Use a static host for forwarding
forward_address: "http://veneur.example.com"

# SSF
# The address on which we will listen for SSF packets via UDP
ssf_address: "127.0.0.1:8128"

# TRACING
# The address on which we will listen for UDP trace data
trace_address: "127.0.0.1:8128"

# TLS
# This is only useful in conjunction with `tcp_address`

# TLS server private key and certificate for encryption (specify both)
# These are the key/certificate contents, not a file path
tls_key: ""
tls_certificate: ""

# Authority certificate: requires clients to be authenticated
tls_authority_certificate: ""

# == SINKS ==

# == Datadog ==
# Datadog can be a sink for metrics, events, service checks and trace spans.

# This is deprecated and will be removed in 2.0; use datadog_api_key
key: "farts"

# This is deprecated and will be removed in 2.0; use datadog_api_hostname
api_hostname: https://app.datadoghq.com

# This is deprecated and will be removed in 2.0; use datadog_trace_api_address
trace_api_address: "http://localhost:7777"

# Hostname to send Datadog data to.
datadog_api_hostname: https://app.datadoghq.com

# API key for acessing Datadog
datadog_api_key: "farts"

# Hostname to send Datadog trace data to.
datadog_trace_api_address: "http://localhost:7777"

# == InfluxDB ==
# InfluxDB can be a sink for metrics.

# Hostname to send Influx metrics to
influx_address: http://localhost:8086

# Consistency level for writes
influx_consistency: one

# Name of database to which metrics will be written.
influx_db_name: mydb

# == LightStep ==
# LightStep can be a sink for trace spans.

# If present, lightstep will be enabled as a tracing sink
# and this access token will be used
# Access token for accessing LightStep
trace_lightstep_access_token: ""

# Host to send trace data to
trace_lightstep_collector_host: ""

# How often LightStep should reconnect to collectors. If your workload is
# imbalanced — some veneur instances see more spans than others — then you may
# want to reconnect more often.
trace_lightstep_reconnect_period: "5m"

# The LightStep client has internal throttling to prevent you overwhelming
# things. Anything that exceeds this many spans in the reporting period
# — which is a minimum of 500ms and maxmium 2.5s at the time of this writing
# — will be dropped. In other words, you can only submit this many spans per
# flush! If left at zero, veneur will set the maximum to the size of
# `ssf_buffer_size`.
trace_lightstep_maximum_spans: 0

# == PLUGINS ==

# == S3 Output ==
# Include these if you want to archive data to S3
aws_access_key_id: ""
aws_secret_access_key: ""
aws_region: ""
aws_s3_bucket: ""

# == LocalFile Output ==
# Include this if you want to archive data to a local file (which should then be rotated/cleaned)
flush_file: ""