Usage

A monitoring tool for Ethereum networks that checks node health and reports issues to Discord. The checks are run against a Grafana instance, which is configured with a Prometheus datasource. It can be found here.

Commands

Register alerts for a new devnet

• Setup a new discord channel, under the bots category in the EthR&D Guild.
• Run the /checks register {network} {channel} {optional:client} {optional:schedule} command to register the alerts for all clients on the new devnet.
• If you do not provide a client, all clients will be registered for alerts.
• If you do not provide a schedule, it will default to 7am UTC.

Note:

• The channel in which alerts are registered must be a text channel and must be under the bots category.

Deregister alerts for a devnet

• Run the /checks deregister {network} command to deregister the alerts for all clients on the network.
• If you wish, you can also deregister alerts for a specific client on the network by running the /checks deregister {network} {client} command.

List all registered alerts

• Run the /checks list command to list all clients and networks for which alerts are registered.

Run a check manually

• Run the /checks run {network} {client} command to run a check manually for a client on a network.

Debug an alert

• Run the /checks debug {id} command to debug an alert.

---

Enable mentions for a network/client

• Run the /mentions enable {network} {client} command to enable mentions for a network/client.

Note:

• By default, mentions are disbaled for all clients/networks.
• Even if mentions are enabled, users/roles need to be configured (See 'Add mentions for a specific network/client/user')
• Users/roles configured for mentions will be tagged in every alert for the network/client.

Disable mentions for a network/client

• Run the /mentions disable {network} {client} command to disable mentions for a network/client.

Add mentions for a specific network/client/user

• Run the /mentions add {network} {client} {user|role} command to add a mention for a specific network/client/user.

Remove mentions for a specific network/client/user

• Run the /mentions remove {network} {client} {user|role} command to remove a mention for a specific network/client/user.

List all mentions configuredfor a network/client

• Run the /mentions list {network} {client} command to list all mentions for a network/client.

---

Register Hive summary for a new devnet

• Setup a new discord channel, under the bots category in the EthR&D Guild.
• Run the /hive register {network} {channel} {optional:schedule} command to register the hive summary for the new devnet.
• If you do not provide a schedule, it will default to 7am UTC.

Note:

• The channel in which alerts are registered must be a text channel.

Deregister alerts for a devnet

• Run the /hive deregister {network} command to deregister the hive summary for a network.

List all registered hive summaries

• Run the /hive list command to list all networks for which hive summaries are registered.

Run a hive summary manually

• Run the /hive run {network} command to run a manual hive summary.

Permissions

Permissions are built in by default and are based around the EthR&D guild roles.

• mod - Has access to all commands.
• admin - Has access to all commands.
• ef - Has access to all commands.

Users assigned a client team role can only interact with the commands for the clients they are responsible for.

For example, a user assigned the prysmatic role can only interact with the commands for the prysm client.