残念なお知らせ

下記で毎分間隔でサーバを監視していましたが、Googleから下記のような警告と共に実行されなくなってしまいました。
サービスで 1 日に使用しているコンピュータ時間が長すぎます

Screen Shot 2016-06-03 at 1.58.29 PM.png

さすがに無料でこれだけ使おうとすると怒られてしまうようです。
間隔を延ばしたりサイト数を減らすことで軽減はされるかと思います。

はじめに

サーバ監視大変ですね。
最近だとSlackで通知させるのが流行ってるそうですね。
Zabbixなどで監視していたのですが、小さいチームだと運用コストが掛かってしまうのでもっと簡単にできないか、ということでトライしてみました。

「Google Spread Sheet + Slackでサーバ監視できる！」みたいな記事はいくつか見つけていてワクワクしていたのですが、うまく行かなかったので組み合わせて完結させました。

Google Spread SheetとGoogle Apps Script (GAS)

当初はHerokuでhubotを動かしてみたのですが色々と大変でした。
もうちょっと簡単にできないかなーと思って探したところ、Google Spread SheetとGoogle Apps Scriptを組み合わせて無料でそこそこアッサリ動きました。
スプレッドシートでの管理ですのでホスト、ページの追加なども簡単に行えます。
特にチームのマネージャさんにも簡単に扱ってもらえそうなのが良いなと思っています。
今まではPHPやZabbixで監視していたのですがマネージャさんには敷居が高く、エンジニアが設定、改修していました。
Google Spread Sheetであれば初回にエンジニアが設定すればいいので凄く便利です。

作業

手順のまとめです。

スプレッドシートを作る
SlackのTokenを取得してスプレッドシート内に記載
スクリプト(GAS)の設定
トリガの設定

スプレッドシートを作る

Googleスプレッドシートを作成します。
GASから操作するためにシートに「targets」と名前を付けておきます。

A列にURL、B列に正常なレスポンスコード、C列にSlackに通知するチャンネル名を記載します。

それぞれ1行目はラベルとしてあります。
2行目以降をスクリプトに読ませるようにしました。

F列1行目にはSlackのTokenを入れる箇所にしました。

SlackのTokenを取得

Slackから投稿したいチームのTokenを取得します。
https://api.slack.com/docs/oauth-test-tokens

xoxoで始まる文字列です。

これを先ほどのF列1行目に入れておきます。

スクリプトの作成

「ツール > スクリプトエディタ」を選択してスクリプトエディタを起動します。

メニューから「リソース > ライブラリ」選択し、Library Keyに「M3W5Ut3Q39AaIwLquryEPMwV62A3znfOO」を入力して「選択」します。
「バージョン」は現段階で最新版の「22」を選択します。

コードの本文には以下のコードを書きます。

function checkSites() {
  var sheet = SpreadsheetApp.getActive().getSheetByName('targets');
  for ( var i = 2; i < sheet.getLastRow() + 1; i++ ) {
    var url = sheet.getRange(i, 1).getValue();
    var codeShouldBe = sheet.getRange(i, 2).getValue();
    var channel = sheet.getRange(i, 3).getValue();
    if ( url != '' ) {
      var statusCode = checkStatusCode(url);
      if ( codeShouldBe != statusCode ) {
        postSlackMessage(channel, url, statusCode, codeShouldBe);
      }
    }
  }
}

function checkStatusCode (url) {
  try {
    var response = UrlFetchApp.fetch(url, {'muteHttpExceptions': true});
    Logger.log(url + ': ' + response.getResponseCode());
    return response.getResponseCode();
  } catch (error) {
    if ( response !== undefined) {
      Logger.log(url + ': ' + response.getResponseCode());
      return response.getResponseCode();
    } else {
      Logger.log(url + ': ' + 'Webserver down')
      return 0;
    }
  }
}

// thanks! http://tech.camph.net/slack-bot-with-gas/
function postSlackMessage(channel, url, statusCode, codeShouldBe) {
  var token = SpreadsheetApp.getActive().getSheetByName('targets').getRange('F1').getValue();
  //Browser.msgBox(token);
  
  var slackApp = SlackApp.create(token); //SlackApp インスタンスの取得
  var message = 'Hey! ' + url + ' returns ' + statusCode + '. (Expected code is ' + codeShouldBe + ')';
  message += 'This message thrown by ' + (SpreadsheetApp.getActiveSpreadsheet()).getUrl();
  
  var options = {
    channelId: channel, //チャンネル名
    userName: "WatchDog", //投稿するbotの名前
    message: message //投稿するメッセージ
  };
 
  slackApp.postMessage(options.channelId, options.message, {username: options.userName});
}

スプレッドシートへのアクセスなどの認証が必要なので、手動で実行しておきます。
メニューの「実行」から「checkSites」を選びます。

以下のようなアラートが出たら承認しておきます。

スプレッドシート側のステータスコードを500などに書き換えて、アラートが飛ぶか確かめます。

うまくいけばこんな感じでアラートが飛んできます。

トリガの設定

監視用に毎分の設定をしておきます。
「リソース > 全てのトリガー」を選択し、「新しいトリガーを追加」します。
実行は「checkSites」、「時間主導型」で「分タイマー」「一分ごと」にしておきます。

以上で一分おきに対象サイトをチェックしてくれます。

補足

うまく動かない時

うまく動かない時にはスクリプトエディタ側の「表示 > ログ」を見るとエラーが出ていたりします。

コードの特定の箇所に

Logger.log('hoge');

のように書くとデバッグに便利です。

開発時のテストツールとして

僕はサイトの開発、運用初期段階から携わることが多いので、その際にはスプレッドシートにページ一覧を列挙しておき、簡易的なページチェックツールとしても使っています。
特にインフラエンジニアとしては細かいリダイレクトの設定の際に簡易的なテストツールとしても使えますので便利です。
(とはいえ、3xxのリダイレクトには今のところ反応せず、リダイレクト先の200などを取ってしまっています)

注意

エンジニア向けには言うまでもありませんが、このスクリプトではサイトへのアクセスを行うため、倫理的に許される範囲での運用にしましょう。
人のサイトへチェックなどはやめましょう。
あまりやりすぎるとたぶんGoogleに怒られる気がします。

参考サイト

Slack BotをGASでいい感じで書くためのライブラリを作った
http://qiita.com/soundTricker/items/43267609a870fc9c7453#botとして動かしてみる

初心者がGASでSlack Botをつくってみた
http://tech.camph.net/slack-bot-with-gas/

ほぼ上述のサイトのおかげで出来ました。