FileLogTraceListener Classe

Définition

public ref class FileLogTraceListener : System::Diagnostics::TraceListener

[System.Runtime.InteropServices.ComVisible(false)]
public class FileLogTraceListener : System.Diagnostics.TraceListener

[<System.Runtime.InteropServices.ComVisible(false)>]
type FileLogTraceListener = class
    inherit TraceListener

Public Class FileLogTraceListener
Inherits TraceListener

Héritage

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Attributs

ComVisibleAttribute

Remarques

La FileLogTraceListener classe fournit des fonctionnalités de maintenance automatisée pour archiver les fichiers journaux selon les besoins, chaque jour ou par application. Cette fonctionnalité d’archivage automatique permet de réduire les responsabilités de maintenance des développeurs et des administrateurs.

Une instance de FileLogTraceListener peut être ajoutée au ou Trace.Listeners aux regroupements pour rediriger la Debug.Listeners sortie de la journalisation vers un fichier texte. Les instances de cette classe peuvent également être ajoutées à My.Application.Log ou My.Log (pour les applications web) dans les applications Visual Basic. Pour plus d’informations, consultez Procédure pas à pas : modification des informations sur my.application.log écrit des informations.

Les principales fonctionnalités de cette classe sont les suivantes :

1. Fonctionnalités d’archivage. Les fichiers journaux générés par cette classe sont nommés en fonction du nom de base et de la date, ainsi qu’un nombre pour distinguer le fichier journal des versions successives du journal. Les nouveaux fichiers journaux sont créés en fonction des besoins.

   La forme explicite du nom de fichier est baseName[-dateStamp][-version].log, où :

   • La baseName partie est le nom du journal fondamental, spécifié par la BaseFileName propriété.
   • La dateStamp partie a le format « AAAA-MM-DD », et elle s’affiche quand LogFileCreationSchedule est Daily ou Weekly.
   • Si plusieurs fichiers journaux sont nécessaires avec le même baseName fichier et dateStamp, le version composant, un positif Integer, est ajouté au nom du fichier.

2. Plusieurs instances de classe. Si une instance de la FileLogTraceListener classe écrit dans un fichier en cours d’utilisation :

   • La classe partage le fichier s’il est utilisé par une autre instance de la FileLogTraceListener classe dans le même processus.
   • La classe crée un fichier journal à l’aide du nom disponible suivant si le fichier est utilisé par un autre processus.

3. Sécurité des threads. La FileLogTraceListener classe est thread safe. Cela vous permet d’écrire en toute sécurité des messages dans le journal à partir de plusieurs threads sans utiliser de verrous.

emplacementLog-File

• La Location propriété accepte une LogFileLocation énumération pour spécifier l’un des répertoires classiques dans utilisant le fichier journal.

• Pour écrire le journal dans un autre emplacement, définissez la CustomLocation propriété sur cet emplacement.

nom duLog-File

• Le nom de base du fichier journal est spécifié par la BaseFileName propriété.
• Le nom du fichier journal actuel peut être lu à partir de la FullLogFileName propriété. Elle est dérivée de plusieurs autres propriétés et de l’état actuel des journaux dans le système de fichiers.

Maintenance des journaux

• La fréquence minimale de création de fichiers journaux est déterminée par la LogFileCreationSchedule propriété. Lorsque la valeur est Daily ou Weekly, un nouveau fichier journal est créé au moins une fois par jour ou semaine, et un horodatage est incorporé dans le FullLogFileName nom.
• La taille maximale (en octets) du fichier journal est déterminée par la MaxFileSize propriété. Si la taille du fichier journal dépasse cette taille, des messages supplémentaires écrits dans le journal sont ignorés et, selon la DiskSpaceExhaustedBehavior propriété, une exception est levée.
• La ReserveDiskSpace propriété détermine la quantité d’espace libre (en octets) qui doit être disponible. Cela permet de s’assurer que la FileLogTraceListener classe ne consommera pas tout l’espace disque disponible. Utilisez la DiskSpaceExhaustedBehavior propriété pour spécifier le comportement des écritures de journal lorsqu’il y a moins d’octets ReserveDiskSpace libres.

paramètres de sortieLog-File

• La AutoFlush propriété spécifie si le flux sous-jacent doit être vidé automatiquement après chaque écriture dans le fichier journal.
• La Append propriété spécifie s’il faut ajouter des messages au fichier journal actuel, le cas échéant, ou les écrire dans un nouveau fichier journal.
• La Delimiter propriété spécifie la chaîne à utiliser pour limiter les champs dans un message de journal.
• La Encoding propriété spécifie l’encodage à utiliser lors de la création d’un fichier journal.

sortieLog-File

• Les TraceData méthodes et TraceEvent les méthodes écrivent des messages dans le fichier journal. Ces méthodes vérifient la LogFileCreationSchedule propriété, ainsi que les journaux existants portant le même nom de base pour déterminer si un nouveau journal doit être créé.
• La Flush méthode vide tous les messages actuellement dans la mémoire tampon de sortie dans le fichier journal.
• La Close méthode ferme le fichier journal afin qu’il puisse être utilisé par d’autres processus.

Activation de la sortie

Vous devez activer le suivi ou le débogage pour utiliser un écouteur de suivi. La syntaxe suivante est spécifique au compilateur. Si vous utilisez des compilateurs autres que C# ou Visual Basic, reportez-vous à la documentation de votre compilateur.

• Pour activer le débogage en C#, ajoutez l’indicateur /d:DEBUG à la ligne de commande du compilateur lorsque vous compilez votre code, ou vous pouvez ajouter #define DEBUG en haut de votre fichier. Dans Visual Basic, ajoutez l’indicateur /d:DEBUG=True à la ligne de commande du compilateur.
• Pour activer le suivi en C#, ajoutez l’indicateur /d:TRACE à la ligne de commande du compilateur lorsque vous compilez votre code ou ajoutez-y #define TRACE en haut de votre fichier. Dans Visual Basic, ajoutez l’indicateur /d:TRACE=True à la ligne de commande du compilateur.

Dans les applications .NET Framework, vous pouvez définir le niveau de votre écouteur en modifiant le fichier de configuration de votre application. Dans ce fichier, vous pouvez ajouter un écouteur, définir son type et définir ses paramètres, supprimer un écouteur ou effacer tous les écouteurs précédemment définis par l’application. Le fichier de configuration doit être mis en forme comme l’exemple suivant.

<configuration>
    <system.diagnostics>
        <sharedListeners>
            <add name="FileLog"
                type="Microsoft.VisualBasic.Logging.FileLogTraceListener,
                      Microsoft.VisualBasic, Version=8.0.0.0,
                      Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a,
                      processorArchitecture=MSIL"
                initializeData="FileLogWriter"/>
        </sharedListeners>
    </system.diagnostics>
</configuration>

Pour que cet exemple s’exécute, vous devez fournir le nom complet de l’assembly. Pour plus d’informations sur l’obtention du nom complet de l’assembly, consultez Noms d’assembly.

Voir aussi

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Procédure pas à pas : modification de l’emplacement où My.Application.Log écrit des informations