README.md

Sensu Go Metric Tag Enrichment

Table of Contents

• Overview
• Usage examples
• Configuration
  • Asset registration
  • Mutator definition
• Installation from source
• Additional notes
• Contributing

Overview

Sensu Go Metric Tag Enrichment is a Sensu Go plugin for enriching metric points with Entity metadata (e.g. entity name, labels) and Check metadata (e.g. check name, labels), adding them as Metric Tags. The Sensu Metric Tag Mutator is useful for adding context to generic metrics collected from plugins that generate metrics in formats that don't support tags (e.g. Nagios Perfdata).

Usage

Enrich Sensu Metrics with Event, Entity, and Check labels as metric tags.

Usage:
  sensu-go-metric-tag-enrichment [flags]
  sensu-go-metric-tag-enrichment [command]

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

Flags:
  -c, --check            Add a "check" tag containing the check name to every metric.
      --check-labels     Add a tag for every check label to every metric.
  -e, --entity           Add an "entity" tag containing the entity name to every metric.
      --entity-labels    Add a tag for every entity label to every metric.
      --event-labels     Add a tag for every event label to every metric.
  -f, --filter string    Comma separated list of tags to exclude. (default "sensu.io/managed_by")
  -h, --help             help for sensu-go-metric-tag-enrichment
  -n, --namespace        Add a "namespace" tag containing the entity namespace to every metric.
  -r, --require string   Comma separated list of tags to include on all metrics, even if no matching  labels are found

Use "sensu-go-metric-tag-enrichment [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 calebhailey/sensu-go-metric-tag-enrichment

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

Mutator definition

---
type: Mutator
api_version: core/v2
metadata:
  name: sensu-go-metric-tag-enrichment
spec:
  command: >- 
    sensu-go-metric-tag-enrichment
    --namespace 
    --entity 
    --check
    --event-labels
    --entity-labels
    --check-labels
    --filter sensu.io/managed_by,foo,bar 
  runtime_assets:
  - calebhailey/sensu-go-metric-tag-enrichment

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-go-metric-tag-enrichment repository:

go build

Additional notes

Contributing

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