Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.17 KB

README.md

File metadata and controls

51 lines (38 loc) · 2.17 KB

Xatu Dashboard

Generate multiple visualizations with the most current data about blobs in the Ethereum Network, and view them inside a webpage!

This dashboard generator is made to bind with a Clickhouse instance connected to Xatu's server.

You can view our instance of these plots here.

There is a total of 10 plots, such as Average blob arrival time, Blob propagation by blob count and Average used blob size.

Preview

image

Generating a dashboard

Before running

The generator can be run with Docker Compose (as well as serving the dashboard) or by running the script directly.

Setting up the environment variables is necessary for the generation of the dashboards. For reference, please view /.env.example.

Note that only Clickhouse's native port is supported.

Script

Running the script directly will output the generated dashboards at plot-generator/generated/ as HTML files.

Install dependencies

$ pip install -r plot-generator/requirements.txt
$ pip install -U python-dotenv

Generate all dashboards

$ python3 plot-generator/main.py

Generate a specific plot

(See plot-generator/src/builder_functions.py for the list of plots).

The default name for the outputted dashboard in this mode is "testing.html". This template is not stylized.

To refer to a plot, use its position in the array. For example, to generate the first, second and third plots, run:

$ python3 plot-generator/main.py -t 1 2 3

Docker compose

$ docker compose build && docker compose up

This will build and run the generator and server containers, which will create the dashboard at the start of every hour (as configured in plot-generator/cron/jobs), and serve it at the port configured inside your .env respectively.

The endpoint where each dashboard is located is the name of itself. For instance, the "blob" (generated/blob.html) dashboard will be located at ip:port/blob.