Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
otherview committed May 21, 2024
1 parent ab333ae commit 0b16fb5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/hosting-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,15 @@ 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 |

#### Thor Solo Flags

| 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 |
Expand Down

0 comments on commit 0b16fb5

Please sign in to comment.