receiver

Documentation

Index

• type Arguments
  • func (args *Arguments) SetToDefault()
• type Component
  • func New(o component.Options, args Arguments) (*Component, error)
  • func (c *Component) CurrentHealth() component.Health
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(args component.Arguments) error
• type LocationArguments
• type LogFormat
  • func (ll LogFormat) MarshalText() (text []byte, err error)
  • func (ll *LogFormat) UnmarshalText(text []byte) error
• type OutputArguments
• type RateLimitingArguments
  • func (r *RateLimitingArguments) SetToDefault()
• type ServerArguments
  • func (s *ServerArguments) SetToDefault()
• type SourceMapsArguments
  • func (s *SourceMapsArguments) SetToDefault()

Types

type Arguments

type Arguments struct {
	LogLabels map[string]string `alloy:"extra_log_labels,attr,optional"`
	LogFormat LogFormat         `alloy:"log_format,attr,optional"`

	Server     ServerArguments     `alloy:"server,block,optional"`
	SourceMaps SourceMapsArguments `alloy:"sourcemaps,block,optional"`
	Output     OutputArguments     `alloy:"output,block"`
}

Arguments configures the app_agent_receiver component.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault applies default settings.

type Component

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

func New

func New(o component.Options, args Arguments) (*Component, error)

func (*Component) CurrentHealth

func (c *Component) CurrentHealth() component.Health

CurrentHealth implements component.HealthComponent. It returns an unhealthy status if the server has terminated.

func (*Component) Run

func (c *Component) Run(ctx context.Context) error

func (*Component) Update

func (c *Component) Update(args component.Arguments) error

type LocationArguments

type LocationArguments struct {
	Path               string `alloy:"path,attr"`
	MinifiedPathPrefix string `alloy:"minified_path_prefix,attr"`
}

LocationArguments specifies an individual location where source maps will be loaded.

type LogFormat

type LogFormat string

const (
	FormatLogfmt LogFormat = "logfmt"
	FormatJSON   LogFormat = "json"

	FormatDefault = FormatLogfmt
)

func (LogFormat) MarshalText

func (ll LogFormat) MarshalText() (text []byte, err error)

func (*LogFormat) UnmarshalText

func (ll *LogFormat) UnmarshalText(text []byte) error

type OutputArguments

type OutputArguments struct {
	Logs   []loki.LogsReceiver `alloy:"logs,attr,optional"`
	Traces []otelcol.Consumer  `alloy:"traces,attr,optional"`
}

OutputArguments configures where to send emitted logs and traces. Metrics emitted by app_agent_receiver are exported as targets to be scraped.

type RateLimitingArguments

type RateLimitingArguments struct {
	Enabled   bool    `alloy:"enabled,attr,optional"`
	Rate      float64 `alloy:"rate,attr,optional"`
	BurstSize float64 `alloy:"burst_size,attr,optional"`
}

RateLimitingArguments configures rate limiting for the HTTP server.

func (*RateLimitingArguments) SetToDefault

func (r *RateLimitingArguments) SetToDefault()

type ServerArguments

type ServerArguments struct {
	Host                  string            `alloy:"listen_address,attr,optional"`
	Port                  int               `alloy:"listen_port,attr,optional"`
	CORSAllowedOrigins    []string          `alloy:"cors_allowed_origins,attr,optional"`
	APIKey                alloytypes.Secret `alloy:"api_key,attr,optional"`
	MaxAllowedPayloadSize units.Base2Bytes  `alloy:"max_allowed_payload_size,attr,optional"`

	RateLimiting    RateLimitingArguments `alloy:"rate_limiting,block,optional"`
	IncludeMetadata bool                  `alloy:"include_metadata,attr,optional"`
}

ServerArguments configures the HTTP server where telemetry information will be sent from Faro clients.

func (*ServerArguments) SetToDefault

func (s *ServerArguments) SetToDefault()

type SourceMapsArguments

type SourceMapsArguments struct {
	Download            bool                `alloy:"download,attr,optional"`
	DownloadFromOrigins []string            `alloy:"download_from_origins,attr,optional"`
	DownloadTimeout     time.Duration       `alloy:"download_timeout,attr,optional"`
	Locations           []LocationArguments `alloy:"location,block,optional"`
}

SourceMapsArguments configures how app_agent_receiver will retrieve source maps for transforming stack traces.

func (*SourceMapsArguments) SetToDefault

func (s *SourceMapsArguments) SetToDefault()