Skip to content

Commit

Permalink
in_windows_exporter_metrics: Add document for process metrics (#1182)
Browse files Browse the repository at this point in the history
* in_windows_exporter_metrics: Add description for parameters of process metrics

Signed-off-by: Hiroshi Hatake <[email protected]>

* Clarify the sentence.

Co-authored-by: Pat <[email protected]>
Signed-off-by: Hiroshi Hatake <[email protected]>

---------

Signed-off-by: Hiroshi Hatake <[email protected]>
Co-authored-by: Pat <[email protected]>
  • Loading branch information
cosmo0920 and patrick-stephens authored Aug 31, 2023
1 parent 2059753 commit 13e6460
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions pipeline/inputs/windows-exporter-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ The initial release of Windows Exporter Metrics contains a single collector avai
| 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 |
Expand All @@ -36,6 +38,7 @@ The initial release of Windows Exporter Metrics contains a single collector avai
| 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"` |

## Collectors available
Expand All @@ -58,6 +61,7 @@ The following table describes the available collectors as part of this plugin. A
| 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 |

## Getting Started

Expand Down

0 comments on commit 13e6460

Please sign in to comment.