Documentation
¶
Overview ¶
Package probes provides some probe implementations.
This package defines some helpers to send alert emails, while actual probes are defined in subpackages.
It uses sendgrid.com to send emails, which seems quite reliable, cheap and easy to use. You need an account with sengrid.com with user/password to use this package.
To send alert emails, at minimum the following configuration is required:
- Config.SendGrid: sendgrid credentials
- Config.Alert.Recipient: who receives the emails
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Config = EmailConfig{TemplateName: "email"}
Config is the email configuration.
Functions ¶
Types ¶
type EmailConfig ¶
type EmailConfig struct {
// Template for HTML email. See EmailData for what's passed to the
// template when an alert email is generated.
Template string
TemplateName string // name of the template
Alert struct {
Sender string // From: address
Recipient string // To: address
CCs []string // CC: addresses
}
SendgridToken string // sendgrid token
}
EmailConfig describes the structure of the email configuration.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package dnsprobe implements a DNS probe.
|
Package dnsprobe implements a DNS probe. |
|
Package tcpprobe implements a TCP probe.
|
Package tcpprobe implements a TCP probe. |
|
Package varsprobe implements a probe for /vars, i.e.
|
Package varsprobe implements a probe for /vars, i.e. |
|
Package webprobe implements a HTTP probe.
|
Package webprobe implements a HTTP probe. |
Click to show internal directories.
Click to hide internal directories.