chqstatsprocessor

README

chqstatsprocessor

This processor is a component of the Cardinal Ecosystem which computes various statistics on the data flowing through it. This is used to compute cost savings and other data flows for presenting in Cardinal's SaaS UI.

While this processor can be used outside of the Cardinal Ecosystem, it would require building an API and processing to receive the statistic data.

Various configuration details are obtained at run-time from the named chqconfig extension.

Configuration

processors:
  chqstats/f32d43b8-f7c4-47c1-846f-241a7516a095:
    configuration_extension: "chqconfig"
    statistics:
      auth:
        authenticator: "chqauth"
      endpoint: "https://stats-receiver.global.aws.cardinalhq.io"
      phase: "presample"

Documentation

Index

• func NewFactory() processor.Factory
• type Config
  • func (c *Config) Validate() error
• type ContextID
• type Entry
• type LRUCache
  • func NewLRUCache(capacity int, expiry time.Duration) *LRUCache
  • func (l *LRUCache) Close()
  • func (l *LRUCache) Contains(key int64) bool
  • func (l *LRUCache) Get(key int64) (interface{}, bool)
  • func (l *LRUCache) Put(key int64, value interface{})
  • func (l *LRUCache) Remove(key int64)
• type StatisticsConfig
  • func (c *StatisticsConfig) Validate() error

Functions

func NewFactory

func NewFactory() processor.Factory

NewFactory creates a factory for S3 exporter.

Types

type Config

type Config struct {
	confighttp.ClientConfig `mapstructure:",squash"`
	Statistics              StatisticsConfig `mapstructure:"statistics"`
	ConfigurationExtension  *component.ID    `mapstructure:"configuration_extension"`
	IDSource                string           `mapstructure:"id_source"`
}

func (*Config) Validate

func (c *Config) Validate() error

type ContextID

type ContextID = string

type Entry

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

type LRUCache

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

func NewLRUCache

func NewLRUCache(capacity int, expiry time.Duration) *LRUCache

func (*LRUCache) Close

func (l *LRUCache) Close()

func (*LRUCache) Contains

func (l *LRUCache) Contains(key int64) bool

func (*LRUCache) Get

func (l *LRUCache) Get(key int64) (interface{}, bool)

func (*LRUCache) Put

func (l *LRUCache) Put(key int64, value interface{})

Put adds a value to the cache or updates it if it already exists.

func (*LRUCache) Remove

func (l *LRUCache) Remove(key int64)

type StatisticsConfig

type StatisticsConfig struct {
	Interval time.Duration `mapstructure:"interval"`
	Phase    string        `mapstructure:"phase"`
}

func (*StatisticsConfig) Validate

func (c *StatisticsConfig) Validate() error