telemetry

Documentation

Index

• Variables
• func Report(event *telemetryv1.Event) bool
• func Start(ctx context.Context, store storage.Store)
• func Stop()
• type Conf
  • func (c *Conf) Key() string
  • func (c *Conf) SetDefaults()
  • func (c *Conf) Validate() (errs error)
• type Interceptors
  • func Intercept() Interceptors
• type Reporter

Variables

var (
	WriteKey     string
	DataPlaneURL string
)

Functions

func Report

func Report(event *telemetryv1.Event) bool

func Start

func Start(ctx context.Context, store storage.Store)

func Stop

func Stop()

Types

type Conf

type Conf struct {
	// StateDir is used to persist state to avoid repeatedly sending the data over and over again.
	StateDir string `yaml:"stateDir" conf:",example=${HOME}/.config/cerbos"`
	// Disabled sets whether telemetry collection is disabled or not.
	Disabled bool `yaml:"disabled" conf:",example=false"`
	// ReportInterval is the interval between telemetry pings.
	ReportInterval time.Duration `yaml:"reportInterval" conf:",example=1h"`
}

Conf for telemetry reporting.

func (*Conf) Key

func (c *Conf) Key() string

func (*Conf) SetDefaults

func (c *Conf) SetDefaults()

func (*Conf) Validate

func (c *Conf) Validate() (errs error)

type Interceptors

type Interceptors interface {
	UnaryServerInterceptor() grpc.UnaryServerInterceptor
	StreamServerInterceptor() grpc.StreamServerInterceptor
}

func Intercept

func Intercept() Interceptors

type Reporter

type Reporter interface {
	Report(*telemetryv1.Event) bool
	Intercept() Interceptors
	Stop() error
}