以前slackの基本的な使い方を学習したので、今回はプログラムでエラーが発生した際にslackに連絡が入るプログラムを作ってみました。
サーバ上でスクレイピング用のプログラムを定期的に実行するときや、自身のPC上で自動でプログラムを走らせておく場合などに有用だと思います。おそらくこういった利用の仕方は、すごく一般的だと思いますが、自分で作ってみることでその機能やどのような実装にするかなど、かなり勉強になりました。今回の実験内容等を整理すると、以下になります。
- 目的: バックグラウンドなどで実行時や自動処理を行わせるときにエラーが発生した際に、slackに連絡が入り、即時に対応できるようにするコード
- 実験内容: int型の中に一つだけstr型の数字が含まれた数字リストの要素を一つ一つ足して、合計値を計算するときに、str型データに遭遇してエラーが発生。エラーメッセージ、エラー個所含めslackに伝える
- 備考: slack連絡プログラムは別途関数を作る
- 実験環境
- 使用するプログラミング言語: python(3.7.0)
- 使用するモジュール・パッケージ:Requests(サードパーティ)、Json(標準モジュール)
- slack app: Incoming WebHooks
slack appのIncoming WebHooksについては、上記に記載した以前の記事に登録方法など基本的なことを書いていますので、ご参照ください。Requestsについてはサードパーティモジュールになるため、別途インストールする必要があります。
1. エラー発生時にslackに連絡が行くコード
まず、以下の式でint型データリストの中に一つだけstr型が混ざった実験リストを作ります。
#実験用リストの生成
int_list = []
for i in range(50):
int_list.append(i)
int_list[30] = str(int_list[30])
#対象文字列 -> 30だけstr型
#[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, '30', 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49]そして、次はslackに連絡が行くためのメソッドです。
#slack連絡用関数
import requests, json
#Incoming WebHooksで取得したURLをここで指定します(このURLを知っていれば誰でもそのチャンネルにメッセージを送ることができるため、ここでは非公開にしています)。
url = YOUR_WEB_HOOK_URL
def slack_error(err, num):
payload = {
"attachments": [
{
"title": "ERROR!!",
"pretext": "Today is a *fu?king* day",
"text": "error: {}\ni: {}\n\nTake it easy. Don't mind such a fu?king error.".format(err, str(num)),
"mrkdwn_in": ["pretext"]
}
]
}
#Incoming WebHooksではjsonデータでメッセージを送る必要があるため、json.dumpsメソッドを利用しています。
requests.post(url, data=json.dumps(payload))この関数では、エラーが起こったことだけでなく、エラーメッセージの内容とエラーが発生した箇所(num)もメッセージで送るようにしています。最後に実験コードです。
#実験コード
#リストから要素を一つずつ取り出し、集計して行く
int_sum = 0
i = 0
for i in range(len(int_list)):
try:
int_sum += int_list[i]
except Exception as err:
error = str(err)
slack_error(err, i)上記のコードを実験すると、slackにエラーメッセージ、エラー個所の連絡が入るので、試してみてください。今回は、非常に短い内容ですが、エラーの取扱時にかなり重宝できるかなと思います。slackメッセージの修飾については、公式ホームページに記載されていますので、適宜確認頂ければと思います。
読んで頂き、ありがとうございました。