外部ツールを連携する
GitHub や Jira などの外部ツールを EM-OS に連携し、開発データを自動で取り込む手順です。連携の設定は組織の管理者が 管理者 > 外部連携 で行います。外部連携はプロプラン以上で利用できます。
TIP
まずは GitHub だけを連携し、開発指標(Four Keys)が集計されることを確認してから、ほかのツールを追加するのがおすすめです。
連携できるツール
| ツール | 取り込む情報 | EM-OS での使われ方 |
|---|---|---|
| GitHub | リポジトリ、コミット、プルリクエスト、Issue | Four Keys・SPACE などの開発指標、Issue のリードタイム、レビュー効率 |
| Jira | プロジェクト、チケット | プロジェクトの取り込みと同期、ストーリーポイント、修繕作業の集計 |
| Slack | チャンネルのやり取り | チーム間のコミュニケーション頻度の分析、通知 |
| Google カレンダー | 予定 | 1on1 の予定の調整 |
| AWS(ベータ版) | 一部リソースの可用性指標 | SLO(稼働安定性)の達成状況 |
| GCP | 監視指標 | SLO(稼働安定性)の達成状況 |
GitHub を連携する
GitHub の連携には、自社の GitHub Organization に GitHub App を作成してインストールします。GitHub Organization の管理者権限が必要です。
- GitHub で New GitHub App を開き、GitHub App を作成します。
- 「Permissions」で、次の権限をすべて Read-only にします。
- Contents(コードとコミット履歴)
- Metadata(リポジトリの情報)
- Issues(リードタイム、復旧時間の計測)
- Pull requests(レビュー効率、デプロイ頻度の計測)
- Actions(CI/CD ワークフローとデプロイ頻度の計測)
- 作成した App を対象の Organization にインストールし、対象のリポジトリを選びます。
- App の設定画面で Private Key を生成し、App ID と Installation ID を控えます。
- EM-OS の 管理者 > 外部連携 で「GitHub」の「連携する」を押し、App ID、Installation ID、Private Key を入力して保存します。
- データが反映されるまで数分かかることがあります。
連携後は、GitHub の「設定」から次の項目を変更できます。
- 除外ユーザー: Bot など、Four Keys の計算から外したい GitHub ユーザー名をカンマ区切りで入力します。
NOTE
「再連携が必要です」と表示された場合は、GitHub App の権限が更新されたか、トークンが失効しています。GitHub App の権限とインストール状態を確認し、必要なら Private Key を作り直して入力し直してください。GitHub の API 利用上限に達したときは、表示された時刻まで同期が一時停止します。
Jira を連携する
- Atlassian のアカウント設定で API トークンを発行します。
- 管理者 > 外部連携 の「Jira」で「連携する」を押し、次を入力します。
- Jira ドメイン(例:
example.atlassian.net) - Atlassian アカウントのメールアドレス
- API トークン
- Jira ドメイン(例:
- 必要に応じて次の項目を設定します。
- ストーリーポイント用カスタムフィールド ID(例:
customfield_10031) - 修繕(Maintenance)対象 Issue Type: 指定しない場合は Bug、Defect、Glitch、Maintenance が修繕として集計されます。
- ストーリーポイント用カスタムフィールド ID(例:
- 「テスト接続」で接続を確認し、「連携を保存」を押します。
Jira のプロジェクトを取り込む方法は管理者機能を参照してください。
Slack を連携する
- Slack App を作成し、Bot User OAuth Token(
xoxb-で始まる文字列)を取得します。 - 管理者 > 外部連携 の「Slack」で「連携する」を押し、トークンを入力して保存します。
- 分析するチャンネルを指定しない場合は、すべてのパブリックチャンネルが対象になります。プライベートチャンネルを含めるときは、対象チャンネルに Bot を招待したうえで、チャンネル ID を指定してください。
- 「設定」の Signing Secret には、Slack App の Basic Information ページにある値を入力します。保存した値は画面に表示されず、「設定済み」とだけ表示されます。変更するときだけ入力し直してください(空のまま保存すると今の値を使い続けます)。
連携を確認・解除する
- 各ツールの「テスト接続」で、認証情報と権限が正しいか確認できます。
- 「今すぐ同期」が表示されているツールは、次の定期同期を待たずにデータを取り込めます。
- 「連携を解除」で連携をやめられます。
うまく同期されないときはトラブルシューティングを参照してください。
