Package org.microproxy.stats

package org.microproxy.stats
  • Class
    Description
    Counter
    A count that only goes up, such as downstream_rq_total.
    Gauge
    A value that goes up and down, such as downstream_cx_active.
    Histogram
    A distribution of recorded values in fixed buckets, such as downstream_rq_time: one LongAdder per bucket, plus the sum and the count of the values, so recording takes no lock and allocates nothing.
    Histogram.Snapshot
    The counts of a histogram at one moment.
    Metric
    A named statistic of a StatsRegistry: a Counter, a Gauge or a Histogram.
    Metric.Type
    What kind of metric a Metric is.
    StatsdSink
    Pushes a registry's metrics to a statsd server over UDP, every flush interval (5 seconds by default, as Envoy), from a virtual thread: counters as the increase since the last flush ( |c), gauges as their value (|g), by their flat names after the registry's prefix (envoy.cluster.direct.upstream_rq_total:3|c).
    StatsdSink.Builder
    Settings for a StatsdSink.
    StatsFormatter
    Renders a registry's metrics as Envoy's admin endpoint does: Prometheus's text exposition format, the plain /stats dump and its JSON form.
    StatsRegistry
    The proxy's metrics, by Envoy's flat stat names (http.<prefix>.downstream_rq_total, cluster.<name>.upstream_cx_connect_ms, ...), each with the tags its name carries (TagExtractor), for StatsFormatter and StatsdSink to show.
    StatsRegistry.Builder
    Settings for a StatsRegistry.
    StatsRegistry.Overflow
    What happens to a new cluster once StatsRegistry.Builder.maxClusters clusters have stats.
    StatsScope
    Metrics named <prefix>.<name> whose names come from outside the proxy, such as a script's (script.<name>), and of which there may be at most a fixed number: past it, new names get metrics that do nothing (and a warning is logged once), so their number stays bounded whatever names are asked for.
    Tag
    A value taken out of a metric's flat name, which Prometheus shows as a label.
    TagExtractor
    Takes tag values out of flat stat names, once, when a metric is registered, as Envoy's tag extraction does: cluster.direct.upstream_rq_2xx becomes cluster.upstream_rq_xx with the tags envoy_cluster_name="direct" and envoy_response_code_class="2".
    TagExtractor.Result
    A name with its tags taken out.
    TagExtractor.Rule
    One rule.