as_metrics_policy Struct Reference

Detailed Description

Client periodic metrics configuration.

Definition at line 82 of file as_metrics.h.

#include "as_metrics.h"

Collaboration diagram for as_metrics_policy:

Data Fields
uint32_t	interval
uint32_t	latency_columns
uint32_t	latency_shift
as_metrics_listeners	metrics_listeners
char	report_dir [256]
uint64_t	report_size_limit

Field Documentation

interval

uint32_t as_metrics_policy::interval

Number of cluster tend iterations between metrics notification events. One tend iteration is defined as as_config.tender_interval (default 1 second) plus the time to tend all nodes.

Default: 30

Definition at line 118 of file as_metrics.h.

latency_columns

uint32_t as_metrics_policy::latency_columns

Number of elapsed time range buckets in latency histograms.

Default: 7

Definition at line 125 of file as_metrics.h.

latency_shift

uint32_t as_metrics_policy::latency_shift

Power of 2 multiple between each range bucket in latency histograms starting at column 3. The bucket units are in milliseconds. The first 2 buckets are "<=1ms" and ">1ms". Examples:

// latencyColumns=7 latencyShift=1
<=1ms >1ms >2ms >4ms >8ms >16ms >32ms
 
// latencyColumns=5 latencyShift=3
<=1ms >1ms >8ms >64ms >512ms

Default: 1

Definition at line 141 of file as_metrics.h.

metrics_listeners

as_metrics_listeners as_metrics_policy::metrics_listeners

Listeners that handles metrics notification events. The default listener implementation writes the metrics snapshot to a file which will later be read and forwarded to OpenTelemetry by a separate offline application.

The listener could be overridden to send the metrics snapshot directly to OpenTelemetry.

Definition at line 90 of file as_metrics.h.

report_dir

char as_metrics_policy::report_dir[256]

Directory path to write metrics log files for listeners that write logs.

Default: . (current directory)

Definition at line 97 of file as_metrics.h.

report_size_limit

uint64_t as_metrics_policy::report_size_limit

Metrics file size soft limit in bytes for listeners that write logs.

When report_size_limit is reached or exceeded, the current metrics file is closed and a new metrics file is created with a new timestamp. If report_size_limit is zero, the metrics file size is unbounded and the file will only be closed when aerospike_disable_metrics() or aerospike_close() is called.

Default: 0

Definition at line 109 of file as_metrics.h.

---

The documentation for this struct was generated from the following file:

• as_metrics.h