From 8eeadbc98ffb554a40ad50d1cd6ae612e8e9a355 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Tue, 22 Jun 2021 14:34:41 +0100 Subject: [PATCH] :sparkles: Adds option for continious status checking --- docs/status-indicators.md | 11 +++++++++++ src/components/LinkItems/Item.vue | 5 +++++ src/components/LinkItems/ItemGroup.vue | 8 ++++++++ src/utils/ConfigSchema.json | 5 +++++ 4 files changed, 29 insertions(+) diff --git a/docs/status-indicators.md b/docs/status-indicators.md index e459c063..1e91af06 100644 --- a/docs/status-indicators.md +++ b/docs/status-indicators.md @@ -37,6 +37,17 @@ sections: statusCheck: true ``` +## Continuous Checking +By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the `statusCheckInterval` attribute. Here you define an interval in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower. + +The following example, will instruct Dashy to continuously check the status of your services every 20 seconds + +``` +appConfig: + statusCheck: true + statusCheckInterval: 20 +``` + ## How it Works When Dashy is loaded, items with `statusCheck` enabled will make a request, to `https://[your-host-name]/ping?url=[address-or-servce]`, which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request. diff --git a/src/components/LinkItems/Item.vue b/src/components/LinkItems/Item.vue index 37c0733a..cf4aa1d7 100644 --- a/src/components/LinkItems/Item.vue +++ b/src/components/LinkItems/Item.vue @@ -53,6 +53,7 @@ export default { }, itemSize: String, enableStatusCheck: Boolean, + statusCheckInterval: Number, }, data() { return { @@ -114,6 +115,7 @@ export default { } }, checkWebsiteStatus() { + this.statusResponse = undefined; const baseUrl = process.env.VUE_APP_DOMAIN || window.location.origin; const endpoint = `${baseUrl}/ping?url=${this.url}`; axios.get(endpoint) @@ -131,6 +133,9 @@ export default { mounted() { this.manageTitleEllipse(); if (this.enableStatusCheck) this.checkWebsiteStatus(); + if (this.statusCheckInterval > 0) { + setInterval(this.checkWebsiteStatus, this.statusCheckInterval * 1000); + } }, }; diff --git a/src/components/LinkItems/ItemGroup.vue b/src/components/LinkItems/ItemGroup.vue index e94a2794..87805055 100644 --- a/src/components/LinkItems/ItemGroup.vue +++ b/src/components/LinkItems/ItemGroup.vue @@ -29,6 +29,7 @@ :backgroundColor="item.backgroundColor" :itemSize="newItemSize" :enableStatusCheck="shouldEnableStatusCheck(item.statusCheck)" + :statusCheckInterval="getStatusCheckInterval()" @itemClicked="$emit('itemClicked')" @triggerModal="triggerModal" /> @@ -98,6 +99,13 @@ export default { const globalPreference = this.config.appConfig.statusCheck || false; return itemPreference !== undefined ? itemPreference : globalPreference; }, + getStatusCheckInterval() { + let interval = this.config.appConfig.statusCheckInterval; + if (!interval) return 0; + if (interval > 60) interval = 60; + if (interval < 1) interval = 0; + return interval; + }, }, }; diff --git a/src/utils/ConfigSchema.json b/src/utils/ConfigSchema.json index edf2db4d..56bce83b 100644 --- a/src/utils/ConfigSchema.json +++ b/src/utils/ConfigSchema.json @@ -131,6 +131,11 @@ "default": false, "description": "Displays an online/ offline status for each of your services" }, + "statusCheckInterval": { + "type": "number", + "default": 0, + "description": "How often to recheck statuses. If set to 0, status will only be checked on page load" + }, "auth": { "type": "array", "description": "Usernames and hashed credentials for frontend authentication",