 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( DefaultArguments = Arguments{ WALOptions: DefaultWALOptions, } DefaultQueueOptions = QueueOptions{ Capacity: 10000, MaxShards: 50, MinShards: 1, MaxSamplesPerSend: 2000, BatchSendDeadline: 5 * time.Second, MinBackoff: 30 * time.Millisecond, MaxBackoff: 5 * time.Second, RetryOnHTTP429: true, SampleAgeLimit: 0, } DefaultMetadataOptions = MetadataOptions{ Send: true, SendInterval: 1 * time.Minute, MaxSamplesPerSend: 2000, } DefaultWALOptions = WALOptions{ TruncateFrequency: 2 * time.Hour, MinKeepaliveTime: 5 * time.Minute, MaxKeepaliveTime: 8 * time.Hour, } )
Defaults for config blocks.
Functions ¶
func InstallTools ¶
InstallTools installs command line utilities as subcommands of the provided cmd.
Types ¶
type Arguments ¶
type Arguments struct {
	ExternalLabels map[string]string  `alloy:"external_labels,attr,optional"`
	Endpoints      []*EndpointOptions `alloy:"endpoint,block,optional"`
	WALOptions     WALOptions         `alloy:"wal,block,optional"`
}
    Arguments represents the input state of the prometheus.remote_write component.
func (*Arguments) SetToDefault ¶
func (rc *Arguments) SetToDefault()
SetToDefault implements syntax.Defaulter.
type AzureADConfig ¶
type AzureADConfig struct {
	// ManagedIdentity is the managed identity that is being used to authenticate.
	ManagedIdentity *ManagedIdentityConfig `alloy:"managed_identity,block,optional"`
	// OAuth is the oauth config that is being used to authenticate.
	OAuth *OAuthConfig `alloy:"oauth,block,optional"`
	// SDK is the SDK config that is being used to authenticate.
	SDK *SDKConfig `alloy:"sdk,block,optional"`
	// Cloud is the Azure cloud in which the service is running. Example: AzurePublic/AzureGovernment/AzureChina.
	Cloud string `alloy:"cloud,attr,optional"`
}
    func (*AzureADConfig) SetToDefault ¶
func (a *AzureADConfig) SetToDefault()
SetToDefault implements syntax.Defaulter.
func (*AzureADConfig) Validate ¶
func (a *AzureADConfig) Validate() error
type Component ¶
type Component struct {
	// contains filtered or unexported fields
}
    Component is the prometheus.remote_write component.
func (*Component) LiveDebugging ¶ added in v1.7.0
func (c *Component) LiveDebugging()
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"`
	SendExemplars        bool                    `alloy:"send_exemplars,attr,optional"`
	SendNativeHistograms bool                    `alloy:"send_native_histograms,attr,optional"`
	HTTPClientConfig     *types.HTTPClientConfig `alloy:",squash"`
	QueueOptions         *QueueOptions           `alloy:"queue_config,block,optional"`
	MetadataOptions      *MetadataOptions        `alloy:"metadata_config,block,optional"`
	WriteRelabelConfigs  []*alloy_relabel.Config `alloy:"write_relabel_config,block,optional"`
	SigV4                *SigV4Config            `alloy:"sigv4,block,optional"`
	AzureAD              *AzureADConfig          `alloy:"azuread,block,optional"`
}
    EndpointOptions describes an individual location for where metrics in the WAL should be delivered to using the remote_write protocol.
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 storage.Appendable `alloy:"receiver,attr"`
}
    Exports are the set of fields exposed by the prometheus.remote_write component.
type ManagedIdentityConfig ¶
type ManagedIdentityConfig struct {
	// ClientID is the clientId of the managed identity that is being used to authenticate.
	ClientID string `alloy:"client_id,attr"`
}
    ManagedIdentityConfig is used to store managed identity config values
type MetadataOptions ¶
type MetadataOptions struct {
	Send              bool          `alloy:"send,attr,optional"`
	SendInterval      time.Duration `alloy:"send_interval,attr,optional"`
	MaxSamplesPerSend int           `alloy:"max_samples_per_send,attr,optional"`
}
    MetadataOptions configures how metadata gets sent over the remote_write protocol.
func (*MetadataOptions) SetToDefault ¶
func (o *MetadataOptions) SetToDefault()
SetToDefault implements syntax.Defaulter.
type OAuthConfig ¶ added in v1.7.0
type OAuthConfig struct {
	// ClientID is the clientId of the azure active directory application that is being used to authenticate.
	ClientID string `alloy:"client_id,attr"`
	// ClientSecret is the clientSecret of the azure active directory application that is being used to authenticate.
	ClientSecret alloytypes.Secret `alloy:"client_secret,attr"`
	// TenantID is the tenantId of the azure active directory application that is being used to authenticate.
	TenantID string `alloy:"tenant_id,attr"`
}
    OAuthConfig is used to store azure oauth config values.
type QueueOptions ¶
type QueueOptions struct {
	Capacity          int           `alloy:"capacity,attr,optional"`
	MaxShards         int           `alloy:"max_shards,attr,optional"`
	MinShards         int           `alloy:"min_shards,attr,optional"`
	MaxSamplesPerSend int           `alloy:"max_samples_per_send,attr,optional"`
	BatchSendDeadline time.Duration `alloy:"batch_send_deadline,attr,optional"`
	MinBackoff        time.Duration `alloy:"min_backoff,attr,optional"`
	MaxBackoff        time.Duration `alloy:"max_backoff,attr,optional"`
	RetryOnHTTP429    bool          `alloy:"retry_on_http_429,attr,optional"`
	SampleAgeLimit    time.Duration `alloy:"sample_age_limit,attr,optional"`
}
    QueueOptions handles the low level queue config options for a remote_write
func (*QueueOptions) SetToDefault ¶
func (r *QueueOptions) SetToDefault()
SetToDefault implements syntax.Defaulter.
type SDKConfig ¶ added in v1.7.0
type SDKConfig struct {
	// TenantID is the tenantId of the azure active directory application that is being used to authenticate.
	TenantID string `alloy:"tenant_id,attr"`
}
    SDKConfig is used to store azure SDK config values.
type SigV4Config ¶
type SigV4Config struct {
	Region    string            `alloy:"region,attr,optional"`
	AccessKey string            `alloy:"access_key,attr,optional"`
	SecretKey alloytypes.Secret `alloy:"secret_key,attr,optional"`
	Profile   string            `alloy:"profile,attr,optional"`
	RoleARN   string            `alloy:"role_arn,attr,optional"`
}
    func (*SigV4Config) Validate ¶
func (s *SigV4Config) Validate() error
type WALOptions ¶
type WALOptions struct {
	TruncateFrequency time.Duration `alloy:"truncate_frequency,attr,optional"`
	MinKeepaliveTime  time.Duration `alloy:"min_keepalive_time,attr,optional"`
	MaxKeepaliveTime  time.Duration `alloy:"max_keepalive_time,attr,optional"`
}
    WALOptions configures behavior within the WAL.
func (*WALOptions) SetToDefault ¶
func (o *WALOptions) SetToDefault()
SetToDefault implements syntax.Defaulter.
func (*WALOptions) Validate ¶
func (o *WALOptions) Validate() error
Validate implements syntax.Validator.