Veebiteenuste monitoorimise bot poole tunni jooksul: telegram + bash + cron

Mõnikord on vaja kiiresti teha uue teenuse jälgimine, aga sobivat infrastruktuuri/ekspertteavet pole käepärast. Selles juhendis loome poole tunni jooksul tööriista veebiteenuste jälgimiseks, kasutades ainult Ubuntu sisseehitatud vahendeid: bash, cron ja curl. Teavituste edastamiseks kasutame telegrammi.

Kirsiks tordil on kasutajate emotsionaalne kaasatus. Inimesed on proovinud — see toimib.

Kui me telemeditsiini teenuses Doktor Räädame lõime kasutajate stressitaseme määramiseks vestlusroboti, olid meil vajalikud jälgimisvahendid. Paari tunni jooksul loodi mini projekt, mis mitte ainult ei töötanud suurepäraselt, vaid lisas ka positiivsust oma sõnumitega.

Kõigepealt saame skriptide hoidla:

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

Liigume kausta msms ja töötame seal edasi.

Kui telegramm on blokeeritud, kasutage proksi. Lihtsaim ja usaldusväärne variant on torsocks:

sudo apt install tor
sudo apt install torsocks

Näiteks seadistame kolme sammuga google.com esilehe jälgimise.

SAMM 1. Loome telegrammis boti ja saame kasutaja ID.

• Otsingureas otsime telegrammis kontakte. @botfather:

  

• Käivitame selle Start-nupuga, sisestame käsu /newbot ja vastame küsimustele. Tuleb meeles pidada, et name on bot'i nimi, mis kuvatakse kasutajatele, ja username on ainulaadne ning peab lõppema sõnaga «bot»:

  
  
  Muuhulgas annab bot välja salajase tokeni HTTP API jaoks, mille tuleb kopeerida ja salvestada faili telegram-api-key.txt kausta msms.

• Otsingureas kirjutame telegram meie bot'i nime ja käivitame selle.
• Lõpetuseks lisame end jälgimise teavituste saajate nimekirja:

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

  Skript väljastab nimekirja viimastest päringutest bot'ile, seal peaks olema üks rida meie id ja nimega telegramis. Võtame selle id ja salvestame faili services/google-recipients.txt. Faili formaat: iga rida — üks id. Näidis:

  123456789
  987654321

Uue saaja lisamiseks tuleb tal paluda bot'i telegramis käivitada, käivitada recipients-setup.sh ja lisada id faili.

Samm 2. Seame jälgimise üles

Teenuse kirjeldamine toimub ini-faili loomise teel kausta serviсes. Tuleb määrata viis parameetrit:

1. MSMS_SERVICE_NAME: teenuse nimi — seda kasutatakse teavitustes ja jälgimislogis.
2. MSMS_SERVICE_ENDPOINT: teenus, millele me pöördume curl’iga.
3. MSMS_CURL_PARAMS: täiendavad curl parameetrid, vaata allpool olevat näidet.
4. MSMS_EXPECTED: oodatav teenuse vastus. Kasutatakse, kui vastus on lühike.
5. MSMS_EXPECTED_FILE: faili nimi oodatava teenuse vastusega. Kui on määratud, kirjutab MSMS_EXPECTED üle.
6. MSMS_RECIPIENTS: fail teavituste saajate nimekirjaga.

Päring google.com tagastab fikseeritud html koos redirectiga, kasutame seda serveri oodatava vastusena:

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

Loome faili services/google.ini:

MSMS_SERVICE_NAME='google eesmine leht'

# teenuse lõpppunkt
MSMS_SERVICE_ENDPOINT='google.com'

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

# oodatav teenuse vastus
MSMS_EXPECTED_FILE='google-response.html'

# saajate nimekirja fail
MSMS_RECIPIENTS='google-recipients.txt'

V MSMS_CURL_PARAMS võid määrata kõik, mis curliga võimalik, sealhulgas:

1. Küljenda curl sõnumeid, et mitte segada konsooli ja logi: -s
2. Määrata ühenduse aegumise aeg kontrollitava teenuse jaoks (sekundites): --connect-timeout 3
3. Määrata vastuse saamise aegumine: -m 7
4. Lülita SSL sertifikaadi kontroll välja (näiteks, kui kasutatakse enesekirjutatud sertifikaati): --insecure
5. Määrata http-päringu tüüp: -X POST
6. Määrata pealkirjad: -H "Content-Type: application/json"
7. Määrata päringu keha stringina või failina. Näide faili kohta: -d @request.json

Oleme välja lülitanud teavitused ja seadnud ühenduse ajaks 3 sekundit ning teenuse vastuse ajaks 7 sekundit.

Tähelepanu: näidake parameetrite väärtusi ühekordsetes jutumärkides, nagu näites. Kahjuks on bash selle poolest üsna hapras olukorras, ning juhuslikult valesse kohta sattunud jutumärk võib viia universumi kokkuvarisemiseni keeruliselt diagnoositavate vigadeni.

Oleme seadistanud jälgimise. Kontrollime, et kõik oleks OK:

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

Skript peaks väljastama sõnumi kujul:

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

STEP 3. Seadistame ajakava

Seadistame jälgimise ajakava cron'is:

sudo crontab -e

Lisa rida, et iga minut kontrollida google.com:

*/1 * * * * torsocks /monitoring.sh >> /monitoring.log 2>&1

Lisame igal päeval kell 11:00 teavituse, mis kinnitab jälgimise töökindlust. Sel eesmärgil edastame skriptile parameetri DAILY:

0 11 * * * torsocks /monitoring.sh DAILY >> /monitoring.log 2>&1

2>&1 — standardne praktika, mis suunab vead põhiväljundvoogu. Seega jõuavad need ka jälgimise logisse.

Salvestame muudatused ja haakime need meeskonnaga:

 sudo service cron reload

Cron seadistamise kohta võib lugeda näiteks siit.

Nii käivitatakse iga minuti järel jälgimisskript, mis teeb curl'i abil päringu google.com-le. Kui saadud vastus erineb oodatust, saadab skript teate telegramis saajate nimekirjale. Kontrollide ajalugu registreeritakse failis monitoring.log

Kui on vaja lisada veel üks teenus, loome lihtsalt uue ini-faili selle jaoks kaustas services ning vajadusel koostame eraldi saajate nimekirja. Kõik muu töötab automaatselt.

Kui kontrollitav teenus muutub kättesaamatuks, saadetakse teavitus iga minuti järel. Kui teenust ei õnnestu kiiresti taastada, saab ajutiselt välja lülitada teavitused boti omadustes telegramis.

Nüüd vaatame lähemalt lisafunktsioone ja skriptide rakendust.

Sõnumite mallid ja emotsionaalne kaasatus

Kuna suhtlemine boti kaudu oleks elavam, nimetasime teda Manetsiks, lisasime sobiva pildi ja kaasasime professionaalsed PR-eksperdid sõnumite koostamiseks. Saate kasutada meie väljatöötatud lahendusi või muuta neid vastavalt oma maitsele.

Näiteks nii:

või isegi nii:

Miks mitte?

Boti nimi ja avatar määratakse läbi @botfather.
Sõnumite šabloonid asuvad kaustas templates:

• curl-fail.txt: sõnum, mis saadetakse juhul, kui curl tagastas mitte-nulliliku veakoodi. See räägib tavaliselt teenuse kättesaamatusest.
• daily.txt: igapäevane sõnum, mis kinnitab, et teenuse jälgimine töötab.
• service-fail.txt: sõnum, mis saadetakse juhul, kui teenuse vastus erineb oodatust.

Vaadakem kohandamise võimalusi sisseehitatud sõnumite šabloonide näitel.
Šabloonides kasutatakse emojide. Kahjuks habr neid ei kuva.
Emodžide valimiseks on mugav kasutada otsingut aadressil emojipedia.org:

Sobiva sümboli kopeerite lihtsalt ja kleebite šablooni teksti (see on tavaline unicode).

1. curl-fail.txt:

   Kassipoeg, aita mind... 
   Ei suuda teenuseni jõuda "$MSMS_SERVICE_NAME" 
   `CURL EXIT CODE: $EXIT_CODE`

   Kasutame meie määratud teenuse nime (muutuja MSMS_SERVICE_NAME) ja sisemist muutujat skripti curl väljumiskoodi (EXIT_CODE). Samuti vormindame sõnumi, kasutades telegram markdown: sümbolid "`" ümbritsevad fikseeritud laiusega teksti. Kuna jutumärgid ja apostroofid on bash'i reserveeritud sümbolid, siis põgeneme neist sümboliga "". Muutujate nimed alustame sümboliga "$".

   Tulemus:

   

2. service-fail.txt:

   Kassipoeg, aita mind...
   Teenuse "$MSMS_SERVICE_NAME" tõttu olen ma pettunud
   See töötab valesti, siin on, mida see mulle vastab:
   `$RESPONSE`

   Tulemus:

   
   
   Siin kasutame veel ühte skripti muutujat: RESPONSE. See sisaldab teenuse vastust.

3. daily.txt:

   Tere, beebi!
   Minuga on kõik hästi, jälgin teenust:
   "$MSMS_SERVICE_NAME" iga minuti tagant...
   Kuidas sul läheb?
   

   Tulemus:

   

Liigume nüüd skriptide rakendamise juurde.

Jälgimisskript

monitoring.sh teeb lihtsa automaatse avastamise — võtab kõik ini-failid kaustast services ja igaühe jaoks käivitab põhiskripti kontrollimise ja teavitamise loogikaga:

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

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

Igapäevase jälgimise oleku sõnumi koostamiseks saab skripti edastada parameetri DAILY.

Pange tähele, et skripti käivitamisel muutub praegune kaust services. See võimaldab ini-failides faili teede määratlemist relative services.

Teavitamise kontrollimise ja saatmise skript

msms.sh sisaldab teenuse kontrollimise ja teavitamise saatmise põhiloogikat.

Töötamine telegramiga:

# 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
}

Kasutame REST API-le ligipääsu vormistamiseks URL-i, kasutades failis salvestatud salajast võtme.

Funktsioon send_message kasutab curl'i teatiste saatmiseks sellele REST API-le, saades vastuvõtjate id-d failist, mille oleme ini-s määranud. Saadetavates andmetes määratleme, et kasutame sõnumite vormindust: parse_mode="Markdown".

Kuvame praeguse kuupäeva ja kellaaja ning laadime ini-faili.

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

# laadige muutujad .ini failist:
. $2

Magiiline rida . $2 täidab teise parameetrina antud ini-faili nagu tavalist skripti, sisestades selles määratletud väärtused keskkonnamuutujatesse.

Laadime oodatud vastuse failist, kui parameeter on määratud MSMS_EXPECTED_FILE:

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

Teostame teenuse kontrollimise ja teavituste saatmise vajadusel:

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

Esmaltame muutuja RESPONSE curl käsku sooritamise tulemuseks oleva väärtuse.

Väljend EXIT_CODE=$? salvestab viimase käsu, s.t. curl, tulemuse muutuja. Kui on vaja teavitust saata, loetakse vastava faili mall ning saadetakse teavitused send_message.

Viimases plokis töödeldakse DAILY parameetrit:

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

See saadetakse sõnum, mis kinnitab, et monitooring töötab.

Kasutajate id-de nimekirja saamine

recipients-setup.sh pöördub telegram API poole, et saada viimased sõnumid, mis on saadetud botile:

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

Siin kasutatakse python'i võlu loendi kauni kuvamise jaoks. See pole tingimata vajalik, piisab, kui võtta soovitud id json'ist, mille annab käsk:

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

Kokkuvõte

Nii saate kasutada valmis skripte ja sõnumimalle, seadistades vaid jälgitavad teenused ja teavituste loendid; võite luua uue „isiku“ botile; või siis teha oma lahenduse pakutud baasil.

Esmaklassiliste arenguvõimalustena võiks kujuneda konfigureerimine ja jälgimise haldamine otse botis, kuid selleks on juba vajalik python. Kui kellelgi juhtub varem ikkagi selle kallal töötama, siis teate, kuhu pull request'i laadida 🙂

Allikas: habr.com