analytics

Documentation

Index

• type AnalyticsSinkSpanExporter
  • func NewAnalyticsSinkSpanExporter(logger *zap.Logger, analyticsStoreMutator AnalyticsStoreMutator) *AnalyticsSinkSpanExporter
  • func (a *AnalyticsSinkSpanExporter) ExportSpans(ctx context.Context, spans []sdktrace.ReadOnlySpan) error
  • func (a *AnalyticsSinkSpanExporter) Shutdown(_ context.Context) error
• type AnalyticsStoreMutator
• type Client
• type EvaluationResponse
• type FlagEvaluationsCountRequest
• type Server
  • func New(logger *zap.Logger, client Client) *Server
  • func (s *Server) GetFlagEvaluationsCount(ctx context.Context, req *analytics.GetFlagEvaluationsCountRequest) (*analytics.GetFlagEvaluationsCountResponse, error)
  • func (s *Server) RegisterGRPC(server *grpc.Server)
  • func (s *Server) SkipsAuthorization(ctx context.Context) bool

Types

type AnalyticsSinkSpanExporter

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

AnalyticsSinkSpanExporter implements SpanExporter.

func NewAnalyticsSinkSpanExporter

func NewAnalyticsSinkSpanExporter(logger *zap.Logger, analyticsStoreMutator AnalyticsStoreMutator) *AnalyticsSinkSpanExporter

NewAnalyticsSinkSpanExporter is the constructor function for an AnalyticsSpanExporter.

func (*AnalyticsSinkSpanExporter) ExportSpans

func (a *AnalyticsSinkSpanExporter) ExportSpans(ctx context.Context, spans []sdktrace.ReadOnlySpan) error

ExportSpans transforms the spans into []*EvaluationResponse which the mutator takes to store into an analytics store.

func (*AnalyticsSinkSpanExporter) Shutdown

func (a *AnalyticsSinkSpanExporter) Shutdown(_ context.Context) error

Shutdown closes resources for an AnalyticsStoreMutator.

type AnalyticsStoreMutator

type AnalyticsStoreMutator interface {
	IncrementFlagEvaluationCounts(ctx context.Context, responses []*EvaluationResponse) error
	Close() error
}

type Client

type Client interface {
	GetFlagEvaluationsCount(ctx context.Context, req *FlagEvaluationsCountRequest) ([]string, []float32, error)
	fmt.Stringer
}

Client is a contract that each analytics store needs to conform to for getting analytics from the implemented store.

type EvaluationResponse

type EvaluationResponse struct {
	FlagKey         string    `json:"flagKey,omitempty"`
	FlagType        string    `json:"flagType,omitempty"`
	NamespaceKey    string    `json:"namespaceKey,omitempty"`
	Reason          string    `json:"reason,omitempty"`
	Match           *bool     `json:"match,omitempty"`
	EvaluationValue *string   `json:"evaluationValue,omitempty"`
	Timestamp       time.Time `json:"timestamp,omitempty"`
	EntityId        string    `json:"entityId,omitempty"`
}

type FlagEvaluationsCountRequest

type FlagEvaluationsCountRequest struct {
	NamespaceKey string
	FlagKey      string
	From         time.Time
	To           time.Time
	StepMinutes  int
}

type Server

type Server struct {
	analytics.UnimplementedAnalyticsServiceServer
	// contains filtered or unexported fields
}

Server is a grpc server for Flipt analytics.

func New

func New(logger *zap.Logger, client Client) *Server

New constructs a new server for Flipt analytics.

func (*Server) GetFlagEvaluationsCount

func (s *Server) GetFlagEvaluationsCount(ctx context.Context, req *analytics.GetFlagEvaluationsCountRequest) (*analytics.GetFlagEvaluationsCountResponse, error)

GetFlagEvaluationsCount is the implemented RPC method that will return aggregated flag evaluation counts.

func (*Server) RegisterGRPC

func (s *Server) RegisterGRPC(server *grpc.Server)

func (*Server) SkipsAuthorization

func (s *Server) SkipsAuthorization(ctx context.Context) bool