Package org.opensearch.action.search

Class SearchRequestStats

java.lang.Object

org.opensearch.action.search.SearchRequestOperationsListener

org.opensearch.action.search.SearchRequestStats

@PublicApi(since="2.11.0")
public final class SearchRequestStats
extends SearchRequestOperationsListener

Request level search stats to track coordinator level node search latencies

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchRequestStats.StatsHolder	Holder of statistics values

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Boolean>	SEARCH_REQUEST_STATS_ENABLED
static final String	SEARCH_REQUEST_STATS_ENABLED_KEY

Fields inherited from class org.opensearch.action.search.SearchRequestOperationsListener

NOOP

Constructor Summary

Constructors

Constructor	Description
SearchRequestStats(ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
long	getPhaseCurrent(SearchPhaseName searchPhaseName)
long	getPhaseMetric(SearchPhaseName searchPhaseName)
long	getPhaseTotal(SearchPhaseName searchPhaseName)
long	getTookCurrent()
long	getTookMetric()
long	getTookTotal()
protected void	onPhaseEnd(SearchPhaseContext context, SearchRequestContext searchRequestContext)
protected void	onPhaseFailure(SearchPhaseContext context, Throwable cause)
protected void	onPhaseStart(SearchPhaseContext context)
protected void	onRequestEnd(SearchPhaseContext context, SearchRequestContext searchRequestContext)
protected void	onRequestFailure(SearchPhaseContext context, SearchRequestContext searchRequestContext)
protected void	onRequestStart(SearchRequestContext searchRequestContext)

Methods inherited from class org.opensearch.action.search.SearchRequestOperationsListener

isEnabled, isEnabled, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SEARCH_REQUEST_STATS_ENABLED_KEY

public static final String SEARCH_REQUEST_STATS_ENABLED_KEY

See Also:

• Constant Field Values

SEARCH_REQUEST_STATS_ENABLED

public static final Setting<Boolean> SEARCH_REQUEST_STATS_ENABLED

Constructor Details

SearchRequestStats

@Inject
public SearchRequestStats(ClusterSettings clusterSettings)

Method Details

getPhaseCurrent

public long getPhaseCurrent(SearchPhaseName searchPhaseName)

getPhaseTotal

public long getPhaseTotal(SearchPhaseName searchPhaseName)

getPhaseMetric

public long getPhaseMetric(SearchPhaseName searchPhaseName)

getTookCurrent

public long getTookCurrent()

getTookTotal

public long getTookTotal()

getTookMetric

public long getTookMetric()

onPhaseStart

protected void onPhaseStart(SearchPhaseContext context)

Overrides:

onPhaseStart in class SearchRequestOperationsListener

onPhaseEnd

protected void onPhaseEnd(SearchPhaseContext context,
 SearchRequestContext searchRequestContext)

Overrides:

onPhaseEnd in class SearchRequestOperationsListener

onPhaseFailure

protected void onPhaseFailure(SearchPhaseContext context,
 Throwable cause)

Overrides:

onPhaseFailure in class SearchRequestOperationsListener

onRequestStart

protected void onRequestStart(SearchRequestContext searchRequestContext)

Overrides:

onRequestStart in class SearchRequestOperationsListener

onRequestEnd

protected void onRequestEnd(SearchPhaseContext context,
 SearchRequestContext searchRequestContext)

Overrides:

onRequestEnd in class SearchRequestOperationsListener

onRequestFailure

protected void onRequestFailure(SearchPhaseContext context,
 SearchRequestContext searchRequestContext)

Overrides:

onRequestFailure in class SearchRequestOperationsListener