pinkdiamond1/xatu

Xatu

Ethereum network monitoring with collection clients and a centralized server for data pipelining.

Overview

Xatu can run in multiple modes. Each mode can be run independently. The following diagram shows the different modes and how they interact with each other and other services.

┌───────────┐
│ CONSENSUS │
│   CLIENT  │
└─────▲─────┘
      │
      │
  ┌───▼────┐ ┌──────────┐  ┌───────────┐
  │  XATU  │ │   XATU   │  │   XATU    │
  │ SENTRY │ │ MIMICRY  │  │ DISCOVERY │
  └───┬────┘ └─────┬────┘  └─────┬─────┘
      │            │             │
      │            │             │
      │       ┌────▼─────┐       │
      └───────►          ◄───────┘
              │   XATU   │
              │  SERVER  │    ┌─────────────┐
              │          ◄────► PERSISTENCE │
              │          │    └─────────────┘
              └─────┬────┘
                    │
                    │
                    ▼
              DATA PIPELINE

Modes

Follow the links for more information on each mode.

• Server - Centralized server collecting events from various clients and can output them to various sinks.
• Sentry - Client that runs along side a Ethereum consensus client and collects data via the consensus client's Beacon API. You must run your own consensus client and this projects sentry will connect to it via the consensus client's http server.
• Discovery - Client that uses the Node Discovery Protocol v5 to discovery nodes on the network.
• Mimicry - Client that collects data from the EL P2P network.

Getting Started

Download a release

Download the latest release from the Releases page. Extract and run with:

./xatu <server|sentry|discovery|mimicry> --config your-config.yaml

Docker

Available as a docker image at ethpandaops/xatu

Images

• latest - distroless, multiarch
• latest-debian - debian, multiarch
• $version - distroless, multiarch, pinned to a release (i.e. 0.4.0)
• $version-debian - debian, multiarch, pinned to a release (i.e. 0.4.0-debian)

Kubernetes via Helm

Read more

helm repo add ethereum-helm-charts https://ethpandaops.github.io/ethereum-helm-charts

helm install xatu ethereum-helm-charts/xatu -f your_values.yaml

Contributing

Contributions are greatly appreciated! Pull requests will be reviewed and merged promptly if you're interested in improving Xatu!

1. Fork the project
2. Create your feature branch:
   • git checkout -b feat/new-output
3. Commit your changes:
   • git commit -m 'feat(sentry): new output
4. Push to the branch: -git push origin feat/new-output
5. Open a pull request

Contact

Sam - @samcmau

Andrew - @savid