forked from netdata/netdata
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Regenerate integrations docs (netdata#19173)
Co-authored-by: ilyam8 <[email protected]>
- Loading branch information
1 parent
9e6a757
commit 7697725
Showing
2 changed files
with
144 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
142 changes: 142 additions & 0 deletions
142
src/collectors/windows.plugin/integrations/processor.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
<!--startmeta | ||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/processor.md" | ||
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml" | ||
sidebar_label: "Processor" | ||
learn_status: "Published" | ||
learn_rel_path: "Collecting Metrics/Windows Systems" | ||
most_popular: False | ||
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" | ||
endmeta--> | ||
|
||
# Processor | ||
|
||
|
||
<img src="https://netdata.cloud/img/windows.svg" width="150"/> | ||
|
||
|
||
Plugin: windows.plugin | ||
Module: PerflibProcessor | ||
|
||
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> | ||
|
||
## 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. | ||
|
||
|