Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated to include new input plugin doc for Windows System Statistics…
…. Applies to #2139.

Signed-off-by: Eric D. Schabell <[email protected]>
  • Loading branch information
eschabell committed Nov 24, 2025
commit 8b9641dec0b3d64aa6d3faf9d80564a96331d824
99 changes: 99 additions & 0 deletions pipeline/inputs/windows-system-statistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Windows System Statistics (winstat)

Check warning on line 1 in pipeline/inputs/windows-system-statistics.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [FluentBit.Spelling] Spelling check: 'winstat'? Raw Output: {"message": "[FluentBit.Spelling] Spelling check: 'winstat'?", "location": {"path": "pipeline/inputs/windows-system-statistics.md", "range": {"start": {"line": 1, "column": 30}}}, "severity": "INFO"}

Check warning on line 1 in pipeline/inputs/windows-system-statistics.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [FluentBit.Headings] 'Windows System Statistics (winstat)' should use sentence-style capitalization. Raw Output: {"message": "[FluentBit.Headings] 'Windows System Statistics (winstat)' should use sentence-style capitalization.", "location": {"path": "pipeline/inputs/windows-system-statistics.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "INFO"}

The _Windows System Statistics_ (`winstat`) input plugin collects system-level statistics from Windows environments, including CPU usage, memory consumption, disk I/O, and network activity. This plugin uses Windows Performance Counters to gather real-time system metrics.

{% hint style="info" %}

This plugin is only available on Windows operating systems and requires appropriate permissions to access Windows Performance Counters.

{% endhint %}

## Configuration parameters

The plugin supports the following configuration parameters:

| Key | Description | Default |
|:----------------|:--------------------------------------------------------------------------------------------------------|:--------|
| `Interval_Sec` | Polling interval in seconds. | `1` |
| `Interval_NSec` | Polling interval in nanoseconds. | `0` |
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

## Metrics collected

The `winstat` plugin collects the following system statistics:

| Metric Category | Description |
|:----------------|:----------------------------------------------------------------------------|
| CPU | CPU usage percentage, including user and system time |
| Memory | Memory usage including total, available, and used memory |
| Disk | Disk I/O statistics including read/write operations and throughput |
| Network | Network interface statistics including bytes sent/received and packet counts |

## Get started

To collect Windows system statistics, you can run the plugin from the command line or through the configuration file:

### Command line

You can run the plugin from the command line:

```shell
fluent-bit -i winstat -o stdout
```

Which returns information similar to the following:

```text
...
[0] winstat: [1699123456.123456789, {"cpu.usage"=>15.3, "cpu.user"=>10.2, "cpu.system"=>5.1, "memory.total"=>8192, "memory.available"=>4096, "memory.used"=>4096, "disk.read_bytes"=>1024000, "disk.write_bytes"=>512000, "network.bytes_sent"=>2048000, "network.bytes_recv"=>1024000}]
[1] winstat: [1699123457.123456789, {"cpu.usage"=>16.1, "cpu.user"=>11.0, "cpu.system"=>5.1, "memory.total"=>8192, "memory.available"=>4080, "memory.used"=>4112, "disk.read_bytes"=>1025000, "disk.write_bytes"=>515000, "network.bytes_sent"=>2050000, "network.bytes_recv"=>1025000}]
...
```

### Configuration file

In your main configuration file append the following:

{% tabs %}
{% tab title="fluent-bit.yaml" %}

```yaml
pipeline:
inputs:
- name: winstat
tag: winstat
interval_sec: 1
interval_nsec: 0

outputs:
- name: stdout
match: '*'
```

{% endtab %}
{% tab title="fluent-bit.conf" %}

```text
[INPUT]
Name winstat
Tag winstat
Interval_Sec 1
Interval_NSec 0

[OUTPUT]
Name stdout
Match *
```

{% endtab %}
{% endtabs %}

Total interval (sec) = `Interval_Sec` + (`Interval_NSec` / 1000000000)

For example: `1.5s` = `1s` + `500000000ns`

## Notes

- The `winstat` plugin requires Windows Performance Counters access. Ensure Fluent Bit is running with appropriate permissions.
- This plugin is Windows-only and will not work on Linux, macOS, or other operating systems.

Check warning on line 98 in pipeline/inputs/windows-system-statistics.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [FluentBit.Contractions] Feel free to use 'won't' instead of 'will not'. Raw Output: {"message": "[FluentBit.Contractions] Feel free to use 'won't' instead of 'will not'.", "location": {"path": "pipeline/inputs/windows-system-statistics.md", "range": {"start": {"line": 98, "column": 35}}}, "severity": "INFO"}
- For Prometheus-based metrics collection on Windows, consider using the [Windows Exporter Metrics](windows-exporter-metrics.md) input plugin instead.
Loading