writer

type Compression ¶ added in v0.1.1

type Compression int

Compression is the compression algorithm used on the marshalled data before sending

const (
	// None tells the engine not to compress at all
	None Compression = iota
	// Snappy uses the snappy compression algorithm described at https://github.com/google/snappy
	Snappy
	// Gzip uses the standard Gzip compression algorithm with default compression level
	Gzip
)

func (e Compression) Compress(data []byte) ([]byte, error)

func (e Compression) String() string

func (e Compression) UpdateRequest(req *http.Request)

type Format ¶ added in v0.1.1

type Format int

Format represents the format to which metrics will be marshalled before sending to Prometheus

const (
	// Protobuf serializes to the protobuf description from the Prometheus github repository
	Protobuf Format = iota + 1
	// JSON serializes to standard JSON according to the Prometheus objects' JSON tags
	JSON
)

func (f Format) Marshal(wr prompb.WriteRequest) ([]byte, error)

func (f Format) String() string

func (f Format) UpdateRequest(req *http.Request)

type RemoteMetricsWriter ¶

type RemoteMetricsWriter interface {
	WriteMetrics(context.Context) (int, error)
}

RemoteMetricsWriter knows how to marshal a set of metrics and send them to a remote prometheus endpoint

func NewRemoteMetricsWriter(targetURL string, options RemoteMetricsWriterOptions, gatherers ...prometheus.Gatherer) (RemoteMetricsWriter, error)

type RemoteMetricsWriterOptions ¶

type RemoteMetricsWriterOptions struct {
	HTTPClient         *http.Client
	Format             Format
	Compression        Compression
	RemoteWriteVersion string
}

RemoteMetricsWriterOptions are the optional settings for a RemoteMetricsWriter.

If HTTPClient is not set, http.DefaultClient is used
If Format is not set, it defaults to Protobuf
If Compression is not set, it defaults to None
If RemoteWriteVersion is not set, it defaults to DefaultRemoteWriteVersion (0.1.0, currently). This should never change