analytics

type Action ¶ added in v0.79.36

type Action string

const (
	Create Action = "create"
	Revoke Action = "revoke"
	Accept Action = "accept"
	Reject Action = "reject"

	Login     Action = "login"
	Delete    Action = "delete"
	Cancel    Action = "cancel"
	Replay    Action = "replay"
	List      Action = "list"
	Get       Action = "get"
	Register  Action = "register"
	Subscribe Action = "subscribe"
	Listen    Action = "listen"
	Release   Action = "release"
	Refresh   Action = "refresh"
	Send      Action = "send"
	Evict     Action = "evict"
	Restore   Action = "restore"
	Branch    Action = "branch"
	Memo      Action = "memo"
	WaitFor   Action = "wait-for"
	Connect   Action = "connect"
	Publish   Action = "publish"
)

type Aggregator ¶ added in v0.79.36

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

Aggregator batches Count calls into periodic flushes. It is intended to be embedded inside an Analytics implementation (e.g. PosthogAnalytics) so that the implementation's Count method is non-blocking and high-throughput.

func NewAggregator(l *zerolog.Logger, enabled bool, interval time.Duration, maxKeys int64, fn FlushFunc) *Aggregator

func (a *Aggregator) Count(resource Resource, action Action, tenantID uuid.UUID, tokenID *uuid.UUID, n int64, props ...Properties)

func (a *Aggregator) CountTotals(resource Resource, action Action, tenantID uuid.UUID, tokenID *uuid.UUID, n int64, totals map[string]int64, props ...Properties)

func (a *Aggregator) Shutdown()

func (a *Aggregator) Start()

type Analytics ¶

type Analytics interface {
	Enqueue(ctx context.Context, resource Resource, action Action, resourceId string, properties Properties)
	Count(ctx context.Context, resource Resource, action Action, props ...Properties)
	// CountN records n occurrences, plus totals summed into the same bucket as Count.
	CountN(ctx context.Context, resource Resource, action Action, n int64, totals Totals, props ...Properties)
	Identify(userId uuid.UUID, properties Properties)
	Tenant(tenantId uuid.UUID, data Properties)
	Group(groupType string, groupKey string, data Properties)
	IsFeatureEnabled(ctx context.Context, flagKey string, tenantID uuid.UUID, user *FeatureFlagUser, isEnabledIfNoPosthog bool) (bool, error)
	Close() error
}

type FeatureFlagUser ¶ added in v0.106.3

type FeatureFlagUser struct {
	ID    uuid.UUID
	Email string
}

type FlushFunc ¶ added in v0.79.36

type FlushFunc func(resource Resource, action Action, tenantID uuid.UUID, tokenID *uuid.UUID, count int64, firstEventAt, lastEventAt time.Time, properties Properties)

FlushFunc receives one bucket's totals for the interval since the previous flush: the number of events counted, and approximate times of the first and last events. The times are sampled independently of the count and of each other: they are zero when unknown, events that arrive during a flush can have their count and their times attributed to different intervals, and lastEventAt can precede firstEventAt when writers interleave.

type NoOpAnalytics ¶

type NoOpAnalytics struct{}

func (a NoOpAnalytics) Close() error

func (a NoOpAnalytics) Count(ctx context.Context, resource Resource, action Action, props ...Properties)

func (a NoOpAnalytics) CountN(ctx context.Context, resource Resource, action Action, n int64, totals Totals, props ...Properties)

func (a NoOpAnalytics) Enqueue(ctx context.Context, resource Resource, action Action, resourceId string, properties Properties)

func (a NoOpAnalytics) Group(groupType string, groupKey string, data Properties)

func (a NoOpAnalytics) Identify(userId uuid.UUID, properties Properties)

func (a NoOpAnalytics) IsFeatureEnabled(_ context.Context, _ string, _ uuid.UUID, _ *FeatureFlagUser, isEnabledIfNoPosthog bool) (bool, error)

func (a NoOpAnalytics) Tenant(tenantId uuid.UUID, data Properties)

type Properties ¶ added in v0.79.36

type Properties map[string]interface{}

func Props(kvs ...interface{}) Properties

type Resource ¶ added in v0.79.36

type Resource string

const (
	User     Resource = "user"
	Invite   Resource = "user-invite"
	Tenant   Resource = "tenant"
	Token    Resource = "api-token"
	Workflow Resource = "workflow"

	Event         Resource = "event"
	WorkflowRun   Resource = "workflow-run"
	TaskRun       Resource = "task-run"
	DurableTask   Resource = "durable-task"
	Worker        Resource = "worker"
	RateLimit     Resource = "rate-limit"
	Webhook       Resource = "webhook"
	Log           Resource = "log"
	StreamEvent   Resource = "stream-event"
	DurableStream Resource = "durable-stream"
	OtelSpan      Resource = "otel-span"
)

type Source ¶ added in v0.79.36

type Source string

const (
	SourceUI   Source = "ui"
	SourceAPI  Source = "api"
	SourceGRPC Source = "grpc"
	SourceCLI  Source = "cli"
)

func SourceFromContext(ctx context.Context) Source

type Totals ¶ added in v0.120.1

type Totals map[string]int64

Totals are additive integers summed into one aggregated event. They are flushed as properties and are not part of the bucket key, so calls that differ only in their totals share a bucket.