isabella232 / sensu-stackdriver-handler

Send Sensu Go collected metrics to Google Stackdriver.

Sensu Stackdriver Handler

Table of Contents

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

Overview

The Sensu Stackdriver Handler is a Sensu Handler that sends Sensu Go collected metrics to Google Stackdriver. Leverage Sensu Go to collect and process metrics from a plethora of data sources, from Nagios service check plugin executions to the Sensu Backend and Agent data ingestion APIs. Provide the Handler with a Google Stackdriver project ID and begin storing time series in Stackdriver with Sensu Go.

Usage examples

Help:

Send Sensu Go collected metrics to Google Stackdriver

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

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

Flags:
  -h, --help                help for sensu-stackdriver-handler
  -p, --project-id string   The Google Cloud Project ID
  -l, --include-labels      Include entity and check labels in the metrics labels (default false)

Use "sensu-stackdriver-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 portertech/sensu-stackdriver-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: stackdriver
  namespace: default
spec:
  command: sensu-stackdriver-handler -p my-project-id-123
  type: pipe
  runtime_assets:
  - portertech/sensu-stackdriver-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-stackdriver-handler repository:

go build

Contributing

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