Ruby/Rails logs onboarding suggests removed enable_logs

未关闭 适合新手
#130,405 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
rails, react, ruby, typescript
领域
documentation

调研方向

从 static/app/gettingStartedDocs/ruby-rails/onboarding.tsx、ruby/onboarding.tsx 和 ruby/logs.tsx 开始,将它们的代码片段与 sentry-ruby 7.x 的行为进行比较。移除关于 config.enable_logs = true 的指引,并根据 7.0.0/7.1.0 的变更更新版本说明和结构化日志指引。完成的标准是:Ruby 和 Rails 的 onboarding 代码片段不再显示已移除的选项,且日志相关文案反映当前 7.x 的设置方式。

由索引模型根据 Issue 内容生成。

描述

Bug Component: Onboarding

The Ruby and Rails onboarding snippets tell users to set config.enable_logs = true. sentry-ruby removed that option in 7.0.0, so on current SDK versions (7.x, latest 7.2.0) the snippet raises NoMethodError in Sentry.init. Reported by a customer setting up Rails with sentry-ruby 7.2.0.

Affected onboarding code (pinned to f182595):

SDK changes behind this:

  • 7.0.0, getsentry/sentry-ruby#3053: logs are enabled by default and enable_logs is removed. No compatibility shim remains
  • 7.1.0, getsentry/sentry-ruby#3102: Rails structured logging is off by default. Turn it on with config.rails.structured_logging.enabled = true

Workaround: drop the config.enable_logs = true line.

Open question: whether config.enabled_patches = [:logger] is still the recommended setup on 7.x.

cc @getsentry/value-discovery (CODEOWNERS for gettingStartedDocs) @sl0thentr0py (sentry-ruby)

via @danielsheccoury-sentry.

--

View Session in Sentry

主要语言
Python
星标
45.7k
派生
5k
平均合并
1 天 1 小时
30 天内合并 PR
642

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

getsentry/sentry 的其他 Issue

查看 getsentry/sentry 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。