agentleFS
BuilderIOBuilderIO/agent-native/.agents/skills/tracking/SKILL.md

tracking

Skill7.6k starsChanged 5 months agoMITView on GitHub

Server-side analytics tracking with pluggable providers. Use when adding analytics events, registering custom tracking providers, or configuring built-in providers (PostHog, Mixpanel, Amplitude, Webhook).

  • Reads credentials

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 1 is distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When first-party Agent-Native Analytics is configured, browser configureTracking() captures uncaught errors, unhandled rejections, and …

    line 122
  2. Very specific:

    When adding a client config field, update both server/posthog-config.ts and the mirrored worker emitter in deploy/build.ts — the worker …

    line 256
  3. Very specific:

    Every third-party browser tag goes through the gate: server-injected scripts use consentGatedScript() in server/analytics.ts.

    line 270
  4. Very specific:

    Use consentDecision(category) for anything a revoke can't undo once sent.

    line 291
  5. Distinctive:

    Does not send first-party events from localhost/local dev

    line 372
  6. Very specific:

    Every browser-side trackEvent() POST to the Agent-Native Analytics /track endpoint includes:

    line 376
  7. Very specific:

    All new event names and properties use lowercase snake_case.

    line 493

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Tracking

Rule

The tracking system provides a single server-side track() call that fans out to all registered providers, plus the browser-side trackEvent() counterpart. Built-in providers auto-register from env vars - set the var and tracking starts. Custom providers can be registered for any analytics backend. Both surfaces are best-effort and never block request handling.

How It Works

  1. At server startup, registerBuiltinProviders() checks env vars and registers any configured providers.
  2. Application code calls track(eventName, properties, source) from actions, plugins, or server routes.
  3. The registry fans out the event to every registered provider. Errors are caught and logged -- a failing provider never crashes the caller.
  4. Built-in providers batch HTTP calls (flush every 10 seconds or 50 events, whichever comes first). Each send times out after 10 seconds.

API

track(name, properties?, source?)

Fire an analytics event. source is either a { userId, anonymousId, sessionId } meta object or an action's ctx passed straight through.

import { track } from "@agent-native/core/tracking";

// From an action — pass ctx; userId comes from ctx.userEmail.
run: async ({ name }, ctx) => {
  track("meal.logged", { mealName: name, calories: 350 }, ctx);
};

// From a plugin or route with no ctx.
track(
  "meal.logged",
  { mealName: "Salad", calories: 350 },
  { userId: "user@example.com" },
);

The caller's browser session comes from the ambient request context (RequestContext.browserSessionId, set from the X-Agent-Native-Session-Id header), so it resolves the same whether the UI called the action or the agent did. Pass sessionId in the meta object to override it — routes that run outside a request context, such as /_agent-native/track, do exactly that. Providers map it to their own session field: $session_id for PostHog (which joins the event to session replay), session_id as a property for Mixpanel and Amplitude, a top-level sessionId for webhooks and Agent-Native Analytics. It is absent for callers with no browser — cron, CLI, MCP, A2A.

identify(userId, traits?)

Identify a user with traits. Forwarded to providers that support it.

import { identify } from "@agent-native/core/tracking";

identify("user@example.com", { plan: "pro", company: "ExampleCo" });

registerTrackingProvider(provider)

Register a custom provider.

import { registerTrackingProvider } from "@agent-native/core/tracking";

registerTrackingProvider({
  name: "my-analytics",
  track(event) {
    // Send event to your backend
  },
  identify(userId, traits) {
    // Optional
  },
  flush() {
    // Optional -- called on graceful shutdown
  },
});

flushTracking()

Flush all providers (call before process exit).

Built-in Providers

Set the env var and the provider auto-registers at startup. No SDK dependencies -- all providers use raw HTTP.

ProviderEnv vars
PostHogPOSTHOG_API_KEY (required), POSTHOG_HOST (optional, defaults to https://us.i.posthog.com), POSTHOG_ERROR_TRACKING=false (optional opt-out)
MixpanelMIXPANEL_TOKEN
AmplitudeAMPLITUDE_API_KEY
Agent-Native AnalyticsAGENT_NATIVE_ANALYTICS_PUBLIC_KEY (server), AGENT_NATIVE_ANALYTICS_ENDPOINT (optional, defaults to https://analytics.agent-native.com/track)
WebhookTRACKING_WEBHOOK_URL (required), TRACKING_WEBHOOK_AUTH (optional, sent as Authorization header)

Multiple providers can be active simultaneously. All receive every event.

Browser-side trackEvent() also forwards to Agent-Native Analytics when VITE_AGENT_NATIVE_ANALYTICS_PUBLIC_KEY is present. Use VITE_AGENT_NATIVE_ANALYTICS_ENDPOINT to override the default browser endpoint. The built-in Agent-Native Analytics sender is quiet on localhost/local dev by default; set AGENT_NATIVE_ANALYTICS_ALLOW_LOCALHOST=true only for an intentional local ingestion test.

An app served from a hosted beta host (beta.*.agent-native.com) reports to beta Analytics: resolveLaneEndpoint moves an endpoint on a production lane host to its beta lane for browser events, auth-page events, replay uploads, and server events. A new sender that reads the analytics endpoint must pass it through resolveLaneEndpoint too, or beta traffic splits. Beta and production Analytics share one database, so an ingest change runs on beta traffic first, and checking it on beta proves the merged code rather than production's. An endpoint on any other host is left as configured.

Error Capture

Exceptions fan out through server/capture-error.ts to every registered backend - Sentry, PostHog, and the tracking providers - from one captureError() call. Backends are additive: configuring a second one does not displace the first, and no backend is required for the others to work.

When first-party Agent-Native Analytics is configured, browser configureTracking() captures uncaught errors, unhandled rejections, and manual captureException() calls as $exception events through /track. On the server, the core route plugin registers the tracking capture provider: captureError() calls captureException(), and the Agent-Native provider sends the same event when the server public key is configured. Analytics groups both into owner-scoped error_issues and error_events, shown in Monitoring -> Errors and exposed to authenticated agents through list-error-issues and get-error-issue. This remains available even when external Sentry is unavailable or rate-limited.

Emit through captureError() / captureException(). Never hand-roll a track("$exception", …): each backend needs its own payload shape and the providers build it.

  • Provider-agnostic wiring must not live in a provider plugin. The Nitro error hook is in core-routes-plugin.ts, not sentry-plugin.ts, because that plugin returns early when no SENTRY_DSN is set — hooking route errors there meant an app on any other backend silently reported none.
  • captureError() is the one noise and flood boundary. The drop rules live in shared/error-noise.ts (expected 4xx, access-control rejections, Lambda socket hang up, third-party/extension/GTM stacks, stale chunks, opaque Script error.); the Nitro hook, every explicit captureError() call, the browser capture, Sentry beforeSend, and the analytics ingest all call classifyErrorNoise(). After the filter, server/capture-error.ts folds transient-database, database-credential, and configuration failures into one aggregate per (class, route): the first event immediately, then one summary per window carrying suppressedCount. Every drop is counted (getCaptureErrorStats()); an error that matches no rule is reported every time. A backend must hang off registerErrorCaptureProvider, never call a provider SDK from a catch block, or it skips both. Two escape hatches keep a rule from hiding a real failure: tag a capture reportExpected: "true" (REPORT_EXPECTED_FAILURE_TAG) when your code raises an access-control or 4xx failure as a failure (a runner whose grant was lost), and give an explicit browser capture a context or area tag so a stackless Safari/Firefox network error from it is not dropped as unattributable. Stale-chunk failures are dropped because route-chunk-recovery reloads on them; when it cannot (cooldown, desktop) it reports one RouteChunkRecoveryExhausted per page session instead.
  • A backend can accept a malformed payload and still show a count. PostHog ingested the framework's camelCase $exception for a long time and rendered empty, ungroupable issues — which reads as coverage, not as breakage. When adding or changing a backend, check what an event looks like in its UI, not just that the request returned 200.
  • Attribute the error. Without a user id, server exceptions land under anonymous and split one person in two against their browser events. Pass aiTraceId for anything inside an agent run so the issue and the LLM trace resolve to each other.
  • Every server capture carries a failure packet at extra.failureContext (observability/failure-context.ts): app, route, action or automation name, threadId, runId, requestId, userScope (org or personal, never an email), threadUrl (https://<app host>/?thread=<chat_threads.id>), build, environment, errorCode, failureClass. The boundary derives it from what the call site already passes (tags.action, extra.runId / threadId / request_id, aiTraceId) and from the ambient chat run, so a capture inside a run names its thread with no change at the call site. Work that runs outside any request (a scheduled automation) passes failure: { threadId, automationName, userScope } on the capture. A run id also becomes aiTraceId. The Analytics issue page links threadUrl; hand any agent the packet and it can run get-agent-thread-debug with the runId. Never put an email, a token or a prompt in it.
  • Rates are events, not log lines. tracking/failure-counters.ts counts a failure class per (event, bounded dimensions) and ships count per window (first occurrence at once, the rest once a minute, SUM(count) is exact): action_error_counts (action_name, error_code, status_class, action_source) and credential_state_counts (credential_state, credential_subject, source). Automation pauses and automatic resumes are automation_paused / automation_resumed (automation_hash, never the name), the client's open circuits are action_circuit_tripped, and a chat run that ended on a credential problem is a $ai_trace with credential_state. Attachment mint/resolve/delete outcomes (ok included) are attachment_outcome_counts (operation, status, reason, who_can_fix), and a template counts its own classes with countOutcome("<thing>_counts", { ...tokens }) from @agent-native/core/tracking (Mail's Gmail cooldowns are gmail_cooldown_counts, by site). Never one event per failure; a name that is not <thing>_counts is dropped with one console error.
  • Browser outcomes are bounded, too. agent_run_outcome is one event per run (outcome, legacy code, terminal_source, verified_after_pipe_closed, resume_attempts, run_id, thread_id, and turn_id when the page started the turn, except a replay whose turn the server did not name): every interrupted / failed / unverified run up to 30 per page, every stopped run up to its own 30 (so stops never crowd out failures), and succeeded sampled at 10% with sample_weight. A turn the server refuses at its start (no model connected, a 5xx) is a failed run too, with terminal_source: local and the refused turn's id. A failed or interrupted run adds its cause from AGENT_TROUBLE_CAUSES when one fits its code, and Analytics groups the rest by code. A code that is not an identifier is sent as unrecognized_code (agentErrorCodeForTelemetry), because a thrower's data.code can be a sentence. It never carries the run's message, not even redacted: no pattern can tell an unquoted document or person's name from the words around it, so a message stays out of every event. A provider error is provider_error only when its code came from a structured HTTP status (http_5xx, including a status on a wrapped cause); a status that appears only in message text is not read. agent_feedback_submitted (sentiment, run_id, thread_id) is the browser's copy of a thumbs rating, because $ai_feedback has no browser session. Every pageview carries agent_signals: 1 (AGENT_SIGNALS_PAGEVIEW_PROPERTY): clients before it sampled stops at 10% and sent no ratings or page_load_id, so Analytics reads a session's cancelled runs, thumbs-down, and quick backs as measured only after seeing the marker and while no unmarked pageview or sampled stop shares the session (tabs share one session id), and counts only stops sent unsampled. Keep all three guarantees while the marker ships. Every pageview also carries page_load_id (PAGE_LOAD_PAGEVIEW_PROPERTY), the same until the page reloads, because quick backs compare pages only within one page load. session_navigation is one event per document that left because of the session (reason, and for signed_out the evidence: signed_out_body or http_401), never the destination. Both are emitted from the single place that decides (agentkit-protocol.ts, navigateForSession; a refused start from the transport's start-run catch), not the callers. agent_chat_stuck_detected fires once per run and only while the stuck banner shows, so Analytics' stuck chats are ones the person saw. It carries reason, dispatchMode, hasInFlightWork and heartbeatSinceSec, so a run the server still holds (a live background worker) reads differently from a dead one.

Symbolication is per-backend and not automatic: the framework uploads no source maps to PostHog, so minified browser stacks stay minified there. Known gap, not a bug to re-diagnose.

Browser keys and the SSR shell

Public keys (POSTHOG_PUBLIC_KEY, the Sentry client DSN, and the first-party Analytics public key) ship inside the CDN-cached SSR shell — publishable and identical for every visitor. Server keys never do, and are never a fallback for a public one: POSTHOG_API_KEY may be a private key and this value lands in public HTML.

Browser errors post directly to the backend rather than through /_agent-native/track, because that route requires a resolved session and relaying would drop every signed-out crash.

When adding a client config field, update both server/posthog-config.ts and the mirrored worker emitter in deploy/build.ts — the worker bundles a string copy and cannot import the module, so a one-sided edit drops the config silently in deployed builds. posthog-config.spec.ts pins the two outputs together.

Cookie consent

Visitors in the consent region (shared/consent.ts, copied from builder.io's banner rules) see ConsentBanner, which AppProviders and the docs root mount, and choose two categories: performance (Google Analytics, Amplitude, Ahrefs) and targeting (Google Tag Manager, attribution). Everyone else gets no banner and every tag at once.

  • Every third-party browser tag goes through the gate: server-injected scripts use consentGatedScript() in server/analytics.ts; client code uses whenConsentAllows(category, run) from @agent-native/core/client/consent. A tag in a raw <script> or a <noscript> fallback runs before the visitor chooses.
  • The GTM container (GTM_CONTAINER_ID, shared by every app and the docs site) carries the ad pixels: Meta, LinkedIn, Reddit, X, Bing UET, Google Ads and OpenAI, plus HubSpot, Dreamdata, Vector, Unify, Common Room and Apollo. Gating the container gates them all, which is why it sits under targeting. Tags added inside GTM need no code change; tags added anywhere else do.
  • The inline bootstrap in server/analytics.ts runs the queue on pages that never load the app bundle. It repeats the cookie format and time-zone rules of client/consent.ts; change both together. Each queued loader runs once a page, even after a reject and a fresh accept.
  • A loaded tag can't be unloaded, so Google's tags follow Consent Mode: the server pushes a consent default from the stored choice (all denied without one) to every Google data layer before any tag, and client/consent.ts pushes a consent update on each region answer and choice. Our own gtag events also wait for performance. Non-Google tags in GTM stop only on the next page load.
  • Use consentDecision(category) for anything a revoke can't undo once sent; it is null until the visitor's choice or the server's region is known. consentAllowsNow guesses from the time zone, so only pair it with storage a revoke can clear.
  • First-party analytics keeps counting in the region before consent, but the visitor id an_aid waits for performance: until then getOrCreateAnalyticsAnonymousId() returns undefined and stores nothing, and events go out with no anonymousId and properties.analytics_consent: "withheld". Events sent before the region is known wait for it, or leave without the id, marked analytics_consent: "unknown", if the page closes first. The plain sign-in page reads the id through the same helper and holds its events with whenConsentDecided; never write an_aid directly. A choice made in another tab applies at once in tabs of the same app, and on focus in another app on the site. A reject clears a stored id. Those rows count as events and views but never as people; the Analytics activation funnel joins them to a signup in the same session. Session replay waits for performance too, with no time-zone head start; a reject stops it, discards what it hasn't uploaded (including a batch an upload in flight puts back), and forgets its stored replay identity. Amplitude rechecks the choice before it initializes and never sends events from before an accept. Google events held for the region's answer go out only if it allows them. Sentry error capture and the session id an_sid aren't gated.

MCP Server Events

The MCP server an app exposes reports its own usage. packages/core/src/mcp/analytics.ts emits one event per protocol request, and the emission points sit in the shared server builder (build-server.ts), so the HTTP mount and the stdio transport report identically.

EventFires on
$mcp_initializethe client/server handshake (HTTP mount only)
$mcp_tools_listtools/list
$mcp_tool_calltools/call, success or failure
$mcp_resources_listresources/list
$mcp_resource_readresources/read

Names come from PostHog's MCP analytics vocabulary (https://posthog.com/docs/mcp-analytics/events) on purpose, so PostHog's MCP dashboards read these events with no mapping layer — but they go through track() like every other event, so Mixpanel, Amplitude, a webhook, and Agent-Native Analytics receive the same ones.

Shared properties: $mcp_source (http / stdio), $mcp_server_name, $mcp_server_version, $mcp_app_id, $mcp_client_name, $mcp_client_version, $mcp_client_user_agent, $mcp_vendor_client, $mcp_protocol_version. Per event: $mcp_tool_name, $mcp_tool_description, $mcp_tool_category (read / write), $mcp_listed_tool_names, $mcp_duration_ms, $mcp_is_error, $mcp_error_type, $mcp_error_message, $mcp_resource_name, $mcp_resource_uri.

  • A client's own name is only on the wire at initialize. The mount is stateless — one server per request — so no later event can recover it. $mcp_initialize carries the clientInfo from the handshake; every other event falls back to the 2026-era per-request _meta and the HTTP user agent, and $mcp_vendor_client buckets both spellings onto one row.
  • A failed call is reported with its reason, not just isError. The tools/call handler renders "unknown tool", "forbidden scope", and a thrown action error as the same shape of error result, so each sets $mcp_error_type where it returns rather than having it guessed back out of the response text.
  • Payloads stay out. $mcp_response is never emitted. $mcp_parameters is off by default and redacted when on — tool arguments carry user content.

Off switches: MCP_ANALYTICS=false (observability.mcpEvents) disables the events; MCP_ANALYTICS_PARAMETERS=true (observability.mcpCaptureParameters) opts into arguments. They sit in observability with the other capture switches, not in analytics — they gate every provider, not the first-party Agent-Native Analytics sender whose key lives there.

Default Baseline Events

Template roots call configureTracking() once during app startup. That installs default browser pageview tracking for hosted apps:

  • Event: pageview
  • Fires on initial load, history.pushState, history.replaceState, and popstate
  • De-dupes repeated events for the same URL
  • Includes url, path, hostname, referrer, title, navigation_type, agent_signals, page_load_id, app, and inferred template
  • Includes LLM connection context on browser events when known: llm_connection (builder, anthropic, openai, etc.), llm_engine, llm_model, llm_connection_source, and llm_connection_configured
  • Does not send first-party events from localhost/local dev

Visitor identity (anonymousId + sessionId)

Every browser-side trackEvent() POST to the Agent-Native Analytics /track endpoint includes:

  • anonymousId — persistent per-browser visitor ID stored in localStorage under agent-native.anonymous_id. Generated once and reused across sessions. Use this for unique-visitor and returning-visitor metrics. In the consent region it's absent until the visitor accepts analytics cookies (see Cookie consent).
  • sessionId — rotating per-visit ID stored in localStorage under agent-native.session_id, with a 30-minute idle timeout (matches GA4 / Mixpanel defaults). Use this for sessions-per-visitor, pages-per-session, and session-duration metrics.
  • userId — only set when the calling code passes properties.userId. Anonymous traffic leaves this NULL by design; anonymousId is the fallback.

These fields land in the analytics_events.anonymous_id, analytics_events.session_id, and analytics_events.user_id columns in the analytics template. Storage access is wrapped in try/catch — private-browsing / blocked-storage clients silently degrade to NULL rather than crashing the page.

Referral / viral attribution (first-touch)

configureTracking() also captures an anonymous visitor's first-touch referral context once, on first page load, and persists it across the signup boundary so the server-side signup event records where the user came from. This powers virality metrics for every template (Clips share links, Plans public pages, etc.).

There is one capture implementation, captureAttribution() from @agent-native/core/client/analytics. Every page that can be someone's first visit calls it, including the server-rendered sign-in page, which never runs configureTracking() and passes { landingPath } so landing_path names the app path behind the sign-in page. Never copy the capture into a page: the sign-in page's private copy silently dropped ad click ids, site handoff fields, and last touch for every visitor who landed on it.

Share-link params (set by whatever generates the link; read client-side only):

  • ref — referral source bucket, e.g. clip_share, plan_share
  • via — the referrer's stable user id (the clip/plan owner)
  • utm_source, utm_medium, utm_campaign, utm_content, utm_term

Client persistence (first-write-wins, except that the first visit with a source replaces one without; last touch lives in an_last_touch / an_lt):

  • localStorage key an_attribution and first-party cookie an_ft (path=/; max-age=2592000; SameSite=Lax, not HttpOnly — non-sensitive, written by client JS).
  • Both store the same URL-encoded compact JSON (empty fields omitted, each value capped at 120 chars): { ref, via, utm_source, utm_medium, utm_campaign, utm_content, utm_term, landing_path, landing_referrer, landed_at }. landing_referrer is the host only of document.referrer (scrubbed; same-origin referrers are dropped).
  • A durable copy, cookie an_fts, set only by our server (POST /_agent-native/auth/attribution, same-origin, no session needed) and expiring 365 days after landed_at, never extended by later visits. The browser sends its first touch there each load until the server holds that visit. Safari caps cookies written by page JavaScript at seven days, so only a server-set cookie can keep first touch for a year. The value carries v: "1"; a reader ignores other versions. When the browser's copies are gone, capture restores them from an_fts. Each sync after the browser writes an_ft or an_lt also has the server write them again from the request's cookies, so Safari keeps them their full 30 days too.
  • Every copy is compared with preferFirstTouch (shared/first-touch-persistence.ts): the first visit with a source, else the first visit. Never add a second ordering rule: the server cookie route, the browser, and signup must agree on which visit is first touch, or a slow response from one tab overwrites a better touch from another.
  • Attribution is a targeting consent category. Visitors in the consent region (builder.io's GDPR list: the EU, the rest of the EEA, Monaco, San Marino, Åland and France's overseas regions; not the UK or Switzerland, in packages/core/src/shared/consent.ts) get nothing stored until they opt in through the an_consent cookie. The banner writes an_consent in the page and then POST /_agent-native/auth/consent writes it again from the server, so Safari keeps the choice its full year. The browser gates capture with whenConsentAllows("targeting", …) from client/consent.ts, which asks GET /_agent-native/auth/consent-region (the request's country) and falls back to the time zone; a reject clears every copy. The server refuses an_fts and clears all three cookies by request country unless an_consent grants targeting. Everyone else is stored as before, with no banner. Don't add attribution storage that bypasses captureAttribution(), or it skips this check.
  • getFirstTouchAttribution() (from @agent-native/core/client) returns the parsed object or null.

Signup event enrichment (server-side, from the an_fts and an_ft cookies on the signup/OAuth-callback request, whichever preferFirstTouch picks, with an_fts winning a tie, derived in packages/core/src/server/attribution.ts):

  • referral_source — ref if present, else derived: /share/… → clip_share; a plan public path (/p/, /plan/, /share-plan/) → plan_share; a non-empty external referring host → external; otherwise direct.
  • referrer_user (= via), referral_medium (= utm_medium), referral_campaign (= utm_campaign)
  • utm_source, utm_medium, utm_campaign, utm_content, utm_term (raw passthrough)
  • first_touch_path (= landing_path), landing_referrer

Attribution parsing is fully defensive and never blocks signup — a missing/malformed cookie falls back to referral_source: "direct".

Other framework-level baseline events:

  • session status from useSession(), with signed_in
  • action.response from the browser action transport, with action name, the route template of the page that made the request (omitted when no manifest route matches), browser-perceived duration and TTFB, response status/outcome, response size when known, and parsed Server-Timing phases for framework readiness and database work. Its request_id joins the exact browser and server events. This separates server time from CDN/network/body overhead. One at or over SLOW_ACTION_RESPONSE_MS (1 s) is never sampled. When someone waited for it (isWaitedActionResponse: the page stayed visible and the request was not cancelled), it is also marked on the session replay (agent-native.slow_request) with its action, method, duration, status, outcome, and page_hidden.
  • web_vitals once per page view, with the React Router route template (/sessions/:id, never the ids; omitted when no manifest route matches, because a normalized raw path still carries slugs and emails. It is the one tracked event with no url or path, even from getDefaultProps: ROUTE_ONLY_EVENT_NAMES in client/analytics.ts strips them), navigation_type (load, client, or resume after the tab was hidden, sent only when it saw an interaction or layout shift), and ttfb_ms, lcp_ms, inp_ms, and cls. TTFB and LCP exist only for document loads, a load in a background tab is not reported, and a metric the browser cannot measure (including CLS when the layout-shift observer fails) is omitted rather than sent as 0. A page view ends on pushState/popstate to another path or when the tab is hidden; replaceState keeps it, so redirects land on the final route. Measured with native PerformanceObservers; configureTracking({ webVitals: false }) turns it off. Each page view also marks the replay.
  • Request timing is an OpenTelemetry http.server span, not a product event. Each framework HTTP request records method, bounded route template, status code, first-request-in-isolate cold marker, framework readiness wait, and database operation count and wall time. The span goes only to the registered OpenTelemetry provider and never reaches analytics providers, so it cannot fire product alerts. Its status is error for 5xx responses only. Ingest endpoints, /api/analytics/replay, and AGENT_NATIVE_HTTP_TELEMETRY_DISABLED record no span. Cold or 1 s-plus requests also write an agent-native.slow_request log line with process age, readiness wait, and database timings. Responses carry Server-Timing for app, startup, db, db-connect, and db-slowest (plus startup-db-* for initialization database work) and an X-Agent-Native-Request-Id header where applicable. Query text and parameters are never captured. There is no sampling knob for this span; export volume is governed by the OpenTelemetry sampler.
  • signup from Better Auth user creation, with auth_provider, auth_user_id, and first-touch referral attribution (referral_source, referrer_user, referral_medium, referral_campaign, utm_*, first_touch_path, landing_referrer — see "Referral / viral attribution" above)
  • builder connect clicked and builder connect popup blocked from browser Use Builder.io CTAs
  • builder connect started, builder connect succeeded, builder connect failed, builder disconnect succeeded, and builder disconnect failed from the Builder connection routes, with LLM connection context when resolvable
  • $ai_generation from instrumented agent loops, with PostHog AI Observability fields such as $ai_trace_id, $ai_session_id, $ai_model, $ai_provider, $ai_input_tokens, $ai_output_tokens, $ai_latency, $ai_total_cost_usd, and mirrored Agent-Native query fields such as run_id, thread_id, turn_id, cost_cents_x100, duration_ms, tool_calls, and status. A bounded tools array contains names, start offsets, durations, statuses, and coarse error classes only; interrupted tools and failed runs remain visible, and delegated runs include protocol/task/parent-run/parent-turn correlation. Run failure messages are omitted from every tracking provider even with content capture enabled. $ai_error carries a fixed message derived from terminal_code, a named cause, terminal state, and retryability. The error_message field and tool error output text are absent. Local trace SQL retains debugging detail under the observability capture settings.
  • agent_run_terminal is one event per run: from the run's own process, or from the SQL write that ended it for that process (a reap with reaped: true, reap_source, recovery_outcome; a stop with status: "aborted" and abort_reason; the reaper's repair from the event log; a run that fails or is released before its worker starts). Not sent yet: a background chunk that hands off to a continuation, and a run the production agent marks errored before its run loop starts (a preparation, history or dispatch failure). A row aborted as duplicate_submission or execution-lease-busy stood in for another run and sends none. An event sent from a SQL write has no model, engine or attempt_count, since only the run's process knows them; every reported aborted run is sent this way. It carries turn_id and the run's user (the turn's initiator when a SQL write ended it, never the request that ended it; none for an anonymous visitor). run_started also carries turn_id.
  • agent_turn_submitted is one browser event per agent request the server accepts (not on send, so a busy-slot refusal then queue counts once; a replay is not counted, including a retry the server answers with the run it already started), with the turn_id the server stores on the run, initiator (user, app for sendToAgentChat including a send deferred while the thread restored, system for continuations, recoveries, approvals, setup replays and background sends), surface, and submit_message_id / recovery_of_run_id when present. Continuations repeat the turn's turn_id as system, so count turns by distinct turn_id. A send routed to Builder or an MCP host is reported once with routed_to and no turn_id, also when the host has not confirmed it. A queued message the server's inbox drain admits sends no agent_turn_submitted yet; its run still reports agent_run_terminal with turn_id queued-<message id>. A queued message the browser promotes is counted.
  • agent_run_terminal carries error_code and error_cause, never error_detail. Run and completion captures, and Builder gateway failures, use captureError(..., { errorMessagePolicy: "omit" }): providers receive the original exception type, stack frames without the original message header or nested causes, and a fixed Internal Server Error message. Noise filtering still sees the original failure; flood summaries use the fixed label. Monitoring groups by app, type, frame, error code, and failure class instead of user-specific message wording.

For new lifecycle events, call track() server-side when the server is the source of truth, and trackEvent() client-side only for browser interactions.

Lifecycle taxonomy

Lifecycle event names use lowercase snake_case; lifecycle properties use the same convention. The shared dimensions are app_name, template_name, user_id, user_email, workspace_id, session_id, output_id, output_type, source, and referrer. App/template values are canonical ids without the agent-native- prefix. Identity is also stored in the event's top-level user/session columns for joins.

The canonical lifecycle events are app_entered, core_action_started, core_action_completed, core_action_failed, output_viewed, output_shared, cta_clicked, return_usage, and cross_app_used. The framework also emits action_started, action_completed, and action_failed for mutating defineAction() calls so UI, agent, MCP, A2A, automation, and CLI activity share one action-level trail. Read-only actions and high-frequency refresh, polling, navigation, and application-state actions are excluded.

App entry is emitted once per app and browser session. Tracking is action-level only: it does not install mouse, pointer, scroll, keypress, or DOM autocapture. Existing legacy events remain available and emit their canonical lifecycle counterpart where the meaning is unambiguous, so downstream dashboards can migrate without losing historical names.

Event name migration

All new event names and properties use lowercase snake_case. The shared track() and browser trackEvent() emitters preserve a legacy event exactly and, for names in LEGACY_TRACKING_EVENT_NAME_ALIASES, emit a canonical alias with legacy_event_name and canonical_event_name provenance properties. Use the canonical alias for new dashboards and new call sites; do not normalize historical warehouse rows or add new legacy names. Provider/framework names such as $ai_*, $mcp_*, $exception, action.response, and app.first_action are intentional exceptions.

Provider Interface

interface TrackingProvider {
  name: string;
  track(event: TrackingEvent): void | Promise<void>;
  identify?(
    userId: string,
    traits?: Record<string, unknown>,
  ): void | Promise<void>;
  flush?(): void | Promise<void>;
}

interface TrackingEvent {
  name: string;
  properties?: Record<string, unknown>;
  timestamp?: string;
  userId?: string;
}

Design Decisions

  • globalThis singleton -- the registry uses a Symbol.for key on globalThis so multiple ESM graph instances (dev-mode Vite + Nitro, symlinks) share one provider set.
  • Best-effort fan-out -- provider errors are caught and logged, never propagated. A broken analytics integration must not break app functionality.
  • Batched HTTP -- built-in providers enqueue events and flush every 10 seconds or 50 events, minimizing outbound requests.
  • NOT bridged to the event bus -- tracking and the event bus are separate concerns. The event bus is for triggering automations; tracking is for analytics. Do not subscribe to track() calls from the event bus or vice versa.

Key Files

FilePurpose
packages/core/src/tracking/registry.tstrack(), identify(), registerTrackingProvider(), flushTracking()
packages/core/src/tracking/providers.tsBuilt-in providers (PostHog, Mixpanel, Amplitude, Agent-Native Analytics, Webhook) and registerBuiltinProviders()
packages/core/src/tracking/types.tsTrackingEvent and TrackingProvider interfaces
packages/core/src/tracking/posthog-exception.ts$exception_list builder + stack-frame parser (isomorphic: server and browser)
packages/core/src/tracking/redaction.tsShared bounding/redaction helpers used by every exception emitter
packages/core/src/shared/error-noise.tsThe one noise rule set (classifyErrorNoise) plus frame-origin and PII scrubbers; browser, server, Sentry, and ingest all call it
packages/core/src/server/error-noise-filter.tsProvider-agnostic drop rules, applied by both Sentry beforeSend and the route error hook
packages/core/src/server/posthog-config.tsPublic browser PostHog config (mirrored in deploy/build.ts)

Related Skills

  • secrets -- API keys for tracking providers can be registered as secrets
  • server-plugins -- registerBuiltinProviders() is called by the core-routes plugin at startup
  • actions -- call track() from action handlers to record user/agent activity

Download now (ZIP)

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 5 mentionsJul 2026: 1 mentionAug 2026: 0 mentionsSep 2026: 4 mentionsOct 2026: 51 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the BuilderIO/agent-native repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about BuilderIO/agent-native

The biggest 5 of 61 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 61

Talked about on GitHub and Bluesky (61 times).

On GitHub · 50

45 more on GitHub

On Bluesky · 11

6 more on Bluesky

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.