--- title: Eventstore description: Collects Eventstore Metrics breadcrumbs: Docs > Integrations > Eventstore --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Eventstore Supported OS Integration version2.1.0 {% callout %} # Important note for users on the following Datadog sites: us2.ddog-gov.com {% alert level="info" %} To find out if this integration is available in your organization, see your [Datadog Integrations](https://app.datadoghq.com/integrations) page or ask your organization administrator. To initiate an exception request to enable this integration for your organization, email [support@ddog-gov.com](mailto:support@ddog-gov.com). {% /alert %} {% /callout %} ## 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.