diff --git a/README.de.md b/README.de.md index 9acfef14..4d4b4679 100644 --- a/README.de.md +++ b/README.de.md @@ -1,5 +1,6 @@ 🇬🇧 English: [README.md](README.md) đŸ‡Ș🇾 Español: [README.es.md](README.es.md) +đŸ‡«đŸ‡· Français: [README.fr.md](README.fr.md) # Telemetry Tracker ![License](https://img.shields.io/github/license/Telemetry-Tracker/telemetry-tracker) diff --git a/README.es.md b/README.es.md index d3f8e33b..c0fdfe81 100644 --- a/README.es.md +++ b/README.es.md @@ -1,5 +1,6 @@ -đŸ‡©đŸ‡Ș Deutsch: [README.de.md](README.de.md) 🇬🇧 English: [README.md](README.md) +đŸ‡©đŸ‡Ș Deutsch: [README.de.md](README.de.md) +đŸ‡«đŸ‡· Français: [README.fr.md](README.fr.md) # Telemetry Tracker ![License](https://img.shields.io/github/license/Telemetry-Tracker/telemetry-tracker) diff --git a/README.fr.md b/README.fr.md new file mode 100644 index 00000000..a0503668 --- /dev/null +++ b/README.fr.md @@ -0,0 +1,318 @@ +🇬🇧 English: [README.md](README.md) +đŸ‡©đŸ‡Ș Deutsch: [README.de.md](README.de.md) +đŸ‡Ș🇾 Español: [README.es.md](README.es.md) +# Telemetry Tracker + +![License](https://img.shields.io/github/license/Telemetry-Tracker/telemetry-tracker) +![GitHub Stars](https://img.shields.io/github/stars/Telemetry-Tracker/telemetry-tracker) +![GitHub Issues](https://img.shields.io/github/issues/Telemetry-Tracker/telemetry-tracker) +![CI](https://github.com/Telemetry-Tracker/telemetry-tracker/actions/workflows/ci.yml/badge.svg) +![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white) +[![npm version](https://img.shields.io/npm/v/@telemetry-tracker/core)](https://www.npmjs.com/package/@telemetry-tracker/core) +[![npm downloads](https://img.shields.io/npm/dm/@telemetry-tracker/core)](https://www.npmjs.com/package/@telemetry-tracker/core) + +

+ 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 du tableau de bord avec erreurs, événements, sessions et métriques de performance + + +

+ +

+ Aperçu — Cartes KPI, tendances des Ă©vĂ©nements, principales erreurs, versions et mĂ©triques de performance (clair/sombre). +

+ +

+ + + Page des erreurs avec KPI, tendances, principaux types d'erreurs et tableau d'erreurs groupé + +

+ +

+ 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](https://telemetry-tracker.com)) | ✅ | +| Forfaits payants (Gratuit / Pro / Business, EUR via Stripe) | ✅ | +| Alertes (notifications & canaux) | ✅ | +| RĂšgles d'alerte (conditions & destinations) | ✅ | +| Source maps | ✅ | + +Configuration auto-hĂ©bergĂ©e : [DEPLOYMENT.md](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](LICENSE)) +- Facile Ă  dĂ©ployer ([DEPLOYMENT.md](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). + +```bash +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 : + +```bash +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](docs/sdk-nuxt.md)) +- ✓ **React Native** — `@telemetry-tracker/react-native` +- ✓ **Vanilla JS** — `@telemetry-tracker/core` + +Guides : [core](docs/sdk-core.md) · [Next.js](docs/sdk-next.md) · [Node](docs/sdk-node.md) · [NestJS](docs/sdk-nestjs.md) · [Vue](docs/sdk-vue.md) · [Nuxt](docs/sdk-nuxt.md) · [React Native](docs/sdk-react-native.md) + +### Exemple + +Installation depuis npm : + +```bash +pnpm add @telemetry-tracker/core +``` + +```ts +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](https://nextjs.org/) — tableau de bord +- [Fastify](https://fastify.dev/) — API +- [Prisma](https://www.prisma.io/) — ORM & migrations +- [PostgreSQL](https://www.postgresql.org/) — base de donnĂ©es +- [TypeScript](https://www.typescriptlang.org/) +- [pnpm](https://pnpm.io/) — monorepo +- [Docker](https://www.docker.com/) — 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](#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](https://github.com/Telemetry-Tracker/telemetry-tracker/issues/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Ă©](https://github.com/Telemetry-Tracker/telemetry-tracker/issues/new?template=feature_request.md). + +--- + +## đŸ€ Contribuer + +Les contributions sont les bienvenues ! Lisez [CONTRIBUTING.md](CONTRIBUTING.md) pour la configuration locale et ce que CI exĂ©cute. + +Bons points de dĂ©part : + +- [**Bonnes premiĂšres issues**](https://github.com/Telemetry-Tracker/telemetry-tracker/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +- Tickets [help wanted](https://github.com/Telemetry-Tracker/telemetry-tracker/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) + +Veuillez suivre le [Code de conduite](CODE_OF_CONDUCT.md). Signalez les problĂšmes de sĂ©curitĂ© en privĂ© via [SECURITY.md](SECURITY.md)—pas dans les tickets publics. + +--- + +## 📚 Documentation + +| Sujet | Doc | +|-------|-----| +| Aperçu de l'architecture | [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | +| Jalons de la feuille de route produit | [docs/ROADMAP.md](docs/ROADMAP.md) | +| RĂšgles d'alerte | [docs/ALERT-RULES.md](docs/ALERT-RULES.md) | +| Webhooks d'alerte / livraison | [docs/ALERT-WEBHOOKS.md](docs/ALERT-WEBHOOKS.md) | +| DĂ©ploiement (aperçu) | [DEPLOYMENT.md](DEPLOYMENT.md) | +| Configuration Railway & dĂ©pannage | [docs/RAILWAY.md](docs/RAILWAY.md) | +| Stripe & Resend (optionnel) | [docs/BILLING.md](docs/BILLING.md) | +| Emails de mise Ă  jour produit | [docs/MARKETING-EMAIL.md](docs/MARKETING-EMAIL.md) | +| Liste de contrĂŽle de production | [docs/PRODUCTION-READINESS.md](docs/PRODUCTION-READINESS.md) | +| Versions & manuel de dĂ©ploiement | [docs/RELEASE.md](docs/RELEASE.md) | +| Journal des modifications | [CHANGELOG.md](CHANGELOG.md) | +| RBAC & modĂšle d'organisation | [docs/RBAC.md](docs/RBAC.md) | +| Forfaits & auth d'ingestion | [docs/ENTITLEMENTS.md](docs/ENTITLEMENTS.md) | +| Nettoyage des PII Ă  l'ingestion | [docs/PII-SCRUBBING.md](docs/PII-SCRUBBING.md) | +| Guides SDK | [docs/sdk-core.md](docs/sdk-core.md), [docs/sdk-next.md](docs/sdk-next.md), [docs/sdk-node.md](docs/sdk-node.md), [docs/sdk-nestjs.md](docs/sdk-nestjs.md), [docs/sdk-vue.md](docs/sdk-vue.md), [docs/sdk-nuxt.md](docs/sdk-nuxt.md), [docs/sdk-react-native.md](docs/sdk-react-native.md) | +| Source maps | [docs/source-maps.md](docs/source-maps.md) | + +**Publier les packages SDK :** `npm login` → `pnpm publish:packages` (voir [CONTRIBUTING.md](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](https://github.com/Telemetry-Tracker/telemetry-tracker/issues/new?template=bug_report.md) +- 💡 [SuggĂ©rez des fonctionnalitĂ©s](https://github.com/Telemetry-Tracker/telemetry-tracker/issues/new?template=feature_request.md) +- đŸ€ Ouvrez une pull request contre **`develop`** ([CONTRIBUTING.md](CONTRIBUTING.md)) + +--- + +## 📄 Licence, marque commerciale & hĂ©bergement + +### Logiciel (MIT) + +Le **code source** de ce projet est sous licence [MIT License](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](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](https://telemetry-tracker.com) est opĂ©rĂ© par [Tacko](https://tacko.io). 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](TRADEMARK.md)** · Partenariats : [info@tacko.io](mailto:info@tacko.io) + +## Contribuer + + +Merci d'envisager une contribution ! Voir les tickets ouverts Ă©tiquetĂ©s `good first issue`. \ No newline at end of file diff --git a/README.md b/README.md index 8a2ba2c2..e211e3ff 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ đŸ‡©đŸ‡Ș Deutsch: [README.de.md](README.de.md) đŸ‡Ș🇾 Español: [README.es.md](README.es.md) +đŸ‡«đŸ‡· Français: [README.fr.md](README.fr.md) # Telemetry Tracker ![License](https://img.shields.io/github/license/Telemetry-Tracker/telemetry-tracker)