isabella232 / sensu-wavefront-handler

Sensu Go Wavefront Metrics Handler

sensu-wavefront-handler

Table of Contents

• Overview
• Usage Examples
• Configuration
  • Asset registration
  • Resource definition
• Installation from source
• Contributing

Overview

The Sensu Wavefront Handler is a Sensu Event Handler that sends metrics to the SaaS time-series database Wavefront via a proxy. Sensu can collect metrics using check output metric extraction or the StatsD listener. Those collected metrics pass through the event pipeline, allowing Sensu to deliver normalized metrics to the configured metric event handlers. This Wavefront handler will allow you to store, instrument, and visualize the metric data from Sensu.

Usage Examples

Help:

sends metrics to a wavefront proxy using the wavefront data format

Usage:
  sensu-wavefront-handler [flags]
  sensu-wavefront-handler [command]

Available Commands:
  help        Help about any command
  version     Print the version number of this plugin

Flags:
  -f, --flush-interval-seconds int   the flush interval of the wavefront proxy (in seconds) (default 1)
  -h, --help                         help for sensu-wavefront-handler
      --host string                  the host of the wavefront proxy (default "127.0.0.1")
  -m, --metrics-port int             the port of the wavefront proxy (default 2878)
  -p, --prefix string                the string to be prepended to the metric name
  -t, --tags stringToString          the additional tags to merge with the metric tags (default [])

Configuration

Asset registration

Sensu Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 with Sensu Backend 5.13 or later, you can use the following command to add the asset:

sensuctl asset add sensu/sensu-wavefront-handler

If you're using an earlier version of sensuctl, you can find the asset on the Bonsai Asset Index.

Resource definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-wavefront-handler
  namespace: default
spec:
  command: sensu-wavefront-handler --host "127.0.0.1" --metrics-port 2878 --prefix sensu --tags type="system" --flush-interval-seconds 1
  runtime_assets:
  - sensu-wavefront-handler
  type: pipe

Installation from source

The preferred way of installing and deploying this plugin is to use it as an Asset. If you would like to compile and install the plugin from source or contribute to it, download the latest version or create an executable script from this source.

From the local path of the sensu-wavefront-handler repository:

go build

Contributing

For more information about contributing to this plugin, see Contributing.