Regenerate integrations docs (#19561)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Feb 3, 2025 at 04:01 UTC
1d404c1ef21293e995fed5d271bfb6a81a1fb7c8
3 files changed
+280
src/collectors/COLLECTORS.md
+4
@@ -1163,6 +1163,10 @@ If you don't see the app/service you'd like to monitor in this list:
1163
1164
### Windows Systems
1165
1166
+- [Active Directory Certificate Service](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory_certificate_service.md)
1167
+
1168
+- [Active Directory](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory.md)
1169
+
1170
- [Hyper-V](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/hyper-v.md)
1171
1172
- [IIS](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/iis.md)
src/collectors/windows.plugin/integrations/active_directory.md
new
+136
@@ -0,0 +1,136 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/active_directory.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "Active Directory"
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
+# Active Directory
12
+
13
+
14
+<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: PerflibAD
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors Active Directory IO and queries.
25
+
26
+
27
+It queries DirectoryServices 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 Active Directory
62
+
63
+These metrics refer to Active Directory.
64
+
65
+This scope has no labels.
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| ad.directory_operations | read, write, search | operations/s |
72
+| ad.name_cache_lookups | lookups | lookups/s |
73
+| ad.dra_replication_properties_updated | inbound | properties/s |
74
+| ad.dra_replication_properties_filtered | inbound | properties/s |
75
+| ad.dra_replication_intersite_compressed_traffic | inbound, outbound | bytes/s |
76
+| ad.dra_replication_intrasite_compressed_traffic | inbound, outbound | bytes/s |
77
+| ad.dra_replication_pending_syncs | pending | syncs |
78
+| ad.dra_replication_pending_syncs | pending | syncs |
79
+| ad.dra_replication_sync_requests | request | requests/s |
80
+| ad.dra_replication_sync_objects_remaining | object | objects |
81
+| ad.dra_replication_sync_objects_remaining | object | objects |
82
+| ad.name_cache_hits | hits | hits/s |
83
+| ad.ds_threads | thread | threads |
84
+| ad.ldap_last_bind_time | last_bind | seconds |
85
+| ad.ldap_searches | searches | searches/s |
86
+| ad.atq_average_request_latency | time | seconds |
87
+
88
+
89
+
90
+## Alerts
91
+
92
+There are no alerts configured by default for this integration.
93
+
94
+
95
+## Setup
96
+
97
+### Prerequisites
98
+
99
+No action required.
100
+
101
+### Configuration
102
+
103
+#### File
104
+
105
+The configuration file name for this integration is `netdata.conf`.
106
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
107
+
108
+The file format is a modified INI syntax. The general structure is:
109
+
110
+```ini
111
+[section1]
112
+ option1 = some value
113
+ option2 = some other value
114
+
115
+[section2]
116
+ option3 = some third value
117
+```
118
+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
119
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
120
+
121
+```bash
122
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
123
+sudo ./edit-config netdata.conf
124
+```
125
+#### Options
126
+
127
+
128
+
129
+| Name | Description | Default | Required |
130
+|:----|:-----------|:-------|:--------:|
131
+| PerflibAD | An option to enable or disable the data collection. | yes | no |
132
+
133
+#### Examples
134
+There are no configuration examples.
135
+
136
+
src/collectors/windows.plugin/integrations/active_directory_certificate_service.md
new
+140
@@ -0,0 +1,140 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/active_directory_certificate_service.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "Active Directory Certificate Service"
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
+# Active Directory Certificate Service
12
+
13
+
14
+<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: PerflibADCS
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors Active Directory Certificate Services statistics.
25
+
26
+
27
+It queries 'Certification Authority' object per certificate 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 Certificate Service Certificate
62
+
63
+These metrics refer to the Certificate instances defined on host.
64
+
65
+Labels:
66
+
67
+| Label | Description |
68
+|:-----------|:----------------|
69
+| cert | The certificate name. |
70
+
71
+Metrics:
72
+
73
+| Metric | Dimensions | Unit |
74
+|:------|:----------|:----|
75
+| adcs.cert_requests | requests | requests/s |
76
+| adcs.cert_request_processing_time | processing_times | seconds |
77
+| adcs.cert_retrievals | retrievals | retrievals/s |
78
+| adcs.cert_failed_requests | failed | requests/s |
79
+| adcs.cert_issued_requests | issued | requests/s |
80
+| adcs.cert_pending_requests | pending | requests/s |
81
+| adcs.cert_challenge_responses | challenge | responses/s |
82
+| adcs.cert_retrieval_processing_time | processing_time | seconds |
83
+| adcs.cert_request_cryptographic_signing_time | singing_time | seconds |
84
+| adcs.cert_request_policy_module_processing | processing_time | seconds |
85
+| adcs.cert_request_policy_module_processing | processing_time | seconds |
86
+| adcs.cert_challenge_response_processing_time | processing_time | seconds |
87
+| adcs.cert_signed_certificate_timestamp_lists | processing_time | lists/s |
88
+| adcs.cert_signed_certificate_timestamp_lists | lists | lists/s |
89
+| adcs.cert_signed_certificate_timestamp_list_processing_time | processing_time | seconds |
90
+| adcs.cert_retrieval_processing_time | processing_time | seconds |
91
+
92
+
93
+
94
+## Alerts
95
+
96
+There are no alerts configured by default for this integration.
97
+
98
+
99
+## Setup
100
+
101
+### Prerequisites
102
+
103
+No action required.
104
+
105
+### Configuration
106
+
107
+#### File
108
+
109
+The configuration file name for this integration is `netdata.conf`.
110
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
111
+
112
+The file format is a modified INI syntax. The general structure is:
113
+
114
+```ini
115
+[section1]
116
+ option1 = some value
117
+ option2 = some other value
118
+
119
+[section2]
120
+ option3 = some third value
121
+```
122
+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
123
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
124
+
125
+```bash
126
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
127
+sudo ./edit-config netdata.conf
128
+```
129
+#### Options
130
+
131
+
132
+
133
+| Name | Description | Default | Required |
134
+|:----|:-----------|:-------|:--------:|
135
+| PerflibADCS | An option to enable or disable the data collection. | yes | no |
136
+
137
+#### Examples
138
+There are no configuration examples.
139
+
140
+