XNUMX 分で Web サービスを監視するボット: telegram + bash + cron

新しいサービスを監視する必要が生じた場合でも、必要なインフラや専門知識が手元にないことがあります。このガイドでは、組み込みツールのみを使用して、あらゆるWebサービスを監視するツールを30分で実装する方法をご紹介します。 ubuntubash、cron、curlを使用します。通知の配信にはTelegramを使用します。

「チェリー・オン・ザ・ケーキ」はユーザーの感情的な関与になります。 人でテストしたところ、効果がありました。

遠隔医療サービスである Doctor Nearby がユーザーのストレス レベルを判断するチャットボットを作成したとき、モニタリングが必要でした。 数時間で、うまく機能するだけでなく、ポジティブなメッセージを加えるミニプロジェクトが作成されました。

まず、スクリプトを含むリポジトリを取得しましょう。

git clone https://github.com/rshekhovtsov/msms.git

msms フォルダーに移動し、そこで作業します。

テレグラムがブロックされている場合は、プロキシを使用してください。 最もシンプルで信頼性の高いオプションはトルソックスです。

sudo apt install tor
sudo apt install torsocks

例として、google.com スタート ページの監視を XNUMX つの手順で設定してみましょう。

ステップ 1. Telegram でボットを作成し、ユーザー ID を取得します

• 電報内の連絡先の検索バーで検索します。 @ボットファーザー:

  

• [スタート] ボタンで起動し、/newbot コマンドを入力して質問に答えます。 name はユーザーに表示されるボットの名前であり、ユーザー名は一意であり、「bot」で終わる必要があることに注意する必要があります。

  
  
  特に、ボットは HTTP API のシークレット トークンを発行します。これをコピーして、msms フォルダー内の telegram-api-key.txt ファイルに保存する必要があります。

• テレグラムの検索バーにボットの名前を入力し、起動します。
• 最後の仕上げとして、監視アラート受信者のリストに自分自身を追加しましょう。

  sudo chmod +x ./recipients-setup.sh
  torsocks ./recipients-setup.sh

  スクリプトはボットへの最近の呼び出しのリストを表示します。テレグラムには ID と名前が XNUMX 行あるはずです。 この ID を取得し、ファイル services/google-recipients.txt に保存します。 ファイル形式: 各行が XNUMX つの ID です。 例：

  123456789
  987654321

新しい受信者を追加するには、テレグラムでボットを起動し、recipients-setup.sh を実行して、ファイルに ID を追加するように依頼する必要があります。

ステップ 2. モニタリングを設定する

サービスは、services フォルダーに ini ファイルを作成することで記述されます。 次の XNUMX つのパラメータを設定する必要があります。

1. MSMS_SERVICE_NAME: サービス名 - アラートと監視ログで使用されます。
2. MSMS_SERVICE_ENDPOINT:curl で接続するサービスのエンドポイント。
3. MSMS_CURL_PARAMS: 追加のカール オプション。以下の例を参照してください。
4. MSMS_EXPECTED: サービスからの予期される応答。 答えが短い場合に使用されます。
5. MSMS_EXPECTED_FILE: 予期されるサービス応答が含まれるファイル名。 指定すると、MSMS_EXPECTED が上書きされます。
6. MSMS_RECIPIENTS: 通知受信者のリストを含むファイル。

google.com へのリクエストはリダイレクト付きの固定 HTML を返します。これを予想されるサーバー応答として使用します。

curl google.com > services/google-response.html

services/google.ini ファイルを作成しましょう。

MSMS_SERVICE_NAME='google front page'

# service endpoint
MSMS_SERVICE_ENDPOINT='google.com'

# curl parameters
MSMS_CURL_PARAMS='-s --connect-timeout 3 -m 7'

# expected service response
MSMS_EXPECTED_FILE='google-response.html'

# recipients list file
MSMS_RECIPIENTS='google-recipients.txt'

В MSMS_CURL_PARAMS 以下を含む、curl で実行できるすべての設定を行うことができます。

1. コンソールとログが乱雑になるのを避けるために、curl メッセージを無効にします。 -s
2. チェックするサービスとの接続タイムアウトを設定します (秒単位)。 --connect-timeout 3
3. 応答タイムアウトを設定します。 -m 7
4. SSL の証明書検証を無効にします (たとえば、自己署名証明書を使用している場合)。 --insecure
5. http リクエストのタイプを指定します。 -X POST
6. 見出しを指定します。 -H "Content-Type: application/json"
7. リクエストの本文を文字列またはファイルとして指定します。 ファイルの例: -d @request.json

通知を無効にし、タイムアウトを 3 秒に設定しました。 接続するには7秒かかります。 サービス応答を受信します。

注目: 例のように、パラメータ値を一重引用符で囲んで指定します。 残念ながら、bash はこの意味で非常に脆弱であり、間違った引用符を使用した偶発的な蝶は、診断が難しいエラーで宇宙の死を招く可能性があります。

モニタリングを設置しております。 すべてが正常であることを確認してみましょう。

sudo chmod +x ./monitoring.sh
torsocks ./monitoring.sh

スクリプトには次のようなメッセージが表示されるはずです。

2020-01-10 12:14:31
health-check "google front page": OK

STEP 3. スケジュールを設定する

cron で監視スケジュールを設定しましょう。

sudo crontab -e

google.com を毎分チェックする行を追加しましょう。

*/1 * * * * torsocks <ПУТЬ К ПАПКЕ РЕПОЗИТОРИЯ>/monitoring.sh >> <ПУТЬ К ПАПКЕ РЕПОЗИТОРИЯ>/monitoring.log 2>&1

毎日午前 11.00 時にアラートを追加し、監視自体の機能を確認します。 これを行うには、DAILY パラメータをスクリプトに渡します。

0 11 * * * torsocks <ПУТЬ К ПАПКЕ РЕПОЗИТОРИЯ>/monitoring.sh DAILY >> <ПУТЬ К ПАПКЕ РЕПОЗИТОРИЯ>/monitoring.log 2>&1

2>&1 - エラーをメイン出力ストリームにリダイレクトする標準的な手法。 その結果、監視ログにも記録されます。

変更を保存し、次のコマンドで取得しましょう。

 sudo service cron reload

cron の設定について詳しくは、以下を参照してください。 ここで.

したがって、毎分監視スクリプトが起動され、curl 経由で google.com に接続されます。 受信した応答が予期したものと異なる場合、スクリプトは受信者のリストに電報通知を送信します。 監査ログはファイルmonitoring.logに保存されます。

別のサービスを追加する必要がある場合は、そのサービス用の新しい ini ファイルを services フォルダーに作成し、必要に応じて受信者の別のリストを作成します。 それ以外はすべて自動的に動作します。

チェック中のサービスが利用できなくなった場合、アラートが XNUMX 分ごとに送信されます。 サービスをすぐに復元できない場合は、ボットのテレグラム プロパティで通知を一時的に無効にすることができます。

次に、追加機能とスクリプトの実装を詳しく見てみましょう。

メッセージパターンと感情的な関与

ボットとのコミュニケーションをより活発にするために、ボットに Manechka という名前を付け、適切なアバター画像を追加し、テキスト メッセージを作成するためにプロの PR スペシャリストを雇いました。 私たちの経験を活用することも、好みに合わせて変更することもできます。

例えば、

または次のようにしても:

なぜでしょうか？

ボット名とアバターは次のように設定されます。 @ボットファーザー.
メッセージテンプレートはフォルダー内にあります テンプレート:

• カール失敗.txt:curl がゼロ以外のエラー コードを返したときに送信されるメッセージ。 通常、サービスに到達できないことについて話します。
• デイリー.txt: サービス監視が機能していることを確認する毎日のメッセージ。
• サービス失敗.txt: サービスの応答が予期したものと異なる場合に送信されるメッセージ。

例として組み込みメッセージ テンプレートを使用して、カスタマイズ オプションを見てみましょう。
テンプレートでは絵文字を使用しています。 残念ながら、habr ではそれらは表示されません。
絵文字を選択するには、検索を使用すると便利です emojipedia.org:

適切な記号をコピーしてテンプレート テキストに貼り付けるだけです (これは通常の Unicode)。

1. カール失敗.txt:

   Котёнок,  помоги мне... 
   Не могу достучаться до сервиса "$MSMS_SERVICE_NAME" 
   `CURL EXIT CODE: $EXIT_CODE`

   指定したサービス名を使用しました (変数 MSMS_SERVICE_NAME) と、curl 終了コードを含む内部スクリプト変数 (EXIT_CODE）。 また、マークアップを使用してメッセージをフォーマットしました 電報値下げ: 「`」文字は固定幅テキストを囲みます。 引用符とアポストロフィは bash 記号であるため、「」でエスケープします。 変数名の前には「$」記号が付きます。

   結果：

   

2. サービス失敗.txt:

   Котёнок, помоги мне... 
   Сервис "$MSMS_SERVICE_NAME" меня расстроил
   Он работает неправильно, вот что он мне отвечает:
   `$RESPONSE`

   結果：

   
   
   ここでは別のスクリプト変数を使用します。 RESPONSE。 これにはサービス応答が含まれます。

3. デイリー.txt:

   Малыш, привет!
   У меня всё хорошо, cлежу за сервисом:
   "$MSMS_SERVICE_NAME" каждую минутку...
   А как у тебя дела?
   

   結果：

   

スクリプトの実装に移りましょう。

監視スクリプト

モニタリング.sh 単純な自動検出を実行します。サービス フォルダーからすべての ini ファイルを取得し、それぞれに対してアラートの確認と送信のロジックを含むメイン スクリプトを実行します。

#!/bin/bash
cd $(dirname "$0")/services

for service_ini  in $(ls *.ini); do
    bash ../msms.sh "$1" "$service_ini"
done

監視ステータスに関する毎日のメッセージを生成するには、DAILY パラメータをスクリプトに渡します。

スクリプトが開始されると、現在のフォルダーが services に変更されることに注意してください。 これにより、ini ファイル内のサービスに相対的なファイル パスを指定できます。

通知を確認および送信するためのスクリプト

msms.sh サービスをチェックし、アラートを送信するためのメイン ロジックが含まれています。

電報の操作:

# telegram endpoint
TG_API_URL="https://api.telegram.org/bot$(cat ../telegram-api-key.txt)/sendMessage"

#################################################################
# send message to telegram
# parameter: message text
#################################################################
function send_message {
    for chat_id  in $(cat ../$MSMS_RECIPIENTS); do
	curl -s -X POST --connect-timeout 10 $TG_API_URL -d chat_id=$chat_id -d parse_mode="Markdown" -d text="$1"
	echo
    done
}

ファイルに保存された秘密キーを使用して電報 REST API にアクセスするための URL を生成します。

send_message 関数は、curl を使用してこの REST API にメッセージを送信し、ini で指定したファイルから受信者 ID を取得します。 私たちが送信するデータでは、メッセージ マークアップを使用していることを示します。 parse_mode="Markdown".

現在の日時を表示してiniファイルを読み込みましょう。

echo $(date '+%Y-%m-%d %H:%M:%S')

# load variables from .ini file:
. $2

魔法の紐 . $2 XNUMX番目のパラメータとして入力に渡されたiniファイルを通常のスクリプトとして実行し、その中で指定された値を環境変数に入力します。

パラメータが指定されている場合、期待される応答をファイルからロードします MSMS_EXPECTED_FILE:

if [ -n "$MSMS_EXPECTED_FILE" ]; then
 MSMS_EXPECTED="$(cat "$MSMS_EXPECTED_FILE")"
fi

サービスを確認し、必要に応じてアラートを送信します。

RESPONSE="$(eval curl $MSMS_CURL_PARAMS "$MSMS_SERVICE_ENDPOINT")"
EXIT_CODE=$?
if [[ $EXIT_CODE != 0 ]]; then
    echo health-check "$MSMS_SERVICE_NAME" FAILED: CURL EXIT WITH $EXIT_CODE
    MESSAGE="$(cat ../templates/curl-fail.txt)"
    MESSAGE=$(eval echo $MESSAGE)
    send_message "$MESSAGE"
elif [[ "$RESPONSE" != "$MSMS_EXPECTED" ]]; then
    echo health-check "$MSMS_SERVICE_NAME" FAILED: "$RESPONSE"
    MESSAGE="$(cat ../templates/service-fail.txt)"
    MESSAGE=$(eval echo $MESSAGE)
    send_message "$MESSAGE"
else
    echo health-check "$MSMS_SERVICE_NAME": OK
fi

まず変数に代入します RESPONSE このサービスに対してcurlコマンドを実行した結果。

式 EXIT_CODE=$? 最後のコマンドの結果を変数に入れます。つまり、 カール。 アラートを送信する必要がある場合は、対応するファイルからテンプレートが読み取られ、次を使用して受信者に送信されます。 send_message.

最後のブロックは DAILY パラメーターを処理します。

if test "$1" = "DAILY"; then
    echo health-check "$MSMS_SERVICE_NAME" DAILY
    MESSAGE="$(cat ../templates/daily.txt)"
    MESSAGE=$(eval echo $MESSAGE)
    send_message "$MESSAGE"
fi

監視自体の機能を確認するメッセージを送信します。

ユーザーIDのリストを取得する

受信者セットアップ.sh テレグラム API を呼び出して、ボット宛ての最新メッセージを取得します。

curl -s https://api.telegram.org/bot$(cat telegram-api-key.txt)/getUpdates 
| python recipients-setup.py

これはPythonのマジックを使ってリストを美しく表示します。 これは必要ありません。コマンドが出力する json から必要な ID を取得するだけです。

torsocks curl -s https://api.telegram.org/bot$(cat telegram-api-key.txt)/getUpdates

まとめ

したがって、既製のスクリプトとメッセージ テンプレートを使用して、監視対象のサービスとアラートのリストのみを設定できます。 ボットの新しい「個性」を作成できます。 または、提案された内容に基づいて独自の決定を下すこともできます。

さらなる開発のためのオプションでは、ボット自体で監視を構成および管理することが提案されていますが、ここでは Python なしでは実行できません。 誰かが私より先にそれを取得したら、どこにプルリクエストを送信すればよいかわかります:)

出所： habr.com