IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Elasticsearch fields Envoyproxy fields »

› ›

Enterprise Search fields

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Enterprise Search fields

edit

Enterprise Search module

enterprisesearch

edit

enterprisesearch contains metrics and health information for Enterprise Search

enterprisesearch.cluster_uuid

Cluster UUID for the Elasticsearch cluster used as the data store for Enterprise Search.

type: keyword

health

edit

Enterprise Search health

enterprisesearch.health.name

Host name for the Enterprise Search node

type: keyword

version

edit

Enterprise Search version information

enterprisesearch.health.version.number

Enterprise Search version number using the semantic versioning format

type: keyword

enterprisesearch.health.version.build_hash

A unique build hash for the Enterprise Search package

type: keyword

process

edit

Enterprise Search process information

enterprisesearch.health.process.pid

Process ID for the Enterprise Search instance

type: long

enterprisesearch.health.process.uptime.sec

Process uptime for the Enterprise Search instance

type: long

filebeat

edit

Health information for the embedded Filebeat instance

enterprisesearch.health.process.filebeat.pid

Process ID for the embedded Filebeat instance

type: long

enterprisesearch.health.process.filebeat.restart_count

Number of times embedded Filebeat instance had to be restarted due to some issues

type: long

enterprisesearch.health.process.filebeat.time_since_last_restart.sec

Time since the last embedded Filebeat instance restart (-1 if never restarted)

type: long

jvm

edit

JVM health

enterprisesearch.health.jvm.version

JVM version used to run Enterprise Search

type: keyword

gc

edit

Java garbage collection metrics

enterprisesearch.health.jvm.gc.collection_count

Total number of Java garbage collector invocations since the start of the process

type: long

enterprisesearch.health.jvm.gc.collection_time.ms

Total time spent running Java garbage collector since the start of the process

type: long

memory_usage

edit

Memory usage

enterprisesearch.health.jvm.memory_usage.heap_init.bytes

Heap init used by the JVM in bytes.

type: long

format: bytes

enterprisesearch.health.jvm.memory_usage.heap_used.bytes

Heap used by the JVM in bytes.

type: long

format: bytes

enterprisesearch.health.jvm.memory_usage.heap_committed.bytes

Committed heap to the JVM in bytes.

type: long

format: bytes

enterprisesearch.health.jvm.memory_usage.heap_max.bytes

Max heap used by the JVM in bytes

type: long

format: bytes

enterprisesearch.health.jvm.memory_usage.non_heap_init.bytes

Non-Heap initial memory used by the JVM in bytes.

type: long

format: bytes

enterprisesearch.health.jvm.memory_usage.non_heap_committed.bytes

Non-Heap committed memory used by the JVM in bytes.

type: long

format: bytes

enterprisesearch.health.jvm.memory_usage.object_pending_finalization_count

Displays the approximate number of objects for which finalization is pending.

type: long

threads

edit

Threads information

enterprisesearch.health.jvm.threads.current

Current number of live threads.

type: long

enterprisesearch.health.jvm.threads.daemon

Current number of live daemon threads.

type: long

enterprisesearch.health.jvm.threads.max

Peak live thread count since the JVM started or the peak was reset.

type: long

enterprisesearch.health.jvm.threads.total_started

Total number of threads created and/or started since the JVM started.

type: long

crawler

edit

Crawler health

workers

edit

Crawler workers

enterprisesearch.health.crawler.workers.pool_size

Workers pool size.

type: long

enterprisesearch.health.crawler.workers.active

Number of active workers.

type: long

enterprisesearch.health.crawler.workers.available

Number of available workers.

type: long

stats

edit

Enterprise Search stats.

connectors

edit

Workplace Search connectors subsystem stats.

job_store

edit

Workplace Search connectors job store stats.

enterprisesearch.stats.connectors.job_store.waiting

Number of connectors jobs waiting to be processed.

type: long

enterprisesearch.stats.connectors.job_store.working

Number of connectors jobs currently being processed.

type: long

job_types

edit

Breakdown of connectors jobs by types.

enterprisesearch.stats.connectors.job_store.job_types.delete

Number of delete jobs in the jobs store.

type: long

enterprisesearch.stats.connectors.job_store.job_types.full

Number of full sync jobs in the jobs store.

type: long

enterprisesearch.stats.connectors.job_store.job_types.incremental

Number of incremental sync jobs in the jobs store.

type: long

enterprisesearch.stats.connectors.job_store.job_types.permissions

Number of permissions sync jobs in the jobs store.

type: long

pool

edit

Workplace Search worker pools stats.

extract_worker_pool

edit

Status information for the extrator workers pool.

enterprisesearch.stats.connectors.pool.extract_worker_pool.size

Worker pool size.

type: long

enterprisesearch.stats.connectors.pool.extract_worker_pool.busy

Number of busy workers.

type: long

enterprisesearch.stats.connectors.pool.extract_worker_pool.queue_depth

Number of items waiting to be processed.

type: long

enterprisesearch.stats.connectors.pool.extract_worker_pool.idle

Number of idle workers.

type: long

enterprisesearch.stats.connectors.pool.extract_worker_pool.total_completed

Number of jobs completed since the start.

type: long

enterprisesearch.stats.connectors.pool.extract_worker_pool.total_scheduled

Number of jobs scheduled since the start.

type: long

subextract_worker_pool

edit

Status information for the sub-extrator workers pool.

enterprisesearch.stats.connectors.pool.subextract_worker_pool.size

Worker pool size.

type: long

enterprisesearch.stats.connectors.pool.subextract_worker_pool.busy

Number of busy workers.

type: long

enterprisesearch.stats.connectors.pool.subextract_worker_pool.queue_depth

Number of items waiting to be processed.

type: long

enterprisesearch.stats.connectors.pool.subextract_worker_pool.idle

Number of idle workers.

type: long

enterprisesearch.stats.connectors.pool.subextract_worker_pool.total_completed

Number of jobs completed since the start.

type: long

enterprisesearch.stats.connectors.pool.subextract_worker_pool.total_scheduled

Number of jobs scheduled since the start.

type: long

publish_worker_pool

edit

Status information for the publish workers pool.

enterprisesearch.stats.connectors.pool.publish_worker_pool.size

Worker pool size.

type: long

enterprisesearch.stats.connectors.pool.publish_worker_pool.busy

Number of busy workers.

type: long

enterprisesearch.stats.connectors.pool.publish_worker_pool.queue_depth

Number of items waiting to be processed.

type: long

enterprisesearch.stats.connectors.pool.publish_worker_pool.idle

Number of idle workers.

type: long

enterprisesearch.stats.connectors.pool.publish_worker_pool.total_completed

Number of jobs completed since the start.

type: long

enterprisesearch.stats.connectors.pool.publish_worker_pool.total_scheduled

Number of jobs scheduled since the start.

type: long

http

edit

Incoming HTTP request metrics.

connections

edit

Incoming HTTP connection statistics.

enterprisesearch.stats.http.connections.current

Current number of HTTP connections opened to the Enterprise Search instance.

type: long

enterprisesearch.stats.http.connections.max

Maximum number of concurrent HTTP connections open to the Enterprise Search instance since the start.

type: long

enterprisesearch.stats.http.connections.total

Total number of HTTP connections opened to the Enterprise Search instance since the start.

type: long

network

edit

Network traffic metrics.

enterprisesearch.stats.http.network.received.bytes

Total number of bytes received by the Enterprise Search instance since the start.

type: long

format: bytes

enterprisesearch.stats.http.network.sent.bytes

Total number of bytes sent by the Enterprise Search instance since the start.

type: long

format: bytes

enterprisesearch.stats.http.network.received.bytes_per_sec

Average number of bytes received by the Enterprise Search instance per second since the start.

type: long

format: bytes

enterprisesearch.stats.http.network.sent.bytes_per_sec

Average number of bytes sent by the Enterprise Search instance per second since the start.

type: long

format: bytes

request_duration

edit

Aggregate HTTP request duration statistics.

enterprisesearch.stats.http.request_duration.max.ms

Longest HTTP connection duration since the start of the instance.

type: long

enterprisesearch.stats.http.request_duration.mean.ms

Average HTTP connection duration since the start of the instance.

type: long

enterprisesearch.stats.http.request_duration.std_dev.ms

Standard deviation for HTTP connection duration values since the start of the instance.

type: long

responses

edit

Aggregate HTTP response counts broken down by HTTP status type.

enterprisesearch.stats.http.responses.1xx

Total number of HTTP requests finished with a 1xx response code since the start of the instance.

type: long

enterprisesearch.stats.http.responses.2xx

Total number of HTTP requests finished with a 2xx response code since the start of the instance.

type: long

enterprisesearch.stats.http.responses.3xx

Total number of HTTP requests finished with a 3xx response code since the start of the instance.

type: long

enterprisesearch.stats.http.responses.4xx

Total number of HTTP requests finished with a 4xx response code since the start of the instance.

type: long

enterprisesearch.stats.http.responses.5xx

Total number of HTTP requests finished with a 5xx response code since the start of the instance.

type: long

queues

edit

Aggregate stats on the functioning of the background jobs processing pipeline within Enterprise Search.

enterprisesearch.stats.queues.engine_destroyer.count

Total number of jobs processed via the engine_destroyer queue since the start of the instance.

type: long

enterprisesearch.stats.queues.mailer.count

Total number of jobs processed via the mailer queue since the start of the instance.

type: long

enterprisesearch.stats.queues.process_crawl.count

Total number of jobs processed via the process_crawl queue since the start of the instance.

type: long

enterprisesearch.stats.queues.failed.count

Total number of jobs waiting in the failed queue.

type: long

product_usage

edit

Aggregate product usage statistics for the Enterprise Search deployment.

app_search

edit

App Search product usage statistics.

enterprisesearch.stats.product_usage.app_search.total_engines

Current number of App Search engines within the deployment.

type: long

workplace_search

edit

Workplace Search product usage statistics.

enterprisesearch.stats.product_usage.workplace_search.total_org_sources

Current number of Workplace Search org-wide content sources within the deployment.

type: long

enterprisesearch.stats.product_usage.workplace_search.total_private_sources

Current number of Workplace Search private content sources within the deployment.

type: long

« Elasticsearch fields Envoyproxy fields »