Skip to content

Commit 2bc0fcf

Browse files
tot19claude
andcommitted
chore: Rename windows_eventlog to windows_event_log for consistency
Rename all occurrences of `windows_eventlog` to `windows_event_log`: - Feature flags in Cargo.toml - Source directory and module names - Internal events module - Configuration type name - Protocol name - Documentation URLs - Checkpoint filename This ensures consistent naming with underscores between words throughout the codebase and passes spellcheck validation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 9797b26 commit 2bc0fcf

File tree

14 files changed

+24
-24
lines changed

14 files changed

+24
-24
lines changed

Cargo.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ docs = ["api", "api-client", "enrichment-tables", "sinks", "sources", "sources-d
502502
default-cmake = ["api", "api-client", "enrichment-tables", "rdkafka?/cmake_build", "sinks", "sources", "sources-dnstap", "transforms", "unix", "rdkafka?/gssapi-vendored", "secrets"]
503503
# Default features for *-pc-windows-msvc
504504
# TODO: Enable SASL https://github.com/vectordotdev/vector/pull/3081#issuecomment-659298042
505-
default-msvc = ["api", "api-client", "enrichment-tables", "rdkafka?/cmake_build", "sinks", "sources", "sources-windows_eventlog", "transforms", "secrets"]
505+
default-msvc = ["api", "api-client", "enrichment-tables", "rdkafka?/cmake_build", "sinks", "sources", "sources-windows_event_log", "transforms", "secrets"]
506506
default-musl = ["api", "api-client", "enrichment-tables", "rdkafka?/cmake_build", "sinks", "sources", "sources-dnstap", "transforms", "unix", "rdkafka?/gssapi-vendored", "secrets"]
507507
default-no-api-client = ["api", "enrichment-tables", "sinks", "sources", "sources-dnstap", "transforms", "unix", "rdkafka?/gssapi-vendored", "secrets"]
508508
default-no-vrl-cli = ["api", "sinks", "sources", "sources-dnstap", "transforms", "unix", "rdkafka?/gssapi-vendored", "secrets"]
@@ -627,7 +627,7 @@ sources-logs = [
627627
"sources-syslog",
628628
"sources-vector",
629629
"sources-websocket",
630-
"sources-windows_eventlog",
630+
"sources-windows_event_log",
631631
]
632632
sources-metrics = [
633633
"dep:prost",
@@ -714,8 +714,8 @@ sources-utils-net-tcp = ["listenfd", "dep:ipnet"]
714714
sources-utils-net-udp = ["listenfd"]
715715
sources-utils-net-unix = []
716716
sources-websocket = ["dep:tokio-tungstenite"]
717-
sources-windows_eventlog = ["dep:windows", "dep:quick-xml", "dep:governor"]
718-
sources-windows_eventlog-integration-tests = ["sources-windows_eventlog"]
717+
sources-windows_event_log = ["dep:windows", "dep:quick-xml", "dep:governor"]
718+
sources-windows_event_log-integration-tests = ["sources-windows_event_log"]
719719

720720
sources-vector = ["dep:prost", "dep:tonic", "protobuf-build"]
721721

changelog.d/windows_eventlog_source.feature.md renamed to changelog.d/windows_event_log_source.feature.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
The `windows_eventlog` source allows collecting logs from Windows Event Log channels using the Windows Event Log API.
1+
The `windows_event_log` source allows collecting logs from Windows Event Log channels using the Windows Event Log API.
22

33
This Windows-specific source uses event-driven subscriptions to stream events in real-time with comprehensive security validation, configurable field filtering, and support for XPath event queries. Key features include:
44

55
- Support for multiple channels (System, Application, Security, and 140+ specialized channels)
6-
- Real-time event-driven subscriptions using EvtSubscribe API
6+
- Real-time event-driven subscriptions using the native Windows Event Log subscription API
77
- XPath query filtering for selective event collection
88
- Checkpoint persistence for reliable resumption after restarts (similar to journald)
99
- End-to-end acknowledgment support for at-least-once delivery guarantees
1010
- Configurable rate limiting to prevent overwhelming downstream systems
11-
- Configurable field truncation for storage optimization (Winlogbeat-compatible)
11+
- Configurable field truncation for storage optimization
1212
- Enhanced provider name extraction using proper XML parsing
1313
- Support for large events (up to 10MB)
1414
- Security hardening against XPath injection, resource exhaustion, and memory leaks
@@ -17,7 +17,7 @@ This Windows-specific source uses event-driven subscriptions to stream events in
1717

1818
New configuration options:
1919
- `events_per_second`: Rate limit event processing (0 = unlimited)
20-
- `max_event_data_length`: Truncate event data values (0 = no truncation, Winlogbeat default)
20+
- `max_event_data_length`: Truncate event data values (0 = no truncation)
2121
- `data_dir`: Directory for checkpoint persistence
2222

2323
Note: Wildcard channel patterns (e.g., `Microsoft-Windows-*`) are not supported. Specify exact channel names.

src/internal_events/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ mod websocket;
141141
mod websocket_server;
142142
#[cfg(feature = "transforms-window")]
143143
mod window;
144-
#[cfg(all(windows, feature = "sources-windows_eventlog"))]
145-
mod windows_eventlog;
144+
#[cfg(all(windows, feature = "sources-windows_event_log"))]
145+
mod windows_event_log;
146146

147147
#[cfg(any(
148148
feature = "sources-file",
@@ -293,8 +293,8 @@ pub(crate) use self::websocket_server::*;
293293
pub(crate) use self::window::*;
294294
#[cfg(windows)]
295295
pub(crate) use self::windows::*;
296-
#[cfg(all(windows, feature = "sources-windows_eventlog"))]
297-
pub(crate) use self::windows_eventlog::*;
296+
#[cfg(all(windows, feature = "sources-windows_event_log"))]
297+
pub(crate) use self::windows_event_log::*;
298298
pub use self::{
299299
adaptive_concurrency::*, batch::*, common::*, conditions::*, encoding_transcode::*,
300300
heartbeat::*, http::*, open::*, process::*, socket::*, tcp::*, template::*, udp::*,
File renamed without changes.

src/sources/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ pub mod syslog;
9494
pub mod vector;
9595
#[cfg(feature = "sources-websocket")]
9696
pub mod websocket;
97-
#[cfg(all(windows, feature = "sources-windows_eventlog"))]
98-
pub mod windows_eventlog;
97+
#[cfg(all(windows, feature = "sources-windows_event_log"))]
98+
pub mod windows_event_log;
9999

100100
pub mod util;
101101

src/sources/windows_eventlog/checkpoint.rs renamed to src/sources/windows_event_log/checkpoint.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use tracing::{debug, error, info, warn};
1414

1515
use super::error::WindowsEventLogError;
1616

17-
const CHECKPOINT_FILENAME: &str = "windows_eventlog_checkpoints.json";
17+
const CHECKPOINT_FILENAME: &str = "windows_event_log_checkpoints.json";
1818

1919
/// Checkpoint data for a single Windows Event Log channel
2020
///

src/sources/windows_eventlog/config.rs renamed to src/sources/windows_event_log/config.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ const MAX_CONNECTION_TIMEOUT_SECS: u64 = 3600;
1515
const MAX_EVENT_TIMEOUT_MS: u64 = 60000;
1616
const MAX_BATCH_SIZE: u32 = 10000;
1717

18-
/// Configuration for the `windows_eventlog` source.
18+
/// Configuration for the `windows_event_log` source.
1919
#[configurable_component(source(
20-
"windows_eventlog",
20+
"windows_event_log",
2121
"Collect logs from Windows Event Log channels using the Windows Event Log API."
2222
))]
2323
#[derive(Clone, Debug)]
File renamed without changes.

src/sources/windows_eventlog/integration_tests.rs renamed to src/sources/windows_event_log/integration_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#![cfg(feature = "sources-windows_eventlog-integration-tests")]
1+
#![cfg(feature = "sources-windows_event_log-integration-tests")]
22
#![cfg(test)]
33

44
use std::time::Duration;

0 commit comments

Comments
 (0)