Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,24 @@ Elastickv now exposes Prometheus metrics on `--metricsAddress` (default: `localh

The exported metrics cover:

- DynamoDB-compatible API request rate, success/error split, latency, request/response size, and per-table read/write item counts
- Raft local state, leader identity, current members, commit/applied index, and leader contact lag
- DynamoDB-compatible API request rate, success/system-error/user-error split, latency, in-flight requests, and per-table read/write activity
- Raft local state, leader identity, membership, last-log/commit/applied/snapshot index, FSM backlog, and leader contact lag

Provisioned monitoring assets live under:

- `monitoring/prometheus/prometheus.yml`
- `monitoring/grafana/dashboards/elastickv-cluster-overview.json`
- `monitoring/grafana/dashboards/elastickv-cluster-summary.json`
- `monitoring/grafana/dashboards/elastickv-raft-status.json`
- `monitoring/grafana/provisioning/`
- `monitoring/docker-compose.yml`

The provisioned dashboards are organized by operator task:

- `Elastickv Cluster Overview` is the landing page for leader identity, cluster-wide latency/error posture, and per-node Raft health
- `Elastickv Request Health` is the DynamoDB/API drilldown for slow operations, noisy nodes, and hot/erroring tables
Comment on lines +53 to +61
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency and clarity, consider renaming the dashboard file elastickv-cluster-summary.json to elastickv-request-health.json. This would align the filename with its new title Elastickv Request Health and the description provided in this README. You would also need to update this file to reflect the new name.

- `Elastickv Raft Status` is the control-plane drilldown for membership, node state, index drift, backlog, and leader contact

If you bind `--metricsAddress` to a non-loopback address, `--metricsToken` is required. Prometheus must send the same bearer token, for example:

```yaml
Expand Down
Loading
Loading