Trickster Metrics
Trickster exposes a Prometheus /metrics endpoint with a customizable listener port number (default is 8481). For more information on customizing the metrics configuration, see configuring.md.
The following metrics are available for polling with any Trickster configuration:
trickster_build_info(Gauge) - This gauge is always 1 when Trickster is running- labels:
goversion- the version of go under which the running Trickster binary was builtrevision- the commit ID on which the running Trickster binary was builtversion- semantic version of the running Trickster binary
- labels:
trickster_config_last_reload_successful(Gauge) - The value is 1 when true (the last config reload was successful) or 0 when falsetrickster_config_last_reload_success_time_seconds(Gauge) - Epoch timestamp of the last successful configuration reloadtrickster_frontend_requests_total(Counter) - Count of front end requests handled by Trickster- labels:
backend_name- the name of the configured backend handling the proxy requestprovider- the type of the configured backend handling the proxy requestmethod- the HTTP Method of the proxied requesthttp_status- The HTTP response code provided by the backendpath- the Path portion of the requested URL
- labels:
trickster_frontend_requests_duration_seconds(Histogram) - Histogram of front end request durations handled by Trickster. ACONNECT, whose duration is that of the tunnel or WebTransport session it opens, is not observed- labels:
backend_name- the name of the configured backend handling the proxy requestprovider- the type of the configured backend handling the proxy requestmethod- the HTTP Method of the proxied requesthttp_status- The HTTP response code provided by the backendpath- the Path portion of the requested URL
- labels:
trickster_frontend_written_byte_total(Counter) - Count of bytes written in front end requests handled by Trickster- labels:
backend_name- the name of the configured backend handling the proxy requestprovider- the type of the configured backend handling the proxy requestmethod- the HTTP Method of the proxied requesthttp_status- The HTTP response code provided by the backendpath- the Path portion of the requested URL
- labels:
trickster_proxy_requests_total(Counter) - The total number of requests Trickster has handled.- labels:
backend_name- the name of the configured backend handling the proxy requestprovider- the type of the configured backend handling the proxy requestmethod- the HTTP Method of the proxied requestcache_status- status codes are described herehttp_status- The HTTP response code provided by the backendpath- the Path portion of the requested URL
- labels:
trickster_proxy_upstream_retries_total(Counter) - The number of upstream requests retried under a path’sretrypolicy.- labels:
backend_name- the name of the configured backend handling the proxy requestpath- the configured path whose policy retried the request
- labels:
trickster_proxy_mirror_requests_total(Counter) - The number of requests copied to a path’smirrorbackend.- labels:
backend_name- the name of the configured backend handling the proxy requestmirror_backend- the backend receiving the copiesresult-sent, ordroppedwhen the mirror’s in-flight bound was reached
- labels:
trickster_proxy_sigv4_events_total(Counter) - The number of SigV4 signing events on backends with asigv4block.- labels:
backend_name- the name of the configured backend whose request was signedevent-sign_failurewhen a request could not be signed and was not sent, orcredentials_retrywhen the origin rejected expiring credentials and the request was resent with refreshed ones
- labels:
trickster_proxy_origin_srv_lookups_total(Counter) - The number of SRV lookups made by backends using SRV origin resolution.- labels:
backend_name- the name of the configured backend that dialed its originresult-hit,miss,stale(a failed refresh served the last good answer),negative(a cached NXDOMAIN, empty answer or failure) orerror
- labels:
trickster_proxy_origin_srv_dial_attempts_total(Counter) - The number of dial attempts to SRV targets by backends using SRV origin resolution.- labels:
backend_name- the name of the configured backend that dialed its origintier- the target’s priority tier, where0is the preferred tierresult-successorfailure
- labels:
trickster_proxy_truncated_responses_total(Counter) - The number of time series fetches the origin truncated at its series limit, which Trickster proxies rather than caches. Only backends whose flavor declares a series limit report it.- labels:
backend_name- the name of the configured backend whose fetch was truncated
- labels:
trickster_accesslog_dropped_lines_total(Counter) - The number of access and error log lines dropped because the log could not accept them.- labels:
backend_name- the name of the configured backend whose logger dropped the linelog-accessorerror
- labels:
trickster_ip_acl_decisions_total(Counter) - Decisions made by an attached IP access list. See ip-acl.md.- labels:
ip_acl- the name of the access listscope-listener,backend, orpathverdict-allowordeny.rejectanddropare bothdeny
- labels:
trickster_ratelimit_decisions_total(Counter) - Decisions made by an attached rate limiter. See rate-limiting.md.- labels:
limiter- the name of the rate limiterplane-http,streamormoqresult-allowed,limited,counted,exempt, orfull
- labels:
trickster_ratelimit_keys(Gauge) - Buckets a rate limiter holds at scrape time.- labels:
limiter- the name of the rate limiter
- labels:
trickster_proxy_points_total(Counter) - The total number of data points Trickster has handled.- labels:
backend_name- the name of the configured backend handling the proxy requestprovider- the type of the configured backend handling the proxy requestcache_status- status codes are described herepath- the Path portion of the requested URL
- labels:
trickster_proxy_timeseries_offgrid_extents_total(Counter) - The number of time series fetch ranges whose bounds fell between buckets and were narrowed to whole buckets before fetching. A non-zero value points to a step or phase mismatch between Trickster and the origin; please report it.- labels:
backend_name- the name of the configured backend fetching the rangeprovider- the type of the configured backend, or the native protocol (e.g.,mysql)
- labels:
trickster_proxy_partial_bucket_fetches_total(Counter) - The number of partial bucket fetches through the object cache, under apartialstep alignment mode.- labels:
backend_name- the name of the configured backendprovider- the backend provideredge-startorend: the edge of the requested range the bucket sits onstatus- the object cache result, such ashitorkmiss, orerrwhen the fetch failed and the bucket was left out of the response
- labels:
trickster_step_alignment_fallbacks_total(Counter) - The number of requests for a step alignment mode the query doesn’t support, served in the query’s default mode instead.- labels:
backend_name- the name of the configured backendrequested- the mode asked for, by the backend’s configuration, an ALB, or atrickster-step-aligndirectiveapplied- the mode the request was served in
- labels:
trickster_geo_acl_decisions_total(Counter) - The number of clients a geo ACL judged.- labels:
geo_acl- the name of the geo ACLplane-http,nativeorstream: the kind of listener the client was judged onverdict-allow,deny,count(denied, but the geo ACL only counts) orexempt(allowed with no lookup), astrickster_ip_acl_decisions_totalnames its verdicts
- labels:
trickster_geo_locator_lookups_total(Counter) - The number of lookups a geo locator answered. A rising rate ofnot_foundcan mean the listener’strusted_proxiesis wrong, so every client resolves to a proxy’s private address.- labels:
geo_locator- the name of the geo locatorresult-found,not_foundorerror
- labels:
trickster_geo_locator_reloads_total(Counter) - The number of replaced data files a geo locator loaded or refused, keeping the last good one.- labels:
geo_locator- the name of the geo locatorresult-successorerror
- labels:
trickster_geo_locator_build_timestamp_seconds(Gauge) - When the database anmmdbgeo locator has loaded was built, in seconds since the epoch.- labels:
geo_locator- the name of the geo locator
- labels:
trickster_proxy_request_duration_seconds(Histogram) - Time required to proxy a given Prometheus query.- labels:
backend_name- the name of the configured backend handling the proxy requestprovider- the type of the configured backend handling the proxy requestmethod- the HTTP Method of the proxied requestcache_status- status codes are described herehttp_status- The HTTP response code provided by the backendpath- the Path portion of the requested URL
- labels:
trickster_proxy_max_connections(Gauge) - Trickster max number of allowed concurrent connectionstrickster_proxy_active_connections(Gauge) - Trickster number of concurrent connectionstrickster_proxy_requested_connections_total(Counter) - Trickster total number of connections requested by clients.trickster_proxy_accepted_connections_total(Counter) - Trickster total number of accepted client connections.trickster_proxy_closed_connections_total(Counter) - Trickster total number of administratively closed client connections.trickster_proxy_failed_connections_total(Counter) - Trickster total number of failed client connections.trickster_proxy_stream_connections_total(Counter) - The number of connections and UDP sessions accepted bytcp,tlsandudplisteners.- labels:
listener_name- the name of the configured listenerprotocol-tcp,tlsorudpresult-proxied, or why the connection was closed instead:not_tls(atlslistener received no ClientHello),no_route(no backend routes the server name),no_upstream(the backend’s pool has no dialable member, or the member chosen refuses its share),dial_failed,refused(audplistener at its session limit, or a connection arriving as the listener closes), ordenied(turned away by the listener’s admission control before anything was relayed)
- labels:
trickster_proxy_stream_active_connections(Gauge) - The number of connections and UDP sessions stream listeners are relaying.- labels:
listener_name- the name of the configured listenerprotocol-tcp,tlsorudp
- labels:
trickster_proxy_stream_dropped_datagrams_total(Counter) - The number of datagramsudplisteners dropped rather than relayed.- labels:
listener_name- the name of the configured listenerreason-queue_full(the client’s flow, or every flow together, already held its allowance of datagrams waiting to be written),write_timeout(the write to the backend blocked for the whole write bound) ordenied(turned away by the listener’s admission control)
- labels:
trickster_proxy_stream_bytes_total(Counter) - The bytes relayed by stream listeners.- labels:
listener_name- the name of the configured listenerprotocol-tcp,tlsorudpdirection-infrom the client to the backend,outfrom the backend to the client
- labels:
trickster_proxy_stream_member_connections_total(Counter) - The number of connections and UDP sessions a stream listener committed to an ALB pool member.- labels:
listener_name- the name of the configured listenerprotocol-tcp,tlsorudpbackend_name- the name of the pool member backendresult-proxied,dial_failed(the member could not be connected to) orunreachable(audpmember answered a datagram with a port-unreachable)
- labels:
trickster_proxy_stream_member_active_connections(Gauge) - The number of connections and UDP sessions open to an ALB pool member.- labels:
listener_name- the name of the configured listenerprotocol-tcp,tlsorudpbackend_name- the name of the pool member backend
- labels:
trickster_proxy_stream_member_connect_duration_seconds(Histogram) - The time taken to connect to an ALB pool member.- labels:
listener_name- the name of the configured listenerprotocol-tcp,tlsorudpbackend_name- the name of the pool member backend
- labels:
trickster_proxy_query_range_rejected_total(Counter) - Trickster total number of queries rejected due to exceeding themax_query_rangelimit.- labels:
backend- the name of the configured backend rejecting the query
- labels:
trickster_graphite_resolution_lookups_total(Counter) - Count of Graphite step-resolution lookups. Labels never include a metric path or target expression.- labels:
backend_name- the name of the configured Graphite backendconfidence- how the step was established:exact(read from an origin response for this leaf set and age),derived(computed from known leaf ladders),configured(fromstatic_retentions, not yet probe-confirmed), orunknown(no usable step; the request is served unaccelerated)source- where it came from:registry,response,probe,static,function, ornone
- labels:
trickster_graphite_probes_total(Counter) - Count of synthetic requests issued to learn a metric’s archive ladder. Expect a spike at startup that collapses toward zero as ladders are learned.- labels:
backend_name- the name of the configured Graphite backendkind-narrow(a one-second window that also discovers the retention edge),wide(what a real query at that age receives), orfind(a/metrics/expandlookup)result-step(a stepped series came back),empty(no series: beyond retention, or no such metric), orerror
- labels:
trickster_graphite_ladders(Gauge) - Number of distinct archive ladders known to the resolution registry. Ladders come fromstorage-schemas.confpatterns, so this should flatten at a small number.- labels:
backend_name- the name of the configured Graphite backend
- labels:
trickster_graphite_registry_entries(Gauge) - Number of entries in each layer of the resolution registry.- labels:
backend_name- the name of the configured Graphite backendlayer-leaf(metric path to ladder),ladder(the ladders themselves),target(cached wildcard expansions), ornegative(paths in resolution backoff)
- labels:
trickster_graphite_step_mispredictions_total(Counter) - Count of origin responses whose step differed from the predicted step. This should always be zero. A non-zero value means a cached ladder was wrong; Trickster discards the prediction, relearns and re-serves the request unaccelerated, so clients still receive correct data.- labels:
backend_name- the name of the configured Graphite backend
- labels:
trickster_graphite_fallbacks_total(Counter) - Count of render requests served without delta caching. Labels never include a target expression.- labels:
backend_name- the name of the configured Graphite backendreason-parse_error,non_series_format,function_not_allowlisted,unknown_step,missing_target,mixed_steps,multi_target_step_mismatch,passthrough_max_data_points,misprediction,client_identity,tz_unavailable, orresolution_identity
- labels:
trickster_sql_query_analysis_total(Counter) - Count of SQL query cache-eligibility classifications. Labels never include query text.- labels:
backend_name- the name of the configured backend analyzing the querydialect- the SQL dialect of the analyzing backend (e.g.,clickhouse)cache_mode- the strongest cache mode supported by the query (delta,object, ornone)reason- the stable classification reason code (e.g.,delta_cacheable,unsafe_predicate,unsupported_bucket)
- labels:
trickster_sql_query_rewrite_failures_total(Counter) - Count of SQL cache-miss extent rewrite failures. Labels never include query text.- labels:
backend_name- the name of the configured backend rendering the querydialect- the SQL dialect of the rendering backendreason- the fixed internal failure category
- labels:
trickster_druid_query_analysis_total(Counter) - Count of native Druid query cache-eligibility classifications. Labels never include query text or datasource names.- labels:
backend_name- the configured Druid backendcache_mode-delta,object, orproxyreason- the stable classification reason code
- labels:
trickster_victoriametrics_query_analysis_total(Counter) - Count of MetricsQL API request cache-eligibility classifications. Labels never include query text.- labels:
backend_name- the configured VictoriaMetrics backendcache_mode-delta,object, orproxyreason- the stable classification reason code
- labels:
trickster_druid_query_rewrite_failures_total(Counter) - Count of Druid cache-miss extent rewrite failures.- labels:
backend_name- the configured Druid backendreason- the fixed internal failure category
- labels:
trickster_cache_operation_objects_total(Counter) - The total number of objects upon which the Trickster cache has operated.- labels:
cache_name- the name of the configured cache performing the operationprovider- the type of the configured cache performing the operationoperation- the name of the operation being performed (read, write, etc.)status- the result of the operation being performed
- labels:
trickster_cache_operation_duration_seconds(Histogram) - The time, in seconds, required to perform an operation on the Trickster cache. Deletions include both requested removals and index reaper evictions.- labels:
cache_name- the name of the configured cache performing the operationprovider- the type of the configured cache performing the operationoperation- the name of the operation being performed (get,set,setDirect,del)status- the result of the operation being performed (e.g.,hit,kmissfor a full key miss,none)
- labels:
trickster_cache_operation_bytes_total(Counter) - The total number of bytes upon which the Trickster cache has operated. Deletions (del) record bytes only for cache providers that use an index, since other providers don’t track object sizes.- labels:
cache_name- the name of the configured cache performing the operationprovider- the type of the configured cache performing the operationoperation- the name of the operation being performed (read, write, etc.)status- the result of the operation being performed
- labels:
trickster_alb_pool_admits_failing(Gauge) - 1 when an ALB pool’shealthy_flooradmits members in theunavailablestate, 0 otherwise. See alb.md for the recommended floor.- labels:
backend_name- the name of the configured ALB backend
- labels:
trickster_alb_pool_floor_reset(Gauge) - 1 when an ALB pool’shealthy_floorwas reset to 0 at startup because pool members have no health check and could never reach the configured floor, 0 otherwise. See alb.md.trickster_alb_pool_on_backup(Gauge) - 1 while an ALB pool that hasbackupmembers is dispatching to them because no other member is available, 0 otherwise. Present only for pools with backup members. See alb.md.- labels:
backend_name- the name of the configured ALB backend
- labels:
trickster_alb_member_inflight(Gauge) - Current number of requests in flight to an ALB pool member. Exported for the mechanisms that track it (p2c,lc,lt), for requests and for stream connections and sessions alike; read when the metrics endpoint is scraped, at no cost to request routing.- labels:
alb_name- the name of the configured ALB backendmember- the name of the pool member backend
- labels:
trickster_alb_member_draining(Gauge) - 1 for each ALB pool member that is draining: markeddrain: true, or discovered while terminating but still serving. It keeps its sticky sessions and takes no new work. Members that are not draining have no series; read when the metrics endpoint is scraped.- labels:
alb_name- the name of the configured ALB backendmember- the name of the pool member backend
- labels:
trickster_alb_member_ejections_total(Counter) - The number of timesalb.stream.passive_healthtook a pool member out of selection after repeated connect failures.- labels:
alb_name- the name of the configured ALB backendmember- the name of the pool member backend
- labels:
trickster_alb_sticky_total(Counter) - The number of requests, stream connections and native sessions through an ALB with sticky sessions, by how their session fared. Each is counted once it reaches its member or is refused, and not at all when it reaches no member; see Sticky Session Metrics.- labels:
alb_name- the name of the configured ALB backendresult-hit(sent to the member its session is pinned to),miss(no token or table entry),expired(a token past itsttloridle; an expired table entry is amiss),invalid(a token that is altered, signed with another key or issued by another ALB),repick(its member was unavailable and the session moved) orrejected(its member was unavailable andon_unavailable: rejectrefused it)
- labels:
trickster_alb_sticky_entries(Gauge) - The number of entries in the table of an ALB that keeps sticky sessions in a table, on any listener, expired entries not yet removed included; read when the metrics endpoint is scraped.- labels:
alb_name- the name of the configured ALB backend
- labels:
The following metrics are available for ALBs that use TSM global evaluation. Queries answered from the ALB’s cache aren’t evaluated, so they aren’t counted.
trickster_alb_global_evaluations_total(Counter) - The number of TSM global evaluations- labels:
alb_name- the name of the configured ALB backendstatus-success,partial(evaluated without an unavailable member), or the Prometheus API error type that answered the query:bad_data,execution,timeout,canceled,unavailableorinternal
- labels:
trickster_alb_global_evaluation_duration_seconds(Histogram) - The time TSM global evaluations take, from arrival to response, including raw series retrieval and any wait for an evaluation slot- labels:
alb_name- the name of the configured ALB backend
- labels:
trickster_alb_global_fetched_series_total(Counter) - The number of raw series TSM global evaluations read from pool members or the raw series cache, before deduplication- labels:
alb_name- the name of the configured ALB backend
- labels:
trickster_alb_global_fetched_samples_total(Counter) - The number of raw samples TSM global evaluations read from pool members or the raw series cache, before deduplication- labels:
alb_name- the name of the configured ALB backend
- labels:
trickster_alb_global_member_failures_total(Counter) - The number of raw series reads from a pool member that failed during TSM global evaluation- labels:
alb_name- the name of the configured ALB backendmember- the name of the pool member backend
- labels:
trickster_alb_global_raw_reads_total(Counter) - The number of raw series reads TSM global evaluations made of pool members, by how the raw series cache answered them- labels:
alb_name- the name of the configured ALB backendstatus-hitwhen only samples within the volatile window were read from the member,phitwhen older samples the cache lacked were read too,kmisswhen the cache held none, andproxy-onlywhen every sample was within the volatile window, or the read couldn’t be cached
- labels:
trickster_alb_global_raw_subsumed_total(Counter) - The number of raw series reads TSM global evaluations answered in part from the cached raw series of a broader selector on the same metric- labels:
alb_name- the name of the configured ALB backend
- labels:
The following metrics are available when ALB Autodiscovery is configured:
trickster_alb_discovery_members(Gauge) - Current number of discovered ALB pool members- labels:
alb_name- the name of the discovery-backed ALB backenddiscoverer- the name of the discoverer serving the ALB
- labels:
trickster_alb_discovery_member_changes_total(Counter) - Count of discovered pool member additions and removals- labels:
alb_name- the name of the discovery-backed ALB backenddiscoverer- the name of the discoverer serving the ALBevent-addorremove
- labels:
trickster_alb_discovery_snapshots_total(Counter) - Count of membership snapshots processed, by result- labels:
alb_name- the name of the discovery-backed ALB backenddiscoverer- the name of the discoverer serving the ALBresult-applied(membership updated),unchanged(no-op),rejected(guardrail-refused, e.g.min_members), orpartial(applied with member instantiation failures)
- labels:
trickster_alb_discovery_last_refresh_success_time_seconds(Gauge) - Epoch timestamp of the last successfully processed snapshot, for staleness alerting- labels:
alb_name- the name of the discovery-backed ALB backenddiscoverer- the name of the discoverer serving the ALB
- labels:
trickster_discovery_refresh_errors_total(Counter) - Count of provider-side refresh/watch errors (DNS resolution failures, Kubernetes list/sync failures, member-file read/parse failures)- labels:
discoverer- the name of the discoverer experiencing the errorprovider- the discoverer’s provider type
- labels:
trickster_tls_certificate_expiration_time_seconds(Gauge) - NotAfter time of a serving TLS certificate, as unix seconds. See tls.md.- labels:
listener- the name of the listener serving the certificateentry- the certificate’s source identity
- labels:
trickster_tls_certificate_last_load_time_seconds(Gauge) - Epoch timestamp a serving TLS certificate was last loaded from its source- labels:
listener- the name of the listener serving the certificateentry- the certificate’s source identity
- labels:
trickster_tls_certificate_swaps_total(Counter) - Count of TLS certificates hot-swapped into a live listener by rotation detection- labels:
listener- the name of the listener serving the certificateentry- the certificate’s source identity
- labels:
trickster_tls_certificate_validation_failures_total(Counter) - Count of detected TLS certificate source changes that failed pair validation (e.g. a mid-rotation partial write) and were not swapped in- labels:
entry- the certificate’s source identity
- labels:
trickster_tls_watcher_errors_total(Counter) - Count of errors reading watched TLS certificate source files- labels:
entry- the certificate’s source identity
- labels:
trickster_tls_certificate_store_size(Gauge) - Number of certificates in a listener’s TLS certificate store- labels:
listener- the name of the listener
- labels:
trickster_acme_orders_total(Counter) - Count of first-time ACME certificate orders. See acme.md.- labels:
issuer- the name of the ACME issuerresult-successorfailure
- labels:
trickster_acme_renewals_total(Counter) - Count of ACME certificate renewals- labels:
issuer- the name of the ACME issuerresult-successorfailure
- labels:
trickster_acme_challenge_requests_total(Counter) - Count of ACME challenge requests received by listeners- labels:
type-http-01ortls-alpn-01result-served,unknown(no matching pending challenge) orerror
- labels:
trickster_acme_on_demand_decisions_total(Counter) - Count of on-demand issuance decisions- labels:
result-allowed,refused,refused_cached,rate_limitedorask_error
- labels:
trickster_acme_startup_wait_seconds(Gauge) - Seconds startup readiness was held waiting for missing ACME certificatestrickster_acme_startup_wait_timeouts_total(Counter) - Count of startup waits that timed out before every ACME certificate was issued
The following metrics are available only for Caches Types whose object lifecycle Trickster manages internally (Memory, Filesystem and bbolt):
trickster_cache_events_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 eventevent- the name of the event being performedreason- the reason the event occurred
- events and reasons:
eventreasoncounts evictionttlremovals of expired objects, a batch at a time evictionsize_bytes,size_objectsremovals of least-recently-accessed objects from a cache over its size evictionfree_spaceremovals of least-recently-accessed objects for min_free_bytes(Filesystem)invalid_objectexpired,corrupt,unknown_formatobjects found to be unservable when read or swept, and removed (Filesystem and bbolt) indexcompactionreplacements of the Cache Index journal by a snapshot (Filesystem and bbolt) indexsweepcompleted sweeps of the cache (Filesystem and bbolt) sweepadoptedobjects a sweep found in the cache that the Cache Index did not list sweepdroppedobjects a sweep found the Cache Index to list that the cache no longer held
- labels:
trickster_cache_usage_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$
- labels:
trickster_cache_usage_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$
- labels:
trickster_cache_max_usage_objects(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
- labels:
trickster_cache_max_usage_bytes(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
- labels:
The following metrics are available for Static File Server Backends. Requests they serve are also counted, like those of any other Backend, by the trickster_frontend_requests_* metrics with a provider of static. Their Fileserver cache is separate from the caches above, and is not reported by the trickster_cache_* metrics.
trickster_fileserver_responses_total(Counter) - The total number of files served, by how the Fileserver cache figured in the response. Responses that send no file (such as a404with no not-found file, a redirect or a directory listing) are not counted.- labels:
backend_name- the name of the configured backendcache_status-hit(served as it was held),phit(the file was held, and was encoded for the response and the rendition then held),kmiss(read from disk for the response, and then held) ordisk(sent from disk without being held, as for a large file, a byte range, aHEADor a304)encoding- the encoding of the rendition the file server sent:identity,zstd,br,gzipordeflate. A response counted asidentitymay still be encoded on its way out, as a large compressible file is.
- labels:
trickster_fileserver_cache_events_total(Counter) - The total number of objects removed from the Fileserver cache.- labels:
backend_name- the name of the configured backendevent-eviction(the least recently used, removed to make room) orinvalidation(removed because the file changed on disk, or the cache was stopped)
- labels:
A backend’s series are published only once it is in service, so a configuration that is rejected publishes nothing. They are deleted when a reload removes or renames the backend; across a reload that keeps its name, the counters carry on rather than start over. The four gauges that follow are published only while the backend has a Fileserver cache, and are removed when it is disabled.
trickster_fileserver_cache_usage_objects(Gauge) - The current count of objects in the Fileserver cache, including files being read into it. Each held rendition of a file is an object.- labels:
backend_name- the name of the configured backend
- labels:
trickster_fileserver_cache_usage_bytes(Gauge) - The current accounted size of the Fileserver cache in bytes, which includes each object’s bookkeeping allowance.- labels:
backend_name- the name of the configured backend
- labels:
trickster_fileserver_cache_max_usage_objects(Gauge) - The configuredmax_filesof the Fileserver cache.- labels:
backend_name- the name of the configured backend
- labels:
trickster_fileserver_cache_max_usage_bytes(Gauge) - The configuredmax_size_bytesof the Fileserver cache.- labels:
backend_name- the name of the configured backend
- labels:
The following metrics are available when the Kubernetes Gateway/Ingress controller is enabled (the top-level kubernetes section; see kubernetes-gateway.md):
trickster_moq_sessions_total(Counter) - Count of MoQ Transport sessions by outcome- labels:
listener_name- the listener the session arrived onbackend_name- the backend it was routed to, empty when it was refused before routingrole-downstreamtransport-quicorwebtransportdraft- the negotiated draft, empty when none was negotiatedresult-ok,refused,no_route,busyorfailed
- labels:
trickster_moq_active_sessions(Gauge) - Current MoQ Transport sessions- labels:
listener_name- the listener serving the sessionsbackend_name- the backend they were routed torole-downstream
- labels:
trickster_moq_requests_total(Counter) - Count of MoQ Transport requests by type and result- labels:
backend_name- the moq backendtype-subscribe,fetch,track_status,publish,publish_namespace,subscribe_namespace,subscribe_tracksorotherresult-okorrefused
- labels:
trickster_moq_active_subscriptions(Gauge) - Current MoQ Transport subscriptions- labels:
backend_name- the moq backenddirection-upstream(the relay’s subscriptions toward origins and publishers) ordownstream
- labels:
trickster_moq_objects_total(Counter) - Count of MoQ Transport objects by direction and delivery- labels:
backend_name- the moq backenddirection-inoroutdelivery-stream,datagramorfetch
- labels:
trickster_moq_bytes_total(Counter) - Count of MoQ Transport object payload and property bytes- labels:
backend_name- the moq backenddirection-inorout
- labels:
trickster_moq_dropped_objects_total(Counter) - Count of MoQ Transport objects not forwarded- labels:
backend_name- the moq backendreason-oversize,delivery_timeout,datagram_queue_fullorspill_queue_full
- labels:
trickster_moq_fetch_objects_total(Counter) - Count of objects served to FETCH and fills, by where they came from- labels:
backend_name- the moq backendsource-live_edge,cacheorupstream
- labels:
trickster_moq_live_edge_bytes(Gauge) - Current payload bytes held in a moq backend’s in-memory live edge- labels:
backend_name- the moq backend
- labels:
trickster_moq_publishers_active(Gauge) - CurrentPUBLISHsubscriptions publishers hold open to a moq backend- labels:
backend_name- the moq backend
- labels:
trickster_moq_errors_total(Counter) - Count of MoQ Transport failures- labels:
backend_name- the moq backendclass-malformed_trackorcache
- labels:
trickster_kgw_reconciles_total(Counter) - Count of controller reconcile passes, by result- labels:
result-applied(the data plane was reloaded),unchanged(the generated configuration was already running), orerror(the pass failed to compile or apply)
- labels:
trickster_kgw_reconcile_duration_seconds(Histogram) - Duration of a whole reconcile pass, from reading the caches to writing statustrickster_kgw_reconcile_errors_total(Counter) - Count of reconcile passes that failed in a stage- labels:
stage-compile,apply,certificates(a certificate a listener’s store refused) orstatus(a status write the API server refused)
- labels:
trickster_kgw_watch_events_total(Counter) - Count of Kubernetes watch events received by the controller- labels:
kind- the object kind (Gateway,HTTPRoute,Ingress,Secret,Service, …)event-add,updateordelete
- labels:
trickster_kgw_translate_duration_seconds(Histogram) - Duration of translating the watched objects into the routing modeltrickster_kgw_apply_duration_seconds(Histogram) - Duration of applying generated configuration to the data plane, observed only on passes that reload ittrickster_kgw_generated_objects(Gauge) - Size of the routing model the last pass produced- labels:
kind-listeners,routes,backends,certificatesorpolicies
- labels:
trickster_kgw_status_write_failures_total(Counter) - Count of status writes the API server refused, after conflict retries- labels:
kind- the kind of the object whose status could not be written
- labels:
trickster_kgw_leader(Gauge) - 1 when this replica holds the leader election Lease and so writes status and Events, 0 otherwisetrickster_kgw_last_successful_sync_time_seconds(Gauge) - Epoch timestamp of the last reconcile pass whose generated configuration is running, for staleness alertingtrickster_kgw_route_info(Gauge) - A constant 1 per generated backend, joining it to the Kubernetes object it serves- labels:
kind-HTTPRouteorIngressroute- the object’s namenamespace- the object’s namespacebackend_name- the generated backend’s name, as thebackend_namelabel of the request metrics carries it
For example, request rates per Kubernetes route:
sum by (kind, namespace, route) ( rate(trickster_proxy_requests_total[5m]) * on (backend_name) group_left (kind, namespace, route) trickster_kgw_route_info )- labels:
In addition to these custom metrics, Trickster also exposes the standard Prometheus metrics that are part of the client_golang metrics instrumentation package, including memory and cpu utilization, etc.