1 of 1

Windows Exporter Metrics

A plugin based on Prometheus Windows Exporter to collect system / host level metrics

Prometheus Windows Exporter is a popular way to collect system level metrics from microsoft windows, such as CPU / Disk / Network / Process statistics. Fluent Bit 1.9.0 includes 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 and we plan to expand it over time.

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.

Configuration

Key

Description

Default

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.

note: the Version column specifies the Fluent Bit version where the collector is available.

Name

Description

Version

Getting Started

Simple Configuration File

In the following configuration file, the input plugin _windows_exporter_metrics collects _metrics every 2 seconds and exposes them through our output plugin on HTTP/TCP port 2021.

You can test the expose of the metrics by using curl:

Service where clause

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 .

Here is how these parameters should work:

we.service.where

we.service.where is handled as a raw WHERE clause. For example, when a user specifies the parameter as follows:

This creates a WMI query like so:

The WMI mechanism will then handle it and return the information which has a "not OK" status in this example.

we.service.include

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:

The parameter will be interpreted as:

The WMI query will be called with the translated parameter as:

we.service.exclude

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. When a user specifies the parameter as follows:

The parameter will be interpreted as:

The WMI query will be called with the translated parameter as:

Advanced usage

we.service.where, we.service.include, and we.service.exclude can all be used at the same time subject to the following rules.

we.service.include translated and applied into the where clause in the service collector
we.service.exclude translated and applied into the where clause in the service collector

For example, when a user specifies the parameter as follows:

The WMI query will be called with the translated parameter as:

Enhancement Requests

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: -

Windows Exporter Metrics

A plugin based on Prometheus Windows Exporter to collect system / host level metrics

The initial release of Windows Exporter Metrics contains a single collector available from Prometheus Windows Exporter and we plan to expand it over time.

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.

Configuration

Key

Description

Default

Collectors available

note: the Version column specifies the Fluent Bit version where the collector is available.

Name

Description

Version

Getting Started

Simple Configuration File

In the following configuration file, the input plugin _windows_exporter_metrics collects _metrics every 2 seconds and exposes them through our output plugin on HTTP/TCP port 2021.

You can test the expose of the metrics by using curl:

Service where clause

To filter these metrics, users should specify a WHERE clause. This syntax is defined in .

Here is how these parameters should work:

we.service.where

we.service.where is handled as a raw WHERE clause. For example, when a user specifies the parameter as follows:

This creates a WMI query like so:

The WMI mechanism will then handle it and return the information which has a "not OK" status in this example.

we.service.include

The parameter will be interpreted as:

The WMI query will be called with the translated parameter as:

we.service.exclude

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. When a user specifies the parameter as follows:

The parameter will be interpreted as:

The WMI query will be called with the translated parameter as:

Advanced usage

we.service.where, we.service.include, and we.service.exclude can all be used at the same time subject to the following rules.

we.service.include translated and applied into the where clause in the service collector
we.service.exclude translated and applied into the where clause in the service collector

For example, when a user specifies the parameter as follows:

The WMI query will be called with the translated parameter as:

Windows Exporter Metrics

hashtagConfiguration

hashtagCollectors available

hashtagGetting Started

hashtagSimple Configuration File

hashtagService where clause

hashtagwe.service.where

hashtagwe.service.include

hashtagwe.service.exclude

hashtagAdvanced usage

hashtagEnhancement Requests

Windows Exporter Metrics

hashtagConfiguration

hashtagCollectors available

hashtagGetting Started

hashtagSimple Configuration File

hashtagService where clause

hashtagwe.service.where

hashtagwe.service.include

hashtagwe.service.exclude

hashtagAdvanced usage

hashtagEnhancement Requests

Configuration

Collectors available

Getting Started

Simple Configuration File

Service where clause

we.service.where

we.service.include

we.service.exclude

Advanced usage

Enhancement Requests

Configuration

Collectors available

Getting Started

Simple Configuration File

Service where clause

we.service.where

we.service.include

we.service.exclude

Advanced usage

Enhancement Requests