This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 2ac7778a2de7 [feat][doc] PIP-264: Add authentication and token metrics
reference (#937)
2ac7778a2de7 is described below
commit 2ac7778a2de741d3c62b195f0dd7ba4ec7d0db5e
Author: Dragos Misca <[email protected]>
AuthorDate: Tue Oct 29 04:36:23 2024 -0700
[feat][doc] PIP-264: Add authentication and token metrics reference (#937)
* [feat][doc] PIP-264: Add authentication and token metrics reference
* Apply to 4.0.x
---------
Co-authored-by: Lari Hotari <[email protected]>
---
docs/reference-metrics-opentelemetry.md | 26 ++++++++++++++++++++++
.../reference-metrics-opentelemetry.md | 26 ++++++++++++++++++++++
2 files changed, 52 insertions(+)
diff --git a/docs/reference-metrics-opentelemetry.md
b/docs/reference-metrics-opentelemetry.md
index 4af8bf83b291..524cea21358c 100644
--- a/docs/reference-metrics-opentelemetry.md
+++ b/docs/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`
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`
