Telemetry

Operator Node monitoring through metrics exports.

Overview

Operators are required to run their nodes alongside a "sidecar" Docker container to export useful metrics about the node. These metrics are aggregated and are visible in a public Grafana dashboard.

Grafana API Key

Dashboard is live at Grafana.

• Please reach out through our channels to get your Grafana API key.
• Run the following command, replacing API_KEY with the provided one:

BASE_URL=https://fermah-releases.s3.us-east-2.amazonaws.com
SCRIPT=telemetry.sh
API_KEY=yourapikey

curl $BASE_URL/$SCRIPT | bash -s -- $API_KEY

OpenTelemetry

All Operators can enable and export metrics using OTL protocol through Grafana Alloy using a provided API key. Operators can customize their Grafana Alloy configuration to export to additional OpenTelemetry collectors.

Currently, the node exports the following:

• Logs
• Tracing Spans (Instrumentation)
• Metrics (e.g. Gauges, Counters)

Configuration

Please refer to the Grafana Alloy documentation when modifying the provided config.alloy file.

Additionally, there is a basic configuration that can be modified under:

~/.fermah/config/net/telemetry.otlp.json

Example configuration:

{
  "name": "otlp",
  "description": "OTLP telemetry with export capabilities.",
  "network": "dev",
  "type": "telemetry",
  "config": {
    "export": {
      "endpoint": "http://localhost:4317",
      "timeoutSecs": 3
    },
    "filter": "info"
  }
}