Catalog of Metrics

This section lists monitoring metrics made available by FTL server, including the following attributes:

  • ID: A unique ID denotes each type of counter. When subscribing to the monitoring stream, content matchers can refer to these ID values using API constants.

  • Metric Type: A human-readable string represents each type of counter. These strings can appear in databases and user interfaces.

  • Description: This column explains the meaning of each type counter and the quantity it measures.

  • Tracking: This column describes the object that each counter tracks. For example, a counter could collect data about the operation of an endpoint, a transport, an event queue, a client process, or a persistence store.

Each metric also has a Prometheus name. Users of the Prometheus endpoint take the ID from the following tables, and lookup the name in FTL Prometheus Metric Naming. Note that the Prometheus version of the metric may use different units. The unit for a metric is included in the metric name, as per Prometheus convention.

All users of FTL are encouraged to use the Prometheus endpoint instead of the legacy monitoring destination.