panda-pulse

module
v0.0.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 10, 2025 License: GPL-3.0

README

panda-pulse 🐼

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. The checks themselves are rather specific to the custom Prometheus metrics ethPandaOps has setup, so your mileage may vary as a public user.

Usage

Pulse Check

Run by passing in a network name, a discord channel ID and one of --ethereum-cl or --ethereum-el.

docker run -e GRAFANA_SERVICE_TOKEN=your_token \
          -e DISCORD_BOT_TOKEN=your_token \
          -e OPENROUTER_API_KEY=optional_key \
          ethpandaops/panda-pulse:latest \
          --discord-channel CHANNEL_ID \
          --network NETWORK_NAME \
          --ethereum-cl CLIENT_NAME
Configuration
Environment Variables
  • GRAFANA_SERVICE_TOKEN (required): Grafana service account token
  • DISCORD_BOT_TOKEN (required): Discord bot token for notifications
  • OPENROUTER_API_KEY (optional): OpenRouter API key for AI analysis
Command Line Arguments
  • --network (required): Network to monitor (e.g., pectra-devnet-5)
  • --discord-channel (required): Discord channel ID for notifications
  • --ethereum-cl: Filter for specific consensus client
  • --ethereum-el: Filter for specific execution client
  • --grafana-base-url: Grafana base URL
  • --prometheus-datasource-id: Prometheus datasource ID

Directories

Path Synopsis
pkg
grafana/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL