app

Documentation

Index

• type BindingFetcher
• type Config
  • func LoadConfig() Config
• type ForwarderAgent
  • func NewForwarderAgent(cfg Config, m Metrics, log *log.Logger) *ForwarderAgent
  • func (s *ForwarderAgent) Run()
  • func (s *ForwarderAgent) Stop()
• type GRPC
• type Metrics
• type Writer

Types

type BindingFetcher

type BindingFetcher interface {
	FetchBindings() ([]syslog.Binding, error)
}

type Config

type Config struct {
	UseRFC3339 bool `env:"USE_RFC3339"`
	// DownstreamIngressPortCfg will define consumers on localhost that will
	// receive each envelope. It is assumed to adhere to the Loggregator Ingress
	// Service and use the provided TLS configuration.
	DownstreamIngressPortCfg string `env:"DOWNSTREAM_INGRESS_PORT_GLOB, report"`
	GRPC                     GRPC
	MetricsServer            config.MetricsServer
	Tags                     map[string]string `env:"AGENT_TAGS"`
	DebugMetrics             bool              `env:"DEBUG_METRICS, report"`
	EmitOTelTraces           bool              `env:"EMIT_OTEL_TRACES, report"`
	EmitOTelMetrics          bool              `env:"EMIT_OTEL_METRICS, report"`
	EmitOTelLogs             bool              `env:"EMIT_OTEL_LOGS, report"`
}

Config holds the configuration for the forwarder agent

func LoadConfig

func LoadConfig() Config

LoadConfig will load the configuration for the forwarder agent from the environment. If loading the config fails for any reason this function will panic.

type ForwarderAgent

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

ForwarderAgent manages starting the forwarder agent service.

func NewForwarderAgent

func NewForwarderAgent(
	cfg Config,
	m Metrics,
	log *log.Logger,
) *ForwarderAgent

NewForwarderAgent intializes and returns a new forwarder agent.

func (*ForwarderAgent) Run

func (s *ForwarderAgent) Run()

func (*ForwarderAgent) Stop

func (s *ForwarderAgent) Stop()

type GRPC

type GRPC struct {
	Port         uint16   `env:"AGENT_PORT, report"`
	CAFile       string   `env:"AGENT_CA_FILE_PATH, required, report"`
	CertFile     string   `env:"AGENT_CERT_FILE_PATH, required, report"`
	KeyFile      string   `env:"AGENT_KEY_FILE_PATH, required, report"`
	CipherSuites []string `env:"AGENT_CIPHER_SUITES, report"`
}

GRPC stores the configuration for the router as a server using a PORT with mTLS certs and as a client.

type Metrics

type Metrics interface {
	NewGauge(name, helpText string, opts ...metrics.MetricOption) metrics.Gauge
	NewCounter(name, helpText string, opts ...metrics.MetricOption) metrics.Counter
	RegisterDebugMetrics()
}

type Writer

type Writer interface {
	Write(*loggregator_v2.Envelope) error
}