Sensu Google Chat Handler

Table of Contents

• Overview
• Files
• Usage examples
• Configuration
  • Asset registration
  • Handler definition
  • Environment variables
• Installation from source
• Contributing

Overview

The Sensu Google Chat Handler is a Sensu Handler that sends notifications to a Google Chat space via webhooks. Messages include a link to the event in the Sensu dashboard and organize messages by entity in Google Chat threads.

Originally forked from grant-singleton-nz/sensu-simple-google-chat-handler.

Files

• main.go: The main Go file that implements the handler functionality
• go.mod: Dependency management file for Go modules
• .goreleaser.yaml: Configuration for building and releasing the handler via GoReleaser
• .github/workflows/: GitHub Actions workflow files for testing and releasing the handler

Usage examples

Help output

The Sensu Google Chat Handler is a Sensu Handler that sends alert notifications to Google Chat

Usage:
  sensu-google-chat-handler [flags]
  sensu-google-chat-handler [command]

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

Flags:
  -d, --dashboard string   URL prefix to dashboard with namespace
  -h, --help               help for sensu-google-chat-handler
  -w, --webhook string     The webhook URL to post the message to (HTTPS required)

Use "sensu-google-chat-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! You can use the following command to add the asset:

sensuctl asset add jhenderson-pro/google-chat-handler

You can also find the asset on the Bonsai Asset Index.

Handler definition

---
type: Handler
api_version: core/v2
metadata:
  name: google-chat
  namespace: default
spec:
  command: sensu-google-chat-handler --webhook $GOOGLE_CHAT_WEBHOOK --dashboard $SENSU_DASHBOARD
  type: pipe
  runtime_assets:
    - jhenderson-pro/google-chat-handler
  secrets:
    - name: GOOGLE_CHAT_WEBHOOK
      secret: google-chat-webhook
  env_vars:
    - SENSU_DASHBOARD=https://sensu.example.com

Environment variables

Argument	Environment Variable	Default	Required	Description
--webhook	GOOGLE_CHAT_WEBHOOK		true	The webhook URL to post the message to (HTTPS only)
--dashboard	SENSU_DASHBOARD		true	URL prefix to dashboard with namespace

Installation from source

Download

Download the latest version of sensu-google-chat-handler from releases, or create an executable from this source.

For Linux systems with go installed:

go install github.com/jhenderson-pro/google-chat-handler@latest

Contributing

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