type HTTPDoer interface {Do(*http.Request) (*http.Response,error)}

type Pusher struct {// contains filtered or unexported fields}

funcNew¶added inv0.9.0

func New(url, jobstring) *Pusher

New creates a new Pusher to push to the provided URL with the provided jobname (which must not be empty). You can use just host:port or ip:port as url,in which case “http://” is added automatically. Alternatively, include theschema in the URL. However, do not include the “/metrics/jobs/…” part.

func (*Pusher)Add¶added inv0.9.0

func (p *Pusher) Add()error

Add works like push, but only previously pushed metrics with the same name(and the same job and other grouping labels) will be replaced. (It uses HTTPmethod “POST” to push to the Pushgateway.)

package mainimport ("fmt""time""github.com/prometheus/client_golang/prometheus""github.com/prometheus/client_golang/prometheus/push")var (completionTime = prometheus.NewGauge(prometheus.GaugeOpts{Name: "db_backup_last_completion_timestamp_seconds",Help: "The timestamp of the last completion of a DB backup, successful or not.",})successTime = prometheus.NewGauge(prometheus.GaugeOpts{Name: "db_backup_last_success_timestamp_seconds",Help: "The timestamp of the last successful completion of a DB backup.",})duration = prometheus.NewGauge(prometheus.GaugeOpts{Name: "db_backup_duration_seconds",Help: "The duration of the last DB backup in seconds.",})records = prometheus.NewGauge(prometheus.GaugeOpts{Name: "db_backup_records_processed",Help: "The number of records processed in the last DB backup.",}))func performBackup() (int, error) {// Perform the backup and return the number of backed up records and any// applicable error.// ...return 42, nil}func main() {// We use a registry here to benefit from the consistency checks that// happen during registration.registry := prometheus.NewRegistry()registry.MustRegister(completionTime, duration, records)// Note that successTime is not registered.pusher := push.New("http://pushgateway:9091", "db_backup").Gatherer(registry)start := time.Now()n, err := performBackup()records.Set(float64(n))// Note that time.Since only uses a monotonic clock in Go1.9+.duration.Set(time.Since(start).Seconds())completionTime.SetToCurrentTime()if err != nil {fmt.Println("DB backup failed:", err)} else {// Add successTime to pusher only in case of success.// We could as well register it with the registry.// This example, however, demonstrates that you can// mix Gatherers and Collectors when handling a Pusher.pusher.Collector(successTime)successTime.SetToCurrentTime()}// Add is used here rather than Push to not delete a previously pushed// success timestamp in case of a failure of this backup.if err := pusher.Add(); err != nil {fmt.Println("Could not push to Pushgateway:", err)}}

func (*Pusher)AddContext¶added inv1.13.0

func (p *Pusher) AddContext(ctxcontext.Context)error

AddContext is like Add but includes a context.

If the context expires before HTTP request is complete, an error is returned.

func (*Pusher)BasicAuth¶added inv0.9.0

func (p *Pusher) BasicAuth(username, passwordstring) *Pusher

BasicAuth configures the Pusher to use HTTP Basic Authentication with theprovided username and password. For convenience, this method returns apointer to the Pusher itself.

func (*Pusher)Client¶added inv0.9.0

func (p *Pusher) Client(cHTTPDoer) *Pusher

Client sets a custom HTTP client for the Pusher. For convenience, this methodreturns a pointer to the Pusher itself.Pusher only needs one method of the custom HTTP client: Do(*http.Request).Thus, rather than requiring a fully fledged http.Client,the provided client only needs to implement the HTTPDoer interface.Since *http.Client naturally implements that interface, it can still be used normally.

func (*Pusher)Collector¶added inv0.9.0

func (p *Pusher) Collector(cprometheus.Collector) *Pusher

Collector adds a Collector to the Pusher, from which metrics will becollected to push them to the Pushgateway. The collected metrics must notcontain a job label of their own.

For convenience, this method returns a pointer to the Pusher itself.

func (*Pusher)Delete¶added inv0.12.1

func (p *Pusher) Delete()error

Delete sends a “DELETE” request to the Pushgateway configured while creatingthis Pusher, using the configured job name and any added grouping labels asgrouping key. Any added Gatherers and Collectors added to this Pusher areignored by this method.

Delete returns the first error encountered by any method call (including thisone) in the lifetime of the Pusher.

func (*Pusher)Error¶added inv1.13.0

func (p *Pusher) Error()error

Error returns the error that was encountered.

func (*Pusher)Format¶added inv0.9.3

func (p *Pusher) Format(formatexpfmt.Format) *Pusher

Format configures the Pusher to use an encoding format given by theprovided expfmt.Format. The default format is expfmt.FmtProtoDelim andshould be used with the standard Prometheus Pushgateway. Customimplementations may require different formats. For convenience, thismethod returns a pointer to the Pusher itself.

func (*Pusher)Gatherer¶added inv0.9.0

func (p *Pusher) Gatherer(gprometheus.Gatherer) *Pusher

Gatherer adds a Gatherer to the Pusher, from which metrics will be gatheredto push them to the Pushgateway. The gathered metrics must not contain a joblabel of their own.

For convenience, this method returns a pointer to the Pusher itself.

func (*Pusher)Grouping¶added inv0.9.0

func (p *Pusher) Grouping(name, valuestring) *Pusher

Grouping adds a label pair to the grouping key of the Pusher, replacing anypreviously added label pair with the same label name. Note that setting anylabels in the grouping key that are already contained in the metrics to pushwill lead to an error.

For convenience, this method returns a pointer to the Pusher itself.

func (*Pusher)Header¶added inv1.15.0

func (p *Pusher) Header(headerhttp.Header) *Pusher

Header sets a custom HTTP header for the Pusher's client. For convenience, this methodreturns a pointer to the Pusher itself.

func (*Pusher)Push¶added inv0.9.0

func (p *Pusher) Push()error

Push collects/gathers all metrics from all Collectors and Gatherers added tothis Pusher. Then, it pushes them to the Pushgateway configured whilecreating this Pusher, using the configured job name and any added groupinglabels as grouping key. All previously pushed metrics with the same job andother grouping labels will be replaced with the metrics pushed by thiscall. (It uses HTTP method “PUT” to push to the Pushgateway.)

Push returns the first error encountered by any method call (including thisone) in the lifetime of the Pusher.

package mainimport ("fmt""github.com/prometheus/client_golang/prometheus""github.com/prometheus/client_golang/prometheus/push")func main() {completionTime := prometheus.NewGauge(prometheus.GaugeOpts{Name: "db_backup_last_completion_timestamp_seconds",Help: "The timestamp of the last successful completion of a DB backup.",})completionTime.SetToCurrentTime()if err := push.New("http://pushgateway:9091", "db_backup").Collector(completionTime).Grouping("db", "customers").Push(); err != nil {fmt.Println("Could not push completion time to Pushgateway:", err)}}

func (*Pusher)PushContext¶added inv1.13.0

func (p *Pusher) PushContext(ctxcontext.Context)error

PushContext is like Push but includes a context.

If the context expires before HTTP request is complete, an error is returned.