The report can be triggered on an interval just like the checks. Its main purpose is to let the user know that the service is up and running.
| name | example | optional | default |
|---|---|---|---|
| disable | true |
✔ | false |
| interval | 60 |
✔ | 604800 |
| cron | 0 * * * * * |
✔ | |
| placeholders | {"hostname" = "foobar"} |
✔ | |
| events | List of Event | ✔ |
If true, the report is disabled and will not be triggered.
The time between two consecutive reports in seconds.
Set either this or cron, but not both.
Report schedule in cron-like syntax: sec min hour day of month month day of week year where year is optional and the time zone is UTC.
Set either this or interval, but not both.
Custom placeholders that will be merged with ones of the events/actions.
List of events.
Events configure the relation between the report and the actions.
| name | example | optional | default |
|---|---|---|---|
| disable | true |
✔ | false |
| name | FooEvent |
❌ | |
| action | FooAction |
❌ | |
| placeholders | {"what" = "foobar"} |
✔ |
If true, the report is disabled and will not be triggered.
The name of the event. It is used for logging and the event_name placeholder.
Must be unique.
The name of the action to trigger when the event is triggered.
Custom placeholders that will be merged with ones of the events/actions.