signalfxgatewayprometheusremotewritereceiver

README

SignalFx Gateway Prometheus remote write receiver

This receiver aims to be an otel-native version of our signalfx prometheus remote write gateway.

Known limitations

This receiver obsoletes the near-exact behavior of the SignalFx Prometheus Remote-Writegateway. The behavior of the Prometheus Remote-Write gateway predates the formalization of the Prometheus Remote-Write specification version 1, and differs in the following ways:

• The receiver doesn't remove suffixes as this is done in the otel-contrib prometheusreceiver.
• The receiver transforms histograms into counters.
• The receiver transforms quantiles (summaries) into gauges.
• If the representation of a float can be expressed as an integer without loss, the receiver sets the representation of a float as an integer.
• If the representation of a sample is NaN, the receiver reports an additional counter with the metric name "prometheus.total_NAN_samples".
• If the representation of a sample is missing a metric name, the receiver reports an additional counter with the metric name "prometheus.total_bad_datapoints".
• Any errors in parsing the request report an additional counter, "prometheus.invalid_requests".
• Metadata from the prompb.WriteRequest is ignored. The following behavior from sfx gateway is not supported:
• "request_time.ns" is no longer reported. obsreport handles similar functionality.
• "drain_size" is no longer reported. obsreport handles similar functionality.

Receiver configuration

This receiver is configured through standard OpenTelemetry mechanisms. See config.go for details.

• path is the path in which the receiver responds to prometheus remote-write requests. The default values is /metrics.
• buffer_size is the degree to which metric translations can be buffered without blocking further write requests. The default value is 100. This receiver uses opentelemetry-collector's confighttp options if you want to set up TLS and other features. However, the receiver makes the following changes to upstream default options:
• endpoint is the default interface and port to listen on. The default value is localhost:19291.

If everything is configured properly, logs with sample writes should start appearing in stdout shortly.

Documentation

Index

• func DecodeWriteRequest(r io.Reader) (*prompb.WriteRequest, error)
• func NewFactory() receiver.Factory
• type Config
  • func (c *Config) Validate() error

Functions

func DecodeWriteRequest

func DecodeWriteRequest(r io.Reader) (*prompb.WriteRequest, error)

DecodeWriteRequest from an io.Reader into a prompb.WriteRequest, handling snappy decompression.

func NewFactory

func NewFactory() receiver.Factory

Types

type Config

type Config struct {
	ListenPath              string `mapstructure:"path"`
	confighttp.ServerConfig `mapstructure:",squash"`
	BufferSize              int `mapstructure:"buffer_size"`
}

func (*Config) Validate

func (c *Config) Validate() error