From c114ce3770cbefc4b26a5677ec073a9682dd1119 Mon Sep 17 00:00:00 2001 From: Dragos Misca Date: Mon, 8 Jul 2024 19:41:42 -0700 Subject: [PATCH 1/2] [feat][doc] PIP-264: Add authentication and token metrics reference --- docs/reference-metrics-opentelemetry.md | 26 +++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/reference-metrics-opentelemetry.md b/docs/reference-metrics-opentelemetry.md index 55a06d4d5e4d..1fea58534134 100644 --- a/docs/reference-metrics-opentelemetry.md +++ b/docs/reference-metrics-opentelemetry.md @@ -695,3 +695,29 @@ The number of Schema Registry compatibility check operations performed by the br * `pulsar.schema_registry.compatibility_check.response` - The compatibility check response type * `compatible` * `incompatible` + +### Authentication Metrics + +#### pulsar.authentication.operation.count +The number of authentication operations. +* Type: Counter +* Unit: `{operation}` +* Attributes: + * `pulsar.authentication.provider` - The name of the authentication provider class. + * `pulsar.authentication.method` - The name of the authentication method. + * `pulsar.authentication.result` - The authentication result. Can be one of: + * `success` + * `failure` + * `pulsar.authentication.error` - The authentication error, if the result is `failure`. + +### Token Metrics + +#### pulsar.authentication.token.expired.count +The total number of expired tokens. +* Type: Counter +* Unit: `{token}` + +#### pulsar.authentication.token.expiry.duration +The remaining time of expiring token in seconds. +* Type: Histogram +* Unit: `s` From 2b0ffeac39db18131879580d287d7213fd436789 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Tue, 29 Oct 2024 13:35:36 +0200 Subject: [PATCH 2/2] Apply to 4.0.x --- .../reference-metrics-opentelemetry.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md b/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md index 4af8bf83b291..524cea21358c 100644 --- a/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md +++ b/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md @@ -1055,3 +1055,29 @@ The number of transactions handled by the persistent ack store. * `pulsar.transaction.pending.ack.store.operation.status` - The status of the pending acknowledgment store operation. Can be one of: * `failure` * `success` + +### Authentication Metrics + +#### pulsar.authentication.operation.count +The number of authentication operations. +* Type: Counter +* Unit: `{operation}` +* Attributes: + * `pulsar.authentication.provider` - The name of the authentication provider class. + * `pulsar.authentication.method` - The name of the authentication method. + * `pulsar.authentication.result` - The authentication result. Can be one of: + * `success` + * `failure` + * `pulsar.authentication.error` - The authentication error, if the result is `failure`. + +### Token Metrics + +#### pulsar.authentication.token.expired.count +The total number of expired tokens. +* Type: Counter +* Unit: `{token}` + +#### pulsar.authentication.token.expiry.duration +The remaining time of expiring token in seconds. +* Type: Histogram +* Unit: `s`