docs: expand reference pages and fix children shortcode rendering
Enable Goldmark block-level attributes so the relearn `children` shortcode applies its CSS classes instead of printing them literally in the table-of-contents pages. Also expand the deploy, plugins, records, and email reference docs and add the checks pages.
This commit is contained in:
parent
f50dcc8ba9
commit
6b6a8c847f
13 changed files with 1457 additions and 501 deletions
174
content/pages/checks.en.md
Normal file
174
content/pages/checks.en.md
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
---
|
||||
date: 2026-04-05T12:00:00+02:00
|
||||
title: Monitoring & Checks
|
||||
author: nemunaire
|
||||
weight: 35
|
||||
description: "Set up automated health checks to monitor your domains and services"
|
||||
---
|
||||
|
||||
happyDomain includes a built-in monitoring system that lets you run automated health checks on your domains and services. Checkers periodically collect data (such as ping response times, domain expiry dates, or DNS audit results), evaluate it against thresholds you define, and report a clear status: OK, Warning, Critical, or Error.
|
||||
|
||||
## Browsing available checkers
|
||||
|
||||
You can see all available checkers by navigating to the **Checkers** page from the main menu.
|
||||
|
||||
<!-- TODO: screenshot of the checkers list page -->
|
||||
|
||||
Each checker is labelled with the scope it applies to:
|
||||
|
||||
- **Domain-level**: checks that concern the domain itself, independent of DNS records (e.g. domain expiry via WHOIS).
|
||||
- **Zone-level**: checks that need the full zone content (e.g. DNSSEC validation).
|
||||
- **Service-level**: checks that target a specific service on a subdomain (e.g. ping, HTTP check).
|
||||
|
||||
Use the search bar to filter checkers by name. Click on a checker to see its description and configuration options.
|
||||
|
||||
|
||||
## Configuring a checker for your domain
|
||||
|
||||
To set up a checker on one of your domains:
|
||||
|
||||
1. Go to your domain's page and open the **Checks** tab.
|
||||
2. You will see a table of checkers available for this domain. Click **Configure** next to the checker you want to set up.
|
||||
|
||||
<!-- TODO: screenshot of the domain checks list -->
|
||||
|
||||
On the configuration page, you will find several sections:
|
||||
|
||||
### Checker options
|
||||
|
||||
Options are grouped by category:
|
||||
|
||||
- **Admin Options** -- system-wide settings controlled by the administrator (read-only for regular users).
|
||||
- **Configuration** -- user-level preferences such as warning and critical thresholds. These are the main settings you will adjust.
|
||||
- **Domain-specific Settings** -- values automatically filled in based on the domain being checked (e.g. the domain name itself).
|
||||
- **Checker Parameters** -- additional runtime parameters.
|
||||
|
||||
Fill in or adjust the options to match your needs, then click **Save**.
|
||||
|
||||
<!-- TODO: screenshot of the checker configuration page with options -->
|
||||
|
||||
### Rules
|
||||
|
||||
Each checker comes with one or more **rules** that evaluate different aspects of the collected data. For example, a ping checker might have separate rules for latency and packet loss.
|
||||
|
||||
You can enable or disable individual rules using the toggle switches. Each rule may also have its own specific options that you can configure.
|
||||
|
||||
<!-- TODO: screenshot of the rules section with toggles -->
|
||||
|
||||
|
||||
## Scheduling automatic checks
|
||||
|
||||
Once a checker is configured, you can schedule it to run automatically at a regular interval.
|
||||
|
||||
In the **Schedule** section of the checker configuration page:
|
||||
|
||||
1. Toggle **Run automatically** to enable scheduling.
|
||||
2. Set the **Check interval** (in hours) -- this determines how often the check runs.
|
||||
3. The **Next scheduled run** time is displayed so you know when the next execution will happen.
|
||||
4. Click **Save** to apply the schedule.
|
||||
|
||||
<!-- TODO: screenshot of the schedule card -->
|
||||
|
||||
{{% notice style="info" title="Interval limits" icon="clock" %}}
|
||||
Each checker defines minimum and maximum intervals to prevent overloading external services. The interface will respect these bounds when you configure the schedule.
|
||||
{{% /notice %}}
|
||||
|
||||
When scheduling is disabled, the checker can still be run manually at any time.
|
||||
|
||||
|
||||
## Running a check manually
|
||||
|
||||
You can trigger a check at any time without waiting for the schedule:
|
||||
|
||||
1. Navigate to the checker's **Executions** page (from the domain checks list, click **View Results**).
|
||||
2. Click **Run Check Now**.
|
||||
3. A dialog opens where you can:
|
||||
- Select which rules to run for this execution.
|
||||
- Override options temporarily (these overrides are not saved).
|
||||
4. Click **Run Check** to start the execution.
|
||||
|
||||
<!-- TODO: screenshot of the Run Check modal -->
|
||||
|
||||
A confirmation message will appear with the execution ID. The result will show up in the executions list once the check completes.
|
||||
|
||||
|
||||
## Viewing check results
|
||||
|
||||
All past executions are listed on the checker's **Executions** page, accessible from your domain's Checks tab by clicking **View Results**.
|
||||
|
||||
<!-- TODO: screenshot of the executions list -->
|
||||
|
||||
The executions table shows:
|
||||
|
||||
| Column | Description |
|
||||
|--------|-------------|
|
||||
| **Executed at** | When the check ran |
|
||||
| **Status** | The result: OK, Warning, Critical, Error, or Unknown |
|
||||
| **Message** | A summary of the findings |
|
||||
| **Duration** | How long the check took to complete |
|
||||
| **Type** | Whether it was a scheduled or manual run |
|
||||
|
||||
Click **View** on any execution to see its detailed results.
|
||||
|
||||
|
||||
## Understanding execution details
|
||||
|
||||
The execution detail page presents the results in the most appropriate format depending on what the checker provides.
|
||||
|
||||
### Metrics
|
||||
|
||||
When a checker produces metrics (e.g. response time, packet loss percentage), the detail page shows:
|
||||
|
||||
- A **line chart** plotting the metric values over time across recent executions.
|
||||
- A **data table** listing each metric with its name, value, and unit.
|
||||
|
||||
<!-- TODO: screenshot of the metrics chart and table -->
|
||||
|
||||
### HTML reports
|
||||
|
||||
Some checkers generate rich HTML reports (e.g. detailed DNS audit results). These are rendered directly in the page.
|
||||
|
||||
### Raw data
|
||||
|
||||
You can always switch to the **Raw JSON** view to inspect the full observation data collected during the execution. Use the view toggle at the top of the report section to switch between Metrics, HTML Report, and Raw JSON.
|
||||
|
||||
### Rule evaluations
|
||||
|
||||
Each rule that ran during the execution reports its own status and message. You can see the per-rule breakdown to understand which specific aspect triggered a warning or critical status.
|
||||
|
||||
<!-- TODO: screenshot of rule evaluation results -->
|
||||
|
||||
|
||||
## Service-level checks
|
||||
|
||||
Checkers that apply at the service level are configured from the service's own page rather than the domain-level Checks tab.
|
||||
|
||||
1. Navigate to your domain, then to the specific subdomain and service.
|
||||
2. Open the **Checks** tab for that service.
|
||||
3. The workflow is the same as for domain-level checkers: configure options, set up scheduling, run checks, and view results.
|
||||
|
||||
Service-level checkers automatically receive information about the service they are attached to (such as IP addresses from a Server service), so they require less manual configuration.
|
||||
|
||||
|
||||
## Managing check results
|
||||
|
||||
From the executions list, you can:
|
||||
|
||||
- **Delete a single result** by clicking the delete action on a specific execution.
|
||||
- **Delete all results** for a checker using the bulk delete option (a confirmation dialog will appear).
|
||||
|
||||
This can be useful to clean up old data or reset after configuration changes.
|
||||
|
||||
|
||||
## Status reference
|
||||
|
||||
Checkers report one of the following statuses, in order of severity:
|
||||
|
||||
| Status | Meaning |
|
||||
|--------|---------|
|
||||
| **OK** | Everything is within acceptable parameters |
|
||||
| **Info** | Informational finding, no action needed |
|
||||
| **Warning** | A threshold is approaching; attention recommended |
|
||||
| **Critical** | A threshold has been exceeded; action required |
|
||||
| **Error** | The check itself failed (collection error, bad configuration) |
|
||||
| **Unknown** | The check could not determine a result |
|
||||
174
content/pages/checks.fr.md
Normal file
174
content/pages/checks.fr.md
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
---
|
||||
date: 2026-04-05T12:00:00+02:00
|
||||
title: Surveillance & Vérifications
|
||||
author: nemunaire
|
||||
weight: 35
|
||||
description: "Mettez en place des vérifications automatiques pour surveiller vos domaines et vos services"
|
||||
---
|
||||
|
||||
happyDomain intègre un système de surveillance qui permet de lancer des vérifications automatiques sur vos domaines et vos services. Les vérificateurs collectent périodiquement des données (temps de réponse au ping, date d'expiration d'un domaine ou résultats d'audit DNS, par exemple), les évaluent au regard des seuils que vous définissez et rapportent un statut clair : OK, Avertissement, Critique ou Erreur.
|
||||
|
||||
## Parcourir les vérificateurs disponibles
|
||||
|
||||
Vous pouvez consulter l'ensemble des vérificateurs disponibles depuis la page **Vérifications**, accessible par le menu principal.
|
||||
|
||||
<!-- TODO: screenshot of the checkers list page -->
|
||||
|
||||
Chaque vérificateur indique la portée à laquelle il s'applique :
|
||||
|
||||
- **Niveau domaine** : vérifications qui concernent le domaine lui-même, indépendamment des enregistrements DNS (par exemple l'expiration du domaine via WHOIS).
|
||||
- **Niveau zone** : vérifications qui nécessitent le contenu complet de la zone (par exemple la validation DNSSEC).
|
||||
- **Niveau service** : vérifications qui ciblent un service précis sur un sous-domaine (par exemple un ping ou une vérification HTTP).
|
||||
|
||||
Utilisez la barre de recherche pour filtrer les vérificateurs par nom. Cliquez sur un vérificateur pour afficher sa description et ses options de configuration.
|
||||
|
||||
|
||||
## Configurer un vérificateur pour votre domaine
|
||||
|
||||
Pour mettre en place un vérificateur sur l'un de vos domaines :
|
||||
|
||||
1. Rendez-vous sur la page de votre domaine et ouvrez l'onglet **Vérifications**.
|
||||
2. Un tableau présente les vérificateurs disponibles pour ce domaine. Cliquez sur **Configurer** en regard du vérificateur souhaité.
|
||||
|
||||
<!-- TODO: screenshot of the domain checks list -->
|
||||
|
||||
La page de configuration regroupe plusieurs sections :
|
||||
|
||||
### Options du vérificateur
|
||||
|
||||
Les options sont réparties par catégorie :
|
||||
|
||||
- **Options d'administration** : paramètres globaux contrôlés par l'administrateur (en lecture seule pour les utilisateurs ordinaires).
|
||||
- **Configuration** : préférences au niveau de l'utilisateur, comme les seuils d'avertissement et critique. Ce sont les principaux réglages que vous ajusterez.
|
||||
- **Paramètres propres au domaine** : valeurs renseignées automatiquement à partir du domaine vérifié (par exemple le nom de domaine lui-même).
|
||||
- **Paramètres du vérificateur** : paramètres d'exécution supplémentaires.
|
||||
|
||||
Renseignez ou ajustez les options selon vos besoins, puis cliquez sur **Enregistrer**.
|
||||
|
||||
<!-- TODO: screenshot of the checker configuration page with options -->
|
||||
|
||||
### Règles
|
||||
|
||||
Chaque vérificateur s'accompagne d'une ou plusieurs **règles** qui évaluent différents aspects des données collectées. Un vérificateur de ping peut par exemple comporter des règles distinctes pour la latence et la perte de paquets.
|
||||
|
||||
Vous pouvez activer ou désactiver chaque règle à l'aide des interrupteurs. Chaque règle peut également disposer de ses propres options à configurer.
|
||||
|
||||
<!-- TODO: screenshot of the rules section with toggles -->
|
||||
|
||||
|
||||
## Planifier des vérifications automatiques
|
||||
|
||||
Une fois un vérificateur configuré, vous pouvez planifier son exécution automatique à intervalle régulier.
|
||||
|
||||
Dans la section **Planification** de la page de configuration du vérificateur :
|
||||
|
||||
1. Activez **Exécuter automatiquement** pour mettre en place la planification.
|
||||
2. Définissez l'**intervalle de vérification** (en heures) : il détermine la fréquence d'exécution.
|
||||
3. L'heure de la **prochaine exécution planifiée** est affichée afin que vous sachiez quand aura lieu la prochaine vérification.
|
||||
4. Cliquez sur **Enregistrer** pour appliquer la planification.
|
||||
|
||||
<!-- TODO: screenshot of the schedule card -->
|
||||
|
||||
{{% notice style="info" title="Limites d'intervalle" icon="clock" %}}
|
||||
Chaque vérificateur définit un intervalle minimal et maximal afin d'éviter de surcharger les services externes. L'interface respecte ces bornes lorsque vous configurez la planification.
|
||||
{{% /notice %}}
|
||||
|
||||
Lorsque la planification est désactivée, le vérificateur peut tout de même être lancé manuellement à tout moment.
|
||||
|
||||
|
||||
## Lancer une vérification manuellement
|
||||
|
||||
Vous pouvez déclencher une vérification à tout moment, sans attendre la planification :
|
||||
|
||||
1. Rendez-vous sur la page **Exécutions** du vérificateur (depuis la liste des vérifications du domaine, cliquez sur **Voir les résultats**).
|
||||
2. Cliquez sur **Lancer la vérification**.
|
||||
3. Une fenêtre s'ouvre, dans laquelle vous pouvez :
|
||||
- Sélectionner les règles à exécuter pour cette exécution.
|
||||
- Remplacer temporairement certaines options (ces remplacements ne sont pas enregistrés).
|
||||
4. Cliquez sur **Lancer la vérification** pour démarrer l'exécution.
|
||||
|
||||
<!-- TODO: screenshot of the Run Check modal -->
|
||||
|
||||
Un message de confirmation apparaît avec l'identifiant de l'exécution. Le résultat s'affiche dans la liste des exécutions une fois la vérification terminée.
|
||||
|
||||
|
||||
## Consulter les résultats des vérifications
|
||||
|
||||
Toutes les exécutions passées sont répertoriées sur la page **Exécutions** du vérificateur, accessible depuis l'onglet Vérifications de votre domaine en cliquant sur **Voir les résultats**.
|
||||
|
||||
<!-- TODO: screenshot of the executions list -->
|
||||
|
||||
Le tableau des exécutions présente :
|
||||
|
||||
| Colonne | Description |
|
||||
|--------|-------------|
|
||||
| **Exécutée le** | Date à laquelle la vérification a été lancée |
|
||||
| **Statut** | Le résultat : OK, Avertissement, Critique, Erreur ou Inconnu |
|
||||
| **Message** | Un résumé des constats |
|
||||
| **Durée** | Le temps qu'a pris la vérification |
|
||||
| **Type** | S'il s'agit d'une exécution planifiée ou manuelle |
|
||||
|
||||
Cliquez sur **Voir** sur une exécution pour en afficher les résultats détaillés.
|
||||
|
||||
|
||||
## Comprendre le détail d'une exécution
|
||||
|
||||
La page de détail d'une exécution présente les résultats sous la forme la plus adaptée à ce que fournit le vérificateur.
|
||||
|
||||
### Métriques
|
||||
|
||||
Lorsqu'un vérificateur produit des métriques (temps de réponse, pourcentage de perte de paquets, etc.), la page de détail affiche :
|
||||
|
||||
- Un **graphique en courbes** qui trace l'évolution des valeurs de la métrique au fil des exécutions récentes.
|
||||
- Un **tableau de données** qui répertorie chaque métrique avec son nom, sa valeur et son unité.
|
||||
|
||||
<!-- TODO: screenshot of the metrics chart and table -->
|
||||
|
||||
### Rapports HTML
|
||||
|
||||
Certains vérificateurs génèrent des rapports HTML détaillés (par exemple les résultats d'un audit DNS). Ces rapports sont affichés directement dans la page.
|
||||
|
||||
### Données brutes
|
||||
|
||||
Vous pouvez à tout moment basculer vers la vue **JSON brut** pour examiner l'ensemble des données d'observation collectées durant l'exécution. Utilisez le sélecteur de vue en haut de la section du rapport pour passer de Métriques à Rapport HTML et JSON brut.
|
||||
|
||||
### Évaluation des règles
|
||||
|
||||
Chaque règle exécutée durant l'exécution rapporte son propre statut et son propre message. Le détail règle par règle permet de comprendre quel aspect précis a déclenché un statut d'avertissement ou critique.
|
||||
|
||||
<!-- TODO: screenshot of rule evaluation results -->
|
||||
|
||||
|
||||
## Vérifications au niveau service
|
||||
|
||||
Les vérificateurs qui s'appliquent au niveau service se configurent depuis la page du service concerné, et non depuis l'onglet Vérifications du domaine.
|
||||
|
||||
1. Rendez-vous sur votre domaine, puis sur le sous-domaine et le service concernés.
|
||||
2. Ouvrez l'onglet **Vérifications** de ce service.
|
||||
3. Le déroulement est identique à celui des vérificateurs de niveau domaine : configurer les options, mettre en place la planification, lancer des vérifications et consulter les résultats.
|
||||
|
||||
Les vérificateurs de niveau service reçoivent automatiquement les informations relatives au service auquel ils sont rattachés (comme les adresses IP d'un service Serveur), ce qui réduit la configuration manuelle.
|
||||
|
||||
|
||||
## Gérer les résultats des vérifications
|
||||
|
||||
Depuis la liste des exécutions, vous pouvez :
|
||||
|
||||
- **Supprimer un résultat** en cliquant sur l'action de suppression d'une exécution précise.
|
||||
- **Supprimer tous les résultats** d'un vérificateur grâce à l'option de suppression groupée (une fenêtre de confirmation apparaît).
|
||||
|
||||
Cela peut être utile pour faire le ménage dans les anciennes données ou repartir de zéro après des changements de configuration.
|
||||
|
||||
|
||||
## Référence des statuts
|
||||
|
||||
Les vérificateurs rapportent l'un des statuts suivants, par ordre de gravité :
|
||||
|
||||
| Statut | Signification |
|
||||
|--------|---------|
|
||||
| **OK** | Tout se situe dans les paramètres acceptables |
|
||||
| **Information** | Constat informatif, aucune action nécessaire |
|
||||
| **Avertissement** | Un seuil est sur le point d'être atteint ; une attention est recommandée |
|
||||
| **Critique** | Un seuil a été dépassé ; une action est requise |
|
||||
| **Erreur** | La vérification elle-même a échoué (erreur de collecte, mauvaise configuration) |
|
||||
| **Inconnu** | La vérification n'a pas pu déterminer de résultat |
|
||||
Loading…
Add table
Add a link
Reference in a new issue