#logging #windows #eventlog

winlog

A simple Rust log backend to send messages to the Windows event log

1 unstable release

0.1.0 Sep 29, 2018

#89 in #logging

Download history 26/week @ 2018-10-04 10/week @ 2018-10-11 39/week @ 2018-10-18 6/week @ 2018-10-25 10/week @ 2018-11-01 36/week @ 2018-11-08 8/week @ 2018-11-15 7/week @ 2018-11-22 32/week @ 2018-11-29 43/week @ 2018-12-06

1 downloads per month

MIT/Apache

14KB
209 lines

winlog

Latest version License

A simple Rust log backend to send messages to the Windows event log.

  • Writes Rust log messages to the Windows event log using the RegisterEventSourceW and ReportEventW APIs.
  • Provides utility functions to register/unregister your event source in the Windows registry.
  • Embeds a small (120-byte) message resource library containing the necessary log message templates in your executable.
  • Does not panic.

The five Rust log levels are mapped to Windows event types as follows:

Rust Log Level Windows Event Type Windows Event Id
Error Error 1
Warn Warning 2
Info Informational 3
Debug Informational 4
Trace Informational 5

Requirements

  • Rust stable (tested on 1.29)
  • Windows
  • (optional) PowerShell (used for the end-to-end test)
  • (optional) mc.exe and rc.exe (only required when eventmsgs.mc is changed)

Usage

Add to cargo.toml:

[dependencies]
winlog = "*"

Register the log source in the Windows registry:

winlog::register("Example Log"); // silently ignores errors
// or
winlog::try_register("Example Log").unwrap();

This usually requires Administrator permission so this is usually done during installation time. If your MSI installer (or similar) registers your event sources you should not call this.

Use the winlog backend:

winlog::init("Example Log").unwrap();
info!("Hello, Event Log");

Deregister the log source:

winlog::deregister("Example Log"); // silently ignores errors
// or
winlog::try_deregister("Example Log").unwrap();

This is usually done during program uninstall. If your MSI installer (or similar) deregisters your event sources you should not call this.

Building

cargo build --release

Internals

Artifacts eventmsgs.lib and eventmsgs.rs are under source control so users don't need to have mc.exe and rc.exe installed for a standard build.

  1. If build.rs determines that eventmsgs.mc was changed then build.rs:
    • invokes mc.exe (which creates eventmsgs.h)
    • invokes rc.exe (which creates eventmsgs.lib)
    • creates eventmsgs.rs from eventmsgs.h.
  2. build.rs emits linker flags so eventmsgs.lib can found.
  3. Standard cargo build follows.

Testing

The end-to-end test requires 'Full Control' permissions on the HKLM\SYSTEM\CurrentControlSet\Services\EventLog\Application registry key.

cargo test

Process:

  1. Create a unique temporary event source name (winlog-test-###########).
  2. Register our compiled test executable as EventMessageFile for the event source in the Windows registry. You can see a new key at HKLM\SYSTEM\CurrentControlSet\Services\EventLog\Application\winlog-test-###########.
  3. Write some log messages to the event source.
  4. Use PowerShell to retrieve the logged messages.
  5. Deregister our event source. This removes the winlog-test-########### registry key.
  6. Assert that the retrieved log messages are correct.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~1MB

  • build build.rs
  • build regex 1.0
  • dev rand 0.5