NETSoon

Docs Run a node

Telemetry

What acrux-node reports while it runs and when it stops. Prometheus metrics, health, JSON logs, the event stream and the run report.

A running node reports on four surfaces: Prometheus metrics and health on the metrics port, JSON logs, the full protocol event stream, and a run report when it stops.

Metrics

GET http://127.0.0.1:4989/metrics serves the Prometheus text format, version 0.0.4.

MetricTypeMeaning
acrux_slots_totalcounterslots started
acrux_finalized_cblocks_totalcountercblocks finalized
acrux_skips_totalcountercblocks skipped
acrux_commit_spread_microsecondsgaugeaverage spread from first to last commitment of a slot, µs
prometheus.yml
scrape_configs:
  - job_name: acrux
    static_configs:
      - targets: ['127.0.0.1:4989']

The same counters, with the net's status, come from getCounters and the net.counters event.

Health

GET /health on the metrics port, and on the gateway port, returns:

FieldMeaning
statusready once a window is producing; waiting before
contractVersionthe @acrux/contract version the gateway speaks
missingConfigurationsettings the node needs and lacks; empty when complete

Logs

The node logs structured JSON, one object per line, through tracing. RUST_LOG sets the filter, warn by default (Configuration).

The event stream

Everything the node does in a slot is an event on ws://127.0.0.1:4931: each slice, commitment and arrival, attestation, the agreed set, the merge, the four-track schedule, execution, every vote and certificate. An event one node emitted carries that node's identity in node. Event stream

The run report

On stop the node writes last-run.json and profile.json into its store and prints a summary line. Stop and the report

Figures from Acrux Net

The figures measured on Acrux Net, slot pacing, commit spread, handovers per hub link and cblock finalization, are on Parameters, live from GET /v1/facts.