按平台安装
Ruby 和 Rails
安装 gem install blipit
添加 blipit gem(0.3.0 或更高版本),并用项目的公钥调用一次 init。它运行在 Blipit 自有内核上,没有运行时依赖。未处理的异常会自动上报,并内置 Rails、Rack、Sinatra 和 Sidekiq 支持。
1Gemfile
gem "blipit"2启动时初始化
Rails:放在 config/initializers/blipit.rb;无需再安装其他东西,因为 Blipit 会自动添加其 Rack 中间件、Active Job 和 Rails.error 上报。Rack 和 Sinatra 应用添加 use Blipit::Rack。脚本:放在代码运行之前。密钥在项目的“密钥”页面上。密钥为空时,init 会打印一条警告并返回 false,而不会抛出异常。
Blipit.init(
key: "<public key>",
environment: Rails.env,
release: ENV["RELEASE"],
)3获取密钥
登录 app.blipit.io,打开侧边栏中的“API 密钥”,然后选择你的项目。每个项目有两个密钥。公钥以 blipit_pk_ 开头:它用于浏览器和应用代码,只能发送事件,任何人看到都没关系。私密密钥以 blipit_sk_ 开头:它留在你的服务器或 Odoo 中,切勿放进浏览器,因为它还可以读取和更改问题。私密密钥只在创建后显示一次,请当时就复制;如果丢失,请点击“创建新的密钥”,旧密钥会立即失效。部分 SDK 还需要项目 id,它显示在同一页面上。
4将密钥保存在 Rails credentials 中
此 SDK 使用公钥发送数据。在 Rails 中,把它放在加密的 credentials 里并在 initializer 中读取;其他场景使用环境变量。
bin/rails credentials:editblipit:
key: blipit_pk_your_public_keyBlipit.init(
key: Rails.application.credentials.dig(:blipit, :key),
environment: Rails.env,
)5不要把密钥放进 git
请把密钥保存在环境变量或托管平台的密钥设置中,切勿写进你提交的代码,并把 .env 文件加入 .gitignore。网页中出现公钥是正常的。如果私密密钥曾出现在 git、公开页面、截图或聊天中,请打开“API 密钥”,点击“创建新的密钥”,并在所有用过旧密钥的地方粘贴新密钥:旧密钥会立即失效。
.env
.env.local
.env.*.local6手动捕获和登录尝试
登录尝试需要私密密钥:请在服务器上使用私密密钥而不是公开密钥进行初始化,否则接收端会以 403 security_needs_secret_key 拒绝。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)7验证是否生效
打开 app.blipit.io 中的“问题”。首个事件几秒钟内就会出现,并归组为一个问题,负责人会收到邮件。
Blipit.capture_message("Hello from Rails")须知
- 向 init 传入 traces_sample_rate: 0.2,请求、任务、Net::HTTP 调用和 SQL 查询就会显示在 Pulse 页面。
- 从 0.2 升级:不再需要 project:(仍然可以传入),Blipit.dsn 已移除,before_send 现在接收 Blipit 格式的 Hash 事件。
- 让 Blipit 保持最新:《让 Blipit 保持最新》指南(docs.blipit.io/updates)介绍了更新横幅、重要版本的邮件、开发控制台中的提示以及此平台的更新命令。
- 每个应用每个平台一个项目:每个项目在创建时选择自己的平台(Android、iOS、React Native、Flutter、Web、Backend 或 Odoo),Blipit 会以明确的错误拒绝来自其他平台的数据,所以 iOS 应用和 Android 应用需要两个项目、两个密钥。各平台的发布、版本、崩溃率和商店构建都不同,混在一个项目里会让这些数据全部失真。Web 项目也接收同一 Web 应用的服务器端数据(Next.js 服务器或 Node),React Native 或 Flutter 项目也接收它自己的 Android 和 iOS 原生崩溃报告。
遇到问题?发邮件至 support@blipit.io。每个项目的密钥和项目 id 在 app.blipit.io 的“API 密钥”下。

