Santé de l'environnement

La page Health Check fournit une vue d'ensemble de toute votre instance GitGuardian Self-Hosted. Sur cette page, vous pouvez accéder au statut des services utilisés par GitGuardian. La page vous fournit aussi des informations sur l'intégration VCS connectée à GitGuardian et l'endpoint REST de Readiness.

Services GitGuardian

Cette section vous montre le statut des services utilisés par votre instance GitGuardian pour fonctionner. Si l'un de ces services est inaccessible ou cassé, cela sera indiqué comme tel.

Readiness

L'endpoint REST vérifie le readiness de votre instance GitGuardian. L'URL de cet endpoint est affichée sur la page Health Check. L'endpoint est protégé, vous pouvez l'utiliser uniquement avec une clé d'API (consultez la documentation d'authentification API)

Il est facile d'utiliser l'endpoint, par exemple via curl (XXXX doit être remplacé par votre clé d'API) :

curl -H "Authorization: Token XXXX" https://gitguardian.example.com/exposed/v1/readiness

Exemple de réponse :

{
    "db": "ok",
    "redis": "ok",
    "status": "ok"
}

Connectivité des intégrations

Les health checks d'intégration (VCS, Messaging, Ticketing, …) sont accessibles via Settings > Workspace > Integrations, fournissant une vue d'ensemble du statut des intégrations sources et de toute erreur rencontrée. En cas d'échec d'une intégration, des informations détaillées sur la résolution du problème seront affichées. De plus, il existe une option pour revérifier manuellement la connexion d'intégration, ainsi que des horodatages indiquant la dernière exécution et la connexion réussie la plus récente.

Vous pouvez configurer votre compte pour recevoir des alertes par e-mail lorsqu'une intégration échoue. Plus d'informations ici.

L'intervalle entre les health checks périodiques peut être personnalisé via la préférence spread_periodic_range_minutes dans la section Health Checks des préférences de l'admin area.

Exemple d'échec

Exemple de succès