Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[feat][doc] PIP-264: Add authentication and token metrics reference #937

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[feat][doc] PIP-264: Add authentication and token metrics reference #937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/reference-metrics-opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Loading