pgBadger 13.2 Documentation on PIG.CENTER

Téléchargement et installation

Mon, 01 Jan 0001 00:00:00 +0000

Choisissez un canal de distribution

Channel	Utilisation	Emplacement
Version officielle	Archives sources et notes de version	GitHub Releases
Paquet RPM	Distributions Linux basées sur RPM	PostgreSQL Yum Repository
Paquet Debian/Ubuntu	Distributions Linux basées sur APT	PostgreSQL Apt Repository
Code source de développement	Code actuel non encore publié	darold/pgbadger

La version de documentation disponible sur ce site est basée sur l’arbre source 13.2. Vérifiez toujours la page de publication avant de télécharger : la version locale est intentionnellement figée, tandis que les versions upstream évoluent continuellement.

Référence en ligne de commande

Mon, 01 Jan 0001 00:00:00 +0000

Cette page conserve la référence de commande générée à partir de la source upstream verrouillée. Les noms d’option et le texte d’aide restent tels quels afin de pouvoir être comparés directement avec pgbadger --help.

Utilisation et options

Utilisation : pgBadger [options] fichier_journal […]

PostgreSQL log analyzer with fully detailed reports and graphs.

Arguments :

logfile can be a single log file, a list of files, or a shell command
returning a list of files. If you want to pass log content from stdin
use - as filename. Note that input from stdin will not work with csvlog.

Options :

Configuration de journalisation de PostgreSQL

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger ne peut rapporter que les informations écrites par PostgreSQL dans les journaux. Commencez par un préfixe analysable et une politique de journalisation explicite des requêtes, puis ajoutez les événements opérationnels que vous souhaitez analyser.

Journalisation minimale des requêtes

Pour inclure le texte et la durée de la requête, activez la journalisation des instructions basée sur la durée :

log_min_duration_statement = 0

0 enregistre chaque instruction terminée. Sur un serveur très sollicité, sélectionnez une valeur plus élevée en millisecondes afin de contrôler le volume des journaux. Mesurez la surcharge et la croissance du stockage avant d’activer une seuil faible en production.

Traitement parallèle

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger dispose de deux modes de traitement parallèle complémentaires. Choisissez selon la forme de l’entrée, et non simplement selon le nombre de processeurs.

Option	Unité parallèle	Meilleur ajustement	Contrainte principale
`-j N` / `--jobs N`	tronçons d’un fichier journal	un seul fichier journal volumineux et accessible par recherche	les limites des tronçons peuvent dupliquer ou omettre un petit nombre de requêtes
`-J N` / `--Jobs N`	fichiers journaux entiers	plusieurs fichiers journaux indépendants	utile uniquement lorsque suffisamment de fichiers sont disponibles pour garder les workers occupés

Découper un grand fichier avec `-j`

$ pgbadger -j 8 /var/log/postgresql/postgresql.log

L’algorithme upstream divise chaque fichier en plages de N octets, lance un parseur par plage, écrit des statistiques binaires temporaires, puis fusionne ces statistiques pour produire le rapport final.

Rapports incrémentiels

Mon, 01 Jan 0001 00:00:00 +0000

Le mode incrémentiel stocke les statistiques analysées sous forme binaire, puis génère un rapport HTML par jour, un rapport cumulatif par semaine et un index au format calendrier reliant ces rapports. Il est destiné à un traitement répété des journaux tournés sans compter deux fois les mêmes entrées.

Générer des rapports quotidiens et hebdomadaires

Exécutez pgBadger après la rotation quotidienne des journaux et spécifiez un répertoire de sortie persistant :

Formats de sortie

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger sélectionne la sortie en fonction de l’extension du nom de fichier ou de -x / --extension. Utilisez -o / --outfile plus d’une fois pour générer plusieurs formats à partir du même analyse.

Format	Extension typique	Meilleur usage
HTML	`.html`	rapport interactif, lisible par l’humain avec graphiques
Texte	`.txt`	consultation en terminal et sortie archivée brute
Binaire	`.bin`	statistiques intermédiaires fusionnables et reconstructions de rapport
JSON	`.json`	intégration avec d’autres logiciels ; nécessite `JSON::XS`
CSV brut	fichier de sortie choisi	extraction orientée ligne avec `--dump-raw-csv`

HTML et texte

La sortie par défaut est out.html :

Rapports d'exemple

Mon, 01 Jan 0001 00:00:00 +0000

Le contenu d’exemple a été généré par pgBadger 11.8 en mai 2022. Les exemples originaux sont stockés avec ce site, de sorte que la navigation dans le rapport, les graphiques, les styles et les scripts restent disponibles sans avoir à interroger le serveur d’origine.

Exemple	Ce qu’il illustre	Copie locale
Rapport complet	Activité PostgreSQL ainsi que les statistiques de PgBouncer	Ouvrir le rapport complet
Rapport incrémentiel	Index calendrier, agrégation hebdomadaire et pages quotidiennes	Ouvrir l’index incrémentiel
Erreurs et événements	Un rapport limité aux erreurs et aux événements opérationnels	Ouvrir le rapport d’erreurs

Rapport complet

Le rapport complet est un document HTML autonome. Utilisez la navigation en haut pour examiner les statistiques globales, les requêtes, les sessions, les connexions, les fichiers temporaires, les points de contrôle, l’activité d’autovacuum, les verrous et les graphiques spécifiques à PgBouncer.

Prise en charge et contribution

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger est maintenu dans le cadre d’un projet open source. Les rapports de bogues, les propositions de fonctionnalités, les corrections de documentation et les correctifs sont gérés via le dépôt GitHub principal.

Signalements de bogues et demandes de fonctionnalités

Passez à la dernière version publiée et vérifiez que le comportement persiste.
Recherchez dans les problèmes ouverts et les problèmes fermés une réponse existante.
Réduisez le problème à l’échantillon de journal le plus petit possible, qui reproduit encore le comportement.
Supprimez les identifiants, les requêtes SQL sensibles, les valeurs liées, les noms d’hôtes, les adresses et les données métier.
Ouvrez un nouveau problème avec la version de pgBadger, le système d’exploitation, le format d’entrée, les options exactes, le résultat observé et le résultat attendu.

En cas de plantage ou d’erreur de parsing, inclure uniquement les lignes de journalisation minimales et nettoyées nécessaires à la reproduction de la limite. Un journal de production complet ou un rapport généré est rarement adapté à une issue publique.

Licence et crédits

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger est un logiciel libre et open source distribué sous la licence PostgreSQL. Il peut être utilisé, copié, modifié et redistribué sans frais, sous réserve du maintien des mentions de copyright et de licence.

Licence PostgreSQL

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

pgBadger 13.2 Documentation on PIG.CENTER

Téléchargement et installation

Choisissez un canal de distribution

Référence en ligne de commande

Utilisation et options

Configuration de journalisation de PostgreSQL

Journalisation minimale des requêtes

Traitement parallèle

Découper un grand fichier avec -j

Rapports incrémentiels

Générer des rapports quotidiens et hebdomadaires

Formats de sortie

HTML et texte

Rapports d'exemple

Rapport complet

Prise en charge et contribution

Signalements de bogues et demandes de fonctionnalités

Licence et crédits

Licence PostgreSQL

Découper un grand fichier avec `-j`