dimensions

Documentation

Index

• Constants
• type DimensionClient
  • func NewDimensionClient(ctx context.Context, options DimensionClientOptions) *DimensionClient
  • func (dc *DimensionClient) PushMetadata(metadata []*metadata.MetadataUpdate) error
  • func (dc *DimensionClient) Start()
• type DimensionClientOptions
• type DimensionKey
  • func (dk DimensionKey) String() string
• type DimensionUpdate
  • func (d *DimensionUpdate) Key() DimensionKey
  • func (d *DimensionUpdate) String() string
• type MetadataUpdateClient
• type ReqSender
  • func NewReqSender(ctx context.Context, client *http.Client, workerCount uint, ...) *ReqSender
  • func (rs *ReqSender) Send(req *http.Request)
• type RequestFailedCallback
• type RequestSuccessCallback

Constants

const RequestFailedCallbackKey key = 1

const RequestSuccessCallbackKey key = 2

Types

type DimensionClient

type DimensionClient struct {
	sync.RWMutex

	Token  configopaque.String
	APIURL *url.URL

	// ExcludeProperties will filter DimensionUpdate content to not submit undesired metadata.
	ExcludeProperties []dpfilters.PropertyFilter
	// contains filtered or unexported fields
}

DimensionClient sends updates to dimensions to the SignalFx API This is a port of https://github.com/signalfx/signalfx-agent/blob/main/pkg/core/writer/dimensions/client.go with the only major difference being deduplication of dimension updates are currently not done by this port.

func NewDimensionClient

func NewDimensionClient(ctx context.Context, options DimensionClientOptions) *DimensionClient

NewDimensionClient returns a new client

func (*DimensionClient) PushMetadata

func (dc *DimensionClient) PushMetadata(metadata []*metadata.MetadataUpdate) error

func (*DimensionClient) Start

func (dc *DimensionClient) Start()

Start the client's processing queue

type DimensionClientOptions

type DimensionClientOptions struct {
	Token                 configopaque.String
	APIURL                *url.URL
	APITLSConfig          *tls.Config
	LogUpdates            bool
	Logger                *zap.Logger
	SendDelay             int
	PropertiesMaxBuffered int
	MetricsConverter      translation.MetricsConverter
	ExcludeProperties     []dpfilters.PropertyFilter
}

type DimensionKey

type DimensionKey struct {
	Name  string
	Value string
}

DimensionKey is what uniquely identifies a dimension, its name and value together.

func (DimensionKey) String

func (dk DimensionKey) String() string

type DimensionUpdate

type DimensionUpdate struct {
	Name       string
	Value      string
	Properties map[string]*string
	Tags       map[string]bool
}

func (*DimensionUpdate) Key

func (d *DimensionUpdate) Key() DimensionKey

func (*DimensionUpdate) String

func (d *DimensionUpdate) String() string

type MetadataUpdateClient

type MetadataUpdateClient interface {
	PushMetadata([]*metadata.MetadataUpdate) error
}

MetadataUpdateClient is an interface for pushing metadata updates

type ReqSender

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

ReqSender is a direct port of https://github.com/signalfx/signalfx-agent/blob/main/pkg/core/writer/requests/sender.go.

func NewReqSender

func NewReqSender(ctx context.Context, client *http.Client,
	workerCount uint, diagnosticDimensions map[string]string) *ReqSender

func (*ReqSender) Send

func (rs *ReqSender) Send(req *http.Request)

Send sends the request. Not thread-safe.

type RequestFailedCallback

type RequestFailedCallback func(statusCode int, err error)

type RequestSuccessCallback

type RequestSuccessCallback func([]byte)