EventLogApi 1.0.0

📝 EventLogApi

A simple, robust Windows Event Log API for .NET.
Provides helpers to write, read, and watch Windows Event Logs with clean, strongly typed APIs.

✨ Features

• 🔹 Write to Windows Event Log

  • Info / Warning / Error helpers
  • Structured JSON payloads
  • Exception logging with stacktrace
  • Auto-create event sources (requires Admin once)

• 🔹 Read from Windows Event Log

  • Query options: time filter, severity, sources, message contains
  • Returns clean EventRecordDto objects
  • Supports Application, System, Security, and custom logs

• 🔹 Watch Windows Event Logs

  • Event-based API using EventLogWatcher
  • Supports XPath filters (e.g., errors only)

• 🛡️ Full error handling (EventLogApiException)

• 💻 Windows-only (net8.0-windows7.0)

📦 Installation

Install via NuGet:

dotnet add package EventLogApi

Or add to .csproj:

<PackageReference Include="EventLogApi" Version="1.0.0" />

🚀 Quick Start

Write to Event Log

using EventLogApi;

var opts = new WriteOptions
{
    Source = "EventLogApi.Demo",
    LogName = "Application",
    AutoCreateSource = true // requires admin the first time
};

EventLogWriter.Info("Hello from EventLogApi!", opts);
EventLogWriter.Warn("Heads-up warning!", opts);
EventLogWriter.Error("Something went wrong!", opts);

try
{
    throw new InvalidOperationException("Demo exception");
}
catch (Exception ex)
{
    EventLogWriter.WriteException(ex, "Caught exception", opts);
}

EventLogWriter.WriteStructured(
    "User {UserId} performed {Action}",
    new { UserId = 42, Action = "Login" },
    EventSeverity.Information,
    opts);

Read from Event Log

var q = new QueryOptions
{
    LogName = "Application",
    MaxEvents = 10,
    ContainsText = "EventLogApi",
    NewestFirst = true
};

var events = EventLogReader.Read(q);
foreach (var e in events)
{
    Console.WriteLine($"{e.TimeCreated:u} [{e.LevelDisplayName}] {e.ProviderName} - {e.Message}");
}

Watch Event Log (Errors only)

using var watcher = new EventLogWatcherService("Application", ".", "*[System/Level=2]");
watcher.OnEvent += e =>
{
    Console.WriteLine($"[ERROR] {e.TimeCreated:u} {e.ProviderName}: {e.Message}");
};
watcher.OnError += ex =>
{
    Console.WriteLine($"Watcher error: {ex.Message}");
};
watcher.Start();

Console.ReadKey(); // keep alive

🖥️ Requirements

• Windows 7 or later
• .NET 6/7/8 (Windows-specific TFM: net8.0-windows7.0)
• Admin rights may be required for some logs (Security, source creation)

📜 License

MIT License – free for commercial and open source use.

🔗 Links

• GitHub: https://github.com/TristanAtze/EventLogApi
• NuGet: https://www.nuget.org/packages/EventLogApi