--- title: Eventstore description: Collects Eventstore Metrics breadcrumbs: Docs > Integrations > Eventstore --- # Eventstore Supported OS Integration version2.1.0 ## Overview{% #overview %} Get metrics from EventStore in real time to: - Visualize and monitor EventStore queues - Capture all available metrics within the following API endpoints: stats, node info, non-transient projections, subscriptions, cluster gossip (the list of endpoints to scrape is configurable) ## Setup{% #setup %} The EventStore check is not included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you need to install it. ### Installation{% #installation %} For Agent v7.21+ / v6.21+, follow the instructions below to install the EventStore check on your host. See [Use Community Integrations](https://docs.datadoghq.com/agent/guide/use-community-integrations.md) to install with the Docker Agent or earlier versions of the Agent. 1. Run the following command to install the Agent integration: ```shell datadog-agent integration install -t datadog-eventstore== ``` 1. Configure your integration similar to core [integrations](https://docs.datadoghq.com/getting_started/integrations.md). ### Configuration{% #configuration %} 1. Edit the `eventstore.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory) to start collecting your EventStore metrics. See the [sample eventstore.d/conf.yaml](https://github.com/DataDog/integrations-extras/blob/master/eventstore/datadog_checks/eventstore/data/conf.yaml.example) for all available configuration options. 1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-restart-the-agent). ### Validation{% #validation %} [Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#service-status) and look for `eventstore` under the Checks section. ## Compatibility{% #compatibility %} The check is compatible with all major platforms. ## Data Collected{% #data-collected %} ### Metrics{% #metrics %} | | | | | **eventstore.proc.mem**(gauge) | Current memory usage*Shown as byte* | | **eventstore.proc.cpu**(gauge) | Current CPU usage | | **eventstore.proc.threads**(gauge) | Current threads | | **eventstore.proc.contentions\_rate**(gauge) | current contentions | | **eventstore.proc.thrown\_exceptions\_rate**(gauge) | number of exceptions | | **eventstore.proc.disk.read\_bytes**(gauge) | Disk Reads (Bytes)*Shown as byte* | | **eventstore.proc.disk.write\_bytes**(gauge) | Disk Writes (Bytes)*Shown as byte* | | **eventstore.proc.disk.read\_ops**(gauge) | Disk Reads (Ops) | | **eventstore.proc.disk.write\_ops**(gauge) | Disk Writes (Ops) | | **eventstore.tcp.connections**(gauge) | Tcp Connections | | **eventstore.tcp.receiving\_speed**(gauge) | Tcp Receiving | | **eventstore.tcp.sending\_speed**(gauge) | Tcp Sending | | **eventstore.tcp.in\_send**(gauge) | Tcp In | | **eventstore.tcp.measure\_time**(gauge) | Tcp Measure | | **eventstore.tcp.pending\_received**(gauge) | Tcp Pending | | **eventstore.tcp.pending\_send**(gauge) | Tcp Pending | | **eventstore.tcp.received\_bytes.since\_last\_run**(gauge) | Received_Bytes Since_Last | | **eventstore.tcp.received\_bytes.total**(gauge) | Received_Bytes Bytes | | **eventstore.tcp.sent\_bytes.since\_last\_run**(gauge) | Sent_Bytes Since_Last | | **eventstore.tcp.sent\_bytes.total**(gauge) | Sent_Bytes total | | **eventstore.gc.allocation\_speed**(gauge) | Allocation Speed | | **eventstore.gc.items\_count.gen0**(gauge) | Items Count.Gen0 | | **eventstore.gc.size.gen0**(gauge) | Gen0 Gen0 | | **eventstore.gc.items\_count.gen1**(gauge) | Items Count.Gen1 | | **eventstore.gc.size.gen1**(gauge) | Gen1 Gen1 | | **eventstore.gc.items\_count.gen2**(gauge) | Items Count.Gen2 | | **eventstore.gc.size.gen2**(gauge) | Gen2 Gen2 | | **eventstore.gc.large\_heap\_size**(gauge) | Large_Heap Size | | **eventstore.gc.time\_in\_gc**(gauge) | Time_In Gc | | **eventstore.gc.total\_bytes\_in\_heaps**(gauge) | Total_Bytes_In Heaps*Shown as byte* | | **eventstore.sys.free\_mem**(gauge) | Free Mem | | **eventstore.es.queue.avg\_items\_per\_second**(gauge) | Queue Avg items per second | | **eventstore.es.queue.avg\_processing\_time**(gauge) | Queue Avg processing Time | | **eventstore.es.queue.current\_idle\_time**(gauge) | Queue Current idle Time | | **eventstore.es.queue.current\_processing\_time**(gauge) | Queue Current processing Time | | **eventstore.es.queue.idle\_time\_percent**(gauge) | Queue Idle time Percent | | **eventstore.es.queue.length**(gauge) | Queue Length queue Length | | **eventstore.es.queue.length\_current\_try\_peak**(gauge) | Queue Length current try peak | | **eventstore.es.queue.length\_lifetime\_peak**(gauge) | Queue Length lifetime Peak | | **eventstore.es.queue.total\_items\_processed**(gauge) | Queue Total items Processed | | **eventstore.es.writer.flush\_size.last**(gauge) | Writer Last Flush Size | | **eventstore.es.writer.flush\_delay\_ms.last**(gauge) | Writer Last flush delay (ms)*Shown as millisecond* | | **eventstore.es.writer.flush\_size.mean**(gauge) | Writer Mean flush size | | **eventstore.es.writer.flush\_delay\_ms.mean**(gauge) | Writer Mean flush delay (ms) | | **eventstore.es.writer.flush\_size.max**(gauge) | Writer Max flush size (size) | | **eventstore.es.writer.flush\_delay\_ms.max**(gauge) | Writer Max flush delay (ms) | | **eventstore.es.writer.queued\_flush\_messages**(gauge) | Writer Queued Flush Messages | | **eventstore.es.read\_index.cached\_record**(gauge) | Read Index Cached Record | | **eventstore.es.read\_index.not\_cached\_record**(gauge) | Read Index Not Cached Record | | **eventstore.es.read\_index.cached\_stream\_info**(gauge) | Read Index Cached Stream Info | | **eventstore.es.read\_index.not\_cached\_stream\_info**(gauge) | Read Index Not Cached Stream Info | | **eventstore.es.read\_index.cached\_trans\_info**(gauge) | Read Index Cached Trans Info | | **eventstore.es.read\_index.not\_cached\_trans\_info**(gauge) | Read Index Not Cached Trans Info | | **eventstore.is\_leader**(gauge) | Cluster Node is a Leader | | **eventstore.is\_follower**(gauge) | Cluster Node is a Follower | | **eventstore.is\_readonlyreplica**(gauge) | Cluster Node is a Read Only Replica | | **eventstore.running\_projections.none**(gauge) | Node does not run Projections | | **eventstore.running\_projections.system**(gauge) | Node runs System Projections | | **eventstore.running\_projections.all**(gauge) | Node runs all kinds of Projections | | **eventstore.projection.core\_processing\_time**(gauge) | Projection Core Processing Time | | **eventstore.projection.version**(gauge) | Projection Version | | **eventstore.projection.epoch**(gauge) | Projection Epoch | | **eventstore.projection.reads\_in\_progress**(gauge) | Projection Reads in Progress | | **eventstore.projection.writes\_in\_progress**(gauge) | Projection Writes in Progress | | **eventstore.projection.partitions\_cached**(gauge) | Projection Partitions Cached | | **eventstore.projection.running**(gauge) | Projection is Running | | **eventstore.projection.progress**(gauge) | Projection Progress | | **eventstore.projection.events\_processed\_after\_restart**(gauge) | Projection Events Processed after Restart | | **eventstore.projection.buffered\_events**(gauge) | Projection Events Buffered | | **eventstore.projection.write\_pending\_events\_before\_checkpoint**(gauge) | Projection Write Pending Events before Checkpoint | | **eventstore.projection.write\_pending\_events\_after\_checkpoint**(gauge) | Projection Write Pending Events after Checkpoint | | **eventstore.subscription.live**(gauge) | Subscription is Live | | **eventstore.subscription.average\_items\_per\_second**(gauge) | Subscription Average Items per Second | | **eventstore.subscription.items\_processed**(gauge) | Subscription Items Processed | | **eventstore.subscription.last\_processed\_event\_number**(gauge) | Subscription Last Processed Event Number | | **eventstore.subscription.last\_known\_event\_number**(gauge) | Subscription Last Known Event Number | | **eventstore.subscription.connections**(gauge) | Subscription Connections | | **eventstore.subscription.messages\_in\_flight**(gauge) | Subscription Messages in Flight | | **eventstore.cluster.member\_alive**(gauge) | Cluster Member is Alive | | **eventstore.cluster.last\_commit\_position**(gauge) | Cluster Member Last Commit Position | | **eventstore.cluster.writer\_checkpoint**(gauge) | Cluster Member Writer Checkpoint | | **eventstore.cluster.chaser\_checkpoint**(gauge) | Cluster Member Chaser Checkpoint | | **eventstore.cluster.epoch\_position**(gauge) | Cluster Member Epoch Position | | **eventstore.cluster.epoch\_number**(gauge) | Cluster Member Epoch Number | | **eventstore.cluster.node\_priority**(gauge) | Cluster Member Node Priority | ### Events{% #events %} The eventstore check does not include any events. ### Service Checks{% #service-checks %} The eventstore check does not include any service checks. ## Troubleshooting{% #troubleshooting %} Need help? Contact the [maintainer](https://github.com/DataDog/integrations-extras/blob/master/eventstore/manifest.json) of this integration.