<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/active_directory_federation_service.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
sidebar_label: "Active Directory Federation Service"
learn_status: "Published"
learn_rel_path: "Collecting Metrics/Collectors/Applications"
keywords: ['windows', 'microsoft', 'active directory', 'adfs', 'ad']
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# Active Directory Federation Service


<img src="https://netdata.cloud/img/windows.svg" width="150"/>


Plugin: windows.plugin
Module: PerflibADFS

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

## Overview

This collector monitors Active Directory Federation Services statistics.


It queries 'AD FS' object from Perflib in order to gather the metrics.


This collector is only supported on the following platforms:

- windows

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


### Default Behavior

#### Auto-Detection

The collector automatically detects all of the metrics, no further configuration is required.


#### Limits

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

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

## Setup


### Prerequisites

No action required.

### Configuration

#### Options





| Option | Description | Default | Required |
|:-----|:------------|:--------|:---------:|
| update every | Data collection frequency. | 10 | no |




#### via File

The configuration file name for this integration is `netdata.conf`.
Configuration for this specific integration is located in the `[plugin:windows:PerflibADFS]` section within that file.

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

```ini
[section1]
    option1 = some value
    option2 = some other value

[section2]
    option3 = some third value
```
You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).

```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf
```

##### Examples
There are no configuration examples.



## Alerts

There are no alerts configured by default for this integration.



## Metrics

Metrics grouped by *scope*.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.




### Per Federation Service

These metrics refer to the Federated Identity and Access Management on host.

This scope has no labels.

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| adfs.ad_login_connection_failures | Connection failures | connection | failures/s |
| adfs.certificate_authentications | User Certificate authentications | authentications | authentications/s |
| adfs.db_artifact_failures | Connection failures to the artifact database | connection | failures/s |
| adfs.db_artifact_query_time_seconds | Time taken for an artifact database query | query_time | seconds/s |
| adfs.db_config_failures | Connection failures to the configuration database | connection | failures/s |
| adfs.db_config_query_time_seconds | Time taken for a configuration database query | query_time | seconds/s |
| adfs.device_authentications | Device authentications | authentications | authentications/s |
| adfs.extranet_account_lockouts | Extranet account lockouts | lockouts | lockouts/s |
| adfs.external_authentications | Authentications from external MFA providers | success, failure | authentications/s |
| adfs.federated_authentications | Authentications from Federated Sources | authentications | authentications/s |
| adfs.federation_metadata_requests | Federation Metadata requests | requests | requests/s |
| adfs.oauth_authorization_requests | Incoming requests to the OAuth Authorization endpoint | requests | requests/s |
| adfs.oauth_client_authentications | OAuth client credentials requests | success, failure | authentications/s |
| adfs.oauth_client_credentials_requests | OAuth client credentials requests | success, failure | requests/s |
| adfs.oauth_client_privkey_jwt_authentications | OAuth client private key JWT authentications | success, failure | authentications/s |
| adfs.oauth_client_secret_basic_authentications | OAuth client secret basic authentications | success, failure | authentications/s |
| adfs.oauth_client_secret_basic_authentications | OAuth client secret basic authentications | success, failure | authentications/s |
| adfs.oauth_client_secret_post_authentications | OAuth client secret post authentications | success, failure | authentications/s |
| adfs.oauth_client_windows_authentications | OAuth client windows integrated authentications | success, failure | requests/s |
| adfs.oauth_logon_certificate_requests | OAuth logon certificate requests | success, failure | requests/s |
| adfs.oauth_password_grant_requests | OAuth password grant requests | success, failure | requests/s |
| adfs.oauth_token_requests_success | Successful RP token requests over OAuth protocol | success | requests/s |
| adfs.passive_requests | Passive requests | passive | requests/s |
| adfs.passport_authentications | Microsoft Passport SSO authentications | passport | authentications/s |
| adfs.password_change_requests | Password change requests | success, failure | requests/s |
| adfs.samlp_token_requests_success | Successful RP token requests over SAML-P protocol | success | requests/s |
| adfs.sso_authentications | SSO authentications | success, failure | authentications/s |
| adfs.token_requests | Token access requests | requests | requests/s |
| adfs.userpassword_authentications | AD U/P authentications | success, failure | authentications/s |
| adfs.windows_integrated_authentications | Windows integrated authentications using Kerberos or NTLM | authentications | authentications/s |
| adfs.wsfed_token_requests_success | Successful RP token requests over WS-Fed protocol | success | requests/s |
| adfs.wstrust_token_requests_success | Successful RP token requests over WS-Trust protocol | success | requests/s |
