integration-ruby

Par posthog · skills

Intégration PostHog pour toute application Ruby utilisant le SDK Ruby

npx skills add https://github.com/posthog/skills --skill integration-ruby

Intégration PostHog pour Ruby

Cette skill vous aide à ajouter PostHog analytics à vos applications Ruby.

Workflow

Suivez ces étapes dans l'ordre pour compléter l'intégration :

  1. basic-integration-1.0-begin.md - Configuration PostHog - Début ← Commencez ici
  2. basic-integration-1.1-edit.md - Configuration PostHog - Édition
  3. basic-integration-1.2-revise.md - Configuration PostHog - Révision
  4. basic-integration-1.3-conclude.md - Configuration PostHog - Conclusion

Fichiers de référence

  • references/EXAMPLE.md - Code de projet d'exemple Ruby
  • references/ruby.md - Ruby - documentation
  • references/identify-users.md - Identifier les utilisateurs - documentation
  • references/basic-integration-1.0-begin.md - Configuration PostHog - début
  • references/basic-integration-1.1-edit.md - Configuration PostHog - édition
  • references/basic-integration-1.2-revise.md - Configuration PostHog - révision
  • references/basic-integration-1.3-conclude.md - Configuration PostHog - conclusion

Le projet d'exemple montre le modèle d'implémentation cible. Consultez la documentation pour les détails de l'API.

Principes clés

  • Variables d'environnement : Utilisez toujours les variables d'environnement pour les clés PostHog. Ne les codez jamais en dur.
  • Changements minimaux : Ajoutez le code PostHog aux côtés des intégrations existantes. Ne remplacez ou ne restructurez pas le code existant.
  • Respectez l'exemple : Votre implémentation doit suivre les patterns du projet d'exemple aussi fidèlement que possible.

Directives du framework

  • posthog-ruby est le nom de la gem SDK Ruby (ajoutez gem 'posthog-ruby' au Gemfile) mais importez-la avec require 'posthog' (PAS require 'posthog-ruby')
  • Utilisez PostHog::Client.new(api_key: key, host: host) pour l'initialisation basée sur une instance dans les scripts et CLIs
  • Dans les CLIs et scripts : vous DEVEZ appeler client.shutdown avant la sortie sinon tous les événements sont perdus
  • Utilisez begin/rescue/ensure avec shutdown dans le bloc ensure pour un nettoyage approprié
  • capture et identify prennent un seul argument hash : client.capture(distinct_id: 'user_123', event: 'my_event', properties: { key: 'value' })
  • capture_exception prend des arguments POSITIONNELS (pas des mots-clés) : client.capture_exception(exception, distinct_id, additional_properties) — N'UTILISEZ PAS la syntaxe distinct_id: en mot-clé

Identification des utilisateurs

Identifiez les utilisateurs lors des événements de connexion et d'inscription. Consultez le code d'exemple et la documentation pour le pattern d'identification correct pour ce framework. Si du code frontend et backend existe, transmettez la session côté client et l'identifiant distinct en utilisant les en-têtes X-POSTHOG-DISTINCT-ID et X-POSTHOG-SESSION-ID pour maintenir la corrélation.

Suivi des erreurs

Ajoutez le suivi des erreurs PostHog aux fichiers pertinents, particulièrement autour des flux utilisateur critiques et des limites d'API.

Skills similaires