moonbitstack/moonp8s/expo

README
U
Counter
U
Entry
U
Exemplar
U
Family
U
Format
U
Gauge
U
GaugeHistogram
U
Histogram
U
Info
U
Kind
U
LabelSet
U
LocalCounter
U
MetricFamily
U
Mode
U
Part
U
Point
U
ProcessCollector
U
ProcessStats
U
PushRequest
U
Registry
U
StateSet
U
Summary
U
TypedFamily
U
Value
V
app
V
buckets
V
delete
V
exemplar_label_limit
V
exponential
V
format_float
V
is_valid_label_name
V
is_valid_metric_name
V
is_valid_unit
V
linear
V
merge
V
middleware
V
negotiate
V
openmetrics
V
protobuf
V
protobuf_content_type
V
push
V
push_add
V
text
V
wants_protobuf

moonbitstack/moonp8s/expo does not have a README file

Format

pub(all) enum Format {
  Text004
  OpenMetrics100
}

The exposition formats this library writes and reads.

Format::content_type

source

fn Format::content_type(self : Format) -> String

The Content-Type an HTTP response should carry for this format.

escape_help

source

fn escape_help(v : String, quotes : Bool) -> String

Escape help text. The compatibility format escapes backslash and newline; OpenMetrics also escapes the double quote, so help text survives a round trip inside a line-oriented document.

escape_label_value

source

fn escape_label_value(v : String) -> String

Escape a label value: backslash, double quote, and newline are backslash-escaped, every other character passes through as UTF-8.

format_float

source

fn format_float(d : Double) -> String

Format a float the way the official clients do: +Inf, -Inf, and NaN by name; otherwise the shortest decimal that round-trips, with a .0 on integers and Go's switch to a two-digit exponent once the integer part is longer than six digits (so 1000000.0 is 1e+06, matching what a Prometheus scrape expects to read).

negotiate

source

fn negotiate(accept : String) -> Format

Pick a format from an HTTP Accept header. application/openmetrics-text wins when it names a version this library speaks (or names no version); otherwise a scrape gets the compatibility format, which is also the default when the header is absent or unrecognised.

openmetrics

source

fn openmetrics(families : Array[@moonbitstack/moonp8s/metric.MetricFamily
MetricFamily]) -> String

Write families in the OpenMetrics text format, version 1.0.0, ending with the # EOF marker the format requires.

parse

source

fn parse(text : String, format? : Format) -> Array[@moonbitstack/moonp8s/metric.MetricFamily
MetricFamily] raise @moonbitstack/moonp8s/metric.Refused
Refused

Parse an exposition back into families. The compatibility format is lossy for info and state sets, which it spells as gauges; OpenMetrics keeps them. The format argument selects which spelling conventions to expect, and the same parser accepts both because the syntax is a superset.

protobuf

source

fn protobuf(families : Array[@moonbitstack/moonp8s/metric.MetricFamily
MetricFamily]) -> Bytes

Write families in the Prometheus protobuf format: a length-delimited stream of io.prometheus.client.MetricFamily messages, the bytes a scraper reads when it answers application/vnd.google.protobuf. It shares the text formats' snapshot, so one scrape is every format. A family is named as the text format declares it, so a counter is <name>_total with its value in the counter field and an info is <name>_info; a histogram keeps its cumulative buckets, sum, and count, its +Inf bucket being the count; a summary keeps its count, sum, and quantiles; a state set is a gauge per state.

protobuf_content_type

source

let protobuf_content_type : String

The Content-Type an HTTP response should carry for the protobuf format: the metric family the stream holds and the framing of the messages.

text

source

fn text(families : Array[@moonbitstack/moonp8s/metric.MetricFamily
MetricFamily]) -> String

Write families in the Prometheus text exposition format, version 0.0.4. Counters gain a _total suffix, info becomes a gauge ending in _info, state sets become gauges, and _created, _gcount, and _gsum series are emitted as separate gauge families, as the compatibility format requires.

wants_protobuf

source

fn wants_protobuf(accept : String) -> Bool

Whether an Accept header asks for the protobuf format. It does when any part is the media type the protobuf exposition carries; the two text formats are picked out of the header by negotiate, which never returns a protobuf.

Source Files

Install

Download zip

Prometheus metrics for MoonBit.

prometheusp8smetricsopenmetricsexpositionmonitoringobservabilitytelemetrycountergaugehistogramsummaryexemplarpushgatewayclientasgiprotobufprotobuf-exportdelimitedscrapecollectormoonbit

moonbitstack

Apache-2.0