Skip to content

Commit db5ae6b

Browse files
authored
Merge pull request #6250 from oasisprotocol/amela/fix/node-metrics-docs
docs/oasis-node: Fix Configuring in Pull Mode
2 parents 68fff91 + 233fdd1 commit db5ae6b

3 files changed

Lines changed: 18 additions & 6 deletions

File tree

.changelog/6250.doc.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
docs/oasis-node: Fix Configuring in Pull Mode
2+
3+
Updated instructions for configuring oasis-node in pull mode and added
4+
instructions for how to enable Prometheus metrics.

docs/oasis-node/metrics.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,17 @@ reporting:
1313

1414
## Configuring `oasis-node` in Pull Mode
1515

16-
To run `oasis-node` in *pull mode* set flag `--metrics.mode pull` and provide
17-
the listen address with `--metrics.address`. For example
16+
To run `oasis-node` in *pull mode* with Prometheus metrics enabled, add the
17+
following to your `config.yml`.
1818

1919
```
20-
oasis-node --metrics.mode pull --metrics.address localhost:3000
20+
metrics:
21+
mode: pull
22+
address: 0.0.0.0:3000
2123
```
2224

25+
After restarting the node, Prometheus metrics will be exposed on port 3000.
26+
2327
Then, add the following segment to your `prometheus.yml` and restart
2428
Prometheus:
2529

docs/oasis-node/metrics.md.tpl

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ reporting:
99

1010
## Configuring `oasis-node` in Pull Mode
1111

12-
To run `oasis-node` in *pull mode* set flag `--metrics.mode pull` and provide
13-
the listen address with `--metrics.address`. For example
12+
To run `oasis-node` in *pull mode* with Prometheus metrics enabled, add the
13+
following to your `config.yml`.
1414

1515
```
16-
oasis-node --metrics.mode pull --metrics.address localhost:3000
16+
metrics:
17+
mode: pull
18+
address: 0.0.0.0:3000
1719
```
1820

21+
After restarting the node, Prometheus metrics will be exposed on port 3000.
22+
1923
Then, add the following segment to your `prometheus.yml` and restart
2024
Prometheus:
2125

0 commit comments

Comments
 (0)