License
MIT License
The Sensu Go Email Handler is a Sensu Event Handler for sending
incident notification emails.
The Sensu Email handler sends an email notifications
Usage:
sensu-email-handler [flags]
Flags:
-a, --authMethod string The SMTP authentication method, one of 'none', 'plain', or 'login' (default "plain")
-T, --bodyTemplateFile string A template file to use for the body
-l, --enableLoginAuth [deprecated] Use "login auth" mechanisim
-f, --fromEmail string The 'from' email address
-h, --help help for sensu-email-handler
-H, --hookout Include output from check hook(s)
-i, --insecure [deprecated] Use an insecure connection (unauthenticated on port 25)
-s, --smtpHost string The SMTP host to use to send to send email
-p, --smtpPassword string The SMTP password, if not in env SMTP_PASSWORD
-P, --smtpPort uint The SMTP server port (default 587)
-u, --smtpUsername string The SMTP username, if not in env SMTP_USERNAME
-S, --subjectTemplate string A template to use for the subject (default "Sensu Alert - {{.Entity.Name}}/{{.Check.Name}}: {{.Check.State}}")
-k, --tlsSkipVerify Do not verify TLS certificates
-t, --toEmail string The 'to' email address (accepts comma delimited and/or multiple flags)
Assets are the best way to make use of this handler. 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 sensu/sensu-email-handler
If you're using an earlier version of sensuctl, you can download the asset definition from this project's Bonsai Asset Index page.
---
type: Asset
api_version: core/v2
metadata:
name: sensu-email-handler_linux_amd64
labels:
annotations:
io.sensu.bonsai.url: https://bonsai.sensu.io/assets/sensu/sensu-email-handler
io.sensu.bonsai.api_url: https://bonsai.sensu.io/api/v1/assets/sensu/sensu-email-handler
io.sensu.bonsai.tier: Supported
io.sensu.bonsai.version: 0.2.0
io.sensu.bonsai.namespace: sensu
io.sensu.bonsai.name: sensu-email-handler
io.sensu.bonsai.tags: handler
spec:
url: https://assets.bonsai.sensu.io/45eaac0851501a19475a94016a4f8f9688a280f6/sensu-email-handler_0.2.0_linux_amd64.tar.gz
sha512: d69df76612b74acd64aef8eed2ae10d985f6073f9b014c8115b7896ed86786128c20249fd370f30672bf9a11b041a99adb05e3a23342d3ad80d0c346ec23a946
filters:
- entity.system.os == 'linux'
- entity.system.arch == 'amd64'
---
api_version: core/v2
type: Handler
metadata:
namespace: default
name: email
spec:
type: pipe
command: sensu-email-handler -f from@example.com -t to@example.com -t "to2@example.com, to3@example.com" -s smtp.example.com
-u user -p password
timeout: 10
filters:
- is_incident
- not_silenced
runtime_assets:
- sensu/sensu-email-handler
All of the above command line arguments can be overridden by check or entity annotations.
The annotation consists of the key formed by appending the "long" argument specification
to the string sensu.io/plugins/email/config (e.g. sensu.io/plugins/email/config/toEmail).
For example, having the following in an agent.yml file will create an entity annotation
such that emails generated by events on this entity will go to ops@example.com
instead
of the recipient defined in the handler. And the subject would be something to the effect
of 'failing - webserver01/check-nginx'.
namespace: "default"
subscriptions:
- linux
backend-url:
- "ws://127.0.0.1:8081"
annotations:
sensu.io/plugins/email/config/toEmail: "ops@example.com"
sensu.io/plugins/email/config/subjectTemplate: "{{.Check.State}} - {{.Entity.Name}}/{{.Check.Name}}",
Note: When using template expansion for annotations in checks, the token delimiters {{
and }}
have to be escaped with {{`
and `}}
, respectively. Yes, this is ugly, but it is because checks are ran through token expansion before being ran. This is not needed for annotations in entities.
Example:
"sensu.io/plugins/email/config/subjectTemplate": "{{`{{ .Check.State }}`}} - {{`{{ .Entity.Name }}`}}/{{`{{ .Check.Name }}`}}",
The plugin provides an option to use a template as for the body of the email and is capable of using HTML for formatting the email. An example is provided below:
/etc/sensu/email_template
<html>
Greetings,
<h3>Informational Details</h3>
<b>Check</b>: {{ .Check.Name }}
<b>Entity</b>: {{ .Entity.Name }}
<b>State</b>: {{ .Check.State }}
<b>Occurrences</b>: {{ .Check.Occurrences }}
<b>Playbook</b>: https://example.com/monitoring/wiki/playbook
<h3>Check Output Details</h3>
<b>Check Output</b>: {{.Check.Output}}
<h4>Check Hook(s)</h4>
{{range .Check.Hooks}}<b>Hook Name</b>: {{.Name}}
<b>Hook Command</b>: {{.Command}}
<b>Hook Output</b>: {{.Output}}
{{end}}
#monitoringlove,<br>
Sensu
</html>
Note that this uses tokens to populate the values provided by the event.
Also note that line breaks in your template and any text surfaced by token substitution are replaced with the HTML <br> tag.
At the time of this example, check hooks and templates are not able to be used together via the -H
and -T
flags. However, you may include the hook output as part of the template via the following:
{{range .Check.Hooks}}
Hook Name: {{.Name}}
Hook Command: {{.Command}}
{{.Output}}
Download the latest version of the sensu-email-handler from releases,
or create an executable script from this source.
From the local path of the sensu-email-handler repository:
go build -o /usr/local/bin/sensu-email-handler main.go
For additional instructions, see CONTRIBUTING
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.
×