Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Add `sentry doctor` with SDK-owned check metadata

オープン
#1,632 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
cli, github, typescript

調査の方向性

Read the design direction and related issues #1627 and #1630, then inspect the existing CLI commands and DSN discovery mentioned in the issue. Start by breaking the proposed work into reviewable pieces and locating the existing implementations to reuse. Done means a smaller design aligned with the review: SDK-owned check metadata, an existing parser and CLI helpers, and fixes handled through an agent or the init backend.

索引モデルが issue の本文から書いたものです。

説明

getsentry/cli#1501 prototyped sentry doctor, a read-only health check for an existing Sentry install. It scans the project, asks the API, and reports what is configured, what is broken, and what to fix. It supports --send-test-event and a dry-run --fix plan, and was live-tested on Android, Empower, and iOS projects. The PR is closing with the getsentry/cli archive, and BYK's review asked for a reshaped version before a command like this can land.

cc @romtsn, author of cli#1501.

Design direction (from BYK's review of cli#1501)

  • SDK knowledge lives outside the CLI. Check lists, manifests, and init/build markers should come from one central place that the SDKs control and every product can read, most likely the release registry. The CLI should download that data at runtime rather than embed it at build time.
  • No hand-rolled parser. Replace the custom capture-block parser with tree-sitter or ast-grep.
  • Reuse existing CLI code instead of reimplementing it:
    • If DSN discovery is missing something, improve the existing DSN discovery so every command benefits.
    • Use the existing send-event command for --send-test-event.
    • Make redaction, if needed, a generic output-layer helper.
    • Drop the doctor-specific flush timeout.
    • Revert the unrelated lib/dsn/code-scanner.ts change.
  • Fixes go through an agent. --fix should produce a report for agents, or go through the sentry init backend, instead of keeping its own fix system. @betegon owns the init backend.
  • Clarify the names and concepts:
    • Rename the doctor online mode (for example to online) so it doesn't read like a subcommand.
    • Explain what tier 1 and tier 2 checks mean.
    • Explain magic numbers such as 31 in live.ts.
  • Ship it smaller. The PR was large and hard to review. Split it into reviewable pieces.

Related

  • #1627, ported from getsentry/cli#1363, runs flutter doctor / npx expo doctor after sentry init. That work is separate from this command, which audits existing installs. If both need per-SDK verification metadata, they should read it from the same SDK-owned source.
  • #1630: the same move of logic into SDK-owned data for SDK upgrades.

Refs getsentry/cli#1501

via BYK.

--

View Junior Session in Sentry

主要言語
TypeScript
スター
938
フォーク
166
平均マージ
1日 5時間
マージ済み PR(30日)
171

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

getsentry/toolkit のほかの issue

getsentry/toolkit の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。