mcpField
I
integration-ruby

integration-ruby

github.com/posthog数据与数据库7690 次安装今天更新
代码仓库

关于 integration-ruby

用于在 Ruby 应用中集成 PostHog 分析的技能，面向 Ruby 开发者。它提供分步骤流程和示例，并说明 SDK 初始化、事件调用及退出前关闭客户端等实践。

主要功能

  1. 01分步骤集成流程
  2. 02Ruby 示例与文档
  3. 03环境变量配置密钥
  4. 04SDK 初始化与事件调用指导
  5. 05用户识别和错误跟踪指导

适用场景

  1. 01为 Ruby 应用添加 PostHog 分析
  2. 02在脚本或 CLI 中发送分析事件
  3. 03在登录和注册流程中识别用户

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/integration-ruby确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
basic-integration-1.0-begin.md
basic-integration-1.1-edit.md
basic-integration-1.2-revise.md
basic-integration-1.3-conclude.md
EXAMPLE.md
identify-users.md
ruby.md

详细介绍

Ruby 的 PostHog 集成

此技能可帮助你在 Ruby 应用中添加 PostHog 分析功能。

工作流

按以下步骤顺序完成集成：

  1. basic-integration-1.0-begin.md - PostHog 设置 - 开始 ← 从这里开始
  2. basic-integration-1.1-edit.md - PostHog 设置 - 编辑
  3. basic-integration-1.2-revise.md - PostHog 设置 - 修订
  4. basic-integration-1.3-conclude.md - PostHog 设置 - 总结

参考文件

  • references/EXAMPLE.md - Ruby 示例项目代码
  • references/ruby.md - Ruby - 文档
  • references/identify-users.md - 用户识别 - 文档
  • references/basic-integration-1.0-begin.md - PostHog 设置 - 开始
  • references/basic-integration-1.1-edit.md - PostHog 设置 - 编辑
  • references/basic-integration-1.2-revise.md - PostHog 设置 - 修订
  • references/basic-integration-1.3-conclude.md - PostHog 设置 - 总结

示例项目展示了目标实现模式。请参阅文档了解 API 详情。

核心原则

  • 环境变量：始终使用环境变量存储 PostHog 密钥。切勿将其硬编码。
  • 最小改动：在现有集成旁添加 PostHog 代码。不要替换或重构现有代码。
  • 匹配示例：实现应尽可能遵循示例项目中的模式。

框架指南

  • posthog-ruby 是 Ruby SDK 的 gem 名称（将 gem 'posthog-ruby' 添加到 Gemfile），但应使用 require 'posthog' 引入（而非 require 'posthog-ruby'）
  • 在脚本和 CLI 中使用 PostHog::Client.new(api_key: key, host: host) 进行基于实例的初始化
  • 在 CLI 和脚本中：必须在退出前调用 client.shutdown，否则所有事件都会丢失
  • 使用 begin/rescue/ensure，并在 ensure 块中调用 shutdown，以正确清理
  • capture 和 identify 接收单个哈希参数：client.capture(distinct_id: 'user_123', event: 'my_event', properties: { key: 'value' })
  • capture_exception 接收位置参数（而非关键字参数）：client.capture_exception(exception, distinct_id, additional_properties) — 不要使用 distinct_id: 关键字语法

识别用户

在登录和注册事件期间识别用户。请参阅示例代码和文档，了解此框架的正确识别模式。如果同时存在前端和后端代码，请使用 X-POSTHOG-DISTINCT-ID 和 X-POSTHOG-SESSION-ID 标头传递客户端会话和 distinct ID，以保持关联。

错误追踪

在相关文件中添加 PostHog 错误追踪，尤其是在关键用户流程和 API 边界附近。

评论

支持 Markdown