Metadata (AD and ADCS), and small fixes (#19557)
thiagoftsm committed
Feb 3, 2025 at 08:59 UTC
885cb8509414dcffa8ca63ea47f0f25682862385
4 files changed
+359
-6
src/collectors/windows.plugin/metadata.yaml
+355
@@ -2042,3 +2042,358 @@ modules:
2042
chart_type: line
2043
dimensions:
2044
- name: contentions
2045
+ - meta:
2046
+ plugin_name: windows.plugin
2047
+ module_name: PerflibAD
2048
+ monitored_instance:
2049
+ name: Active Directory
2050
+ link: "https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/get-started/virtual-dc/active-directory-domain-services-overview"
2051
+ categories:
2052
+ - data-collection.windows-systems
2053
+ icon_filename: "windows.svg"
2054
+ related_resources:
2055
+ integrations:
2056
+ list: []
2057
+ info_provided_to_referring_integrations:
2058
+ description: ""
2059
+ keywords:
2060
+ - windows
2061
+ - microsoft
2062
+ - active directory
2063
+ - ad
2064
+ most_popular: false
2065
+ overview:
2066
+ data_collection:
2067
+ metrics_description: |
2068
+ This collector monitors Active Directory IO and queries.
2069
+ method_description: |
2070
+ It queries DirectoryServices object from Perflib in order to gather the metrics.
2071
+ supported_platforms:
2072
+ include: ["windows"]
2073
+ exclude: []
2074
+ multi_instance: false
2075
+ additional_permissions:
2076
+ description: ""
2077
+ default_behavior:
2078
+ auto_detection:
2079
+ description: |
2080
+ The collector automatically detects all of the metrics, no further configuration is required.
2081
+ limits:
2082
+ description: ""
2083
+ performance_impact:
2084
+ description: ""
2085
+ setup:
2086
+ prerequisites:
2087
+ list: []
2088
+ configuration:
2089
+ file:
2090
+ name: "netdata.conf"
2091
+ section_name: "[plugin:windows]"
2092
+ description: "The Netdata main configuration file"
2093
+ options:
2094
+ description: ""
2095
+ folding:
2096
+ title: "Config option"
2097
+ enabled: false
2098
+ list:
2099
+ - name: PerflibAD
2100
+ description: An option to enable or disable the data collection.
2101
+ default_value: yes
2102
+ required: false
2103
+ examples:
2104
+ folding:
2105
+ enabled: true
2106
+ title: ""
2107
+ list: []
2108
+ troubleshooting:
2109
+ problems:
2110
+ list: []
2111
+ alerts: []
2112
+ metrics:
2113
+ folding:
2114
+ title: Metrics
2115
+ enabled: false
2116
+ description: ""
2117
+ availability: []
2118
+ scopes:
2119
+ - name: Active Directory
2120
+ description: "These metrics refer to Active Directory."
2121
+ labels: []
2122
+ metrics:
2123
+ - name: ad.directory_operations
2124
+ description: AD directory operations
2125
+ unit: operations/s
2126
+ chart_type: line
2127
+ dimensions:
2128
+ - name: read
2129
+ - name: write
2130
+ - name: search
2131
+ - name: ad.name_cache_lookups
2132
+ description: Name cache lookups
2133
+ unit: lookups/s
2134
+ chart_type: line
2135
+ dimensions:
2136
+ - name: lookups
2137
+ - name: ad.dra_replication_properties_updated
2138
+ description: DRA replication properties updated
2139
+ unit: properties/s
2140
+ chart_type: line
2141
+ dimensions:
2142
+ - name: inbound
2143
+ - name: ad.dra_replication_properties_filtered
2144
+ description: DRA replication properties filtered
2145
+ unit: properties/s
2146
+ chart_type: line
2147
+ dimensions:
2148
+ - name: inbound
2149
+ - name: ad.dra_replication_intersite_compressed_traffic
2150
+ description: DRA replication compressed traffic withing site
2151
+ unit: bytes/s
2152
+ chart_type: area
2153
+ dimensions:
2154
+ - name: inbound
2155
+ - name: outbound
2156
+ - name: ad.dra_replication_intrasite_compressed_traffic
2157
+ description: DRA replication compressed traffic between sites
2158
+ unit: bytes/s
2159
+ chart_type: area
2160
+ dimensions:
2161
+ - name: inbound
2162
+ - name: outbound
2163
+ - name: ad.dra_replication_pending_syncs
2164
+ description: DRA replication pending syncs
2165
+ unit: syncs
2166
+ chart_type: line
2167
+ dimensions:
2168
+ - name: pending
2169
+ - name: ad.dra_replication_pending_syncs
2170
+ description: DRA replication pending syncs
2171
+ unit: syncs
2172
+ chart_type: line
2173
+ dimensions:
2174
+ - name: pending
2175
+ - name: ad.dra_replication_sync_requests
2176
+ description: DRA replication sync requests
2177
+ unit: requests/s
2178
+ chart_type: line
2179
+ dimensions:
2180
+ - name: request
2181
+ - name: ad.dra_replication_sync_objects_remaining
2182
+ description: DRA replication full sync objects remaining
2183
+ unit: objects
2184
+ chart_type: line
2185
+ dimensions:
2186
+ - name: object
2187
+ - name: ad.dra_replication_sync_objects_remaining
2188
+ description: DRA replication full sync objects remaining
2189
+ unit: objects
2190
+ chart_type: line
2191
+ dimensions:
2192
+ - name: object
2193
+ - name: ad.name_cache_hits
2194
+ description: Name cache hits
2195
+ unit: hits/s
2196
+ chart_type: line
2197
+ dimensions:
2198
+ - name: hits
2199
+ - name: ad.ds_threads
2200
+ description: Directory Service threads
2201
+ unit: threads
2202
+ chart_type: line
2203
+ dimensions:
2204
+ - name: thread
2205
+ - name: ad.ldap_last_bind_time
2206
+ description: LDAP last successful bind time
2207
+ unit: seconds
2208
+ chart_type: line
2209
+ dimensions:
2210
+ - name: last_bind
2211
+ - name: ad.ldap_searches
2212
+ description: LDAP client search operations
2213
+ unit: searches/s
2214
+ chart_type: line
2215
+ dimensions:
2216
+ - name: searches
2217
+ - name: ad.atq_average_request_latency
2218
+ description: Average request processing time
2219
+ unit: seconds
2220
+ chart_type: line
2221
+ dimensions:
2222
+ - name: time
2223
+ - meta:
2224
+ plugin_name: windows.plugin
2225
+ module_name: PerflibADCS
2226
+ monitored_instance:
2227
+ name: Active Directory Certificate Service
2228
+ link: "https://learn.microsoft.com/en-us/windows-server/identity/ad-cs/"
2229
+ categories:
2230
+ - data-collection.windows-systems
2231
+ icon_filename: "windows.svg"
2232
+ related_resources:
2233
+ integrations:
2234
+ list: []
2235
+ info_provided_to_referring_integrations:
2236
+ description: ""
2237
+ keywords:
2238
+ - windows
2239
+ - microsoft
2240
+ - active directory
2241
+ - adcs
2242
+ - ad
2243
+ most_popular: false
2244
+ overview:
2245
+ data_collection:
2246
+ metrics_description: |
2247
+ This collector monitors Active Directory Certificate Services statistics.
2248
+ method_description: |
2249
+ It queries 'Certification Authority' object per certificate from Perflib in order to gather the metrics.
2250
+ supported_platforms:
2251
+ include: ["windows"]
2252
+ exclude: []
2253
+ multi_instance: false
2254
+ additional_permissions:
2255
+ description: ""
2256
+ default_behavior:
2257
+ auto_detection:
2258
+ description: |
2259
+ The collector automatically detects all of the metrics, no further configuration is required.
2260
+ limits:
2261
+ description: ""
2262
+ performance_impact:
2263
+ description: ""
2264
+ setup:
2265
+ prerequisites:
2266
+ list: []
2267
+ configuration:
2268
+ file:
2269
+ name: "netdata.conf"
2270
+ section_name: "[plugin:windows]"
2271
+ description: "The Netdata main configuration file"
2272
+ options:
2273
+ description: ""
2274
+ folding:
2275
+ title: "Config option"
2276
+ enabled: false
2277
+ list:
2278
+ - name: PerflibADCS
2279
+ description: An option to enable or disable the data collection.
2280
+ default_value: yes
2281
+ required: false
2282
+ examples:
2283
+ folding:
2284
+ enabled: true
2285
+ title: ""
2286
+ list: []
2287
+ troubleshooting:
2288
+ problems:
2289
+ list: []
2290
+ alerts: []
2291
+ metrics:
2292
+ folding:
2293
+ title: Metrics
2294
+ enabled: false
2295
+ description: ""
2296
+ availability: []
2297
+ scopes:
2298
+ - name: Certificate Service Certificate
2299
+ description: "These metrics refer to the Certificate instances defined on host."
2300
+ labels:
2301
+ - name: cert
2302
+ description: The certificate name.
2303
+ metrics:
2304
+ - name: adcs.cert_requests
2305
+ description: Certificate requests processed
2306
+ unit: requests/s
2307
+ chart_type: line
2308
+ dimensions:
2309
+ - name: requests
2310
+ - name: adcs.cert_request_processing_time
2311
+ description: Certificate last request processing time
2312
+ unit: seconds
2313
+ chart_type: line
2314
+ dimensions:
2315
+ - name: processing_times
2316
+ - name: adcs.cert_retrievals
2317
+ description: Total of certificate retrievals
2318
+ unit: retrievals/s
2319
+ chart_type: line
2320
+ dimensions:
2321
+ - name: retrievals
2322
+ - name: adcs.cert_failed_requests
2323
+ description: Certificate failed requests processed
2324
+ unit: requests/s
2325
+ chart_type: line
2326
+ dimensions:
2327
+ - name: failed
2328
+ - name: adcs.cert_issued_requests
2329
+ description: Certificate issued requests processed
2330
+ unit: requests/s
2331
+ chart_type: line
2332
+ dimensions:
2333
+ - name: issued
2334
+ - name: adcs.cert_pending_requests
2335
+ description: Certificate pending requests processed
2336
+ unit: requests/s
2337
+ chart_type: line
2338
+ dimensions:
2339
+ - name: pending
2340
+ - name: adcs.cert_challenge_responses
2341
+ description: Certificate challenge responses
2342
+ unit: responses/s
2343
+ chart_type: line
2344
+ dimensions:
2345
+ - name: challenge
2346
+ - name: adcs.cert_retrieval_processing_time
2347
+ description: Certificate last retrieval processing time
2348
+ unit: seconds
2349
+ chart_type: line
2350
+ dimensions:
2351
+ - name: processing_time
2352
+ - name: adcs.cert_request_cryptographic_signing_time
2353
+ description: Certificate last signing operation request time
2354
+ unit: seconds
2355
+ chart_type: line
2356
+ dimensions:
2357
+ - name: singing_time
2358
+ - name: adcs.cert_request_policy_module_processing
2359
+ description: Certificate last policy module processing request time
2360
+ unit: seconds
2361
+ chart_type: line
2362
+ dimensions:
2363
+ - name: processing_time
2364
+ - name: adcs.cert_request_policy_module_processing
2365
+ description: Certificate last policy module processing request time
2366
+ unit: seconds
2367
+ chart_type: line
2368
+ dimensions:
2369
+ - name: processing_time
2370
+ - name: adcs.cert_challenge_response_processing_time
2371
+ description: Certificate last challenge response time
2372
+ unit: seconds
2373
+ chart_type: line
2374
+ dimensions:
2375
+ - name: processing_time
2376
+ - name: adcs.cert_signed_certificate_timestamp_lists
2377
+ description: Certificate Signed Certificate Timestamp Lists processed
2378
+ unit: lists/s
2379
+ chart_type: line
2380
+ dimensions:
2381
+ - name: processing_time
2382
+ - name: adcs.cert_signed_certificate_timestamp_lists
2383
+ description: Certificate Signed Certificate Timestamp Lists processed
2384
+ unit: lists/s
2385
+ chart_type: line
2386
+ dimensions:
2387
+ - name: lists
2388
+ - name: adcs.cert_signed_certificate_timestamp_list_processing_time
2389
+ description: Certificate last Signed Certificate Timestamp List process time
2390
+ unit: seconds
2391
+ chart_type: line
2392
+ dimensions:
2393
+ - name: processing_time
2394
+ - name: adcs.cert_retrieval_processing_time
2395
+ description: Certificate last retrieval processing time
2396
+ unit: seconds
2397
+ chart_type: line
2398
+ dimensions:
2399
+ - name: processing_time
src/collectors/windows.plugin/perflib-ad.c
+3
-3
@@ -359,7 +359,7 @@ intraChart:
359
"PerflibAD",
360
PRIO_AD_REPLICATION_INTRASITE_COMPRESSED,
361
update_every,
362
- RRDSET_TYPE_LINE);
362
+ RRDSET_TYPE_AREA);
363
364
rd_replication_data_intrasite_bytes_total_inbound = rrddim_add(
365
st_dra_replication_intrasite_compressed_traffic, "inbound", NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
@@ -472,7 +472,7 @@ RemainingSyncChart:
472
RRDSET_TYPE_LINE);
473
474
rd_dra_replication_sync_objects_remaining =
475
- rrddim_add(st_dra_replication_sync_objects_remaining, "request", NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
475
+ rrddim_add(st_dra_replication_sync_objects_remaining, "object", NULL, 1, 1, RRD_ALGORITHM_INCREMENTAL);
476
}
477
478
rrddim_set_by_pointer(
@@ -507,7 +507,7 @@ netdata_ad_service_threads_in_use(PERF_DATA_BLOCK *pDataBlock, PERF_OBJECT_TYPE
507
RRDSET_TYPE_LINE);
508
509
rd_directory_services_threads =
510
- rrddim_add(st_directory_services_threads, "in_use", NULL, 1, 1, RRD_ALGORITHM_ABSOLUTE);
510
+ rrddim_add(st_directory_services_threads, "thread", NULL, 1, 1, RRD_ALGORITHM_ABSOLUTE);
511
}
512
513
rrddim_set_by_pointer(
src/collectors/windows.plugin/perflib-adcs.c
+1
-1
@@ -629,7 +629,7 @@ static void netdata_adcs_signed_certificate_timetamp_list_processing(
629
630
ac->rd_adcs_signed_certificate_timestamp_list_processing_time_seconds = rrddim_add(
631
ac->st_adcs_signed_certificate_timestamp_list_processing_time_seconds,
632
- "processing_time",
632
+ "list",
633
NULL,
634
1,
635
1000,
src/collectors/windows.plugin/windows_plugin.c
-2
@@ -46,8 +46,6 @@ static struct proc_module {
46
47
{.name = "PerflibADCS", .dim = "PerflibADCS", .enabled = CONFIG_BOOLEAN_YES, .func = do_PerflibADCS},
48
49
- {.name = "PerflibADCS", .dim = "PerflibADCS", .enabled = CONFIG_BOOLEAN_YES, .func = do_PerflibADCS},
50
-
49
// the terminator of this array
50
{.name = NULL, .dim = NULL, .func = NULL}};
51