Get enrich stats

  • GET /_enrich/_stats
Auth

Returns enrich coordinator statistics and information about enrich policies that are currently executing.

Query parameters

master_timeout string · default: 30s

Period to wait for a connection to the master node.

Response

application/json
coordinator_stats object[] required

Objects containing information about each coordinating ingest node for configured enrich processors.

executed_searches_total number required
node_id string required
queue_size number required
remote_requests_current number required
remote_requests_total number required
executing_policies object[] required

Objects containing information about each enrich policy that is currently executing.

name string required
task object required
action string required
cancelled boolean
cancellable boolean required
description string

Human readable text that identifies the particular request that the task is performing. For example, it might identify the search request being performed by a search task. Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.

headers map string to string required
id number required
node string required
running_time string
running_time_in_nanos number required
start_time_in_millis number required
status object

The internal status of the task, which varies from task to task. The format also varies. While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.

type string required
parent_task_id string
original_task_id string

The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task). For tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response.

original_start_time_in_millis number

The time at which the original task started, in milliseconds since the Unix epoch. Only present together with original_task_id.

original_start_time string

The time at which the original task started, as an ISO 8601 formatted string. Only present together with original_task_id and when the request includes the ?human=true query parameter.

cache_stats object[]

Objects containing information about the enrich cache stats on each ingest node.

node_id string required
count number required
hits number required
hits_time_in_millis number required
misses number required
misses_time_in_millis number required
evictions number required
size_in_bytes number required