From fb9c6524ca6d448ea504d7992c992f9f8cea4112 Mon Sep 17 00:00:00 2001 From: Mickael Maison Date: Tue, 23 Jul 2024 17:15:51 +0200 Subject: [PATCH] Cleanup logging Signed-off-by: Mickael Maison --- .../metrics/DataPointSnapshotBuilder.java | 2 +- .../kafka/metrics/KafkaMetricsCollector.java | 8 +++----- .../KafkaPrometheusMetricsReporter.java | 7 ++----- .../PrometheusMetricsReporterConfig.java | 2 +- .../kafka/metrics/YammerMetricsCollector.java | 18 ++++++------------ .../YammerPrometheusMetricsReporter.java | 4 ++-- 6 files changed, 15 insertions(+), 26 deletions(-) diff --git a/src/main/java/io/strimzi/kafka/metrics/DataPointSnapshotBuilder.java b/src/main/java/io/strimzi/kafka/metrics/DataPointSnapshotBuilder.java index 629f9da..6dc8ef9 100644 --- a/src/main/java/io/strimzi/kafka/metrics/DataPointSnapshotBuilder.java +++ b/src/main/java/io/strimzi/kafka/metrics/DataPointSnapshotBuilder.java @@ -19,7 +19,7 @@ */ public class DataPointSnapshotBuilder { - private static final Logger LOG = LoggerFactory.getLogger(DataPointSnapshotBuilder.class.getName()); + private static final Logger LOG = LoggerFactory.getLogger(DataPointSnapshotBuilder.class); /** * Create a datapoint for a {@link InfoSnapshot} metric diff --git a/src/main/java/io/strimzi/kafka/metrics/KafkaMetricsCollector.java b/src/main/java/io/strimzi/kafka/metrics/KafkaMetricsCollector.java index c0007c6..b8ab59f 100644 --- a/src/main/java/io/strimzi/kafka/metrics/KafkaMetricsCollector.java +++ b/src/main/java/io/strimzi/kafka/metrics/KafkaMetricsCollector.java @@ -31,7 +31,7 @@ */ public class KafkaMetricsCollector implements MultiCollector { - private static final Logger LOG = LoggerFactory.getLogger(KafkaMetricsCollector.class.getName()); + private static final Logger LOG = LoggerFactory.getLogger(KafkaMetricsCollector.class); private final Map metrics; private final PrometheusMetricsReporterConfig config; @@ -87,16 +87,14 @@ public MetricSnapshots collect() { for (Map.Entry entry : metrics.entrySet()) { MetricName metricName = entry.getKey(); KafkaMetric kafkaMetric = entry.getValue(); - LOG.trace("Collecting Kafka metric {}", metricName); String prometheusMetricName = metricName(metricName); - // TODO Filtering should take labels into account if (!config.isAllowed(prometheusMetricName)) { - LOG.info("Kafka metric {} is not allowed", prometheusMetricName); + LOG.trace("Ignoring metric {} as it does not match the allowlist", prometheusMetricName); continue; } - LOG.info("Kafka metric {} is allowed", prometheusMetricName); Labels labels = labelsFromTags(metricName.tags(), metricName.name()); + LOG.debug("Collecting metric {} with the following labels: {}", prometheusMetricName, labels); Object valueObj = kafkaMetric.metricValue(); if (valueObj instanceof Number) { diff --git a/src/main/java/io/strimzi/kafka/metrics/KafkaPrometheusMetricsReporter.java b/src/main/java/io/strimzi/kafka/metrics/KafkaPrometheusMetricsReporter.java index fb33fb1..f33846e 100644 --- a/src/main/java/io/strimzi/kafka/metrics/KafkaPrometheusMetricsReporter.java +++ b/src/main/java/io/strimzi/kafka/metrics/KafkaPrometheusMetricsReporter.java @@ -28,7 +28,7 @@ */ public class KafkaPrometheusMetricsReporter implements MetricsReporter { - private static final Logger LOG = LoggerFactory.getLogger(KafkaPrometheusMetricsReporter.class.getName()); + private static final Logger LOG = LoggerFactory.getLogger(KafkaPrometheusMetricsReporter.class); private final PrometheusRegistry registry; @SuppressFBWarnings({"UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"}) // This field is initialized in the configure method @@ -55,6 +55,7 @@ public void configure(Map map) { // Add JVM metrics JvmMetrics.builder().register(registry); httpServer = config.startHttpServer(); + LOG.debug("KafkaPrometheusMetricsReporter configured with {}", config); } @Override @@ -67,20 +68,17 @@ public void init(List metrics) { @Override public void metricChange(KafkaMetric metric) { - LOG.info("Kafka metricChange {}", metric.metricName()); kafkaMetricsCollector.addMetric(metric); } @Override public void metricRemoval(KafkaMetric metric) { - LOG.info("Kafka metricRemoval {}", metric.metricName()); kafkaMetricsCollector.removeMetric(metric); } @Override public void close() { registry.unregister(kafkaMetricsCollector); - LOG.info("Closing the HTTP server"); } @Override @@ -98,7 +96,6 @@ public Set reconfigurableConfigs() { @Override public void contextChange(MetricsContext metricsContext) { - LOG.info("Kafka contextChange with {}", metricsContext.contextLabels()); String prefix = metricsContext.contextLabels().get(MetricsContext.NAMESPACE); kafkaMetricsCollector.setPrefix(prefix); } diff --git a/src/main/java/io/strimzi/kafka/metrics/PrometheusMetricsReporterConfig.java b/src/main/java/io/strimzi/kafka/metrics/PrometheusMetricsReporterConfig.java index 94066d5..baa7d53 100644 --- a/src/main/java/io/strimzi/kafka/metrics/PrometheusMetricsReporterConfig.java +++ b/src/main/java/io/strimzi/kafka/metrics/PrometheusMetricsReporterConfig.java @@ -28,7 +28,7 @@ */ public class PrometheusMetricsReporterConfig extends AbstractConfig { - private static final Logger LOG = LoggerFactory.getLogger(PrometheusMetricsReporterConfig.class.getName()); + private static final Logger LOG = LoggerFactory.getLogger(PrometheusMetricsReporterConfig.class); private static final String CONFIG_PREFIX = "prometheus.metrics.reporter."; /** diff --git a/src/main/java/io/strimzi/kafka/metrics/YammerMetricsCollector.java b/src/main/java/io/strimzi/kafka/metrics/YammerMetricsCollector.java index dcb5892..4ea7c4c 100644 --- a/src/main/java/io/strimzi/kafka/metrics/YammerMetricsCollector.java +++ b/src/main/java/io/strimzi/kafka/metrics/YammerMetricsCollector.java @@ -44,7 +44,7 @@ @SuppressWarnings("ClassFanOutComplexity") public class YammerMetricsCollector implements MultiCollector { - private static final Logger LOG = LoggerFactory.getLogger(YammerMetricsCollector.class.getName()); + private static final Logger LOG = LoggerFactory.getLogger(YammerMetricsCollector.class); private static final List QUANTILES = Arrays.asList(0.50, 0.75, 0.95, 0.98, 0.99, 0.999); private final List registries; @@ -76,17 +76,14 @@ public MetricSnapshots collect() { for (Map.Entry entry : registry.allMetrics().entrySet()) { MetricName metricName = entry.getKey(); Metric metric = entry.getValue(); - LOG.trace("Collecting Yammer metric {}", metricName); String prometheusMetricName = metricName(metricName); - // TODO Filtering should take labels into account if (!config.isAllowed(prometheusMetricName)) { - LOG.info("Yammer metric {} is not allowed", prometheusMetricName); + LOG.trace("Ignoring metric {} as it does not match the allowlist", prometheusMetricName); continue; } - LOG.info("Yammer metric {} is allowed", prometheusMetricName); Labels labels = labelsFromScope(metricName.getScope(), prometheusMetricName); - LOG.info("labels {}", labels); + LOG.debug("Collecting metric {} with the following labels: {}", prometheusMetricName, labels); if (metric instanceof Counter) { Counter counter = (Counter) metric; @@ -115,7 +112,7 @@ public MetricSnapshots collect() { CounterSnapshot.Builder builder = counterBuilders.computeIfAbsent(prometheusMetricName, k -> CounterSnapshot.builder().name(prometheusMetricName)); builder.dataPoint(DataPointSnapshotBuilder.counterDataPoint(labels, meter.count())); } else { - LOG.error("The metric {} has an unexpected type.", metric.getClass().getName()); + LOG.error("The metric {} has an unexpected type: {}", prometheusMetricName, metric.getClass().getName()); } } } @@ -136,13 +133,11 @@ public MetricSnapshots collect() { } private static String metricName(MetricName metricName) { - String metricNameStr = PrometheusNaming.sanitizeMetricName( + return PrometheusNaming.sanitizeMetricName( "kafka_server_" + metricName.getGroup() + '_' + metricName.getType() + '_' + metricName.getName()).toLowerCase(Locale.ROOT); - LOG.info("metricName group {}, type {}, name {} converted into {}", metricName.getGroup(), metricName.getType(), metricName.getName(), metricNameStr); - return metricNameStr; } static Labels labelsFromScope(String scope, String metricName) { @@ -156,8 +151,7 @@ static Labels labelsFromScope(String scope, String metricName) { if (labelNames.add(newLabelName)) { builder.label(newLabelName, parts[i + 1]); } else { - String value = parts[i + 1]; - LOG.warn("Ignoring duplicate label key: {} with value: {} from metric: {} ", newLabelName, value, metricName); + LOG.warn("Ignoring duplicate label key: {} with value: {} from metric: {} ", newLabelName, parts[i + 1], metricName); } } } diff --git a/src/main/java/io/strimzi/kafka/metrics/YammerPrometheusMetricsReporter.java b/src/main/java/io/strimzi/kafka/metrics/YammerPrometheusMetricsReporter.java index 3d27b02..2247588 100644 --- a/src/main/java/io/strimzi/kafka/metrics/YammerPrometheusMetricsReporter.java +++ b/src/main/java/io/strimzi/kafka/metrics/YammerPrometheusMetricsReporter.java @@ -15,7 +15,7 @@ */ public class YammerPrometheusMetricsReporter implements KafkaMetricsReporter { - private static final Logger LOG = LoggerFactory.getLogger(YammerPrometheusMetricsReporter.class.getName()); + private static final Logger LOG = LoggerFactory.getLogger(YammerPrometheusMetricsReporter.class); private final PrometheusRegistry registry; @@ -33,9 +33,9 @@ public YammerPrometheusMetricsReporter() { @Override public void init(VerifiableProperties props) { - LOG.info(">>> in init() yammer"); PrometheusMetricsReporterConfig config = new PrometheusMetricsReporterConfig(props.props(), registry); registry.register(new YammerMetricsCollector(config)); + LOG.debug("YammerPrometheusMetricsReporter configured with {}", config); } }