diff --git a/docs/hosting-a-node.md b/docs/hosting-a-node.md index d137c78f5..ac9e8fa73 100644 --- a/docs/hosting-a-node.md +++ b/docs/hosting-a-node.md @@ -12,7 +12,7 @@ requirements may change as the network evolves._ - [Full Archive Node](#full-archive-node) - [Full Node](#full-node) - [Full Node without Logs](#full-node-without-logs) -- [Telemetry](#telemetry) +- [Metrics](#metrics) --- @@ -96,12 +96,12 @@ bin/thor --network main --skip-logs _As of 22nd April 2024, a full node without logs uses **~100 GB** of disk space._ -### Telemetry +### Metrics Telemetry plays a critical role in monitoring and managing blockchain nodes efficiently. -Below is an overview of how telemetry is integrated and utilized within our node systems. +Below is an overview of how metrics is integrated and utilized within our node systems. -Telemetry is enabled in nodes by default. It's possible to disable it by setting `--telemetry-enabled=false`. +Metrics is enabled in nodes by default. It's possible to disable it by setting `--enable-metrics=false`. By default, a [prometheus](https://prometheus.io/docs/introduction/overview/) server is available at `localhost:2112/metrics` with the metrics. ```shell diff --git a/docs/usage.md b/docs/usage.md index ef102cbe1..92cb768d0 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -178,6 +178,7 @@ bin/thor -h | `--cache` | Megabytes of RAM allocated to trie nodes cache (default: 4096) | | `--disable-pruner` | Disable state pruner to keep all history | | `--bootnode` | Comma-separated list of bootnode IDs | +| `--enable-metrics` | Enables the metrics server | | `--help, -h` | Show help | | `--version, -v` | Print the version | @@ -185,7 +186,7 @@ bin/thor -h | Flag | Description | |------------------------------|----------------------------------------------------| -| `--genesis` | Path to genesis file(default: builtin devnet) | +| `--genesis` | Path to genesis file(default: builtin devnet) | | `--on-demand` | Create new block when there is pending transaction | | `--persist` | Save blockchain data to disk(default to memory) | | `--gas-limit` | Gas limit for each block |