エラートラッキング

GitLab 11.8 で導入されました

エラートラッキングにより、開発者はアプリケーションが生成している可能性のあるエラーを簡単に発見し、表示することができます。 コードが開発されている場所でエラー情報を表示することにより、効率と認識を高めることができます。

セントリーエラー追跡

Sentryはオープンソースのエラートラッキングシステムです。 GitLabでは、管理者がSentryをGitLabに接続し、GitLabでSentryのエラー一覧を表示できるようにしています。

セントリーのデプロイ

クラウドホスティングhttps://sentry.ioにサインアップすることも、独自のオンプレミスインスタンスをデプロイすることも、GitLab を使って Kubernetesクラスタに Sentry をインストールすることもできます。

セントリーの有効化

注:Sentryインテグレーションを有効にするには、少なくともメンテナーの権限が必要です。

GitLabはSentryをプロジェクトに接続する簡単な方法を提供します:

  1. Sentry.ioにサインアップするか、独自のSentryインスタンスをデプロイしてください。
  2. 新しい Sentry プロジェクトを作成します。 インテグレーションしたい GitLab プロジェクトごとに、新しい Sentry プロジェクトを作成することをお勧めします。
  3. Sentry プロジェクト用の Sentry 認証トークンを見つけるか、生成してください。 少なくとも次のスコープを与えてください:event:readproject:read
  4. プロジェクトの設定 >オペレーションに移動します。
  5. アクティブ」チェックボックスが設定されていることを確認します。
  6. Sentry API URLフィールドに、Sentryホスト名を入力します。 例えば、Sentryインスタンスが利用可能なアドレスの場合は、https://sentry.example.com と入力します。SaaSバージョンのSentryの場合、ホスト名はhttps://sentry.ioとなります。
  7. Auth Tokenフィールドに、以前に生成したトークンを入力します。
  8. 接続]ボタンをクリックして、Sentryへの接続をテストし、[プロジェクト]ドロップダウンに入力します。
  9. Projectドロップダウンから、GitLabプロジェクトにリンクするSentryプロジェクトを選択します。
  10. 変更を有効にするには、[変更を保存] をクリックします。
  11. プロジェクトのサイドバーにあるオペレーション> エラー追跡で、Sentryのエラーリストを見ることができるようになりました。

Sentryのドキュメントの手順に従って、SentryのGitLabインテグレーションを有効にすることもできます。

エラー追跡リスト

注:エラー追跡リストを表示するには、少なくともレポーター権限が必要です。

エラー追跡のリストは、プロジェクトのサイドバーのオペレーション> エラー追跡で見つけることができます。 ここでは、エラーをタイトルまたはステータス(無視、解決、未解決のいずれか)でフィルタリングし、頻度、最初に見たもの、最後に見たもので降順に並べ替えることができます。 デフォルトでは、エラーリストは最後に見たもので並べ替えられ、未解決のエラーにフィルタリングされます。

Error Tracking list

エラーの詳細

エラーリストから、エラーのタイトルをクリックすると、エラーの詳細ページに移動できます。

このページには

  • 仙谷イシューへのリンク。
  • Sentry Issueの最初のリリースにあるSentryリリースID/バージョンが、GitLabでホストされているプロジェクトのコミットSHAと一致する場合、GitLabコミットへのリンクが表示されます。
  • スタックトレースを含む、イシューに関するその他の詳細。
  • GitLab12.7以降では、言語と緊急度が表示されます。

デフォルトでは、イシューの作成ボタンが表示されます:

Error Details without Issue Link

エラーから GitLab issue を作成すると、Create issueボタンがView issueボタンに変わり、エラーの詳細セクションに GitLab issue へのリンクが表示されます:

Error Details with Issue Link

エラーに対するアクション

GitLab UI内からSentryエラーにアクションを起こすことができます。

エラーの無視

GitLab 12.7から導入されました

エラー詳細ページでは、ページ上部の「無視」ボタンをクリックするだけで、Sentryエラーを無視することができます。

エラーを無視すると、エラー追跡リストに表示されなくなり、Sentry 内で設定された通知も無効になります。

エラーの解決

GitLab 12.7から導入されました

エラーの詳細ページで、ページ上部の解決ボタンをクリックすると、Sentryエラーを解決できます。

エラーを解決済みとマークすることは、エラーがイベントの発生を停止したことを示します。 GitLabのイシューがエラーにリンクされている場合、イシューはクローズされます。

別のイベントが発生すると、エラーは未解決に戻ります。