EventLog クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

EventLog クラス

Windows のイベントログとの対話を実現します。

名前空間: System.Diagnostics
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Class EventLog
    Inherits Component
    Implements ISupportInitialize

Visual Basic (使用法)

Dim instance As EventLog

public class EventLog : Component, ISupportInitialize

C++

public ref class EventLog : public
 Component, ISupportInitialize

public class EventLog extends Component implements
 ISupportInitialize

JScript

public class EventLog extends
 Component implements ISupportInitialize

解説

EventLog を使用すると、重要なソフトウェアイベントまたはハードウェアイベントについての情報を記録する Windows のイベントログへのアクセスやカスタマイズが可能になります。EventLog を使用して、既存のログからの読み取り、ログへのエントリの書き込み、イベントソースの作成や削除、ログエントリへの応答などを行うことができます。また、イベントソースの作成時に新しいログを作成することもできます。

重要 :
EventLog オブジェクトを作成し、エントリを書き込んで、信頼性が一部しか確認されていないコードに EventLog オブジェクトを渡すと、セキュリティ上の問題が発生することがあります。信頼性の低いコードには、EventLogEntry オブジェクトや EventLogEntryCollection オブジェクトなどのイベントログオブジェクトを渡さないでください。

重要 :

EventLog オブジェクトを作成し、エントリを書き込んで、信頼性が一部しか確認されていないコードに EventLog オブジェクトを渡すと、セキュリティ上の問題が発生することがあります。信頼性の低いコードには、EventLogEntry オブジェクトや EventLogEntryCollection オブジェクトなどのイベントログオブジェクトを渡さないでください。

重要 :
NET Framework Version 1.0 および 1.1 では、このクラスは直接の呼び出し元に完全な信頼を要求します。Version 2.0 では、このクラスは EventLogPermission に特定のアクションを要求します。EventLogPermission で信頼性が一部しか確認されていないコードを許可しないようにすることをお勧めします。イベントログの読み取りと書き込みを行う機能を利用して、別のアプリケーションの名前でイベントログメッセージを発行するなどのアクションを実行できます。

重要 :

NET Framework Version 1.0 および 1.1 では、このクラスは直接の呼び出し元に完全な信頼を要求します。Version 2.0 では、このクラスは EventLogPermission に特定のアクションを要求します。EventLogPermission で信頼性が一部しか確認されていないコードを許可しないようにすることをお勧めします。イベントログの読み取りと書き込みを行う機能を利用して、別のアプリケーションの名前でイベントログメッセージを発行するなどのアクションを実行できます。

重要 :
イベントソースを作成または削除する場合、名前付きミューテックスを使用して基になるコードを同期する必要があります。高度な特権が付与されたアプリケーションが名前付きミューテックスをロックしている場合、イベントソースを作成または削除しようとすると、ロックが解除されるまでアプリケーションは応答を停止します。この問題を回避するために、信頼関係のないコードには UnmanagedCode アクセス許可を付与しないでください。また、UnmanagedCode アクセス許可を使用すると、他のアクセス許可をバイパスできる可能性もあるため、信頼度の高いコードにだけこのアクセス許可を付与する必要があります。

重要 :

イベントソースを作成または削除する場合、名前付きミューテックスを使用して基になるコードを同期する必要があります。高度な特権が付与されたアプリケーションが名前付きミューテックスをロックしている場合、イベントソースを作成または削除しようとすると、ロックが解除されるまでアプリケーションは応答を停止します。この問題を回避するために、信頼関係のないコードには UnmanagedCode アクセス許可を付与しないでください。また、UnmanagedCode アクセス許可を使用すると、他のアクセス許可をバイパスできる可能性もあるため、信頼度の高いコードにだけこのアクセス許可を付与する必要があります。

ログを読み取るには、EventLog に Log 名と MachineName (サーバーコンピュータ名) を指定します。ソースが必要なのはログに書き込む場合だけであるため、Source を指定する必要はありません。Entries メンバには、自動的にイベントログのエントリリストが設定されます。

メモ
Log/MachineName のペアを指定してログに接続している場合は、MachineName を指定する必要はありません。MachineName を指定しなかった場合は、ローカルコンピュータ "." が想定されます。

イベントログに書き込む場合は、イベント Source を指定するか、または作成する必要があります。新しいイベントソースを作成するには、コンピュータの管理者権限が必要です。Source は、アプリケーションを有効なソースとしてイベントログに登録します。Source は、同時に 1 つのログに書き込むときだけ使用できます。Source には任意のランダムな文字列を指定できますが、コンピュータの他のソースとは別の一意の名前である必要があります。通常、ソース名には、アプリケーション名またはその他の識別用文字列を使用します。重複する Source 値を作成しようとすると、例外がスローされます。ただし、単一のイベントログを複数のソースに関連付けることは可能です。

メモ
アプリケーションは、あらゆる登録済みのソース名で書き込みを行うことが可能で、これを防ぐ手段はありません。アプリケーションに Write アクセス許可が与えられている場合、コンピュータに登録されている有効なソースすべてに関するイベントを書き込むことができます。

アプリケーションおよびサービスは、アプリケーションログまたはカスタムログに書き込みます。デバイスドライバは、システムログに書き込みます。Log プロパティを明示的に設定しない場合、イベントログは既定のアプリケーションログに設定されます。

メモ
セキュリティログは読み取り専用です。

イベントをイベントログに書き込むには、WriteEvent と WriteEntry を使用します。イベントを書き込むには、イベントソースを指定することが必要です。イベントソースは、そのソースを持つ最初のエントリを書き込む前に作成および構成しておく必要があります。

アプリケーションのインストール時に新しいイベントソースを作成します。これにより、オペレーティングシステムが、登録されたイベントソースとその構成の一覧を更新するだけの時間的余裕が生まれます。イベントソースの一覧がオペレーティングシステムにより更新されていないとき、新しいソースでイベントを書き込もうとすると、書き込み操作が失敗します。新しいソースは、EventLogInstaller または CreateEventSource メソッドを使用して構成できます。新しいイベントソースを作成するには、コンピュータの管理者権限が必要です。

各ソースは同時に 1 つのログだけに登録できます。ただし、アプリケーションでは、複数のイベントログに書き込むために複数のソースが使用される場合があります。たとえば、アプリケーションには、異なるイベントログまたは異なるリソースファイル用に構成された複数のソースが必要になる場合があります。既存のソースの構成情報を変更するには、一度ソースを削除してから、新しい構成で作成し直す必要があります。他のアプリケーションまたはコンポーネントが既存のソースを使用している場合、既存のソースを削除するのではなく、更新された構成で新しいソースを作成します。

イベントカテゴリおよびメッセージ文字列用のローカライズされたリソースを持つイベントソースを登録できます。アプリケーションは、実際の文字列値を指定するのではなく、リソース識別子を使用してイベントログエントリを書き込むことができます。リソースファイルを使用したソースの構成については、EventLogInstaller クラスおよび EventSourceCreationData クラスのトピックを参照してください。

アプリケーションが文字列値をイベントログに直接書き込む場合は、ソースにリソースファイルのプロパティを設定する必要はありません。ソースは、ローカライズされたエントリを書き込むか、または直接の文字列を書き込むように構成されている必要があります。アプリケーションがリソース識別子と文字列値の両方を使用してエントリを書き込む場合、2 つの異なるソースを登録する必要があります。たとえば、複数のリソースファイルを持つ 1 つのソースを構成してから、WriteEvent メソッドでこのソースを使用し、リソース識別子によってエントリをイベントログに書き込みます。次に、リソースファイルを使わずに作成した別のソースを WriteEntry メソッドで使用し、そのソースを使って文字列を直接イベントログに書き込みます。

イベントを書き込む場合は、少なくともメッセージ文字列またはメッセージ文字列のリソース識別子を指定する必要があります。他のイベントプロパティは省略可能です。省略可能なイベント設定の例を次に示します。EventLogEntryType を設定して、イベントビューアがエントリに表示するアイコンを指定できます。アプリケーションがイベントのフィルタにカテゴリを使用する場合は、イベントのカテゴリ識別子を指定できます。追加情報を指定したイベントに関連付ける必要がある場合は、イベントエントリにバイナリデータを追加できます。

EventLog クラスは、個別のイベントログとそのエントリへのアクセスを提供するだけではなく、すべてのイベントログのコレクションへのアクセスも提供します。EventLog のstatic メンバを使用すると、ログの削除、ログリストの取得、ソースの作成または削除、特定のソースがコンピュータに既に存在するかどうかの確認などを行うことができます。

アプリケーションログ、システムログ、セキュリティログの 3 つの既定のイベントログがあります。Active Directory など、インストールされた他のアプリケーションやサービスでは追加のイベントログを使用できます。EventLog を使用してカスタムイベントログを作成できます。カスタムイベントログはサーバーのイベントビューアで表示できます。イベントビューアにイベントログのローカライズされた名前を表示させるには、RegisterDisplayName メソッドを使用します。最大ログサイズに達した場合のイベントログの動作を構成するには、ModifyOverflowPolicy メソッドを使用します。

イベントのログはディスク容量やプロセッサ時間、その他のシステムリソースを消費します。このため、必要な情報だけをログすることが重要です。パフォーマンスの低下を避けるために、イベントログの呼び出しはメインのコードパスではなくエラーパスに配置することをお勧めします。

EventLog のインスタンスの初期プロパティ値の一覧については、EventLog コンストラクタのトピックを参照してください。

Windows 98, Windows Millennium Edition プラットフォームメモ : イベントログは、Windows 98 または Windows Millennium Edition (Me) ではサポートされていません。

使用例

ソースが存在しない場合は MySource を作成し、イベントログ MyNewLog にエントリを書き込む例を次に示します。

Visual Basic

Option Explicit
Option Strict

Imports System
Imports System.Diagnostics
Imports System.Threading

Class MySample
    Public Shared Sub Main()
        
        ' Create the source, if it does not already exist.
        If Not EventLog.SourceExists("MySource")
 Then
            EventLog.CreateEventSource("MySource",
 "MyNewLog")
            Console.WriteLine("CreatingEventSource")
        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 'Main 
End Class 'MySample

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")){
            EventLog.CreateEventSource("MySource", "MyNewLog");
            Console.WriteLine("CreatingEventSource");
        }
                
        // 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.");
        
    }
}

C++

#using <System.dll>

using namespace System;
using namespace System::Diagnostics;
using namespace System::Threading;
int main()
{
   
   // Create the source, if it does not already exist.
   if (  !EventLog::SourceExists( "MySource" ) )
   {
      EventLog::CreateEventSource( "MySource", "MyNewLog" );
      Console::WriteLine( "CreatingEventSource" );
   }

   
   // Create an EventLog instance and assign its source.
   EventLog^ myLog = gcnew EventLog;
   myLog->Source = "MySource";
   
   // Write an informational entry to the event log.    
   myLog->WriteEntry( "Writing to event log." );
}

import System.*;
import System.Diagnostics.*;
import System.Threading.*;

class MySample
{
    public static void main(String[]
 args)
    {
        // Create the source, if it does not already exist.
        if (!(EventLog.SourceExists("MySource"))) {
            EventLog.CreateEventSource("MySource", "MyNewLog");
            Console.WriteLine("CreatingEventSource");
        }

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

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