| 1 | # Perses Dashboards for vLLM Monitoring |
| 2 | |
| 3 | This directory contains Perses dashboard configurations designed to monitor vLLM |
| 4 | performance and metrics. |
| 5 | |
| 6 | ## Requirements |
| 7 | |
| 8 | - Perses instance (standalone or via operator) |
| 9 | - Prometheus data source configured in Perses |
| 10 | - vLLM deployment with Prometheus metrics enabled |
| 11 | |
| 12 | ## Dashboard Format |
| 13 | |
| 14 | We provide dashboards in the **native Perses YAML format** that works across all |
| 15 | deployment methods: |
| 16 | |
| 17 | - **Files**: `*.yaml` (native Perses dashboard specifications) |
| 18 | - **Format**: Pure dashboard specifications that work everywhere |
| 19 | - **Usage**: Works with standalone Perses, API imports, CLI, and file provisioning |
| 20 | - **Kubernetes**: Directly compatible with Perses Operator |
| 21 | |
| 22 | ## Dashboard Descriptions |
| 23 | |
| 24 | - **performance_statistics.yaml**: Performance metrics with aggregated latency |
| 25 | statistics |
| 26 | - **query_statistics.yaml**: Query performance and deployment metrics |
| 27 | |
| 28 | ## Deployment Options |
| 29 | |
| 30 | ### Direct Import to Perses |
| 31 | |
| 32 | Import the dashboard specifications via Perses API or CLI: |
| 33 | |
| 34 | ```bash |
| 35 | percli apply -f performance_statistics.yaml |
| 36 | ``` |
| 37 | |
| 38 | ### Perses Operator (Kubernetes) |
| 39 | |
| 40 | The native YAML format works directly with the Perses Operator: |
| 41 | |
| 42 | ```bash |
| 43 | kubectl apply -f performance_statistics.yaml -n <namespace> |
| 44 | ``` |
| 45 | |
| 46 | ### File Provisioning |
| 47 | |
| 48 | Place the YAML files in a Perses provisioning folder for automatic loading. |