gortiz commented on code in PR #14155: URL: https://github.com/apache/pinot/pull/14155#discussion_r1806024047
########## pinot-common/src/test/java/org/apache/pinot/common/metrics/PinotJMXToPromMetricsTest.java: ########## @@ -0,0 +1,379 @@ +/** + * 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.pinot.common.metrics; + +import com.google.common.base.Objects; +import io.prometheus.jmx.JmxCollector; +import io.prometheus.jmx.common.http.HTTPServerFactory; +import io.prometheus.jmx.shaded.io.prometheus.client.CollectorRegistry; +import io.prometheus.jmx.shaded.io.prometheus.client.exporter.HTTPServer; +import io.prometheus.jmx.shaded.io.prometheus.client.hotspot.DefaultExports; +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.io.StringReader; +import java.net.InetSocketAddress; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import org.apache.commons.lang3.StringUtils; +import org.apache.pinot.common.utils.SimpleHttpResponse; +import org.apache.pinot.common.utils.http.HttpClient; +import org.apache.pinot.spi.config.table.TableType; +import org.apache.pinot.spi.utils.builder.TableNameBuilder; +import org.testng.Assert; + + +public abstract class PinotJMXToPromMetricsTest { + + private static final Map<PinotComponent, String> PINOT_COMPONENT_CONFIG_FILE_MAP = + Map.of(PinotComponent.CONTROLLER, "controller.yml", PinotComponent.SERVER, "server.yml", PinotComponent.MINION, + "minion.yml", PinotComponent.BROKER, "broker.yml"); + + private static final String CONFIG_DIR = "../docker/images/pinot/etc/jmx_prometheus_javaagent/configs"; + + protected HttpClient _httpClient; + + protected static final String LABEL_KEY_TABLE = "table"; + protected static final String LABEL_VAL_RAW_TABLENAME = "myTable"; + protected static final String LABEL_KEY_TABLETYPE = "tableType"; + protected static final String LABEL_VAL_TABLETYPE_REALTIME = "REALTIME"; + protected static final String LABEL_VAL_TABLENAME_WITH_TYPE_REALTIME = + TableNameBuilder.forType(TableType.REALTIME).tableNameWithType(LABEL_VAL_RAW_TABLENAME); + protected static final String LABEL_KEY_DATABASE = "database"; + protected static final String LABEL_KEY_TOPIC = "topic"; + protected static final String LABEL_KEY_PARTITION = "partition"; + protected static final String LABEL_KEY_CONTROLLER_TASKTYPE = "taskType"; + protected static final String LABEL_VAL_CONTROLLER_TASKTYPE_CHC = "ClusterHealthCheck"; + protected static final String LABEL_KEY_CONTROLLER_PERIODIC_TASK = "periodicTask"; + protected static final String LABEL_KEY_STATUS = "status"; + protected static final String LABEL_VAL_STATUS_IN_PROGRESS = "IN_PROGRESS"; + + protected static final List<String> METER_TYPES = + List.of("Count", "FiveMinuteRate", "MeanRate", "OneMinuteRate", "FifteenMinuteRate"); + + protected static final List<String> TIMER_TYPES = + List.of("Count", "FiveMinuteRate", "Max", "999thPercentile", "95thPercentile", "75thPercentile", "98thPercentile", + "OneMinuteRate", "50thPercentile", "99thPercentile", "FifteenMinuteRate", "Mean", "StdDev", "MeanRate", + "Min"); + + protected static final String TABLE_NAME_WITH_TYPE = + TableNameBuilder.forType(TableType.REALTIME).tableNameWithType(LABEL_VAL_RAW_TABLENAME); + + protected static final String KAFKA_TOPIC = "myTopic"; + protected static final String PARTITION_GROUP_ID = "partitionGroupId"; + protected static final String CLIENT_ID = + String.format("%s-%s-%s", TABLE_NAME_WITH_TYPE, KAFKA_TOPIC, PARTITION_GROUP_ID); + protected static final String TABLE_STREAM_NAME = String.format("%s_%s", TABLE_NAME_WITH_TYPE, KAFKA_TOPIC); + protected static final List<String> EXPORTED_LABELS_FOR_TABLE_NAME_TABLE_TYPE = + List.of(LABEL_KEY_TABLE, LABEL_VAL_RAW_TABLENAME, LABEL_KEY_TABLETYPE, LABEL_VAL_TABLETYPE_REALTIME); + + protected static final List<String> EXPORTED_LABELS_FOR_RAW_TABLE_NAME = + List.of(LABEL_KEY_TABLE, LABEL_VAL_RAW_TABLENAME); + + protected static final List<String> EXPORTED_LABELS_FOR_CLIENT_ID = + List.of(LABEL_KEY_PARTITION, PARTITION_GROUP_ID, LABEL_KEY_TABLE, LABEL_VAL_RAW_TABLENAME, LABEL_KEY_TABLETYPE, + TableType.REALTIME.toString(), LABEL_KEY_TOPIC, KAFKA_TOPIC); + + protected static final List<String> EXPORTED_LABELS_FOR_PARTITION_TABLE_NAME_AND_TYPE = + List.of(LABEL_KEY_PARTITION, "3", LABEL_KEY_TABLE, LABEL_VAL_RAW_TABLENAME, LABEL_KEY_TABLETYPE, + TableType.REALTIME.toString()); + + protected static final List<String> EXPORTED_LABELS_FOR_TABLE_TABLETYPE_TASKTYPE = + List.of(LABEL_KEY_TABLE, LABEL_VAL_RAW_TABLENAME, LABEL_KEY_TABLETYPE, LABEL_VAL_TABLETYPE_REALTIME, + LABEL_KEY_CONTROLLER_TASKTYPE, LABEL_VAL_CONTROLLER_TASKTYPE_CHC); + + protected static final List<String> EXPORTED_LABELS_FOR_TABLENAMEANDTYPE_AND_TASKTYPE = + List.of(LABEL_KEY_TABLE, LABEL_VAL_TABLENAME_WITH_TYPE_REALTIME, LABEL_KEY_CONTROLLER_TASKTYPE, + LABEL_VAL_CONTROLLER_TASKTYPE_CHC); + + protected static final List<String> EXPORTED_LABELS_FOR_TASK_TYPE_AND_STATUS = + List.of(LABEL_KEY_STATUS, LABEL_VAL_STATUS_IN_PROGRESS, LABEL_KEY_CONTROLLER_TASKTYPE, + LABEL_VAL_CONTROLLER_TASKTYPE_CHC); + + protected static final List<String> EXPORTED_LABELS_PERIODIC_TASK_TABLE_TABLETYPE = + List.of(LABEL_KEY_CONTROLLER_PERIODIC_TASK, LABEL_VAL_CONTROLLER_TASKTYPE_CHC, LABEL_KEY_TABLE, + LABEL_VAL_RAW_TABLENAME, LABEL_KEY_TABLETYPE, LABEL_VAL_TABLETYPE_REALTIME); + + /** + * For impl, see: https://github.com/prometheus/jmx_exporter/blob/a3b9443564ff5a78c25fd6566396fda2b7cbf216 + * /jmx_prometheus_javaagent/src/main/java/io/prometheus/jmx/JavaAgent.java#L48 + * @param pinotComponent the Pinot component to start the server for + * @return the corresponding HTTP server on a random unoccupied port + */ + protected HTTPServer startExporter(PinotComponent pinotComponent) { + String args = String.format("%s:%s/%s", 0, CONFIG_DIR, PINOT_COMPONENT_CONFIG_FILE_MAP.get(pinotComponent)); + try { + JMXExporterConfig config = parseExporterConfig(args, "0.0.0.0"); + CollectorRegistry registry = new CollectorRegistry(); + (new JmxCollector(new File(config._file), JmxCollector.Mode.AGENT)).register(registry); + DefaultExports.register(registry); + return (new HTTPServerFactory()).createHTTPServer(config._socket, registry, true, new File(config._file)); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + protected void assertGaugeExportedCorrectly(String exportedGaugePrefix, String exportedMetricPrefix) { + List<PromMetric> promMetrics; + try { + promMetrics = parseExportedPromMetrics(getExportedPromMetrics().getResponse()); + Assert.assertTrue( + promMetrics.contains(PromMetric.withName(exportedMetricPrefix + exportedGaugePrefix + "_" + "Value")), + exportedGaugePrefix); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + protected void assertGaugeExportedCorrectly(String exportedGaugePrefix, List<String> labels, + String exportedMetricPrefix) { + List<PromMetric> promMetrics; + try { + promMetrics = parseExportedPromMetrics(getExportedPromMetrics().getResponse()); + Assert.assertTrue(promMetrics.contains( + PromMetric.withNameAndLabels(exportedMetricPrefix + exportedGaugePrefix + "_" + "Value", labels)), + exportedGaugePrefix); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + protected void assertTimerExportedCorrectly(String exportedTimerPrefix, String exportedMetricPrefix) { + List<PromMetric> promMetrics; + try { + promMetrics = parseExportedPromMetrics(getExportedPromMetrics().getResponse()); + for (String meterType : TIMER_TYPES) { + Assert.assertTrue( + promMetrics.contains(PromMetric.withName(exportedMetricPrefix + exportedTimerPrefix + "_" + meterType))); + } + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + protected void assertTimerExportedCorrectly(String exportedTimerPrefix, List<String> labels, + String exportedMetricPrefix) { + List<PromMetric> promMetrics; + try { + promMetrics = parseExportedPromMetrics(getExportedPromMetrics().getResponse()); + for (String meterType : METER_TYPES) { + Assert.assertTrue(promMetrics.contains( + PromMetric.withNameAndLabels(exportedMetricPrefix + exportedTimerPrefix + "_" + meterType, labels)), + exportedTimerPrefix); + } + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + protected void assertMeterExportedCorrectly(String exportedMeterPrefix, String exportedMetricPrefix) { + List<PromMetric> promMetrics; + try { + promMetrics = parseExportedPromMetrics(getExportedPromMetrics().getResponse()); + } catch (Exception e) { + throw new RuntimeException(e); + } + for (String meterType : METER_TYPES) { + Assert.assertTrue( + promMetrics.contains(PromMetric.withName(exportedMetricPrefix + exportedMeterPrefix + "_" + meterType)), + exportedMeterPrefix); + } + } + + protected void assertMeterExportedCorrectly(String exportedMeterPrefix, List<String> labels, + String exportedMetricPrefix) { + List<PromMetric> promMetrics; + try { + promMetrics = parseExportedPromMetrics(getExportedPromMetrics().getResponse()); + for (String meterType : METER_TYPES) { + Assert.assertTrue(promMetrics.contains( + PromMetric.withNameAndLabels(exportedMetricPrefix + exportedMeterPrefix + "_" + meterType, labels)), + exportedMeterPrefix); + } + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + protected List<PromMetric> parseExportedPromMetrics(String response) + throws IOException { + + List<PromMetric> exportedPromMetrics = new ArrayList<>(); + + try (BufferedReader reader = new BufferedReader(new StringReader(response))) { + String line; + while ((line = reader.readLine()) != null) { + if (line.startsWith("pinot_")) { + exportedPromMetrics.add(PromMetric.fromExportedMetric(line)); + } + } + reader.close(); + return exportedPromMetrics; + } + } + + protected abstract SimpleHttpResponse getExportedPromMetrics(); + + protected abstract void timerTest(); + + protected abstract void gaugeTest(); + + protected abstract void meterTest(); Review Comment: is there a reason to have these abstract methods here? Nobody is going to call them but TestNG and that is just because they are annotated as `@Test` -- 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: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
