From 7697725de97593d656d8cbcbdf6ff6b8e340aa87 Mon Sep 17 00:00:00 2001 From: Netdata bot <43409846+netdatabot@users.noreply.github.com> Date: Mon, 9 Dec 2024 13:45:58 -0500 Subject: [PATCH] Regenerate integrations docs (#19173) Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com> --- src/collectors/COLLECTORS.md | 2 + .../windows.plugin/integrations/processor.md | 142 ++++++++++++++++++ 2 files changed, 144 insertions(+) create mode 100644 src/collectors/windows.plugin/integrations/processor.md diff --git a/src/collectors/COLLECTORS.md b/src/collectors/COLLECTORS.md index 71fc3382955c70..74dc009f675c4d 100644 --- a/src/collectors/COLLECTORS.md +++ b/src/collectors/COLLECTORS.md @@ -1167,6 +1167,8 @@ If you don't see the app/service you'd like to monitor in this list: - [NET Framework](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/net_framework.md) +- [Processor](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/processor.md) + - [System statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_statistics.md) - [System thermal zone](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_thermal_zone.md) diff --git a/src/collectors/windows.plugin/integrations/processor.md b/src/collectors/windows.plugin/integrations/processor.md new file mode 100644 index 00000000000000..86d2fca4163b9f --- /dev/null +++ b/src/collectors/windows.plugin/integrations/processor.md @@ -0,0 +1,142 @@ + + +# Processor + + + + + +Plugin: windows.plugin +Module: PerflibProcessor + + + +## Overview + +This collector monitors processors statistics on host. + + +It queries Processor object from Perflib in order to gather the metrics. + + +This collector is only supported on the following platforms: + +- windows + +This collector only supports collecting metrics from a single instance of this integration. + + +### Default Behavior + +#### Auto-Detection + +The collector automatically detects all of the metrics, no further configuration is required. + + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per Processor instance + +These metrics refer to the entire system. + +This scope has no labels. + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| system.cpu | interrupts, user, privileged, dpc | percentage | + +### Per CPU + +These metrics provide information about individual CPU cores. + +Labels: + +| Label | Description | +|:-----------|:----------------| +| cpu | The identifier of the CPU core. On Windows systems, CPU cores are labeled as 'cpu0', 'cpu1', etc. | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| cpu.cpu | interrupts, user, privileged, dpc | percentage | + + + +## Alerts + + +The following alerts are available: + +| Alert name | On metric | Description | +|:------------|:----------|:------------| +| [ 10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cpu.conf) | system.cpu | Average CPU utilization over the last 10 minutes | + + +## Setup + +### Prerequisites + +No action required. + +### Configuration + +#### File + +The configuration file name for this integration is `netdata.conf`. +Configuration for this specific integration is located in the `[plugin:windows]` section within that file. + +The file format is a modified INI syntax. The general structure is: + +```ini +[section1] + option1 = some value + option2 = some other value + +[section2] + option3 = some third value +``` +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). + +```bash +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata +sudo ./edit-config netdata.conf +``` +#### Options + + + +| Name | Description | Default | Required | +|:----|:-----------|:-------|:--------:| +| PerflibProcessor | An option to enable or disable the data collection. | yes | no | + +#### Examples +There are no configuration examples. + +