From ac7ff773042ef46a6ce9c2b00679ce5a1ecc0bb2 Mon Sep 17 00:00:00 2001
From: Mirko Bez <mirko.bez@elastic.co>
Date: Fri, 13 Dec 2024 11:17:15 +0100
Subject: [PATCH] Add first draft of the documentation

---
 .../module/windows/wmi/_meta/docs.asciidoc    | 45 ++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/metricbeat/module/windows/wmi/_meta/docs.asciidoc b/metricbeat/module/windows/wmi/_meta/docs.asciidoc
index b598d4f916b..94dc73b67f0 100644
--- a/metricbeat/module/windows/wmi/_meta/docs.asciidoc
+++ b/metricbeat/module/windows/wmi/_meta/docs.asciidoc
@@ -1 +1,44 @@
-This is the wmi metricset of the module windows.
+The `wmi` metricset of the Windows module reads metrics via Windows Management Instrumentation  link:https://learn.microsoft.com/en-us/windows/win32/wmisdk/about-wmi[(WMI)], a core management technology in the Windows Operating system.
+
+By leveraging WMI Query Language (WQL), this metricset allows you to extract detailed
+system information and metrics to monitor the health and performance of Windows
+Systems.
+
+This metricset leverages the link:https://github.com/microsoft/wmi[Microsoft WMI], library a
+convenient wrapper around the link:https://github.com/go-ole[GO-OLE] library which allows to
+invoke the WMI Api.
+
+=== WMI Query Language (WQL) Support
+
+This metricset supports the execution of link:https://learn.microsoft.com/en-us/windows/win32/wmisdk/wql-sql-for-wmi[WQL] queries, a SQL-like query language for retrieving information from WMI namespaces.
+
+As of now, we only support and execute queries with `SELECT`, `FROM` and `WHERE` clauses.
+
+=== Configuration
+
+[source,yaml]
+----
+- module: windows
+  metricsets: ["wmi"]
+  period: 60s
+  namespace: "root\\cimv2" # Namespace
+  queries:
+  - class: Win32_OperatingSystem
+    fields:
+    - FreePhysicalMemory
+    - FreeSpaceInPaginFiles
+    - NumberOfUsers
+    # Where Clasue
+    where: ""
+----
+
+[float]
+=== Compatibility
+
+This module has been tested on the following platform:
+
+- Operating System: Microsoft Windows Server 2019 Datacenter
+- Architecture: x86
+
+Other Windows versions and architectures may also work but have not been explicitly tested.
+