#Alepha - Api Analytics

#Installation

Part of the alepha package. Import from alepha/api/analytics.

npm install alepha

#Overview

Portable analytics datasets.

Binds the relational provider under Node, and the memory provider under test. WaeAnalyticsProvider is exported here too, and - unlike its first design - it is now DI-constructible like any other provider (see its class doc). It is still never auto-wired by this module's register(), though: its write path reads a cloudflare.env binding that only exists inside a Worker, so selecting it under Node would mean every record() call throws. index.workerd.ts is the entry that selects it, gated on CLOUDFLARE_ANALYTICS_DATASET.

AnalyticsRollupJobs is deliberately not wired here - see AlephaApiAnalyticsRollup just below for why it is a separate module. AnalyticsRetentionGuard is wired here, unconditionally, precisely to catch an app that forgets the split: it log.warns at boot if any dataset declares retention.hot while no AnalyticsRollupJobs was ever constructed.

#API Reference

#Primitives

• $analytics - Declares an analytics dataset: what you record, and what you can ask.

#Providers

• AnalyticsProvider - Where a dataset's rows live.
• MemoryAnalyticsProvider - An in-memory dataset, and the reference implementation of the seam.
• OrmAnalyticsProvider - Two relational tables per dataset: raw hour buckets and rolled day buckets.
• WaeAnalyticsProvider - Hot rows on Workers Analytics Engine, rolled rows in a durable store.

#Environment Variables

Environment variables used to configure this module. These can be set in your .env file or through your deployment configuration.