OpenTSDB

ENTERPRISE: Built-in integrations are available for Sensu Enterprise users only.

Overview

Send metrics to OpenTSDB using the telnet protocol (over TCP). This handler uses the output_formatmutator.

The following is an example global configuration for the opentsdb enterprise handler (integration).

{
  "opentsdb": {
    "host": "opentsdb.example.com",
    "port": 4242,
    "tag_host": true,
    "tags": {
      "dc": "us-central-1"
    }
  }
}

The following attributes are configured within the {"opentsdb": {} } configuration scope.

PRO TIP: You can override opentsdb attributes on a per-contact basis using contact routing.

port
description	The OpenTSDB telnet listener port.
required	false
type	Integer
default	`4242`
example	`"port": 4444`

tag_host
description	If automatic host tagging should be used for metric data points. The Sensu client `name` is used as the `host` tag value. The OpenTSDB handler will always add a `host` tag to metric data points that do not have tags.
required	false
type	Boolean
default	`true`
example	`"tag_host": false`

prefix_source
description	If the Sensu source (client name) should prefix (added to) the metric names.
required	false
type	Boolean
default	`false`
example	`"prefix_source": true`

tags
description	Configurable custom tags (key/value pairs) to add to every OpenTSDB metric data point.
required	false
type	Hash
default	`{}`
example	`"tags": { "dc": "us-central-1" }`

retry_limit
description	The number of times the integration will attempt to re-send metrics after encountering an error.
required	false
type	Integer
default	`3`
example	`"retry_limit": "3"`

retry_delay
description	How long the integration will wait between retries, in seconds.
required	false
type	Integer
default	`1`
example	`"retry_delay": "1"`