Expose compaction metrics to Prometheus #11739

Technoboy- · 2021-08-22T01:02:09Z

Motivation

As #11564 has involved compaction metrics in CLI, it's extremely useful to expose relative metrics to Prometheus.

pulsar_compaction_removed_event_count : the removed event count of compaction .
pulsar_compaction_succeed_count : the succeed count of compaction.
pulsar_compaction_failed_count : the failed count of compaction.
pulsar_compaction_duration_time_in_millis : the duration time of compaction.
pulsar_compaction_read_throughput : the read throughput of compaction.
pulsar_compaction_write_throughput : the write throughput of compaction.
pulsar_compaction_compacted_entries_count: the compacted entries count.
pulsar_compaction_compacted_entries_size: the compacted entries size;

if users enable the topic level metrics and the topic has been compacted or doing the compaction, we should expose the compaction metrics for the topic level. If users disable the topic level metrics, we should expose the aggregated compaction metrics for the namespace level.

Documentation

For contributor

The document is required.

Anonymitaet · 2021-08-23T01:00:10Z

Thanks for your contribution. Please do not forget to update docs later. And you can ping me to review the docs, thanks.

eolivelli

very good.

I left one comment about exposing an "Impl" class in PersistentTopic.

PTAL

pulsar-broker/src/main/java/org/apache/pulsar/broker/service/persistent/PersistentTopic.java

pulsar-broker/src/test/java/org/apache/pulsar/broker/stats/CompactionMetricsTest.java

Technoboy- · 2021-08-25T13:24:31Z

very good.

I left one comment about exposing an "Impl" class in PersistentTopic.

PTAL

Thanks for reviewing.

eolivelli

LGTM

Technoboy- · 2021-08-26T08:18:38Z

/pulsarbot run-failure-checks

michaeljmarshall · 2021-08-26T22:05:16Z

Just took a glance, and this is a good addition. ~~change. When reviewing #11564, I forgot to mention that we should provide a way to disable metrics at a topic level~~. I plan to review this PR more thoroughly within 24 hours.

michaeljmarshall

This is a great start. I left a couple comments where I think we can improve the data modeling to minimize the number of get calls required to retrieve metrics from the same CompactionRecord object.

pulsar-broker/src/main/java/org/apache/pulsar/broker/service/BrokerService.java

pulsar-broker/src/main/java/org/apache/pulsar/broker/stats/metrics/CompactionMetrics.java

michaeljmarshall · 2021-08-27T04:35:44Z

@Technoboy- it could also be convenient to allow users to aggregate these metrics at a namespace level, but not a topic level. This would especially be helpful for users with many compacted topics.

Technoboy- · 2021-08-27T10:25:48Z

@Technoboy- it could also be convenient to allow users to aggregate these metrics at a namespace level, but not a topic level. This would especially be helpful for users with many compacted topics.

Yes, the current CompactorMetrics is based on namespace level. And many thanks for your kind reivew.

Technoboy- · 2021-08-27T12:14:09Z

/pulsarbot run-failure-checks

michaeljmarshall

@Technoboy- thanks for making those changes. It looks great to me. The only change I can see is to update the computeIfAbsent logic to prevent the same value from being added twice.

pulsar-broker/src/main/java/org/apache/pulsar/broker/stats/metrics/AbstractMetrics.java

pulsar-broker/src/main/java/org/apache/pulsar/broker/stats/metrics/CompactionMetrics.java

pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java

hangc0276

Please add a test to check the final prometheus metric output result in PrometheusMetricsTest

pulsar-broker/src/main/java/org/apache/pulsar/broker/service/persistent/PersistentTopic.java

michaeljmarshall

LGTM. Thanks for addressing all of my feedback.

Technoboy- · 2021-08-31T01:22:30Z

LGTM. Thanks for addressing all of my feedback.

Many thanks for your kind review.

Technoboy- · 2021-08-31T02:46:43Z

Please add a test to check the final prometheus metric output result in PrometheusMetricsTest

Yes, done. Thanks for reviewing.

Anonymitaet · 2021-09-02T03:03:07Z

Hi @sijia-w, in this PR, @Technoboy- has already added docs tomaster.

Could you please add the same contents to 2.8.2?
If you find any inaccurate expressions, incorrect grammar usage, or other issues, you can modify the docs based on technical writing rules.

Thanks!

### Motivation As #11564 has involved compaction metrics in CLI, it's extremely useful to expose relative metrics to Prometheus. - pulsar_compaction_removed_event_count : the removed event count of compaction . - pulsar_compaction_succeed_count : the succeed count of compaction. - pulsar_compaction_failed_count : the failed count of compaction. - pulsar_compaction_duration_time_in_millis : the duration time of compaction. - pulsar_compaction_read_throughput : the read throughput of compaction. - pulsar_compaction_write_throughput : the write throughput of compaction. - pulsar_compaction_compacted_entries_count: the compacted entries count. - pulsar_compaction_compacted_entries_size: the compacted entries size; if users enable the topic level metrics and the topic has been compacted or doing the compaction, we should expose the compaction metrics for the topic level. If users disable the topic level metrics, we should expose the aggregated compaction metrics for the namespace level. (cherry picked from commit 656635e)

### Motivation As apache#11564 has involved compaction metrics in CLI, it's extremely useful to expose relative metrics to Prometheus. - pulsar_compaction_removed_event_count : the removed event count of compaction . - pulsar_compaction_succeed_count : the succeed count of compaction. - pulsar_compaction_failed_count : the failed count of compaction. - pulsar_compaction_duration_time_in_millis : the duration time of compaction. - pulsar_compaction_read_throughput : the read throughput of compaction. - pulsar_compaction_write_throughput : the write throughput of compaction. - pulsar_compaction_compacted_entries_count: the compacted entries count. - pulsar_compaction_compacted_entries_size: the compacted entries size; if users enable the topic level metrics and the topic has been compacted or doing the compaction, we should expose the compaction metrics for the topic level. If users disable the topic level metrics, we should expose the aggregated compaction metrics for the namespace level. (cherry picked from commit 656635e) (cherry picked from commit a80f1e8)

### Motivation As apache#11564 has involved compaction metrics in CLI, it's extremely useful to expose relative metrics to Prometheus. - pulsar_compaction_removed_event_count : the removed event count of compaction . - pulsar_compaction_succeed_count : the succeed count of compaction. - pulsar_compaction_failed_count : the failed count of compaction. - pulsar_compaction_duration_time_in_millis : the duration time of compaction. - pulsar_compaction_read_throughput : the read throughput of compaction. - pulsar_compaction_write_throughput : the write throughput of compaction. - pulsar_compaction_compacted_entries_count: the compacted entries count. - pulsar_compaction_compacted_entries_size: the compacted entries size; if users enable the topic level metrics and the topic has been compacted or doing the compaction, we should expose the compaction metrics for the topic level. If users disable the topic level metrics, we should expose the aggregated compaction metrics for the namespace level.

…, apache#11810, and apache#11563

Technoboy- added a commit to Technoboy-/pulsar that referenced this pull request Aug 22, 2021

Expose compaction metrics to Prometheus (apache#11739)

adcd231

Technoboy- force-pushed the compacted-topic-metrics-2 branch from 88b3c8f to adcd231 Compare August 22, 2021 01:19

Technoboy- changed the title ~~Expose compaction metrics to Prometheus~~ [WIP]Expose compaction metrics to Prometheus Aug 22, 2021

Anonymitaet added the doc-required Your PR changes impact docs and you will update later. label Aug 23, 2021

codelipenghui assigned Technoboy- Aug 23, 2021

codelipenghui added this to the 2.9.0 milestone Aug 23, 2021

codelipenghui added release/2.8.2 area/metrics labels Aug 23, 2021

Expose compaction metrics to Prometheus (apache#11739)

7eab18b

Technoboy- force-pushed the compacted-topic-metrics-2 branch from adcd231 to 7eab18b Compare August 23, 2021 09:51

Technoboy- changed the title ~~[WIP]Expose compaction metrics to Prometheus~~ Expose compaction metrics to Prometheus Aug 23, 2021

fix checkstyle

aaca286

codelipenghui requested review from eolivelli, codelipenghui, hangc0276, 315157973, gaoran10, merlimat and sijie August 25, 2021 02:12

eolivelli requested changes Aug 25, 2021

View reviewed changes

pulsar-broker/src/main/java/org/apache/pulsar/broker/service/persistent/PersistentTopic.java Outdated Show resolved Hide resolved

pulsar-broker/src/test/java/org/apache/pulsar/broker/stats/CompactionMetricsTest.java Outdated Show resolved Hide resolved

make CompactedTopicContext as public

07c118d

eolivelli approved these changes Aug 25, 2021

View reviewed changes

michaeljmarshall requested changes Aug 27, 2021

View reviewed changes

refactor CompactorMXBean

b681d1d

michaeljmarshall requested changes Aug 27, 2021

View reviewed changes

fix add object twice

867c3e1

codelipenghui reviewed Aug 30, 2021

View reviewed changes

pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java Outdated Show resolved Hide resolved

hangc0276 reviewed Aug 30, 2021

View reviewed changes

pulsar-broker/src/main/java/org/apache/pulsar/broker/service/persistent/PersistentTopic.java Outdated Show resolved Hide resolved

Technoboy- added 4 commits August 30, 2021 22:42

put metrics to topic level

bf5912d

update doc

1d9b160

add test

bf87c05

update doc

e9fcccd

michaeljmarshall approved these changes Aug 30, 2021

View reviewed changes

add test case

ff89d75

codelipenghui approved these changes Aug 31, 2021

View reviewed changes

codelipenghui merged commit 656635e into apache:master Aug 31, 2021

Anonymitaet added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. and removed doc-required Your PR changes impact docs and you will update later. labels Sep 1, 2021

Anonymitaet mentioned this pull request Sep 1, 2021

[Doc] generate doc set for 2.8.2 #11870

Merged

codelipenghui added the cherry-picked/branch-2.8 Archived: 2.8 is end of life label Sep 2, 2021

sijia-w mentioned this pull request Sep 2, 2021

[docs] Update compaction metrics in 282 #11896

Merged

hangc0276 added release/2.8.1 and removed release/2.8.2 labels Sep 4, 2021

momo-jun added a commit to momo-jun/pulsar that referenced this pull request Aug 5, 2022

Merge 2.8.1-specific docs from apache#11509, apache#11512, apache#11739…

e18ce57

…, apache#11810, and apache#11563

Technoboy- deleted the compacted-topic-metrics-2 branch August 10, 2022 05:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose compaction metrics to Prometheus #11739

Expose compaction metrics to Prometheus #11739

Technoboy- commented Aug 22, 2021 •

edited

Anonymitaet commented Aug 23, 2021

eolivelli left a comment

Technoboy- commented Aug 25, 2021

eolivelli left a comment

Technoboy- commented Aug 26, 2021

michaeljmarshall commented Aug 26, 2021 •

edited

michaeljmarshall left a comment

michaeljmarshall commented Aug 27, 2021

Technoboy- commented Aug 27, 2021 •

edited

Technoboy- commented Aug 27, 2021

michaeljmarshall left a comment

hangc0276 left a comment

michaeljmarshall left a comment

Technoboy- commented Aug 31, 2021

Technoboy- commented Aug 31, 2021

Anonymitaet commented Sep 2, 2021 •

edited

Expose compaction metrics to Prometheus #11739

Expose compaction metrics to Prometheus #11739

Conversation

Technoboy- commented Aug 22, 2021 • edited

Motivation

Documentation

For contributor

Anonymitaet commented Aug 23, 2021

eolivelli left a comment

Choose a reason for hiding this comment

Technoboy- commented Aug 25, 2021

eolivelli left a comment

Choose a reason for hiding this comment

Technoboy- commented Aug 26, 2021

michaeljmarshall commented Aug 26, 2021 • edited

michaeljmarshall left a comment

Choose a reason for hiding this comment

michaeljmarshall commented Aug 27, 2021

Technoboy- commented Aug 27, 2021 • edited

Technoboy- commented Aug 27, 2021

michaeljmarshall left a comment

Choose a reason for hiding this comment

hangc0276 left a comment

Choose a reason for hiding this comment

michaeljmarshall left a comment

Choose a reason for hiding this comment

Technoboy- commented Aug 31, 2021

Technoboy- commented Aug 31, 2021

Anonymitaet commented Sep 2, 2021 • edited

Technoboy- commented Aug 22, 2021 •

edited

michaeljmarshall commented Aug 26, 2021 •

edited

Technoboy- commented Aug 27, 2021 •

edited

Anonymitaet commented Sep 2, 2021 •

edited