sensu-kafka-handler

sensu-kafka-handler

Table of Contents

• Overview
• Files
• Usage examples
• Configuration
  • Asset registration
  • Handler definition
  • Annotations
• Installation from source
• Additional notes
• Contributing

Overview

This handler translate Sensu events into Kafka key/value messages for a configurable Kafka topic. The full Sensu event is passed as the message value, using the event UUID as the message key

Note handler is in in active development.

Files

Usage examples

./sensu-kafka-handler --help
Sensu handler to convert Sensu events to Kafka messages

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

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

Flags:
      --cert-file string           certificate for TLS authenticationin PEM format
  -n, --dryrun                     Dryrun, do not connect to Kafka broker
  -e, --enable-tls                 enable TLS encryption
  -h, --help                       help for sensu-kafka-handler
  -H, --host string                The Kafka broker host, defaults to value of KAFKA_HOST env variable (default "localhost:9092")
      --insecure-skip-tls-verify   skip TLS verification (not recommended!)
      --key-file string            key for TLS authentication in PEM format
  -t, --topic string               Kafka topic to post to, defaults to value of KAFKA_TOPIC env variable (default "sensu-event")
      --trusted-ca-file string     TLS CA certificate bundle in PEM format
  -v, --verbose                    Verbose output to stdout, useful for testing

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

Configuration

host argument should point to the Kafka listener <host:port>. Currently only plaintext is supported topic argument should match an existing topic already created on the Kafka server.

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-kafka-handler

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/sensu/sensu-kafka-handler].

Handler definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-kafka-handler
  namespace: default
spec:
  command: sensu-kafka-handler --host localhost:9092 --topic sensu-events
  type: pipe
  runtime_assets:
  - sensu/sensu-kafka-handler

Proxy Support

This handler supports the use of the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof). HTTPS_PROXY takes precedence over HTTP_PROXY for https requests. The environment values may be either a complete URL or a "host[:port]", in which case the "http" scheme is assumed.

Annotations

The host and topic 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-kafka-handler/config.

Examples

To change the example 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-kafka-handler/config/topic: "custom-topic"
[...]

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-kafka-handler repository:

go build

Additional notes

Contributing

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