Select Supported Platforms

Select Supported Architectures

Select Tier

Github Name


v0.2.0 · public · Published 17 days ago

README
Asset Definition
Release Notes
Release Assets

Sensu Bonsai Asset
Go Test
goreleaser
Go Report Card

sensu-snmp-trap-handler

Table of Contents

Overview

The sensu-snmp-trap-handler is a Sensu Handler that sends alerts to an SNMP manager via
SNMP traps.

Files

The necessary MIB files are in the mibs directory.

Usage examples

Sensu SNMP Trap Handler

Usage:
  sensu-snmp-trap-handler [flags]
  sensu-snmp-trap-handler [command]

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

Flags:
  -c, --community string          The SNMP Community string to use when sending traps (default "public")
  -h, --help                      help for sensu-snmp-trap-handler
  -H, --host string               The SNMP manager host address (default "127.0.0.1")
  -p, --port int                  The SNMP manager trap port (UDP) (default 162)
  -t, --varbind-trim int          The SNMP trap varbind value trim length in characters (default 100)
  -v, --version string            The SNMP version to use (1,2,2c) (default "2")
  -m, --message-template string   The template for the SNMP message (default "{{.Check.State}} - {{.Entity.Name}}/{{.Check.Name}} : {{.Check.Output}}")


Use "sensu-snmp-trap-handler [command] --help" for more information about a command.

Configuration

Sensu Go

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 nixwiz/sensu-snmp-trap-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-snmp-trap-handler
  namespace: default
spec:
  command: sensu-snmp-trap-handler --host snmp-manager.example.com
  type: pipe
  filters:
  - is_incident
  - not_silenced
  runtime_assets:
  - nixwiz/sensu-snmp-trap-handler

Annotations

All arguments for this handler are tunable on a per entity or check basis based on annotations. The
annotations keyspace for this handler is sensu.io/plugins/sensu-snmp-trap-handler/config.

Examples

To change the host argument for a particular check, for that checks's metadata add the following:

type: CheckConfig
api_version: core/v2
metadata:
  annotations:
    sensu.io/plugins/sensu-snmp-trap-handler/config/host: "snmp-manager2.example.com"
[...]

Sensu Core

N/A

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-snmp-trap-handler repository:

go build

Additional notes

N/A

Contributing

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

Are you sure you want to report this asset?

Please describe the reason for reporting this asset. Our moderators will be notified and will disable the asset if it is found to be inappropriate.

×

You must be signed in to report this asset.

Sign In with Github

Download

×

Either download the source code:

Download Source

Or download the asset definition: