diff --git a/docs/widgets.md b/docs/widgets.md index f0ac657d..3fa60a79 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -25,6 +25,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Public IP Address](#public-ip) - [Self-Hosted Services Widgets](#dynamic-widgets) - [System Info](#system-info) + - [Cron Monitoring](#cron-monitoring-health-checks) - [CPU History](#cpu-history-netdata) - [Memory History](#memory-history-netdata) - [System Load History](#load-history-netdata) @@ -584,6 +585,29 @@ _No config options._ --- +### Cron Monitoring (Health Checks) + +Cron job monitoring using [Health Checks](https://github.com/healthchecks/healthchecks). Both managed and self-hosted instances are supported. + +

+ +##### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`apiKey`** | `string` | Required | A read-only API key for the project to monitor. You can generate this by selecting a Project --> Settings --> API Access. Note that you must generate a separate key for each project +**`host`** | `string` | _Optional_ | If you're self-hosting, or using any instance other than the official (healthchecks.io), you will need to specify the host address. E.g. `https://healthchecks.example.com` or `http://cron-monitoing.local` + +##### Example + +```yaml +- type: health-checks + options: + apiKey: XXXXXXXXX +``` + +--- + ### CPU History (NetData) Pull recent CPU usage history from NetData. diff --git a/src/components/Widgets/HealthChecks.vue b/src/components/Widgets/HealthChecks.vue new file mode 100644 index 00000000..6c8b20b9 --- /dev/null +++ b/src/components/Widgets/HealthChecks.vue @@ -0,0 +1,161 @@ + + + + + + + diff --git a/src/components/Widgets/WidgetBase.vue b/src/components/Widgets/WidgetBase.vue index 48da3373..9d02647a 100644 --- a/src/components/Widgets/WidgetBase.vue +++ b/src/components/Widgets/WidgetBase.vue @@ -88,6 +88,13 @@ @error="handleError" :ref="widgetRef" /> +