write

package
v1.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2025 License: Apache-2.0 Imports: 36 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	DefaultArguments = func() Arguments {
		return Arguments{
			Tracing: TracingOptions{
				JaegerPropagator:       true,
				TraceContextPropagator: true,
			},
		}
	}
)

Functions

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  `alloy:"external_labels,attr,optional"`
	Endpoints      []*EndpointOptions `alloy:"endpoint,block,optional"`
	Tracing        TracingOptions     `alloy:"tracing,block,optional"`
}

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

func (*Arguments) SetToDefault

func (rc *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

type Component

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

Component is the pyroscope.write component.

func New

func New(
	logger log.Logger,
	tracer trace.Tracer,
	reg prometheus.Registerer,
	onStateChange func(Exports),
	userAgent, uid string,
	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                   `alloy:"name,attr,optional"`
	URL               string                   `alloy:"url,attr"`
	RemoteTimeout     time.Duration            `alloy:"remote_timeout,attr,optional"`
	Headers           map[string]string        `alloy:"headers,attr,optional"`
	HTTPClientConfig  *config.HTTPClientConfig `alloy:",squash"`
	MinBackoff        time.Duration            `alloy:"min_backoff_period,attr,optional"`  // start backoff at this level
	MaxBackoff        time.Duration            `alloy:"max_backoff_period,attr,optional"`  // increase exponentially to this level
	MaxBackoffRetries int                      `alloy:"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 syntax.Defaulter.

func (*EndpointOptions) Validate

func (r *EndpointOptions) Validate() error

Validate implements syntax.Validator.

type Exports

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

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

type PyroscopeWriteError added in v1.5.0

type PyroscopeWriteError struct {
	Message    string
	StatusCode int
}

func (*PyroscopeWriteError) Error added in v1.5.0

func (e *PyroscopeWriteError) Error() string

type TracingOptions added in v1.11.0

type TracingOptions struct {
	JaegerPropagator       bool `alloy:"jaeger_propagator,attr,optional"`
	TraceContextPropagator bool `alloy:"trace_context_propagator,attr,optional"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL