├── .travis.yml ├── .gitignore ├── src ├── main │ └── java │ │ └── no │ │ └── sysco │ │ └── middleware │ │ └── prometheus │ │ └── kafka │ │ ├── clients │ │ ├── KafkaStreamMetrics.java │ │ ├── KafkaConsumerMetrics.java │ │ ├── KafkaProducerMetrics.java │ │ └── KafkaMetrics.java │ │ ├── KafkaClientsJmxExports.java │ │ └── ClientsJmxCollector.java └── test │ └── java │ └── no │ └── sysco │ └── middleware │ └── prometheus │ └── kafka │ └── clients │ ├── KafkaStreamMetricsTest.java │ ├── KafkaProducerMetricsTest.java │ └── KafkaConsumerMetricsTest.java ├── architecture.log.md ├── README.md ├── pom.xml └── LICENSE /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | cache: 3 | directories: 4 | - $HOME/.m2 5 | 6 | language: java 7 | 8 | jdk: 9 | - openjdk8 10 | 11 | script: 12 | - mvn clean verify -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | # editor files 3 | *.swp 4 | *.iml 5 | .idea 6 | 7 | # compilation objects 8 | target/ 9 | .project 10 | .settings/ 11 | .classpath 12 | dependency-reduced-pom.xml 13 | codemr/ -------------------------------------------------------------------------------- /src/main/java/no/sysco/middleware/prometheus/kafka/clients/KafkaStreamMetrics.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka.clients; 2 | 3 | import org.apache.kafka.streams.KafkaStreams; 4 | 5 | public class KafkaStreamMetrics extends KafkaMetrics { 6 | public KafkaStreamMetrics(KafkaStreams kafkaStreams) { super(kafkaStreams::metrics); } 7 | } 8 | -------------------------------------------------------------------------------- /src/main/java/no/sysco/middleware/prometheus/kafka/clients/KafkaConsumerMetrics.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka.clients; 2 | 3 | import org.apache.kafka.clients.consumer.Consumer; 4 | 5 | public class KafkaConsumerMetrics extends KafkaMetrics { 6 | public KafkaConsumerMetrics(Consumer kafkaConsumer) { super(kafkaConsumer::metrics); } 7 | } 8 | -------------------------------------------------------------------------------- /src/main/java/no/sysco/middleware/prometheus/kafka/clients/KafkaProducerMetrics.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka.clients; 2 | 3 | import org.apache.kafka.clients.producer.Producer; 4 | 5 | public final class KafkaProducerMetrics extends KafkaMetrics { 6 | public KafkaProducerMetrics(Producer kafkaProducer) { super(kafkaProducer::metrics); } 7 | } 8 | -------------------------------------------------------------------------------- /src/main/java/no/sysco/middleware/prometheus/kafka/KafkaClientsJmxExports.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka; 2 | 3 | public class KafkaClientsJmxExports { 4 | private static boolean initialized = false; 5 | 6 | public static synchronized void initialize(Object... clients) { 7 | if (!initialized) { 8 | new ClientsJmxCollector(clients).register(); 9 | initialized = true; 10 | } 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/test/java/no/sysco/middleware/prometheus/kafka/clients/KafkaStreamMetricsTest.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka.clients; 2 | 3 | import java.util.Properties; 4 | import java.util.UUID; 5 | import org.apache.kafka.common.serialization.Serdes; 6 | import org.apache.kafka.streams.KafkaStreams; 7 | import org.apache.kafka.streams.StreamsBuilder; 8 | import org.apache.kafka.streams.StreamsConfig; 9 | import org.junit.Test; 10 | 11 | import static org.junit.Assert.assertTrue; 12 | 13 | public class KafkaStreamMetricsTest { 14 | private static final String BOOTSTRAP_SERVERS = "localhost:29092"; 15 | 16 | @Test 17 | public void verify() { 18 | String id = UUID.randomUUID().toString(); 19 | KafkaStreams streams = createStreamApp(id); 20 | KafkaStreamMetrics metrics = new KafkaStreamMetrics(streams); 21 | assertTrue( 22 | metrics.getAllMetrics().stream() 23 | // consumer api under the hood 24 | .anyMatch( 25 | metricFamilySamples -> 26 | "consumer_metrics_iotime_total".equals(metricFamilySamples.name))); 27 | } 28 | 29 | private KafkaStreams createStreamApp(String id) { 30 | Properties streamConfig = new Properties(); 31 | streamConfig.put(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG, BOOTSTRAP_SERVERS); 32 | streamConfig.put(StreamsConfig.APPLICATION_ID_CONFIG, "stream-metrics"); 33 | streamConfig.put(StreamsConfig.CLIENT_ID_CONFIG, id); 34 | streamConfig.put(StreamsConfig.DEFAULT_KEY_SERDE_CLASS_CONFIG, Serdes.String().getClass()); 35 | streamConfig.put(StreamsConfig.DEFAULT_VALUE_SERDE_CLASS_CONFIG, Serdes.String().getClass()); 36 | return new KafkaStreams(new StreamsBuilder().build(), streamConfig); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/test/java/no/sysco/middleware/prometheus/kafka/clients/KafkaProducerMetricsTest.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka.clients; 2 | 3 | import java.util.Properties; 4 | import java.util.UUID; 5 | import org.apache.kafka.clients.producer.KafkaProducer; 6 | import org.apache.kafka.clients.producer.Producer; 7 | import org.apache.kafka.clients.producer.ProducerConfig; 8 | import org.apache.kafka.common.serialization.StringSerializer; 9 | import org.junit.Test; 10 | 11 | import static org.junit.Assert.assertTrue; 12 | import static org.junit.Assert.fail; 13 | 14 | public class KafkaProducerMetricsTest { 15 | 16 | private static final String BOOTSTRAP_SERVERS = "localhost:29092"; 17 | 18 | @Test 19 | public void verify() { 20 | String id = UUID.randomUUID().toString(); 21 | try (Producer producer = createProducer(id)) { 22 | KafkaProducerMetrics metrics = new KafkaProducerMetrics(producer); 23 | assertTrue( 24 | metrics.getAllMetrics().stream() 25 | .anyMatch( 26 | metricFamilySamples -> 27 | "producer_metrics_network_io_total".equals(metricFamilySamples.name))); 28 | } catch (Exception e) { 29 | fail(); 30 | } 31 | } 32 | 33 | private Producer createProducer(String id) { 34 | Properties producerConfig = new Properties(); 35 | producerConfig.put(ProducerConfig.CLIENT_ID_CONFIG, id); 36 | producerConfig.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, BOOTSTRAP_SERVERS); 37 | producerConfig.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class); 38 | producerConfig.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class); 39 | return new KafkaProducer<>(producerConfig); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/main/java/no/sysco/middleware/prometheus/kafka/ClientsJmxCollector.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka; 2 | 3 | import io.prometheus.client.Collector; 4 | import java.util.ArrayList; 5 | import java.util.List; 6 | import java.util.stream.Collectors; 7 | import no.sysco.middleware.prometheus.kafka.clients.KafkaConsumerMetrics; 8 | import no.sysco.middleware.prometheus.kafka.clients.KafkaMetrics; 9 | import no.sysco.middleware.prometheus.kafka.clients.KafkaProducerMetrics; 10 | import no.sysco.middleware.prometheus.kafka.clients.KafkaStreamMetrics; 11 | import org.apache.kafka.clients.consumer.Consumer; 12 | import org.apache.kafka.clients.producer.Producer; 13 | import org.apache.kafka.streams.KafkaStreams; 14 | 15 | public class ClientsJmxCollector extends Collector { 16 | 17 | private List clientMetricReporters; 18 | 19 | public ClientsJmxCollector(Object... kafkaClients) { 20 | this.clientMetricReporters = new ArrayList<>(); 21 | for (Object client : kafkaClients) { 22 | if (client instanceof Producer) { 23 | clientMetricReporters.add(new KafkaProducerMetrics((Producer) client)); 24 | } else if (client instanceof Consumer) { 25 | clientMetricReporters.add(new KafkaConsumerMetrics((Consumer) client)); 26 | } else if (client instanceof KafkaStreams) { 27 | clientMetricReporters.add(new KafkaStreamMetrics((KafkaStreams) client)); 28 | } else { 29 | throw new IllegalArgumentException("Unknown client"); 30 | } 31 | } 32 | } 33 | 34 | @Override 35 | public List collect() { 36 | return clientMetricReporters.stream() 37 | .flatMap(collector -> collector.getAllMetrics().stream()) 38 | .collect(Collectors.toList()); 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/test/java/no/sysco/middleware/prometheus/kafka/clients/KafkaConsumerMetricsTest.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka.clients; 2 | 3 | import java.util.Properties; 4 | import java.util.UUID; 5 | import org.apache.kafka.clients.consumer.Consumer; 6 | import org.apache.kafka.clients.consumer.ConsumerConfig; 7 | import org.apache.kafka.clients.consumer.KafkaConsumer; 8 | import org.apache.kafka.common.serialization.StringDeserializer; 9 | import org.junit.Test; 10 | 11 | import static org.junit.Assert.assertTrue; 12 | import static org.junit.Assert.fail; 13 | 14 | public class KafkaConsumerMetricsTest { 15 | private static final String BOOTSTRAP_SERVERS = "localhost:29092"; 16 | 17 | @Test 18 | public void verify() { 19 | String id = UUID.randomUUID().toString(); 20 | String groupId = "some-gr-id"; 21 | 22 | try (Consumer consumer = createConsumer(id, groupId)) { 23 | KafkaConsumerMetrics metrics = new KafkaConsumerMetrics(consumer); 24 | assertTrue( 25 | metrics.getAllMetrics().stream() 26 | .anyMatch( 27 | metricFamilySamples -> 28 | "consumer_metrics_iotime_total".equals(metricFamilySamples.name))); 29 | } catch (Exception e) { 30 | fail(); 31 | } 32 | } 33 | 34 | private Consumer createConsumer(String id, String groupId) { 35 | final Properties properties = new Properties(); 36 | properties.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, BOOTSTRAP_SERVERS); 37 | properties.put(ConsumerConfig.CLIENT_ID_CONFIG, id); 38 | properties.put(ConsumerConfig.GROUP_ID_CONFIG, groupId); 39 | properties.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest"); 40 | properties.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class); 41 | properties.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class); 42 | return new KafkaConsumer<>(properties); 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /architecture.log.md: -------------------------------------------------------------------------------- 1 | # 25.06.19 2 | Build draft implementation based on idea having dependency injection(di) of kafka-client metrics. 3 | Iterate within this metrics and get values from kafka related beans which are registered in MBeanServer. 4 | ```java 5 | final KafkaProducer kafkaProducer = new KafkaProducer<>(getProducerProps(id1)); 6 | Set metrics = kafkaProducer1.metrics().keySet(); 7 | // di 8 | KafkaClientsJmxExports.initialize(metrics); 9 | ``` 10 | 11 | `Update`: Idea implemented in branch `feature/draft` 12 | 13 | # 01.07.19 14 | Build draft implementation without having dependency injection. 15 | ```java 16 | KafkaClientsJmxExports.initialize(); 17 | ``` 18 | Ideas: 19 | * Register all kafka-client metrics 20 | ```java 21 | //example 22 | // registered in MBeanServer as `kafka.producer:type=producer-metrics,client-id=2312-123432-5345` 23 | new MetricName("record-send-rate", PRODUCER_METRICS, "The average number of records sent per second.",new HashMap<>()) 24 | ``` 25 | * Keep in mind that one java process can have several kafka-clients, which can be identified by `client-id` 26 | 27 | # 02.07.19 28 | ## Producer metrics 29 | Producer has 2 metric group : 30 | * "producer-metrics" - has tags "client-id", which can be initialized at startup of application 31 | * "producer-topic-metrics" - has tags "client-id", "topic". Because of "topic", can be initialize dynamically at run-time. 32 | 33 | What is the best way to collect Metrics for second group. 34 | 35 | # 04.07.19 36 | New iteration of dev process lead me finally to apache kafka docs: https://kafka.apache.org/documentation/#selector_monitoring 37 | There are producer metrics groups: 38 | 39 | | group | clients | initialised at | 40 | | ------------- |:-------------:| -----:| 41 | | `app-info` | all | startup | 42 | | `-node-metrics` | all | runtime | 43 | | `producer-metrics` | producer | startup + runtime | 44 | | `producer-topic-metrics` | producer | runtime | 45 | 46 | Naming become a nightmare. 47 | 48 | todos: 49 | * check https://github.com/micrometer-metrics/micrometer 50 | 51 | Thread-off: 52 | Make Set init dynamic at runtime or separate some at startup time, some at runtime; 53 | Benefit is performance. 54 | 55 | # 09.07.19 56 | I decided to initialise all metric names (`Set`) at runtime. 57 | Sequence: 58 | ``` 59 | // init kafka client: 60 | // new KafkaStreams(...); 61 | // new KafkaProducer(); 62 | // new kafkaConsumer(); 63 | // ... 64 | KafkaClientsJmxExports.initialize(); 65 | application.start(); 66 | ``` 67 | Kafka clients should be initialised before collecting JMX metrics. 68 | Because custom collector will collect kafka-client ids. 69 | 70 | TODO: create validation mechanism for checking attribute exist. 71 | 72 | Example: 73 | ``` 74 | Exception in thread "main" java.lang.IllegalArgumentException: The specified attribute does not exist or cannot be retrieved: reauthentication-latency-max 75 | at no.sysco.middleware.prometheus.kafka.KafkaClientJmxCollector.getMBeanAttributeValue(KafkaClientJmxCollector.java:133) 76 | at no.sysco.middleware.prometheus.kafka.KafkaClientJmxCollector.getMetricsPerClient(KafkaClientJmxCollector.java:154) 77 | at no.sysco.middleware.prometheus.kafka.clients.ConsumerJmxCollector.getAllMetrics(ConsumerJmxCollector.java:77) 78 | at no.sysco.middleware.prometheus.kafka.ClientsJmxCollector.lambda$collect$0(ClientsJmxCollector.java:63) 79 | at java.util.stream.ReferencePipeline$7$1.accept(ReferencePipeline.java:267) 80 | at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1382) 81 | at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481) 82 | at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) 83 | at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708) 84 | at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) 85 | at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499) 86 | at no.sysco.middleware.prometheus.kafka.ClientsJmxCollector.collect(ClientsJmxCollector.java:64) 87 | at io.prometheus.client.CollectorRegistry.collectorNames(CollectorRegistry.java:100) 88 | at io.prometheus.client.CollectorRegistry.register(CollectorRegistry.java:50) 89 | at io.prometheus.client.Collector.register(Collector.java:139) 90 | at io.prometheus.client.Collector.register(Collector.java:132) 91 | at no.sysco.middleware.prometheus.kafka.KafkaClientsJmxExports.initialize(KafkaClientsJmxExports.java:8) 92 | at no.sysco.middleware.prometheus.kafka.example.Consumer.main(Consumer.java:32) 93 | ``` 94 | 95 | # 12.07.19 96 | 1. Add `try-catch` construct and `log.warn` when call `getMBeanAttributeValue` and log warn any IllegalArgument 97 | 98 | # 19.07.19 99 | TODOs: 100 | 1. Naming consistency 101 | 2. refactoring 102 | 3. Logging 103 | 104 | Has an idea, Stream `Metrics` have a different recording levels debug and info. For first release focus only on info level. 105 | 106 | # 01.08.19 107 | Change approach to JmxReporter and DI. 108 | Refs: 109 | - [micrometer](https://github.com/micrometer-metrics/micrometer/pull/1173) 110 | - [jeqo micrometer binder for kafka](https://github.com/jeqo/micrometer-binder-kafka) 111 | 112 | # 09.08.2019 113 | Add opportunity to use different http servers 114 | # 17.09.2019 115 | Release 0.0.5 -> fix metric registered twice -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://www.travis-ci.org/sysco-middleware/kafka-client-collector.svg?branch=master)](https://www.travis-ci.org/sysco-middleware/kafka-client-collector) 2 | [![Maven metadata URI](https://img.shields.io/maven-metadata/v/http/central.maven.org/maven2/no/sysco/middleware/prometheus/kafka-client-collector/maven-metadata.xml.svg)](https://repo1.maven.org/maven2/no/sysco/middleware/prometheus/kafka-client-collector) 3 | 4 | # Kafka client collector 5 | Kafka client collector is an implementation of [Prometheus custom collector](https://github.com/prometheus/client_java#custom-collectors), 6 | for collecting JMX metrics from kafka clients. 7 | 8 | | Version | Kafka-client version | Prometheus simpleclient version | 9 | |:-------------:|:-------------:|:-----:| 10 | | 0.0.3 | 2.1.1 | 0.6.0 | 11 | | 0.0.4 | 2.3.0 | 0.6.0 | 12 | | 0.0.5 | 2.3.0 | 0.6.0 | 13 | ## Usage 14 | ```xml 15 | 16 | no.sysco.middleware.prometheus 17 | kafka-client-collector 18 | 0.0.5 19 | 20 | ``` 21 | 22 | ### Prometheus http server 23 | Use `KafkaClientsJmxExports` to initialize collectors for kafka client's JMX metrics to conveniently register them. 24 | ```java 25 | HTTPServer server = new HTTPServer(8081); 26 | Runtime.getRuntime().addShutdownHook(new Thread(server::stop)); 27 | 28 | KafkaClientsJmxExports.initialize(kafkaProducer1); 29 | ``` 30 | 31 | ### Armeria http server 32 | Add armeria dependency, than 33 | ```java 34 | /** init health-check, config, metrics */ 35 | final CollectorRegistry collectorRegistry = CollectorRegistry.defaultRegistry; 36 | new ClientsJmxCollector(kafkaProducer).register(collectorRegistry); 37 | 38 | Server server = new ServerBuilder().http(8085) 39 | .service("/", (ctx, req) -> HttpResponse.of("OK")) 40 | .service("/config", (ctx, req) -> HttpResponse.of(appConfig.properties.toString())) 41 | .service("/metrics", (ctx, req) -> { 42 | final ByteArrayOutputStream stream = new ByteArrayOutputStream(); 43 | try (OutputStreamWriter writer = new OutputStreamWriter(stream)) { 44 | TextFormat.write004(writer, collectorRegistry.metricFamilySamples()); 45 | } 46 | return HttpResponse.of(HttpStatus.OK, CONTENT_TYPE_004, stream.toByteArray()); 47 | }) 48 | .build(); 49 | CompletableFuture future = server.start(); 50 | // Wait until the server is ready. 51 | future.join(); 52 | ``` 53 | 54 | Follow [full example](https://github.com/sysco-middleware/kafka-client-collector-examples/blob/master/src/main/java/no/sysco/middleware/prometheus/kafka/armeria/Application.java) 55 | ## Metric format 56 | ``` 57 | JMX example 58 | kafka.producer:type=producer-metrics,client-id="dasf-gdfgd-dfgd-31",waiting-threads="5" 59 | 60 | Will be exposed as 61 | producer_metrics_waiting_threads {cliend_id="dasf-gdfgd-dfgd-31"} 5.0 62 | ``` 63 | JMX domain (kafka.producer - example above) is not present in Prometheus format, due to kafka-streams api 64 | use others apis (kafka-producer, kafka-consumer, kafka-admin-client) and domain names are not presented in KafkaMetric. 65 | 66 | ## Metrics types (group) 67 | ### Producer: 68 | * `app-info` @deprecated 69 | * `producer-metrics` 70 | * `producer-topic-metrics` 71 | * `producer-node-metrics` 72 | ### Consumer: 73 | * `app-info` @deprecated 74 | * `consumer-metrics` 75 | * `consumer-coordinator-metrics` 76 | * `consumer-fetch-manager-metrics` 77 | * `consumer-node-metrics` 78 | ### Stream: 79 | Stream contains metrics from domains `kafka.producer`, `kafka.consumer`, `kafka.admin.client` and own set of metrics 80 | such as : 81 | * `app-info` @deprecated 82 | * `stream-metrics` [INFO lvl] 83 | * `stream-task-metrics` [DEBUG lvl] 84 | * `stream-processor-node-metrics` [DEBUG lvl] 85 | * `stream-[store-scope]-metrics` [DEBUG lvl] 86 | * `stream-record-cache-metrics` [DEBUG lvl] 87 | * `stream-buffer-metrics` [DEBUG lvl] 88 | 89 | ### Prometheus metrics format 90 | 1. Check 91 | Read [blog post](https://www.robustperception.io/invalid-is-not-a-valid-start-token-and-other-scrape-errors). 92 | There is a tool `promtool` to verify metrics formatting. 93 | 94 | ### References 95 | - [More examples](https://github.com/sysco-middleware/kafka-client-collector-examples) 96 | - [Issue 305: Add kafka client example config](https://github.com/prometheus/jmx_exporter/pull/305#issuecomment-412851484) 97 | - [Issue 400: does the client automatically publish jmx mertices (heap size memory, thread number)?](https://github.com/prometheus/client_java/issues/400) 98 | - [Blog post: JMX monitoring + Java custom metrics.](https://sysdig.com/blog/jmx-monitoring-custom-metrics/) 99 | - [Kafka metrics reporter](https://github.com/apache/kafka/blob/2.0.0/clients/src/main/java/org/apache/kafka/common/metrics/MetricsReporter.java) 100 | - [IMO - Good example how to make custom collector](https://github.com/joyent/manta-monitor/blob/master/src/main/java/com/joyent/manta/monitor/CustomPrometheusCollector.java) 101 | - Approaches (POCs) with `org.apache.kafka.common.metrics.MetricReporter` 102 | - [kafka-prometheus-metric-reporter](https://github.com/ripa1993/kafka-prometheus-metric-reporter) 103 | - [kafka-client-monitoring-poc](https://github.com/sysco-middleware/kafka-client-monitoring-poc) 104 | - [Micrometer [PR WIP]](https://github.com/micrometer-metrics/micrometer/pull/1173/files) 105 | 106 | ### Issues 107 | - [KIP-488: Clean up Sum,Count,Total Metrics](https://cwiki.apache.org/confluence/display/KAFKA/KIP-488%3A+Clean+up+Sum%2CCount%2CTotal+Metrics) 108 | - [KIP-444: Augment metrics for Kafka Streams](https://cwiki.apache.org/confluence/display/KAFKA/KIP-444%3A+Augment+metrics+for+Kafka+Streams) -------------------------------------------------------------------------------- /src/main/java/no/sysco/middleware/prometheus/kafka/clients/KafkaMetrics.java: -------------------------------------------------------------------------------- 1 | package no.sysco.middleware.prometheus.kafka.clients; 2 | 3 | import io.prometheus.client.Collector; 4 | import io.prometheus.client.CounterMetricFamily; 5 | import io.prometheus.client.GaugeMetricFamily; 6 | import java.util.ArrayList; 7 | import java.util.HashMap; 8 | import java.util.List; 9 | import java.util.Map; 10 | import java.util.function.Supplier; 11 | import java.util.stream.Collectors; 12 | 13 | import io.prometheus.client.SummaryMetricFamily; 14 | import org.apache.kafka.common.Metric; 15 | import org.apache.kafka.common.MetricName; 16 | import org.apache.kafka.common.metrics.KafkaMetric; 17 | 18 | public abstract class KafkaMetrics { 19 | private final Supplier> metricsSupplier; 20 | 21 | KafkaMetrics(Supplier> metricsSupplier) { 22 | this.metricsSupplier = metricsSupplier; 23 | } 24 | 25 | public List getAllMetrics() { 26 | Map metrics = metricsSupplier.get(); 27 | Map prometheusFotmattingMetrics = new HashMap<>(); 28 | 29 | metrics.forEach( 30 | (metricName, metric) -> { 31 | if (metric instanceof KafkaMetric) { 32 | KafkaMetric kafkaMetric = (KafkaMetric) metric; 33 | String metricNamePrometheus = metricName(kafkaMetric); 34 | final List tagsKeys = metric.metricName().tags().keySet().stream().map(this::metricTag).collect(Collectors.toList()); 35 | final List tagValues = new ArrayList<>(metric.metricName().tags().values()); 36 | 37 | if (filterBadMetrics(kafkaMetric)) { 38 | if (kafkaMetric.metricName().name().endsWith("total")) { 39 | double value; 40 | if (metric.metricValue() instanceof Double) { 41 | value = (double) metric.metricValue(); 42 | 43 | if (prometheusFotmattingMetrics.containsKey(metricNamePrometheus)) { 44 | // already registered once 45 | // find 46 | // add new tags & values 47 | CounterMetricFamily counterMetricFamily = (CounterMetricFamily) prometheusFotmattingMetrics.get(metricNamePrometheus); 48 | counterMetricFamily.addMetric(tagValues, value); 49 | } else { 50 | // never registered 51 | CounterMetricFamily counterMetricFamily = new CounterMetricFamily(metricNamePrometheus, kafkaMetric.metricName().description(), tagsKeys); 52 | counterMetricFamily.addMetric(tagValues, value); 53 | prometheusFotmattingMetrics.put(metricNamePrometheus, counterMetricFamily); 54 | } 55 | 56 | } else { 57 | // not counter 58 | } 59 | } 60 | // naming convention 61 | // https://prometheus.io/docs/concepts/metric_types/#summary 62 | else if (kafkaMetric.metricName().name().contains("count")) { 63 | double value; 64 | if (kafkaMetric.metricValue() instanceof Double) { 65 | value = (double) kafkaMetric.metricValue(); 66 | 67 | if (prometheusFotmattingMetrics.containsKey(metricNamePrometheus)) { 68 | SummaryMetricFamily summaryMetricFamily = (SummaryMetricFamily) prometheusFotmattingMetrics.get(metricNamePrometheus); 69 | summaryMetricFamily.addMetric(tagValues, value, value); 70 | } else { 71 | SummaryMetricFamily summaryMetricFamily = 72 | new SummaryMetricFamily(metricNamePrometheus, kafkaMetric.metricName().description(), tagsKeys); 73 | summaryMetricFamily.addMetric(tagValues, value, value); 74 | prometheusFotmattingMetrics.put(metricNamePrometheus, summaryMetricFamily); 75 | } 76 | } else { 77 | // not a summary 78 | } 79 | } else { 80 | double value; 81 | if (metric.metricValue() instanceof Double) { 82 | value = (double) metric.metricValue(); 83 | 84 | if (prometheusFotmattingMetrics.containsKey(metricNamePrometheus)) { 85 | GaugeMetricFamily gaugeMetricFamily = (GaugeMetricFamily) prometheusFotmattingMetrics.get(metricNamePrometheus); 86 | gaugeMetricFamily.addMetric(tagValues, value); 87 | } else { 88 | GaugeMetricFamily gaugeMetricFamily = 89 | new GaugeMetricFamily(metricNamePrometheus, kafkaMetric.metricName().description(), tagsKeys); 90 | gaugeMetricFamily.addMetric(tagValues, value); 91 | prometheusFotmattingMetrics.put(metricNamePrometheus, gaugeMetricFamily); 92 | } 93 | } else { 94 | // not a gauge 95 | } 96 | } 97 | } 98 | } 99 | }); 100 | 101 | return new ArrayList<>(prometheusFotmattingMetrics.values()); 102 | } 103 | 104 | private String metricName(KafkaMetric metric) { 105 | return String.format("%s.%s", metric.metricName().group(), metric.metricName().name()) 106 | .replaceAll("\\.", "_") 107 | .replaceAll("-", "_"); 108 | } 109 | 110 | private String metricTag(String tagName) { 111 | return tagName.replaceAll("-", "_"); 112 | } 113 | 114 | private Boolean filterBadMetrics(final KafkaMetric kafkaMetric) { 115 | // some metrics has no description 116 | if (kafkaMetric.metricName().description().isEmpty()) { 117 | return false; 118 | } 119 | // append fail https://github.com/sysco-middleware/kafka-client-collector/issues/12 120 | // kafka node metrics repeats same set twice for `node-id="node-1"` and `node-id="node--1"` 121 | if (kafkaMetric.metricName().tags().values().stream().anyMatch((tagValue -> tagValue.contains("--")))) { 122 | return false; 123 | } 124 | // The app-info mbean registered with JMX to provide version and commit id will be deprecated and replaced with metrics providing these attributes. 125 | if ("app-info".equalsIgnoreCase(kafkaMetric.metricName().group()) || 126 | "kafka-metrics-count".equalsIgnoreCase(kafkaMetric.metricName().group())) { 127 | return false; 128 | } 129 | return true; 130 | } 131 | 132 | } 133 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | no.sysco.middleware.prometheus 6 | kafka-client-collector 7 | 0.0.7-SNAPSHOT 8 | 9 | kafka-client-collector 10 | Custom Kafka client JMX collector for prometheus 11 | http://github.com/sysco-middleware/kafka-client-collector 12 | 13 | 14 | UTF-8 15 | 1.8 16 | 1.8 17 | 18 | 0.8.0 19 | 2.3.0 20 | 21 | 22 | 23 | 24 | The Apache Software License, Version 2.0 25 | http://www.apache.org/licenses/LICENSE-2.0.txt 26 | repo 27 | 28 | 29 | 30 | 31 | 32 | zhenik 33 | Nikita Zhevnitskiy 34 | https://github.com/zhenik 35 | 36 | 37 | 38 | 39 | 40 | org.apache.kafka 41 | kafka-clients 42 | ${kafka-client.version} 43 | 44 | 45 | org.apache.kafka 46 | kafka-streams 47 | ${kafka-client.version} 48 | 49 | 50 | io.prometheus 51 | simpleclient 52 | ${io.prometheus.version} 53 | 54 | 55 | junit 56 | junit 57 | 4.12 58 | test 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | maven-clean-plugin 67 | 3.1.0 68 | 69 | 70 | maven-resources-plugin 71 | 3.0.2 72 | 73 | 74 | maven-compiler-plugin 75 | 3.8.0 76 | 77 | 78 | maven-surefire-plugin 79 | 3.0.0-M3 80 | 81 | 82 | maven-failsafe-plugin 83 | 3.0.0-M3 84 | 85 | 86 | maven-jar-plugin 87 | 3.0.2 88 | 89 | 90 | maven-install-plugin 91 | 2.5.2 92 | 93 | 94 | maven-deploy-plugin 95 | 2.8.2 96 | 97 | 98 | 99 | 100 | 101 | maven-release-plugin 102 | 103 | v@{project.version} 104 | true 105 | true 106 | true 107 | release 108 | 109 | 110 | 111 | maven-jar-plugin 112 | 113 | 114 | 115 | true 116 | 117 | 118 | 119 | 120 | 121 | maven-failsafe-plugin 122 | 123 | 124 | integration-test 125 | 126 | integration-test 127 | 128 | 129 | 130 | verify 131 | 132 | verify 133 | 134 | 135 | 136 | 137 | 138 | org.codehaus.mojo 139 | cobertura-maven-plugin 140 | 2.7 141 | 142 | 143 | 144 | html 145 | xml 146 | 147 | true 148 | 149 | 150 | 151 | 152 | 153 | 154 | release 155 | 156 | 157 | 158 | maven-source-plugin 159 | 3.0.1 160 | 161 | 162 | attach-sources 163 | 164 | jar-no-fork 165 | 166 | 167 | 168 | 169 | 170 | maven-javadoc-plugin 171 | 2.10.4 172 | 173 | 174 | attach-javadocs 175 | 176 | jar 177 | 178 | 179 | 180 | 181 | 182 | maven-gpg-plugin 183 | 1.6 184 | 185 | 186 | sign-artifacts 187 | verify 188 | 189 | sign 190 | 191 | 192 | 193 | 194 | 195 | org.sonatype.plugins 196 | nexus-staging-maven-plugin 197 | 1.6.8 198 | true 199 | 200 | ossrh 201 | https://oss.sonatype.org/ 202 | true 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | scm:git:ssh://git@github.com/sysco-middleware/kafka-client-collector.git 212 | scm:git:ssh://git@github.com/sysco-middleware/kafka-client-collector.git 213 | 214 | http://github.com/sysco-middleware/kafka-client-collector/tree/master 215 | HEAD 216 | 217 | 218 | 219 | GitHub 220 | https://github.com/sysco-middleware/kafka-client-collector/issues 221 | 222 | 223 | 224 | 225 | ossrh 226 | https://oss.sonatype.org/content/repositories/snapshots 227 | 228 | 229 | ossrh 230 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 231 | 232 | 233 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. --------------------------------------------------------------------------------