GitHub と Sentry を統合して解決までの時間を短縮する
August 8, 2022 // 1 min read
既に Sentry と GitHub を別々に使っている場合でも、初めてデプロイメント ワークフローを構築する場合でも、以下の手順に従えばチームの自動ワークフローを作成できます。
執筆者: Sentry、プロダクト マーケティング マネージャー、Angela Jiang
Sentry は、350 万人以上の開発者が利用するアプリケーション監視プラットフォームであり、フロントエンドからバックエンドまで、アプリケーションの実際の重要事項を確認し、迅速に解決し、継続的に学習できるように支援します。
ツールチェインは複雑です。開発者やエンジニアリング マネージャーは、数えるのも嫌になるほど多くのツールを使用しています。現代の世界で効率性を維持するには、スマートな統合は「あれば便利」なものではなく、「必要」なものになってきています。
Sentry では、開発者ワークフローを改善することに重点を置いています。それは、Github のようなツールとのより公剛統合を構築することによって、開発者がリリース サイクルの全てのステージを簡単に監視できるようにすると同時に、より自動化されたデプロイメント ワークフローを開発者に提供し、コードが本番環境に出荷される際にエラーを迅速に検出するようにすることを意味します (余計なボタンをクリックする必要はありません)。
既に Sentry と GitHub を別々に使っている場合でも、初めてデプロイメント ワークフローを構築する場合でも、以下の手順に従えばチームの自動ワークフローを作成できます。
- Sentry アカウントにサインインする
- GitHub リポジトリを Sentry に接続してコミット データの追跡を開始する
- GitHub CODEOWNERS ファイルをインポートして、Sentry のチームまたは担当者に問題を自動的にマッピングする
- Sentry Release GitHub Action を GitHub にインストールして、ソースマップの自動アップロード、Sentry でのリリース管理、リリースのトレンドの追跡を行う
Forethought のように、エンジニアリング チームが成長し、継続的に出荷しているお客様は、多くの場合、出荷するコードや、リリース後の修正担当者およびその修正内容についての責任に対する可視性が低いまま運用を行っています。Forethought の場合、GitHub CODEOWNERS ファイルを Sentry と統合することによって、責任を分担して特定のチームに割り当てることによって、解決までの時間を最大 94% 短縮しました。
GitHub と Sentry を統合することにより、Forethought のようなお客様は、問題の責任を改善するだけでなく、次のようなことが可能になります。
- Sentry Release GitHub Actions を使用して、新しいリリースの正常性とユーザーへの影響を自動的に監視する
- Sentry で GitHub の問題を直接作成またはリンクする
- どのコミットが問題を引き起こし、その問題を解決する責任が誰にあるかを予測する
- Sentry のスタック トレースを GitHub のソース コードにリンクし、エラーの原因となっているコード行を確認する
- プルリクエストまたはコミットにより問題を解決する
Sentry と GitHub の一般的な使い方の例と上述の操作の方法を見てみましょう。
リリースがデプロイされたら、Sentry の [リリースの正常性] タブでリリースの安定性、ユーザー導入率、問題を監視します。そうすることによって、顧客に影響を与える前に、問題のあるリリースの展開を特定し、停止させることができます。[リリースの正常性] では、コミットの履歴の詳細や、ユーザー導入率、アプリケーション使用率、クラッシュ率などの主要な統計情報を確認できます。また、各リリースの新しい問題、未処理の問題、再発した問題、関連するパフォーマンス上の問題を確認できます。
Sentry Release GitHub Action をインストールすると、全ての新しいリリース (メジャーまたはマイナー) が自動的に記録され、疑わしいコミットが自動的に設定されます。Sentry は、Javascript コードがあればアンミニファイし、変換されていないオリジナルのソース コード (ソースマップ) もアップロードします。ユーザー導入率やクラッシュのないセッション率などの主要な指標を見れば、リリースがうまくいっていないトレンドを確認できます。
GitHub CODEOWNERS ファイルを Sentry のコード所有者ルールと同期すると、Sentry はユーザーに影響を与える問題を取得するだけでなく、その問題に関連する特定のコミットを表示し、問題をトリアージする適切なチーム メンバーを自動的に提案するようになります。こうすることで、重大な障害が発生したときに、誰が何に責任を持つかを把握するために奔走する必要がなくなります。
ここでは、Sentry から直接 GitHub の問題を作成し、アサインを提案された人を問題にタグ付けできます。
Sentry のエラー レポートをクリックすると、その問題にアサインされた開発者はスタック トレースを確認でき、そのスタック トレースにディープ リンクされた関連する GitHub ファイルに簡単に移動して、その問題を詳細に調査できます。
最後に、問題を所有する開発者は、問題の内容をすばやく特定、修正し、コメントに含まれる Sentry Issue ID でプルリクエストを開くことができます。(Sentry はマッチした問題に自動的にコミットやプルリクエストへの参照を注釈し、後でそのコミットやプルリクエストがリリースの一部となったときに、その問題を解決済みとしてマークします)。
GitHub と Sentry を統合することで、両ツールの可能性を最大限に引き出し、チームのワークフローを簡素化し、解決までのスピードを上げ、トレンドからの学習によりコードの正常性を時間とともに最適化できます。
弊社は開発者がソフトウェアをリリースおよび改良する方法を改善していくため、引き続き努力を続けております。ワークフローのうまく機能している部分や、問題がある部分、改善できる点など、皆様からのご意見をお待ちしております。
Tags