New announcements for Serverless, Network, RUM, and more from Dash! New announcements from Dash!

Eventstore

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

Get metrics from EventStore in real time to:

  • Visualize and monitor EventStore queues
  • Capture all available metrics within the stats API

Setup

Installation

If you are using Agent v6.8+ follow the instructions below to install the EventStore check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior to version 6.8 or the Docker Agent:

  1. Install the developer toolkit.
  2. Clone the integrations-extras repository:

    git clone https://github.com/DataDog/integrations-extras.git.
    
  3. Update your ddev config with the integrations-extras/ path:

    ddev config set extras ./integrations-extras
    
  4. To build the eventstore package, run:

    ddev -e release build eventstore
    
  5. Download and launch the Datadog Agent.

  6. Run the following command to install the integrations wheel with the Agent:

    datadog-agent integration install -w <PATH_OF_EVENTSTORE_ARTIFACT_>/<EVENTSTORE_ARTIFACT_NAME>.whl
    
  7. Configure your integration like any other packaged integration.

Configuration

  1. Edit the eventstore.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your EventStore metrics. See the sample eventstore.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for eventstore under the Checks section.

Compatibility

The check is compatible with all major platforms.

Data Collected

Metrics

eventstore.proc.mem
(gauge)
Current memory usage
shown as byte
eventstore.proc.cpu
(gauge)
Current CPU usage
eventstore.proc.cpu_scaled
(gauge)
Scaled 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.cpu
(gauge)
Cpu Cpu
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

Events

The eventstore check does not include any events.

Service Checks

The eventstore check does not include any service checks.

Troubleshooting

Need help? Contact the maintainer of this integration.


Mistake in the docs? Feel free to contribute!