Installation par plateforme
Ruby et Rails
Installation gem install blipit
Ajoutez la gem blipit (0.3.0 ou plus récente) et appelez init une fois avec la clé publique de votre projet. Elle fonctionne sur le cœur de Blipit, sans dépendance à l'exécution. Les exceptions non gérées sont signalées d'elles-mêmes, et Rails, Rack, Sinatra et Sidekiq sont intégrés.
1Gemfile
gem "blipit"2Initialiser au démarrage
Rails : config/initializers/blipit.rb ; rien d'autre à installer, car Blipit ajoute lui-même son middleware Rack, le suivi d'Active Job et de Rails.error. Les applications Rack et Sinatra ajoutent use Blipit::Rack. Scripts : avant l'exécution de votre code. La clé se trouve sur la page Clés du projet. Avec une clé vide, init affiche un avertissement et renvoie false au lieu de lever une exception.
Blipit.init(
key: "<public key>",
environment: Rails.env,
release: ENV["RELEASE"],
)3Obtenir vos clés
Connectez-vous sur app.blipit.io et ouvrez Clés API dans la barre latérale, puis votre projet. Chaque projet a deux clés. La clé publique commence par blipit_pk_ : elle va dans le code navigateur et applicatif, ne peut qu'envoyer des événements et peut être vue par n'importe qui sans risque. La clé secrète commence par blipit_sk_ : elle reste sur votre serveur ou dans Odoo, jamais dans un navigateur, car elle peut aussi lire et modifier les problèmes. La clé secrète n'est affichée qu'une fois, juste après sa création, alors copiez-la à ce moment-là ; si vous la perdez, appuyez sur Créer une nouvelle clé secrète, et l'ancienne cesse aussitôt de fonctionner. Certains SDK ont aussi besoin de l'identifiant de projet, affiché sur la même page.
4Gardez la clé dans les credentials Rails
Ce SDK envoie avec la clé publique. Dans Rails, gardez-la dans les credentials chiffrés et lisez-la dans l'initializer ; ailleurs, utilisez une variable d'environnement.
bin/rails credentials:editblipit:
key: blipit_pk_your_public_keyBlipit.init(
key: Rails.application.credentials.dig(:blipit, :key),
environment: Rails.env,
)5Gardez les clés hors de git
Gardez les clés dans des variables d'environnement ou dans les réglages de secrets de votre hébergeur, jamais dans du code que vous committez, et ajoutez vos fichiers .env à .gitignore. Une clé publique dans une page web est normale. Si une clé secrète se retrouve un jour dans git, sur une page publique, dans une capture d'écran ou dans un chat, ouvrez Clés API, appuyez sur Créer une nouvelle clé secrète, et collez la nouvelle clé partout où l'ancienne était utilisée : l'ancienne clé cesse immédiatement de fonctionner.
.env
.env.local
.env.*.local6Capture manuelle et tentatives de connexion
Les tentatives de connexion exigent la clé secrète : sur le serveur, initialisez avec la clé secrète au lieu de la clé publique, sinon l'ingestion les refuse avec 403 security_needs_secret_key. Offre Scale.
Blipit.capture_exception(e)
Blipit.capture_message("cache miss rate above 50%", level: :warning)
Blipit.set_user(id: "42", email: "ana@example.com")
Blipit.capture_security("login_failed", email, outcome: "bad_password", ip: request.remote_ip, user_agent: request.user_agent)7Vérifier que ça fonctionne
Ouvrez Problèmes dans app.blipit.io. Le premier événement apparaît en quelques secondes, regroupé en un problème, et les responsables reçoivent un e-mail.
Blipit.capture_message("Hello from Rails")Bon à savoir
- Passez traces_sample_rate: 0.2 à init et les requêtes, jobs, appels Net::HTTP et requêtes SQL apparaissent sur la page Pulse.
- Mise à jour depuis 0.2 : project: n'est plus nécessaire (il reste accepté), Blipit.dsn a disparu, et before_send reçoit désormais l'événement sous forme de Hash au format de Blipit.
- Garder Blipit à jour : le guide Garder Blipit à jour (docs.blipit.io/updates) explique la bannière de mise à jour, les e-mails pour les versions importantes, l'avis dans votre console de développement et la commande de mise à jour pour cette plateforme.
- Un projet par application et par plateforme : chaque projet choisit sa plateforme à sa création (Android, iOS, React Native, Flutter, Web, Backend ou Odoo), et Blipit refuse avec une erreur claire les données de toute autre plateforme. Une app iOS et une app Android ont donc besoin de deux projets avec deux clés. Les releases, les versions, les taux de plantage et les builds des stores diffèrent selon la plateforme, et les mélanger dans un projet les rend tous faux. Un projet Web accepte aussi la partie serveur de la même app web (le serveur Next.js ou Node), et un projet React Native ou Flutter accepte aussi ses propres rapports de plantage natifs Android et iOS.
Bloqué ? Écrivez à support@blipit.io. Les clés et l'identifiant de chaque projet sont sous Clés API dans app.blipit.io.

