方法 :イベントログのイベントをサブスクライブする

[アーティクル]
11/21/2007

特定のイベントがイベントログに発行されたときにアプリケーションに通知するよう、イベントログのイベントをサブスクライブできます。これによって、イベントログを監視してタスクを実行したり、イベントが発生した時点で通知を送信したりできます。イベント通知を受信するようサブスクライブする場合は、指定したクエリ条件に一致したイベントのグループを対象とする、XPath ベースのクエリを指定します。クエリは、イベントプロパティに基づいてイベントをフィルタ処理します。たとえば、あるイベントログのレベル 2 のイベントをすべてサブスクライブしたり、105 に一致する識別子を持つイベントをすべてサブスクライブしたりできます。

例

説明

次のコード例では、System.Diagnostics.Eventing.Reader クラスを使用して、アプリケーションイベントログに記録されたレベル 2 のイベントすべてについて、イベント通知を受信するようサブスクライブします。この条件に一致したイベントがイベントログに発行されると、その説明とイベント ID がそのイベントに表示されます。サブスクライブ対象のイベントのクエリを作成するには、EventLogQuery クラスが使用されます。次に、EventLogWatcher クラスを使用して、サブスクリプションを作成します。そのために、EventRecordWritten イベントのイベントハンドラメソッドを設定します。クエリ条件に一致するイベントがログに発行されると、このイベントハンドラメソッドが呼び出されます。

次のコード例では、イベントをサブスクライブする一連の手順に従います。

イベントのフィルタ処理に使用するクエリ文字列、およびサブスクライブ対象のイベントログの名前または場所を指定して、EventLogQuery クラスのインスタンスを作成します。イベントログ名の検索方法の詳細については、「方法 :イベントログのプロパティを構成し、読み取る」を参照してください。または、イベントビューアツールでイベントログを検索してください。イベントクエリ文字列を作成する方法の詳細については、「イベントクエリとイベント XML」を参照してください。
(オプション) リモートコンピュータのイベントをサブスクライブするには、Session プロパティを EventLogSession クラスのインスタンスに設定します。次に、リモートコンピュータに接続するために使用するリモートコンピュータ名、ドメイン、およびユーザー名とパスワードを指定します。
手順 1. で作成した EventLogQuery インスタンスを EventLogWatcher コンストラクタに渡して、EventLogWatcher インスタンスを新規作成します。
イベントがサブスクリプションに報告された時点で実行されるコールバックメソッドを作成します。このメソッドは、Object 型および EventRecordWrittenEventArgs 型の引数を受け入れる必要があります。
EventRecordWritten イベントハンドラを、手順 4. で作成したコールバックメソッドを指す新しいイベントハンドラに設定します。
イベントサブスクリプションを開始するには Enabled プロパティを true に、イベントサブスクリプションを停止するには false に設定します。

コード

Imports System
Imports System.Diagnostics.Eventing.Reader

Public Class SubscribeToEventsExample

    Public Sub New()

        Dim watcher As EventLogWatcher
        watcher = Nothing

        Try

            ' Subscribe to receive event notifications
            ' in the Application log. The query specifies
            ' that only level 2 events will be returned.
            Dim subscriptionQuery As New EventLogQuery( _
                "Application", PathType.LogName, "*[System/Level=2]")

            watcher = New EventLogWatcher(subscriptionQuery)

            ' Set watcher to listen for the EventRecordWritten
            ' event.  When this event happens, the callback method
            ' (EventLogEventRead) will be called.
            AddHandler watcher.EventRecordWritten, _
                AddressOf Me.HandleEvent

            ' Begin subscribing to events the events
            watcher.Enabled = True
            Console.WriteLine("Waiting for events...")

            Dim i As Integer
            For i = 0 To 4
                If i < 5 Then
                    ' Wait for events to occur. 
                    System.Threading.Thread.Sleep(1000)
                End If
            Next

        Catch e As EventLogReadingException

            Console.WriteLine("Error reading the log: {0}", e.Message)

        Finally

            ' Stop listening to events
            watcher.Enabled = False

            If Not watcher Is Nothing Then
                watcher.Dispose()
            End If

        End Try
    End Sub

    ' <summary>
    ' Callback method that gets executed when an event is
    ' reported to the subscription.
    ' </summary>
    Public Sub HandleEvent(ByVal obj As Object, _
        ByVal arg As EventRecordWrittenEventArgs)

        ' Make sure there was no error reading the event.
        If Not arg.EventRecord Is Nothing Then

            Console.WriteLine("Received event {0} from the subscription.", _
               arg.EventRecord.Id)
            Console.WriteLine("Description: {0}", arg.EventRecord.FormatDescription())
        Else

            Console.WriteLine("The event instance was null.")
        End If
    End Sub

    Public Overloads Shared Function Main( _
    ByVal args() As String) As Integer

        ' Start the event watcher
        Dim eventWatcher As New SubscribeToEventsExample

        Return 0

    End Function
End Class

using System;
using System.Diagnostics.Eventing.Reader;

class SubscribeToEventsExample
{
    static void Main(string[] args)
    {
        EventLogWatcher watcher = null;

        try
        {
            // Subscribe to receive event notifications
            // in the Application log. The query specifies
            // that only level 2 events will be returned.
            EventLogQuery subscriptionQuery = new EventLogQuery(
                "Application", PathType.LogName, "*[System/Level=2]");

            watcher = new EventLogWatcher(subscriptionQuery);

            // Set watcher to listen for the EventRecordWritten
            // event.  When this event happens, the callback method
            // (EventLogEventRead) will be called.
            watcher.EventRecordWritten +=
                new EventHandler<EventRecordWrittenEventArgs>(
                    EventLogEventRead);

            // Begin subscribing to events the events
            watcher.Enabled = true;

            for (int i = 0; i < 5; i++)
            {
                // Wait for events to occur. 
                System.Threading.Thread.Sleep(1000);
            }
        }
        catch (EventLogReadingException e)
        {
            Console.WriteLine("Error reading the log: {0}", e.Message);
        }
        finally
        {
            // Stop listening to events
            watcher.Enabled = false;

            if (watcher != null)
            {
                watcher.Dispose();
            }
        }
    }

    /// <summary>
    /// Callback method that gets executed when an event is
    /// reported to the subscription.
    /// </summary>
    public static void EventLogEventRead(object obj,
        EventRecordWrittenEventArgs arg)
    {
        // Make sure there was no error reading the event.
        if (arg.EventRecord != null)
        {
            Console.WriteLine("Received event {0} from the subscription.",
               arg.EventRecord.Id);
            Console.WriteLine("Description: {0}", arg.EventRecord.FormatDescription());
        }
        else
        {
            Console.WriteLine("The event instance was null.");
        }
    }
}

コードのコンパイル

このコード例では、System.dll ファイルと System.Core.dll ファイルへの参照が必要です。

次の方法で共有

方法 :イベントログのイベントをサブスクライブする

例

説明

コード

コードのコンパイル

関連項目

概念

その他のリソース

次の方法で共有

方法 :イベント ログのイベントをサブスクライブする

例

説明

コード

コードのコンパイル

関連項目

概念

その他のリソース

方法 :イベントログのイベントをサブスクライブする