EventLog Klasa

Definicja

Przestrzeń nazw:

System.Diagnostics

Zestaw:

System.Diagnostics.EventLog.dll

Źródło:

EventLog.cs

Zapewnia interakcję z dziennikami zdarzeń systemu Windows.

public ref class EventLog : System::ComponentModel::Component, System::ComponentModel::ISupportInitialize

public class EventLog : System.ComponentModel.Component, System.ComponentModel.ISupportInitialize

type EventLog = class
    inherit Component
    interface ISupportInitialize

Public Class EventLog
Inherits Component
Implements ISupportInitialize

Dziedziczenie

Object

MarshalByRefObject

Component

EventLog

Implementuje

ISupportInitialize

Przykłady

Poniższy przykład tworzy źródło MySource zdarzeń, jeśli jeszcze nie istnieje, i zapisuje wpis w dzienniku MyNewLogzdarzeń .

Uwaga / Notatka

Musisz uruchomić tę aplikację jako administrator.

using System;
using System.Diagnostics;
using System.Threading;

class MySample{

    public static void Main(){

        // Create the source, if it does not already exist.
        if(!EventLog.SourceExists("MySource"))
        {
             //An event log source should not be created and immediately used.
             //There is a latency time to enable the source, it should be created
             //prior to executing the application that uses the source.
             //Execute this sample a second time to use the new source.
            EventLog.CreateEventSource("MySource", "MyNewLog");
            Console.WriteLine("CreatedEventSource");
            Console.WriteLine("Exiting, execute the application a second time to use the source.");
            // The source is created.  Exit the application to allow it to be registered.
            return;
        }

        // Create an EventLog instance and assign its source.
        EventLog myLog = new EventLog();
        myLog.Source = "MySource";

        // Write an informational entry to the event log.
        myLog.WriteEntry("Writing to event log.");
    }
}

Option Explicit
Option Strict

Imports System.Diagnostics
Imports System.Threading

Class MySample
    Public Shared Sub Main()
        
        If Not EventLog.SourceExists("MySource") Then
            ' Create the source, if it does not already exist.
            ' An event log source should not be created and immediately used.
            ' There is a latency time to enable the source, it should be created
            ' prior to executing the application that uses the source.
            ' Execute this sample a second time to use the new source.
            EventLog.CreateEventSource("MySource", "MyNewLog")
            Console.WriteLine("CreatingEventSource")
            'The source is created.  Exit the application to allow it to be registered.
            Return
        End If
        
        ' Create an EventLog instance and assign its source.
        Dim myLog As New EventLog()
        myLog.Source = "MySource"
        
        ' Write an informational entry to the event log.    
        myLog.WriteEntry("Writing to event log.")
    End Sub
End Class

Uwagi

EventLog umożliwia uzyskiwanie dostępu do dzienników zdarzeń systemu Windows lub dostosowywanie ich, które rejestrują informacje o ważnych zdarzeniach oprogramowania lub sprzętu. Za pomocą programu EventLogmożna odczytywać z istniejących dzienników, zapisywać wpisy w dziennikach, tworzyć lub usuwać źródła zdarzeń, usuwać dzienniki i odpowiadać na wpisy dziennika. Podczas tworzenia źródła zdarzeń można również utworzyć nowe dzienniki.

Ważna

Ten typ implementuje interfejs IDisposable. Po zakończeniu korzystania z typu danych, należy go usunąć w sposób bezpośredni lub pośredni. Aby usunąć typ bezpośrednio, wywołaj metodę Dispose w bloku try/catch. Aby usunąć go pośrednio, należy użyć konstrukcji języka, takiej jak using (w języku C#) lub Using (w Visual Basic). Aby uzyskać więcej informacji, zobacz sekcję "Używanie obiektu implementującego IDisposable" (Using an Object that Implements IDisposable) w temacie interfejsu IDisposable.

Oprócz zapewnienia dostępu do poszczególnych dzienników zdarzeń i ich wpisów, EventLog klasa umożliwia dostęp do kolekcji wszystkich dzienników zdarzeń. Możesz użyć static elementów członkowskich EventLog , aby usunąć dzienniki, pobrać listy dzienników, utworzyć lub usunąć źródło lub określić, czy komputer zawiera już określone źródło.

Istnieją trzy domyślne dzienniki zdarzeń: Aplikacja, System i Zabezpieczenia. Dziennik zabezpieczeń jest tylko do odczytu. Inne instalowane aplikacje i usługi, takie jak Usługa Active Directory, mogą mieć dodatkowe dzienniki zdarzeń.

Podczas korzystania z EventLog klasy istnieją zagadnienia dotyczące zabezpieczeń. EventLog wymaga EventLogPermission uprawnień do określonych akcji. Zalecamy, aby EventLogPermission nie udzielono mu częściowo zaufanego kodu. Nigdy nie należy przekazywać żadnych obiektów dziennika zdarzeń, w tym EventLogEntryCollection obiektów i EventLogEntry , do mniej zaufanego kodu. Na przykład utworzenie EventLog obiektu, zapisanie wpisu, a następnie przekazanie EventLog obiektu do częściowo zaufanego kodu może spowodować problem z zabezpieczeniami, ponieważ możliwość odczytywania i zapisywania w dzienniku zdarzeń umożliwia kodowi wykonywanie akcji, takich jak wysyłanie komunikatów dziennika zdarzeń w nazwie innej aplikacji.

Począwszy od systemu Windows Vista, kontrola konta użytkownika (UAC) określa poświadczenia użytkownika. Jeśli jesteś członkiem wbudowanej grupy Administratorzy, masz przypisane dwa tokeny dostępu w czasie wykonywania: standardowy token dostępu użytkownika i token dostępu administratora. Domyślnie jesteś w roli użytkownika standardowego. Aby uruchomić kod, który uzyskuje dostęp do dziennika zabezpieczeń, należy najpierw podnieść poziom poświadczeń od użytkownika standardowego do administratora. Można to zrobić po uruchomieniu aplikacji, otwierając menu skrótów dla aplikacji (jeśli używasz myszy, kliknij prawym przyciskiem myszy ikonę aplikacji) i wskazując, że chcesz uruchomić jako administrator.

Możesz użyć EventLog polecenia , aby utworzyć niestandardowe dzienniki zdarzeń, które można wyświetlić za pośrednictwem Podglądu zdarzeń serwera. RegisterDisplayName Użyj metody , aby wyświetlić zlokalizowaną nazwę dziennika zdarzeń w Podglądzie zdarzeń. ModifyOverflowPolicy Użyj metody , aby skonfigurować zachowanie dziennika zdarzeń, gdy osiągnie maksymalny rozmiar dziennika.

Aby odczytać z dziennika zdarzeń, określ nazwę dziennika (Log właściwość) i nazwę komputera serwera (MachineName właściwość dziennika zdarzeń. Jeśli nie określisz nazwy komputera serwera, przyjmuje się, że jest zakładany komputer lokalny ". Nie jest konieczne określenie źródła zdarzeń (Source właściwości), ponieważ źródło jest wymagane tylko do zapisywania w dziennikach. Właściwość Entries jest automatycznie wypełniana listą wpisów dziennika zdarzeń.

Aby zapisać w dzienniku zdarzeń, określ lub utwórz źródło zdarzeń (Source właściwość). Aby utworzyć nowe źródło zdarzeń, musisz mieć poświadczenia administracyjne na komputerze. Źródło zdarzeń rejestruje aplikację w dzienniku zdarzeń jako prawidłowe źródło wpisów. Możesz użyć źródła zdarzeń, aby zapisywać tylko jeden dziennik w danym momencie. Właściwość Source może być dowolnym losowym ciągiem, ale nazwa musi być różna od innych źródeł na komputerze. Źródło zdarzenia jest zazwyczaj nazwą aplikacji lub innego ciągu identyfikującego. Próba utworzenia zduplikowanego Source wartości zgłasza wyjątek. Jednak pojedynczy dziennik zdarzeń może być skojarzony z wieloma źródłami.

Jeśli źródło zdarzeń dziennika zdarzeń skojarzonego z EventLog wystąpieniem nie istnieje, zostanie utworzone nowe źródło zdarzeń. Aby utworzyć źródło zdarzeń w systemie Windows Vista lub nowszym lub Windows Server 2003, musisz mieć poświadczenia administracyjne.

To wymaganie jest spowodowane tym, że wszystkie dzienniki zdarzeń, w tym dzienniki zabezpieczeń, muszą być przeszukiwane, aby określić, czy źródło zdarzeń jest unikatowe. Począwszy od systemu Windows Vista, użytkownicy nie mają uprawnień dostępu do dziennika zabezpieczeń; w związku z tym SecurityException jest zgłaszany.

Ważna

Tworzenie lub usuwanie źródła zdarzeń wymaga synchronizacji kodu bazowego przy użyciu nazwanego mutexu. Jeśli aplikacja o wysokim poziomie uprawnień blokuje nazwany mutex, próba utworzenia lub usunięcia źródła zdarzeń powoduje, że aplikacja przestanie odpowiadać do momentu zwolnienia blokady. Aby zapobiec temu problemowi, nigdy nie udzielaj UnmanagedCode uprawnień do niezaufanego kodu. Ponadto UnmanagedCode uprawnienie potencjalnie zezwala na pomijanie innych uprawnień i powinno być przyznawane tylko do wysoce zaufanego kodu.

Aplikacje i usługi powinny zapisywać w dzienniku aplikacji lub w dzienniku niestandardowym. Sterowniki urządzeń powinny zapisywać w dzienniku systemu. Jeśli właściwość nie zostanie jawnie ustawiona, dziennik zdarzeń zostanie domyślnie ustawiony Log na dziennik aplikacji.

Uwaga / Notatka

Nie ma nic, aby chronić aplikację przed zapisem jako dowolne zarejestrowane źródło. Jeśli aplikacja ma przyznane Write uprawnienie, może zapisywać zdarzenia dla dowolnego prawidłowego źródła zarejestrowanego na komputerze.

WriteEvent Użyj metod i WriteEntry do zapisywania zdarzeń w dzienniku zdarzeń. Należy określić źródło zdarzeń do zapisywania zdarzeń; należy utworzyć i skonfigurować źródło zdarzeń przed zapisaniem pierwszego wpisu ze źródłem.

Utwórz nowe źródło zdarzeń podczas instalacji aplikacji. Dzięki temu system operacyjny może odświeżyć listę zarejestrowanych źródeł zdarzeń i ich konfigurację. Jeśli system operacyjny nie odświeżył listy źródeł zdarzeń i spróbujesz napisać zdarzenie z nowym źródłem, operacja zapisu zakończy się niepowodzeniem. Nowe źródło można skonfigurować przy użyciu EventLogInstaller obiektu lub CreateEventSource metody. Aby utworzyć nowe źródło zdarzeń, musisz mieć poświadczenia administracyjne na komputerze.

Każde źródło może zapisywać tylko w jednym dzienniku zdarzeń jednocześnie; Jednak aplikacja może używać wielu źródeł do zapisywania w wielu dziennikach zdarzeń. Na przykład aplikacja może wymagać wielu źródeł skonfigurowanych dla różnych dzienników zdarzeń lub różnych plików zasobów. Aby zmienić szczegóły konfiguracji istniejącego źródła, musisz usunąć źródło, a następnie utworzyć je przy użyciu nowej konfiguracji. Jeśli inne aplikacje lub składniki używają istniejącego źródła, utwórz nowe źródło ze zaktualizowaną konfiguracją zamiast usuwać istniejące źródło.

Źródło zdarzeń można zarejestrować za pomocą zlokalizowanych zasobów dla kategorii zdarzeń i ciągów komunikatów. Aplikacja może zapisywać wpisy dziennika zdarzeń przy użyciu identyfikatorów zasobów zamiast określania rzeczywistych wartości ciągu. Zapoznaj się z klasami EventLogInstaller i, EventSourceCreationData aby uzyskać więcej informacji na temat konfigurowania źródła przy użyciu plików zasobów.

Jeśli aplikacja zapisuje wartości ciągów bezpośrednio w dzienniku zdarzeń, nie trzeba ustawiać właściwości pliku zasobu dla źródła. Źródło musi być skonfigurowane do zapisywania zlokalizowanych wpisów lub pisania ciągów bezpośrednich. Jeśli aplikacja zapisuje wpisy przy użyciu identyfikatorów zasobów i wartości ciągów, musisz zarejestrować dwa oddzielne źródła. Na przykład skonfiguruj jedno źródło z plikami zasobów, a następnie użyj tego źródła w WriteEvent metodzie w celu zapisania wpisów przy użyciu identyfikatorów zasobów w dzienniku zdarzeń. Następnie utwórz inne źródło bez plików zasobów i użyj tego źródła w WriteEntry metodzie , aby zapisać ciągi bezpośrednio w dzienniku zdarzeń przy użyciu tego źródła.

Podczas pisania zdarzeń należy przynajmniej określić ciąg komunikatu lub identyfikator zasobu dla ciągu komunikatu. Inne właściwości zdarzenia są opcjonalne. Przykłady opcjonalnych ustawień zdarzeń obejmują następujące elementy:

• Można ustawić wartość , EventLogEntryType aby określić ikonę wyświetlaną przez Podgląd zdarzeń dla wpisu.

• Możesz określić identyfikator kategorii zdarzenia, jeśli aplikacja używa kategorii do filtrowania zdarzeń.

• Możesz dołączyć dane binarne do wpisu zdarzenia, jeśli chcesz skojarzyć dodatkowe informacje z danym zdarzeniem.

Ważna

Rejestrowanie zdarzeń zużywa miejsce na dysku, czas procesora i inne zasoby systemowe. Ważne jest, aby rejestrować tylko istotne informacje. Zalecamy umieszczenie wywołań dziennika zdarzeń w ścieżce błędu, a nie w głównej ścieżce kodu, aby nie wpływały one negatywnie na wydajność.

Aby uzyskać listę początkowych wartości właściwości dla wystąpienia EventLog, zobacz konstruktor EventLog.

Konstruktory

Nazwa	Opis
EventLog()	Inicjuje nowe wystąpienie klasy EventLog. Nie kojarzy wystąpienia z żadnym dziennikiem.
EventLog(String, String, String)	Inicjuje nowe wystąpienie klasy EventLog. Kojarzy wystąpienie z dziennikiem na określonym komputerze i tworzy lub przypisuje określone źródło do obiektu EventLog.
EventLog(String, String)	Inicjuje nowe wystąpienie klasy EventLog. Kojarzy wystąpienie z dziennikiem na określonym komputerze.
EventLog(String)	Inicjuje nowe wystąpienie klasy EventLog. Kojarzy wystąpienie z dziennikiem na komputerze lokalnym.

Właściwości

Nazwa	Opis
EnableRaisingEvents	Pobiera lub ustawia wartość wskazującą, czy EventLog odbiera EntryWritten powiadomienia o zdarzeniach.
Entries	Pobiera zawartość dziennika zdarzeń.
Log	Pobiera lub ustawia nazwę dziennika do odczytu lub zapisu.
LogDisplayName	Pobiera przyjazną nazwę dziennika zdarzeń.
MachineName	Pobiera lub ustawia nazwę komputera, na którym mają być odczytywane lub zapisywane zdarzenia.
MaximumKilobytes	Pobiera lub ustawia maksymalny rozmiar dziennika zdarzeń w kilobajtach.
MinimumRetentionDays	Ta właściwość jest niezalecana.
OverflowAction	Pobiera skonfigurowane zachowanie do przechowywania nowych wpisów, gdy dziennik zdarzeń osiągnie maksymalny rozmiar pliku dziennika.
Source	Pobiera lub ustawia nazwę źródłową do zarejestrowania i użycia podczas zapisywania w dzienniku zdarzeń.
SynchronizingObject	Pobiera lub ustawia obiekt używany do marshalingu wywołań programu obsługi zdarzeń wystawionych w wyniku wpisu zapisanego EventLog zdarzenia.

Metody

Nazwa	Opis
BeginInit()	Rozpoczyna inicjowanie elementu używanego EventLog w formularzu lub używanego przez inny składnik. Inicjowanie odbywa się w czasie wykonywania.
Clear()	Usuwa wszystkie wpisy z dziennika zdarzeń.
Close()	Zamyka dziennik zdarzeń i zwalnia dojścia odczytu i zapisu.
CreateEventSource(EventSourceCreationData)	Ustanawia prawidłowe źródło zdarzeń do zapisywania zlokalizowanych komunikatów zdarzeń przy użyciu określonych właściwości konfiguracji dla źródła zdarzeń i odpowiedniego dziennika zdarzeń.
CreateEventSource(String, String, String)	Przestarzałe. Ustanawia określoną nazwę źródła jako prawidłowe źródło zdarzeń do zapisywania wpisów w dzienniku na określonym komputerze. Tej metody można również użyć do utworzenia nowego dziennika niestandardowego na określonym komputerze.
CreateEventSource(String, String)	Ustanawia określoną nazwę źródła jako prawidłowe źródło zdarzeń do zapisywania wpisów w dzienniku na komputerze lokalnym. Ta metoda może również utworzyć nowy dziennik niestandardowy na komputerze lokalnym.
Delete(String, String)	Usuwa dziennik zdarzeń z określonego komputera.
Delete(String)	Usuwa dziennik zdarzeń z komputera lokalnego.
DeleteEventSource(String, String)	Usuwa rejestrację źródła zdarzeń aplikacji z określonego komputera.
DeleteEventSource(String)	Usuwa rejestrację źródła zdarzeń z dziennika zdarzeń komputera lokalnego.
Dispose(Boolean)	Zwalnia niezarządzane zasoby używane przez EventLogprogram i opcjonalnie zwalnia zarządzane zasoby.
EndInit()	Kończy inicjowanie elementu używanego EventLog w formularzu lub przez inny składnik. Inicjowanie odbywa się w czasie wykonywania.
Exists(String, String)	Określa, czy dziennik istnieje na określonym komputerze.
Exists(String)	Określa, czy dziennik istnieje na komputerze lokalnym.
GetEventLogs()	Wyszukuje wszystkie dzienniki zdarzeń na komputerze lokalnym i tworzy tablicę EventLog obiektów zawierających listę.
GetEventLogs(String)	Wyszukuje wszystkie dzienniki zdarzeń na danym komputerze i tworzy tablicę EventLog obiektów zawierających listę.
LogNameFromSourceName(String, String)	Pobiera nazwę dziennika, do którego zarejestrowano określone źródło.
ModifyOverflowPolicy(OverflowAction, Int32)	Zmienia skonfigurowane zachowanie podczas zapisywania nowych wpisów, gdy dziennik zdarzeń osiągnie maksymalny rozmiar pliku.
RegisterDisplayName(String, Int64)	Określa zlokalizowaną nazwę dziennika zdarzeń, który jest wyświetlany w Podglądzie zdarzeń serwera.
SourceExists(String, String)	Określa, czy źródło zdarzeń jest zarejestrowane na określonym komputerze.
SourceExists(String)	Określa, czy źródło zdarzeń jest zarejestrowane na komputerze lokalnym.
WriteEntry(String, EventLogEntryType, Int32, Int16, Byte[])	Zapisuje wpis z podanym tekstem wiadomości, identyfikatorem zdarzenia zdefiniowanym przez aplikację i kategorią zdefiniowaną przez aplikację w dzienniku zdarzeń oraz dołącza dane binarne do komunikatu.
WriteEntry(String, EventLogEntryType, Int32, Int16)	Zapisuje wpis z podanym tekstem wiadomości, identyfikatorem zdarzenia zdefiniowanym przez aplikację i kategorią zdefiniowaną przez aplikację w dzienniku zdarzeń.
WriteEntry(String, EventLogEntryType, Int32)	Zapisuje wpis z podanym tekstem komunikatu i identyfikatorem zdarzenia zdefiniowanego przez aplikację w dzienniku zdarzeń.
WriteEntry(String, EventLogEntryType)	Zapisuje błąd, ostrzeżenie, informacje, inspekcję powodzenia lub wpis inspekcji niepowodzenia z podanym tekstem komunikatu w dzienniku zdarzeń.
WriteEntry(String, String, EventLogEntryType, Int32, Int16, Byte[])	Zapisuje wpis z podanym tekstem wiadomości, identyfikatorem zdarzenia zdefiniowanym przez aplikację i kategorią zdefiniowaną przez aplikację do dziennika zdarzeń (przy użyciu określonego zarejestrowanego źródła zdarzeń) i dołącza dane binarne do wiadomości.
WriteEntry(String, String, EventLogEntryType, Int32, Int16)	Zapisuje wpis z podanym tekstem wiadomości, identyfikatorem zdarzenia zdefiniowanym przez aplikację i kategorią zdefiniowaną przez aplikację w dzienniku zdarzeń przy użyciu określonego zarejestrowanego źródła zdarzeń. Za category pomocą Podglądu zdarzeń można filtrować zdarzenia w dzienniku.
WriteEntry(String, String, EventLogEntryType, Int32)	Zapisuje wpis z podanym tekstem wiadomości i identyfikatorem zdarzenia zdefiniowanym przez aplikację w dzienniku zdarzeń przy użyciu określonego zarejestrowanego źródła zdarzeń.
WriteEntry(String, String, EventLogEntryType)	Zapisuje błąd, ostrzeżenie, informacje, inspekcję powodzenia lub wpis inspekcji niepowodzenia z podanym tekstem komunikatu w dzienniku zdarzeń przy użyciu określonego zarejestrowanego źródła zdarzeń.
WriteEntry(String, String)	Zapisuje wpis typu informacji z podanym tekstem wiadomości w dzienniku zdarzeń przy użyciu określonego zarejestrowanego źródła zdarzeń.
WriteEntry(String)	Zapisuje wpis typu informacji z podanym tekstem wiadomości do dziennika zdarzeń.
WriteEvent(EventInstance, Byte[], Object[])	Zapisuje wpis dziennika zdarzeń przy użyciu danych zdarzeń, ciągów zastępczych komunikatów i skojarzonych danych binarnych.
WriteEvent(EventInstance, Object[])	Zapisuje zlokalizowany wpis w dzienniku zdarzeń.
WriteEvent(String, EventInstance, Byte[], Object[])	Zapisuje wpis dziennika zdarzeń z podanymi danymi zdarzenia, ciągami zastępczymi komunikatów i skojarzonymi danymi binarnymi oraz przy użyciu określonego zarejestrowanego źródła zdarzeń.
WriteEvent(String, EventInstance, Object[])	Zapisuje wpis dziennika zdarzeń z podanymi danymi zdarzenia i ciągami zastępczymi komunikatów przy użyciu określonego zarejestrowanego źródła zdarzeń.

Zdarzenia

Nazwa	Opis
EntryWritten	Występuje, gdy wpis jest zapisywany w dzienniku zdarzeń na komputerze lokalnym.

Zobacz też

• EventLogInstaller
• EventLogEntry
• EntryWrittenEventArgs
• ServiceBase