stdlib/metricsView source ↗
metrics
17 items · generated by scribe fromstdlib/metrics.fd· synced 2026-11-15
Contents
- METRIC_COUNTER: (const)
- Metrics (struct)
- metrics_new (function)
- metrics_valid_name (function)
- metrics_counter (function)
- metrics_gauge (function)
- metrics_histogram (function)
- metrics_inc (function)
- metrics_set (function)
- metrics_observe (function)
- metrics_get (function)
- metrics_count (function)
- metrics_text (function)
- metrics_http_handler (function)
- metrics_serve_set (function)
- metrics_serve (function)
METRIC_COUNTER:
pub const METRIC_COUNTER: i64 = 0; pub const METRIC_GAUGE: i64 = 1; pub const METRIC_HISTOGRAM: i64 = 2;Defined at line 15
Metrics
A set of metrics. Ids are indexes; a histogram’s buckets live in bounds and buckets, from first[id], nbounds[id] of them.
pub struct Metrics {Fields:
| Name | Type |
|---|---|
names | Vec<str> |
helps | Vec<str> |
kinds | Vec<i64> |
values | Vec<i64> |
counts | Vec<i64> |
first | Vec<i64> |
nbounds | Vec<i64> |
bounds | Vec<i64> |
buckets | Vec<i64> |
Defined at line 18
metrics_new
An empty set of metrics.
Example: var m = metrics_new(); var reqs = metrics_counter(&mut m, “http_requests_total”, “Requests served.”); metrics_inc(&mut m, reqs, 1); metrics_inc(&mut m, reqs, 2); assert_eq(metrics_get(m, reqs), 3); var text = metrics_text(m); println(text); assert(str_contains(text, “http_requests_total 3”));
pub fn metrics_new() -> Metrics {Returns: Metrics
Defined at line 43
metrics_valid_name
Is name a valid metric name: [a-zA-Z_:][a-zA-Z0-9_:]*?
Example: assert(metrics_valid_name(“http_requests_total”)); assert(!metrics_valid_name(“9lives”));
pub fn metrics_valid_name(name: str) -> bool {Parameters:
name:str
Returns: bool
Defined at line 54
metrics_counter
A counter: only goes up.
pub fn metrics_counter(m: & mut Metrics, name: str, help: str) -> i64 {Parameters:
m:& mut Metricsname:strhelp:str
Returns: i64
Defined at line 93
metrics_gauge
A gauge: set to any value.
Example: var m = metrics_new(); var g = metrics_gauge(&mut m, “queue_depth”, “Jobs waiting.”); metrics_set(&mut m, g, 12); metrics_set(&mut m, g, 4); assert_eq(metrics_get(m, g), 4);
pub fn metrics_gauge(m: & mut Metrics, name: str, help: str) -> i64 {Parameters:
m:& mut Metricsname:strhelp:str
Returns: i64
Defined at line 105
metrics_histogram
A histogram with the given upper bounds, in increasing order.
Example: var m = metrics_new(); var up: Vec
pub fn metrics_histogram(m: & mut Metrics, name: str, help: str, upper: Vec<i64>) -> i64 {Parameters:
m:& mut Metricsname:strhelp:strupper:Vec<i64>
Returns: i64
Defined at line 120
metrics_inc
Add by (>= 0) to a counter, or to a gauge.
pub fn metrics_inc(m: & mut Metrics, id: i64, by: i64) {Parameters:
m:& mut Metricsid:i64by:i64
Defined at line 136
metrics_set
Set a gauge.
pub fn metrics_set(m: & mut Metrics, id: i64, value: i64) {Parameters:
m:& mut Metricsid:i64value:i64
Defined at line 144
metrics_observe
Record one value in a histogram.
pub fn metrics_observe(m: & mut Metrics, id: i64, value: i64) {Parameters:
m:& mut Metricsid:i64value:i64
Defined at line 152
metrics_get
A counter’s or gauge’s value; a histogram’s sum.
pub fn metrics_get(m: Metrics, id: i64) -> i64 {Parameters:
m:Metricsid:i64
Returns: i64
Defined at line 170
metrics_count
A histogram’s number of observations.
pub fn metrics_count(m: Metrics, id: i64) -> i64 {Parameters:
m:Metricsid:i64
Returns: i64
Defined at line 175
metrics_text
Every metric in the Prometheus text format, version 0.0.4.
pub fn metrics_text(m: Metrics) -> str {Parameters:
m:Metrics
Returns: str
Defined at line 180
metrics_http_handler
The endpoint body: Prometheus text on /metrics, 404 elsewhere.
pub fn metrics_http_handler(req: HttpRequest) -> str {Parameters:
req:HttpRequest
Returns: str
Defined at line 217
metrics_serve_set
Point the served endpoint at m without starting a server.
pub fn metrics_serve_set(m: Metrics) {Parameters:
m:Metrics
Defined at line 225
metrics_serve
Serve m at GET /metrics on port — one call (CO3). Returns false when the port cannot be opened.
pub fn metrics_serve(m: Metrics, port: i64) -> bool {Parameters:
m:Metricsport:i64
Returns: bool
Defined at line 231
Generated by scribe, the Fides documentation generator