🇬🇧 English: README.md 🇪🇸 Español: README.es.md 🇫🇷 Français: README.fr.md

Telemetry Tracker

Open-source Fehlerverfolgung, Produktanalyse, und Sitzungstelemetrie.

Entweder ressourcenschonend und self-hosted für die eigene Infrastruktur — oder über den offiziellen Cloud-Dienst bei telemetry-tracker.com über Stripe (EUR).

_{Übersicht — KPI-Karten, Event-Trends, häufigste Fehler, Releases und Performance-Daten (Hell-/Dunkelmodus).}

_{Fehler — KPIs, Trends nach Typ, häufigste Fehler und eine filterbare, gruppierte Fehlertabelle (Hell-/Dunkelmodus).}

---

Funktionen

Funktion	Unterstützung
Fehler	✅
Events	✅
Sessions	✅
Performance / Web Vitals	✅
Releases	✅
Globale Suche	✅
Organisationen	✅
Projekte	✅
API-Keys	✅
Dashboard	✅
REST API	✅
SDKs (@telemetry-tracker/*)	✅
Self-hosted	✅
Hosted cloud (telemetry-tracker.com)	✅
Zahlungspläne (Free / Pro / Business, in EUR)	✅
Benachrichtigungen (Notifications & Kanäle)	✅
Alert-Regeln (Bedingungen & Ziele)	✅
Source Maps	✅

Self-Hosting-Einrichtung: DEPLOYMENT.md

---

Warum Telemetry Tracker?

Telemetry Tracker bietet die wichtigsten Funktionen, die die meisten Anwendungen benötigen – Fehlerverfolgung, Produktanalyse-Ereignisse und Sitzungs-Telemetrie – ohne die Komplexität von Enterprise-Observability-Plattformen.

• Self-hosted für eigene Anwendungen
• Offizielle gehostete Cloud mit Abrechnung in Euro (EUR)
• Ressourcenschonend
• Einfache APIs
• Open Source (MIT)
• Einfach bereitzustellen (DEPLOYMENT.md)

---

Architektur

Client SDK
    ↓  Datenaufnahme (API key)
   API  ←──  Dashboard (Sitzungsauthentifizierung)
    ↓
 PostgreSQL

Anwendungen senden Fehler, Ereignisse und Sitzungen über @telemetry-tracker/* an die API. Das Dashboard liest die Telemetriedaten über dieselbe API – niemals direkt aus der Datenbank.

---

🚀 Installation

Lokale Telemetry-Tracker-Installation in weniger als 5 Minuten.

Voraussetzungen: Node.js 18+, pnpm 9, PostgreSQL 16 (oder Docker).

git clone https://github.com/Telemetry-Tracker/telemetry-tracker.git
cd telemetry-tracker
pnpm install
docker compose up -d
cp apps/api/.env.example apps/api/.env
cp apps/dashboard/.env.example apps/dashboard/.env
pnpm db:migrate

In zwei Konsolen:

pnpm dev:api        # API → http://localhost:3001
pnpm dev:dashboard  # Dashboard → http://localhost:3000

Danach:

1. Öffne http://localhost:3000, klicke Start tracking, und erstelle einen Account.
2. Erstelle eine Organisation und ein Projekt in den Organisationseinstellungen.
3. Erstelle einen API-Key unter Settings → API-keys (kopiere den tt_live_… secret einmalig).
4. Benutze deine App (siehe SDK-Beispiel) und überprüfe Overview im Dashboard.

---

SDK

Kompatibel mit:

• ✓ React / Vue — @telemetry-tracker/core
• ✓ Next.js — @telemetry-tracker/next
• ✓ Node / NestJS — @telemetry-tracker/node
• ✓ Nuxt — @telemetry-tracker/core (Anleitung)
• ✓ React Native — @telemetry-tracker/react-native
• ✓ Vanilla JS — @telemetry-tracker/core

Anleitungen core · Next.js · Node · NestJS · Vue · Nuxt · React Native

Beispiel

Mit npm installieren:

pnpm add @telemetry-tracker/core

import { init, trackEvent, trackError } from "@telemetry-tracker/core";

init({
  ingestUrl: "http://localhost:3001",
  app: "my-app",
  apiKey: process.env.TELEMETRY_API_KEY!, // tt_live_… vom Dashboard
  environment: "development",
});

trackEvent("user_registered");
trackError(new Error("Something broke"));

---

🏗 Projektstruktur

apps/
  api/          # Fastify ingest + read API, Prisma, auth, billing
  dashboard/    # Next.js UI

packages/
  telemetry-core/
  telemetry-node/
  telemetry-next/
  telemetry-react-native/

---

Erstellt mit

• Next.js — Dashboard
• Fastify — API
• Prisma — ORM & migrations
• PostgreSQL — Datenbank
• TypeScript
• pnpm — Monorepo
• Docker — Lokale Entwicklung (Postgres über docker compose; Dashboard-Produktions-image)

---

Ablaufplan

Die bereits verfügbaren Funktionen befinden sich oben unter Features. Im Folgenden werden geplante und in Entwicklung befindliche Arbeiten aufgeführt, kein Veröffentlichungsplan. Elemente, die im Dashboard als Coming soon gekennzeichnet sind, entsprechen dieser Liste (#96).

Status	Erklärung
Geplant	In einer GitHub-Issue definiert oder erfasst
In Entwicklung	Als Coming soon gekennzeichnet; Zeitpunkt und Umfang noch offen

Geplant & in Entwicklung (9 Bereiche — Observierung, Plattform, Konto)

Observierung

Bereich	Status
Traces	In Entwicklung
Logs	In Entwicklung

Plattform

Bereich	Status
Benutzerdefinierte Dashboards	Geplant
Feature Flags	In Entwicklung
Exportberichte	In Entwicklung

Konto & Organisation

Bereich	Status
Team-Audit-Protokoll	Geplant
Integrationen	In Entwicklung
Profil, Einstellungen & Sicherheit	In Entwicklung

Sie haben eine Idee? Feature vorschlagen.

---

🤝 Beiträge

Beiträge sind willkommen! Lies CONTRIBUTING.md für ein lokales Setup und welche CI-Workflows ausgeführt werden.

Gute Einstiegspunkte:

• Good first issues
• help wanted issues

Bitte befolgen Sie den Code of Conduct. Melden Sie Sicherheitslücken via SECURITY.md—nicht über öffentliche issues.

---

📚 Dokumentation

Thema	Dokumentation
Architekturübersicht	docs/ARCHITECTURE.md
Bereitstellung (Übersicht)	DEPLOYMENT.md
Railway-Einrichtung & Fehlerbehebung	docs/RAILWAY.md
Stripe & Resend (optional)	docs/BILLING.md
Checkliste für den Produktivbetrieb	docs/PRODUCTION-READINESS.md
Releases & Bereitstellungsleitfaden	docs/RELEASE.md
Änderungsprotokoll	CHANGELOG.md
RBAC & Organisationsmodell	docs/RBAC.md
Tarife & Ingest-Authentifizierung	docs/ENTITLEMENTS.md
SDK-Anleitungen	docs/sdk-core.md, docs/sdk-next.md, docs/sdk-node.md, docs/sdk-nestjs.md, docs/sdk-vue.md, docs/sdk-nuxt.md, docs/sdk-react-native.md
Source Maps	docs/source-maps.md

SDK-Pakete veröffentlichen: npm login → pnpm publish:packages (siehe CONTRIBUTING.md und die Skripte in der package.json im Hauptverzeichnis).

GitHub Social Preview: Unter Repository → Settings → General → Social preview https://telemetry-tracker.com/og-banner.png verwenden (1024×409 Marketing-Banner), sobald das Dashboard bereitgestellt wurde. Installationspfad für Dokumentation und Marketing: @telemetry-tracker/core (siehe npm-Badges oben).

---

❤️ Unterstütze das Projekt

Wenn Sie Telemetry Tracker hilfreich finden:

• ⭐ Geben Sie diesem Projekt einen Stern
• 🐛 Fehler Melden
• 💡 Features empfehlen
• 🤝 Öffnen eines pull requests

---

📄 Lizenz, Markenrecht & Hosting

Software (MIT)

Der Quellcode dieses Projekts ist unter der MIT-Lizenz lizenziert. Du darfst die Software unter diesen Bedingungen verwenden, verändern, selbst hosten und weiterverbreiten, einschließlich des Copyright-Hinweises in den von dir verbreiteten Kopien.

Die MIT-Lizenz deckt das Urheberrecht am Quellcode ab. Sie gewährt keine Rechte zur Nutzung des Namens oder der Marke Telemetry Tracker in einer Weise, die den Eindruck erweckt, dass Tacko deinen Dienst betreibt oder unterstützt. Siehe TRADEMARK.md.

Self-Hosting

Du darfst Telemetry Tracker auf einer von dir kontrollierten Infrastruktur für deine eigenen Anwendungen betreiben – hierfür ist unter der MIT-Lizenz keine gesonderte Genehmigung erforderlich.

Offiziell gehostete Cloud

Der verwaltete Dienst unter telemetry-tracker.com wird von Tacko betrieben. Die Tarife Pro und Business werden dort über Stripe in EUR abgerechnet.

Marke & konkurrierende gehostete Dienste

Biete keinen mandantenfähigen Hosting-Dienst für Dritte unter dem Namen, Logo oder Marketing von Telemetry Tracker an, als wäre es das offizielle Produkt. Forks und interne Bereitstellungen sollten einen eigenständigen Namen verwenden, sofern du keine schriftliche Genehmigung von Tacko hast.

Details und Beispiele: TRADEMARK.md · Partnerschaften: [email protected]