Metric Notifier
This integration can be used together with the Metric Monitor to send notifications when status of the monitored devices and functions changes.
The integration listens for the events emitted by the Metric Monitor and reads meta-data information to know how and if to send notifications to the user.
Configuration
Configuration of the notification can be done with the following keys. The keys can be used on functions, devices, installations and organizations. However, they will always use the following priority:
- Function/Device (depending on object triggering)
- Installation
- Organization
There are two options described below to specify notifications. Either using plain email or using existing notification outputs in the platform.
metric_notify.emails
This meta-key can specify a comma-separated list of email-addresses that should receive the notification. The email will contain a pre-formatted message with some data in it.
metric_notify.notification_outputs
This meta-key can specify one or several notification outputs to be sent. The notification message template gets injected with the following data and can be used in the template to enrich the message (see more here):
Please note that notification_outputs cannot be used on organization level.
Var name | Description |
---|---|
.payload.InstallationID | ID of the installation |
.payload.ObjectType | Device or Function |
.payload.ObjectID | ID of the object |
.payload.Timestamp | Time the monitor event was emitted |
.payload.Installation | The installation object |
.payload.Organization | The organization of the installation |
.payload.Status | The monitor status number |
.payload.StatusText | The monitor status as text |
.payload.Device | The device object (if ObjectType is device) |
.payload.Function | The function object (if ObjectType is function) |