MetricSample

MetricSample = object

Defined in: src/metrics/Metrics.ts:51

A single point-in-time observation of one metric series. Exporters walk the registry and turn each sample into their wire format.

Properties

bucket?

readonly optional bucket?: number

Defined in: src/metrics/Metrics.ts:68

Histogram bucket upper bound. When set, value carries the cumulative count for that bucket; series name will be suffixed with _bucket and labels will include le=<bound>. Special value Infinity represents the +Inf bucket.

---

count?

readonly optional count?: number

Defined in: src/metrics/Metrics.ts:70

For histograms: total observation count. Series name _count.

---

help

readonly help: string

Defined in: src/metrics/Metrics.ts:55

Free-form description for # HELP.

---

kind

readonly kind: "counter" | "gauge" | "histogram"

Defined in: src/metrics/Metrics.ts:57

'counter', 'gauge', 'histogram'.

---

labels

readonly labels: Labels

Defined in: src/metrics/Metrics.ts:59

Series-level labels. Empty object for unlabeled series.

---

name

readonly name: string

Defined in: src/metrics/Metrics.ts:53

Family name — e.g. actor_messages_delivered_total.

---

sum?

readonly optional sum?: number

Defined in: src/metrics/Metrics.ts:72

For histograms: total observation sum. Series name _sum.

---

value

readonly value: number

Defined in: src/metrics/Metrics.ts:61

Counter / gauge value, or histogram sum (when bucket is set).