promremote

promremote is a Prometheus remote write client written in Go.

Installation

go get -u github.com/m3db/prometheus_remote_client_golang

Use

promremote is used to send metrics to a Prometheus remote write endpoint such as supported by m3coordinator. It can be pulled into an existing codebase as a client library or used as a cli tool (cmd/main.go) for ad hoc testing purposes.

IMPORTANT: A running program or application that has a Prometheus remote write endpoint is required.

Client library

To use promremote as a client library, the client must be constructed manually using structs.

// create config and client
cfg := promremote.NewConfig(
  promremote.WriteURLOption(writeURLFlag),
  promremote.HTTPClientTimeoutOption(60 * time.Second),
  promremote.UserAgent(userAgent),
)

client, err := promremote.NewClient(cfg)
if err != nil {
  log.Fatal(fmt.Errorf("unable to construct client: %v", err))
}


timeSeriesList := []promremote.TimeSeries{
		promremote.TimeSeries{
			Labels: []promremote.Label{
				{
					Name:  "__name__",
					Value: "foo_bar",
				},
				{
					Name:  "biz",
					Value: "baz",
				},
			},
			Datapoint: promremote.Datapoint{
				Timestamp: time.Now(),
				Value:     1415.92,
			},
		},
	}

if err := client.WriteTimeSeries(timeSeriesList); err != nil {
	log.Fatal(err)
}

CLI

If one wants to use promremote as a CLI, he or she can utilize the tool located in the cmd/ directory. The tool takes in a series of labels and a datapoint then writes them to a Prometheus remote write endpoint. Below is an example showing a metric with two labels (__name__:foo_bar and biz:baz) and a datapoint (timestamp:now value:1415.92).

Note: One can either specify a Unix timestamp (e.g. 1556026725) or the keyword now as the first parameter in the -d flag.

go run cmd/promremotecli/main.go -t=__name__:foo_bar -t=biz:baz -d=now,1415.92