Skip to content

Commit 6df1314

Browse files
committed
add global queries to user manual documentation
1 parent ecfff36 commit 6df1314

File tree

4 files changed

+87
-0
lines changed

4 files changed

+87
-0
lines changed
60.4 KB
Loading
215 KB
Loading
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
.. Copyright (C) 2015, Wazuh, Inc.
2+
3+
.. meta::
4+
:description: Wazuh global queries allow users to search and visualize global state data directly on the Wazuh dashboard. Learn more in this section of the documentation.
5+
6+
Wazuh global queries
7+
====================
8+
9+
Wazuh global queries allow users to search and visualize global state data directly on the Wazuh dashboard. Global state data represents aggregated information collected from all monitored endpoints, stored centrally in the Wazuh indexer under dedicated indices. This provides a comprehensive view of system configurations, installed software, vulnerabilities, and other critical details.
10+
11+
Previously, users could only retrieve inventory and vulnerability information per agent. With global queries, all relevant data is collected and centralized in the Wazuh indexer. This enables users to view and analyze system inventory and vulnerability information for all monitored endpoints from one single place. This centralization improves monitoring efficiency, streamlines threat hunting, and accelerates incident response.
12+
13+
How it works
14+
------------
15+
16+
Wazuh agents run modules such as the Syscollector module, which periodically collect system inventory data from monitored endpoints. This includes running processes, network interfaces, software packages, and more.
17+
18+
The Wazuh agents forward this data securely to the Wazuh manager using protocols such as ``wazuh-remoted`` and ``wazuh-db``. The Wazuh Inventory Harvester module on the Wazuh manager processes the incoming data and standardizes it using Wazuh Common Schemas (WCS). It then forwards the processed data to the Wazuh indexer, where it is stored as global state data.
19+
20+
This data is stored under dedicated indices for each data type, so users can efficiently run targeted queries and generate visualizations directly on the dashboard. For example, the vulnerabilities inventory is indexed as ``wazuh-states-vulnerabilities-*``. It is also part of the global state data and provides up-to-date information about discovered endpoint vulnerabilities.
21+
22+
The image below illustrates how the Wazuh global queries feature works.
23+
24+
.. thumbnail:: /images/wazuh-dashboard/global-queries/illustration.png
25+
:align: center
26+
:width: 80%
27+
:title: Wazuh global queries workflow
28+
:alt: Wazuh global queries workflow
29+
30+
Wazuh Inventory Harvester module
31+
--------------------------------
32+
33+
The Wazuh Inventory Harvester module on the Wazuh manager processes the collected data in sequential steps:
34+
35+
1. **Message ingestion**: The Wazuh manager receives data from the Wazuh Syscollector module via the :doc:`wazuh-remoted </user-manual/reference/daemons/wazuh-remoted>` and :doc:`wazuh-db </user-manual/reference/daemons/wazuh-db>` protocols. These messages are transformed into FlatBuffer messages, a compact format designed for fast and efficient communication between Wazuh components for processing.
36+
37+
2. **Deserialization and validation**: The FlatBuffer messages are converted into native data structures and validated against the Wazuh Common Schema (WCS). This ensures all data maintains a consistent structure, format, and integrity.
38+
39+
3. **Batching and forwarding:** The validated data is grouped into batches for performance. These batches are forwarded in bulk from the Wazuh manager to the Wazuh indexer for storage.
40+
41+
4. **Storage**: The data is stored in a dedicated global state index for each data type, following Wazuh Common Schemas (WCS). This logical separation allows for efficient and targeted queries.
42+
43+
5. **Monitoring and feedback**: The module reports any indexing issues or failures for retries or error handling.
44+
45+
Indexing
46+
--------
47+
48+
The Wazuh indexer organizes global state data into indices, each representing a category of information collected by Wazuh modules. These indices enable precise queries and visualizations in the Wazuh dashboard. The global state data indices are outlined below:
49+
50+
.. list-table::
51+
:header-rows: 1
52+
:widths: 40 60
53+
54+
* - Index Pattern
55+
- Description
56+
* - ``wazuh-states-inventory-hardware-*``
57+
- Basic information about hardware components on a monitored endpoint.
58+
* - ``wazuh-states-inventory-hotfixes-*``
59+
- Updates installed on a Windows endpoint.
60+
* - ``wazuh-states-inventory-interfaces-*``
61+
- Status and packet transfer information for network interfaces.
62+
* - ``wazuh-states-inventory-networks-*``
63+
- IPv4 and IPv6 addresses for each network interface.
64+
* - ``wazuh-states-inventory-packages-*``
65+
- Currently installed software packages on an endpoint.
66+
* - ``wazuh-states-inventory-ports-*``
67+
- Open network ports on a monitored endpoint.
68+
* - ``wazuh-states-inventory-processes-*``
69+
- System processes running on a monitored endpoint.
70+
* - ``wazuh-states-inventory-protocols-*``
71+
- Network routing configuration details and protocols per interface.
72+
* - ``wazuh-states-inventory-system-*``
73+
- Operating system, hostname, and architecture on an endpoint.
74+
* - ``wazuh-states-vulnerabilities-*``
75+
- Information about vulnerabilities detected on a monitored endpoint.
76+
77+
Querying and visualization
78+
--------------------------
79+
80+
Users can query and visualize global state data directly from the Wazuh dashboard. The centralized and enriched index structure enables prompt reporting, compliance checks, and detection of risks across the environment.
81+
82+
.. thumbnail:: /images/wazuh-dashboard/global-queries/query-and-visualization.png
83+
:align: center
84+
:width: 80%
85+
:title: Global queries visualization
86+
:alt: Global queries visualization

source/user-manual/wazuh-dashboard/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,6 @@ The following section provides an overview of the Wazuh dashboard, covering topi
3333
configuring-third-party-certs/index
3434
custom-branding
3535
settings
36+
global-queries
3637
troubleshooting
3738
certificates

0 commit comments

Comments
 (0)