FileLogTraceListener Classe

Référence

Définition

Espace de noms:: Microsoft.VisualBasic.Logging

Assembly:: Microsoft.VisualBasic.dll

Assembly:: Microsoft.VisualBasic.Forms.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Fournit un écouteur simple qui dirige la sortie d'enregistrement vers un fichier.

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 en fonction des besoins, tous les jours 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 aux collections ou Trace.Listeners pour rediriger la sortie de la Debug.Listeners 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 Walkthrough: Changing Where My.Application.Log Writes Information.

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

Fonctionnalité 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 permettant de 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 de journal fondamental, spécifié par la BaseFileName propriété .
- Le dateStamp composant a le format « AAAA-MM-JJ » et s’affiche quand LogFileCreationSchedule est Daily ou Weekly.
- Si plusieurs fichiers journaux sont nécessaires avec le même baseName et , la version partie, un positifInteger, est ajoutée au dateStampnom de fichier.
Plusieurs instances de classe. Si un instance de la FileLogTraceListener classe écrit dans un fichier en cours d’utilisation :
- La classe partage le fichier s’il est utilisé par un autre instance de la FileLogTraceListener classe dans le même processus.
- La classe crée un fichier journal à l’aide du nom suivant disponible si le fichier est utilisé par un autre processus.
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.

Emplacement du fichier journal

La Location propriété prend une LogFileLocation énumération pour spécifier l’un des répertoires classiques dans lequel écrire le fichier journal.
Pour écrire le journal dans un autre emplacement, définissez la CustomLocation propriété sur cet emplacement.

Nom du fichier journal

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é . Il est dérivé 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 par 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, les 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 classe ne consommera pas tout l’espace FileLogTraceListener 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 sortie du fichier journal

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, si cela est autorisé, 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.

Sortie du fichier journal

Les TraceData méthodes et TraceEvent écrivent des messages dans le fichier journal. Ces méthodes case activée la LogFileCreationSchedule propriété, ainsi que tous les journaux existants portant le même nom de base pour déterminer si un 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 trace. La syntaxe suivante est propre 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. En 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 #define TRACE en haut de votre fichier. En 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 dans 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 la façon d’obtenir le nom complet de l’assembly, consultez Noms d’assembly.

Constructeurs

FileLogTraceListener()	Initialise une nouvelle instance de la classe FileLogTraceListener avec le nom par défaut.
FileLogTraceListener(String)	Initialise une nouvelle instance de la classe FileLogTraceListener avec le nom fourni.

Propriétés

Append	Détermine s’il convient d’ajouter la sortie au fichier en cours ou de l’écrire dans un fichier nouveau ou existant.
Attributes	Obtient les attributs d'écouteur de trace personnalisés définis dans le fichier de configuration de l'application. (Hérité de TraceListener)
AutoFlush	Indique si l'écriture dans le flux du fichier journal vide ou non la mémoire tampon.
BaseFileName	Obtient ou définit le nom de base des fichiers journaux qui est utilisé pour créer le nom de fichier journal complet.
CustomLocation	Obtient ou définit le répertoire du fichier journal lorsque la propriété Location a la valeur Custom.
Delimiter	Obtient ou définit le séparateur utilisé pour délimiter les champs d'un message de journal.
DiskSpaceExhaustedBehavior	Détermine que faire lors de l'écriture dans le fichier journal si l'espace disque disponible est inférieur à celui qui est spécifié par la propriété ReserveDiskSpace.
Encoding	Obtient ou définit l'encodage à utiliser lors de la création d'un fichier journal.
Filter	Obtient ou définit le filtre de trace pour l’écouteur de la trace. (Hérité de TraceListener)
FullLogFileName	Obtient le nom complet du fichier journal actuel.
IncludeHostName	Indique si le nom d'hôte de l'ordinateur d'enregistrement doit être ou non inclus dans la sortie.
IndentLevel	Obtient ou définit le niveau de retrait. (Hérité de TraceListener)
IndentSize	Obtient ou définit le nombre d'espaces dans un retrait. (Hérité de TraceListener)
IsThreadSafe	Obtient une valeur qui indique si l'écouteur de trace est thread-safe. (Hérité de TraceListener)
Location	Obtient ou définit l'emplacement des fichiers journaux.
LogFileCreationSchedule	Détermine la date à inclure dans les noms des fichiers journaux.
MaxFileSize	Obtient ou définit la taille maximale autorisée du fichier journal, en octets.
Name	Obtient ou définit un nom pour ce TraceListener. (Hérité de TraceListener)
NeedIndent	Obtient ou définit une valeur indiquant si la sortie doit être mise en retrait. (Hérité de TraceListener)
ReserveDiskSpace	Obtient ou définit la quantité d'espace disque disponible (en octets) nécessaire pour que les messages puissent être écrits dans le fichier journal.
TraceOutputOptions	Obtient ou définit les options de sortie de trace. (Hérité de TraceListener)

Méthodes

Close()	Ferme le flux sous-jacent du fichier journal actuel et libère toutes les ressources associées au flux actuel.
CreateObjRef(Type)	Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject)
Dispose()	Libère toutes les ressources utilisées par TraceListener. (Hérité de TraceListener)
Dispose(Boolean)	Ferme le flux sous-jacent et libère éventuellement les ressources managées.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
Fail(String)	Émet un message d'erreur à l'écouteur que vous créez lors de l'implémentation de la classe TraceListener. (Hérité de TraceListener)
Fail(String, String)	Émet un message d'erreur, ainsi qu'un message d'erreur détaillé, à l'écouteur que vous créez lors de l'implémentation de la classe TraceListener. (Hérité de TraceListener)
Flush()	Vide le flux sous-jacent qui écrit dans le fichier journal actuel.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetLifetimeService()	Obsolète. Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
GetSupportedAttributes()	Obtient les attributs de configuration XML personnalisés pris en charge par l'écouteur Trace.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
InitializeLifetimeService()	Obsolète. Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
MemberwiseClone(Boolean)	Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)	Écrit des informations de traçage, un objet de données et des informations d'événement dans le fichier ou le flux de sortie.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Écrit des informations de traçage, un tableau d'objets de données et des informations d'événement dans le fichier ou le flux de sortie.
TraceEvent(TraceEventCache, String, TraceEventType, Int32)	Écrit les informations sur la trace et les événements dans la sortie spécifique de l'écouteur. (Hérité de TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)	Écrit des informations de traçage, un message et des informations d'événement dans le fichier ou le flux de sortie.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Écrit des informations de traçage, un tableau d'objets mis en forme et des informations d'événement dans le fichier ou le flux de sortie.
TraceTransfer(TraceEventCache, String, Int32, String, Guid)	Écrit les informations sur la trace, un message, une identité d'activité connexe et les informations sur les événements dans la sortie spécifique de l'écouteur. (Hérité de TraceListener)
Write(Object)	Écrit la valeur de la méthode ToString() de l'objet dans l'écouteur que vous créez lors de l'implémentation de la classe TraceListener. (Hérité de TraceListener)
Write(Object, String)	Écrit un nom de catégorie ou la valeur de la méthode ToString() de l'objet dans l'écouteur que vous créez lors de l'implémentation de la classe TraceListener. (Hérité de TraceListener)
Write(String)	Écrit mot à mot un message à disque, sans informations de contexte supplémentaires.
Write(String, String)	Écrit un nom de catégorie et un message dans l'écouteur que vous créez lors de l'implémentation de la classe TraceListener. (Hérité de TraceListener)
WriteIndent()	Écrit la mise en retrait dans l'écouteur que vous créez lors de l'implémentation de cette classe et rétablit la valeur `false` à la propriété NeedIndent. (Hérité de TraceListener)
WriteLine(Object)	Écrit la valeur de la méthode ToString() de l'objet dans l'écouteur que vous créez lors de l'implémentation de la classe TraceListener, suivie d'une marque de fin de ligne. (Hérité de TraceListener)
WriteLine(Object, String)	Écrit un nom de catégorie ou la valeur de la méthode ToString() de l'objet dans l'écouteur que vous créez lors de l'implémentation de la classe TraceListener, suivis d'une marque de fin de ligne. (Hérité de TraceListener)
WriteLine(String)	Écrit un message mot pour mot sur le disque, suivi par la marque de fin de ligne en cours, sans informations de contexte supplémentaires.
WriteLine(String, String)	Écrit un nom de catégorie ou un message dans l'écouteur que vous créez lors de l'implémentation de la classe TraceListener, suivis d'une marque de fin de ligne. (Hérité de TraceListener)

S’applique à