analytics

package

Go to main page

Versions in this module

v0

v0.4.0

Sep 6, 2026

Changes in this version

type IngestConfig

+ Observer RedirectObserver

+ type RedirectObserver interface

+ Observe func(ev addon.RedirectEvent)

v0.3.0

Aug 18, 2026

Changes in this version

type LinkStats

+ QRCodes []QRCodeSplit

+ type QRCodeSplit struct

+ Clicks int64

+ Label string

+ Removed bool

+ Slug string

+ UniqueVisitors int64

v0.2.0

Aug 6, 2026

Changes in this version

+ const DimensionInterval

+ const DimensionJob

+ const ReturningHashLength

+ const ReturningKeyPrefix

+ const TotalsJob

+ type DestinationSplit struct

+ Approximate bool

+ Clicks int64

+ DestinationID uuid.UUID

+ IsPrimary bool

+ Removed bool

+ Share float64

+ URL string

+ UniqueVisitors int64

+ VisitorsKnown bool

+ Weight int32

type Event

+ DestinationID uuid.UUID

+ Source string

+ TrackReturning bool

type IngestConfig

+ Returning *ReturningSet

type LinkStats

+ Destinations []DestinationSplit

+ type ReturningSet struct

+ func NewReturningSet(rdb *goredis.Client, salts *SaltCache, timeout time.Duration, log *slog.Logger) *ReturningSet

+ func (s *ReturningSet) Enabled() bool

+ func (s *ReturningSet) Member(salt []byte, ip netip.Addr, userAgent string, workspaceID uuid.UUID) string

+ func (s *ReturningSet) Seen(ctx context.Context, linkID, workspaceID uuid.UUID, ip netip.Addr, ...) bool

type Roller

+ func (r *Roller) RunDimensions(ctx context.Context, from, to time.Time) error

+ func (r *Roller) RunRecentDimensions(ctx context.Context, now time.Time) error

+ func (r *Roller) RunRecentTotals(ctx context.Context, now time.Time) error

+ func (r *Roller) RunTotals(ctx context.Context, from, to time.Time) error

+ func (r *Roller) Staleness(ctx context.Context) ([]Staleness, error)

type SaltCache

+ func (c *SaltCache) Cached(day time.Time) ([]byte, bool)

+ type Staleness struct

+ Job string

+ Seconds float64

v0.1.0

Jul 31, 2026

Changes in this version

+ const PermRead

+ const SaltLength

+ const SaltRetentionDays

+ const VisitorHashLength

+ var ErrIngesterClosed = errors.New("analytics: ingester is closed")

+ func AnonymizeIP(addr netip.Addr) string

+ func FormatHash(h []byte) string

+ func NewSalt() ([]byte, error)

+ func PrimaryLanguage(header string) string

+ func ReferrerHost(referrer string) string

+ func SaltDay(at time.Time) time.Time

+ func VisitorHash(salt []byte, ip netip.Addr, userAgent string, workspaceID uuid.UUID) []byte

+ type Classification struct

+ Browser string

+ Device Device

+ IsBot bool

+ OS string

+ func Classify(ua string) Classification

+ type CountryResolver interface

+ Country func(netip.Addr) string

+ type DayPoint struct

+ BotClicks int64

+ Clicks int64

+ Day string

+ UniqueVisitors int64

+ type Device string

+ const DeviceBot

+ const DeviceDesktop

+ const DeviceMobile

+ const DeviceTablet

+ const DeviceUnknown

+ type DimensionValue struct

+ Clicks int64

+ UniqueVisitors int64

+ Value string

+ type Event struct

+ IP netip.Addr

+ Language string

+ LatencyUS int32

+ LinkID uuid.UUID

+ OccurredAt time.Time

+ Referrer string

+ UserAgent string

+ WorkspaceID uuid.UUID

+ type IngestConfig struct

+ BatchSize int

+ FlushInterval time.Duration

+ Geo CountryResolver

+ Logger *slog.Logger

+ QueueSize int

+ type Ingester struct

+ Stats Stats

+ func NewIngester(pool *pgxpool.Pool, salts *SaltCache, cfg IngestConfig) *Ingester

+ func (i *Ingester) Close(ctx context.Context) error

+ func (i *Ingester) Counters() (enqueued, dropped, flushed, failed, batches int64)

+ func (i *Ingester) QueueDepth() int

+ func (i *Ingester) Record(ev Event)

+ func (i *Ingester) Start()

+ type LinkStats struct

+ Caveat string

+ Dimensions map[string][]DimensionValue

+ From string

+ LinkID uuid.UUID

+ Series []DayPoint

+ To string

+ Totals Totals

+ type Reader struct

+ func NewReader(pool *pgxpool.Pool) *Reader

+ func (r *Reader) LinkStats(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, ...) (*LinkStats, error)

+ func (r *Reader) Overview(ctx context.Context, actor *auth.Identity, from, to time.Time) (*WorkspaceOverview, error)

+ func (r *Reader) RecentClicks(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, limit int32) ([]RecentClick, error)

+ type RecentClick struct

+ Browser string

+ Country string

+ Device string

+ IsBot bool

+ OS string

+ OccurredAt time.Time

+ Referrer string

+ type Roller struct

+ func NewRoller(pool *pgxpool.Pool, log *slog.Logger) *Roller

+ func (r *Roller) Run(ctx context.Context, from, to time.Time) error

+ func (r *Roller) RunRecent(ctx context.Context, now time.Time) error

+ type SaltCache struct

+ func NewSaltCache(pool *pgxpool.Pool) *SaltCache

+ func (c *SaltCache) For(ctx context.Context, day time.Time) ([]byte, error)

+ func (c *SaltCache) Purge(ctx context.Context) (int64, error)

+ type Stats struct

+ Batches atomic.Int64

+ Dropped atomic.Int64

+ Enqueued atomic.Int64

+ Failed atomic.Int64

+ Flushed atomic.Int64

+ type Totals struct

+ BotClicks int64

+ Clicks int64

+ UniqueVisitors int64

+ type WorkspaceOverview struct

+ Caveat string

+ From string

+ Series []DayPoint

+ To string

+ Totals Totals

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL