🇬🇧 English: README.md 🇩🇪 Deutsch: README.de.md 🇪🇸 Español: README.es.md

Telemetry Tracker

Suivi d'erreurs open-source, analytics produit et télémétrie de session.

Léger et auto-hébergé pour votre propre infrastructure—ou utilisez le cloud officiel hébergé sur telemetry-tracker.com avec facturation Stripe (EUR).

_{Aperçu — Cartes KPI, tendances des événements, principales erreurs, versions et métriques de performance (clair/sombre).}

_{Erreurs — KPI, tendances par type, principales erreurs et tableau d'erreurs groupé filtrable (clair/sombre).}

---

Fonctionnalités

Fonctionnalité	Supportée
Erreurs	✅
Événements	✅
Sessions	✅
Performance / Web Vitals	✅
Versions	✅
Recherche globale	✅
Organisations	✅
Projets	✅
Clés API	✅
Tableau de bord	✅
API REST	✅
SDKs (@telemetry-tracker/*)	✅
Auto-hébergement	✅
Cloud hébergé (telemetry-tracker.com)	✅
Forfaits payants (Gratuit / Pro / Business, EUR via Stripe)	✅
Alertes (notifications & canaux)	✅
Règles d'alerte (conditions & destinations)	✅
Source maps	✅

Les alertes sont livrées par notifications dans l'application, e-mail, webhooks HTTPS, Slack, Discord, Microsoft Teams et Telegram. Slack, Discord et Microsoft Teams utilisent des URL de webhook entrant (Teams utilise les anciens webhooks Office 365 MessageCard). Telegram utilise une URL sendMessage de l'API Bot ainsi qu'un identifiant de chat. Il ne s'agit pas d'installations d'applications OAuth. L'éditeur de règles du tableau de bord crée actuellement des conditions basées sur le nombre d'erreurs.

Configuration auto-hébergée : DEPLOYMENT.md

---

Pourquoi Telemetry Tracker ?

Telemetry Tracker fournit les blocs de construction essentiels dont la plupart des applications ont besoin—suivi d'erreurs, analytics produit et télémétrie de session—sans la complexité des plateformes d'observabilité d'entreprise.

• Auto-hébergé pour vos propres produits
• Cloud officiel hébergé avec facturation en EUR
• Léger
• APIs simples
• Open source (MIT)
• Facile à déployer (DEPLOYMENT.md)

---

Architecture

Client SDK
    ↓  ingestion (clé API)
   API  ←──  Tableau de bord (authentification par session)
    ↓
 PostgreSQL

Les applications envoient les erreurs, événements et sessions à l'API via @telemetry-tracker/*. Le tableau de bord lit la télémétrie via la même API—jamais directement depuis la base de données.

---

🚀 Démarrage rapide

Faites fonctionner Telemetry Tracker localement en moins de 5 minutes.

Prérequis : Node.js 18+, pnpm 9, PostgreSQL 16 (Docker fonctionne).

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

Dans deux terminaux :

pnpm dev:api        # API → http://localhost:3001
pnpm dev:dashboard  # Tableau de bord → http://localhost:3000

Ensuite :

1. Ouvrez http://localhost:3000, cliquez sur Start tracking et créez un compte.
2. Créez une organisation et un projet dans les paramètres de l'organisation.
3. Créez une clé API dans Paramètres → Clés API (copiez le secret tt_live_… une seule fois).
4. Instrumentez votre application (voir l'exemple SDK ci-dessous) et consultez l'Aperçu dans le tableau de bord.

---

SDK

Fonctionne avec :

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

Guides : core · Next.js · Node · NestJS · Vue · Nuxt · React Native

Exemple

Installation depuis npm :

pnpm add @telemetry-tracker/core

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

init({
  ingestUrl: "http://localhost:3001",
  app: "mon-app",
  apiKey: process.env.TELEMETRY_API_KEY!, // tt_live_… depuis le tableau de bord
  environment: "development",
});

trackEvent("utilisateur_inscrit");
trackError(new Error("Quelque chose s'est mal passé"));

---

🏗 Structure du projet

apps/
  api/          # API Fastify d'ingestion + lecture, Prisma, auth, facturation
  dashboard/    # Interface Next.js

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

---

Construit avec

• Next.js — tableau de bord
• Fastify — API
• Prisma — ORM & migrations
• PostgreSQL — base de données
• TypeScript
• pnpm — monorepo
• Docker — développement local (Postgres via docker compose ; image de production du tableau de bord)

---

Feuille de route

Les fonctionnalités livrées sont dans Fonctionnalités ci-dessus. Ce qui suit est un travail planifié et exploratoire—regroupé par domaine, pas un calendrier de publication. Les éléments marqués Bientôt disponible dans le tableau de bord correspondent à cette liste (#96).

Statut	Signification
Planifié	Délimité ou suivi dans un ticket GitHub
Exploration	Étiqueté Bientôt disponible dans le produit ; calendrier et périmètre à déterminer

Planifié & exploration (9 domaines — Observabilité, Plateforme, Compte)

Observabilité

Domaine	Statut
Traces	Exploration
Logs	Exploration

Plateforme

Domaine	Statut
Tableaux de bord personnalisés	Planifié
Feature flags	Exploration
Exportation de rapports	Exploration

Compte & organisation

Domaine	Statut
Journal d'audit d'équipe	Planifié
Intégrations	Exploration
Profil, préférences & sécurité	Exploration

Vous avez une idée ? Ouvrez une demande de fonctionnalité.

---

🤝 Contribuer

Les contributions sont les bienvenues ! Lisez CONTRIBUTING.md pour la configuration locale et ce que CI exécute.

Bons points de départ :

• Bonnes premières issues
• Tickets help wanted

Veuillez suivre le Code de conduite. Signalez les problèmes de sécurité en privé via SECURITY.md—pas dans les tickets publics.

---

📚 Documentation

Sujet	Doc
Aperçu de l'architecture	docs/ARCHITECTURE.md
Jalons de la feuille de route produit	docs/ROADMAP.md
Règles d'alerte	docs/ALERT-RULES.md
Webhooks d'alerte / livraison	docs/ALERT-WEBHOOKS.md
Déploiement (aperçu)	DEPLOYMENT.md
Configuration Railway & dépannage	docs/RAILWAY.md
Stripe & Resend (optionnel)	docs/BILLING.md
Emails de mise à jour produit	docs/MARKETING-EMAIL.md
Liste de contrôle de production	docs/PRODUCTION-READINESS.md
Versions & manuel de déploiement	docs/RELEASE.md
Journal des modifications	CHANGELOG.md
RBAC & modèle d'organisation	docs/RBAC.md
Forfaits & auth d'ingestion	docs/ENTITLEMENTS.md
Nettoyage des PII à l'ingestion	docs/PII-SCRUBBING.md
Guides SDK	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

Publier les packages SDK : npm login → pnpm publish:packages (voir CONTRIBUTING.md et les scripts dans le package.json racine).

Aperçu social GitHub : Dans le dépôt Paramètres → Général → Aperçu social, utilisez https://telemetry-tracker.com/og-banner.png (bannière marketing 1024×409) une fois le tableau de bord déployé. Chemin d'installation pour la documentation et le marketing : @telemetry-tracker/core (voir les badges npm ci-dessus).

---

❤️ Soutenir le projet

Si vous trouvez Telemetry Tracker utile :

• ⭐ Mettez une étoile sur ce dépôt
• 🐛 Signalez des bugs
• 💡 Suggérez des fonctionnalités
• 🤝 Ouvrez une pull request contre develop (CONTRIBUTING.md)

---

📄 Licence, marque commerciale & hébergement

Logiciel (MIT)

Le code source de ce projet est sous licence MIT License. Vous pouvez utiliser, modifier, auto-héberger et distribuer le logiciel selon ces conditions, y compris la mention de copyright dans les copies que vous distribuez.

La licence MIT couvre le copyright sur le code. Elle n'accorde pas de droits pour utiliser le nom Telemetry Tracker ou l'image de marque de manière à suggérer que Tacko exploite ou approuve votre service. Voir TRADEMARK.md.

Auto-hébergement

Vous pouvez exécuter Telemetry Tracker sur une infrastructure que vous contrôlez pour vos propres applications—aucune permission supplémentaire requise sous la licence MIT.

Cloud officiel hébergé

Le service managé sur telemetry-tracker.com est opéré par Tacko. Les forfaits Pro et Business y sont facturés en EUR via Stripe.

Marque & services hébergés concurrents

N'offrez pas de service hébergé multi-tenant à des tiers utilisant le nom Telemetry Tracker, le logo ou le marketing comme s'il s'agissait du produit officiel. Les forks et les déploiements internes doivent utiliser un nom distinct sauf si vous avez une autorisation écrite de Tacko.

Détails et exemples : TRADEMARK.md · Partenariats : [email protected]

Contribuer

Merci d'envisager une contribution ! Voir les tickets ouverts étiquetés good first issue.