Skip to content

Latest commit

 

History

History
171 lines (131 loc) · 7.63 KB

BACKENDS.md

File metadata and controls

171 lines (131 loc) · 7.63 KB

Configuring backends

Backends must be configured through the usage of a configuration file (toml, yaml and json are supported), passed via --config-path.

Documentation is currently provided for graphite and newrelic backends. For datadog, statsdaemon, stdout, and cloudwatch please refer to the source code.

All configuration is in a stanza named after the backend, and takes simple key value pairs.

Graphite

Example with defaults

[graphite]
address = "localhost:2003"
dial_timeout = '5s'
write_timeout = '30s'

mode = 'tags'

global_prefix = 'stats'
global_suffix = ''

prefix_counter = 'counters'
prefix_timer = 'timers'
prefix_gauge = 'gauges'
prefix_sets = 'sets'

The configuration settings are as follows:

  • address: the graphite server to send aggregated data to
  • dial_timeout: the timeout for connecting to the graphite server
  • write_timeout: the maximum amount of time to try and write before giving up
  • mode: one of legacy, basic, or tags style naming should be used. Note that legacy and basic will silently drop all tags. If there is a need to support tags as Graphite nodes, please raise an issue.

The following 5 options will only be applied if mode is basic or tags.

  • prefix_counter: the prefix to add to all counters
  • prefix_timer: the prefix to add to all timers
  • prefix_gauge: the prefix to add to all gauges
  • prefix_sets: the prefix to add to all sets
  • gloabl_prefix: a prefix to add to all metrics

This is always applied

  • global_suffix: a suffix to add to all metrics

Metric names

When mode is basic or tags, the graphite backend will emit metrics with the following naming scheme:

[global_prefix.][prefix_<type>.]<metricname>[.aggregation_suffix][.global_suffix]

The aggregation_suffix will be count or rate for counters, and the configured aggregation functions for timers.

When mode is legacy, the graphite backend will emit metrics with the following scheme:

  • counters: stats_counts.<metricname>[.global_suffix] (count) and stats.<metricname>[.global_suffix] (rate)
  • timers: stats.timers.<metricname>.<aggregation_suffix>[.global_suffix]
  • gauges: stats.gauges.<metricname>[.global_suffix]
  • sets: stats.sets.<metricname>[.global_suffix]

New Relic Backend

Supports three flush-types for sending metrics to New Relic:

  • infra Via the Infrastructure Agent's inbuilt HTTP Server (default)
  • insights Directly to the Insights Collector - Insights Event API
  • metrics Directly to the Metric API - Metric Event API

An attempt will be made to automatically set the flush-type based on the address you have configured, manual configuration is also available.

New Relic Insights Event API

Sending directly to the Event API alleviates the requirement of needing to have the New Relic Infrastructure Agent. Therefore you can run this from nearly anywhere for maximum flexibility. This also becomes a shorter data path with less resource requirements becoming a simpler setup.

To use this method, create an Insert API Key from here: https://insights.newrelic.com/accounts/YOUR_ACCOUNT_ID/manage/api_keys. More information on registering an Insert API Key can be found here.

#Example Insights Collector configuration

[newrelic]
    transport = "default"
    address = "https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/events"
    api-key = "yourEventAPIInsertKey"

See TRANSPORT.md for information about transport.

Make sure that address is set to https://insights-collector.eu01.nr-data.net/v1/accounts/YOUR_ACCOUNT_ID/events if your account hosts data in the EU data center.

New Relic's Metric API

To enable sending metrics to the Metric API endpoint you need to set the config setting address-metrics to https://metric-api.newrelic.com/metric/v1. These events appear in New Relic Insights as a new event type. These new events can then be used to leverage the power of NRQL for querying the metric data.

To use this method, create an Insert API Key from here: https://insights.newrelic.com/accounts/YOUR_ACCOUNT_ID/manage/api_keys

#Example Metric API configuration

[newrelic]
    transport = "default"
    address-metrics = "https://metric-api.newrelic.com/metric/v1"
    api-key = "yourEventAPIInsertKey"

Make sure that address-metrics is set to https://metric-api.eu.newrelic.com/metric/v1 if your account hosts data in the EU data center.

It is also recommended to set up the backend to either use the Insight Collector or the Infrastructure Agent to send none metric events back to New Relic.

#Example Metric API configuration with Insights Collector support

[newrelic]
    transport = "default"
    address = "https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/events"
    address-metrics = "https://metric-api.newrelic.com/metric/v1"
    api-key = "yourEventAPIInsertKey"

New Relic Infrastructure Agent

Sending via the Infrastructure Agent's inbuilt HTTP server provides additional features, such as automatically applying additional metadata to the event the host may have such as AWS tags, instance type, host information, labels etc.

The payload structure required to be accepted by the agent can be viewed here.

To enable the HTTP server, modify /etc/newrelic.yml to include the below, and restart the agent (Step 1.2).

http_server_enabled: true
http_server_host: 127.0.0.1 #(default host)
http_server_port: 8001 #(default port)

Manual Flush Type Configuration

The flush-type attribute can be configured with the following available options - insights, metrics or infra.

[newrelic]
    transport = "default"
	flush-type = "insights" # <--
    address = "https://another-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/events"
    api-key = "yourEventAPIInsertKey"

Renaming Attributes

This option is only available for insights and infra flush-types.

Additional options are available to rename attributes if required.

[newrelic]
	tag-prefix = ""
	metric-name = "name"
	metric-type = "type"
	per-second = "per_second"
	value = "value"
	timer-min = "min"
	timer-max = "max"
	timer-count = "samples_count"
	timer-mean = "samples_mean"
	timer-median = "samples_median"
	timer-stddev = "samples_std_dev"
	timer-sum = "samples_sum"
	timer-sumsquare = "samples_sum_squares"