API
#github.com/xulang-org/packages/prometheusPublic API convenience helpers for Prometheus metrics exporter
github.com/xulang-org/packages · 0.1.1 · Install and use
open_pusherpub fn open_pusher(endpoint string, job string) PusherPublic API convenience helpers for Prometheus metrics exporter
endpoint stringjob stringPusher — a value of this type
struct Labelpub struct Label {
pub name string
pub value string
}Public struct `Label`.
name stringvalue stringstruct MetricSamplepub struct MetricSample {
pub label_str string
pub value string
}Public struct `MetricSample`.
label_str stringvalue stringstruct Counterpub struct Counter {
pub name string
pub help string
pub samples []MetricSample
}Public struct `Counter`.
name stringhelp stringsamples []MetricSamplestruct Gaugepub struct Gauge {
pub name string
pub help string
pub samples []MetricSample
}Public struct `Gauge`.
name stringhelp stringsamples []MetricSamplenew_counterpub fn new_counter(name string, help string) CounterConstruct counter.
name stringhelp stringCounter — a value of this type
new_gaugepub fn new_gauge(name string, help string) GaugeConstruct gauge.
name stringhelp stringGauge — a value of this type
(&mut Counter) incpub fn (c &mut Counter) inc()Call `inc` on `&mut Counter`.
c &mut Counter(&mut Counter) inc_bypub fn (c &mut Counter) inc_by(delta int)Method on `&mut Counter`: inc by.
c &mut Counterdelta int(&mut Counter) inc_labelspub fn (c &mut Counter) inc_labels(labels []Label, delta int)Method on `&mut Counter`: inc labels.
c &mut Counterlabels []Labeldelta int(&mut Gauge) setpub fn (g &mut Gauge) set(val string)Call `set` on `&mut Gauge`.
g &mut Gaugeval string(&mut Gauge) set_labelspub fn (g &mut Gauge) set_labels(labels []Label, val string)Method on `&mut Gauge`: set labels.
g &mut Gaugelabels []Labelval string(Counter) formatpub fn (c Counter) format() stringMethod on `Counter`: format as a string.
c Counterstring — result string
(Gauge) formatpub fn (g Gauge) format() stringMethod on `Gauge`: format as a string.
g Gaugestring — result string
struct Poolpub struct Pool {
pub host string
pub port int
pub state chan pool.State
pub max_idle int
}Connection Pool for Prometheus Pushgateway & Remote Exporters. Manages reusable TCP/HTTP socket connections.
host stringport intstate chan pool.Statemax_idle intnew_poolpub fn new_pool(endpoint string, max_idle int) PoolConstruct pool.
endpoint stringmax_idle intPool — a value of this type
open_poolpub fn open_pool(endpoint string, max_idle int) PoolOpen pool.
endpoint stringmax_idle intPool — a value of this type
(&Pool) duppub fn (p &Pool) dup() PoolShares sockets and close state; clones configuration strings.
p &PoolPool — a value of this type
(&Pool) get_connpub fn (p &Pool) get_conn() intMethod on `&Pool`: read conn.
p &Poolint — a value of this type
(&Pool) put_connpub fn (p &Pool) put_conn(fd int)Method on `&Pool`: put connection.
p &Poolfd int(&Pool) discard_connpub fn (p &Pool) discard_conn(fd int)Method on `&Pool`: discard connection.
p &Poolfd int(&Pool) push_metricspub fn (p &Pool) push_metrics(job string, metrics_text string) boolMethod on `&Pool`: push metrics.
p &Pooljob stringmetrics_text stringbool — true or false
(&Pool) closepub fn (p &Pool) close()Method on `&Pool`: close the resource.
p &Poolstruct Pusherpub struct Pusher {
pub host string
pub port int
pub job string
}Public struct `Pusher`.
host stringport intjob stringnew_pusherpub fn new_pusher(endpoint string, job string) PusherConstruct pusher.
endpoint stringjob stringPusher — a value of this type
(&Pusher) pushpub fn (p &Pusher) push(metrics_text string) boolCall `push` on `&Pusher`.
p &Pushermetrics_text stringbool — true or false
struct Registrypub struct Registry {
pub counters []Counter
pub gauges []Gauge
}Public struct `Registry`.
counters []Countergauges []Gaugenew_registrypub fn new_registry() RegistryConstruct registry.
none
Registry — a value of this type
(&mut Registry) register_counterpub fn (r &mut Registry) register_counter(c Counter)Method on `&mut Registry`: register counter.
r &mut Registryc Counter(&mut Registry) register_gaugepub fn (r &mut Registry) register_gauge(g Gauge)Method on `&mut Registry`: register gauge.
r &mut Registryg Gauge(&Registry) gatherpub fn (r &Registry) gather() stringCall `gather` on `&Registry`.
r &Registrystring — result string