Directives INF AddAutoLogger et UpdateAutoLogger
Les directives AddAutoLogger et UpdateAutoLogger sont utilisées dans un DDInstall INF. Section Événements. Ils spécifient des caractéristiques pour les sessions de suivi d’événements pour Windows (ETW) AutoLogger qui enregistrent les événements qui se produisent au début du processus de démarrage du système d’exploitation. Ces directives sont prises en charge à partir de Windows 11.
[DDInstall.Events]
AddAutoLogger=session-name,{SessionGUID},add-autologger-install-section
UpdateAutoLogger=session-name,update-autologger-install-section
...
Entrées
session-name
Spécifie le nom de la session AutoLogger qui sera ajoutée. Ce nom doit être unique parmi l’ensemble des sessions AutoLogger sur un ordinateur. Il est recommandé que le nom de la session inclue le nom de votre entreprise ou une abréviation du nom de votre société afin qu’il n’entre pas en conflit avec le nom d’une session d’une autre société.
SessionGUID
Spécifie la valeur GUID qui identifie la session AutoLogger. Cela peut être exprimé sous la forme d’une valeur GUID explicite du formulaire {nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn} ou d’un jeton %strkey% défini sur {nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn} dans une section Strings du fichier INF.
add-autologger-install-section
Fait référence à une section définie par l’enregistreur INF qui contient des informations pour l’inscription du journal automatique. Pour plus d’informations, consultez la section Notes suivante.
update-autologger-install-section
Fait référence à une section définie par l’enregistreur INF qui contient des informations permettant d’ajouter des fournisseurs à un autologger existant. Pour plus d’informations, consultez la section Notes suivante.
Notes
Pour plus d’informations sur les autologgers, consultez Configuration et démarrage d’une session de journal automatique.
Chaque nom de section créé par l’enregistreur INF doit être unique dans le fichier INF et respecter les règles générales de définition des noms de section. Pour plus d’informations sur ces règles, consultez Règles de syntaxe générales pour les fichiers INF.
Une directive AddAutoLogger doit référencer un add-autologger-install-section de noms ailleurs dans le fichier INF. Chaque section a la forme suivante :
[add-autologger-install-section]
Start=<0 | 1>
[BufferSize=buffer-size]
[ClockType=clock-type]
[DisableRealtimePersistence= <0 | 1>]
[FileName=path-to-file]
[FileMax=file-max]
[FlushTimer=flush-timer]
[LogFileMode=log-file-mode]
[MaxFileSize=max-file-size]
[MaximumBuffers=max-buffers]
[MinimumBuffers=min-buffers]
(AddAutoLoggerProvider={ProviderGUID},autologger-provider-install-section)
…
Chaque section add-autologger-install-section doit fournir start. Si vous le souhaitez, spécifiez un ou plusieurs fournisseurs AutoLogger pour l’auto-journal à l’aide de AddAutoLoggerProvider, chacun sur une ligne distincte. Pour plus d’informations sur les fournisseurs AutoLogger dans un fichier INF, consultez Ajout de fournisseurs de journal automatique ci-dessous.
Une directive UpdateAutoLogger doit référencer une section nommée update-autologger-install-section ailleurs dans le fichier INF. Chacune de ces sections se présente sous la forme suivante :
[update-autologger-install-section]
(AddAutoLoggerProvider={ProviderGUID},autologger-provider-install-section)
…
Chaque update-autologger-install-section peut spécifier un ou plusieurs fournisseurs AutoLogger à l’aide de AddAutoLoggerProvider, chacun sur une ligne distincte. Pour plus d’informations sur les fournisseurs AutoLogger dans un fichier INF, consultez Ajout de fournisseurs de journal automatique ci-dessous.
Add-AutoLogger-Install-Section Entrées et valeurs
Commencer=0 | 1
Spécifie si l’autologger démarrera la prochaine fois que l’ordinateur sera redémarré. Pour démarrer l’autologger, définissez cette valeur sur 1; sinon, définissez cette valeur sur 0.
BufferSize=taille de la mémoire tampon
Spécifie éventuellement la taille de chaque mémoire tampon, en kilo-octets.
BufferSize doit être inférieur à un mégaoctet. ETW utilise la taille de la mémoire physique pour calculer cette valeur si elle n’est pas définie.
ClockType=clock-type
Spécifie éventuellement le minuteur à utiliser lors de la journalisation de l’horodatage pour chaque événement à l’aide des valeurs numériques suivantes, exprimées en décimal ou, comme indiqué dans la liste suivante, en notation hexadécimale. S’il est omis, la valeur par défaut est 0x1 (valeur du compteur de performances).
0x1 (valeur du compteur de performances)
0x2 (minuteur système)
0x3 (compteur de cycle processeur)
Pour obtenir une description de chaque type d’horloge, consultez le membre ClientContext de WNODE_HEADER.
DisableRealtimePersistence=0 | 1
Autorise éventuellement la désactivation de la persistance en temps réel en définissant la valeur sur 1. La valeur par défaut est 0 (activé). Si la persistance en temps réel est activée, les événements en temps réel qui n’ont pas été remis au moment de l’arrêt de l’ordinateur sont conservés. Les événements sont ensuite remis au consommateur la prochaine fois qu’il se connecte à la session.
Fichier=nom_fichier
Spécifie éventuellement le chemin complet du fichier journal. Si le chemin d’accès n’existe pas, il y aura un effort de création la première fois que l’autologger démarre. La longueur de FileName est limitée à 1 024 caractères. Le fichier est un fichier journal séquentiel. Le chemin d’accès au fichier par défaut est %DriverData%\<SessionName.etl>.
FileMax=file-max
Spécifie éventuellement le nombre maximal d’instances du fichier journal créé par ETW. Une fois le nombre maximal de fichiers créé, ETW remplace le premier fichier, s’il existe. Le nombre maximal d’instances du fichier journal pris en charge est de 16. N’utilisez pas cette fonctionnalité avec le EVENT_TRACE_FILE_MODE_NEWLINE LogFileMode.
FlushTimer=flush-timer
Spécifie éventuellement à quelle fréquence, en secondes, les mémoires tampons de trace sont vidées de force. La durée minimale de vidage est de 1 seconde. La valeur par défaut est 0. Par défaut, les mémoires tampons sont vidées uniquement lorsqu’elles sont pleines.
LogFileMode=log-file-mode
Spécifie éventuellement un ou plusieurs modes de journalisation. Pour connaître les valeurs possibles, consultez Constantes du mode de journalisation. La valeur par défaut est 0x1 (EVENT_TRACE_FILE_MODE_SEQUENTIAL).
MaxFileSize=max-file-size
Spécifie éventuellement la taille de fichier maximale du fichier journal, en mégaoctets. La session est fermée lorsque la taille maximale est atteinte, sauf si EVENT_TRACE_FILE_MODE_CIRCULAR est spécifié dans LogFileMode. Pour ne spécifier aucune limite, définissez la valeur sur 0. La valeur par défaut est 100 Mo. Le comportement qui se produit lorsque la taille de fichier maximale est atteinte dépend de la valeur de LogFileMode.
MaximumBuffers=maximum-buffers
Spécifie éventuellement le nombre maximal de mémoires tampons à allouer, généralement le nombre minimal de mémoires tampons plus vingt. Cette valeur doit être supérieure ou égale à la valeur de MinimumBuffers.
MinimumBuffers=minimum-buffers
Spécifie éventuellement le nombre minimal de mémoires tampons à allouer au démarrage. Le nombre minimal de mémoires tampons que vous pouvez spécifier est de deux tampons par processeur.
AddAutoLoggerProvider={ProviderGUID},autologger-provider-install-section
Spécifie éventuellement un fournisseur avec une sous-directive qui fait référence à un autologger-provider-install-section défini par inf-writer-defined ailleurs dans le fichier INF. Pour plus d’informations, consultez la section Ajout de fournisseurs de journal automatique .
Ajout de fournisseurs AutoLogger
Dans les sections add-autologger-install-section et update-autologger-install-section , vous pouvez spécifier les fournisseurs que vous souhaitez activer dans la session à l’aide de la directive AddAutoLoggerProvider .
ProviderGUID doit être une valeur GUID qui identifie le fournisseur AutoLogger. Cette valeur peut être exprimée sous la forme d’une valeur GUID explicite de la forme {nnnnnn-nnnn-nnnn-nnnnnnnnnnnn} ou sous la forme d’un jeton %strkey% défini sur {nnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnn} dans une section Strings du fichier INF.
Une sous-directive AddAutoLoggerProvider doit également référencer une section autologger-provider-install-section ailleurs dans le fichier. Chacune de ces sections se présente sous la forme suivante :
[autologger-provider-install-section]
[Enabled=<0 | 1>]
[EnableFlags=enable-flags]
[EnableLevel=enable-level]
[EnablePropety=enable-property]
[MatchAnyKeyword=match-any-keyword]
[MatchAllKeyword=match-all-keyword]
Entrées et valeurs de section AutoLogger-Provider-Install-Section
Activé=0 | 1
Indique éventuellement si le fournisseur est activé. Pour activer le fournisseur, définissez cette valeur sur 1. Pour désactiver, définissez la valeur sur 0. La valeur par défaut est 0.
EnableFlags=enable-flags
Spécifie éventuellement la classe d’événements pour laquelle le fournisseur génère des événements. Pour plus d’informations, consultez le paramètre EnableFlags de la fonction EnableTraceEx . Spécifiez ce nom de valeur si le fournisseur ne prend pas en charge MatchAnyKeyword ou MatchAllKeyword.
EnableLevel=niveau d’activation
Fournit éventuellement le niveau de détail inclus dans l’événement. Pour obtenir la liste des niveaux prédéfinis, consultez le paramètre Level de la fonction EnableTraceEx .
EnableProperty=enable-property
Fournit éventuellement l’inclusion d’un ou plusieurs des éléments suivants dans le fichier journal :
0x00000001 (EVENT_ENABLE_PROPERTY_SID) = Incluez dans les données étendues l’identificateur de sécurité (SID) de l’utilisateur.
0x00000002 (EVENT_ENABLE_PROPERTY_TS_ID) = Incluez dans les données étendues l’identificateur de session de terminal.
0x00000004 (EVENT_ENABLE_PROPERTY_STACK_TRACE) = Incluez dans les données étendues une trace de pile d’appels pour les événements écrits à l’aide d’EventWrite.
0x00000010 (EVENT_ENABLE_PROPERTY_IGNORE_KEYWORD_0) = Filtre tous les événements qui n’ont pas un mot clé différent de zéro spécifié.
0x00000020 (EVENT_ENABLE_PROPERTY_PROVIDER_GROUP) = Indique que cet appel à EnableTraceEx2 doit activer un groupe de fournisseurs plutôt qu’un fournisseur d’événements individuel.
0x00000080 (EVENT_ENABLE_PROPERTY_PROCESS_START_KEY) = Incluez la clé de démarrage du processus dans les données étendues.
0x00000100 (EVENT_ENABLE_PROPERTY_EVENT_KEY) = Inclure la clé d’événement dans les données étendues.
0x00000200 (EVENT_ENABLE_PROPERTY_EXCLUDE_INPRIVATE) = Filtre tous les événements marqués comme un événement InPrivate ou qui proviennent d’un processus marqué comme InPrivate.
MatchAnyKeyword=match-any-mot clé
Fournit éventuellement un masque de bits de mots clés qui déterminent la catégorie d’événements que vous souhaitez que le fournisseur écrive. Le fournisseur écrit l’événement si l’un des bits mot clé de l’événement correspond à l’un des bits définis dans ce masque. Pour spécifier que le fournisseur écrit tous les événements, définissez cette valeur sur zéro. Pour obtenir un exemple, consultez la section Remarques de la fonction EnableTraceEx .
MatchAllKeyword=match-all-mot clé
Restreint éventuellement la catégorie d’événements que vous souhaitez que le fournisseur écrive. Si le mot clé de l’événement répond à la condition MatchAnyKeyword, le fournisseur écrit l’événement uniquement si tous les bits de ce masque existent dans le mot clé de l’événement. Ce masque n’est pas utilisé si MatchAnyKeyword est égal à zéro. Pour obtenir un exemple, consultez la section Remarques de la fonction EnableTraceEx .
Exemples
[Contoso_Add_AutoLogger_Inst]
Start = 1
FileName = %%DriverData%%\Contoso\AutoLoggerLogFile.etl
AddAutoLoggerProvider = {4b8b1947-ae4d-54e2-826a-1aee78ef05b2}, Contoso_Provider_1_Inst
[Contoso_Update_AutoLogger_Inst]
AddAutoLoggerProvider= {a55d5a23-1a5b-580a-2be5-d7188f43fae1}, Contoso_Provider_2_Inst
[Contoso_Provider_1_Inst]
Enabled = 1
EnableProperty = 0x00000001
[Contoso_Provider_2_Inst]
Enabled = 1
Compatibilité héritée
Les directives AddAutoLogger et UpdateAutoLogger sont prises en charge à partir de Windows 11. Pour configurer une autologger sur un système d’exploitation de niveau inférieur, utilisez la directive AddReg .
[Contoso_AutoLogger_AddReg]
HKLM,SYSTEM\CurrentControlSet\Control\WMI\Autologger\<autologger-session-name>,Start,0x00010001,1
HKLM,SYSTEM\CurrentControlSet\Control\WMI\Autologger\<autologger-session-name>,GUID,,{autologger-guid}
HKLM,SYSTEM\CurrentControlSet\Control\WMI\Autologger\<autologger-session-name>\{autologger-provider-guid},Enabled,0x00010001,1