Skip to content

docs: add the App Analytics guide - #615

Draft
ditadi wants to merge 1 commit into
stack/app-analytics/04-auto-startfrom
stack/app-analytics/05-docs
Draft

ditadi wants to merge 1 commit into
stack/app-analytics/04-auto-startfrom
stack/app-analytics/05-docs

Conversation

@ditadi

@ditadi ditadi commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Why the change

App Analytics now spans an SDK, a server relay, appkit-ui exports, and an auto-start script, so this adds one docs section that explains it as a whole, both for AppKit apps and for apps built without AppKit.

Special things to note

Change outline

 docs/docs/
+├── app-analytics/
+│   ├── _category_.json
+│   ├── getting-started.md     # set up collection, first Action, verify, what must never be collected
+│   ├── using-with-appkit.md   # auto-start, <AppAnalytics />, the relay's answers, turning it off,
+│   │                          #   enabling App telemetry, the dev playground page
+│   ├── events.md              # Action, Page View, Web Vital, properties, what to track
+│   ├── api-reference.md       # data specification: event schema, otel_logs encoding, privacy, compatibility
+│   └── architecture.md        # pipeline, delivery, sessions and sampling, reference relay without AppKit
 └── plugins/
     ├── server.md              # + POST /_analytics/v1/logs, appAnalytics and bodyLimit options
     └── analytics.md           # + note: SQL analytics plugin ≠ App Analytics

This pull request and its description were written by Isaac.

Add an App Analytics section to the docs: getting started, using it with
AppKit, the events it records, the API reference, and the architecture,
including a reference relay for apps built without AppKit.

The server plugin page documents POST /_analytics/v1/logs and the
appAnalytics option. The analytics plugin page notes that it is a
different feature from App Analytics.

Co-authored-by: Isaac <no-reply@databricks.com>
Signed-off-by: ditadi <victordperd@gmail.com>
@ditadi
ditadi added this pull request to stack #616 September 26, 2026 21:42

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant