From 704f6e2fe4fb0fbf0a53345196a08e12cd1bf1eb Mon Sep 17 00:00:00 2001 From: Ben Reedy Date: Thu, 12 Nov 2020 17:46:20 +1000 Subject: [PATCH] Fix ADFS collector metric names Prometheus counters should have a '_total' suffix Signed-off-by: Ben Reedy --- collector/adfs.go | 22 +++++++++++----------- docs/collector.adfs.md | 20 ++++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/collector/adfs.go b/collector/adfs.go index 73519113..9357b8b1 100644 --- a/collector/adfs.go +++ b/collector/adfs.go @@ -30,67 +30,67 @@ func newADFSCollector() (Collector, error) { return &adfsCollector{ adLoginConnectionFailures: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "ad_login_connection_failures"), + prometheus.BuildFQName(Namespace, subsystem, "ad_login_connection_failures_total"), "Total number of connection failures to an Active Directory domain controller", nil, nil, ), certificateAuthentications: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "certificate_authentications"), + prometheus.BuildFQName(Namespace, subsystem, "certificate_authentications_total"), "Total number of User Certificate authentications", nil, nil, ), deviceAuthentications: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "device_authentications"), + prometheus.BuildFQName(Namespace, subsystem, "device_authentications_total"), "Total number of Device authentications", nil, nil, ), extranetAccountLockouts: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "extranet_account_lockouts"), + prometheus.BuildFQName(Namespace, subsystem, "extranet_account_lockouts_total"), "Total number of Extranet Account Lockouts", nil, nil, ), federatedAuthentications: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "federated_authentications"), + prometheus.BuildFQName(Namespace, subsystem, "federated_authentications_total"), "Total number of authentications from a federated source", nil, nil, ), passportAuthentications: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "passport_authentications"), + prometheus.BuildFQName(Namespace, subsystem, "passport_authentications_total"), "Total number of Microsoft Passport SSO authentications", nil, nil, ), passiveRequests: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "passive_requests"), + prometheus.BuildFQName(Namespace, subsystem, "passive_requests_total"), "Total number of passive (browser-based) requests", nil, nil, ), passwordChangeFailed: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "password_change_failed"), + prometheus.BuildFQName(Namespace, subsystem, "password_change_failed_total"), "Total number of failed password changes", nil, nil, ), passwordChangeSucceeded: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "password_change_succeeded"), + prometheus.BuildFQName(Namespace, subsystem, "password_change_succeeded_total"), "Total number of successful password changes", nil, nil, ), tokenRequests: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "token_requests"), + prometheus.BuildFQName(Namespace, subsystem, "token_requests_total"), "Total number of token requests", nil, nil, ), windowsIntegratedAuthentications: prometheus.NewDesc( - prometheus.BuildFQName(Namespace, subsystem, "windows_integrated_authentications"), + prometheus.BuildFQName(Namespace, subsystem, "windows_integrated_authentications_total"), "Total number of Windows integrated authentications (Kerberos/NTLM)", nil, nil, diff --git a/docs/collector.adfs.md b/docs/collector.adfs.md index e104dd37..2b97228c 100644 --- a/docs/collector.adfs.md +++ b/docs/collector.adfs.md @@ -18,16 +18,16 @@ None Name | Description | Type | Labels -----|-------------|------|------- -`windows_adfs_ad_login_connection_failures` | Total number of connection failures between the ADFS server and the Active Directory domain controller(s) | counter | None -`windows_adfs_certificate_authentications` | Total number of [User Certificate](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/configure-user-certificate-authentication) authentications. I.E. smart cards or mobile devices with provisioned client certificates | counter | None -`windows_adfs_device_authentications` | Total number of [device authentications](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/device-authentication-controls-in-ad-fs) (SignedToken, clientTLS, PkeyAuth). Device authentication is only available on ADFS 2016 or later | counter | None -`windows_adfs_extranet_account_lockouts` | Total number of [extranet lockouts](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/configure-ad-fs-extranet-smart-lockout-protection). Requires the Extranet Lockout feature to be enabled | counter | None -`windows_adfs_federated_authentications` | Total number of authentications from federated sources. E.G. Office365 | counter | None -`windows_adfs_passport_authentications` | Total number of authentications from [Microsoft Passport](https://en.wikipedia.org/wiki/Microsoft_account) (now named Microsoft Account) | counter | None -`windows_adfs_password_change_failed` | Total number of failed password changes. The Password Change Portal must be enabled in the AD FS Management tool in order to allow user password changes | counter | None -`windows_adfs_password_change_succeeded` | Total number of succeeded password changes. The Password Change Portal must be enabled in the AD FS Management tool in order to allow user password changes | counter | None -`windows_adfs_token_requests` | Total number of requested access tokens | counter | None -`windows_adfs_windows_integrated_authentications` | Total number of Windows integrated authentications using Kerberos or NTLM | counter | None +`windows_adfs_ad_login_connection_failures_total` | Total number of connection failures between the ADFS server and the Active Directory domain controller(s) | counter | None +`windows_adfs_certificate_authentications_total` | Total number of [User Certificate](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/configure-user-certificate-authentication) authentications. I.E. smart cards or mobile devices with provisioned client certificates | counter | None +`windows_adfs_device_authentications_total` | Total number of [device authentications](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/device-authentication-controls-in-ad-fs) (SignedToken, clientTLS, PkeyAuth). Device authentication is only available on ADFS 2016 or later | counter | None +`windows_adfs_extranet_account_lockouts_total` | Total number of [extranet lockouts](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/configure-ad-fs-extranet-smart-lockout-protection). Requires the Extranet Lockout feature to be enabled | counter | None +`windows_adfs_federated_authentications_total` | Total number of authentications from federated sources. E.G. Office365 | counter | None +`windows_adfs_passport_authentications_total` | Total number of authentications from [Microsoft Passport](https://en.wikipedia.org/wiki/Microsoft_account) (now named Microsoft Account) | counter | None +`windows_adfs_password_change_failed_total` | Total number of failed password changes. The Password Change Portal must be enabled in the AD FS Management tool in order to allow user password changes | counter | None +`windows_adfs_password_change_succeeded_total` | Total number of succeeded password changes. The Password Change Portal must be enabled in the AD FS Management tool in order to allow user password changes | counter | None +`windows_adfs_token_requests_total` | Total number of requested access tokens | counter | None +`windows_adfs_windows_integrated_authentications_total` | Total number of Windows integrated authentications using Kerberos or NTLM | counter | None ### Example metric Show rate of device authentications in AD FS: