Skip to content

Commit 08d2e8a

Browse files
committed
Document Telemetry beta and distinguish edge traffic stats
1 parent 195f31c commit 08d2e8a

4 files changed

Lines changed: 68 additions & 1 deletion

File tree

‎content/(serve)/meta.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ export default defineMeta({
1010
"routing",
1111
"caching",
1212
"stats",
13+
"telemetry",
1314
"access",
1415
"customization",
1516
"site-pages",

‎content/(serve)/stats.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Requests, views, unique visitors, and top paths for a Space, where
55

66
Views exclude crawlers and failed requests. Requests count every HTTP request, and unique visitors use a separate daily count without those filters.
77

8+
Looking for live visitors or engagement history? See [Telemetry (Beta)](/telemetry). This page covers edge traffic stats, not Telemetry's Now and Trends views.
9+
810
## Where to look
911

1012
Open the Space and go to **Settings → Stats**. A segmented control labelled **Time period** switches between three windows.
@@ -76,4 +78,4 @@ There is no window-level request total in the payload. Sum `series[].requests` f
7678

7779
## This is not Google Analytics
7880

79-
These numbers are the edge's own accounting, and they are all you get from Spacefast. If you want page-level product analytics, add your own tag. **Customization → Google Analytics** takes a GA4 measurement id or a Tag Manager container id and injects it into every published page. That is a separate feature with a separate switch. See [Customization](/customization).
81+
These numbers are the edge's own accounting. [Telemetry (Beta)](/telemetry) provides separate visitor analytics where enabled. You can also add your own tag: **Customization → Google Analytics** takes a GA4 measurement id or a Tag Manager container id and injects it into every published page. That is a separate feature with a separate switch. See [Customization](/customization).

‎content/(serve)/telemetry.mdx‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Telemetry (Beta)
3+
description: Watch visitors live in Now and explore visitor history in Trends, with beta availability and the difference from edge traffic stats
4+
---
5+
6+
Telemetry shows who's on your Space now and how visits change over time. Use **Now** to watch live activity and **Trends** to explore visitor history over 7, 30, or 90 days.
7+
8+
## Open Telemetry
9+
10+
Open your Space in the dashboard and choose **Telemetry**. You must be signed in as an editor of the Space.
11+
12+
Telemetry is in beta and must be enabled for both your team and your Space. If the menu is missing, or the page says **Analytics is off for this Space**, contact [support](mailto:support@spacefast.com). There is no self-service switch to enable the beta.
13+
14+
The dashboard page does not require Comments. The live and history views depend on separate services: if only one is configured, only its card appears. **Telemetry isn't set up here** means neither is available on that deployment.
15+
16+
Collection on published pages requires **Page enhancements** to be on in the Space's **Settings**. Telemetry uses a browser tracker, unlike the script-free edge stats. Opening the dashboard does not by itself start collecting visits from a site with page enhancements off.
17+
18+
## What can I do with Telemetry?
19+
20+
| View | Use it to |
21+
| --- | --- |
22+
| Now | See how many visitors are here, which pages they're on, and recent arrivals |
23+
| Now | Inspect sources, countries, engagement, and recent events where those measurements are available |
24+
| Trends | Follow visitors, page views, and engaged time over 7, 30, or 90 days |
25+
| Trends | Find top pages, compare page traffic with the previous period, and inspect engagement by page |
26+
| Trends | Review referrers and scroll depth |
27+
28+
The Space's analytics profile changes which live views come first. A measurement the source cannot supply is shown as unavailable or left out, not counted as zero. Visitor analytics counts visitors without listing individual people.
29+
30+
If Trends cannot be reached, reload the page to try again. A gap or an error is not evidence that nobody visited.
31+
32+
## Watch on the published site
33+
34+
For a published Space, the page can offer **Watch on site** or **Open site**. **Watch on site** opens the live site with its Telemetry drawer. That drawer requires page enhancements and Comments enabled on the live Space, not only on previews. Otherwise, **Open site** opens the site without promising a drawer.
35+
36+
You can use the dashboard's Now and Trends cards without enabling Comments.
37+
38+
## Telemetry or traffic stats?
39+
40+
Telemetry is visitor analytics. [Traffic stats](/stats) are the edge's request accounting, available under **Settings → Stats** and through `sf analytics`. They count requests and views differently and use windows of 48 hours, 7 days, or 30 days. The CLI command does not return the Telemetry cards.
41+
42+
Use Stats to inspect requests, bandwidth, and busy paths. Use Telemetry to watch visitors and explore engagement over time. Do not expect their totals to match.
43+
44+
[Google Analytics and Tag Manager](/customization) are separate integrations. Adding one of those tags does not enable the Telemetry beta.

‎scripts/docs-experience.test.mjs‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,27 @@ test("Troubleshooting gives a first diagnostic step before the error catalog", a
8686
assert.match(troubleshooting.slice(0, errors), /last publish and its status/iu);
8787
});
8888

89+
test("Telemetry preserves beta gates and separates visitor analytics from edge stats", async () => {
90+
const telemetry = await builtPage("/telemetry");
91+
const stats = await builtPage("/stats");
92+
assert.match(telemetry, /enabled for both your team and your Space/iu);
93+
assert.match(telemetry, /no self-service switch/iu);
94+
assert.match(telemetry, /signed in as an editor/iu);
95+
assert.match(telemetry, /Collection on published pages requires/iu);
96+
assert.match(telemetry, /Page enhancements/u);
97+
assert.match(telemetry, /does not require Comments/iu);
98+
assert.match(telemetry, /CLI command does not return the Telemetry cards/iu);
99+
assert.match(telemetry, /\[Traffic stats\]\(\/docs\/stats\)/u);
100+
assert.match(stats, /\[Telemetry \(Beta\)\]\(\/docs\/telemetry\)/u);
101+
assert.doesNotMatch(stats, /all you get from Spacefast/iu);
102+
});
103+
89104
const firstFactCases = [
105+
{
106+
route: "/telemetry",
107+
question: "What can I do with Telemetry?",
108+
evidence: [/Now/u, /Trends/u, /live activity/iu, /7, 30, or 90 days/u],
109+
},
90110
{
91111
route: "/versions",
92112
question: "Does rollback rebuild, and which versions can it use?",

0 commit comments

Comments
 (0)