Regenerate integrations docs (#19173)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Dec 9, 2024 at 13:45 UTC
7697725de97593d656d8cbcbdf6ff6b8e340aa87
2 files changed
+144
src/collectors/COLLECTORS.md
+2
@@ -1167,6 +1167,8 @@ If you don't see the app/service you'd like to monitor in this list:
1167
1168
- [NET Framework](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/net_framework.md)
1169
1170
+- [Processor](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/processor.md)
1171
+
1172
- [System statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_statistics.md)
1173
1174
- [System thermal zone](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_thermal_zone.md)
src/collectors/windows.plugin/integrations/processor.md
new
+142
@@ -0,0 +1,142 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/processor.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "Processor"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Windows Systems"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# Processor
12
+
13
+
14
+<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: PerflibProcessor
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors processors statistics on host.
25
+
26
+
27
+It queries Processor object from Perflib in order to gather the metrics.
28
+
29
+
30
+This collector is only supported on the following platforms:
31
+
32
+- windows
33
+
34
+This collector only supports collecting metrics from a single instance of this integration.
35
+
36
+
37
+### Default Behavior
38
+
39
+#### Auto-Detection
40
+
41
+The collector automatically detects all of the metrics, no further configuration is required.
42
+
43
+
44
+#### Limits
45
+
46
+The default configuration for this integration does not impose any limits on data collection.
47
+
48
+#### Performance Impact
49
+
50
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
51
+
52
+
53
+## Metrics
54
+
55
+Metrics grouped by *scope*.
56
+
57
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
58
+
59
+
60
+
61
+### Per Processor instance
62
+
63
+These metrics refer to the entire system.
64
+
65
+This scope has no labels.
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| system.cpu | interrupts, user, privileged, dpc | percentage |
72
+
73
+### Per CPU
74
+
75
+These metrics provide information about individual CPU cores.
76
+
77
+Labels:
78
+
79
+| Label | Description |
80
+|:-----------|:----------------|
81
+| cpu | The identifier of the CPU core. On Windows systems, CPU cores are labeled as 'cpu0', 'cpu1', etc. |
82
+
83
+Metrics:
84
+
85
+| Metric | Dimensions | Unit |
86
+|:------|:----------|:----|
87
+| cpu.cpu | interrupts, user, privileged, dpc | percentage |
88
+
89
+
90
+
91
+## Alerts
92
+
93
+
94
+The following alerts are available:
95
+
96
+| Alert name | On metric | Description |
97
+|:------------|:----------|:------------|
98
+| [ 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 |
99
+
100
+
101
+## Setup
102
+
103
+### Prerequisites
104
+
105
+No action required.
106
+
107
+### Configuration
108
+
109
+#### File
110
+
111
+The configuration file name for this integration is `netdata.conf`.
112
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
113
+
114
+The file format is a modified INI syntax. The general structure is:
115
+
116
+```ini
117
+[section1]
118
+ option1 = some value
119
+ option2 = some other value
120
+
121
+[section2]
122
+ option3 = some third value
123
+```
124
+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
125
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
126
+
127
+```bash
128
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
129
+sudo ./edit-config netdata.conf
130
+```
131
+#### Options
132
+
133
+
134
+
135
+| Name | Description | Default | Required |
136
+|:----|:-----------|:-------|:--------:|
137
+| PerflibProcessor | An option to enable or disable the data collection. | yes | no |
138
+
139
+#### Examples
140
+There are no configuration examples.
141
+
142
+