Stackstate-Elasticsearch Integration

Overview

Elasticsearch

Connect Elasticsearch to Stackstate in order to:

  • Visualize Elasticsearch performance.
  • Correlate Elasticsearch performance with the rest of your applications.

Installation

No installation steps are required for this integration

Configuration

  1. Edit your conf.d/elastic.yaml file as follows:

    init_config:
    
    instances:
      - url: http://elastic:9200
        # The format for the url entry is url: http://servername:port
    
  2. Restart the agent

For more details about configuring this integration refer to the following file(s) on GitHub:

Validation

To validate that the integration is working, run stackstate-agent info. You should see results similar to the following:

Checks
======

    ntp
    ---
      - instance #0 [OK]
      - Collected 1 metric, 0 events & 2 service checks

    disk
    ----
      - instance #0 [OK]
      - Collected 32 metrics, 0 events & 1 service check

    elastic
    -------
      - instance #0 [OK]
      - Collected 97 metrics, 0 events & 3 service checks

Metrics

elasticsearch.active_primary_shards
(gauge)
The number of active primary shards in the cluster.
shown as shard
elasticsearch.active_shards
(gauge)
The number of active shards in the cluster.
shown as shard
elasticsearch.cache.field.evictions
(gauge)
The total number of evictions from the field data cache.
shown as eviction
elasticsearch.cache.field.size
(gauge)
The size of the field cache.
shown as byte
elasticsearch.cache.filter.count
(gauge)
The number of items in the filter cache.
shown as item
elasticsearch.cache.filter.evictions
(gauge)
The total number of evictions from the filter cache.
shown as eviction
elasticsearch.cache.filter.size
(gauge)
The size of the filter cache.
shown as byte
elasticsearch.cluster_status
(gauge)
The elasticsearch cluster health as a number: red = 0, yellow = 1, green = 2
elasticsearch.docs.count
(gauge)
The total number of documents in the cluster across all shards.
shown as document
elasticsearch.docs.deleted
(gauge)
The total number of documents deleted from the cluster across all shards.
shown as document
elasticsearch.fielddata.evictions
(gauge)
The total number of evictions from the fielddata cache.
shown as eviction
elasticsearch.fielddata.size
(gauge)
The size of the fielddata cache.
shown as byte
elasticsearch.flush.total
(gauge)
The total number of index flushes to disk since start.
shown as flush
elasticsearch.flush.total.time
(gauge)
The total time spent flushing the index to disk.
shown as second
elasticsearch.fs.total.available_in_bytes
(gauge)
The total number of bytes available to this Java virtual machine on this file store.
shown as byte
elasticsearch.fs.total.disk_io_op
(gauge)
The total I/O operations on the file store.
shown as operation
elasticsearch.fs.total.disk_io_size_in_bytes
(gauge)
Total bytes used for all I/O operations on the file store.
shown as byte
elasticsearch.fs.total.disk_read_size_in_bytes
(gauge)
The total bytes read from the file store.
shown as byte
elasticsearch.fs.total.disk_reads
(gauge)
The total number of reads from the file store.
shown as read
elasticsearch.fs.total.disk_write_size_in_bytes
(gauge)
The total bytes written to the file store.
shown as byte
elasticsearch.fs.total.disk_writes
(gauge)
The total number of writes to the file store.
shown as write
elasticsearch.fs.total.free_in_bytes
(gauge)
The total number of unallocated bytes in the file store.
shown as byte
elasticsearch.fs.total.total_in_bytes
(gauge)
The total size in bytes of the file store.
shown as byte
elasticsearch.get.current
(gauge)
The number of get requests currently running.
shown as request
elasticsearch.get.exists.time
(gauge)
The total time spent on get requests where the document existed.
shown as second
elasticsearch.get.exists.total
(gauge)
The total number of get requests where the document existed.
shown as request
elasticsearch.get.missing.time
(gauge)
The total time spent on get requests where the document was missing.
shown as second
elasticsearch.get.missing.total
(gauge)
The total number of get requests where the document was missing.
shown as request
elasticsearch.get.time
(gauge)
The total time spent on get requests.
shown as second
elasticsearch.get.total
(gauge)
The total number of get requests.
shown as request
elasticsearch.http.current_open
(gauge)
The number of current open HTTP connections.
shown as connection
elasticsearch.http.total_opened
(gauge)
The total number of opened HTTP connections.
shown as connection
elasticsearch.id_cache.size
(gauge)
The size of the id cache
shown as byte
elasticsearch.indexing.delete.current
(gauge)
The number of documents currently being deleted from an index.
shown as document
elasticsearch.indexing.delete.time
(gauge)
The total time spent deleting documents from an index.
shown as second
elasticsearch.indexing.delete.total
(gauge)
The total number of documents deleted from an index.
shown as document
elasticsearch.indexing.index.current
(gauge)
The number of documents currently being indexed to an index.
shown as document
elasticsearch.indexing.index.time
(gauge)
The total time spent indexing documents to an index.
shown as second
elasticsearch.indexing.index.total
(gauge)
The total number of documents indexed to an index.
shown as document
elasticsearch.indices.segments.count
(gauge)
The number of segments in an index shard.
shown as segment
elasticsearch.indices.segments.fixed_bit_set_memory_in_bytes
(gauge)
The size used by the in memory fixed bit set.
shown as byte
elasticsearch.indices.segments.index_writer_max_memory_in_bytes
(gauge)
The maximum memory used by the index writer.
shown as byte
elasticsearch.indices.segments.index_writer_memory_in_bytes
(gauge)
The memory used by the index writer.
shown as byte
elasticsearch.indices.segments.memory_in_bytes
(gauge)
The memory used by index segments.
shown as byte
elasticsearch.indices.segments.version_map_memory_in_bytes
(gauge)
The memory used by the segment version map.
shown as byte
elasticsearch.indices.translog.operations
(gauge)
The number of operations in the transaction log.
shown as operation
elasticsearch.indices.translog.size_in_bytes
(gauge)
The size of the transaction log.
shown as byte
elasticsearch.initializing_shards
(gauge)
The number of shards that are currently initializing.
shown as shard
elasticsearch.merges.current
(gauge)
The number of currently active segment merges.
shown as merge
elasticsearch.merges.current.docs
(gauge)
The number of documents across segments currently being merged.
shown as document
elasticsearch.merges.current.size
(gauge)
The size of the segments currently being merged.
shown as byte
elasticsearch.merges.total
(gauge)
The total number of segment merges.
shown as merge
elasticsearch.merges.total.docs
(gauge)
The total number of documents across all merged segments.
shown as document
elasticsearch.merges.total.size
(gauge)
The total size of all merged segments.
shown as byte
elasticsearch.merges.total.time
(gauge)
The total time spent on segment merging.
shown as second
elasticsearch.number_of_data_nodes
(gauge)
The number of data nodes in the cluster.
shown as node
elasticsearch.number_of_nodes
(gauge)
The total number of nodes in the cluster.
shown as node
elasticsearch.pending_tasks_priority_high
(gauge)
The number of high priority pending tasks.
shown as task
elasticsearch.pending_tasks_priority_urgent
(gauge)
The number of urgent priority pending tasks.
shown as task
elasticsearch.pending_tasks_total
(gauge)
The total number of pending tasks.
shown as task
elasticsearch.primaries.docs.count
(gauge)
The total number of documents in the primary shards.
shown as document
elasticsearch.primaries.docs.deleted
(gauge)
The total number of documents deleted from the primary shards.
shown as document
elasticsearch.primaries.flush.total
(gauge)
The total number of index flushes to disk from the primary shards since start.
shown as flush
elasticsearch.primaries.flush.total.time
(gauge)
The total time spent flushing the index to disk from the primary shards.
shown as second
elasticsearch.primaries.get.current
(gauge)
The number of get requests currently running on the primary shards.
shown as request
elasticsearch.primaries.get.exists.time
(gauge)
The total time spent on get requests from the primary shards where the document existed.
shown as request
elasticsearch.primaries.get.exists.total
(gauge)
The total number of get requests on primary shards where the document existed.
shown as request
elasticsearch.primaries.get.missing.time
(gauge)
The total time spent on get requests from the primary shards where the document was missing.
shown as second
elasticsearch.primaries.get.missing.total
(gauge)
The total number of get requests from the primary shards where the document was missing.
shown as request
elasticsearch.primaries.get.time
(gauge)
The total time spent on get requests from the primary shards.
shown as second
elasticsearch.primaries.get.total
(gauge)
The total number of get requests from the primary shards.
shown as request
elasticsearch.primaries.indexing.delete.current
(gauge)
The number of documents currently being deleted from an index on the primary shards.
shown as document
elasticsearch.primaries.indexing.delete.time
(gauge)
The total time spent deleting documents from an index on the primary shards.
shown as second
elasticsearch.primaries.indexing.delete.total
(gauge)
The total number of documents deleted from an index on the primary shards.
shown as document
elasticsearch.primaries.indexing.index.current
(gauge)
The number of documents currently being indexed to an index on the primary shards.
shown as document
elasticsearch.primaries.indexing.index.time
(gauge)
The total time spent indexing documents to an index on the primary shards.
shown as second
elasticsearch.primaries.indexing.index.total
(gauge)
The total number of documents indexed to an index on the primary shards.
shown as document
elasticsearch.primaries.merges.current
(gauge)
The number of currently active segment merges on the primary shards.
shown as merge
elasticsearch.primaries.merges.current.docs
(gauge)
The number of documents across segments currently being merged on the primary shards.
shown as document
elasticsearch.primaries.merges.current.size
(gauge)
The size of the segments currently being merged on the primary shards.
shown as byte
elasticsearch.primaries.merges.total
(gauge)
The total number of segment merges on the primary shards.
shown as merge
elasticsearch.primaries.merges.total.docs
(gauge)
The total number of documents across all merged segments on the primary shards.
shown as document
elasticsearch.primaries.merges.total.size
(gauge)
The total size of all merged segments on the primary shards.
shown as byte
elasticsearch.primaries.merges.total.time
(gauge)
The total time spent on segment merging on the primary shards.
shown as second
elasticsearch.primaries.refresh.total
(gauge)
The total number of index refreshes on the primary shards.
shown as refresh
elasticsearch.primaries.refresh.total.time
(gauge)
The total time spent on index refreshes on the primary shards.
shown as second
elasticsearch.primaries.search.fetch.current
(gauge)
The number of query fetches currently running on the primary shards.
shown as fetch
elasticsearch.primaries.search.fetch.time
(gauge)
The total time spent on query fetches on the primary shards.
shown as second
elasticsearch.primaries.search.fetch.total
(gauge)
The total number of query fetches on the primary shards.
shown as fetch
elasticsearch.primaries.search.query.current
(gauge)
The number of currently active queries on the primary shards.
shown as query
elasticsearch.primaries.search.query.time
(gauge)
The total time spent querying on the primary shards.
shown as second
elasticsearch.primaries.search.query.total
(gauge)
The total number of queries to the primary shards.
shown as query
elasticsearch.primaries.store.size
(gauge)
The total size of all the primary shards.
shown as byte
elasticsearch.process.open_fd
(gauge)
The number of opened file descriptors associated with the current process, or -1 if not supported.
shown as file
elasticsearch.refresh.total
(gauge)
The total number of index refreshes.
shown as refresh
elasticsearch.refresh.total.time
(gauge)
The total time spent on index refreshes.
shown as second
elasticsearch.relocating_shards
(gauge)
The number of shards that are reloacting from one node to another.
shown as shard
elasticsearch.search.fetch.current
(gauge)
The number of search fetches currently running.
shown as fetch
elasticsearch.search.fetch.open_contexts
(gauge)
The number of active searches.
shown as query
elasticsearch.search.fetch.time
(gauge)
The total time spent on the search fetch.
shown as second
elasticsearch.search.fetch.total
(gauge)
The total number of search fetches.
shown as fetch
elasticsearch.search.query.current
(gauge)
The number of currently active queries.
shown as query
elasticsearch.search.query.time
(gauge)
The total time spent on queries.
shown as second
elasticsearch.search.query.total
(gauge)
The total number of queries.
shown as query
elasticsearch.store.size
(gauge)
The total size in bytes of the store.
shown as byte
elasticsearch.thread_pool.bulk.active
(gauge)
The number of active threads in the bulk pool.
shown as thread
elasticsearch.thread_pool.bulk.queue
(gauge)
The number of queued threads in the bulk pool.
shown as thread
elasticsearch.thread_pool.bulk.threads
(gauge)
The total number of threads in the bulk pool.
shown as thread
elasticsearch.thread_pool.bulk.rejected
(gauge)
The number of rejected threads in the bulk pool.
shown as thread
elasticsearch.thread_pool.flush.active
(gauge)
The number of active threads in the flush queue.
shown as thread
elasticsearch.thread_pool.flush.queue
(gauge)
The number of queued threads in the flush pool.
shown as thread
elasticsearch.thread_pool.flush.threads
(gauge)
The total number of threads in the flush pool.
shown as thread
elasticsearch.thread_pool.generic.active
(gauge)
The number of active threads in the generic pool.
shown as thread
elasticsearch.thread_pool.generic.queue
(gauge)
The number of queued threads in the generic pool.
shown as thread
elasticsearch.thread_pool.generic.threads
(gauge)
The total number of threads in the generic pool.
shown as thread
elasticsearch.thread_pool.get.active
(gauge)
The number of active threads in the get pool.
shown as thread
elasticsearch.thread_pool.get.queue
(gauge)
The number of queued threads in the get pool.
shown as thread
elasticsearch.thread_pool.get.threads
(gauge)
The total number of threads in the get pool.
shown as thread
elasticsearch.thread_pool.index.active
(gauge)
The number of active threads in the index pool.
shown as thread
elasticsearch.thread_pool.index.queue
(gauge)
The number of queued threads in the index pool.
shown as thread
elasticsearch.thread_pool.index.threads
(gauge)
The total number of threads in the index pool.
shown as thread
elasticsearch.thread_pool.management.active
(gauge)
The number of active threads in the management pool.
shown as thread
elasticsearch.thread_pool.management.queue
(gauge)
The number of queued threads in the management pool.
shown as thread
elasticsearch.thread_pool.management.threads
(gauge)
The total number of threads in the management pool.
shown as thread
elasticsearch.thread_pool.merge.active
(gauge)
The number of active threads in the merge pool.
shown as thread
elasticsearch.thread_pool.merge.queue
(gauge)
The number of queued threads in the merge pool.
shown as thread
elasticsearch.thread_pool.merge.threads
(gauge)
The total number of threads in the merge pool.
shown as thread
elasticsearch.thread_pool.percolate.active
(gauge)
The number of active threads in the percolate pool.
shown as thread
elasticsearch.thread_pool.percolate.queue
(gauge)
The number of queued threads in the percolate pool.
shown as thread
elasticsearch.thread_pool.percolate.threads
(gauge)
The total number of threads in the percolate pool.
shown as thread
elasticsearch.thread_pool.refresh.active
(gauge)
The number of active threads in the refresh pool.
shown as thread
elasticsearch.thread_pool.refresh.queue
(gauge)
The number of queued threads in the refresh pool.
shown as thread
elasticsearch.thread_pool.refresh.threads
(gauge)
The total number of threads in the refresh pool.
shown as thread
elasticsearch.thread_pool.search.active
(gauge)
The number of active threads in the search pool.
shown as thread
elasticsearch.thread_pool.search.queue
(gauge)
The number of queued threads in the search pool.
shown as thread
elasticsearch.thread_pool.search.threads
(gauge)
The total number of threads in the search pool.
shown as thread
elasticsearch.thread_pool.snapshot.active
(gauge)
The number of active threads in the snapshot pool.
shown as thread
elasticsearch.thread_pool.snapshot.queue
(gauge)
The number of queued threads in the snapshot pool.
shown as thread
elasticsearch.thread_pool.snapshot.threads
(gauge)
The total number of threads in the snapshot pool.
shown as thread
elasticsearch.transport.rx_count
(gauge)
The total number of packets received in cluster communication.
shown as packet
elasticsearch.transport.rx_size
(gauge)
The total size of data received in cluster communication.
shown as byte
elasticsearch.transport.server_open
(gauge)
The number of connections opened for cluster communication.
shown as connection
elasticsearch.transport.tx_count
(gauge)
The total number of packets sent in cluster communication.
shown as packet
elasticsearch.transport.tx_size
(gauge)
The total size of data sent in cluster communication.
shown as byte
elasticsearch.unassigned_shards
(gauge)
The number of shards that are unassigned to a node.
shown as shard
jvm.gc.collection_count
(gauge)
The total number of garbage collections run by the JVM.
shown as garbage collection
jvm.gc.collection_time
(gauge)
The total time spent on garbage collection in the JVM.
shown as second
jvm.gc.collectors.old.collection_time
(gauge)
The total time spent in major GCs in the JVM that collect old generation objects.
shown as second
jvm.gc.collectors.old.count
(gauge)
The total count of major GCs in the JVM that collect old generation objects.
shown as garbage collection
jvm.gc.collectors.young.collection_time
(gauge)
The total time spent in minor GCs in the JVM that collects young generation objects.
shown as second
jvm.gc.collectors.young.count
(gauge)
The total count of minor GCs in the JVM that collects young generation objects.
shown as garbage collection
jvm.gc.concurrent_mark_sweep.collection_time
(gauge)
The total time spent on "concurrent mark & sweep" GCs in the JVM.
shown as second
jvm.gc.concurrent_mark_sweep.count
(gauge)
The total count of "concurrent mark & sweep" GCs in the JVM.
shown as garbage collection
jvm.gc.par_new.collection_time
(gauge)
The total time spent on "parallel new" GCs in the JVM.
shown as second
jvm.gc.par_new.count
(gauge)
The total count of "parallel new" GCs in the JVM.
shown as garbage collection
jvm.mem.heap_committed
(gauge)
The amount of memory guaranteed to be available to the JVM heap.
shown as byte
jvm.mem.heap_in_use
(gauge)
The amount of memory currently used by the JVM heap as a value between 0 and 1.
jvm.mem.heap_max
(gauge)
The maximum amount of memory that can be used by the JVM heap.
shown as byte
jvm.mem.heap_used
(gauge)
The amount of memory in bytes currently used by the JVM heap.
shown as byte
jvm.mem.non_heap_committed
(gauge)
The amount of memory guaranteed to be available to JVM non-heap.
shown as byte
jvm.mem.non_heap_used
(gauge)
The amount of memory in bytes currently used by the JVM non-heap.
shown as byte
jvm.threads.count
(gauge)
The number of active threads in the JVM.
shown as thread
jvm.threads.peak_count
(gauge)
The peak number of threads used by the JVM.
shown as thread