Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Examples

The repository includes example Grafana dashboards and a local demo environment.

Demo Stack

Start Prometheus, node-exporter, and mock vLLM metrics:

cd examples/demo
docker-compose up -d

Run Grafatui from the repository root:

cargo run -- --grafana-json examples/dashboards/prometheus_demo.json --prometheus-url http://localhost:19090

Stop the demo:

cd examples/demo
docker-compose down -v

Included Dashboards

  • examples/dashboards/prometheus_demo.json: recommended first demo for the bundled Prometheus stack.

  • examples/dashboards/all_visualizations.json: compact dashboard showing the supported visualization types, including timeseries bars, area fill, point mode, and hidden-axis examples.

  • examples/dashboards/instant_queries.json: demonstrates explicit instant targets and the default instant behavior for summary panels.

  • examples/dashboards/thresholds_demo.json: demonstrates thresholds, field bounds, and threshold marker rendering.

  • examples/dashboards/grafana_v2_compatibility.json: exact Grafana V2 resource with a GridLayout, a dynamic Prometheus job variable, refresh settings, and two supported panels. Run it with:

    cargo run -- --grafana-json examples/dashboards/grafana_v2_compatibility.json --prometheus-url http://localhost:19090
    
  • examples/demo/vllm/grafana.json: vLLM-oriented dashboard for the mock demo services.

More Detail

See the repository example docs: