Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Contributors: add user-facing changes under **[Unreleased]** in your PR to `deve

### Changed

- **Docs** — mark Performance / Web Vitals, Releases, and Global search as shipped in README (EN/DE/ES) and site `/docs/dashboard`; mark roadmap milestones v1.16.x and v1.17.x as shipped

### Database

---
Expand Down
10 changes: 6 additions & 4 deletions README.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@
| Fehler | ✅ |
| Events | ✅ |
| Sessions | ✅ |
| Performance / Web Vitals | ✅ |
| Releases | ✅ |
| Globale Suche | ✅ |
| Organisationen | ✅ |
| Projekte | ✅ |
| API-Keys | ✅ |
Expand All @@ -61,7 +64,8 @@
| Self-hosted | ✅ |
| Hosted cloud ([telemetry-tracker.com](https://telemetry-tracker.com)) | ✅ |
| Zahlungspläne (Free / Pro / Business, in EUR) | ✅ |
| Benachrichtigungen | ✅ |
| Benachrichtigungen (Notifications & Kanäle) | ✅ |
| Alert-Regeln (Bedingungen & Ziele) | ✅ |
| Source Maps | ✅ |

Self-Hosting-Einrichtung: [DEPLOYMENT.md](DEPLOYMENT.md)
Expand Down Expand Up @@ -203,13 +207,12 @@ Die bereits verfügbaren Funktionen befinden sich oben unter **[Features](#featu
| **In Entwicklung** | Als *Coming soon* gekennzeichnet; Zeitpunkt und Umfang noch offen |

<details>
<summary><strong>Geplant & in Entwicklung</strong> (11 Bereiche — Observierung, Plattform, Konto)</summary>
<summary><strong>Geplant & in Entwicklung</strong> (9 Bereiche — Observierung, Plattform, Konto)</summary>

### Observierung

| Bereich | Status |
|---------|--------|
| [Performance / Web Vitals](https://github.com/Telemetry-Tracker/telemetry-tracker/issues/99) | Geplant |
| Traces | In Entwicklung |
| Logs | In Entwicklung |

Expand All @@ -218,7 +221,6 @@ Die bereits verfügbaren Funktionen befinden sich oben unter **[Features](#featu
| Bereich | Status |
|---------|--------|
| Benutzerdefinierte Dashboards | Geplant |
| Releases | In Entwicklung |
| Feature Flags | In Entwicklung |
| Exportberichte | In Entwicklung |

Expand Down
10 changes: 6 additions & 4 deletions README.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@
| Errores | ✅ |
| Eventos | ✅ |
| Sesiones | ✅ |
| Rendimiento / Web Vitals | ✅ |
| Lanzamientos (Releases) | ✅ |
| Búsqueda global | ✅ |
| Organizaciones | ✅ |
| Proyectos | ✅ |
| API keys | ✅ |
Expand All @@ -61,7 +64,8 @@
| Autoalojado | ✅ |
| Nube alojada ([telemetry-tracker.com](https://telemetry-tracker.com)) | ✅ |
| Planes de pago (Gratis / Pro / Business, EUR mediante Stripe) | ✅ |
| Alertas | ✅ |
| Alertas (notificaciones y canales) | ✅ |
| Reglas de alerta (condiciones y destinos) | ✅ |
| Source maps | ✅ |

Configuración autoalojada: [DEPLOYMENT.md](DEPLOYMENT.md)
Expand Down Expand Up @@ -203,13 +207,12 @@ Las funcionalidades ya implementadas se encuentran en **[Características](#cara
| **En exploración** | Etiquetado como *Próximamente* en el producto; fecha y alcance por definir |

<details>
<summary><strong>Planificado y en exploración</strong> (11 áreas — Observabilidad, Plataforma, Cuenta)</summary>
<summary><strong>Planificado y en exploración</strong> (9 áreas — Observabilidad, Plataforma, Cuenta)</summary>

### Observabilidad

| Área | Estado |
|------|--------|
| Rendimiento / Web Vitals | Planificado |
| Trazas | En exploración |
| Logs | En exploración |

Expand All @@ -218,7 +221,6 @@ Las funcionalidades ya implementadas se encuentran en **[Características](#cara
| Área | Estado |
|------|--------|
| Paneles personalizados | Planificado |
| Lanzamientos | En exploración |
| Feature flags | En exploración |
| Exportar informes | En exploración |

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@
| Errors | ✅ |
| Events | ✅ |
| Sessions | ✅ |
| Performance / Web Vitals | ✅ |
| Releases | ✅ |
| Global search | ✅ |
| Organizations | ✅ |
| Projects | ✅ |
| API keys | ✅ |
Expand All @@ -61,7 +64,8 @@
| Self-hosted | ✅ |
| Hosted cloud ([telemetry-tracker.com](https://telemetry-tracker.com)) | ✅ |
| Paid plans (Free / Pro / Business, EUR via Stripe) | ✅ |
| Alerting | ✅ |
| Alerting (notifications & channels) | ✅ |
| Alert rules (conditions & destinations) | ✅ |
| Source maps | ✅ |

Self-host setup: [DEPLOYMENT.md](DEPLOYMENT.md)
Expand Down Expand Up @@ -203,13 +207,12 @@ Shipped capabilities are in **[Features](#features)** above. What follows is **p
| **Exploring** | Labeled *Coming soon* in the product; timing and scope TBD |

<details>
<summary><strong>Planned & exploring</strong> (11 areas — Observability, Platform, Account)</summary>
<summary><strong>Planned & exploring</strong> (9 areas — Observability, Platform, Account)</summary>

### Observability

| Area | Status |
|------|--------|
| [Performance / Web Vitals](https://github.com/Telemetry-Tracker/telemetry-tracker/issues/99) | Planned |
| Traces | Exploring |
| Logs | Exploring |

Expand All @@ -218,7 +221,6 @@ Shipped capabilities are in **[Features](#features)** above. What follows is **p
| Area | Status |
|------|--------|
| Custom dashboards | Planned |
| Releases | Exploring |
| Feature flags | Exploring |
| Export reports | Exploring |

Expand Down
89 changes: 80 additions & 9 deletions apps/dashboard/app/docs/dashboard/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import { DocsArticle } from "@/app/components/docs/DocsArticle";

export const metadata: Metadata = {
title: "Dashboard — Docs — Telemetry Tracker",
description: "Overview, errors, events, and sessions in the Telemetry Tracker UI",
description:
"Overview, errors, events, sessions, performance, releases, search, compare, and alerts in the Telemetry Tracker UI",
};

export default function DocsDashboardPage() {
Expand All @@ -14,7 +15,7 @@ export default function DocsDashboardPage() {
lede={
<p>
The web app is your control plane: filter by app and time, drill from trends into error
groups, and inspect sessions end to end.
groups, inspect sessions end to end, and monitor releases and Web Vitals.
</p>
}
>
Expand All @@ -27,7 +28,7 @@ export default function DocsDashboardPage() {
In your app: <code className="text-foreground">init(&#123; ingestUrl, app, apiKey &#125;)</code> — see{" "}
<Link href="/docs/sdk">SDK docs</Link>.
</li>
<li>Confirm data on Overview, Errors, Events, and Sessions.</li>
<li>Confirm data on Overview, Errors, Events, Sessions, Performance, and Releases.</li>
</ol>
</section>

Expand All @@ -44,9 +45,10 @@ export default function DocsDashboardPage() {
<section className="mb-10" aria-labelledby="dash-time-range-heading">
<h2 id="dash-time-range-heading">Time range</h2>
<p>
Overview, Errors, Events, and Sessions share a <strong className="text-foreground">Time range</strong>{" "}
picker. Leave it unselected to show the latest rows regardless of age (sorted and paginated).
To narrow results, choose a preset, enter a custom relative window (for example{" "}
Overview, Errors, Events, Sessions, Performance, Releases, and Search share a{" "}
<strong className="text-foreground">Time range</strong> picker. Leave it unselected to show
the latest rows regardless of age (sorted and paginated). To narrow results, choose a
preset, enter a custom relative window (for example{" "}
<code className="text-foreground">2h</code> or <code className="text-foreground">8w</code>
), or pick an absolute <strong className="text-foreground">From</strong> /{" "}
<strong className="text-foreground">To</strong> date range.
Expand All @@ -66,11 +68,23 @@ export default function DocsDashboardPage() {
</p>
</section>

<section className="mb-10" aria-labelledby="dash-compare-heading">
<h2 id="dash-compare-heading">Compare periods</h2>
<p>
Overview, Errors, Events, Sessions, and Performance support an explicit{" "}
<strong className="text-foreground">Compare</strong> mode. Pick a calendar preset (for
example Today vs Yesterday, this week vs last week, this month vs last month; UTC) or equal-
duration custom ranges. Deltas show as New / — when there is no prior baseline. Releases
uses release-vs-previous “New” handling for first-seen versions.
</p>
</section>

<section className="mb-10" aria-labelledby="dash-overview-heading">
<h2 id="dash-overview-heading">Overview</h2>
<p>
High-level counts and trends, plus top error groups and top event names. Use the time range
picker and app/environment filters to narrow scope.
High-level counts and trends, plus top error groups, top event names, recent releases, and
a Performance / Web Vitals snapshot. Use the time range picker and app/environment filters
to narrow scope.
</p>
</section>

Expand All @@ -91,13 +105,70 @@ export default function DocsDashboardPage() {
</p>
</section>

<section aria-labelledby="dash-sessions-heading">
<section className="mb-10" aria-labelledby="dash-sessions-heading">
<h2 id="dash-sessions-heading">Sessions</h2>
<p>
Sessions group activity by session id and optional identity. Filter by time range, then use
the list to jump into a single session’s timeline and metadata.
</p>
</section>

<section className="mb-10" aria-labelledby="dash-performance-heading">
<h2 id="dash-performance-heading">Performance / Web Vitals</h2>
<p>
The <strong className="text-foreground">Performance</strong> page summarizes Core Web
Vitals (LCP, INP/FID, CLS, TTFB) with Good / Needs improvement / Poor ratings, distribution
bars, and trend charts. Tables list slowest{" "}
<code className="text-foreground">$request</code> routes (method, path, count, p50/p95,
error rate) and slowest <code className="text-foreground">$web_vital</code> pages (path,
LCP p75, CLS, samples), with deep links back to Events. Overview also shows a scoped
vitals snapshot with a link into the full report.
</p>
</section>

<section className="mb-10" aria-labelledby="dash-releases-heading">
<h2 id="dash-releases-heading">Releases</h2>
<p>
The <strong className="text-foreground">Releases</strong> page lists versions seen in your
telemetry with health signals (errors, sessions, and related activity) for the selected
time range and filters. Use it to spot regressions after a deploy and jump into scoped
Errors / Events / Sessions for that release.
</p>
</section>

<section className="mb-10" aria-labelledby="dash-search-heading">
<h2 id="dash-search-heading">Global search</h2>
<p>
<strong className="text-foreground">Search</strong> finds issues, events, sessions,
releases, and users in the current project. Use free text and optional{" "}
<code className="text-foreground">key:value</code> filters (for example{" "}
<code className="text-foreground">environment:production</code>,{" "}
<code className="text-foreground">release:…</code>, browser, country, device, platform,
error, user, range). Results are grouped by type with links to open the matching list
views.
</p>
</section>

<section aria-labelledby="dash-alerts-heading">
<h2 id="dash-alerts-heading">Alerts &amp; alert rules</h2>
<p>
<strong className="text-foreground">Alerts</strong> covers notification delivery: email
recipients, webhook / Slack / Discord / Teams / Telegram channels, recent alert events,
and delivery history. <strong className="text-foreground">Alert rules</strong> decide{" "}
<em>when</em> to fire (conditions, thresholds, cooldowns) and which destinations to bind.
Built-in error-spike and quota rules ship as system-managed rules; you can add custom
rules for project-specific thresholds. See also{" "}
<a
href="https://github.com/Telemetry-Tracker/telemetry-tracker/blob/main/docs/ALERT-RULES.md"
className="text-brand hover:underline"
target="_blank"
rel="noopener noreferrer"
>
Alert rules docs
</a>
.
</p>
</section>
</DocsArticle>
);
}
24 changes: 12 additions & 12 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Telemetry Tracker roadmap milestones

Future product lines after the shipped **v1.13.x — Dashboard UX**, **v1.14.x — Notifications**, and **v1.15.x — Alert Rules** lines.
Future product lines after the shipped **v1.13.x — Dashboard UX**, **v1.14.x — Notifications**, **v1.15.x — Alert Rules**, **v1.16.x — Release Intelligence**, and **v1.17.x — Performance Intelligence** lines.

> **Version note:** The thematic roadmap originally drafted Notifications as `v1.13.x`, but that line number was already used for Dashboard UX (`v1.13.0`–`v1.13.2`). Notifications therefore started at **`v1.14.x`**, with later themes shifted by one.

Expand All @@ -9,15 +9,15 @@ Roadmap **priorities** (P3–P9, etc.) remain independent of release numbering.
## Progression

```text
v1.13.x Dashboard UX (shipped)
v1.13.x Dashboard UX (shipped)
v1.14.x Notifications (shipped)
v1.14.x Notifications (shipped)
v1.15.x Alert Rules (shipped)
v1.15.x Alert Rules (shipped)
v1.16.x Release Intelligence
v1.16.x Release Intelligence (shipped)
v1.17.x Performance Intelligence
v1.17.x Performance Intelligence (shipped)
v1.18.x AI Intelligence
Expand All @@ -33,8 +33,8 @@ v1.20.x Data & Export
| [v1.13.x — Dashboard UX](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/12) | Nav/rename/ATF polish | Shipped (#480, #482, #484, #486, …) |
| [v1.14.x — Notifications](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/17) | Operational awareness | Shipped — parent #492; children #508, #499, #223, #224, #225, #500, … |
| [v1.15.x — Alert Rules](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/18) | When & where to notify | Shipped — parent #493; children #532–#536 (foundation, UX, conditions + cron, built-ins, release) |
| [v1.16.x — Release Intelligence](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/19) | Release health + search | #453, #494 |
| [v1.17.x — Performance Intelligence](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/20) | Compare + performance UX | #495, #197, #196 |
| [v1.16.x — Release Intelligence](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/19) | Release health + search | Shipped — #453, #494 |
| [v1.17.x — Performance Intelligence](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/20) | Compare + performance UX | Shipped — #495, #196, #197 |
| [v1.18.x — AI Intelligence](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/21) | Grounded AI summaries | #496 |
| [v1.19.x — Organization Management](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/22) | Org defaults + PII | #497, #477, #476 |
| [v1.20.x — Data & Export](https://github.com/Telemetry-Tracker/telemetry-tracker/milestone/23) | Export & share | #498 |
Expand All @@ -49,13 +49,13 @@ Know immediately when something important happens. Notification Center, email fa

Decide when notifications should be generated and where they should be delivered. See [ALERT-RULES.md](./ALERT-RULES.md). Ops: schedule the [alert-rules-evaluator cron](./RAILWAY.md#alert-rules-evaluator-cron) for non-ingest conditions.

### v1.16.x — Release Intelligence
### v1.16.x — Release Intelligence (shipped)

Understand release health and find telemetry across releases, errors, events, and sessions.
Understand release health and find telemetry across releases, errors, events, and sessions. Releases page plus Global search (#453, #494).

### v1.17.x — Performance Intelligence
### v1.17.x — Performance Intelligence (shipped)

Understand whether application health is improving or regressing over time.
Understand whether application health is improving or regressing over time. Compare periods, Performance / Web Vitals (including Overview card), and slow routes / pages (#495, #196, #197).

### v1.18.x — AI Intelligence

Expand Down
Loading