Skip to content

Commit 4bb210d

Browse files
authored
winlog: improve documentation for obtaining channel names (#5689)
1 parent 28f80e3 commit 4bb210d

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Custom Windows event log package
22

3-
The custom Windows event log package allows you to ingest events from
4-
any [Windows event log](https://docs.microsoft.com/en-us/windows/win32/wes/windows-event-log) channel. You can get a list of available event
5-
log channels by running `Get-EventLog *` in PowerShell. Custom ingest
6-
pipelines may be added by setting one up in
7-
[Ingest Node Pipelines](/app/management/ingest/ingest_pipelines/).
3+
The custom Windows event log package allows you to ingest events from any [Windows event log](https://docs.microsoft.com/en-us/windows/win32/wes/windows-event-log) channel.
4+
You can get a list of available event log channels by running [`Get-WinEvent -ListLog * | Format-List -Property LogName`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.diagnostics/get-winevent) in PowerShell on Windows Vista or newer.
5+
If `Get-WinEvent` is not available, [`Get-EventLog *`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/get-eventlog) may be used.
6+
Custom ingest pipelines may be added by setting one up in [Ingest Node Pipelines](/app/management/ingest/ingest_pipelines/).
87

98
## Configuration
109

packages/winlog/changelog.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# newer versions go on top
2+
- version: "1.12.4"
3+
changes:
4+
- description: Improve documentation for listing event log channels.
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/5689
27
- version: "1.12.3"
38
changes:
49
- description: Added categories and/or subcategories.

packages/winlog/docs/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Custom Windows event log package
22

3-
The custom Windows event log package allows you to ingest events from
4-
any [Windows event log](https://docs.microsoft.com/en-us/windows/win32/wes/windows-event-log) channel. You can get a list of available event
5-
log channels by running `Get-EventLog *` in PowerShell. Custom ingest
6-
pipelines may be added by setting one up in
7-
[Ingest Node Pipelines](/app/management/ingest/ingest_pipelines/).
3+
The custom Windows event log package allows you to ingest events from any [Windows event log](https://docs.microsoft.com/en-us/windows/win32/wes/windows-event-log) channel.
4+
You can get a list of available event log channels by running [`Get-WinEvent -ListLog * | Format-List -Property LogName`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.diagnostics/get-winevent) in PowerShell on Windows Vista or newer.
5+
If `Get-WinEvent` is not available, [`Get-EventLog *`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/get-eventlog) may be used.
6+
Custom ingest pipelines may be added by setting one up in [Ingest Node Pipelines](/app/management/ingest/ingest_pipelines/).
87

98
## Configuration
109

packages/winlog/manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: winlog
33
title: Custom Windows Event Logs
44
description: Collect and parse logs from any Windows event log channel with Elastic Agent.
55
type: integration
6-
version: "1.12.3"
6+
version: "1.12.4"
77
release: ga
88
conditions:
99
kibana.version: '^7.16.0 || ^8.0.0'

0 commit comments

Comments
 (0)