write

Documentation

Index

• Variables
• func NewFanOut(opts component.Options, config Arguments, metrics *metrics) (*fanOutClient, error)
• func WithUserAgent(agent string) connect.ClientOption
• type Arguments
  • func (rc *Arguments) SetToDefault()
• type Component
  • func New(o component.Options, c Arguments) (*Component, error)
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(newConfig component.Arguments) error
• type EndpointOptions
  • func GetDefaultEndpointOptions() EndpointOptions
  • func (r *EndpointOptions) SetToDefault()
  • func (r *EndpointOptions) Validate() error
• type Exports

Variables

var (
	DefaultArguments = func() Arguments {
		return Arguments{}
	}
)

Functions

func NewFanOut

func NewFanOut(opts component.Options, config Arguments, metrics *metrics) (*fanOutClient, error)

NewFanOut creates a new fan out client that will fan out to all endpoints.

func WithUserAgent

func WithUserAgent(agent string) connect.ClientOption

WithUserAgent returns a `connect.ClientOption` that sets the User-Agent header on.

Types

type Arguments

type Arguments struct {
	ExternalLabels map[string]string  `river:"external_labels,attr,optional"`
	Endpoints      []*EndpointOptions `river:"endpoint,block,optional"`
}

Arguments represents the input state of the pyroscope.write component.

func (*Arguments) SetToDefault

func (rc *Arguments) SetToDefault()

SetToDefault implements river.Defaulter.

type Component

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

Component is the pyroscope.write component.

func New

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

New creates a new pyroscope.write component.

func (*Component) Run

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

Run implements Component.

func (*Component) Update

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

Update implements Component.

type EndpointOptions

type EndpointOptions struct {
	Name              string                   `river:"name,attr,optional"`
	URL               string                   `river:"url,attr"`
	RemoteTimeout     time.Duration            `river:"remote_timeout,attr,optional"`
	Headers           map[string]string        `river:"headers,attr,optional"`
	HTTPClientConfig  *config.HTTPClientConfig `river:",squash"`
	MinBackoff        time.Duration            `river:"min_backoff_period,attr,optional"`  // start backoff at this level
	MaxBackoff        time.Duration            `river:"max_backoff_period,attr,optional"`  // increase exponentially to this level
	MaxBackoffRetries int                      `river:"max_backoff_retries,attr,optional"` // give up after this many; zero means infinite retries
}

EndpointOptions describes an individual location for where profiles should be delivered to using the Pyroscope push API.

func GetDefaultEndpointOptions

func GetDefaultEndpointOptions() EndpointOptions

func (*EndpointOptions) SetToDefault

func (r *EndpointOptions) SetToDefault()

SetToDefault implements river.Defaulter.

func (*EndpointOptions) Validate

func (r *EndpointOptions) Validate() error

Validate implements river.Validator.

type Exports

type Exports struct {
	Receiver pyroscope.Appendable `river:"receiver,attr"`
}

Exports are the set of fields exposed by the pyroscope.write component.