remote

Documentation

Overview

Package remote is a generated protocol buffer package.

It is generated from these files:

remote.proto

It has these top-level messages:

Sample
LabelPair
TimeSeries
WriteRequest

Index

• type Client
  • func NewClient(conf config.RemoteWriteConfig) (*Client, error)
  • func (c Client) Name() string
  • func (c *Client) Store(samples model.Samples) error
• type LabelPair
  • func (*LabelPair) Descriptor() ([]byte, []int)
  • func (*LabelPair) ProtoMessage()
  • func (m *LabelPair) Reset()
  • func (m *LabelPair) String() string
• type Options
• type ReloadableStorage
  • func NewConfigurable() *ReloadableStorage
  • func (s *ReloadableStorage) Append(smpl *model.Sample) error
  • func (s *ReloadableStorage) ApplyConfig(conf *config.Config) error
  • func (s *ReloadableStorage) NeedsThrottling() bool
  • func (s *ReloadableStorage) Stop()
• type Sample
  • func (*Sample) Descriptor() ([]byte, []int)
  • func (*Sample) ProtoMessage()
  • func (m *Sample) Reset()
  • func (m *Sample) String() string
• type Storage
  • func New(o *Options) (*Storage, error)
  • func (s *Storage) Append(smpl *model.Sample) error
  • func (s *Storage) ApplyConfig(conf *config.Config) error
  • func (s *Storage) NeedsThrottling() bool
  • func (s *Storage) Start()
  • func (s *Storage) Stop()
• type StorageClient
• type StorageQueueManager
  • func NewStorageQueueManager(tsdb StorageClient, cfg *StorageQueueManagerConfig) *StorageQueueManager
  • func (t *StorageQueueManager) Append(s *model.Sample) error
  • func (*StorageQueueManager) NeedsThrottling() bool
  • func (t *StorageQueueManager) Start()
  • func (t *StorageQueueManager) Stop()
• type StorageQueueManagerConfig
• type TimeSeries
  • func (*TimeSeries) Descriptor() ([]byte, []int)
  • func (m *TimeSeries) GetLabels() []*LabelPair
  • func (m *TimeSeries) GetSamples() []*Sample
  • func (*TimeSeries) ProtoMessage()
  • func (m *TimeSeries) Reset()
  • func (m *TimeSeries) String() string
• type WriteRequest
  • func (*WriteRequest) Descriptor() ([]byte, []int)
  • func (m *WriteRequest) GetTimeseries() []*TimeSeries
  • func (*WriteRequest) ProtoMessage()
  • func (m *WriteRequest) Reset()
  • func (m *WriteRequest) String() string

Types

type Client

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

Client allows sending batches of Prometheus samples to an HTTP endpoint.

func NewClient

func NewClient(conf config.RemoteWriteConfig) (*Client, error)

NewClient creates a new Client.

func (Client) Name

func (c Client) Name() string

Name identifies the client as a generic client.

func (*Client) Store

func (c *Client) Store(samples model.Samples) error

Store sends a batch of samples to the HTTP endpoint.

type LabelPair

type LabelPair struct {
	Name  string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

func (*LabelPair) Descriptor

func (*LabelPair) Descriptor() ([]byte, []int)

func (*LabelPair) ProtoMessage

func (*LabelPair) ProtoMessage()

func (*LabelPair) Reset

func (m *LabelPair) Reset()

func (*LabelPair) String

func (m *LabelPair) String() string

type Options

type Options struct {
	StorageTimeout          time.Duration
	InfluxdbURL             *url.URL
	InfluxdbRetentionPolicy string
	InfluxdbUsername        string
	InfluxdbPassword        string
	InfluxdbDatabase        string
	OpentsdbURL             string
	GraphiteAddress         string
	GraphiteTransport       string
	GraphitePrefix          string
}

Options contains configuration parameters for a remote storage.

type ReloadableStorage

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

Storage collects multiple remote storage queues.

func NewConfigurable

func NewConfigurable() *ReloadableStorage

New returns a new remote Storage.

func (*ReloadableStorage) Append

func (s *ReloadableStorage) Append(smpl *model.Sample) error

Append implements storage.SampleAppender. Always returns nil.

func (*ReloadableStorage) ApplyConfig

func (s *ReloadableStorage) ApplyConfig(conf *config.Config) error

ApplyConfig updates the state as the new config requires.

func (*ReloadableStorage) NeedsThrottling

func (s *ReloadableStorage) NeedsThrottling() bool

NeedsThrottling implements storage.SampleAppender. It will always return false as a remote storage drops samples on the floor if backlogging instead of asking for throttling.

func (*ReloadableStorage) Stop

func (s *ReloadableStorage) Stop()

Stop the background processing of the storage queues.

type Sample

type Sample struct {
	Value       float64 `protobuf:"fixed64,1,opt,name=value" json:"value,omitempty"`
	TimestampMs int64   `protobuf:"varint,2,opt,name=timestamp_ms,json=timestampMs" json:"timestamp_ms,omitempty"`
}

func (*Sample) Descriptor

func (*Sample) Descriptor() ([]byte, []int)

func (*Sample) ProtoMessage

func (*Sample) ProtoMessage()

func (*Sample) Reset

func (m *Sample) Reset()

func (*Sample) String

func (m *Sample) String() string

type Storage

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

Storage collects multiple remote storage queues.

func New

func New(o *Options) (*Storage, error)

New returns a new remote Storage.

func (*Storage) Append

func (s *Storage) Append(smpl *model.Sample) error

Append implements storage.SampleAppender. Always returns nil.

func (*Storage) ApplyConfig

func (s *Storage) ApplyConfig(conf *config.Config) error

ApplyConfig updates the status state as the new config requires.

func (*Storage) NeedsThrottling

func (s *Storage) NeedsThrottling() bool

NeedsThrottling implements storage.SampleAppender. It will always return false as a remote storage drops samples on the floor if backlogging instead of asking for throttling.

func (*Storage) Start

func (s *Storage) Start()

Start starts the background processing of the storage queues.

func (*Storage) Stop

func (s *Storage) Stop()

Stop the background processing of the storage queues.

type StorageClient

type StorageClient interface {
	// Store stores the given samples in the remote storage.
	Store(model.Samples) error
	// Name identifies the remote storage implementation.
	Name() string
}

StorageClient defines an interface for sending a batch of samples to an external timeseries database.

type StorageQueueManager

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

StorageQueueManager manages a queue of samples to be sent to the Storage indicated by the provided StorageClient.

func NewStorageQueueManager

func NewStorageQueueManager(tsdb StorageClient, cfg *StorageQueueManagerConfig) *StorageQueueManager

NewStorageQueueManager builds a new StorageQueueManager.

func (*StorageQueueManager) Append

func (t *StorageQueueManager) Append(s *model.Sample) error

Append queues a sample to be sent to the remote storage. It drops the sample on the floor if the queue is full. Always returns nil.

func (*StorageQueueManager) NeedsThrottling

func (*StorageQueueManager) NeedsThrottling() bool

NeedsThrottling implements storage.SampleAppender. It will always return false as a remote storage drops samples on the floor if backlogging instead of asking for throttling.

func (*StorageQueueManager) Start

func (t *StorageQueueManager) Start()

Start the queue manager sending samples to the remote storage. Does not block.

func (*StorageQueueManager) Stop

func (t *StorageQueueManager) Stop()

Stop stops sending samples to the remote storage and waits for pending sends to complete.

type StorageQueueManagerConfig

type StorageQueueManagerConfig struct {
	QueueCapacity     int           // Number of samples to buffer per shard before we start dropping them.
	Shards            int           // Number of shards, i.e. amount of concurrency.
	MaxSamplesPerSend int           // Maximum number of samples per send.
	BatchSendDeadline time.Duration // Maximum time sample will wait in buffer.
}

type TimeSeries

type TimeSeries struct {
	Labels []*LabelPair `protobuf:"bytes,1,rep,name=labels" json:"labels,omitempty"`
	// Sorted by time, oldest sample first.
	Samples []*Sample `protobuf:"bytes,2,rep,name=samples" json:"samples,omitempty"`
}

func (*TimeSeries) Descriptor

func (*TimeSeries) Descriptor() ([]byte, []int)

func (*TimeSeries) GetLabels

func (m *TimeSeries) GetLabels() []*LabelPair

func (*TimeSeries) GetSamples

func (m *TimeSeries) GetSamples() []*Sample

func (*TimeSeries) ProtoMessage

func (*TimeSeries) ProtoMessage()

func (*TimeSeries) Reset

func (m *TimeSeries) Reset()

func (*TimeSeries) String

func (m *TimeSeries) String() string

type WriteRequest

type WriteRequest struct {
	Timeseries []*TimeSeries `protobuf:"bytes,1,rep,name=timeseries" json:"timeseries,omitempty"`
}

func (*WriteRequest) Descriptor

func (*WriteRequest) Descriptor() ([]byte, []int)

func (*WriteRequest) GetTimeseries

func (m *WriteRequest) GetTimeseries() []*TimeSeries

func (*WriteRequest) ProtoMessage

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) Reset

func (m *WriteRequest) Reset()

func (*WriteRequest) String

func (m *WriteRequest) String() string