16.13. Taler Observability RESTful API#

16.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.

16.13.1.1. Version History#

The current protocol version is v0.

This API is to be used by Prometheus and other external tools.

Version history:

v0: Initial version.

Upcoming versions:

None anticipated.

Ideas for future version:

vXXX: marker for features not yet targeted for release

16.13.2. Config#

GET /config#

Return the protocol version and configuration information about the bank.

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;
}

16.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.