[Authentication]Add authentication metrics #9244
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sijie
requested review from
sijie,
315157973,
codelipenghui,
hangc0276,
jiazhai and
merlimat
sijie
added
area/security
type/enhancement
|
/pulsarbot run-failure-checks |
sijie
reviewed
Jan 20, 2021
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
codelipenghui
added
the
doc-required
|
/pulsarbot run-failure-checks |
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
pulsar-broker/src/main/java/org/apache/pulsar/broker/service/BrokerService.java
Outdated
Show resolved
Hide resolved
pulsar-broker/src/test/java/org/apache/pulsar/broker/stats/PrometheusMetricsTest.java
Outdated
Show resolved
Hide resolved
|
/pulsarbot run-failure-checks |
4 similar comments
|
/pulsarbot run-failure-checks |
|
/pulsarbot run-failure-checks |
|
/pulsarbot run-failure-checks |
|
/pulsarbot run-failure-checks |
Fix counters and labels name Co-authored-by: lipenghui <penghui@apache.org>
RobertIndie
force-pushed
the
auth-metrics
branch
from
f959cc8
to
7b29e67
Compare
|
/pulsarbot run-failure-checks |
1 similar comment
|
/pulsarbot run-failure-checks |
...mon/src/main/java/org/apache/pulsar/broker/authentication/metrics/AuthenticationMetrics.java
Outdated
Show resolved
Hide resolved
Whenever a successful authentication is triggered, the log is stored in the |
codelipenghui
approved these changes
Jan 25, 2021
|
/pulsarbot run-failure-checks |
codelipenghui
pushed a commit
that referenced
this pull request
Jan 26, 2021
### Motivation Currently, if many clients are failing to authenticate, it might not be clear as to the reason why. For JWT auth for example, it could be because the JWT failed to validate, or that a token is expired. In a busy system, these messages are too noisy to log, so we should instead consider metrics that provide info on successful vs failed auths, as well as auth failure reasons ### Modifications * Implement `AuthenticationMetrics` API that allows for instrumenting auth success, and auth failures, with a Prometheus compatible attribute used to distinguish failure reasons. * Add auth metrics instrument to the `basic auth`, `jwt auth`, `tls auth`, `athenz auth` and `sasl auth`. (cherry picked from commit f89dbb6)
Anonymitaet
removed
the
doc-required
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Master Issue: streamnative/platform-epics#217
Motivation
Currently, if many clients are failing to authenticate, it might not be clear as to the reason why. For JWT auth for example, it could be because the JWT failed to validate, or that a token is expired. In a busy system, these messages are too noisy to log, so we should instead consider metrics that provide info on successful vs failed auths, as well as auth failure reasons
Modifications
Implement
AuthenticationMetricsAPI that allows for instrumenting auth success, and auth failures, with a Prometheus compatible attribute used to distinguish failure reasons.Add auth metrics instrument to the
basic auth,jwt auth,tls auth,athenz authandsasl auth.Add metric
pulsar_authentication_success_countwith two labelsprovider_nameandauth_methodAdd metric
pulsar_authentication_failures_countwith 3 labelsprovider_name,auth_methodandreasonVerifying this change
This change is already covered by existing tests, such as testAuthMetrics.