v0.6.3 · public · Published almost 3 years ago
The Senso Go Flowdock Handler is a Sensu Event Handler for sending incident notifications to CA Flowdock.
The Sensu Go Flowdock handler for sending notifications Usage: sensu-go-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 -u, --flowdockAPIURL string The Flowdock API URL (default "https://api.flowdock.com/messages") -t, --flowdockToken string The Flowdock application token -h, --help help for sensu-go-flowdock-handler -i, --includeNamespace Include the namespace with the entity name in title and thread ID -l, --labelPrefix string Label prefix for entity fields to be included in thread
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 or later, you can use the following command to add the asset:
sensuctl asset add nixwiz/sensu-go-flowdock-handler
If you're using an earlier version of sensuctl, you can download the asset definition from this project's Bonsai asset index page or one of the existing releases or create an executable script from this source.
To build from source, from the local path of the sensu-go-flowdock-handler repository:
go build -o /usr/local/bin/sensu-go-flowdock-handler main.go
api_version: core/v2 type: Handler metadata: namespace: default name: flowdock spec: type: pipe command: sensu-go-flowdock-handler -b http://sensu-backend.example.com:3000 filters: - is_incident - not_silenced runtime_assets: - nixwiz/sensu-go-flowdock-handler secrets: - name: SENSU_FLOWDOCK_TOKEN secret: flowdock-token#key timeout: 10
Security Note: The Flowdock Token should always be treated as a security
sensitive configuration option and in this example, it is loaded into the
handler configuration as an environment variable using a secret. Command
arguments are commonly readable from the process table by other unpriviledged
users on a system (ex: ps and top commands), so it's a better practice to read
in sensitive information via environment variables or configuration files on
disk. The --flowdockToken flag is provided as an override for testing purposes.
See the instructions above for asset registration.
Install and setup plugins on Sensu Core.
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.
|SENSU_FLOWDOCK_TOKEN||same as -t / --flowdockToken||sensu.io/plugins/flowdock/flowdockToken|
|SENSU_FLOWDOCK_BACKENDURL||same as -b / --backendURL||sensu.io/plugins/flowdock/backendURL|
|N/A||same as -n / --authorName||sensu.io/plugins/flowdock/authorName|
|N/A||same as -a / --authorAvatar||sensu.io/plugins/flowdock/authorAvatar|
environment variable < command-line argument < annotation
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"
Below is a thread sample that includes surfacing the labels defined above.
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.×