liveBook · Manning

Metric endpoint

As explained in ScyllaDB in Action

A metrics endpoint is an API access point that exposes a system's measurable operational data for collection.

A metric endpoint is an API access point that exposes measurable operational data for collection. Prometheus calls the designated endpoint on each Scylla node, retrieves its metrics, and stores them in specialized time-series storage. section 11.1.1 section 11.1.2

The endpoint supports monitoring questions such as whether read latency has increased, how many reads are in progress, and whether compactions have risen. Prometheus collects these values at a configured interval, 20 seconds by default in the Scylla monitoring stack, so their change over time can be queried with PromQL. section 11.1.2 section 11.1.2

Reading an exported metric

An endpoint can expose a counter such as scylla_cache_partition_insertions, with separate values labeled by shard. Prometheus scrapes these values and makes them available for time-based queries and dashboards. section 11.1.2

How ScyllaDB in Action covers it

How deep it goes
Explains scraping, ingestion, and querying, but stops short of detailing endpoint implementation.
Examples
Uses read latency, reads in progress, compactions, and labeled cache-insertion counters.
What it assumes
Assumes a running Scylla node and monitoring configuration, while explaining endpoint collection at a high level.
What you can do after
Operate Prometheus collection by configuring hosts and verifying that monitoring targets are online.
How it connects
Connects Prometheus, PromQL, Grafana, and time-series metrics storage.

Also explained in

Compare how 4 books explain metric endpoint →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of ScyllaDB in Action. The section links point to the parts of the book it draws on.