|
| 1 | +# Monitoring Dashboards |
| 2 | + |
| 3 | +This directory contains monitoring dashboard configurations for vLLM, providing |
| 4 | +comprehensive observability for your vLLM deployments. |
| 5 | + |
| 6 | +## Dashboard Platforms |
| 7 | + |
| 8 | +We provide dashboards for two popular observability platforms: |
| 9 | + |
| 10 | +- **[Grafana](https://grafana.com)** |
| 11 | +- **[Perses](https://perses.dev)** |
| 12 | + |
| 13 | +## Dashboard Format Approach |
| 14 | + |
| 15 | +All dashboards are provided in **native formats** that work across different |
| 16 | +deployment methods: |
| 17 | + |
| 18 | +### Grafana (JSON) |
| 19 | + |
| 20 | +- ✅ Works with any Grafana instance (cloud, self-hosted, Docker) |
| 21 | +- ✅ Direct import via Grafana UI or API |
| 22 | +- ✅ Can be wrapped in Kubernetes operators when needed |
| 23 | +- ✅ No vendor lock-in or deployment dependencies |
| 24 | + |
| 25 | +### Perses (YAML) |
| 26 | + |
| 27 | +- ✅ Works with standalone Perses instances |
| 28 | +- ✅ Compatible with Perses API and CLI |
| 29 | +- ✅ Supports Dashboard-as-Code workflows |
| 30 | +- ✅ Can be wrapped in Kubernetes operators when needed |
| 31 | + |
| 32 | +## Dashboard Contents |
| 33 | + |
| 34 | +Both platforms provide equivalent monitoring capabilities: |
| 35 | + |
| 36 | +| Dashboard | Description | |
| 37 | +|-----------|-------------| |
| 38 | +| **Performance Statistics** | Tracks latency, throughput, and performance metrics | |
| 39 | +| **Query Statistics** | Monitors request volume, query performance, and KPIs | |
| 40 | + |
| 41 | +## Quick Start |
| 42 | + |
| 43 | +First, navigate to this example's directory: |
| 44 | + |
| 45 | +```bash |
| 46 | +cd examples/online_serving/dashboards |
| 47 | +``` |
| 48 | + |
| 49 | +### Grafana |
| 50 | + |
| 51 | +Import the JSON directly into the Grafana UI, or use the API: |
| 52 | + |
| 53 | +```bash |
| 54 | +curl -X POST http://grafana/api/dashboards/db \ |
| 55 | + -H "Content-Type: application/json" \ |
| 56 | + -d @grafana/performance_statistics.json |
| 57 | +``` |
| 58 | + |
| 59 | +### Perses |
| 60 | + |
| 61 | +Import via the Perses CLI: |
| 62 | + |
| 63 | +```bash |
| 64 | +percli apply -f perses/performance_statistics.yaml |
| 65 | +``` |
| 66 | + |
| 67 | +## Requirements |
| 68 | + |
| 69 | +- **Prometheus** metrics from your vLLM deployment |
| 70 | +- **Data source** configured in your monitoring platform |
| 71 | +- **vLLM metrics** enabled and accessible |
| 72 | + |
| 73 | +## Platform-Specific Documentation |
| 74 | + |
| 75 | +For detailed deployment instructions and platform-specific options, see: |
| 76 | + |
| 77 | +- **[Grafana Documentation](./grafana)** - JSON dashboards, operator usage, manual import |
| 78 | +- **[Perses Documentation](./perses)** - YAML specs, CLI usage, operator wrapping |
| 79 | + |
| 80 | +## Contributing |
| 81 | + |
| 82 | +When adding new dashboards, please: |
| 83 | + |
| 84 | +1. Provide native formats (JSON for Grafana, YAML specs for Perses) |
| 85 | +2. Update platform-specific README files |
| 86 | +3. Ensure dashboards work across deployment methods |
| 87 | +4. Test with the latest platform versions |
0 commit comments