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 également des informations sur l'intégration VCS connectée à GitGuardian et sur 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 d'une manière ou d'une autre inaccessible ou défaillant, cela sera indiqué comme tel.

Readiness
L'endpoint REST vérifie l'état de disponibilité de votre instance GitGuardian. L'URL de cet endpoint est affichée sur la page Health Check. L'endpoint est protégé, vous ne pouvez l'utiliser qu'avec une clé d'API (consultez la documentation sur l'authentification de l'API)
Il est facile d'utiliser l'endpoint, par exemple avec 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 vérifications de santé des intégrations (VCS, Messagerie, Ticketing, ...) sont accessibles via Settings > Workspace > Integrations, fournissant une vue d'ensemble du statut de l'intégration de la source et de toutes les erreurs rencontrées. 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 de l'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. Trouvez plus d'informations ici.
L'intervalle entre les vérifications de santé périodiques peut être personnalisé à l'aide de la préférence spread_periodic_range_minutes dans la section Health Checks des préférences de la zone d'administration.
Exemple d'échec

Exemple de succès

Public Monitoring
Si Public Monitoring est activé sur votre instance, deux vérifications de santé supplémentaires confirment l'intégration avec le service Public Monitoring hébergé par GitGuardian :
- Credentials : confirme que les identifiants de Public Monitoring sont définis.
- Connectivity : confirme que les identifiants sont valides et que le service hébergé est accessible.
Les identifiants sont configurés dans la zone d'administration ; consultez Configurer la connexion pour le flux de configuration. Utilisez ces vérifications pour confirmer que la fonctionnalité fonctionne après la configuration, et pour la diagnostiquer si les incidents de secrets publics cessent d'être récupérés. Si les deux vérifications réussissent mais qu'aucun incident de secret public n'est créé, assurez-vous que le worker Public Monitoring est en cours d'exécution ; consultez Redéployer l'application.