Skip to main content

Usage Beacon

RowOps includes an internal usage beacon used for abuse detection around export, sync, and import completion events. It is disabled by default and only sends when explicitly enabled by the host runtime.

Default behavior

  • Disabled by default.
  • No network traffic unless the host enables it.
  • Payloads contain aggregate metrics only (no row data, schema, or column names).

Network path

All usage beacon network activity is centralized in packages/core/engine/src/internal/usage_beacon.ts via sendUsageBeacon. The endpoint is host-configured; there is no default endpoint.

Configuration (host runtime)

The host runtime must call configureUsageBeacon with enabled: true, endpoint, and projectId to allow sending. If enabled is not explicitly true, the beacon does not send.

Payload fields

FieldTypeNotes
eventstringOne of export, sync, import_complete.
projectIdstringProject ID from entitlement token.
tierstringTier at time of operation.
rowCountnumberRows processed.
fileBytesnumberExport only.
featuresUsedstring[]Import completion only.
timestampnumberUnix epoch milliseconds.
sessionNoncestringRandom nonce for deduplication.
signaturestringOptional HMAC signature when entitlement token is available.