爆速でJenkinsをマスターしよう(Slack通知編) ~ パイプラインのビルド失敗時にSlackで通知する方法 ~

継続的インテグレーションの自動ビルド失敗時に開発者に通知する手段はメールだけではありません。今回は、Jenkinsのビルドが失敗した場合にSlack通知を自動で行う方法を紹介します。

はじめに

JenkinsなどのCI/CDツールで自動ビルドが失敗した場合、開発者にビルド失敗を迅速に通知する必要があります。通知する手段としては、昔からあるメール通知は当然として、メッセンジャーで通知する方法が今では一般的です。メッセンジャーとしてはHipChatとSlackがメジャーです。

今回は、Jenkinsのパイプラインジョブにおいて、ビルドが失敗した場合に、Slackで通知する方法を紹介します。

前提

以下の準備が完了している必要があります。

• Jenkinsが構築済みであること
• Jenkins内でDockerが実行可能であること
• GitHubのアカウントがあること
• Slackのアカウントがあること

このやり方がわからない場合は以前の記事「爆速でJenkinsをマスターしよう(Docker編)」を参照してください。

また、ビルド失敗を検証するサンプルアプリケーションとして、以前の記事「爆速でJenkinsをマスターしよう(メール通知編)」で作成したものを使うので必要に応じて参照してください。

Slackのチャンネル作成と設定

Slackのチャンネル作成

任意のチャンネル名(今回は「#alerts」)を入力し、「チャンネルを作成する」をクリックします。

このチャンネルはSlackの通知を受け取るチャンネルとして使います。

SlackのWebhook用のアプリの追加

「App 管理」をクリックします。

「webhook」でアプリを検索して「Incoming Webhook」クリックします。

「設定を追加」をクリックします。

チャンネルに先程作成したチャンネル名(今回は「#alerts」)を選択し、「Incoming Webhook インテグレーションの追加」をクリックします。

これでアプリの追加は完了です。

「Webhook URL」が発行されていますね。

これを以下の3つの情報としてJenkinsに設定します。

• Team Subdomain
• Base URL
• Secret text

メモしておきましょう。

JenkinsのSlack通知用の設定

Slack用のプラグインを入れる

「Jenkinsの管理」から「プラグインの管理」をクリックします。

Slack通知用のプラグイン「Slack Notification」にチェックを入れて、「ダウンロードして再起動後にインストール」をクリックします。

Jenkinsの再起動が完了すればOKです。

SlackのWebhookの認証情報の設定

Slackで設定したWebhookの情報を元に、Jenkinsに認証情報を設定します。

「認証情報」から「Jenkins」をクリックします。

「グローバルドメイン」の「Add credentials」をクリックします。

「種類」に「Secret text」を選択し、「Secret」にWebhookのSecret textを入力し、IDに任意の名前(今回は「slack-webhook-url-credentials」)を付けて、「保存」をクリックします。

認証情報が追加されていればOKです。

大丈夫ですね。

Slack通知用の設定

JenkinsにSlack通知の設定を追加します。

「Jenkinsの管理」から「システムの設定」をクリックします。

「Global Slack Notifier Setting」から、「Base URL」と「Team Subdomain」にSlackの情報を入力し、「Integration Token Credential ID」に先程作成した認証情報(slack-webhook-url-credentials)を選択します。

「保存」をクリックすれば完了です。

Slack通知用のパイプラインの設定ファイル作成

今回は以前の「爆速でJenkinsをマスターしよう(メール通知編)」で準備したビルドが失敗するサンプルアプリケーションをベースにして、設定ファイルを追加することにしましょう。

ベースを作る

以前作ったプロジェクトをクローンし、新しくJenkinfileを追加します。

$ git clone https://github.com/{your-github-account}/devops_fail_build_nodejs.git
$ touch Jenkinsfile.slack

「{your-github-account}」は自分のGitHubアカウント名に置き換えてください。

Jenkinsのパイプラインの設定ファイルの作成

Jenkins.slack

今回はビルド失敗時に、Slackに赤色でジョブ名、ジョブ番号、ジョブURLを送信してみましょう。

node {
  def app

  try {
    stage('Clone repository') {
      checkout scm
    }

    stage('Build image') {
      app = docker.build('{your-github-account}/devops_fail_build_nodejs')
    }

    stage('Test') {
      app.inside {
        sh 'npm install --only=dev'
        sh 'npm test'
      }
    }
  } catch(error) {
    currentBuild.result = "FAILURE";

    slackSend (color: '#FF0000', message: "FAILED: Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]' (${env.BUILD_URL})")

    throw error;
  }
}

GitHubにPushしましょう。

$ git add .
$ git commit -m 'Add jenkinsfile for slack notification'
$ git push origin master

これで準備は整いました。

Slack通知の動作確認

最後にJenkinsのパイプラインのビルド失敗時にSlack通知が動作することを確認しましょう。

パイプラインジョブを作る

「新規ジョブ作成」をクリックします。

任意のジョブ名(今回は「slack_notification」)を入力し、「パイプライン」を選択し、「OK」をクリックします。

「パイプライン」から「Pipeline script from SCM」を選択して、「リポジトリURL」を入力し、「Script Path」には先程作成した「Jenkinsfile.slack」を指定します。

「保存」をクリックすればジョブ作成は完了です。

失敗するビルドを実行し、Slack通知を確認する

いよいよビルドしてみましょう。

「ビルド実行」をクリックします。

想定通りビルドが失敗しました。ビルド番号をクリックして出力結果を確認してみましょう。

「Console Output」を見てみましょう。

テストが失敗し、Slackに情報が送信されています。

それでは、Slack側も確認しましょう。

SlackにJenkinsからビルド失敗のメッセージがビルド結果ページのURL付きで届いています。

OKですね。

最後に

いかがでしたか？これでJenkinsのパイプラインのビルド失敗時にSlackで開発者に通知することができるようになったことでしょう。メールよりもSlackの方が迅速に連携が取れるので、より効率的に継続的インテグレーションが実現できますね。では。

環境

• Jenkins: 2.151

The following two tabs change content below.

• この記事を書いた人
• 最新の記事

Keid

自由で楽しい世界を目指すフルスタックWebデベロッパー。 大学でコンピュータサイエンスを真面目に学び、日本の大手IT企業に就職後、新しい技術やスケールするビジネスが北米にある事に気づき、海外への挑戦を決意。全く英語ができなかっため、フィリピン留学およびカナダ留学を経て強制的に英語を上達させた。挑戦に終わりはない。このブログでは海外に挑戦したいエンジニアやデザイナーに少しでも有益な情報を提供していきたいと思う。（写真は旅行先のラスベガス）

最新記事 by Keid (全て見る)

• Jenkins爆速入門: 5日間ブートキャンプ (NodeJS&Docker編) - 2019年8月30日
• 開発用データベースのためのDocker Composeの設定方法 (MySQL/PostgreSQL/MongoDB編) - 2019年7月22日
• 令和時代にGraphQLを知らないエンジニアはいらない！GraphQLとPrismaのバックエンド開発入門(GraphQL Yoga編) - 2019年7月18日