Skip to content

Commit a006791

Browse files
Ingest New Documentation (#2830)
Co-authored-by: netdatabot <43409846+netdatabot@users.noreply.github.com>
1 parent e443090 commit a006791

13 files changed

Lines changed: 1669 additions & 1630 deletions

LegacyLearnCorrelateLinksWithGHURLs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3486,5 +3486,6 @@
34863486
"https://learn.netdata.cloud/docs/collecting-metrics/applications/alamos-fe2-server": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/alamos_fe2_server.md",
34873487
"https://learn.netdata.cloud/docs/collecting-metrics/applications/active-directory-federation-service": "https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory_federation_service.md",
34883488
"https://learn.netdata.cloud/docs/collecting-metrics/applications/active-directory-certificate-service": "https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory_certificate_service.md",
3489-
"https://learn.netdata.cloud/docs/collecting-metrics/applications/active-directory": "https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory.md"
3489+
"https://learn.netdata.cloud/docs/collecting-metrics/applications/active-directory": "https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory.md",
3490+
"https://learn.netdata.cloud/docs/collecting-metrics/collectors/synthetic-testing/nagios-plugins": "https://github.com/netdata/netdata/blob/master/src/go/plugin/scripts.d/collector/nagios/README.md"
34903491
}

docs/Alerts & Notifications/Alert Configuration Reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1588,7 +1588,7 @@ When seeking help, include:
15881588

15891589
- [Netdata GitHub Issues](https://github.com/netdata/netdata/issues)
15901590
- [Netdata Community Forum](https://community.netdata.cloud)
1591-
- [Netdata Discord](https://discord.gg/mPZ6WZKKG2)
1591+
- [Netdata Discord](https://discord.com/invite/2mEmfW735j)
15921592

15931593
## Related Pages
15941594

docs/Collecting Metrics/Collectors/Applications/Active Directory Federation Service.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ Metrics:
134134
| adfs.db_config_failures | connection | failures/s |
135135
| adfs.db_config_query_time_seconds | query_time | seconds/s |
136136
| adfs.device_authentications | authentications | authentications/s |
137+
| adfs.extranet_account_lockouts | lockouts | lockouts/s |
137138
| adfs.external_authentications | success, failure | authentications/s |
138139
| adfs.federated_authentications | authentications | authentications/s |
139140
| adfs.federation_metadata_requests | requests | requests/s |

docs/Collecting Metrics/Collectors/Collectors.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -758,7 +758,7 @@ import { Grid, Box } from '@site/src/components/Grid_integrations';
758758
<img custom-image src="https://netdata.cloud/img/mysql.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }} data-integration-logo="true" data-logo-contrast-light="ok" data-logo-contrast-dark="ok" data-logo-contrast-confidence="medium"/>
759759
</Box>
760760

761-
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/collectors/synthetic-testing/nagios-plugins" title="Nagios Plugins">
761+
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/collectors/synthetic-testing/nagios-plugins-and-custom-scripts" title="Nagios Plugins and Custom Scripts">
762762
<img custom-image src="https://netdata.cloud/img/nagios.png" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }} data-integration-logo="true" data-logo-contrast-light="low" data-logo-contrast-dark="ok" data-logo-contrast-confidence="high"/>
763763
</Box>
764764

@@ -1111,7 +1111,7 @@ import { Grid, Box } from '@site/src/components/Grid_integrations';
11111111
</Box>
11121112

11131113
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/collectors/operating-systems/system-statistics" title="System statistics">
1114-
<img custom-image src="https://netdata.cloud/img/linuxserver.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }} data-integration-logo="true" data-logo-contrast-light="unknown" data-logo-contrast-dark="unknown" data-logo-contrast-confidence="low"/>
1114+
<img custom-image src="https://netdata.cloud/img/windows.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }} data-integration-logo="true" data-logo-contrast-light="ok" data-logo-contrast-dark="ok" data-logo-contrast-confidence="medium"/>
11151115
</Box>
11161116

11171117
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/collectors/hardware-and-sensors/system-thermal-zone" title="System thermal zone">

docs/Collecting Metrics/Collectors/Operating Systems/Operating Systems.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ import { Grid, Box } from '@site/src/components/Grid_integrations';
171171
</Box>
172172

173173
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/collectors/operating-systems/system-statistics" title="System statistics">
174-
<img custom-image src="https://netdata.cloud/img/linuxserver.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }} data-integration-logo="true" data-logo-contrast-light="unknown" data-logo-contrast-dark="unknown" data-logo-contrast-confidence="low"/>
174+
<img custom-image src="https://netdata.cloud/img/windows.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }} data-integration-logo="true" data-logo-contrast-light="ok" data-logo-contrast-dark="ok" data-logo-contrast-confidence="medium"/>
175175
</Box>
176176

177177
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/collectors/operating-systems/system-uptime" title="System Uptime">
Lines changed: 18 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml"
2+
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
33
sidebar_label: "System statistics"
44
learn_status: "Published"
55
toc_max_heading_level: "6"
66
toc_collapsible: "true"
77
learn_rel_path: "Collecting Metrics/Collectors/Operating Systems"
8-
keywords: [cpu utilization, process counts]
8+
keywords: [process counts, threads, context switch]
99
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
1010
sidebar_position: "420"
1111
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/collectors/operating-systems/system-statistics"
@@ -16,43 +16,25 @@ slug: "/collecting-metrics/collectors/operating-systems/system-statistics"
1616
# System statistics
1717

1818

19-
<img src="https://netdata.cloud/img/linuxserver.svg" width="150" data-integration-logo="true" data-logo-contrast-light="unknown" data-logo-contrast-dark="unknown" data-logo-contrast-confidence="low"/>
19+
<img src="https://netdata.cloud/img/windows.svg" width="150" data-integration-logo="true" data-logo-contrast-light="ok" data-logo-contrast-dark="ok" data-logo-contrast-confidence="medium"/>
2020

2121

22-
Plugin: proc.plugin
23-
Module: /proc/stat
22+
Plugin: windows.plugin
23+
Module: PerflibProcesses
2424

2525
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
2626

2727
## Overview
2828

29-
CPU utilization, states and frequencies and key Linux system performance metrics.
30-
31-
The `/proc/stat` file provides various types of system statistics:
32-
33-
- The overall system CPU usage statistics
34-
- Per CPU core statistics
35-
- The total context switching of the system
36-
- The total number of processes running
37-
- The total CPU interrupts
38-
- The total CPU softirqs
39-
40-
The collector also reads:
41-
42-
- `/proc/schedstat` for statistics about the process scheduler in the Linux kernel.
43-
- `/sys/devices/system/cpu/[X]/thermal_throttle/core_throttle_count` to get the count of thermal throttling events for a specific CPU core on Linux systems.
44-
- `/sys/devices/system/cpu/[X]/thermal_throttle/package_throttle_count` to get the count of thermal throttling events for a specific CPU package on a Linux system.
45-
- `/sys/devices/system/cpu/[X]/cpufreq/scaling_cur_freq` to get the current operating frequency of a specific CPU core.
46-
- `/sys/devices/system/cpu/[X]/cpufreq/stats/time_in_state` to get the amount of time the CPU has spent in each of its available frequency states.
47-
- `/sys/devices/system/cpu/[X]/cpuidle/state[X]/name` to get the names of the idle states for each CPU core in a Linux system.
48-
- `/sys/devices/system/cpu/[X]/cpuidle/state[X]/time` to get the total time each specific CPU core has spent in each idle state since the system was started.
29+
This collector monitors the current number of processes, threads, and context switches on Windows systems.
4930

5031

32+
It queries the 'System' object from Perflib in order to gather the metrics.
5133

5234

5335
This collector is only supported on the following platforms:
5436

55-
- linux
37+
- windows
5638

5739
This collector only supports collecting metrics from a single instance of this integration.
5840

@@ -61,7 +43,7 @@ This collector only supports collecting metrics from a single instance of this i
6143

6244
#### Auto-Detection
6345

64-
The collector auto-detects all metrics. No configuration is needed.
46+
The collector automatically detects all of the metrics, no further configuration is required.
6547

6648

6749
#### Limits
@@ -70,8 +52,7 @@ The default configuration for this integration does not impose any limits on dat
7052

7153
#### Performance Impact
7254

73-
The collector disables cpu frequency and idle state monitoring when there are more than 128 CPU cores available.
74-
55+
The default configuration for this integration is not expected to impose a significant performance impact on the system.
7556

7657
## Setup
7758

@@ -86,25 +67,19 @@ No action required.
8667

8768

8869

89-
<details open>
90-
<summary>Config options</summary>
91-
9270

9371

9472
| Option | Description | Default | Required |
9573
|:-----|:------------|:--------|:---------:|
96-
| per cpu core utilization | Collects CPU usage metrics for each individual core, in addition to the system-wide averages. | no | no |
97-
| cpu idle states | Collects CPU idle state residency metrics for each individual core, showing how much time each core spends in different idle states (C-states). | no | no |
98-
74+
| update every | Data collection frequency. | 1 | no |
9975

100-
</details>
10176

10277

10378

10479
#### via File
10580

10681
The configuration file name for this integration is `netdata.conf`.
107-
Configuration for this specific integration is located in the `plugin:proc:/proc/stat` section within that file.
82+
Configuration for this specific integration is located in the `[plugin:windows:PerflibProcesses]` section within that file.
10883

10984
The file format is a modified INI syntax. The general structure is:
11085

@@ -131,14 +106,7 @@ There are no configuration examples.
131106

132107
## Alerts
133108

134-
135-
The following alerts are available:
136-
137-
| Alert name | On metric | Description |
138-
|:------------|:----------|:------------|
139-
| [ 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 (excluding iowait, nice and steal) |
140-
| [ 10min_cpu_iowait ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cpu.conf) | system.cpu | average CPU iowait time over the last 10 minutes |
141-
| [ 20min_steal_cpu ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cpu.conf) | system.cpu | average CPU steal time over the last 20 minutes |
109+
There are no alerts configured by default for this integration.
142110

143111

144112
## Metrics
@@ -149,40 +117,19 @@ The scope defines the instance that the metric belongs to. An instance is unique
149117

150118

151119

152-
### Per System statistics instance
153-
120+
### Per System
154121

122+
These metrics refer to the entire system.
155123

156124
This scope has no labels.
157125

158126
Metrics:
159127

160128
| Metric | Dimensions | Unit |
161129
|:------|:----------|:----|
162-
| system.cpu | guest_nice, guest, steal, softirq, irq, user, system, nice, iowait, idle | percentage |
163-
| system.intr | interrupts | interrupts/s |
130+
| system.processes | running | processes |
131+
| system.threads | threads | threads |
164132
| system.ctxt | switches | context switches/s |
165-
| system.forks | started | processes/s |
166-
| system.processes | running, blocked | processes |
167-
| cpu.core_throttling | a dimension per cpu core | events/s |
168-
| cpu.package_throttling | a dimension per package | events/s |
169-
| cpu.cpufreq | a dimension per cpu core | MHz |
170-
171-
### Per cpu core
172-
173-
Per-core CPU metrics. Disabled by default, can be enabled in the [configuration options](#configuration).
174-
175-
Labels:
176-
177-
| Label | Description |
178-
|:-----------|:----------------|
179-
| cpu | Identifier of the CPU core (e.g., core0, core1, core2). |
180-
181-
Metrics:
182-
183-
| Metric | Dimensions | Unit |
184-
|:------|:----------|:----|
185-
| cpu.cpu | guest_nice, guest, steal, softirq, irq, user, system, nice, iowait, idle | percentage |
186-
| cpuidle.cpu_cstate_residency_time | a dimension per c-state | percentage |
133+
| system.processor_queue_length | threads | threads |
187134

188135

Lines changed: 27 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
2+
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/apps.plugin/metadata.yaml"
33
sidebar_label: "Windows Services"
44
learn_status: "Published"
55
toc_max_heading_level: "6"
66
toc_collapsible: "true"
77
learn_rel_path: "Collecting Metrics/Collectors/Operating Systems"
8-
keywords: [windows, microsoft, services]
8+
keywords: [windows, services, processes, os, host monitoring]
99
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
1010
sidebar_position: "590"
1111
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/collectors/operating-systems/windows-services"
@@ -19,40 +19,37 @@ slug: "/collecting-metrics/collectors/operating-systems/windows-services"
1919
<img src="https://netdata.cloud/img/windows.svg" width="150" data-integration-logo="true" data-logo-contrast-light="ok" data-logo-contrast-dark="ok" data-logo-contrast-confidence="medium"/>
2020

2121

22-
Plugin: windows.plugin
23-
Module: PerflibServices
22+
Plugin: apps.plugin
23+
Module: services
2424

2525
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
2626

2727
## Overview
2828

29-
This collector monitors Windows Services Status and States.
30-
31-
32-
It queries Service Management to get the metrics.
29+
This integration monitors resource utilization grouped by Windows Service.
3330

31+
It auto-discovers running Windows services via the Service Control Manager and groups each service's process tree to aggregate CPU, memory, I/O, and other metrics per service. Processes not belonging to any service are grouped under 'not-services'.
3432

3533
This collector is only supported on the following platforms:
3634

3735
- windows
3836

39-
This collector only supports collecting metrics from a single instance of this integration.
37+
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
4038

4139

4240
### Default Behavior
4341

4442
#### Auto-Detection
4543

46-
The collector automatically detects all of the metrics, no further configuration is required.
47-
44+
All running Windows services are automatically discovered. No configuration is needed.
4845

4946
#### Limits
5047

5148
The default configuration for this integration does not impose any limits on data collection.
5249

5350
#### Performance Impact
5451

55-
The default configuration for this integration is not expected to impose a significant performance impact on the system.
52+
No additional SCM query overhead. The service list is already queried by apps.plugin for process naming. Per-iteration work involves walking parent chains to assign service names.
5653

5754
## Setup
5855

@@ -65,39 +62,13 @@ No action required.
6562

6663
#### Options
6764

68-
69-
70-
71-
72-
| Option | Description | Default | Required |
73-
|:-----|:------------|:--------|:---------:|
74-
| update every | Data collection frequency. | 30 | no |
75-
65+
Service charts are enabled by default. Use the `without-services` (or `no-services`) command line option to disable them.
7666

7767

7868

7969
#### via File
8070

81-
The configuration file name for this integration is `netdata.conf`.
82-
Configuration for this specific integration is located in the `[plugin:windows:PerflibServices]` section within that file.
83-
84-
The file format is a modified INI syntax. The general structure is:
85-
86-
```ini
87-
[section1]
88-
option1 = some value
89-
option2 = some other value
90-
91-
[section2]
92-
option3 = some third value
93-
```
94-
You can edit the configuration file using the [`edit-config`](/docs/netdata-agent/configuration#edit-configuration-files) script from the
95-
Netdata [config directory](/docs/netdata-agent/configuration#locate-your-config-directory).
96-
97-
```bash
98-
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
99-
sudo ./edit-config netdata.conf
100-
```
71+
There is no configuration file.
10172

10273
##### Examples
10374
There are no configuration examples.
@@ -117,20 +88,30 @@ The scope defines the instance that the metric belongs to. An instance is unique
11788

11889

11990

120-
### Per Windows Service
91+
### Per windows service
12192

122-
These metrics refer to Windows Services.
93+
These metrics refer to the Windows Service.
12394

12495
Labels:
12596

12697
| Label | Description |
12798
|:-----------|:----------------|
128-
| service | The service name |
99+
| service | The display name of the Windows service. |
129100

130101
Metrics:
131102

132-
| Metric | Dimensions | Unit |
133-
|:------|:----------|:----|
134-
| windows.service_state | running, stopped, start_pending, stop_pending, continue_pending, pause_pending, paused, unknown | state |
103+
| Metric | Dimensions | Unit | windows |
104+
|:------|:----------|:----|:---:|
105+
| service.cpu_utilization | user, system | percentage ||
106+
| service.mem_usage | rss | MiB ||
107+
| service.vmem_usage | vmem | MiB ||
108+
| service.mem_page_faults | minor | pgfaults/s ||
109+
| service.swap_usage | swap | MiB ||
110+
| service.disk_logical_io | reads, writes | KiB/s ||
111+
| service.fds_open | handles | fds ||
112+
| service.processes | processes | processes ||
113+
| service.threads | threads | threads ||
114+
| service.uptime | uptime | seconds ||
115+
| service.uptime_summary | min, avg, max | seconds ||
135116

136117

0 commit comments

Comments
 (0)