Vue d'ensemble de la journalisation dans MSBuild

Mise à jour : novembre 2007

Les journaux MSBuild offrent un moyen de personnaliser le rapport des événements, avertissements et erreurs de génération. Les journaux peuvent afficher des informations dans la fenêtre de console, écrire dans XML ou un fichier de texte, ou entrer des données de génération dans une base de données.

Journaux MSBuild

Un journal permet de relayer des informations provenant d'événements de génération, de messages, d'avertissements et d'erreurs dans un document facile à lire et à interpréter. La logique d'un journal est écrite dans un type managé qui implémente l'interface ILogger.

Journal de console par défaut de MSBuild

Lorsque vous exécutez MSBuild.exe à partir de la ligne de commande, MSBuild utilise le journal de console par défaut pour afficher les informations d'événement de génération dans la fenêtre de console. Vous pouvez personnaliser le niveau de détail que vous souhaitez que le journal rapporte à l'aide du commutateur /verbosity sur la ligne de commande.

Le journal de console par défaut accepte des paramètres supplémentaires pouvant modifier la sortie dans la fenêtre de console. Ces paramètres sont spécifiés avec le commutateur /consoleloggerparameters sur la ligne de commande.

Si vous utilisez un journal personnalisé, vous pouvez souhaiter masquer les informations affichées en provenance du journal de console par défaut. Utilisez le commutateur /noconsolelogger sur la ligne de commande pour désactiver le journal de console par défaut.

Journal fichier de MSBuild

MSBuild inclut également un journal fichier qui enregistre des informations d'événement de génération dans un fichier. Pour exécuter le journal fichier, utilisez le commutateur suivant dans la ligne de commande, où MyLog.log est le fichier dans lequel sont stockées les informations de journal.

/l:FileLogger,Microsoft.Build.Engine;logfile=MyLog.log

Au total, le journal fichier accepte également quatre paramètres. Il s'agit des valeurs suivantes :

  • Logfile : paramètre requis qui spécifie le fichier dans lequel stocker les informations de journal.

  • Append : paramètre boolean facultatif qui indique si le journal doit être ajouté ou non au fichier spécifié : true pour ajouter le journal au texte déjà présent dans le fichier ; false pour remplacer le contenu du fichier. La valeur par défaut est false.

  • Verbosity : paramètre optionnel qui substitue le paramètre de commentaires global pour ce journal fichier uniquement. Cela vous permet d'enregistrer des informations dans plusieurs journaux, chacun avec un niveau de commentaires différent.

  • Encoding : paramètre optionnel qui spécifie le codage pour le fichier, par exemple, UTF-8.

Les différents paramètres sont séparés par des points-virgules (;). Par exemple, la ligne de commande suivante enregistre les informations d'événement de génération dans le fichier MyLog.log et ajoute le journal au texte dans le fichier, avec le niveau de commentaires diagnostic et le codage UTF-8.

MSBuild MyProj.proj /l:FileLogger,Microsoft.Build.Engine;logfile=MyLog.log append=true;verbosity=diagnostic;encoding=utf-8

Spécification d'un journal.

Si vous souhaitez utiliser un journal autre que le journal de console par défaut pendant une génération, spécifiez le journal personnalisé à l'aide du commutateur /logger dans la ligne de commande. Pour plus d'informations sur les commutateurs de ligne de commande de MSBuild, consultez Référence de la ligne de commande MSBuild.

Écriture d'un journal

La logique d'un journal est écrite en code managé et spécifiée dans la ligne de commande MSBuild à l'aide du commutateur /logger.

Vous pouvez écrire votre propre journal en créant un type managé qui implémente l'interface ILogger. Pour plus d'informations, consultez Comment : écrire un journal.

Voir aussi

Tâches

Comment : écrire un journal

Concepts

Journalisation dans un environnement multiprocesseur

Création de journaux de transfert

Autres ressources

Concepts MSBuild