Table of Contents

Class Telemetry.Metrics

Namespace
Duende.IdentityServer
Assembly
Duende.IdentityServer.dll

Metrics configuration.

public static class Telemetry.Metrics
Inheritance
Telemetry.Metrics
Inherited Members

Fields

ActiveRequestCounter

Counter for active requests.

public static readonly UpDownCounter<long> ActiveRequestCounter

Field Value

UpDownCounter<long>

ApiSecretValidationCounter

Successful Api Secret validations

public static Counter<long> ApiSecretValidationCounter

Field Value

Counter<long>

BackChannelAuthenticationCounter

Successful back channel (CIBA) authentications counter

public static readonly Counter<long> BackChannelAuthenticationCounter

Field Value

Counter<long>

ClientSecretValidationCounter

Successful Client Secret validations

public static Counter<long> ClientSecretValidationCounter

Field Value

Counter<long>

ClientValidationCounter

Client configuration validation

public static Counter<long> ClientValidationCounter

Field Value

Counter<long>

DeviceAuthenticationCounter

Successful device code authentication counter

public static readonly Counter<long> DeviceAuthenticationCounter

Field Value

Counter<long>

DynamicIdentityProviderValidationCounter

Dynamic identityprovider validations

public static Counter<long> DynamicIdentityProviderValidationCounter

Field Value

Counter<long>

ExperimentalMeter

Meter for experimental counters from IdentityServer

public static readonly Meter ExperimentalMeter

Field Value

Meter

IntrospectionCounter

Introspection success counter

public static readonly Counter<long> IntrospectionCounter

Field Value

Counter<long>

Meter

Meter for IdentityServer

public static readonly Meter Meter

Field Value

Meter

OperationCounter

High level number of operations and result/outcome

public static readonly Counter<long> OperationCounter

Field Value

Counter<long>

PushedAuthorizationRequestCounter

Pushed Authorization Request Counter

public static Counter<long> PushedAuthorizationRequestCounter

Field Value

Counter<long>

ResourceOwnerAuthenticationCounter

Resource Owner Authentication Counter

public static Counter<long> ResourceOwnerAuthenticationCounter

Field Value

Counter<long>

RevocationCounter

Revocation success counter.

public static readonly Counter<long> RevocationCounter

Field Value

Counter<long>

TokenIssuedCounter

Successful token issuance counter.

public static readonly Counter<long> TokenIssuedCounter

Field Value

Counter<long>

Methods

ApiSecretValidation(string, string)

Helper method to increase ApiSecretValidationCounter

public static void ApiSecretValidation(string apiId, string authMethod)

Parameters

apiId string

Api Id

authMethod string

Authentication Method

ApiSecretValidationFailure(string, string)

Helper method to increase ApiSecretValidationFailure(string, string) on errors

public static void ApiSecretValidationFailure(string clientId, string message)

Parameters

clientId string

Client Id

message string

Error message

BackChannelAuthentication(string)

Helper method to increase BackChannelAuthenticationCounter

public static void BackChannelAuthentication(string clientId)

Parameters

clientId string

Client Id

BackChannelAuthenticationFailure(string, string)

Helper method to increase BackChannelAuthenticationCounter on errors

public static void BackChannelAuthenticationFailure(string clientId, string error)

Parameters

clientId string
error string

ClientSecretValidation(string, string)

Helper method to increase ClientSecretValidationCounter

public static void ClientSecretValidation(string clientId, string authMethod)

Parameters

clientId string
authMethod string

ClientSecretValidationFailure(string, string)

Helper method to increase ClientSecretValidationCounter on failure.

public static void ClientSecretValidationFailure(string clientId, string message)

Parameters

clientId string

Client Id

message string

Error message

ClientValidation(string)

Helper method to increase ClientValidationCounter

public static void ClientValidation(string clientId)

Parameters

clientId string

ClientValidationFailure(string, string)

Helper method to increase ClientValidationCounter on errors

public static void ClientValidationFailure(string clientId, string error)

Parameters

clientId string

Client id

error string

Error

DecreaseActiveRequests(string, string)

Decrease ActiveRequestCounter

public static void DecreaseActiveRequests(string endpointType, string path)

Parameters

endpointType string

Type name for endpoint

path string

Path

DeviceAuthentication(string)

Helper method to increase DeviceAuthenticationCounter

public static void DeviceAuthentication(string clientId)

Parameters

clientId string

Client ID

DeviceAuthenticationFailure(string, string)

Helper method to increase DeviceAuthenticationCounter on error

public static void DeviceAuthenticationFailure(string clientId, string error)

Parameters

clientId string

Client Id

error string

Error

DynamicIdentityProviderValidation(string)

Helper method to increase DynamicIdentityProviderValidationCounter

public static void DynamicIdentityProviderValidation(string scheme)

Parameters

scheme string

DynamicIdentityProviderValidationFailure(string, string)

Helper method to increase DynamicIdentityProviderValidationCounter on errors

public static void DynamicIdentityProviderValidationFailure(string scheme, string error)

Parameters

scheme string

Scheme name

error string

Error message

Failure(string, string)

Helper method to increase the OperationCounter with an error event

public static void Failure(string error, string clientId = null)

Parameters

error string

Error message

clientId string

Client involved in event

IncreaseActiveRequests(string, string)

Increase ActiveRequestCounter

public static void IncreaseActiveRequests(string endpointType, string path)

Parameters

endpointType string

Type name for endpoint

path string

Path

Introspection(string, bool)

Helper method to increase IntrospectionCounter

public static void Introspection(string callerId, bool active)

Parameters

callerId string
active bool

Is the token valid/active?

IntrospectionFailure(string, string)

Helper method to increase IntrospectionCounter on errors

public static void IntrospectionFailure(string callerId, string error)

Parameters

callerId string

Api resource or client Id

error string

Error message

PushedAuthorizationRequest(string)

Helper method to increase PushedAuthorizationRequestCounter

public static void PushedAuthorizationRequest(string clientId)

Parameters

clientId string

PushedAuthorizationRequestFailure(string, string)

Helper method to increase PushedAuthorizationRequestCounter on errors.

public static void PushedAuthorizationRequestFailure(string clientId, string error)

Parameters

clientId string
error string

Error reason

ResourceOwnerAuthentication(string)

Helper method to increase ResourceOwnerAuthenticationCounter

public static void ResourceOwnerAuthentication(string clientId)

Parameters

clientId string

ResourceOwnerAuthenticationFailure(string, string)

Helper method to increase ResourceOwnerAuthenticationCounter on errors

public static void ResourceOwnerAuthenticationFailure(string clientId, string message)

Parameters

clientId string

Client Id

message string

Error message

Revocation(string)

Helper method to increase RevocationCounter

public static void Revocation(string clientId)

Parameters

clientId string

Client id

RevocationFailure(string, string)

Helper method to increase RevocationCounter on errors.

public static void RevocationFailure(string clientId, string error)

Parameters

clientId string

Client id

error string

Error

Success(string)

Helper method to increase the OperationCounter with a success event

public static void Success(string clientId = null)

Parameters

clientId string

Client involved in event

TokenIssued(string, string, AuthorizeRequestType?)

Helper method to increase TokenIssuedCounter

public static void TokenIssued(string clientId, string grantType, AuthorizeRequestType? requestType)

Parameters

clientId string

Client Id

grantType string

Grant Type

requestType AuthorizeRequestType?

Type of authorization request

TokenIssuedFailure(string, string, AuthorizeRequestType?, string)

Helper method to increase TokenIssuedCounter on errors

public static void TokenIssuedFailure(string clientId, string grantType, AuthorizeRequestType? requestType, string error)

Parameters

clientId string

Client Id

grantType string

Grant Type

requestType AuthorizeRequestType?

Type of authorization request

error string

Error

UnHandledException(Exception)

Helper method to increase OperationCounter on internal errors

public static void UnHandledException(Exception ex)

Parameters

ex Exception

Exception