Skip to content

Commit aef829a

Browse files
author
leonardo-albertovich
authored
pipeline: inputs: windows_exporter_metrics: initial commit (#711)
* pipeline: inputs: windows_exporter_metrics: initial commit Signed-off-by: Leonardo Alminana <[email protected]> * pipeline: inputs: windows_exporter_metrics: initial commit Signed-off-by: Leonardo Alminana <[email protected]>
1 parent 920a4f2 commit aef829a

File tree

2 files changed

+78
-0
lines changed

2 files changed

+78
-0
lines changed

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@
7676
* [Pipeline Monitoring](pipeline/pipeline-monitoring.md)
7777
* [Inputs](pipeline/inputs/README.md)
7878
* [Node Exporter Metrics](pipeline/inputs/node-exporter-metrics.md)
79+
* [Windows Exporter Metrics](pipeline/inputs/windows-exporter-metrics.md)
7980
* [Collectd](pipeline/inputs/collectd.md)
8081
* [CPU Metrics](pipeline/inputs/cpu-metrics.md)
8182
* [Disk I/O Metrics](pipeline/inputs/disk-io-metrics.md)
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
description: >-
3+
A plugin based on Prometheus Windows Exporter to collect system / host level
4+
metrics
5+
---
6+
7+
# Windows Exporter Metrics
8+
9+
[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. 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.
10+
11+
The initial release of Windows Exporter Metrics contains a single collector available from Prometheus Windows Exporter and we plan to expand it over time.
12+
13+
**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.
14+
15+
16+
## Configuration
17+
18+
| Key | Description | Default |
19+
| --------------- | ---------------------------------------------------------------------- | --------- |
20+
| scrape_interval | The rate at which metrics are collected from the host operating system | 5 seconds |
21+
22+
## Collectors available
23+
24+
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.
25+
26+
> note: the Version column specifies the Fluent Bit version where the collector is available.
27+
28+
| Name | Description | OS | Version |
29+
| --------- | ------------------------------------------------------------------------------------------------ | ------- | ------- |
30+
| cpu | Exposes CPU statistics. | Windows | v1.9 |
31+
32+
## Getting Started
33+
34+
### Simple Configuration File
35+
36+
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.
37+
38+
```
39+
# Node Exporter Metrics + Prometheus Exporter
40+
# -------------------------------------------
41+
# The following example collect host metrics on Linux and expose
42+
# them through a Prometheus HTTP end-point.
43+
#
44+
# After starting the service try it with:
45+
#
46+
# $ curl http://127.0.0.1:2021/metrics
47+
#
48+
[SERVICE]
49+
flush 1
50+
log_level info
51+
52+
[INPUT]
53+
name windows_exporter_metrics
54+
tag node_metrics
55+
scrape_interval 2
56+
57+
[OUTPUT]
58+
name prometheus_exporter
59+
match node_metrics
60+
listen 0.0.0.0
61+
port 2021
62+
63+
64+
```
65+
66+
You can test the expose of the metrics by using _curl:_
67+
68+
```bash
69+
curl http://127.0.0.1:2021/metrics
70+
```
71+
72+
## Enhancement Requests
73+
74+
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:\
75+
\
76+
\- [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)
77+

0 commit comments

Comments
 (0)