From f0297a58cbc628c8f3911ca19421bb7b2ce5682a Mon Sep 17 00:00:00 2001
From: Fotis Voutsas <fotis@netdata.cloud>
Date: Mon, 21 Oct 2024 12:23:42 +0300
Subject: [PATCH] Add the Windows event logs integration to the meta (#18829)
* add the windows event logs integration to the meta
* remove extra word
* Apply suggestions from code review
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
---------
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
---
integrations/logs/metadata.yaml | 37 +++++++++++++++++++
.../windows-events.plugin/README.md | 2 +-
2 files changed, 38 insertions(+), 1 deletion(-)
diff --git a/integrations/logs/metadata.yaml b/integrations/logs/metadata.yaml
index 6338999623..42c3131713 100644
--- a/integrations/logs/metadata.yaml
+++ b/integrations/logs/metadata.yaml
@@ -36,3 +36,40 @@
prerequisites:
description: |
- A Netdata Cloud account
+- id: "windows-event-logs"
+ meta:
+ name: "Windows Event Logs"
+ link: "https://github.com/netdata/netdata/blob/master/src/collectors/windows-events.plugin/README.md"
+ categories:
+ - logs
+ - data-collection.windows-systems
+ icon_filename: "windows.svg"
+ keywords:
+ - windows
+ - windows events
+ - logs
+ overview:
+ description: |
+ The Windows Events plugin by Netdata makes viewing, exploring and analyzing Windows Events simple and
+ efficient.
+
+ The plugin automatically detects all the available channels and offers a list of "Event Channels".
+
+ By default, it aggregates events from all event channels, providing a unified view of all events.
+ visualization:
+ description: |
+ You can start exploring Windows event logs on the "Logs" tab of the Netdata UI.
+ key_features:
+ description: |
+ - Supports **Windows Event Logs (WEL)**.
+ - Supports **Event Tracing for Windows (ETW)** and **TraceLogging (TL)**, when events are routed to Event Log.
+ - Allows filtering on all System Events fields.
+ - Allows **full text search** (`grep`) on all System and User fields.
+ - Provides a **histogram** for log entries over time, with a break down per field-value, for any System Event field and any
+ time-frame.
+ - Supports coloring log entries based on severity.
+ - In PLAY mode it "tails" all the Events, showing new log entries immediately after they are received.
+ setup:
+ prerequisites:
+ description: |
+ - Netdata Cloud paid subscription
diff --git a/src/collectors/windows-events.plugin/README.md b/src/collectors/windows-events.plugin/README.md
index 8e05a79b6b..ecaa4349ab 100644
--- a/src/collectors/windows-events.plugin/README.md
+++ b/src/collectors/windows-events.plugin/README.md
@@ -31,7 +31,7 @@ For more information check [this discussion](https://github.com/netdata/netdata/
The plugin automatically detects all the available channels and offers a list of "Event Channels".
-By default, it aggregates events from all event channels, providing a unified systems view of all events.
+By default, it aggregates events from all event channels, providing a unified view of all events.
> To improve query performance, we recommend selecting the relevant event channels, before doing more
> analysis on the events.