Sensu Prometheus remote write Handler

Table of Contents

• Overview
• Usage examples
  • Help output
• Configuration
  • Asset registration
  • Handler definition
• Installation from source
• Contributing

Overview

The Sensu Prometheus remote write Handler is a Sensu Handler that sends metrics to time series database that has Prometheus remote write interface.

Usage examples

Help output

Prometheus remote write Handler for Sensu

Usage:
  sensu-prometheus-remote-write-handler [flags]
  sensu-prometheus-remote-write-handler [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  version     Print the version number of this plugin

Flags:
  -e, --endpoint string        Remote write endpoint
  -H, --header strings         Additional header(s) to send in remote write request
  -h, --help                   help for sensu-prometheus-remote-write-handler
  -C, --include-check-name     If true, the name of CheckConfig is added as a label to all metrics sent from Sensu
  -S, --include-event-status   If true, the check status result will be captured as a metric
  -t, --timeout string         Remote write timeout (default "10s")

Use "sensu-prometheus-remote-write-handler [command] --help" for more information about a command.

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 jadiunr/sensu-prometheus-remote-write-handler

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

Handler definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-prometheus-remote-write-handler
  namespace: default
spec:
  command: sensu-prometheus-remote-write-handler -e http://localhost:9009/prometheus -H "X-Scope-OrgID:tenant-example"
  type: pipe
  runtime_assets:
  - jadiunr/sensu-prometheus-remote-write-handler

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-prometheus-remote-write-handler repository:

go build

Contributing

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