org.elasticsearch.search.profile.AbstractProfileBreakdown Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch 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.elasticsearch.search.profile;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
/**
* A record of timings for the various operations that may happen during query execution.
* A node's time may be composed of several internal attributes (rewriting, weighting,
* scoring, etc).
*/
public abstract class AbstractProfileBreakdown> {
/**
* The accumulated timings for this query node
*/
private final long[] timings;
private final long[] counts;
/** Scratch to store the current timing type. */
private T currentTimingType;
/**
* The temporary scratch space for holding start-times
*/
private long scratch;
private T[] timingTypes;
/** Sole constructor. */
public AbstractProfileBreakdown(T[] timingTypes) {
this.timingTypes = timingTypes;
timings = new long[timingTypes.length];
counts = new long[timingTypes.length];
}
/**
* Begin timing a query for a specific Timing context
* @param timing The timing context being profiled
*/
public void startTime(T timing) {
assert currentTimingType == null;
assert scratch == 0;
counts[timing.ordinal()] += 1;
currentTimingType = timing;
scratch = System.nanoTime();
}
/**
* Halt the timing process and save the elapsed time.
* startTime() must be called for a particular context prior to calling
* stopAndRecordTime(), otherwise the elapsed time will be negative and
* nonsensical
*
* @return The elapsed time
*/
public long stopAndRecordTime() {
long time = Math.max(1, System.nanoTime() - scratch);
timings[currentTimingType.ordinal()] += time;
currentTimingType = null;
scratch = 0L;
return time;
}
/** Convert this record to a map from timingType to times. */
public Map toTimingMap() {
Map map = new HashMap<>();
for (T timingType : timingTypes) {
map.put(timingType.toString(), timings[timingType.ordinal()]);
map.put(timingType.toString() + "_count", counts[timingType.ordinal()]);
}
return Collections.unmodifiableMap(map);
}
/**
* Add other
's timings into this breakdown
* @param other Another Breakdown to merge with this one
*/
public void merge(AbstractProfileBreakdown other) {
assert(timings.length == other.timings.length);
for (int i = 0; i < timings.length; ++i) {
timings[i] += other.timings[i];
}
assert(counts.length == other.counts.length);
for (int i = 0; i < counts.length; ++i) {
counts[i] += other.counts[i];
}
}
}