Metrics
Fabio collects metrics per route and service instance as well as running totals
to avoid computing large amounts of metrics. The metrics can be sent to
Circonus, Graphite,
StatsD, DataDog
(via statsd - or since v1.6.0 to native protocol with tag support) or stdout. See the metrics.*
options in the fabio.properties
file. Prometheus is also possible, but it works the reverse of the other metrics platforms.
Instead of pushing data to a metrics server, prometheus expects to poll an endpoint for changes.
Configuring Prometheus Metrics
To configure prometheus metrics, you need to do the following:
- You must specify that prometheus is the metrics.target
- You must configure a listener in proxy.addr with
proto=prometheus - (optional) override the metrics.prometheus.path, metrics.prometheus.subsystem, and metrics.prometheus.buckets.
Metrics info (for non-tagged backends, such as circonus and statsd_raw)
Fabio reports the following metrics:
| Name | Type | Description |
|---|---|---|
{route}.rx |
timer | Number of bytes received by fabio for TCP target |
{route}.tx |
timer | Number of bytes transmitted by fabio for TCP target |
{route} |
timer | Average response time for a route |
http.status.code.{code} |
timer | Average response time for all HTTP(S) requests per status code |
notfound |
counter | Number of failed HTTP route lookups |
requests |
timer | Average response time for all HTTP(S) requests |
grpc.requests |
timer | Average response time for all GRPC(S) requests |
grpc.noroute |
counter | Number of failed GRPC route lookups |
grpc.conn |
counter | Number of established GRPC proxy connections |
grpc.status.{code} |
timer | Average response time for all GRPC(S) requests per status code |
tcp.conn |
counter | Number of established TCP proxy connections |
tcp.connfail |
counter | Number of TCP upstream connection failures |
tcp.noroute |
counter | Number of failed TCP upstream route lookups |
tcp_sni.conn |
counter | Number of established TCP+SNI proxy connections |
tcp_sni.connfail |
counter | Number of failed TCP+SNI proxy connections |
tcp_sni.noroute |
counter | Number of failed TCP+SNI upstream route lookups |
ws.conn |
gauge | Number of actively open websocket connections |
Legend
timer
A timer counts events and provides an average throughput and latency number. Depending on the metrics provider the aggregation happens either in the metrics library (go-metrics: statsd, graphite) or in the system of the metrics provider (Circonus)
counter
A counter counts events and provides an monotonically increasing value.
gauge
A gauge provides a current value.
{code}
{code} is the three digit HTTP status code like 200.
{route}
{route} is a shorthand for the metrics name generated for a route
with the metrics.names template defined in
fabio.properties