The dashboard is designed to work with Tarantool + Prometheus + Grafana cluster.
The dashboard is designed to work with Tarantool metrics module (v0.9.0 or greater is recommended, while v0.8.0 is sufficient for complete experience). It is recommended to use metrics role (refer to cartridge.roles.metrics role page for instructions). Be sure to set alias for every Tarantool instance (e.g. by environment variable TARANTOOL_ALIAS) so metrics will be splitted and displayed correctly.
Cartridge must be configured to have a prometheus metrics endpoint for Prometheus (refer to cartridge.roles.metrics role page for instructions). For HTTP panels, HTTP routing middleware with summary collector must be enabled. (See more on HTTP middleware in metrics documentation and Cartridge role example.)
Metrics used in dashboard are based on Tarantool metrics module. Time series are grouped by alias parameter, so you can use this dashboard to monitor a cluster of Tarantool instances.
Dashboard contains the following sections:
- Cluster overview
- Tarantool HTTP statistics
- Tarantool network activity
- Tarantool memtx allocation overview
- Tarantool vinyl statistics
- Tarantool CPU statistics
- Tarantool memory miscellaneous
- Tarantool operations statistics
Contains several cluster overview panels, providing some aggregated info on cluster instances health, overall load and memory stats. Also contains panels on Cartridge issues count and replication lag.
Tarantool HTTP statistics
Overview of processed HTTP requests on Tarantool's side, grouped by method, path and response code. There are two lines of panels: one on rps and the other on 99th percentile of latency.
Tarantool network activity
Overview of instances network activity. Displays input and output data load, as well as network connections and requests stats.
Tarantool memtx allocation overview
Overview of Tarantool memtx memory allocation (tuples and indexes). Contains short instruction on memory allocation monitoring. You can read more about slab here.
Tarantool vinyl statistics
Overview of Tarantool vinyl memory and disk allocation, vinyl scheduler process and transaction statistics. You can read more about vinyl engine here.
Tarantool CPU statistics
Contains CPU process time statistics for each instance.
Tarantool memory miscellaneous
Memory metrics not related to space data. Contains Lua runtime memory panel.
Tarantool operations statistics
Overview of operations on Tarantool spaces (select, update, etc.) aggregated over all Tarantool spaces, as well as other operations activity (eval, call, auth, errors and SQL calls).
Project is open-sourced, so you can freely file an issue with suggestion or bug report to our GitHub page.