soumitra-st commented on code in PR #14155: URL: https://github.com/apache/pinot/pull/14155#discussion_r1807914546
########## pinot-common/src/test/java/org/apache/pinot/common/metrics/BrokerJMXToPromMetricsTest.java: ########## @@ -0,0 +1,162 @@ +/** + * 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.yammer.metrics.core.MetricsRegistry; +import com.yammer.metrics.reporting.JmxReporter; +import io.prometheus.jmx.shaded.io.prometheus.client.exporter.HTTPServer; +import java.net.URI; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.stream.Stream; +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.plugin.metrics.yammer.YammerMetricsRegistry; +import org.apache.pinot.spi.env.PinotConfiguration; +import org.apache.pinot.spi.metrics.PinotMetricUtils; +import org.testng.annotations.BeforeClass; +import org.testng.annotations.Test; + +import static org.apache.pinot.spi.utils.CommonConstants.CONFIG_OF_METRICS_FACTORY_CLASS_NAME; + + +public class BrokerJMXToPromMetricsTest extends PinotJMXToPromMetricsTest { + + private static final String EXPORTED_METRIC_PREFIX = "pinot_broker_"; + + private static final String EXPORTED_METRIC_PREFIX_EXCEPTIONS = "exceptions"; + + private BrokerMetrics _brokerMetrics; + + private HTTPServer _httpServer; + + @BeforeClass + public void setup() + throws Exception { + + _httpServer = startExporter(PinotComponent.BROKER); + + PinotConfiguration pinotConfiguration = new PinotConfiguration(); + pinotConfiguration.setProperty(CONFIG_OF_METRICS_FACTORY_CLASS_NAME, + "org.apache.pinot.plugin.metrics.yammer.YammerMetricsFactory"); + PinotMetricUtils.init(pinotConfiguration); + + // Initialize ServerMetrics with the registry + YammerMetricsRegistry yammerMetricsRegistry = new YammerMetricsRegistry(); + _brokerMetrics = new BrokerMetrics(yammerMetricsRegistry); + + // Enable JMX reporting + MetricsRegistry metricsRegistry = (MetricsRegistry) yammerMetricsRegistry.getMetricsRegistry(); + JmxReporter jmxReporter = new JmxReporter(metricsRegistry); + jmxReporter.start(); + + _httpClient = new HttpClient(); + } + + @Test + public void timerTest() { + //first assert on global timers + Stream.of(BrokerTimer.values()).filter(BrokerTimer::isGlobal) + .peek(timer -> _brokerMetrics.addTimedValue(timer, 30_000, TimeUnit.MILLISECONDS)) + .forEach(timer -> assertTimerExportedCorrectly(timer.getTimerName(), EXPORTED_METRIC_PREFIX)); + //Assert on local timers + Stream.of(BrokerTimer.values()).filter(timer -> !timer.isGlobal()).peek(timer -> { + _brokerMetrics.addTimedTableValue(LABEL_VAL_RAW_TABLENAME, timer, 30_000L, TimeUnit.MILLISECONDS); + }).forEach(timer -> assertTimerExportedCorrectly(timer.getTimerName(), EXPORTED_LABELS_FOR_RAW_TABLE_NAME, + EXPORTED_METRIC_PREFIX)); + } + + @Test + public void gaugeTest() { + //global gauges + Stream.of(BrokerGauge.values()).filter(BrokerGauge::isGlobal) + .peek(gauge -> _brokerMetrics.setOrUpdateGlobalGauge(gauge, () -> 5L)) + .forEach(gauge -> assertGaugeExportedCorrectly(gauge.getGaugeName(), EXPORTED_METRIC_PREFIX)); + //local gauges + Stream.of(BrokerGauge.values()).filter(gauge -> !gauge.isGlobal()).peek(gauge -> { + if (gauge == BrokerGauge.REQUEST_SIZE) { + _brokerMetrics.setOrUpdateTableGauge(LABEL_VAL_RAW_TABLENAME, gauge, 5L); + } else { + _brokerMetrics.setOrUpdateTableGauge(TABLE_NAME_WITH_TYPE, gauge, 5L); + } + }).forEach(gauge -> { + if (gauge == BrokerGauge.REQUEST_SIZE) { + assertGaugeExportedCorrectly(gauge.getGaugeName(), EXPORTED_LABELS_FOR_RAW_TABLE_NAME, EXPORTED_METRIC_PREFIX); + } else { + assertGaugeExportedCorrectly(gauge.getGaugeName(), EXPORTED_LABELS_FOR_TABLE_NAME_TABLE_TYPE, + EXPORTED_METRIC_PREFIX); + } + }); + } + + @Test + public void meterTest() { + + List<BrokerMeter> globalMetersWithExceptionsPrefix = + List.of(BrokerMeter.UNCAUGHT_GET_EXCEPTIONS, BrokerMeter.UNCAUGHT_POST_EXCEPTIONS, + BrokerMeter.QUERY_REJECTED_EXCEPTIONS, BrokerMeter.REQUEST_COMPILATION_EXCEPTIONS, + BrokerMeter.RESOURCE_MISSING_EXCEPTIONS); + + Stream.of(BrokerMeter.values()).filter(BrokerMeter::isGlobal) + .peek(meter -> _brokerMetrics.addMeteredGlobalValue(meter, 5L)).forEach(meter -> { + if (globalMetersWithExceptionsPrefix.contains(meter)) { + String exportedMeterPrefix = String.format("%s_%s", EXPORTED_METRIC_PREFIX_EXCEPTIONS, + StringUtils.remove(meter.getMeterName(), "Exceptions")); + assertMeterExportedCorrectly(exportedMeterPrefix, EXPORTED_METRIC_PREFIX); + } else { + assertMeterExportedCorrectly(meter.getMeterName(), EXPORTED_METRIC_PREFIX); + } + }); + + List<BrokerMeter> localMetersThatAcceptRawTableName = + List.of(BrokerMeter.QUERIES, BrokerMeter.NO_SERVER_FOUND_EXCEPTIONS, BrokerMeter.DOCUMENTS_SCANNED, Review Comment: Let's plan to standardize the metric definition in subsequent PRs, then we can remove the hardcoded list. We can traverse the definition and figure out different class of metrics. This will ensure no metrics are missed in testing, and no additional work would be required while adding new metrics. -- 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
