Package org.opensearch.plugin.insights.core.service

Class QueryInsightsService

java.lang.Object

org.opensearch.common.lifecycle.AbstractLifecycleComponent

org.opensearch.plugin.insights.core.service.QueryInsightsService

All Implemented Interfaces:

Closeable, AutoCloseable, org.opensearch.common.lease.Releasable, org.opensearch.common.lifecycle.LifecycleComponent

public class QueryInsightsService
extends org.opensearch.common.lifecycle.AbstractLifecycleComponent

Service responsible for gathering, analyzing, storing and exporting information related to search queries

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
protected Scheduler.Cancellable	scheduledFuture	Holds a reference to delayed operation Scheduler.Cancellable so it can be cancelled when the service closed concurrently.

Fields inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
QueryInsightsService(ThreadPool threadPool)	Constructor of the QueryInsightsService

Method Summary

Modifier and Type	Method	Description
boolean	addRecord(SearchQueryRecord record)	Ingest the query data into in-memory stores
protected void	doClose()
protected void	doStart()
protected void	doStop()
void	drainRecords()	Drain the queryRecordsQueue into internal stores and services
void	enableCollection(MetricType metricType, boolean enable)	Set flag to enable or disable Query Insights data collection
TopQueriesService	getTopQueriesService(MetricType metricType)	Get the top queries service based on metricType
boolean	isCollectionEnabled(MetricType metricType)	Get if the Query Insights data collection is enabled for a MetricType
boolean	isEnabled()	Check if query insights service is enabled

Methods inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Details

scheduledFuture

protected volatile Scheduler.Cancellable scheduledFuture

Holds a reference to delayed operation Scheduler.Cancellable so it can be cancelled when the service closed concurrently.

Constructor Details

QueryInsightsService

@Inject
public QueryInsightsService(ThreadPool threadPool)

Constructor of the QueryInsightsService

Parameters:

threadPool - The OpenSearch thread pool to run async tasks

Method Details

addRecord

public boolean addRecord(SearchQueryRecord record)

Ingest the query data into in-memory stores

Parameters:

record - the record to ingest

drainRecords

public void drainRecords()

Drain the queryRecordsQueue into internal stores and services

getTopQueriesService

public TopQueriesService getTopQueriesService(MetricType metricType)

Get the top queries service based on metricType

Parameters:

metricType - MetricType

Returns:

TopQueriesService

enableCollection

public void enableCollection(MetricType metricType,
 boolean enable)

Set flag to enable or disable Query Insights data collection

Parameters:

metricType - MetricType

enable - Flag to enable or disable Query Insights data collection

isCollectionEnabled

public boolean isCollectionEnabled(MetricType metricType)

Get if the Query Insights data collection is enabled for a MetricType

Parameters:

metricType - MetricType

Returns:

if the Query Insights data collection is enabled

isEnabled

public boolean isEnabled()

Check if query insights service is enabled

Returns:

if query insights service is enabled

doStart

protected void doStart()

Specified by:

doStart in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class org.opensearch.common.lifecycle.AbstractLifecycleComponent