receivers

Documentation

Overview

Package receivers holds the type of receivers that consul telemetery supports

Package receivers holds the type of receivers that consul telemetery supports

Package receivers holds the type of receivers that consul telemetery supports

Index

• Variables
• func EnvoyReceiverCfg(listenerPort int) *envoyreceiver.Config
• type Config
• type HTTPConfig
• type OtlpReceiverConfig
  • func OtlpReceiverCfg() *OtlpReceiverConfig
• type PrometheusConfig
  • func PrometheusReceiverCfg(metricsPort int) *PrometheusConfig
• type Protocols
• type ScrapeConfig
• type StaticConfig

Variables

var EnvoyReceiverID component.ID = component.NewID(envoyreceiver.ID)

EnvoyReceiverID is the component id of the otlp receiver.

var OtlpReceiverID component.ID = component.NewID(otlpReceiverName)

OtlpReceiverID is the component id of the otlp receiver.

var PrometheusReceiverID component.ID = component.NewID(prometheusReceiverName)

PrometheusReceiverID is the component id of the prometheus receiver.

Functions

func EnvoyReceiverCfg

func EnvoyReceiverCfg(listenerPort int) *envoyreceiver.Config

EnvoyReceiverCfg generates the config for an otlp receiver.

Types

type Config

type Config struct {
	GRPC *configgrpc.GRPCServerSettings `mapstructure:"grpc,omitempty"`
}

Config is the configuration for the supported protocols.

type HTTPConfig

type HTTPConfig struct {
	// Endpoint configures the listening address for the server.
	Endpoint string `mapstructure:"endpoint"`

	// TLSSetting struct exposes TLS client configuration.
	TLSSetting *types.TLSServerSetting `mapstructure:"tls"`

	// CORS configures the server for HTTP cross-origin resource sharing (CORS).
	CORS *confighttp.CORSSettings `mapstructure:"cors"`

	// Auth for this receiver
	Auth *configauth.Authentication `mapstructure:"auth"`

	// MaxRequestBodySize sets the maximum request body size in bytes
	MaxRequestBodySize int64 `mapstructure:"max_request_body_size"`

	// IncludeMetadata propagates the client metadata from the incoming requests to the downstream consumers
	// Experimental: *NOTE* this option is subject to change or removal in the future.
	IncludeMetadata bool `mapstructure:"include_metadata"`

	// Additional headers attached to each HTTP response sent to the client.
	// Header values are opaque since they may be sensitive.
	ResponseHeaders map[string]string `mapstructure:"response_headers"`
	// The URL path to receive traces on. If omitted "/v1/traces" will be used.
	TracesURLPath string `mapstructure:"traces_url_path,omitempty"`

	// The URL path to receive metrics on. If omitted "/v1/metrics" will be used.
	MetricsURLPath string `mapstructure:"metrics_url_path,omitempty"`

	// The URL path to receive logs on. If omitted "/v1/logs" will be used.
	LogsURLPath string `mapstructure:"logs_url_path,omitempty"`
}

HTTPConfig is the HTTPConfig type used to build the http settings for the receiver

type OtlpReceiverConfig

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

OtlpReceiverConfig defines configuration for OTLP receiver.

func OtlpReceiverCfg

func OtlpReceiverCfg() *OtlpReceiverConfig

OtlpReceiverCfg generates the config for an otlp receiver.

type PrometheusConfig

type PrometheusConfig struct {
	// We'll probably want to make this a little more generic in the future if we scrape more targets
	Config map[string][]ScrapeConfig `mapstructure:"config"`
}

PrometheusConfig is the highest container for a prometheus config

func PrometheusReceiverCfg

func PrometheusReceiverCfg(metricsPort int) *PrometheusConfig

PrometheusReceiverCfg generates the prometheus config for scraping the local telemetry-collector metrics

type Protocols

type Protocols struct {
	GRPC *configgrpc.GRPCServerSettings `mapstructure:"grpc,omitempty"`
	HTTP *HTTPConfig                    `mapstructure:"http,omitempty"`
}

Protocols is the configuration for the supported protocols.

type ScrapeConfig

type ScrapeConfig struct {
	JobName        string         `mapstructure:"job_name"`
	ScrapeInterval string         `mapstructure:"scrape_interval"`
	StaticConfigs  []StaticConfig `mapstructure:"static_configs,omitempty"`
}

ScrapeConfig matches a single minimal scrape configs for prometheus

type StaticConfig

type StaticConfig struct {
	Targets []string `mapstructure:"targets"`
}

StaticConfig a minimal prometheus static scrape config