Taler Observability API

1.13. Taler Observability API#

1.13.1. Introduction#

This section describes the API offered by many Taler components. The API is used to track the internal state of a Taler component.

1.13.2. Config#

GET /config#

Return the protocol version and configuration information about the bank. This specification corresponds to current protocol being version v0.

Response:

200 OK:

Response is a Config.

Details:

interface Config {
  // Name of the API.
  name: "taler-observability";

  // libtool-style representation of the Bank protocol version, see
  // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
  // The format is "current:revision:age".
  version: string;
}

1.13.3. Metrics#

GET /metrics#

Exposes application metrics in the Prometheus exposition format. These metrics can be scraped by Prometheus or other monitoring systems for observability, alerting, and analysis.

Response:

200 Ok:

Response woth metrics in the Prometheus text format.

401 Unauthorized:

Authentication failed, likely the credentials are wrong.