remove duplicated broker prometheus metrics type #8995
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 changes
Dec 18, 2020
| Pattern typePattern = Pattern.compile("^#\\s+TYPE\\s+(\\w+)\\s+(\\w+)"); | ||
| Pattern metricNamePattern = Pattern.compile("^(\\w+)\\{.+"); | ||
|
|
||
| Splitter.on("\n").split(metricsStr).forEach(line -> { |
There was a problem hiding this comment.
I think this block has intention issue.
There was a problem hiding this comment.
Removed the tab. The code block is to catch any issues with duplicated definition of metrics TYPE and also ensures the metric name matches the ones defined in the type definition header.
| typeDefs.put(metricName, type); | ||
| } else { | ||
| fail("Duplicate type definition found for TYPE definition " + metricName); | ||
| System.out.println(metricsStr); |
There was a problem hiding this comment.
I am not sure why do we need this line if it will fail before this line.
|
@sijie @wolfstudy can we pick this change to 2.6.3 and 2.7.1 ? |
|
/pulsarbot run-failure-checks |
hangc0276
approved these changes
Dec 21, 2020
sijie
approved these changes
Dec 22, 2020
codelipenghui
pushed a commit
that referenced
this pull request
Dec 23, 2020
### Motivation If there are multiple topics from different namespaces, the broker prometheus metrics will print out duplicated `# TYPE` definition for pulsar_ml_AddEntryBytesRate and other managed ledger metrics. In fact, this problem can be verified by `promtool` https://github.com/prometheus/prometheus#building-from-source On the broker, run this command to check validity of Pulsar broker metric format. `curl localhost:8080/metrics/ | ~/go/bin/promtool check metrics` ### Modifications To prevent duplicated metrics type definition, the definition is now tracked and only printed out once. It leverages the existing metrics name Set already defined under parseMetricsToPrometheusMetrics() in PrometheusMetricsGenerator.java ### Verifying this change - [ x] Make sure that the change passes the CI checks. This change added tests and can be verified as follows: Added two topics under new namespaces to trigger conditions that duplicated prometheus type could happen previously under testManagedLedgerStats() of PrometheusMetricsTest.java. Updated test cases checks this duplicated type problem. (cherry picked from commit 7319819)
codelipenghui
added
cherry-picked/branch-2.6
cherry-picked/branch-2.7
codelipenghui
pushed a commit
that referenced
this pull request
Dec 23, 2020
### Motivation If there are multiple topics from different namespaces, the broker prometheus metrics will print out duplicated `# TYPE` definition for pulsar_ml_AddEntryBytesRate and other managed ledger metrics. In fact, this problem can be verified by `promtool` https://github.com/prometheus/prometheus#building-from-source On the broker, run this command to check validity of Pulsar broker metric format. `curl localhost:8080/metrics/ | ~/go/bin/promtool check metrics` ### Modifications To prevent duplicated metrics type definition, the definition is now tracked and only printed out once. It leverages the existing metrics name Set already defined under parseMetricsToPrometheusMetrics() in PrometheusMetricsGenerator.java ### Verifying this change - [ x] Make sure that the change passes the CI checks. This change added tests and can be verified as follows: Added two topics under new namespaces to trigger conditions that duplicated prometheus type could happen previously under testManagedLedgerStats() of PrometheusMetricsTest.java. Updated test cases checks this duplicated type problem. (cherry picked from commit 7319819)
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.
Motivation
If there are multiple topics from different namespaces, the broker prometheus metrics will print out duplicated
# TYPEdefinition for pulsar_ml_AddEntryBytesRate and other managed ledger metrics.In fact, this problem can be verified by
promtoolhttps://github.com/prometheus/prometheus#building-from-sourceOn the broker, run this command to check validity of Pulsar broker metric format.
curl localhost:8080/metrics/ | ~/go/bin/promtool check metricsModifications
To prevent duplicated metrics type definition, the definition is now tracked and only printed out once. It leverages the existing metrics name Set already defined under parseMetricsToPrometheusMetrics() in PrometheusMetricsGenerator.java
Verifying this change
This change added tests and can be verified as follows:
Added two topics under new namespaces to trigger conditions that duplicated prometheus type could happen previously under testManagedLedgerStats() of PrometheusMetricsTest.java. Updated test cases checks this duplicated type problem.
Does this pull request potentially affect one of the following parts:
If
yeswas chosen, please highlight the changesDocumentation