Regenerate integrations docs (#19804)
Co-authored-by: thiagoftsm <49162938+thiagoftsm@users.noreply.github.com>
Netdata bot committed
Mar 8, 2025 at 11:14 UTC
149434ad849ba56c8ab18049990e48d4a497b660
2 files changed
+153
src/collectors/COLLECTORS.md
+2
@@ -1165,6 +1165,8 @@ If you don't see the app/service you'd like to monitor in this list:
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 Federation Service](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory_federation_service.md)
1169
+
1170
- [Active Directory](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/active_directory.md)
1171
1172
- [Hyper-V](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/hyper-v.md)
src/collectors/windows.plugin/integrations/active_directory_federation_service.md
new
+151
@@ -0,0 +1,151 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/active_directory_federation_service.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "Active Directory Federation 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 Federation Service
12
+
13
+
14
+<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: PerflibADFS
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors Active Directory Federation Services statistics.
25
+
26
+
27
+It queries 'AD FS' 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 Federation Service
62
+
63
+These metrics refer to the Federated Identity and Access Management on host.
64
+
65
+This scope has no labels.
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| adfs.ad_login_connection_failures | connection | failures/s |
72
+| adfs.certificate_authentications | authentications | authentications/s |
73
+| adfs.db_artifact_failures | connection | failures/s |
74
+| adfs.db_artifact_query_time_seconds | query_time | seconds/s |
75
+| adfs.db_config_failures | connection | failures/s |
76
+| adfs.db_config_query_time_seconds | query_time | seconds/s |
77
+| adfs.device_authentications | authentications | authentications/s |
78
+| adfs.external_authentications | success, failure | authentications/s |
79
+| adfs.federated_authentications | authentications | authentications/s |
80
+| adfs.federation_metadata_requests | requests | requests/s |
81
+| adfs.oauth_authorization_requests | requests | requests/s |
82
+| adfs.oauth_client_authentications | success, failure | authentications/s |
83
+| adfs.oauth_client_credentials_requests | success, failure | requests/s |
84
+| adfs.oauth_client_privkey_jwt_authentications | success, failure | authentications/s |
85
+| adfs.oauth_client_secret_basic_authentications | success, failure | authentications/s |
86
+| adfs.oauth_client_secret_basic_authentications | success, failure | authentications/s |
87
+| adfs.oauth_client_secret_post_authentications | success, failure | authentications/s |
88
+| adfs.oauth_client_windows_authentications | success, failure | requests/s |
89
+| adfs.oauth_logon_certificate_requests | success, failure | requests/s |
90
+| adfs.oauth_password_grant_requests | success, failure | requests/s |
91
+| adfs.oauth_token_requests_success | success | requests/s |
92
+| adfs.passive_requests | passive | requests/s |
93
+| adfs.passport_authentications | passport | authentications/s |
94
+| adfs.password_change_requests | success, failure | requests/s |
95
+| adfs.samlp_token_requests_success | success | requests/s |
96
+| adfs.sso_authentications | success, failure | authentications/s |
97
+| adfs.token_requests | requests | requests/s |
98
+| adfs.userpassword_authentications | success, failure | authentications/s |
99
+| adfs.windows_integrated_authentications | authentications | authentications/s |
100
+| adfs.wsfed_token_requests_success | success | requests/s |
101
+| adfs.wstrust_token_requests_success | success | requests/s |
102
+
103
+
104
+
105
+## Alerts
106
+
107
+There are no alerts configured by default for this integration.
108
+
109
+
110
+## Setup
111
+
112
+### Prerequisites
113
+
114
+No action required.
115
+
116
+### Configuration
117
+
118
+#### File
119
+
120
+The configuration file name for this integration is `netdata.conf`.
121
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
122
+
123
+The file format is a modified INI syntax. The general structure is:
124
+
125
+```ini
126
+[section1]
127
+ option1 = some value
128
+ option2 = some other value
129
+
130
+[section2]
131
+ option3 = some third value
132
+```
133
+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
134
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
135
+
136
+```bash
137
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
138
+sudo ./edit-config netdata.conf
139
+```
140
+#### Options
141
+
142
+
143
+
144
+| Name | Description | Default | Required |
145
+|:----|:-----------|:-------|:--------:|
146
+| PerflibADFS | An option to enable or disable the data collection. | yes | no |
147
+
148
+#### Examples
149
+There are no configuration examples.
150
+
151
+