Package org.opensearch.plugin.insights.core.listener

Class QueryInsightsListener

java.lang.Object

org.opensearch.action.search.SearchRequestOperationsListener

org.opensearch.plugin.insights.core.listener.QueryInsightsListener

public final class QueryInsightsListener
extends SearchRequestOperationsListener

The listener for query insights services. It forwards query-related data to the appropriate query insights stores, either for each request or for each phase.

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
QueryInsightsListener(ClusterService clusterService, QueryInsightsService queryInsightsService)	Constructor for QueryInsightsListener

Method Summary

Modifier and Type	Method	Description
boolean	isEnabled()
void	onPhaseEnd(SearchPhaseContext context, SearchRequestContext searchRequestContext)
void	onPhaseFailure(SearchPhaseContext context)
void	onPhaseStart(SearchPhaseContext context)
void	onRequestEnd(SearchPhaseContext context, SearchRequestContext searchRequestContext)
void	onRequestStart(SearchRequestContext searchRequestContext)
void	setEnableTopQueries(MetricType metricType, boolean enabled)	Enable or disable top queries insights collection for MetricType This function will enable or disable the corresponding listeners and query insights services.

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

isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

QueryInsightsListener

@Inject
public QueryInsightsListener(ClusterService clusterService,
 QueryInsightsService queryInsightsService)

Constructor for QueryInsightsListener

Parameters:

clusterService - The Node's cluster service.

queryInsightsService - The topQueriesByLatencyService associated with this listener

Method Details

setEnableTopQueries

public void setEnableTopQueries(MetricType metricType,
 boolean enabled)

Enable or disable top queries insights collection for MetricType This function will enable or disable the corresponding listeners and query insights services.

Parameters:

metricType - MetricType

enabled - boolean

isEnabled

public boolean isEnabled()

Overrides:

isEnabled in class SearchRequestOperationsListener

onPhaseStart

public void onPhaseStart(SearchPhaseContext context)

Specified by:

onPhaseStart in class SearchRequestOperationsListener

onPhaseEnd

public void onPhaseEnd(SearchPhaseContext context,
 SearchRequestContext searchRequestContext)

Specified by:

onPhaseEnd in class SearchRequestOperationsListener

onPhaseFailure

public void onPhaseFailure(SearchPhaseContext context)

Specified by:

onPhaseFailure in class SearchRequestOperationsListener

onRequestStart

public void onRequestStart(SearchRequestContext searchRequestContext)

Overrides:

onRequestStart in class SearchRequestOperationsListener

onRequestEnd

public void onRequestEnd(SearchPhaseContext context,
 SearchRequestContext searchRequestContext)

Overrides:

onRequestEnd in class SearchRequestOperationsListener