-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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.
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
Add support of PrometheusRawMetricsProvider for the Pulsar-Proxy #14681
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
106 changes: 106 additions & 0 deletions
106
.../main/java/org/apache/pulsar/broker/stats/prometheus/PrometheusMetricsGeneratorUtils.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.broker.stats.prometheus; | ||
|
|
||
| import io.netty.buffer.ByteBuf; | ||
| import io.netty.buffer.ByteBufAllocator; | ||
| import io.prometheus.client.Collector; | ||
| import io.prometheus.client.CollectorRegistry; | ||
| import java.io.IOException; | ||
| import java.io.OutputStream; | ||
| import java.util.Enumeration; | ||
| import java.util.List; | ||
| import org.apache.pulsar.common.util.SimpleTextOutputStream; | ||
|
|
||
| /** | ||
| * Generate metrics in a text format suitable to be consumed by Prometheus. | ||
| * Format specification can be found at {@link https://prometheus.io/docs/instrumenting/exposition_formats/} | ||
| */ | ||
| public class PrometheusMetricsGeneratorUtils { | ||
|
|
||
| public static void generate(String cluster, OutputStream out, | ||
| List<PrometheusRawMetricsProvider> metricsProviders) | ||
| throws IOException { | ||
| ByteBuf buf = ByteBufAllocator.DEFAULT.heapBuffer(); | ||
| try { | ||
| SimpleTextOutputStream stream = new SimpleTextOutputStream(buf); | ||
| generateSystemMetrics(stream, cluster); | ||
| if (metricsProviders != null) { | ||
| for (PrometheusRawMetricsProvider metricsProvider : metricsProviders) { | ||
| metricsProvider.generate(stream); | ||
| } | ||
| } | ||
| out.write(buf.array(), buf.arrayOffset(), buf.readableBytes()); | ||
| } finally { | ||
| buf.release(); | ||
| } | ||
| } | ||
|
|
||
| public static void generateSystemMetrics(SimpleTextOutputStream stream, String cluster) { | ||
| Enumeration<Collector.MetricFamilySamples> metricFamilySamples = | ||
| CollectorRegistry.defaultRegistry.metricFamilySamples(); | ||
| while (metricFamilySamples.hasMoreElements()) { | ||
| Collector.MetricFamilySamples metricFamily = metricFamilySamples.nextElement(); | ||
|
|
||
| // Write type of metric | ||
| stream.write("# TYPE ").write(metricFamily.name).write(' ') | ||
| .write(getTypeStr(metricFamily.type)).write('\n'); | ||
|
|
||
| for (int i = 0; i < metricFamily.samples.size(); i++) { | ||
| Collector.MetricFamilySamples.Sample sample = metricFamily.samples.get(i); | ||
| stream.write(sample.name); | ||
| stream.write("{cluster=\"").write(cluster).write('"'); | ||
| for (int j = 0; j < sample.labelNames.size(); j++) { | ||
| String labelValue = sample.labelValues.get(j); | ||
| if (labelValue != null) { | ||
| labelValue = labelValue.replace("\"", "\\\""); | ||
| } | ||
|
|
||
| stream.write(","); | ||
| stream.write(sample.labelNames.get(j)); | ||
| stream.write("=\""); | ||
| stream.write(labelValue); | ||
| stream.write('"'); | ||
| } | ||
|
|
||
| stream.write("} "); | ||
| stream.write(Collector.doubleToGoString(sample.value)); | ||
| stream.write('\n'); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| static String getTypeStr(Collector.Type type) { | ||
| switch (type) { | ||
| case COUNTER: | ||
| return "counter"; | ||
| case GAUGE: | ||
| return "gauge"; | ||
| case SUMMARY : | ||
| return "summary"; | ||
| case HISTOGRAM: | ||
| return "histogram"; | ||
| case UNTYPED: | ||
| default: | ||
| return "untyped"; | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
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
File renamed without changes.
19 changes: 19 additions & 0 deletions
19
...r-broker-common/src/main/java/org/apache/pulsar/broker/stats/prometheus/package-info.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.broker.stats.prometheus; |
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
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
52 changes: 52 additions & 0 deletions
52
...c/main/java/org/apache/pulsar/broker/stats/prometheus/PulsarPrometheusMetricsServlet.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.broker.stats.prometheus; | ||
|
|
||
| import java.io.IOException; | ||
| import javax.servlet.ServletOutputStream; | ||
| import org.apache.pulsar.broker.PulsarService; | ||
|
|
||
| public class PulsarPrometheusMetricsServlet extends PrometheusMetricsServlet { | ||
|
|
||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| private final PulsarService pulsar; | ||
| private final boolean shouldExportTopicMetrics; | ||
| private final boolean shouldExportConsumerMetrics; | ||
| private final boolean shouldExportProducerMetrics; | ||
| private final boolean splitTopicAndPartitionLabel; | ||
|
|
||
| public PulsarPrometheusMetricsServlet(PulsarService pulsar, boolean includeTopicMetrics, | ||
| boolean includeConsumerMetrics, boolean shouldExportProducerMetrics, | ||
| boolean splitTopicAndPartitionLabel) { | ||
| super(pulsar.getConfiguration().getMetricsServletTimeoutMs(), pulsar.getConfiguration().getClusterName()); | ||
| this.pulsar = pulsar; | ||
| this.shouldExportTopicMetrics = includeTopicMetrics; | ||
| this.shouldExportConsumerMetrics = includeConsumerMetrics; | ||
| this.shouldExportProducerMetrics = shouldExportProducerMetrics; | ||
| this.splitTopicAndPartitionLabel = splitTopicAndPartitionLabel; | ||
| } | ||
|
|
||
| @Override | ||
| protected void generateMetrics(String cluster, ServletOutputStream outputStream) throws IOException { | ||
| PrometheusMetricsGenerator.generate(pulsar, shouldExportTopicMetrics, shouldExportConsumerMetrics, | ||
| shouldExportProducerMetrics, splitTopicAndPartitionLabel, outputStream, | ||
| metricsProviders); | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason for introducing new http status code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@codelipenghui
because we are not importing org.eclipse.jetty.http.HttpStatus anymore
500 is used below