diff --git a/pipeline/inputs/windows-exporter-metrics.md b/pipeline/inputs/windows-exporter-metrics.md index a5add77ac..8967594ab 100644 --- a/pipeline/inputs/windows-exporter-metrics.md +++ b/pipeline/inputs/windows-exporter-metrics.md @@ -1,112 +1,74 @@ --- -description: >- - A plugin based on Prometheus Windows Exporter to collect system / host level - metrics +description: A plugin based on Prometheus Windows Exporter to collect system and host level metrics --- -# Windows Exporter Metrics +# Windows Exporter metrics -[Prometheus Windows Exporter](https://github.com/prometheus-community/windows_exporter) is a popular way to collect system level metrics from microsoft windows, such as CPU / Disk / Network / Process statistics. Included since Fluent Bit 1.9.0, windows exporter metrics plugin builds off the Prometheus design to collect system level metrics without having to manage two separate processes or agents. +[Prometheus Windows Exporter](https://github.com/prometheus-community/windows_exporter) is a popular way to collect system level metrics from Microsoft Windows, such as CPU, Disk, Network, and Process statistics. Fluent Bit 1.9.0 and later includes the Windows Exporter metrics plugin that builds off the Prometheus design to collect system level metrics without having to manage two separate processes or agents. -The initial release of Windows Exporter Metrics contains a single collector available from Prometheus Windows Exporter. +The initial release of Windows Exporter metrics contains a single collector available from Prometheus Windows Exporter. -{% hint style="warning" %} - -**Important note:** Metrics collected with Windows Exporter Metrics flow through a separate pipeline from logs and current filters do not operate on top of metrics. - -{% endhint %} +Metrics collected with Windows Exporter metrics flow through a separate pipeline from logs and current filters don't operate on top of metrics. ## Configuration | Key | Description | Default | | --------------- | ---------------------------------------------------------------------- | --------- | -| scrape\_interval | The rate at which metrics are collected from the host operating system | 5 seconds | -| we.logical\_disk.allow\_disk\_regex | Specify the regex for logical disk metrics to allow collection of. Collect all by default. | "/.+/" | -| we.logical\_disk.deny\_disk\_regex | Specify the regex for logical disk metrics to prevent collection of/ignore. Allow all by default. | `NULL` | -|we.net.allow\_nic\_regex | Specify the regex for network metrics captured by the name of the NIC, by default captures all NICs but to exclude adjust the regex. | "/.+/" | -| we.service.where | Specify the WHERE clause for retrieving service metrics. | `NULL` | -| we.service.include | Specify the key value pairs for the include condition for the WHERE clause of service metrics. | `NULL` | -| we.service.exclude | Specify the key value pairs for the exclude condition for the WHERE clause of service metrics. | `NULL` | -| we.process.allow\_process\_regex | Specify the regex covering the process metrics to collect. Collect all by default. | "/.+/" | -| we.process.deny\_process\_regex | Specify the regex for process metrics to prevent collection of/ignore. Allow all by default. | `NULL` | -| collector.cpu.scrape\_interval | The rate in seconds at which cpu metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.net.scrape\_interval | The rate in seconds at which net metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.logical_disk.scrape\_interval | The rate in seconds at which logical\_disk metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.cs.scrape\_interval | The rate in seconds at which cs metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.os.scrape\_interval | The rate in seconds at which os metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.thermalzone.scrape\_interval | The rate in seconds at which thermalzone metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used.| 0 seconds | -| collector.cpu\_info.scrape\_interval | The rate in seconds at which cpu\_info metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.logon.scrape\_interval | The rate in seconds at which logon metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.system.scrape\_interval | The rate in seconds at which system metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.service.scrape\_interval | The rate in seconds at which service metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.memory.scrape\_interval | The rate in seconds at which memory metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.paging_file.scrape\_interval | The rate in seconds at which paging_file metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| collector.process.scrape\_interval | The rate in seconds at which process metrics are collected from the host operating system. If a value greater than 0 is used then it overrides the global default otherwise the global default is used. | 0 seconds | -| metrics | To specify which metrics are collected from the host operating system. | `"cpu,cpu_info,os,net,logical_disk,cs,thermalzone,logon,system,service"` | +| `scrape_interval` | The rate at which metrics are collected. | `5 seconds` | +| `we.logical_disk.allow_disk_regex` | Specify the regular expression for logical disk metrics to allow collection of. | `"/.+/"` (all) | +| `we.logical_disk.deny_disk_regex` | Specify the regular expression for logical disk metrics to prevent collection of or ignore. | `NULL` (all) | +| `we.net.allow_nic_regex` | Specify the regular expression for network metrics captured by the name of the NIC. | `"/.+/"` (all) | +| `we.service.where` | Specify the `WHERE` clause for retrieving service metrics. | `NULL` | +| `we.service.include` | Specify the key value pairs for the include condition for the `WHERE` clause of service metrics. | `NULL` | +| `we.service.exclude` | Specify the key value pairs for the exclude condition for the `WHERE` clause of service metrics. | `NULL` | +| `we.process.allow_process_regex` | Specify the regular expression covering the process metrics to collect. | `"/.+/"` (all) | +| `we.process.deny_process_regex` | Specify the regular expression for process metrics to prevent collection of or ignore. | `NULL` (all) | +| `collector.cpu.scrape_interval` | The rate in seconds at which `cpu` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.net.scrape_interval` | The rate in seconds at which `net` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.logical_disk.scrape_interval` | The rate in seconds at which `logical_disk` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.cs.scrape_interval` | The rate in seconds at which `cs` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.os.scrape_interval`| The rate in seconds at which `os` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.thermalzone.scrape_interval`| The rate in seconds at which `thermalzone` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.cpu_info.scrape_interval`| The rate in seconds at which `cpu_info` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.logon.scrape_interval` | The rate in seconds at which `logon` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.system.scrape_interval` | The rate in seconds at which `system` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.service.scrape_interval` | The rate in seconds at which `service` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.memory.scrape_interval` | The rate in seconds at which `memory` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.paging_file.scrape_interval` | The rate in seconds at which `paging_file` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `collector.process.scrape_interval` | The rate in seconds at which `process` metrics are collected. Values greater than `0` override the global default. Otherwise, the global default is used. | `0 seconds` | +| `metrics` | Specify which metrics are collected. | `"cpu,cpu_info,os,net,logical_disk,cs,thermalzone,logon,system,service"` | ## Collectors available -The following table describes the available collectors as part of this plugin. All of them are enabled by default and respects the original metrics name, descriptions, and types from Prometheus Windows Exporter, so you can use your current dashboards without any compatibility problem. +The following table describes the available collectors as part of this plugin. All collectors are enabled by default and respect the original metrics name, descriptions, and types from Prometheus Windows Exporter, so you can use your current dashboards without any compatibility problem. -> note: the Version column specifies the Fluent Bit version where the collector is available. +The Version column specifies the Fluent Bit version where the collector is available. | Name | Description | OS | Version | | ------------- | ------------------------------------------------------------------------------------------------ | ------- | ------- | -| cpu | Exposes CPU statistics. | Windows | v1.9 | -| net | Exposes Network statistics. | Windows | v2.0.8 | -| logical\_disk | Exposes logical\_disk statistics. | Windows | v2.0.8 | -| cs | Exposes cs statistics. | Windows | v2.0.8 | -| os | Exposes OS statistics. | Windows | v2.0.8 | -| thermalzone | Exposes thermalzone statistics. | Windows | v2.0.8 | -| cpu\_info | Exposes cpu\_info statistics. | Windows | v2.0.8 | -| logon | Exposes logon statistics. | Windows | v2.0.8 | -| system | Exposes system statistics. | Windows | v2.0.8 | -| service | Exposes service statistics. | Windows | v2.1.6 | -| memory | Exposes memory statistics. | Windows | v2.1.9 | -| paging\_file | Exposes paging\_file statistics. | Windows | v2.1.9 | -| process | Exposes process statistics. | Windows | v2.1.9 | +| `cpu` | Exposes CPU statistics. | Windows | v1.9 | +| `net` | Exposes Network statistics. | Windows | v2.0.8 | +| `logical_disk` | Exposes `logical_disk` statistics. | Windows | v2.0.8 | +| `cs` | Exposes `cs` statistics. | Windows | v2.0.8 | +| `os` | Exposes OS statistics. | Windows | v2.0.8 | +| `thermalzone` | Exposes `thermalzone` statistics. | Windows | v2.0.8 | +| `cpu_info` | Exposes `cpu_info` statistics. | Windows | v2.0.8 | +| `logon` | Exposes `logon` statistics. | Windows | v2.0.8 | +| `system` | Exposes `system` statistics. | Windows | v2.0.8 | +| `service` | Exposes `service` statistics. | Windows | v2.1.6 | +| `memory` | Exposes `memory` statistics. | Windows | v2.1.9 | +| `paging_file` | Exposes `paging_file` statistics. | Windows | v2.1.9 | +| `process` | Exposes `process` statistics. | Windows | v2.1.9 | ## Threading This input always runs in its own [thread](../../administration/multithreading.md#inputs). -## Getting Started - -### Simple Configuration File +## Get started -In the following configuration file, the input plugin _windows_exporter_metrics collects _metrics every 2 seconds and exposes them through our [Prometheus Exporter](../outputs/prometheus-exporter.md) output plugin on HTTP/TCP port 2021. +### Configuration file -{% tabs %} -{% tab title="fluent-bit.yaml" %} - -```yaml -# Node Exporter Metrics + Prometheus Exporter -# ------------------------------------------- -# The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. -# -# After starting the service try it with: -# -# $ curl http://127.0.0.1:2021/metrics -# -service: - flush: 1 - log_level: info - -pipeline: - inputs: - - name: windows_exporter_metrics - tag: node_metrics - scrape_interval: 2 - - outputs: - - name: prometheus_exporter - match: node_metrics - port: 2021 -``` - -{% endtab %} -{% tab title="fluent-bit.conf" %} +In the following configuration file, the input plugin `windows_exporter_metrics` collects `metrics` every two seconds and exposes them through the [Prometheus Exporter](../outputs/prometheus-exporter.md) output plugin on HTTP/TCP port `2021`. ```text # Node Exporter Metrics + Prometheus Exporter @@ -134,13 +96,10 @@ pipeline: port 2021 ``` -{% endtab %} -{% endtabs %} - -You can test the expose of the metrics by using _curl:_ +You can test the expose of the metrics by using `curl`: ```shell -$ curl http://127.0.0.1:2021/metrics +curl http://127.0.0.1:2021/metrics ``` ### Service where clause @@ -148,14 +107,14 @@ $ curl http://127.0.0.1:2021/metrics Windows service collector will retrieve all of the service information for the local node or container. `we.service.where`, `we.service.include`, and `we.service.exclude` can be used to filter the service metrics. -To filter these metrics, users should specify a WHERE clause. -This syntax is defined in [the WMI Query Language(WQL)](https://learn.microsoft.com/en-us/windows/win32/wmisdk/wql-sql-for-wmi). +To filter these metrics, users should specify a `WHERE` clause. +This syntax is defined in [the WMI Query Language (WQL)](https://learn.microsoft.com/en-us/windows/win32/wmisdk/wql-sql-for-wmi). Here is how these parameters should work: -#### we.service.where +#### `we.service.where` -`we.service.where` is handled as a raw WHERE clause. +`we.service.where` is handled as a raw `WHERE` clause. For example, when a user specifies the parameter as follows: ```text @@ -168,11 +127,11 @@ This creates a WMI query like so: SELECT * FROM Win32_Service WHERE Status!='OK' ``` -The WMI mechanism will then handle it and return the information which has a "not OK" status in this example. +The WMI mechanism will then handle it and return the information which has a `not OK` status in this example. -### we.service.include +### `we.service.include` -When defined, the `we.service.include` is interpreted into a WHERE clause. +When defined, the `we.service.include` is interpreted into a `WHERE` clause. If multiple key-value pairs are specified, the values will be concatenated with `OR`. Also, if the values contain `%` character then a `LIKE` operator will be used in the clause instead of the `=` operator. When a user specifies the parameter as follows: @@ -193,9 +152,9 @@ The WMI query will be called with the translated parameter as: SELECT * FROM Win32_Service WHERE (Name='docker' OR Name LIKE '%Svc%' OR Name LIKE '%Service') ``` -### we.service.exclude +### `we.service.exclude` -When defined, the `we.service.exclude` is interpreted into a WHERE clause. +When defined, the `we.service.exclude` is interpreted into a `WHERE` clause. If multiple key-value pairs are specified, the values will be concatenated with `AND`. Also, if the values contain `%` character then a `LIKE` operator will be used in the translated clause instead of the `!=` operator. @@ -224,8 +183,8 @@ SELECT * FROM Win32_Service WHERE (NOT Name LIKE 'UdkUserSvc%' AND NOT Name LIKE 1. `we.service.include` translated and applied into the where clause in the service collector 2. `we.service.exclude` translated and applied into the where clause in the service collector 1. If the `we.service.include` is applied, translated `we.service.include` and `we.service.exclude` conditions are concatenated with `AND`. -3. `we.service.where` is just handled as-is into the where clause in the service collector . - 1. If either of the above parameters is applied, the clause will be applied with `AND (` _the value of `we.service.where`_ `)`. +1. `we.service.where` is handled as-is into the where clause in the service collector . + 1. If either of the previous parameters is applied, the clause will be applied with `AND (` _the value of `we.service.where`_ `)`. For example, when a user specifies the parameter as follows: @@ -241,8 +200,8 @@ The WMI query will be called with the translated parameter as: SELECT * FROM Win32_Service WHERE (Name='docker' OR Name LIKE '%Svc%' OR Name LIKE '%Service') AND (NOT Name LIKE 'UdkUserSvc%' AND Name!='XboxNetApiSvc') AND (NOT Name LIKE 'webthreatdefusersvc%') ``` -## Enhancement Requests +## Enhancement requests + +The plugin implements a subset of the available collectors in the original Prometheus Windows Exporter. If you would like a specific collector prioritized, open a Github issue by using the following template: -Our current plugin implements a sub-set of the available collectors in the original Prometheus Windows Exporter, if you would like that we prioritize a specific collector please open a Github issue by using the following template:\ -\ -\- [in_windows_exporter_metrics](https://github.com/fluent/fluent-bit/issues/new?assignees=\&labels=\&template=feature_request.md\&title=in_windows_exporter_metrics:%20add%20ABC%20collector) \ No newline at end of file +- [`in_windows_exporter_metrics`](https://github.com/fluent/fluent-bit/issues/new?assignees=\&labels=\&template=feature_request.md\&title=in_windows_exporter_metrics:%20add%20ABC%20collector) diff --git a/vale-styles/FluentBit/Acronyms.yml b/vale-styles/FluentBit/Acronyms.yml index 01d6df7d7..4ecc1696b 100644 --- a/vale-styles/FluentBit/Acronyms.yml +++ b/vale-styles/FluentBit/Acronyms.yml @@ -58,6 +58,7 @@ exceptions: - MQTT - NET - NGINX + - NIC - NOTE - NVDA - OSS @@ -98,6 +99,7 @@ exceptions: - UTF - UUID - WASI + - WMI - XML - XSS - YAML