Select Supported Platforms

Select Supported Architectures

Select Tier

Github Name


v0.3.1 · public · Published about 4 years ago

README
Asset Definition
Release Notes
Release Assets

sensu-go-flowdock-handler

The Senso Go Flowdock Handler is a Sensu Event Handler for sending incident
notifications to CA Flowdock.

This handler reuses concepts found in the sensu-email-handler.

Installation

Create an executable script from this source or download one of the existing releases.

From the local path of the sensu-go-flowdock-handler repository:

go build -o /usr/local/bin/sensu-flowdock-handler main.go

Sensu Configuration

Example Sensu Go definition:

{
    "api_version": "core/v2",
    "type": "Handler",
    "metadata": {
        "namespace": "default",
        "name": "flowdock"
    },
    "spec": {
        "type": "pipe",
        "command": "sensu-flowdock-handler -t 0123456789abcdef0123456789abcdef -b http://sensu-backend.example.com:3000",
        "timeout": 10,
        "filters": [
            "is_incident",
            "not_silenced"
        ]
    }
}

Flowdock Configuration

This handler makes use of Flowdock's "new" Integration API mechanism. This means creating a developer application
and then a source. This source will have the API Token needed by this handler.

Note: Actions for these messages are not implemented.

Usage Examples

Help

The Sensu Flowdock handler for sending notifications

Usage:
  sensu-flowdock-handler [flags]

Flags:
  -a, --authorAvatar string    Avatar URL (default "https://avatars1.githubusercontent.com/u/1648901?s=200&v=4")
  -n, --authorName string      Name for the author of the thread (default "Sensu")
  -b, --backendURL string      The URL for the backend, used to create links to events, if not in env SENSU_FLOWDOCK_BACKENDURL
  -t, --flowdockToken string   The Flowdock application token, if not in env SENSU_FLOWDOCK_TOKEN
  -h, --help                   help for sensu-flowdock-handler
  -l, --labelPrefix string     Label prefix for entity fields to be included in thread (default "flowdock_")

Environment Variables and Annotations

Environment Variable Setting Annotation
SENSU_FLOWDOCK_TOKEN same as -t / --flowdockToken sensu.io/plugins/flowdock/token
SENSU_FLOWDOCK_BACKENDURL same as -b / --backendURL sensu.io/plugins/flowdock/backend-url
N/A same as -n / --authorName sensu.io/plugins/flowdock/author-name
N/A same as -a / --authorAvatar sensu.io/plugins/flowdock/author-avatar

Precedence

environment variable < command-line argument < annotation

Usage of entity labels to add fields to output

This handler can make use of labels provided by the entity to populate addtional fields in the thread.

---
##
# agent configuration
##
#name: ""
namespace: "default"
subscriptions:
  - linux
backend-url:
  - "ws://127.0.0.1:8081"

labels:
  flowdock_Application: "webapp1"
  flowdock_Environment: "live"

Sample in Flowdock

Below is a thread sample that includes surfacing the labels defined above.

Flowdock Sample

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: