Logs et débogage
Consulter les logs dans les pods
Pour une manière plus interactive et conviviale de parcourir les pods Kubernetes et de consulter les logs, pensez à utiliser k9s. Cet outil offre un moyen efficace et visuel de gérer les applications Kubernetes directement depuis la ligne de commande, améliorant l'expérience de consultation des logs et de gestion des ressources.
Pour consulter les logs d'un pod, utilisez la commande kubectl logs. Remplacez [POD_NAME] par le nom spécifique de votre pod :
kubectl logs [POD_NAME] -n [NAMESPACE]
Si vous n'êtes pas sûr du nom du pod, listez d'abord tous les pods avec :
kubectl get pods -n [NAMESPACE]
Pod de débogage
Veuillez noter que pour pouvoir exécuter la commande de débogage, votre version de kubectl doit être >= 1.27.
Pour lancer une session de débogage pour un pod existant, exécutez la commande kubectl debug comme indiqué ci-dessous, en utilisant le pod internal-api comme exemple (remplacez [NAMESPACE] par le bon et trouvez les noms des autres pods sur la page Topologie de l'application) :
kubectl debug \
--namespace=[NAMESPACE] \
--profile=restricted \
--share-processes \
--container=app \
--copy-to=webapp-debug \
--image=$(kubectl --namespace=[NAMESPACE] get pods -l app.kubernetes.io/component=internal-api -o jsonpath='{.items[0].spec.containers[0].image}')-debug \
$(kubectl --namespace=[NAMESPACE] get pods -l app.kubernetes.io/component=internal-api -o jsonpath='{.items[0].metadata.name}')
Où :
--profile=restricted: Monte tous les volumes, config maps et secrets du pod d'origine avec des capacités limitées.--container: Spécifie le conteneur de débogage.--copy-to: Nomme le nouveau pod de débogage.--image: Définit l'image de débogage, en modifiant le tag de l'image d'origine avec un suffixe--debug.
À l'exécution, un pod de débogage nommé webapp-debug sera créé dans votre namespace désigné, contenant un unique conteneur app exécutant l'image de débogage :
Pour interagir avec le conteneur de débogage, utilisez kubectl exec :
kubectl exec -it webapp-debug -- bash
Pour les diagnostics, vous pouvez exécuter :
kubectl exec -it webapp-debug -- python manage.py diagnose_instance
Une fois vos tâches de débogage terminées, supprimez le pod de débogage avec cette commande :
kubectl delete pod webapp-debug
Collecteur de logs
Les déploiements GitGuardian Self-Hosted disposent désormais d'un collecteur de logs intégré, conçu pour simplifier le dépannage et le support. Ce système s'appuie sur Loki, MinIO et Fluent Bit pour collecter, stocker et centraliser automatiquement les logs de votre application GitGuardian. La collecte des logs est activée par défaut pour tous les types d'installation (Helm ou KOTS), garantissant que tous les logs pertinents sont facilement disponibles pour les diagnostics sans configuration manuelle. Par défaut, nous conservons 3 jours de logs.

Installation basée sur Helm
Dans le fichier values.yaml, définissez le paramètre logCollector.enabled sur false pour désactiver le collecteur de logs.
Par défaut, lors de la génération du Support Bundle, nous récupérons 3 jours de logs d'application. Cette durée est configurable via le paramètre Helm : logCollector.supportBundle.since en utilisant ce format : <0-9>+<h|d>, et ne doit pas dépasser 7 jours.
Configuration de Loki
Vous devrez peut-être configurer les limites de ressources de Loki et les labels des pods pour respecter les politiques de votre organisation :
Limites de ressources :
loki:
singlyBinary:
resources:
limits:
# Specify CPU limits for Loki
cpu: 1000m
# Specify Memory limits for Loki
memory: 1024Mi
requests:
cpu: 500m
memory: 512Mi
Labels des pods :
loki:
podLabels:
env: production
team: infrastructure
Pipelines supplémentaires
Le LogCollector peut être étendu avec des pipelines personnalisés pour transférer les logs d'application vers des systèmes externes d'agrégation de logs. Cela vous permet d'intégrer les logs de GitGuardian à votre infrastructure d'observabilité existante.
Sorties prises en charge :
Le LogCollector s'appuie sur le vaste écosystème de plugins de sortie de Fluent Bit, permettant l'intégration avec des plateformes populaires de gestion de logs, notamment :
- Splunk - Gestion et analyse de logs pour entreprises
- Loki - Système d'agrégation de logs de Grafana
- Elasticsearch - Moteur de recherche et d'analyse
- Kafka - Plateforme de streaming distribuée
- Datadog - Services de surveillance basés sur le cloud
Pour la liste complète des sorties disponibles et leurs options de configuration, reportez-vous à la documentation des sorties de Fluent Bit.
Configuration :
Les pipelines supplémentaires sont configurés via la section logCollector.pipelines de votre fichier de values. Chaque pipeline peut inclure :
- Filtres - Transforment, enrichissent ou modifient les enregistrements de logs avant la sortie
- Sorties - Définissent les systèmes de destination et les paramètres de connexion
Exemple : intégration Splunk
La configuration suivante montre comment envoyer des logs vers un endpoint Splunk HTTP Event Collector (HEC) :
logCollector:
envFrom:
- secretRef:
# Secret containing token (SPLUNK_TOKEN)
name: splunk
pipelines:
splunk:
filters:
- |
name modify
add index my-splunk-index
outputs:
- |
name splunk
host <HOST>
port 8088
splunk_token ${SPLUNK_TOKEN}
tls on
tls.verify off
Installation basée sur KOTS
Dans la KOTS Admin Console, désactivez le collecteur de logs.

Embedded cluster
Dans un embedded cluster, vous avez besoin d'une étape supplémentaire pour pouvoir exécuter les commandes kubectl.
sudo ./gitguardian shell
Vous pouvez maintenant opérer le cluster.
Tâches des workers
Pour surveiller l'activité des tâches, le nombre de workers et l'utilisation, consultez la page des tâches dans l'espace d'administration.