Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

📊 Metrics & Telemetry


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
NodeExporterListenAddress:910000

Description:

Sets the specific address for publishing metrics.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableMetricReportingfalse00

Description:

Determines whether the metrics collection service is enabled for the node. When enabled, the node will collect performance and usage metrics from the specific instance of algod. Additionally, machine-wide metrics are also collected. This enables monitoring across all instances on the same machine, helping with performance analysis and troubleshooting.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
NodeExporterPath./node_exporter00

Description:

Specifies the path to the node_exporter binary, which exposes node metrics for monitoring and integration with systems like Prometheus. The node_exporter collects and exposes various performance and health metrics from the node.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableAssembleStatsEmpty string33

Description:

Specifies whether to emit the AssembleBlockMetrics telemetry event.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableProcessBlockStatsEmpty string33

Description:

Specifies whether to emit the ProcessBlockMetrics telemetry event.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
PeerConnectionsUpdateInterval360055

Description:

Defines the interval at which the peer connections’ information is sent to telemetry. Defined in seconds.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
HeartbeatUpdateInterval6002727

Description:

Defines the interval at which the heartbeat information is sent to the telemetry (when enabled). Defined in seconds. Minimum value is 60.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableRuntimeMetricsfalse2222

Description:

Exposes Go runtime metrics in /metrics and via node_exporter.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableNetDevMetricsfalse3434

Description:

Exposes network interface total bytes sent/received metrics in /metrics


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableAccountUpdatesStatsfalse1616

Description:

Specifies whether to emit the AccountUpdates telemetry event.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
AccountUpdatesStatsInterval50000000001616

Description:

Time interval in nanoseconds between accountUpdates telemetry events.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableUsageLogfalse3131

Description:

Enables 10Hz log of CPU and RAM usage. Also adds algod_ram_usage (number of bytes in use) to /metrics.