π A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
:sparkles: Adds a StatPing widget
Alicia Sykes901c873d4e94
diff --git a/docs/widgets.md b/docs/widgets.mdindex 3fa60a79..e86d7d61 100644--- a/docs/widgets.md+++ b/docs/widgets.md@@ -32,6 +32,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a- [Pi Hole Stats](#pi-hole-stats)- [Pi Hole Queries](#pi-hole-queries)- [Recent Traffic](#recent-traffic)+ - [Stat Ping Statuses](#stat-ping-statuses)- [Dynamic Widgets](#dynamic-widgets)- [Iframe Widget](#iframe-widget)- [HTML Embed Widget](#html-embedded-widget)@@ -747,6 +748,28 @@ Shows number of recent traffic, using allowed and blocked queries from [Pi-Hole]---+### Stat Ping Statuses++Displays the current and recent uptime of your running services, via a self-hosted instance of [StatPing](https://github.com/statping/statping)++<p align="center"><img width="500" src="https://i.ibb.co/Fq7JDjQ/stat-ping.png" /></p>++##### Options++**Field** | **Type** | **Required** | **Description**+--- | --- | --- | ---+**`hostname`** | `string` | Required | The URL to your StatPing instance, without a trailing slash++##### Example++```yaml+- type: stat-ping+ options:+ hostname: http://192.168.130.1:8080+```++---+## Dynamic Widgets### Iframe Widgetdiff --git a/src/components/Widgets/StatPing.vue b/src/components/Widgets/StatPing.vuenew file mode 100644index 00000000..7fa4be5c--- /dev/null+++ b/src/components/Widgets/StatPing.vue@@ -0,0 +1,192 @@+<template>+<div class="stat-ping-wrapper">+ <div+ class="service-row"+ v-for="(service, indx) in services"+ :key="indx"+ v-tooltip="makeTooltip(service)"+ >+ <!-- Title -->+ <p class="service-name">+ {{ service.name }}:+ <span v-if="service.online" class="status-online">Online</span>+ <span v-else class="status-offline">Offline</span>+ </p>+ <!-- Charts -->+ <div class="charts">+ <img class="uptime-pie-chart" :src="makeChartUrl(service.uptime24, '24 Hours')" />+ <img class="uptime-pie-chart" :src="makeChartUrl(service.uptime7, '7 Days')" />+ </div>+ <!-- Info -->+ <div class="info">+ <div class="info-row">+ <span class="lbl">Failed Pings</span>+ <span class="val">{{ service.totalFailure }}/{{ service.totalSuccess }}</span>+ </div>+ <div class="info-row">+ <span class="lbl">Last Success</span><span class="val">{{ service.lastSuccess }}</span>+ </div>+ <div class="info-row">+ <span class="lbl">Last Failure</span><span class="val">{{ service.lastFailure }}</span>+ </div>+ <div class="info-row">+ <span class="lbl">Avg Response Time</span>+ <span class="val">{{ service.responseTime }} ms</span>+ </div>+ </div>+ </div>+</div>+</template>++<script>+import axios from 'axios';+import { serviceEndpoints } from '@/utils/defaults';+import { showNumAsThousand } from '@/utils/MiscHelpers';+import WidgetMixin from '@/mixins/WidgetMixin';++export default {+ mixins: [WidgetMixin],+ components: {},+ data() {+ return {+ services: null,+ };+ },+ computed: {+ hostname() {+ if (!this.options.hostname) this.error('A hostname is required');+ return this.options.hostname;+ },+ proxyReqEndpoint() {+ const baseUrl = process.env.VUE_APP_DOMAIN || window.location.origin;+ return `${baseUrl}${serviceEndpoints.corsProxy}`;+ },+ endpoint() {+ return `${this.hostname}/api/services`;+ },+ },+ methods: {+ fetchData() {+ const requestConfig = {+ method: 'GET',+ url: this.proxyReqEndpoint,+ headers: {+ 'Target-URL': this.endpoint,+ },+ };+ axios.request(requestConfig)+ .then((response) => {+ this.processData(response.data);+ }).catch((error) => {+ this.error('Unable to fetch cron data', error);+ }).finally(() => {+ this.finishLoading();+ });+ },+ makeChartUrl(uptime, title) {+ const host = 'https://quickchart.io';+ const chartId = 'zm-d3d5134f-5920-49d1-92ab-303aaaf8cb0b';+ return `${host}/chart/render/${chartId}?data1=${uptime},${100 - uptime}&title=${title}`;+ },+ makeTooltip(service) {+ const {+ responseTime, totalFailure, totalSuccess, lastSuccess, lastFailure,+ } = service;+ const content = `<b>Failed Pings:</b> ${totalFailure}/${totalSuccess}<br>`+ + `<b>Response Time:</b> ${responseTime}ms<br>`+ + `<b>Last Success:</b> ${lastSuccess}<br>`+ + `<b>Last Failure:</b> ${lastFailure}`;+ return {+ content, html: true, trigger: 'hover focus', delay: 250, classes: 'ping-times-tt',+ };+ },+ getTimeAgo(dateTime) {+ const now = new Date().getTime();+ const then = new Date(dateTime).getTime();+ if (then < 0) return 'Never';+ const diff = (now - then) / 1000;+ const divide = (time, round) => Math.round(time / round);+ if (diff < 60) return `${divide(diff, 1)} seconds ago`;+ if (diff < 3600) return `${divide(diff, 60)} minutes ago`;+ if (diff < 86400) return `${divide(diff, 3600)} hours ago`;+ if (diff < 604800) return `${divide(diff, 86400)} days ago`;+ if (diff >= 604800) return `${divide(diff, 604800)} weeks ago`;+ return 'unknown';+ },+ processData(data) {+ const services = [];+ data.forEach((service) => {+ services.push({+ name: service.name,+ online: service.online,+ uptime7: service.online_7_days,+ uptime24: service.online_24_hours,+ responseTime: Math.round(service.avg_response / 1000),+ totalSuccess: showNumAsThousand(service.stats.hits),+ totalFailure: showNumAsThousand(service.stats.failures),+ lastSuccess: this.getTimeAgo(service.last_success),+ lastFailure: this.getTimeAgo(service.last_error),+ });+ });+ this.services = services;+ },+ },+};+</script>++<style scoped lang="scss">+.stat-ping-wrapper {+ p {+ color: var(--widget-text-color);+ margin: 0.5rem 0;+ }+ .service-row {+ p.service-name {+ font-size: 1.2rem;+ font-weight: bold;+ span {+ margin-left: 0.25rem;+ font-family: var(--font-monospace);+ &.status-online { color: var(--success); }+ &.status-offline { color: var(--danger); }+ }+ }+ .charts {+ display: flex;+ flex-direction: row;+ justify-content: space-evenly;+ img.uptime-pie-chart {+ width: 35%;+ margin: 0.5rem;+ }+ }+ .info {+ opacity: var(--dimming-factor);+ margin: 1rem auto;+ width: fit-content;+ background: var(--background);+ padding: 0.5rem;+ border-radius: var(--curve-factor);+ .info-row {+ display: flex;+ span {+ color: var(--widget-text-color);+ font-size: 0.8rem;+ &.lbl {+ font-weight: bold;+ margin-right: 0.25rem;+ min-width: 8rem;+ }+ &.val {+ font-family: var(--font-monospace);+ }+ }+ }+ }+ &:not(:last-child) {+ border-bottom: 1px dashed var(--widget-text-color);+ }+ }+}++</style>diff --git a/src/components/Widgets/WidgetBase.vue b/src/components/Widgets/WidgetBase.vueindex 9d02647a..142ddf71 100644--- a/src/components/Widgets/WidgetBase.vue+++ b/src/components/Widgets/WidgetBase.vue@@ -179,6 +179,13 @@@error="handleError":ref="widgetRef"/>+ <StatPing+ v-else-if="widgetType === 'stat-ping'"+ :options="widgetOptions"+ @loading="setLoaderState"+ @error="handleError"+ :ref="widgetRef"+ /><StockPriceChartv-else-if="widgetType === 'stock-price-chart'":options="widgetOptions"@@ -259,6 +266,7 @@ import PiHoleTraffic from '@/components/Widgets/PiHoleTraffic.vue';import PublicHolidays from '@/components/Widgets/PublicHolidays.vue';import PublicIp from '@/components/Widgets/PublicIp.vue';import RssFeed from '@/components/Widgets/RssFeed.vue';+import StatPing from '@/components/Widgets/StatPing.vue';import StockPriceChart from '@/components/Widgets/StockPriceChart.vue';import SystemInfo from '@/components/Widgets/SystemInfo.vue';import TflStatus from '@/components/Widgets/TflStatus.vue';@@ -298,6 +306,7 @@ export default {PublicHolidays,PublicIp,RssFeed,+ StatPing,StockPriceChart,SystemInfo,TflStatus,