EventStoreDB metrics

Receive metrics from collected by a EventStoreDB

status: beta role: daemon role: sidecar delivery: at-least-once egress: batch state: stateless output: metrics

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "eventstoredb_metrics",
      "endpoints": "https://localhost:2113/stats",
      "scrape_interval_secs": 15
    }
  }
}
[sources.my_source_id]
type = "eventstoredb_metrics"
endpoints = "https://localhost:2113/stats"
scrape_interval_secs = 15
---
sources:
  my_source_id:
    type: eventstoredb_metrics
    endpoints: https://localhost:2113/stats
    scrape_interval_secs: 15
{
  "sources": {
    "my_source_id": {
      "type": "eventstoredb_metrics",
      "endpoints": "https://localhost:2113/stats",
      "scrape_interval_secs": 15,
      "default_namespace": "eventstoredb"
    }
  }
}
[sources.my_source_id]
type = "eventstoredb_metrics"
endpoints = "https://localhost:2113/stats"
scrape_interval_secs = 15
default_namespace = "eventstoredb"
---
sources:
  my_source_id:
    type: eventstoredb_metrics
    endpoints: https://localhost:2113/stats
    scrape_interval_secs: 15
    default_namespace: eventstoredb

default_namespace

optional string
The namespace used otherwise will be defaulted to eventstoredb.
default: eventstoredb

endpoints

common optional string
Endpoints to scrape stats from.
default: https://localhost:2113/stats

scrape_interval_secs

common optional uint
The interval between scrapes, in seconds.
default: 15 (seconds)

Output

Metrics

disk_free_bytes

gauge
The number of bytes free on disk.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

disk_read_bytes_total

counter
The accumulated number of bytes read in from disk.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

disk_read_ops_total

counter
The accumulated number of read IOPS.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

disk_total_bytes

gauge
The total number of bytes in disk.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

disk_used_bytes

gauge
The number of bytes used on disk.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

disk_write_ops_total

counter
The accumulated number of write IOPS.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

disk_written_bytes_total

counter
The accumulated number of bytes written out to disk.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

memory_free_bytes

gauge
The number of bytes of main memory not used.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

process_memory_used_bytes

gauge
The number of bytes of main memory used by the EventStoreDB node.
id required
The process id of the EventStoreDB node.
path optional
Location of the EventStoreDB node data directory.

Telemetry

Metrics

link

events_in_total

counter
The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the event originates.
peer_path optional
The pathname from which the event originates.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

http_request_errors_total

counter
The total number of HTTP request errors for this component.

parse_errors_total

counter
The total number of errors parsing metrics for this component.

processed_bytes_total

counter
The number of bytes processed by the component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the bytes originate.
file optional
The file from which the bytes originate.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the bytes originate.
peer_path optional
The pathname from which the bytes originate.
pod_name optional
The name of the pod from which the bytes originate.
uri optional
The sanitized URI from which the bytes originate.

How it works

Context

By default, the eventstoredb_metrics source augments events with helpful context keys.

State

This component is stateless, meaning its behavior is consistent across each input.