Index (query-insights 2.12.0 API)

A C D E F G H I J L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values

A

addAttribute(Attribute, Object) - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Add an attribute to this record
addRecord(SearchQueryRecord) - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService: Ingest the query data into in-memory stores
allMetricTypes() - Static method in enum org.opensearch.plugin.insights.rules.model.MetricType: Get all valid metrics
Attribute - Enum in org.opensearch.plugin.insights.rules.model: Valid attributes for a search query record

C

canTripCircuitBreaker() - Method in class org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction
compare(Number, Number) - Method in enum org.opensearch.plugin.insights.rules.model.MetricType: Compare two numbers based on the metric type
compare(SearchQueryRecord, SearchQueryRecord, MetricType) - Static method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Compare two SearchQueryRecord, based on the given MetricType
CPU - Enum constant in enum org.opensearch.plugin.insights.rules.model.MetricType: CPU usage metric type
createComponents(Client, ClusterService, ThreadPool, ResourceWatcherService, ScriptService, NamedXContentRegistry, Environment, NodeEnvironment, NamedWriteableRegistry, IndexNameExpressionResolver, Supplier<RepositoriesService>) - Method in class org.opensearch.plugin.insights.QueryInsightsPlugin

D

DEFAULT_TOP_N_SIZE - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Default top N size to keep the data in query insight store
DEFAULT_WINDOW_SIZE - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Default window size in seconds to keep the top N queries with latency data in query insight store
doClose() - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService
doStart() - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService
doStop() - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService
drainRecords() - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService: Drain the queryRecordsQueue into internal stores and services

E

enableCollection(MetricType, boolean) - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService: Set flag to enable or disable Query Insights data collection
equals(Object) - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Check if a SearchQueryRecord is deep equal to another record

F

fromString(String) - Static method in enum org.opensearch.plugin.insights.rules.model.MetricType: Create MetricType from String

G

getActions() - Method in class org.opensearch.plugin.insights.QueryInsightsPlugin
getAttributes() - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Returns a map of the attributes associated with the metric.
getExecutorBuilders(Settings) - Method in class org.opensearch.plugin.insights.QueryInsightsPlugin
getMeasurement(MetricType) - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Returns the measurement associated with the specified name.
getMeasurements() - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Returns a map of all the measurements associated with the metric.
getMetricType() - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesRequest: Get the type of requested metrics
getName() - Method in class org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction
getRestHandlers(Settings, RestController, ClusterSettings, IndexScopedSettings, SettingsFilter, IndexNameExpressionResolver, Supplier<DiscoveryNodes>) - Method in class org.opensearch.plugin.insights.QueryInsightsPlugin
getSettings() - Method in class org.opensearch.plugin.insights.QueryInsightsPlugin
getTimestamp() - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Returns the observation time of the metric.
getTopNSize() - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Get the current configured top n size
getTopQueriesCurrentSnapshot() - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Get the current top queries snapshot from the AtomicReference.
getTopQueriesRecord() - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueries: Get all top queries records
getTopQueriesRecords(boolean) - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Get all top queries records that are in the current top n queries store Optionally include top N records from the last window.
getTopQueriesService(MetricType) - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService: Get the top queries service based on metricType

H

hashCode() - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord

I

INDICES - Enum constant in enum org.opensearch.plugin.insights.rules.model.Attribute: The indices involved
INSTANCE - Static variable in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesAction: The TopQueriesAction Instance.
isCollectionEnabled(MetricType) - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService: Get if the Query Insights data collection is enabled for a MetricType
isEnabled() - Method in class org.opensearch.plugin.insights.core.listener.QueryInsightsListener
isEnabled() - Method in class org.opensearch.plugin.insights.core.service.QueryInsightsService: Check if query insights service is enabled

J

JVM - Enum constant in enum org.opensearch.plugin.insights.rules.model.MetricType: JVM heap usage metric type

L

LATENCY - Enum constant in enum org.opensearch.plugin.insights.rules.model.MetricType: Latency metric type

M

MAX_N_SIZE - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Default N size for top N queries
MAX_THREAD_COUNT - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Max number of thread
MAX_WINDOW_SIZE - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Default Values and Settings
MetricType - Enum in org.opensearch.plugin.insights.rules.model: Valid metric types for a search query record
MIN_WINDOW_SIZE - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Minimal window size

N

NAME - Static variable in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesAction: The name of this Action
newNodeRequest(TopQueriesRequest) - Method in class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction
newNodeResponse(StreamInput) - Method in class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction
newResponse(TopQueriesRequest, List<TopQueries>, List<FailedNodeException>) - Method in class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction
NODE_ID - Enum constant in enum org.opensearch.plugin.insights.rules.model.Attribute: The node id for this request
nodeOperation(TransportTopQueriesAction.NodeRequest) - Method in class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction
NodeRequest(StreamInput) - Constructor for class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction.NodeRequest: Create the NodeResponse object from StreamInput
NodeRequest(TopQueriesRequest) - Constructor for class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction.NodeRequest: Create the NodeResponse object from a TopQueriesRequest

O

onPhaseEnd(SearchPhaseContext, SearchRequestContext) - Method in class org.opensearch.plugin.insights.core.listener.QueryInsightsListener
onPhaseFailure(SearchPhaseContext) - Method in class org.opensearch.plugin.insights.core.listener.QueryInsightsListener
onPhaseStart(SearchPhaseContext) - Method in class org.opensearch.plugin.insights.core.listener.QueryInsightsListener
onRequestEnd(SearchPhaseContext, SearchRequestContext) - Method in class org.opensearch.plugin.insights.core.listener.QueryInsightsListener
onRequestStart(SearchRequestContext) - Method in class org.opensearch.plugin.insights.core.listener.QueryInsightsListener
org.opensearch.plugin.insights - package org.opensearch.plugin.insights: Base Package of Query Insights
org.opensearch.plugin.insights.core.listener - package org.opensearch.plugin.insights.core.listener: Listeners for Query Insights
org.opensearch.plugin.insights.core.service - package org.opensearch.plugin.insights.core.service: Service Classes for Query Insights
org.opensearch.plugin.insights.rules.action.top_queries - package org.opensearch.plugin.insights.rules.action.top_queries: Transport Actions, Requests and Responses for Top N Queries
org.opensearch.plugin.insights.rules.model - package org.opensearch.plugin.insights.rules.model: Data Models for Query Insight Records
org.opensearch.plugin.insights.rules.resthandler.top_queries - package org.opensearch.plugin.insights.rules.resthandler.top_queries: Rest Handlers for Top N Queries
org.opensearch.plugin.insights.rules.transport.top_queries - package org.opensearch.plugin.insights.rules.transport.top_queries: Transport Actions for Top N Queries.
org.opensearch.plugin.insights.settings - package org.opensearch.plugin.insights.settings: Settings for Query Insights Plugin

P

PHASE_LATENCY_MAP - Enum constant in enum org.opensearch.plugin.insights.rules.model.Attribute: The per phase level latency map for a search query
PLUGINS_BASE_URI - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Query Insights base uri
prepareRequest(RestRequest, NodeClient) - Method in class org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction

Q

QUERY_INSIGHTS_EXECUTOR - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Executors settings
QUERY_RECORD_QUEUE_CAPACITY - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Max number of requests for the consumer to collect at one time
QUERY_RECORD_QUEUE_DRAIN_INTERVAL - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Time interval for record queue consumer to run
QueryInsightsListener - Class in org.opensearch.plugin.insights.core.listener: The listener for query insights services.
QueryInsightsListener(ClusterService, QueryInsightsService) - Constructor for class org.opensearch.plugin.insights.core.listener.QueryInsightsListener: Constructor for QueryInsightsListener
QueryInsightsPlugin - Class in org.opensearch.plugin.insights: Plugin class for Query Insights.
QueryInsightsPlugin() - Constructor for class org.opensearch.plugin.insights.QueryInsightsPlugin: Default constructor
QueryInsightsService - Class in org.opensearch.plugin.insights.core.service: Service responsible for gathering, analyzing, storing and exporting information related to search queries
QueryInsightsService(ThreadPool) - Constructor for class org.opensearch.plugin.insights.core.service.QueryInsightsService: Constructor of the QueryInsightsService
QueryInsightsSettings - Class in org.opensearch.plugin.insights.settings: Settings for Query Insights Plugin
QueryInsightsSettings() - Constructor for class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Default constructor

R

readFromStream(StreamInput) - Static method in enum org.opensearch.plugin.insights.rules.model.MetricType: Read a MetricType from a StreamInput
readNodesFrom(StreamInput) - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesResponse
responseParams() - Method in class org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction
RestTopQueriesAction - Class in org.opensearch.plugin.insights.rules.resthandler.top_queries: Rest action to get Top N queries by certain metric type
RestTopQueriesAction() - Constructor for class org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction: Constructor for RestTopQueriesAction
routes() - Method in class org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction

S

scheduledFuture - Variable in class org.opensearch.plugin.insights.core.service.QueryInsightsService: Holds a reference to delayed operation Scheduler.Cancellable so it can be cancelled when the service closed concurrently.
SEARCH_TYPE - Enum constant in enum org.opensearch.plugin.insights.rules.model.Attribute: The search query type
SearchQueryRecord - Class in org.opensearch.plugin.insights.rules.model: SearchQueryRecord represents a minimal atomic record stored in the Query Insight Framework, which contains extensive information related to a search query.
SearchQueryRecord(long, Map<MetricType, Number>, Map<Attribute, Object>) - Constructor for class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Constructor of SearchQueryRecord
SearchQueryRecord(StreamInput) - Constructor for class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Constructor of SearchQueryRecord
setEnabled(boolean) - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Set enable flag for the service
setEnableTopQueries(MetricType, boolean) - Method in class org.opensearch.plugin.insights.core.listener.QueryInsightsListener: Enable or disable top queries insights collection for MetricType This function will enable or disable the corresponding listeners and query insights services.
setTopNSize(int) - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Set the top N size for TopQueriesService service.
setWindowSize(TimeValue) - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Set the window size for top N queries service
SOURCE - Enum constant in enum org.opensearch.plugin.insights.rules.model.Attribute: The search query source

T

TOP_N_LATENCY_QUERIES_ENABLED - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Boolean setting for enabling top queries by latency.
TOP_N_LATENCY_QUERIES_PREFIX - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Default prefix for top N queries by latency feature
TOP_N_LATENCY_QUERIES_SIZE - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Int setting to define the top n size for top queries by latency.
TOP_N_LATENCY_QUERIES_WINDOW_SIZE - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Time setting to define the window size in seconds for top queries by latency.
TOP_N_QUERIES_SETTING_PREFIX - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Default prefix for top N queries feature
TOP_QUERIES_BASE_URI - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Settings for Top Queries
TopQueries - Class in org.opensearch.plugin.insights.rules.action.top_queries: Holds all top queries records by resource usage or latency on a node Mainly used in the top N queries node response workflow.
TopQueries(DiscoveryNode, List<SearchQueryRecord>) - Constructor for class org.opensearch.plugin.insights.rules.action.top_queries.TopQueries: Create the TopQueries Object
TopQueries(StreamInput) - Constructor for class org.opensearch.plugin.insights.rules.action.top_queries.TopQueries: Create the TopQueries Object from StreamInput
TopQueriesAction - Class in org.opensearch.plugin.insights.rules.action.top_queries: Transport action for cluster/node level top queries information.
TopQueriesRequest - Class in org.opensearch.plugin.insights.rules.action.top_queries: A request to get cluster/node level top queries information.
TopQueriesRequest(StreamInput) - Constructor for class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesRequest: Constructor for TopQueriesRequest
TopQueriesRequest(MetricType, String...) - Constructor for class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesRequest: Get top queries from nodes based on the nodes ids specified.
TopQueriesResponse - Class in org.opensearch.plugin.insights.rules.action.top_queries: Transport response for cluster/node level top queries information.
TopQueriesResponse(ClusterName, List<TopQueries>, List<FailedNodeException>, int, MetricType) - Constructor for class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesResponse: Constructor for TopQueriesResponse
TopQueriesResponse(StreamInput) - Constructor for class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesResponse: Constructor for TopQueriesResponse.
TopQueriesService - Class in org.opensearch.plugin.insights.core.service: Service responsible for gathering and storing top N queries with high latency or resource usage
toString() - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesResponse
toString() - Method in enum org.opensearch.plugin.insights.rules.model.Attribute
toString() - Method in enum org.opensearch.plugin.insights.rules.model.MetricType
TOTAL_SHARDS - Enum constant in enum org.opensearch.plugin.insights.rules.model.Attribute: Total shards queried
toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueries
toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesResponse
toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord
TransportTopQueriesAction - Class in org.opensearch.plugin.insights.rules.transport.top_queries: Transport action for cluster/node level top queries information.
TransportTopQueriesAction(ThreadPool, ClusterService, TransportService, QueryInsightsService, ActionFilters) - Constructor for class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction: Create the TransportTopQueriesAction Object
TransportTopQueriesAction.NodeRequest - Class in org.opensearch.plugin.insights.rules.transport.top_queries: Inner Node Top Queries Request

V

VALID_WINDOW_SIZES_IN_MINUTES - Static variable in class org.opensearch.plugin.insights.settings.QueryInsightsSettings: Valid window sizes
validateTopNSize(int) - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Validate the top N size based on the internal constrains
validateWindowSize(TimeValue) - Method in class org.opensearch.plugin.insights.core.service.TopQueriesService: Validate if the window size is valid, based on internal constrains.
valueOf(String) - Static method in enum org.opensearch.plugin.insights.rules.model.Attribute: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opensearch.plugin.insights.rules.model.MetricType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.opensearch.plugin.insights.rules.model.Attribute: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opensearch.plugin.insights.rules.model.MetricType: Returns an array containing the constants of this enum type, in the order they are declared.

W

writeNodesTo(StreamOutput, List<TopQueries>) - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesResponse
writeTo(StreamOutput) - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueries
writeTo(StreamOutput) - Method in class org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesRequest
writeTo(StreamOutput) - Method in class org.opensearch.plugin.insights.rules.model.SearchQueryRecord: Write a SearchQueryRecord to a StreamOutput
writeTo(StreamOutput) - Method in class org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction.NodeRequest

A C D E F G H I J L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values