Skip to content

Commit ee3a38f

Browse files
committed
docs: updates system, windows, winlog integrations
1 parent c14efbf commit ee3a38f

File tree

6 files changed

+54
-0
lines changed

6 files changed

+54
-0
lines changed

packages/system/_dev/build/docs/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ Then, you could view real-time updates to disk space used on your system in Kiba
1212
You could also set up a new rule in the Elastic Observability Metrics app to alert you when the percent free is
1313
less than 10% of the total disk space.
1414

15+
## Choosing the right integration for Windows event logs
16+
17+
If you're collecting Windows event logs, note that there are three related integrations:
18+
19+
- **System integration** (this integration): Collects logs from the Windows `Application`, `System`, and `Security` channels with specialized ingest pipelines optimized for observability use cases.
20+
- **[Windows integration](https://www.elastic.co/docs/reference/integrations/windows)**: Collects logs from Windows-specific channels like PowerShell, Sysmon, Windows Defender, and AppLocker with specialized security-focused ingest pipelines. Use this for security monitoring and advanced Windows telemetry.
21+
- **[Custom Windows event log package](https://www.elastic.co/docs/reference/integrations/winlog)**: Collects logs from any user-defined Windows event log channel. Use this when you need to collect from channels not covered by the System or Windows integrations. Note that this integration does not include specialized ingest pipelines—you'll need to create custom pipelines if additional processing is required.
22+
1523
## Data streams
1624

1725
The System integration collects two types of data: logs and metrics.

packages/system/docs/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ Then, you could view real-time updates to disk space used on your system in Kiba
1212
You could also set up a new rule in the Elastic Observability Metrics app to alert you when the percent free is
1313
less than 10% of the total disk space.
1414

15+
## Choosing the right integration for Windows event logs
16+
17+
If you're collecting Windows event logs, note that there are three related integrations:
18+
19+
- **System integration** (this integration): Collects logs from the Windows `Application`, `System`, and `Security` channels with specialized ingest pipelines optimized for observability use cases.
20+
- **[Windows integration](https://www.elastic.co/docs/reference/integrations/windows)**: Collects logs from Windows-specific channels like PowerShell, Sysmon, Windows Defender, and AppLocker with specialized security-focused ingest pipelines. Use this for security monitoring and advanced Windows telemetry.
21+
- **[Custom Windows event log package](https://www.elastic.co/docs/reference/integrations/winlog)**: Collects logs from any user-defined Windows event log channel. Use this when you need to collect from channels not covered by the System or Windows integrations. Note that this integration does not include specialized ingest pipelines—you'll need to create custom pipelines if additional processing is required.
22+
1523
## Data streams
1624

1725
The System integration collects two types of data: logs and metrics.

packages/windows/_dev/build/docs/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ Then visualize that data in Kibana, create alerts to notify you if something goe
88
For example, if you wanted to know if a Windows service unexpectedly stops running, you could install the Windows integration to send service metrics to Elastic.
99
Then, you could view real-time changes to service status in Kibana's _[Metrics Windows] Services_ dashboard.
1010

11+
## Choosing the right integration for Windows event logs
12+
13+
If you're collecting Windows event logs, note that there are three related integrations:
14+
15+
- **[System integration](https://www.elastic.co/docs/reference/integrations/system)**: Collects logs from the Windows `Application`, `System`, and `Security` channels with specialized ingest pipelines optimized for observability use cases.
16+
- **Windows integration** (this integration): Collects logs from Windows-specific channels like PowerShell, Sysmon, Windows Defender, and AppLocker with specialized security-focused ingest pipelines. Use this for security monitoring and advanced Windows telemetry.
17+
- **[Custom Windows Event Logs integration](https://www.elastic.co/docs/reference/integrations/winlog)**: Collects logs from any user-defined Windows event log channel without specialized pipelines.
18+
1119
## Data streams
1220

1321
The Windows integration collects two types of data: logs and metrics.

packages/windows/docs/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ Then visualize that data in Kibana, create alerts to notify you if something goe
88
For example, if you wanted to know if a Windows service unexpectedly stops running, you could install the Windows integration to send service metrics to Elastic.
99
Then, you could view real-time changes to service status in Kibana's _[Metrics Windows] Services_ dashboard.
1010

11+
## Choosing the right integration for Windows event logs
12+
13+
If you're collecting Windows event logs, note that there are three related integrations:
14+
15+
- **[System integration](https://www.elastic.co/docs/reference/integrations/system)**: Collects logs from the Windows `Application`, `System`, and `Security` channels with specialized ingest pipelines optimized for observability use cases.
16+
- **Windows integration** (this integration): Collects logs from Windows-specific channels like PowerShell, Sysmon, Windows Defender, and AppLocker with specialized security-focused ingest pipelines. Use this for security monitoring and advanced Windows telemetry.
17+
- **[Custom Windows Event Logs integration](https://www.elastic.co/docs/reference/integrations/winlog)**: Collects logs from any user-defined Windows event log channel without specialized pipelines.
18+
1119
## Data streams
1220

1321
The Windows integration collects two types of data: logs and metrics.

packages/winlog/_dev/build/docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ You can get a list of available event log channels by running [`Get-WinEvent -Li
55
If `Get-WinEvent` is not available, [`Get-EventLog *`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/get-eventlog) may be used.
66
Custom ingest pipelines may be added by setting one up in [Ingest Node Pipelines](/app/management/ingest/ingest_pipelines/).
77

8+
## Choosing the right integration for Windows event logs
9+
10+
Use the Custom Windows event logs integration when you need to collect events from Windows event log channels that are not covered by the prebuilt integrations. This integration provides flexibility, but does not include specialized ingest pipelines—the data is collected in its raw form.
11+
12+
**Before using this integration**, check if one of these alternatives better fits your use case:
13+
14+
- **[System integration](https://www.elastic.co/docs/reference/integrations/system)**: Collects from the `Application`, `System`, and `Security` channels with specialized ingest pipelines that enrich the data for observability dashboards and alerting.
15+
- **[Windows integration](https://www.elastic.co/docs/reference/integrations/windows)**: Collects from PowerShell, Sysmon, Windows Defender, AppLocker, and ForwardedEvents channels with security-focused ingest pipelines.
16+
17+
Using the System or Windows integrations for their supported channels provides better out-of-the-box value because their ingest pipelines parse and enrich the event data, making it more useful for dashboards, searches, and security detections.
18+
819
## Configuration
920

1021
### Windows Event ID clause limit

packages/winlog/docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ You can get a list of available event log channels by running [`Get-WinEvent -Li
55
If `Get-WinEvent` is not available, [`Get-EventLog *`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/get-eventlog) may be used.
66
Custom ingest pipelines may be added by setting one up in [Ingest Node Pipelines](/app/management/ingest/ingest_pipelines/).
77

8+
## Choosing the right integration for Windows event logs
9+
10+
Use the Custom Windows event logs integration when you need to collect events from Windows event log channels that are not covered by the prebuilt integrations. This integration provides flexibility, but does not include specialized ingest pipelines—the data is collected in its raw form.
11+
12+
**Before using this integration**, check if one of these alternatives better fits your use case:
13+
14+
- **[System integration](https://www.elastic.co/docs/reference/integrations/system)**: Collects from the `Application`, `System`, and `Security` channels with specialized ingest pipelines that enrich the data for observability dashboards and alerting.
15+
- **[Windows integration](https://www.elastic.co/docs/reference/integrations/windows)**: Collects from PowerShell, Sysmon, Windows Defender, AppLocker, and ForwardedEvents channels with security-focused ingest pipelines.
16+
17+
Using the System or Windows integrations for their supported channels provides better out-of-the-box value because their ingest pipelines parse and enrich the event data, making it more useful for dashboards, searches, and security detections.
18+
819
## Configuration
920

1021
### Windows Event ID clause limit

0 commit comments

Comments
 (0)