| title |
|---|
Metrics |
The metrics endpoint returns a host of Prometheus metrics for monitoring the health of the underlying Frontier process.
There is an official Grafana Dashboard to easily visualize those metrics.
Since Frontier 1.0.0 this endpoint is not part of the public API. It's available in the internal server (listening on the internal port set via ADMIN_PORT env variable or --admin-port CLI param).
GET /metrics
Assuming a local Frontier instance is running with an admin port of 9090 (i.e. ADMIN_PORT=9090 env variable or --admin-port=9090)
curl "https://localhost:9090/metrics"The /metrics endpoint returns a Prometheus text-formated response. It is meant to be scraped by Prometheus.
Below, each section of related data points are grouped together and annotated (note: this endpoint returns ALL this data in one response).
Frontier utilizes Go's built in concurrency primitives (goroutines and channels). The goroutine metric monitors the number of currently running goroutines on this Frontier's process.
Frontier maintains its own database (postgres), a verbose and user friendly account of activity on the DigitalBits network.
| Metric | Description |
|---|---|
| history.elder_ledger | The sequence number of the oldest ledger recorded in Frontier's database. |
| history.latest_ledger | The sequence number of the youngest (most recent) ledger recorded in Frontier's database. |
| history.open_connections | The number of open connections to the Frontier database. |
Ingester represents metrics specific to Frontier's ingestion process, or the process by which Frontier consumes transaction results from a connected DigitalBits Core instance.
| Metric | Description |
|---|---|
| ingester.clear_ledger | The count and rate of clearing (per ledger) for this Frontier process. |
| ingester.ingest_ledger | The count and rate of ingestion (per ledger) for this Frontier process. |
These metrics contain useful sub metrics.
Frontier utilizes the standard debug, error, etc. levels of logging. This metric outputs stats for each level of log message produced, useful for a high-level monitoring of "is my Frontier instance functioning properly?" In order of increasing severity:
- logging.debug
- logging.info
- logging.warning
- logging.error
- logging.panic
These metrics contain useful sub metrics.
Requests represent an overview of Frontier's incoming traffic.
These metrics contain useful sub metrics.
| Metric | Description |
|---|---|
| requests.failed | Failed requests are those that return a status code in [400, 600). |
| requests.succeeded | Successful requests are those that return a status code in [200, 400). |
| requests.total | Total number of received requests. |
As noted above, Frontier relies on DigitalBits Core to stay in sync with the DigitalBits network. These metrics are specific to the underlying DigitalBits Core instance.
| Metric | Description |
|---|---|
| digitalbits_core.latest_ledger | The sequence number of the latest (most recent) ledger recorded in DigitalBits Core's database. |
| digitalbits_core.open_connections | The number of open connections to the DigitalBits Core postgres database. |
Frontier does not submit transactions directly to the DigitalBits network. Instead, it sequences transactions and sends the base64 encoded, XDR serialized blob to its connected DigitalBits Core instance.
The following is a simplified version of the transaction submission process that glosses over the finer details. To dive deeper, check out the source code.
Frontier's sequencing mechanism consists of a manager that keeps track of submission queues for a set of addresses. A submission queue is a priority queue, prioritized by minimum transaction sequence number, that holds a set of pending transactions for an account. A pending transaction is represented as an object with a sequence number and a channel. Periodically, this queue is updated, popping off finished transactions, sending down the transaction's channel a successful/failure response.
These metrics contain useful sub metrics.
| Metric | Description |
|---|---|
| txsub.buffered | The count of submissions buffered behind this Frontier's submission queue. |
| txsub.failed | The rate of failed transactions that have been submitted to this Frontier. |
| txsub.open | The count of "open" submissions (i.e.) submissions whose transactions haven't been confirmed successful or failed. |
| txsub.succeeded | The rate of successful transactions that have been submitted to this Frontier. |
| txsub.total | Both the rate and count of all transactions submitted to this Frontier. |
Various sub metrics related to a certain metric's performance.
| Metric | Description |
|---|---|
1m.rate, 5min.rate, etc. |
The per-minute moving average rate of events per second at the given time interval. |
75%, 95%, etc. |
Counts at different percentiles. |
count |
Sum total of a certain metric value. |
max, mean, etc. |
Common statistic calculations. |