Sentryエラートラッキング
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
Sentryは、オープンソースのエラートラッキングシステムです。GitLabでは、管理者がSentryをGitLabに接続することで、ユーザーがGitLabでSentryエラーの一覧を表示できるようになります。
GitLabは、クラウドでホストされているSentryと、オンプレミスインスタンスにデプロイされたSentryの両方とインテグレーションできます。
プロジェクトのSentryインテグレーションを有効にする
GitLabには、Sentryをプロジェクトに接続する方法が用意されています。
前提要件:
- プロジェクトのメンテナー以上のロールを持っている必要があります。
Sentryインテグレーションを有効にするには、次の手順に従います:
- Sentry.ioにサインアップするか、独自のオンプレミスSentryインスタンスをデプロイします。
- 新しいSentryプロジェクトを作成します。インテグレーションするGitLabプロジェクトごとに、新しいSentryプロジェクトを作成します。
- Sentryの認証トークンを検索または生成します。SaaSバージョンのSentryの場合は、https://sentry.io/api/で認証トークンを検索または生成できます。少なくとも次のスコープをトークンに付与します。
project:read、event:read、およびevent:write(解決イベント用)。 - GitLabで、エラートラッキングを有効にして設定します:
- 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
- 左側のサイドバーで、設定を選択して、プロジェクトを見つけます。モニタリング > エラートラッキングを選択し、[エラートラッキング]を展開します。
- エラートラッキングを有効にするで、有効を選択します。
- バックエンドのトラッキングエラーでSentryを選択します。
- Sentry API URLに、Sentryのホスト名を入力します。たとえば、
https://sentry.example.comと入力します。SaaSバージョンのSentryの場合、ホスト名はhttps://sentry.ioです。EUでホストされているSaaSバージョンのSentryの場合、ホスト名はhttps://de.sentry.ioです。 - 認証トークンに、以前に生成したトークンを入力します。
- Sentryへの接続をテストし、プロジェクトドロップダウンリストに入力された状態で表示するには、接続を選択します。
- プロジェクトリストから、GitLabプロジェクトにリンクするSentryプロジェクトを選択します。
- 変更を保存を選択します。
Sentryエラーのリストを表示するには、プロジェクトのサイドバーで、モニタリング > エラートラッキングに移動します。
GitLabとのSentryのインテグレーションを有効にする
Sentryドキュメントの手順に従って、SentryのGitLabインテグレーションを有効にすることもできます。
トラブルシューティング
エラートラッキングを使用していると、次の問題が発生する可能性があります。
エラーConnection failed. Check auth token and try again
プロジェクト設定でモニタリング機能が無効になっている場合、プロジェクトのSentryインテグレーションを有効にするときにエラーが表示されることがあります。/project/path/-/error_tracking/projects.json?api_host=https:%2F%2Fsentry.example.com%2F&token=<token>へのリクエストの結果、404エラーが返されます。
この問題を修正するには、プロジェクトのモニタリング機能を有効にします。
エラーConnection has failed. Re-check Auth Token and try again
接続を試みると、オンプレミスのSentryインテグレーションでこの問題が発生する可能性があります。
このイシューを解決するには、次の手順に従います:
- 左側のサイドバーの下部で、管理者を選択します。
- 左側のサイドバーの下部にある設定 > ネットワークを選択します。
- アウトバウンドリクエストを展開します。
- ウェブフックとインテグレーションからローカルネットワークへの要求を許可するチェックボックスとシステムフックからのローカルネットワークへのリクエストを許可するチェックボックスを選択します。
- 変更を保存を選択します。