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
    proxy: null
    default_namespace: eventstoredb

default_namespace

optional string literal
The namespace used otherwise will be defaulted to eventstoredb.
Examples
"app-123-eventstoredb"
default: eventstoredb

endpoints

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

proxy

optional object
Configures an HTTP(S) proxy for Vector to use. By default, the globally configured proxy is used.

proxy.enabled

optional bool
If false the proxy will be disabled.
default: true

proxy.http

optional string literal
The URL to proxy HTTP requests through.
Examples
"http://foo.bar:3128"

proxy.https

optional string literal
The URL to proxy HTTPS requests through.
Examples
"http://foo.bar:3128"

proxy.no_proxy

optional [string]

A list of hosts to avoid proxying. Allowed patterns here include:

PatternExample match
Domain namesexample.com matches requests to example.com
Wildcard domains.example.com matches requests to example.com and its subdomains
IP addresses127.0.0.1 matches requests to 127.0.0.1
CIDR blocks192.168.0.0./16 matches requests to any IP addresses in this range
Splat* matches all hosts

scrape_interval_secs

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

Environment variables

HTTPS_PROXY

common optional string literal

The global URL to proxy HTTPS requests through.

If another HTTPS proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples
http://foo.bar:3128

HTTP_PROXY

common optional string literal

The global URL to proxy HTTP requests through.

If another HTTP proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples
http://foo.bar:3128

NO_PROXY

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

PatternExample match
Domain namesexample.com matches requests to example.com
Wildcard domains.example.come matches requests to example.com and its subdomains
IP addresses127.0.0.1 matches requests to 127.0.0.1
CIDR blocks192.168.0.0./16 matches requests to any IP addresses in this range
Splat* matches all hosts

If another no_proxy value is set in the configuration file or at a component level, this one is overridden.

The lowercase variant has priority over the uppercase one.

Examples
localhost,.example.com,192.168.0.0./16
*

http_proxy

common optional string literal

The global URL to proxy HTTP requests through.

If another HTTP proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples
http://foo.bar:3128

https_proxy

common optional string literal

The global URL to proxy HTTPS requests through.

If another HTTPS proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples
http://foo.bar:3128

no_proxy

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

PatternExample match
Domain namesexample.com matches requests to example.com
Wildcard domains.example.come matches requests to example.com and its subdomains
IP addresses127.0.0.1 matches requests to 127.0.0.1
CIDR blocks192.168.0.0./16 matches requests to any IP addresses in this range
Splat* matches all hosts

If another no_proxy value is set in the configuration file or at a component level, this one is overridden.

The lowercase variant has priority over the uppercase one.

Examples
localhost,.example.com,192.168.0.0./16
*

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

component_received_events_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
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.
host required
The hostname of the system Vector is running on.
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.
pid required
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

component_sent_event_bytes_total

counter
The total number of event bytes emitted by this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

component_sent_events_total

counter
The total number of events emitted by this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

events_in_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins. This metric is deprecated and will be removed in a future version. Use component_received_events_total instead.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
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.
host required
The hostname of the system Vector is running on.
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.
pid required
The process ID of the Vector instance.
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. This metric is deprecated and will be removed in a future version. Use component_sent_events_total instead.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

http_request_errors_total

counter
The total number of HTTP request errors for this component.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

parse_errors_total

counter
The total number of errors parsing metrics for this component.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

processed_bytes_total

counter
The number of bytes processed by the component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
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.
host required
The hostname of the system Vector is running on.
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.
pid required
The process ID of the Vector instance.
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.