Skip to content

Commit 9588fd7

Browse files
authored
docs: add metrics references for operators (#1913)
1 parent 14f831f commit 9588fd7

File tree

2 files changed

+68
-28
lines changed

2 files changed

+68
-28
lines changed

docs/operator_guides/0_running_an_operator.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,15 @@ Then you must register as an Operator on AlignedLayer. To do this, you must run:
153153
154154
- Mainnet:
155155
156-
```bash
157-
make operator_register_with_aligned_layer CONFIG_FILE=./config-files/config-operator-mainnet.yaml
158-
```
156+
```bash
157+
make operator_register_with_aligned_layer CONFIG_FILE=./config-files/config-operator-mainnet.yaml
158+
```
159159

160160
- Holesky:
161161

162-
```bash
163-
make operator_register_with_aligned_layer CONFIG_FILE=./config-files/config-operator-holesky.yaml
164-
```
162+
```bash
163+
make operator_register_with_aligned_layer CONFIG_FILE=./config-files/config-operator-holesky.yaml
164+
```
165165

166166
{% hint style="danger" %}
167167
If you are going to run the server in this machine,
@@ -172,15 +172,15 @@ delete the operator key
172172

173173
- Mainnet:
174174

175-
```bash
176-
./operator/build/aligned-operator start --config ./config-files/config-operator-mainnet.yaml
177-
```
175+
```bash
176+
./operator/build/aligned-operator start --config ./config-files/config-operator-mainnet.yaml
177+
```
178178

179179
- Holesky:
180180

181-
```bash
182-
./operator/build/aligned-operator start --config ./config-files/config-operator-holesky.yaml
183-
```
181+
```bash
182+
./operator/build/aligned-operator start --config ./config-files/config-operator-holesky.yaml
183+
```
184184

185185
### Run Operator using Systemd
186186

@@ -242,21 +242,39 @@ Once you are running your operator using systemd, you can get its logs using jou
242242
journalctl -xfeu aligned-operator.service
243243
```
244244

245+
## Operator Metrics
246+
247+
Metrics are exposed by default at `localhost:9092/metrics` in Prometheus format. To change the endpoint, update the following line in the configuration file:
248+
249+
```yaml
250+
metrics_ip_port_address: localhost:9092
251+
```
252+
253+
Example of exposed metrics:
254+
255+
```yaml
256+
# HELP aligned_operator_responses_count Number of proof verified by the operator and sent to the Aligned Service Manager
257+
# TYPE aligned_operator_responses_count counter
258+
aligned_operator_responses_count x
259+
```
260+
261+
You can scrape these metrics using Prometheus and visualize them in Grafana or configure alerts based on the data.
262+
245263
## Unregistering the operator
246264

247265
To unregister the Aligned operator, run:
248266

249267
- Mainnet:
250268

251-
```bash
252-
cast send --rpc-url https://ethereum-rpc.publicnode.com --private-key <private_key> 0xA8CC0749b4409c3c47012323E625aEcBA92f64b9 'deregisterOperator(bytes)' 0x00
253-
```
269+
```bash
270+
cast send --rpc-url https://ethereum-rpc.publicnode.com --private-key <private_key> 0xA8CC0749b4409c3c47012323E625aEcBA92f64b9 'deregisterOperator(bytes)' 0x00
271+
```
254272

255273
- Holesky:
256274

257-
```bash
258-
cast send --rpc-url https://ethereum-holesky-rpc.publicnode.com --private-key <private_key> 0x3aD77134c986193c9ef98e55e800B71e72835b62 'deregisterOperator(bytes)' 0x00
259-
```
275+
```bash
276+
cast send --rpc-url https://ethereum-holesky-rpc.publicnode.com --private-key <private_key> 0x3aD77134c986193c9ef98e55e800B71e72835b62 'deregisterOperator(bytes)' 0x00
277+
```
260278

261279
`<private_key>` is the one specified in the output when generating your keys with the EigenLayer CLI.
262280

docs/operator_guides/1_operator_FAQ.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,24 @@ You can check the latest version available on the [releases' page](https://githu
4343

4444
You can get the registered version of your operator by running the following command:
4545

46-
```bash
47-
curl https://holesky.tracker.alignedlayer.com/versions/<operator_address>
48-
```
46+
- Mainnet:
47+
48+
```bash
49+
curl https://mainnet.telemetry.alignedlayer.com/versions/<operator_address>
50+
```
51+
52+
- Holesky:
53+
54+
```bash
55+
curl https://holesky.telemetry.alignedlayer.com/versions/<operator_address>
56+
```
4957

5058
Replace `<operator_address>` with your operator address.
5159

52-
In future releases, the explorer will show the operator version and the latest available version.
60+
Also, you can check the operator version in the Explorer:
61+
62+
- [Mainnet Operators Explorer](https://explorer.alignedlayer.com/operators)
63+
- [Holesky Operators Explorer](https://holesky.explorer.alignedlayer.com/operators)
5364

5465
### How do I check the operator version locally?
5566

@@ -67,12 +78,23 @@ This will show the version of the operator you have built in your filesystem.
6778

6879
You can get the ID of the operator by running the following command:
6980

70-
```bash
71-
cast call \
72-
--rpc-url https://ethereum-holesky-rpc.publicnode.com \
73-
0xD0A725d82649f9e4155D7A60B638Fe33b3F25e3b \
74-
"getOperatorId(address operator)(bytes32)" <operator_address>
75-
```
81+
- Mainnet:
82+
83+
```bash
84+
cast call \
85+
--rpc-url https://ethereum-rpc.publicnode.com \
86+
0x3CcfB7e6e8fe2A8d941a8Ce4C69A944a770E8228 \
87+
"getOperatorId(address operator)(bytes32)" <operator_address>
88+
```
89+
90+
- Holesky
91+
92+
```bash
93+
cast call \
94+
--rpc-url https://ethereum-holesky-rpc.publicnode.com \
95+
0xD0A725d82649f9e4155D7A60B638Fe33b3F25e3b \
96+
"getOperatorId(address operator)(bytes32)" <operator_address>
97+
```
7698

7799
> Note: You need to have installed [Foundry](https://book.getfoundry.sh/)
78100

0 commit comments

Comments
 (0)