prometheusremotewritereceiver

README

Prometheus Remote Write Receiver

Status
Stability	[inDevelopment]
Supported pipeline types	metrics
Distributions	[contrib]

Supported pipeline types: metrics

Getting Started

All that is required to enable the Prometheus Remote Write receiver is to include it in the receiver definitions.

receivers:
  prometheusremotewrite:
    time_threshold: 24
    protocols:
      http:

Http Server configuration settings:

• endpoint (default = 0.0.0.0:19291): host:port to which the receiver is going to receive data.

Additional server settings are mentioned here: https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp#server-configuration

• time_threshold (default = 24) - time threshold (in hours). All timeseries older than limit will be dropped.

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (cfg *Config) Unmarshal(conf *confmap.Conf) error
  • func (cfg *Config) Validate() error
• type PrometheusRemoteWriteReceiver
  • func NewReceiver(settings receiver.CreateSettings, config *Config, consumer consumer.Metrics) (*PrometheusRemoteWriteReceiver, error)
  • func (rec *PrometheusRemoteWriteReceiver) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (rec *PrometheusRemoteWriteReceiver) Shutdown(context.Context) error
  • func (rec *PrometheusRemoteWriteReceiver) Start(_ context.Context, host component.Host) error
• type Protocols

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory return a new receiver.Factory for receiver.

Types

type Config

type Config struct {
	// Protocols is the configuration for the supported protocols, currently gRPC and HTTP (Proto and JSON).
	Protocols     `mapstructure:"protocols"`
	TimeThreshold int64 `mapstructure:"time_threshold"`
}

Config defines configuration for the receiver.

func (*Config) Unmarshal

func (cfg *Config) Unmarshal(conf *confmap.Conf) error

Unmarshal a confmap.Conf into the config struct.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks the receiver configuration is valid

type PrometheusRemoteWriteReceiver

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

PrometheusRemoteWriteReceiver - remote write

func NewReceiver

func NewReceiver(settings receiver.CreateSettings, config *Config, consumer consumer.Metrics) (*PrometheusRemoteWriteReceiver, error)

NewReceiver - remote write

func (*PrometheusRemoteWriteReceiver) ServeHTTP

func (rec *PrometheusRemoteWriteReceiver) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*PrometheusRemoteWriteReceiver) Shutdown

func (rec *PrometheusRemoteWriteReceiver) Shutdown(context.Context) error

Shutdown - remote write

func (*PrometheusRemoteWriteReceiver) Start

func (rec *PrometheusRemoteWriteReceiver) Start(_ context.Context, host component.Host) error

Start - remote write

type Protocols

type Protocols struct {
	GRPC *configgrpc.GRPCServerSettings `mapstructure:"grpc"`
	HTTP *confighttp.HTTPServerSettings `mapstructure:"http"`
}

Protocols is the configuration for the supported protocols.