Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow multiple Project Keys for HealthChecks #1039

Merged
merged 1 commit into from
Jan 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/widgets.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
- [NASA APOD](#astronomy-picture-of-the-day)
- [GitHub Trending](#github-trending)
- [GitHub Profile Stats](#github-profile-stats)
- [Healthchecks Status](#healthchecks status)
- **[Self-Hosted Services Widgets](#self-hosted-services-widgets)**
- [System Info](#system-info)
- [Cron Monitoring](#cron-monitoring-health-checks)
Expand Down Expand Up @@ -1140,6 +1141,38 @@ Display stats from your GitHub profile, using embedded cards from [anuraghazra/g

---

### HealthChecks Status

Display status of one or more HealthChecks project(s). Works with healthcheck.io and your selfhosted instance.

<p align="center"><img width="380" src="https://i.ibb.co/W5dP6VN/Bildschirm-foto-2023-01-07-um-11-07-11.png" /></p>

#### Options

**Field** | **Type** | **Required** | **Description**
--- | --- | --- | ---
**`host`** | `string` | Optional | The base url of your instance, default is `https://healthchecks.io`
**`apiKey`** | `string` or `array` | Required | One or more API keys for your healthcheck projects. (Read-only works fine)

```yaml
- type: HealthChecks
options:
host: https://healthcheck.your-domain.de
apiKey:
- abcdefg...
- zxywvu...
```

#### Info

- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Required
- **Price**: 🟢 Free / Paid / Self-hosted
- **Host**: Managed Instance or Self-Hosted (see [healthchecks/healthchecks](https://github.com/healthchecks/healthchecks))
- **Privacy**: _See [Healthchecks.io Privacy Policy](https://healthchecks.io/privacy/)_

---

## Self-Hosted Services Widgets

### System Info
Expand Down
92 changes: 51 additions & 41 deletions src/components/Widgets/HealthChecks.vue
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
<template>
<div class="health-checks-wrapper" v-if="crons">
<div
class="cron-row"
<template
v-for="cron in crons" :key="cron.id"
v-tooltip="pingTimeTooltip(cron)"
>
<div class="status">
<p :class="cron.status">{{ cron.status | formatStatus }}</p>
</div>
<div class="info">
<div
class="info"
v-tooltip="pingTimeTooltip(cron)"
>
<p class="cron-name">{{ cron.name }}</p>
<p class="cron-desc">{{ cron.desc }}</p>
</div>
</div>
</template>
</div>
</template>

Expand All @@ -35,6 +36,8 @@ export default {
if (status === 'up') symbol = '✔';
if (status === 'down') symbol = '✘';
if (status === 'new') symbol = '❖';
if (status === 'paused') symbol = '⏸';
if (status === 'running') symbol = '▶'
return `${symbol} ${capitalize(status)}`;
},
formatDate(timestamp) {
Expand All @@ -51,21 +54,28 @@ export default {
if (!this.options.apiKey) {
this.error('An API key is required, please see the docs for more info');
}
if (typeof(this.options.apiKey) === "string") {
return [ this.options.apiKey ];
}
return this.options.apiKey;
},
},
methods: {
/* Make GET request to CoinGecko API endpoint */
fetchData() {
this.overrideProxyChoice = true;
const authHeaders = { 'X-Api-Key': this.apiKey };
this.makeRequest(this.endpoint, authHeaders).then(
(response) => { this.processData(response); },
);
const results = [];
this.apiKey.forEach((key) => {
const authHeaders = { 'X-Api-Key': key };
this.makeRequest(this.endpoint, authHeaders).then(
(response) => { this.processData(response, results); },
);
});
results.sort((a,b) => (a.name > b.name) ? 1 : ((b.name > a.name) ? -1 : 0));
this.crons = results;
},
/* Assign data variables to the returned data */
processData(data) {
const results = [];
processData(data, results) {
data.checks.forEach((cron) => {
results.push({
id: cron.slug,
Expand All @@ -78,7 +88,7 @@ export default {
url: this.makeUrl(cron.unique_key),
});
});
this.crons = results;
return results;
},
makeUrl(cronId) {
const base = this.options.host || 'https://healthchecks.io';
Expand All @@ -99,40 +109,40 @@ export default {

<style scoped lang="scss">
.health-checks-wrapper {
display: grid;
justify-content: center;
grid-template-columns: 1fr 2fr;
color: var(--widget-text-color);
.cron-row {
display: flex;
justify-content: center;
align-items: center;
padding: 0.25rem 0;
.status {
min-width: 5rem;
font-size: 1.2rem;
font-weight: bold;
p {
margin: 0;
color: var(--info);
&.up { color: var(--success); }
&.down { color: var(--danger); }
&.new { color: var(--neutral); }
}
padding: 0.25rem 0;
.status {
min-width: 5rem;
font-size: 1.2rem;
font-weight: bold;
p {
margin: 0;
color: var(--info);
&.up { color: var(--success); }
&.down { color: var(--danger); }
&.new { color: var(--widget-text-color); }
&.running { color: var(--warning); }
&.paused { color: var(--info); }
}
.info {
p.cron-name {
margin: 0.25rem 0;
font-weight: bold;
color: var(--widget-text-color);
}
p.cron-desc {
margin: 0;
color: var(--widget-text-color);
opacity: var(--dimming-factor);
}
}
.info {
p.cron-name {
margin: 0.25rem 0;
font-weight: bold;
color: var(--widget-text-color);
}
&:not(:last-child) {
border-bottom: 1px dashed var(--widget-text-color);
p.cron-desc {
margin: 0;
color: var(--widget-text-color);
opacity: var(--dimming-factor);
}
}
&:not(:last-child) {
border-bottom: 1px dashed var(--widget-text-color);
}
}

</style>
Expand Down