Author: fortino
Date: Wed Aug 12 15:45:08 2020
New Revision: 1880812
URL: http://svn.apache.org/viewvc?rev=1880812&view=rev
Log:
OAK-9164: expose query metrics in oak-search-elastic
Added:
jackrabbit/oak/trunk/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticMetricHandler.java
(with props)
Added:
jackrabbit/oak/trunk/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticMetricHandler.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticMetricHandler.java?rev=1880812&view=auto
==============================================================================
---
jackrabbit/oak/trunk/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticMetricHandler.java
(added)
+++
jackrabbit/oak/trunk/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticMetricHandler.java
Wed Aug 12 15:45:08 2020
@@ -0,0 +1,107 @@
+/*
+ * 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.jackrabbit.oak.plugins.index.elastic;
+
+import org.apache.jackrabbit.oak.stats.HistogramStats;
+import org.apache.jackrabbit.oak.stats.MeterStats;
+import org.apache.jackrabbit.oak.stats.StatisticsProvider;
+import org.apache.jackrabbit.oak.stats.StatsOptions;
+import org.apache.jackrabbit.oak.stats.TimerStats;
+
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Provides high level functions to track and measure activities against
Elastic.
+ */
+public class ElasticMetricHandler {
+
+ private static final String QUERY_RATE = "ELASTIC_QUERY_RATE";
+ private static final String QUERY_INTERNAL_RATE =
"ELASTIC_QUERY_INTERNAL_RATE";
+
+ private static final String QUERY_HITS = "ELASTIC_QUERY_HITS";
+ private static final String QUERY_SERVER_TIME =
"ELASTIC_QUERY_SERVER_TIME";
+ private static final String QUERY_TOTAL_TIME = "ELASTIC_QUERY_TOTAL_TIME";
+
+ private static final String QUERY_TIMED_OUT_RATE =
"ELASTIC_QUERY_TIMED_OUT_RATE";
+ private static final String QUERY_FAILED_RATE =
"ELASTIC_QUERY_FAILED_RATE";
+
+ private final MeterStats queryRate;
+ private final MeterStats queryInternalRate;
+
+ private final HistogramStats queryHitsHistogram;
+ private final TimerStats queryServerTimer;
+ private final TimerStats queryTotalTimer;
+
+ private final MeterStats queryTimedOutRate;
+ private final MeterStats queryFailedRate;
+
+ public ElasticMetricHandler(StatisticsProvider sp) {
+ queryRate = sp.getMeter(QUERY_RATE, StatsOptions.METRICS_ONLY);
+ queryInternalRate = sp.getMeter(QUERY_INTERNAL_RATE,
StatsOptions.METRICS_ONLY);
+
+ queryHitsHistogram = sp.getHistogram(QUERY_HITS,
StatsOptions.METRICS_ONLY);
+ queryServerTimer = sp.getTimer(QUERY_SERVER_TIME,
StatsOptions.METRICS_ONLY);
+ queryTotalTimer = sp.getTimer(QUERY_TOTAL_TIME,
StatsOptions.METRICS_ONLY);
+
+ queryTimedOutRate = sp.getMeter(QUERY_TIMED_OUT_RATE,
StatsOptions.METRICS_ONLY);
+ queryFailedRate = sp.getMeter(QUERY_FAILED_RATE,
StatsOptions.METRICS_ONLY);
+ }
+
+ /**
+ * Tracks a new query using two metrics:
+ * <ul>
+ * <li>{@code QUERY_RATE}</li>
+ * <li>{@code QUERY_INTERNAL_RATE}</li>
+ * </ul>
+ *
+ * @param isRootQuery if {@code false} only {@code QUERY_INTERNAL_RATE}
gets incremented
+ */
+ public void markQuery(boolean isRootQuery) {
+ if (isRootQuery) {
+ queryRate.mark();
+ }
+ queryInternalRate.mark();
+ }
+
+ /**
+ * Measures a single query execution
+ * @param hits the number of hits in the result set
+ * @param serverTimeMs the Elastic server time in milliseconds
+ * @param totalTimeMs the complete query execution time
+ * @param timedOut Elastic could time out while returning partial results.
When {@code true} these
+ * occurrences get tracked
+ */
+ public void measureQuery(int hits, long serverTimeMs, long totalTimeMs,
boolean timedOut) {
+ queryHitsHistogram.update(hits);
+ queryServerTimer.update(serverTimeMs, TimeUnit.MILLISECONDS);
+ queryTotalTimer.update(totalTimeMs, TimeUnit.MILLISECONDS);
+ if (timedOut) {
+ queryTimedOutRate.mark();
+ }
+ }
+
+ /**
+ * Measures a failed query execution
+ * @param totalTimeMs the total execution time
+ */
+ public void measureFailedQuery(long totalTimeMs) {
+ queryFailedRate.mark();
+ queryTotalTimer.update(totalTimeMs, TimeUnit.MILLISECONDS);
+ }
+}
Propchange:
jackrabbit/oak/trunk/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticMetricHandler.java
------------------------------------------------------------------------------
svn:eol-style = native
