Project: Trickster (Observability and Analysis / Observability)
File: metrics.md

Trickster exposes a Prometheus /metrics endpoint with a customizable listener port number (default is 8481). For more information on customizing the metrics configuration, see . The following metrics are available for polling with any Trickster configuration: `tricksterbuildinfo` (Gauge) - This gauge is always 1 when Trickster is running labels: `goversion` - the version of go under which the running Trickster binary was built `revision` - the commit ID on which the running Trickster binary was built `version` - semantic version of the running Trickster binary `tricksterconfiglastreloadsuccessful` (Gauge) - The value is 1 when true (the last config reload was successful) or 0 when false `tricksterconfiglastreloadsuccesstimeseconds` (Gauge) - Epoch timestamp of the last successful configuration reload `tricksterfrontendrequests_total` (Counter) - Count of front end requests handled by Trickster labels: `backend_name` - the name of the configured backend handling the proxy request `provider` - the type of the configured backend handling the proxy request `method` - the HTTP Method of the proxied request `http_status` - The HTTP response code provided by the backend `path` - the Path portion of the requested URL `tricksterfrontendrequestsdurationseconds` (Histogram) - Histogram of front end request durations handled by Trickster labels: `backend_name` - the name of the configured backend handling the proxy request `provider` - the type of the configured backend handling the proxy request `method` - the HTTP Method of the proxied request `http_status` - The HTTP response code provided by the backend `path` - the Path portion of the requested URL `tricksterfrontendwrittenbytetotal` (Counter) - Count of bytes written in front end requests handled by Trickster labels: `backend_name` - the name of the configured backend handling the proxy request `provider` - the type of the configured backend handling the proxy request `method` - the HTTP Method of the proxied request `http_status` - The HTTP response code provided by the backend `path` - the Path portion of the requested URL `tricksterproxyrequests_total` (Counter) - The total number of requests Trickster has handled. labels: `backend_name` - the name of the configured backend handling the proxy request `provider` - the type of the configured backend handling the proxy request `method` - the HTTP Method of the proxied request `cache_status` - status codes are described `http_status` - The HTTP response code provided by the backend `path` - the Path portion of the requested URL `tricksterproxypoints_total` (Counter) - The total number of data points Trickster has handled. labels: `backend_name` - the name of the configured backend handling the proxy request `provider` - the type of the configured backend handling the proxy request `cache_status` - status codes are described `path` - the Path portion of the requested URL `tricksterproxyrequestdurationseconds` (Histogram) - Time required to proxy a given Prometheus

labels: `backend_name` - the name of the configured backend handling the proxy request `provider` - the type of the configured backend handling the proxy request `method` - the HTTP Method of the proxied request `cache_status` - status codes are described `http_status` - The HTTP response code provided by the backend `path` - the Path portion of the requested URL `tricksterproxymax_connections` (Gauge) - Trickster max number of allowed concurrent connections `tricksterproxyactive_connections` (Gauge) - Trickster number of concurrent connections `tricksterproxyrequestedconnectionstotal` (Counter) - Trickster total number of connections requested by clients. `tricksterproxyacceptedconnectionstotal` (Counter) - Trickster total number of accepted client connections. `tricksterproxyclosedconnectionstotal` (Counter) - Trickster total number of administratively closed client connections. `tricksterproxyfailedconnectionstotal` (Counter) - Trickster total number of failed client connections. `trickstercacheoperationobjectstotal` (Counter) - The total number of objects upon which the Trickster cache has operated. labels: `cache_name` - the name of the configured cache performing the operation$ `provider` - the type of the configured cache performing the operation `operation` - the name of the operation being performed (read, write, etc.) `status` - the result of the operation being performed `trickstercacheoperationbytestotal` (Counter) - The total number of bytes upon which the Trickster cache has operated. labels: `cache_name` - the name of the configured cache performing the operation$ `provider` - the type of the configured cache performing the operation `operation` - the name of the operation being performed (read, write, etc.) `status` - the result of the operation being performed The following metrics are available only for Caches Types whose object lifecycle Trickster manages internally (Memory, Filesystem and bbolt): `trickstercacheevents_total` (Counter) - The total number of events that change the Trickster cache, such as retention policy evictions. labels: `cache_name` - the name of the configured cache experiencing the event$ `provider` - the type of the configured cache experiencing the event `event` - the name of the event being performed `reason` - the reason the event occurred `trickstercacheusage_objects` (Gauge) - The current count of objects in the Trickster cache. labels: `cache_name` - the name of the configured cache$ `provider` - the type of the configured cache$ `trickstercacheusage_bytes` (Gauge) - The current count of bytes in the Trickster cache. labels: `cache_name` - the name of the configured cache$ `provider` - the type of the configured cache$ `trickstercachemaxusageobjects` (Gauge) - The maximum allowed size of the Trickster cache in objects. labels: `cache_name` - the name of the configured cache$ `provider` - the type of the configured cache `trickstercachemaxusagebytes` (Gauge) - The maximum allowed size of the Trickster cache in bytes. labels: `cache_name` - the name of the configured cache$ `provider` - the type of the configured cache In addition to these custom metrics, Trickster also exposes the standard Prometheus metrics that are part of the metrics instrumentation package, including memory and cpu utilization, etc.