davsclaus commented on code in PR #25444:
URL: https://github.com/apache/camel/pull/25444#discussion_r3757463051
##########
components/camel-micrometer/src/main/java/org/apache/camel/component/micrometer/json/AbstractMicrometerService.java:
##########
@@ -243,19 +264,165 @@ static Map<String, Object> convertMeterToMap(Meter
meter) {
}
void logMetricsOnShutdown(String... filters) {
- meterRegistry.getMeters().stream()
- .filter(m ->
AbstractMicrometerService.matchesFilter(m.getId().getName(), filters))
- .map(AbstractMicrometerService::convertMeterToMap)
- .forEach(logEntry -> {
- try {
- // we include a start and end tag to make sure the
- // scraper can more easily identify the metric content.
- String metric = "#METRIC-START#" +
mapper.writeValueAsString(logEntry) + "#METRIC-END#";
- LOG.info(metric);
- } catch (Exception e) {
- LOG.error("Error logging metric " +
logEntry.get("name"), e);
+ if ("prometheus".equalsIgnoreCase(logMetricsOnShutdownFormat)) {
+ List<Meter> meters = meterRegistry.getMeters().stream()
+ .filter(m -> AbstractMicrometerService.matchesFilter(
+ m.getId().getName(), filters))
+ .sorted(Comparator.comparing(m -> {
Review Comment:
Minor: this can be simplified to a method reference:
```suggestion
.sorted(Comparator.comparing(AbstractMicrometerService::normalizePrometheusName))
```
##########
components/camel-micrometer/src/test/java/org/apache/camel/component/micrometer/json/AbstractMicrometerServicePrometheusFormatTest.java:
##########
@@ -0,0 +1,237 @@
+/*
+ * 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.camel.component.micrometer.json;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+import io.micrometer.core.instrument.*;
Review Comment:
Minor: Camel conventions use explicit imports rather than wildcard imports.
Running `mvn install -DskipTests` in the module should auto-format these.
##########
components/camel-micrometer/src/main/java/org/apache/camel/component/micrometer/json/AbstractMicrometerService.java:
##########
@@ -243,19 +264,165 @@ static Map<String, Object> convertMeterToMap(Meter
meter) {
}
void logMetricsOnShutdown(String... filters) {
- meterRegistry.getMeters().stream()
- .filter(m ->
AbstractMicrometerService.matchesFilter(m.getId().getName(), filters))
- .map(AbstractMicrometerService::convertMeterToMap)
- .forEach(logEntry -> {
- try {
- // we include a start and end tag to make sure the
- // scraper can more easily identify the metric content.
- String metric = "#METRIC-START#" +
mapper.writeValueAsString(logEntry) + "#METRIC-END#";
- LOG.info(metric);
- } catch (Exception e) {
- LOG.error("Error logging metric " +
logEntry.get("name"), e);
+ if ("prometheus".equalsIgnoreCase(logMetricsOnShutdownFormat)) {
+ List<Meter> meters = meterRegistry.getMeters().stream()
+ .filter(m -> AbstractMicrometerService.matchesFilter(
+ m.getId().getName(), filters))
+ .sorted(Comparator.comparing(m -> {
+ return normalizePrometheusName(m);
+ }))
+ .toList();
+
+ String previousPromName = null;
+
+ for (Meter meter : meters) {
+ String promName = normalizePrometheusName(meter);
+
+ List<String> lines = convertMeterToPrometheusLines(promName,
meter);
+ boolean newMetric = !promName.equals(previousPromName);
+
+ for (String line : lines) {
+ if (!newMetric
+ && (line.startsWith("# HELP ")
+ || line.startsWith("# TYPE "))) {
+ continue;
}
- });
+
+ LOG.info("#METRIC-START#{}#METRIC-END#", line);
+ }
+
+ previousPromName = promName;
+ }
+
+ } else {
+ meterRegistry.getMeters().stream()
+ .filter(m ->
AbstractMicrometerService.matchesFilter(m.getId().getName(), filters))
+ .map(AbstractMicrometerService::convertMeterToMap)
+ .forEach(this::logMetricsAsJson);
+ }
+ }
+
+ private void logMetricsAsJson(Map<String, Object> logEntry) {
+ try {
+ // we include a start and end tag to make sure the
+ // scraper can more easily identify the metric content.
+ String metric = "#METRIC-START#" +
mapper.writeValueAsString(logEntry) + "#METRIC-END#";
+ LOG.info(metric);
+ } catch (Exception e) {
+ LOG.error("Error logging metric {}", logEntry.get("name"), e);
+ }
+ }
+
+ /**
+ * Converts a single {@link Meter} into one or more Prometheus
text-exposition lines.
+ * <p>
+ * The output follows the Prometheus text format specification:
+ *
+ * <pre>
+ * # HELP <name> <description>
+ * # TYPE <name> <type>
+ * <name>{labels} <value>
+ * </pre>
+ *
+ * Metric names use underscores in place of dots/hyphens as required by
Prometheus naming rules.
+ */
+ static List<String> convertMeterToPrometheusLines(String promName, Meter
meter) {
+ String description = meter.getId().getDescription() != null ?
meter.getId().getDescription() : promName;
+ String labels = buildPrometheusLabels(meter.getId().getTags());
+
+ List<String> lines = new ArrayList<>();
+
+ if (meter instanceof Gauge g) {
+ lines.add("# HELP " + promName + " " + description);
+ lines.add("# TYPE " + promName + " gauge");
+ lines.add(promName + labels + " " +
formatPrometheusDouble(g.value()));
+ } else if (meter instanceof Counter c) {
+ lines.add("# HELP " + promName + "_total " + description);
+ lines.add("# TYPE " + promName + "_total counter");
+ lines.add(promName + "_total" + labels + " " +
formatPrometheusDouble(c.count()));
+ } else if (meter instanceof Timer t) {
+ lines.add("# HELP " + promName + "_seconds " + description);
+ lines.add("# TYPE " + promName + "_seconds summary");
+ lines.add(promName + "_seconds_count" + labels + " " + t.count());
+ lines.add(promName + "_seconds_sum" + labels + " " +
formatPrometheusDouble(t.totalTime(TimeUnit.SECONDS)));
+ lines.add(promName + "_seconds_max" + labels + " " +
formatPrometheusDouble(t.max(TimeUnit.SECONDS)));
+ } else if (meter instanceof DistributionSummary ds) {
+ lines.add("# HELP " + promName + " " + description);
+ lines.add("# TYPE " + promName + " summary");
+ lines.add(promName + "_count" + labels + " " + ds.count());
+ lines.add(promName + "_sum" + labels + " " +
formatPrometheusDouble(ds.totalAmount()));
+ lines.add(promName + "_max" + labels + " " +
formatPrometheusDouble(ds.max()));
+ } else if (meter instanceof FunctionCounter fc) {
+ lines.add("# HELP " + promName + "_total " + description);
+ lines.add("# TYPE " + promName + "_total counter");
+ lines.add(promName + "_total" + labels + " " +
formatPrometheusDouble(fc.count()));
+ } else if (meter instanceof FunctionTimer ft) {
+ lines.add("# HELP " + promName + "_seconds " + description);
+ lines.add("# TYPE " + promName + "_seconds summary");
+ lines.add(promName + "_seconds_count" + labels + " " +
formatPrometheusDouble(ft.count()));
+ lines.add(promName + "_seconds_sum" + labels + " " +
formatPrometheusDouble(ft.totalTime(TimeUnit.SECONDS)));
+ } else if (meter instanceof LongTaskTimer ltt) {
+ lines.add("# HELP " + promName + "_active_seconds " + description);
+ lines.add("# TYPE " + promName + "_active_seconds gauge");
+ lines.add(promName + "_active_seconds_active" + labels + " " +
ltt.activeTasks());
+ lines.add(promName + "_active_seconds_duration" + labels + " "
+ +
formatPrometheusDouble(ltt.duration(TimeUnit.SECONDS)));
+ lines.add(promName + "_active_seconds_max" + labels + " "
Review Comment:
The LongTaskTimer naming here (`_active_seconds_active`,
`_active_seconds_duration`, `_active_seconds_max`) doesn't follow the standard
Prometheus/Micrometer naming convention. The standard format would be:
```
<name>_seconds_active_count (active tasks)
<name>_seconds_duration_sum (total duration)
<name>_seconds_max (max duration)
```
Using the standard naming would be more consistent with what users see from
`PrometheusMeterRegistry.scrape()` and avoids confusion when comparing log
output to scrape output.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
