Santé de l'environnement

La page Health Check offre 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 les intégrations VCS connectées à GitGuardian ainsi que sur le 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 défaillant, cela sera indiqué.

Readiness

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

Il est facile d'utiliser le endpoint, par exemple avec curl (XXXX doit être remplacé par votre clé 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 un aperçu du statut de l'intégration 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 vé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 en cas d'échec d'une intégration. 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 l'admin area.

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 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 l'Admin area ; consultez Configurer la connexion pour la procédure de configuration. Utilisez ces vérifications pour vous assurer 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.