9e57b7d320
* Check docs spelling * Add config * Fix docs spelling * Lint docs format * docs(flamegraph): remove note about script that was removed * sort wordlist * Set sort algo * Fix CI pipeline * hope to fix CI ordering * Disable wordlist sort check * docs(CONTRIBUTING): remove merge conflict marker and add codeblock types * refactor: change to pyspelling.yml for local runs * docs: make spell-checking wordlist case insensitive * fix: sort .wordlist.txt * refactor: alphabetize script order * fix: add docs/reference to gitignore * docs: add codeblocks to pyspelling ignore and clear all errors * docs: ignore possessive endings in spellcheck * docs: clear spelling errors in package readmes * docs: pyspelling fix generated cli.md * feat(workflows): lint generated docs * feat(workflows): add word sort to docs-check * test: unsort wordlist * fix: sort wordlist * refactor(workflow): remove unused comments --------- Co-authored-by: matthewkeil <me@matthewkeil.com> Co-authored-by: Cayman <caymannava@gmail.com>
2.4 KiB
Client monitoring
Lodestar has the ability to send client stats to a remote service for collection. At the moment, the main service offering remote monitoring is beaconcha.in.
Instructions for setting up client monitoring with beaconcha.in can be found in their docs about Mobile App <> Node Monitoring and in your account settings.
Configuration
Lodestar provides CLI options to configure monitoring on both the beacon node and validator client.
Remote endpoint URL
Client monitoring can be enabled by setting the --monitoring.endpoint flag to a remote service endpoint URL.
lodestar beacon --monitoring.endpoint "https://beaconcha.in/api/v1/client/metrics?apikey={apikey}&machine={machineName}"
In case of beaconcha.in, the API key can be found in your account settings. Setting the machine is optional but it is especially useful if you are monitoring multiple nodes.
!!! note When sending data to a remote service you should be conscious about security:
- Only use a service that you trust as this will send information which may identify you
and associate your validators, IP address and other personal information.
- Always use a HTTPS connection (i.e. a URL starting with `https://`) to prevent the traffic
from being intercepted in transit and leaking information.
More details about the data sent to the remote service can be found in the specification.
It is also possible to print out the data sent to the remote service by enabling debug logs which can be done by supplying the --logLevel debug flag.
Monitoring interval
It is possible to adjust the interval between sending client stats to the remote service by setting the --monitoring.interval flag.
It takes an integer value in milliseconds, the default is 60000 which means data is sent once a minute.
For example, setting an interval of 300000 would mean the data is only sent every 5 minutes.
lodestar beacon --monitoring.interval 300000
Increasing the monitoring interval can be useful if you are running into rate limit errors when posting large amounts of data for multiple nodes.