Files
lodestar/mkdocs.yml
Nico Flaig e6eb3bd5c9 Support client monitoring by a remote service (e.g. beaconcha.in) (#5037)
* Initial client monitoring implementation

* Add monitoring to beacon node

* Add monitoring to validator

* Ensure that monitoring endpoint is a valid URL

* Improve validation of monitoring endpoint

* Improve error handling and timeout of remote server request

* Wait for pending request before sending next one

* Update request error handling

* Update monitoring endpoint parsing

* Export monitoring package

* Fix process cpu seconds total metric

Use "process_cpu_user_seconds_total" instead of "process_cpu_seconds_total"
as it properly reports the CPU usage of the process and more importantly
also triggers the collect method of the metric which ensures that always
the latest value is shown.

* Add option to collect system stats

* Define system stats

* Improve logs when monitoring service is started

* Use the term "remote service" instead of "remote server"

* Move Client type to service

* Add monitoring args to beacon node test

* Update description of monitoring cli args

* Update monitoring service

* Add metrics for collecting and sending data

* Add monitoring panels to VM + host dashboard

* Update send data metric buckets

* Print out machine when starting monitoring service

* Refactoring

* Add unit tests

* Add metric values for sync_eth1_connected and sync_eth1_fallback_configured

* Use setTimeout instead of sleep for initial delay

* Use milliseconds instead of seconds for time values

* Add description to client stats properties

* Remove sinon spies after tests are finished

* Document client monitoring usage

* Add enum to check status of monitoring service

* Reduce info log when monitoring service is started

Only print out information which is configurable by non-hidden CLI options and properly documented.
2023-02-16 11:56:17 -05:00

86 lines
2.4 KiB
YAML

site_name: Lodestar Documentation
site_description: Lodestar Documentation - Typescript Ethereum Consensus client
site_url: https://chainsafe.github.io/lodestar
repo_name: chainsafe/lodestar
repo_url: https://github.com/chainsafe/lodestar
# Configuration
theme:
name: material
logo: assets/lodestar_icon_300.png
favicon: assets/round-icon.ico
palette:
- scheme: preference
media: "(prefers-color-scheme: light)"
primary: black
accent: deep purple
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
media: "(prefers-color-scheme: dark)"
primary: black
accent: deep purple
toggle:
icon: material/weather-sunny
name: Switch to light mode
nav_style: dark
plugins:
- search
- mermaid2:
version: 8.6.4
arguments:
theme: |
^(window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'
markdown_extensions:
- meta
- codehilite:
guess_lang: false
- admonition
- toc:
permalink: true
- pymdownx.superfences:
# make exceptions to highlighting of code (for mermaid):
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
extra_css:
- stylesheets/extras.css
# Socials
extra:
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/ChainSafe/lodestar
- icon: fontawesome/brands/twitter
link: https://twitter.com/ChainSafeth
- icon: fontawesome/brands/discord
link: https://discord.gg/yjyvFRP
- icon: fontawesome/brands/medium
link: https://blog.chainsafe.io
# Customize left navigation menu
nav:
- Getting Started: index.md
- Installation:
- Install from source: install/source.md
- Install from NPM: install/npm.md
- Install with Docker: install/docker.md
- Using Lodestar:
- Beacon management: usage/beacon-management.md
- Local testnet: usage/local.md
- Validator management: usage/validator-management.md
- Prometheus & Grafana Setup: usage/prometheus-grafana.md
- MEV Builder Integration: usage/mev-integration.md
- Client monitoring: usage/client-monitoring.md
- Reference:
- Command line: reference/cli.md
- Libraries: libraries/index.md
- Design:
- Lodestar package structure: design/depgraph.md
- Contributing: contributing.md