librenms - 清新下午茶

2024-06-15

使用 LibreNMS 實現 HTTP Health check 健康度檢查，網站監控

監控，是一個很老牙卻也很樸實的問題。網站的健康度已成為維持業務連續性的必要條件。
本文將探討如何使用 LibreNMS 這一強大的網路監控工具來實現網站HTTP 的 Health check 健康度檢查。LibreNMS 不僅在 SNMP 提供豐富的功能，還支援廣泛的設備，但在 HTTP 健康度卻比較少著墨，故整理一個較完整的筆記分享給大家。

背後的實現原理

先說結論，LibreNMS 是使用 Nagios plugins 來實現健康度監控的。
Nagios plugins 是一個很老牌的開源監控服務的程式， 2002 年首次發佈，GPLv2 授權釋出，
它提供了很多的監控服務，例如 HTTP, FTP, SSH, SMTP, POP3, SNMP, DNS, Disk, CPU, Memory…等等，而
LibreNMS 就是使用這些服務來實現健康度監控的。
所以你要先了解 Nagios plugins 的使用方法，才能在 LibreNMS 上面設定，
很剛好的，我們拉取的 jarischaefer/docker-librenms docker image 直接把 Nagios plugins 給包進去了，
我們可以直接拿它來做健康度監控。

我們就舉一些例子來看看怎麼實現 Health check 吧！

建立健康度監控的操作步驟

Step1. 先建立 Device

LibreNMS 的健康度測試是一個一個 Services 要掛在 Device 上面
所以我們要先建立 Device

Devices > Add Devices

Hostname or IP: 打入一個監控的網址或 IP
SNMP: OFF

如果 SNMP 設定是 OFF，會改用 ping 來做測試
如果 SNMP 設定 ON，需要提供 SNMP Version, Community 等資訊

SNMP (Simple Network Management Protocol) 可以視你的情況打開，它會依照協定規範發送 CPU, RAM…等資訊，這部分就不細講了

如果你只需要一個 Device，然後把所有 HTTP 健康度測試，你甚至 IP 用 localhost 都可以。

再建立 Service

這邊就是 Nagios plugins 的重頭戲

Services > Add Services

Name: 取一個名字
Device: 選擇剛剛加入的裝置
Check Type: http
Description: (可留空)
Remote Host: 打入要檢測的網址
Parameters: 參數說明，後詳

這邊我覺得就是 LibreNMS 設計不好的地方，出現了一個謎樣的 Parameters 欄位
這個參數格式還要參照另外一個文件知道怎麼使用，很不直覺
（有看到一個討論串，其中之一的作者說要重寫這個部分，可以參與實作）

我把文件先放上來
https://nagios-plugins.org/doc/man/check_http.html

列一些比較常用或重要的參數：

-p 8080 ：設定連接埠 (port) 號，例如 8080
-S ：使用 SSL 加密協定 (https) ，若只是 http 不用加此參數
--sni：使用 Server Name Indication (SNI) 伺服器名稱指示
開啟後它才可以正確辨別第二階層的 DNS 位址，例如主域名是 example.com 底下有二個子域名 blog 與 myhome
沒有開啟 sni 的時候，blog.example.com 與 myhome.example.com 都會被視為一個 example.com
而造成不如預期的結果，如果第二層域名，要打開這個選項，個人建議不管有沒有第二層域名，直接打開該選項
-u /example/path ：如果你有參數需要寫這裡
-s "testString" ：設定 Response 的關鍵字檢測，有出現該關鍵字才算正確，例如有出現 testString 關鍵字才算正確
-f follow ：跟隨轉址 (Follow redirect)，假設有一個首頁直接呼叫它，會回應 302 Redirect，它會繼續轉址直到停止控制時才會做前者的關鍵字檢測
-e 403 ：原始 HTTP 封包的關鍵字檢測，例如有個 Endpoint 永遠不會回 200 OK，
而是回應 403 forbidden，你就可以加 -e 403 設定檢測規則
-v：使用 verbose 模式，可以看到更多的訊息，可以看到原始的 HTTP 封包

手動測試步驟

剛剛有提過， LibreNMS 是透過 Nagios plugins 來實現 HTTP 健康度監控的
它安裝在 container 裡面的 /usr/lib/nagios/plugins (可能會依版本不同而路徑不同)
如果你要手動測試，你可以參照以下步驟

用 docker ps 或者 docker-compose ps 找到你該容器 ID

# docker ps
% docker ps
CONTAINER ID   IMAGE                              COMMAND                  CREATED        STATUS                PORTS                                                                                                                             NAMES
b6064b0ae371   jarischaefer/docker-librenms       "/sbin/my_init"          34 hours ago   Up 34 hours           443/tcp, 0.0.0.0:9001->80/tcp, :::9001->80/tcp                                                                                    librenms-web-1
f7e81da94af5   mariadb:10.5                       "docker-entrypoint.s…"   34 hours ago   Up 34 hours           3306/tcp                                                                                                                          librenms_database

以這個範例來說就是，該 container ID 為 b6064b0ae371

進入該容器

# docker exec -it b6064b0ae371 /bin/bash

進入容器後，切到 /usr/lib/nagios/plugins 目錄

# cd /usr/lib/nagios/plugins

然後你就會找到 ./check_http 你可以對他做測試
例如以下的幾個實例可以快速進入狀況

附註：在容器內找不到 `./check_http` 程式？

如果在容器內找不到 ./check_http 程式
可以找尋看看 /opt/librenms/config.php 這個設定檔

可能會找到這段

$config['nagios_plugins'] = "/usr/lib/nagios/plugins";

這邊就有記載著 nagios_plugins 它的路徑

或者你的 nagios_plugins 沒有安裝，可能要參考文件手動安裝

舉一些範例

我把 LibreNMS 設定參數與測試指令放在一起做對照

檢測 http 連結

檢測 http 連結，例如 http://192.168.1.1:8080/hello ，其中須包含 Hello 字樣

Remote Host: 192.168.1.1
Parameters: -p 8080 -f follow -s "Hello" -u "/hello"

測試指令

這裡列出前述方法的測試指令與執行結果，供大家參考

./check_http -H 192.168.1.1 -p 8080 -s "Hello" -u "/hello" -f follow
HTTP OK: HTTP/1.1 200 OK - 235 bytes in 0.025 second response time |time=0.024936s;;;0.000000;10.000000 size=235B;;;0

參數說明

-H 192.168.1.1：指定 Host name 為 192.168.1.1
-p 8080 ：設定連接埠 (port) 號，為 8080
-u /hello ：指定 Path 為 /hello
-f follow ：跟隨轉址 (Follow redirect)
-s "hello" ：有出現 hello 關鍵字才算成功

檢測 https 連結

檢測 https 連結，例如 https://google.com/ ，其中須包含 Google 字樣

Remote Host: google.com
Parameters: -S --sni -f follow -u "/" -s "Google"

測試指令

這裡列出前述方法的測試指令與執行結果，供大家參考

./check_http -H google.com -S --sni -f follow -u "/" -s "Google"
HTTP OK: HTTP/1.1 200 OK - 21613 bytes in 0.555 second response time |time=0.555301s;;;0.000000;10.000000 size=21613B;;;0

參數說明

-H google.com：指定 Host name 為 google.com
-S ：使用 SSL 加密協定 (https)
--sni：使用 Server Name Indication (SNI) 伺服器名稱指示
-f follow ：跟隨轉址 (Follow redirect)
-u / ：指定 Path 為 / （在這個範例可省略）
-s "Google" ：有出現 Google 關鍵字才算成功

檢查 POST API (x-www-form-urlencoded)

這個範例可能比較少用，但還是附上來

檢查 POST API，例如 POST 到 https://httpbin.org/post ，參數為 aaa=bbb (x-www-form-urlencoded) ，其中須包含 origin 字樣

Remote Host: httpbin.org
Parameters: -S --sni -f follow -u "/post" -P "aaa=bbb" -s "origin"

測試指令

./check_http -H httpbin.org -S --sni -f follow -u "/post" -P "aaa=bbb" -s "origin"
HTTP OK: HTTP/1.1 200 OK - 662 bytes in 3.446 second response time |time=3.446157s;;;0.000000;10.000000 size=662B;;;0

參數說明

-H httpbin.org：指定 Host name 為 httpbin.org
-S ：使用 SSL 加密協定 (https)
--sni：使用 Server Name Indication (SNI) 伺服器名稱指示
-f follow ：跟隨轉址 (Follow redirect)
-u /post ：指定 Path 為 /post
-P "aaa=bbb" ：設定 POST 參數，aaa=bbb (x-www-form-urlencoded)
-s "origin" ：有出現 origin 關鍵字才算成功

檢查 POST API (json)

檢查 POST API，例如 POST 到 https://httpbin.org/post ，參數為 {"aaa":"bbb"} (application/json) ，其中須包含 origin 字樣

Remote Host: httpbin.org
Parameters: -S --sni -f follow -u "/post" -T "Content-Type:application/json" -P "{\"aaa\": \"bbb\"}" -s "origin"

測試指令

./check_http -H httpbin.org -S --sni -f follow -u "/post" -T "Content-Type:application/json" -P "{\"aaa\": \"bbb\"}" -s "origin"
HTTP OK: HTTP/1.1 200 OK - 676 bytes in 1.333 second response time |time=1.332586s;;;0.000000;10.000000 size=676B;;;0

參數說明

-H httpbin.org：指定 Host name 為 httpbin.org
-S ：使用 SSL 加密協定 (https)
--sni：使用 Server Name Indication (SNI) 伺服器名稱指示
-f follow ：跟隨轉址 (Follow redirect)
-u /post ：指定 Path 為 /post
-T "Content-Type:application/json" ：設定 POST 參數的 Content-Type 為 application/json
-P "{\"aaa\": \"bbb\"}" ：設定 POST 參數，{"aaa": "bbb"} (application/json)
-s "origin" ：有出現 origin 關鍵字才算成功

檢查 HTTP 狀態碼

在有些時候，別的團隊沒有特別做出 health check API，但我們還是可以做檢查
例如我們可以找一個 API 可能會回應 404 not found
我們就拿這個方式來檢查

註： 404 不等於網路接不上，404 是網路「有接上」，但是沒有這個頁面
如果是網路接不上，會是 timeout，而這就是我們要檢查的

檢查 HTTP 狀態碼，例如 https://httpbin.org/status/404 ，狀態碼為 404

Remote Host: httpbin.org
Parameters: -S --sni -f follow -u "/status/404" -e 404

測試指令

這裡列出前述方法的測試指令與執行結果，供大家參考

./check_http -H httpbin.org -S --sni -f follow -u "/status/404" -e 404
HTTP OK: Status line output matched "404" - 238 bytes in 2.494 second response time |time=2.493861s;;;0.000000;10.000000 size=238B;;;0

參數說明

-H httpbin.org：指定 Host name 為 httpbin.org
-S ：使用 SSL 加密協定 (https)
--sni：使用 Server Name Indication (SNI) 伺服器名稱指示
-f follow ：跟隨轉址 (Follow redirect)
-u /status/404 ：指定 Path 為 /status/404
-e 404 ：狀態碼有出現 404 關鍵字才算成功

檢查 SSL 憑證期限

檢查 SSL 憑證是否有到期，例如 https://example.com/ 的憑證期限

Remote Host: example.com
Parameters: --sni -S -C 30,10

測試指令

這裡列出前述方法的測試指令與執行結果，供大家參考

./check_http -H example.com --sni -S -C 30,10
OK - Certificate 'www.example.org' will expire on Sat Mar  1 23:59:59 2025 +0000.

參數說明

-H example.com：指定 Host name 為 example.com
--sni：使用 Server Name Indication (SNI) 伺服器名稱指示
-S ：使用 SSL 加密協定 (https)
-C 30,10 ：設定過期時限通知，30 天標黃色，10 天標紅色

個人小結

這邊做一個小總結與加上一點個人建議
關於 HTTP 健康度測量這部分，我覺得 LibreNMS 設定上比較沒那麼直覺，
可能等待有緣人來修改這段的程式碼

個人可以給出一些設定上的小建議

測試指令原本寫 -H 的地方，在 LibreNMS 中就寫在 Remote Host 的地方
使用 -u 參數指令後續的路徑
建議不管有沒有第二層子網域都加上 --sni 參數，避免網域被合併而測不到的情境
建議可以加上 -f follow 參數，自動做頁面轉導，避免頁面需要轉導跳出 301 moved permanently 造成不預期的情境
有 https 請加上 -S 參數
如果回應不是 200 OK，使用 -e 參數指定 Response 應看到的 http status code
例如 -e 404 代表瀏覽該頁面應該要看到 404 not found
（網路不通等待到 timeout 跟看到 404 有所不同，前者網路不通，後者網路有通但無此頁面）
如果有特定的關鍵字，可以使用 -s 參數指定，例如 -s "Hello" 代表要看到 Hello 字樣才算成功
如果要測試語法，可以用 ./check_http -v 使用 verbose 模式，可以看到更多的訊息，還可以看到原始的 HTTP 封包

希望這篇文章能有所幫助，祝大家設定愉快！

參考資料

Website monitoring
https://community.librenms.org/t/website-monitoring/17181/2
加裝 Nagios Plugin 增加監控能力
https://www.ichiayi.com/tech/librenms/nagios_agent
加裝 Nagios Plugin 增加監控能力
https://www.ichiayi.com/tech/librenms/nagios_agent
Service checks in LibreNMS (http, all other Nagios plugins)
https://raymii.org/s/tutorials/Service_checks_in_LibreNMS_nagios_plugins.html
開源網路裝置服務監控系統：LibreNMS (三)
https://ithelp.ithome.com.tw/articles/10224484
How to post json with check_http
https://support.nagios.com/forum/viewtopic.php?t=26109

2023-02-272023-02-28

[教學] LibreNMS 串接 LINE 通知

在現代科技世界中，網路裝置監控與通知非常重要。LibreNMS 是一個開源的網路監控系統，可以用來監控網絡設備、伺服器…等。然而，對於一些使用者而言，LibreNMS 的通知設定可能會有一些小困難。我們將在這個系列文章中介紹幾種常用的通知方式：電子郵件、LINE、Telegram、GoogleChat…等。這些通知方式都可幫助使用者即時收到監視警報和報告，以便快速回應並保護他們的系統和網絡安全。

LibreNMS 系列文：

用 Docker 來架設 LibreNMS 架設網路服務監控系統
https://blog.jks.coffee/setup-librenms-using-docker/
用 Gmail 來串接 LibreNMS 的 Email 通知
https://blog.jks.coffee/librenms-gmail-alert-setup/
LibreNMS 串接 LINE 通知
https://blog.jks.coffee/librenms-line-message-alert-setup/

剛好工作會用到 LINE，所以把通知轉到 LINE 去，就讓我們看看要怎麼做吧！

抓下 Pull Request 的內容

目前截稿至今，目前還沒有人把 LINE 機器人通知功能的做進去，
小弟就順手貢獻程式碼，把這個功能加上 😎。

當然 LibreNMS 整套程式授權是 GPL，想當然爾貢獻的程式碼也是 GPL，歡迎大家使用。

只是官方還沒有允許 Pull Request 的內容，
如果覺得不錯，可以幫忙在原串留個言，加速系統演進。

https://github.com/librenms/librenms/pull/14802

也因為目前小弟貢獻的程式碼尚未被合併，預設這功能「沒有包含」在官方系統裡，
需要你手動抓檔案來補

檔案在此：
https://github.com/j796160836/librenms/blob/feature_line_messaging/LibreNMS/Alert/Transport/Linemessagingapi.php

按下 Raw 得到原始檔，然後另存新檔，存成 LineMessagingAPI.php。

如果跟我一樣是使用 Docker 的話，
放在目錄中，修改 docker-compose.yml 把這個檔案用掛載的方式，
類似 Hot patch 的方式把它放進去

在 docker-compose.yml 的 LibreNMS 設定，裡頭的 volumes 區塊，加上一句：

- ./LineMessagingAPI.php:/opt/librenms/LibreNMS/Alert/Transport/Linemessagingapi.php

（注意大小寫！）

如果你是照個之前那篇文的方式架設的話，
變成類似底下的範例：

docker-compose.yml

version: '3.5'

services:
  web:
    image: jarischaefer/docker-librenms
    restart: always
    ports:
      - '80:80'
    volumes:
      - ./librenms_data/logs:/opt/librenms/logs
      - ./librenms_data/rrd:/opt/librenms/rrd
      # Add this line
      - ./LineMessagingAPI.php:/opt/librenms/LibreNMS/Alert/Transport/Linemessagingapi.php
    environment:
      APP_KEY: base64:NA......................................SdA=
      DB_HOST: librenms_database
      DB_USER: librenms
      DB_PASS: Tuq.........tai
      DB_NAME: librenms
      POLLERS: 16
      BASE_URL: http://192.168.1.2
      TZ: Asia/Taipei
    depends_on:
      - mysql
  mysql:
    image: mariadb:10.5
    container_name: librenms_database
    restart: always
    volumes:
      - ./librenms_data/mysql:/var/lib/mysql
      - ./LineMessagingAPI.php:/opt/librenms/LibreNMS/Alert/Transport/Linemessagingapi.ph
    environment:
      TZ: Asia/Taipei
      MYSQL_ROOT_PASSWORD: Cho.........lan
      MYSQL_USER: librenms
      MYSQL_PASSWORD: Tuq.........tai
      MYSQL_DATABASE: librenms

官方 docker 架設方式也雷同，就不贅述了。

設定 LINE 開發者帳號

1. 前往Line開發者網站並註冊帳戶

https://developers.line.biz/

使用您的真人帳號來進行註冊。

2. 新增一個 Channel (頻道)

如果你沒有 Provider (供應商)，請先建立一個。

創建一個 Channel (頻道)，選擇 Messaging API ，然後填寫表單。

一些必填欄位說明：

Channel type 頻道類型：Messaging API
Provider 供應商：(選擇您的 Provider (供應商))
Company or owner’s country or region 公司或擁有者的國家或地區：(選擇您的地區)
Channel name 頻道名稱：(預設它將是您的 LINE機器人的名稱，送出後無法編輯)
Channel description 頻道描述：(預設它將是您的 LINE 機器人的描述)
Category 類別：(選擇適當的類別)
Subcategory 子類別：(選擇適當的子類別)

然後按送出建立它。

到 Channel 的 "Messaging API" 頁籤，這裡列出了一些你需要注意的重要值。

Bot basic ID 和 QR code 是您的 LINE 機器人的 ID 和 QR code。
Channel access token (long-lived)，通行 token ，效力等同於密碼，這將在 LibreNMS 中使用，請妥善保管。

使用您的真實 LINE 帳號加你建立的 LINE機器人為好友。

3. 設置 webhook 以獲取「收件人ID」

這邊講的「收件人ID」是指，你未來希望系統要把訊息發送到哪裡
它可以是

聊天群組（要抓取 groupID）
個人私訊（要抓取 userID）

以下是獲取「收件人ID」的步驟。

使用以下 NodeJS 程式和 ngrok 轉送臨時 https 連線。
以下步驟是在 Mac 底下操作。Linux 也適用這些步驟。

LINE-bot-RecipientFetcher

抓取程式

git clone https://github.com/j796160836/LINE-bot-RecipientFetcher.git

切換到該資料夾

cd LINE-bot-RecipientFetcher

執行程式

$ node index.js

使用 ngrok 將該連接埠暴露到網路上

ngrok http 3000

到 Channel (頻道) 中的 "Messaging API" 頁籤，
將 Webhook URL 填寫 ngork 所產生的網址 https://<your ngrok domain>/webhook

4. 獲取「收件人ID」

如果您想讓 LINE 機器人向自己（或者目標發送對象）發送訊息，這是獲取 userID 的步驟。

使用您的真實帳戶（或者目標發送對象）向您的 LINE 機器人發送訊息

範例資料：

{"type":"user","userId":"U527xxxxxxxxxxxxxxxxxxxxxxxxxc0ee"}

如果您想讓 LINE 機器人向一個群組發送訊息，這是獲取 groupID 的步驟。

將您的LINE機器人添加到群組中
使用您的真實帳戶在群組中發訊息

程式會把 groupID 印出來，這個就是收件人ID，請保管好。

範例資料：

{"type":"group","groupId":"Ce51xxxxxxxxxxxxxxxxxxxxxxxxxx6ef","userId":"U527xxxxxxxxxxxxxxxxxxxxxxxxxc0ee"} ```

LibreNMS 的通知設定

接下來回到 LibreNMS 繼續做設定。

1. 設定 Alert transport (通知管道)

到 Alerting > Alert Transports 頁面，新增一個 Alert transport (通知管道)。

Transport name 傳輸名稱：Line
Trsansport type 傳輸類型：Line Messanging API
Access token 存取權杖：(您的頻道存取權杖)
Recipient 收件人ID：_(填入剛剛抓的 userID或 MARKDOWN_HASH2df121e268641afe58606b37a6e37a50MARKDOWNHASH )

2. 在 Alert rules (監控規則) 中掛上 Alert transport (通知管道)

在 Alerts > Alert rules 設定警告通知規則，

在想要通知的規則上按編輯，
（以預設通知 Device Down! Due to no ICMP response 為例）

在 Transports 的地方加上這個通知管道。

可以在 Alert rules 設定好通知的：

Max alert 通知數：最多要通知幾次
Delay 延遲：問題發生後，延遲多久再來通知，
過濾掉時好時壞跳來跳去的情況
Interval 間隔：通知間隔，意指通知後隔多久再通知，該值會配合 Max alert 來使用。

例如：
Max alert: 3 / Delay: 30m / Interval: 5m
白話文就是：先延遲 30 分鐘再通知，通知共 3 次，每 5 分鐘通知一次

這邊可以依照需求來設定通知次數與頻繁度。

如果剛剛 Default Alert 有設定 ON 的話，應該所有規則都會出現才對。

測試

最後，你需要測試他們的通知設置是否正確。可以通過觸發警報或手動測試通知來完成這個步驟。

手動觸發測試

在 Alerts > Alert Transports 中，設定這個通知管道、通知方式。

就會收到測試訊息

以上，就是設定的所有內容，希望這個教學對您有幫助。

參考資料

2023-02-262023-02-28

[教學] 用 Gmail 來串接 LibreNMS 的 Email 通知

LibreNMS 系列文：

用 Docker 來架設 LibreNMS 架設網路服務監控系統
https://blog.jks.coffee/setup-librenms-using-docker/
用 Gmail 來串接 LibreNMS 的 Email 通知
https://blog.jks.coffee/librenms-gmail-alert-setup/
LibreNMS 串接 LINE 通知
https://blog.jks.coffee/librenms-line-message-alert-setup/

這篇是利用 Gmail 來設定電子郵件的通知方式

Gmail 建立應用程式密碼

首先，登入一個 Gmail 帳號，這個帳號未來會為系統寄件人。
你需要在 Google Gmail 中創建一個應用程式密碼。

到 Google 帳戶中的「安全性」頁籤，

https://myaccount.google.com/security

在「登入 Google」的區段，有一個「應用程式密碼 App passwords」的選項

有件事情要先提醒，這必須要先開啟「兩步驟驗證 (Two-factor authentication (2FA))」，才會出現這個選項

它會重新驗證你的帳號，然後出現以下畫面：

Select the app and device you want to generate the app password for.

你可以直接選 Other (Custom name) 然後給定一個名字，按下產生後產生。

這邊要注意，「密碼只會出現一次」 請好好保存你的密碼。

LibreNMS 的通知設定

以下分為幾個步驟：

1. 設定發信方式

接下來，在 LibreNMS 的設定中，
到 Global settings 中，找到 Alert settings 選 Email options 。

打開 Enable email alerting 選項，
以下參考 Gmail 的 SMTP 的資訊設定，如果有修改，以官方文件為主。

Enable email alerting：Enabled 開
From name：填入「寄件人」
（例如：`"LibreNMS System"）
From email address：填入「寄件人」的訊息
（例如："LibreNMS System" <[email protected]> ，這邊 E-mail 地址就填你剛剛設定的 Gmail 地址）
Use HTML emails：Enabled 開
How to deliver mail：SMTP
SMTP Server：smtp.gmail.com
SMTP port setting：587
Encryption：TLS
Auto TLS support：Enabled 開
SMTP authentication：Enabled 開
SMTP Auth username：填你剛剛設定的 Gmail 地址（例如： [email protected] ）
SMTP Auth password：填剛剛申請的「應用程式密碼」，不是你個人帳號的密碼唷

2. 建立通知管道 (Alert Transports)

然後，在 Alerts > Alert Transports 中，設定這個通知管道、通知方式。

按「Create alert transport」新增一個通知管道、通知方式

參數說明：

Transport name：取一個名字（例如：Email）
Transport type：Mail
Default Alert：是否為預設主要通知管道，這個依照你的需求來設定
Email：設定一個「收件人」，如果有發生警告，都會往他那邊寄信來通知
Include Graphs：是否包含圖片，這個保留預設 ON 即可

然後按「Save Transport」儲存

3. 在監控規則中掛上通知管道

最後在 Alerts > Alert rules 設定警告通知規則，

在想要通知的規則上按編輯，
（以預設通知 Device Down! Due to no ICMP response 為例）

在 Transports 的地方加上這個通知管道。

可以在 Alert rules 設定好通知的：

Max alert：最多要通知幾次
Delay：問題發生後，延遲多久再來通知，
過濾掉時好時壞跳來跳去的情況
Interval：通知間隔，意指通知後隔多久再通知，該值會配合 Max alert 來使用。

例如：
Max alert: 3 / Delay: 30m / Interval: 5m
白話文就是：先延遲 30 分鐘再通知，通知共 3 次，每 5 分鐘通知一次

這邊可以依照需求來設定通知次數與頻繁度。

如果剛剛 Default Alert 有設定 ON 的話，應該所有規則都會出現才對。

測試

最後，你需要測試他們的通知設置是否正確。可以通過觸發警報或手動測試通知來完成這個步驟。

手動觸發測試

在 Alerts > Alert Transports 中，設定這個通知管道、通知方式。

旁邊有一個打勾符號可以按，按一下測試。
成功的話就會收到 Email 通知。

總結來說，這個教學文章向使用者展示了如何在 LibreNMS 中設置 Gmail 通知。這將使管理人能夠即時收到他們的監視警報和報告。這對於系統管理員和網絡工程師來說非常重要，因為它可以幫助他們及時處理問題，保護他們的系統和網絡的安全。

參考資料

2023-01-272023-02-28

[教學] 用 Docker 來架設 LibreNMS 架設網路服務監控系統

LibreNMS 是一套 Open source 的功能完整的網路監控系統，
使用 SNMP (Simple Network Management Protocol) 協定來搜集電腦系統的資料。

初次研究後，就發現它可以協助解決設備很多在線上，
測量設備穩定性的事情。
就算該裝置沒有支援 SNMP，也可以使用純 ping 的方式來監控所有線上的設備。
就一步一步帶大家怎麼設定與架設。

LibreNMS 系列文：

用 Docker 來架設 LibreNMS 架設網路服務監控系統
https://blog.jks.coffee/setup-librenms-using-docker/
用 Gmail 來串接 LibreNMS 的 Email 通知
https://blog.jks.coffee/librenms-gmail-alert-setup/
LibreNMS 串接 LINE 通知
https://blog.jks.coffee/librenms-line-message-alert-setup/

以下使用 Docker 裝在 Linux 主機上。
至於 Linux 版本就看大家喜好，
以下示範使用 Ubuntu 系統，若是其他發佈版可以依樣畫葫蘆稍加修改。

我們今天用的是 jarischaefer/docker-librenms 套件來架設，
如果作者版本有更新安裝方式，再煩請告知。

GitHub 位置：
https://github.com/jarischaefer/docker-librenms

Step1. 產生密鑰

使用指令產生密鑰

$ sudo docker run --rm jarischaefer/docker-librenms generate_key

每台系統密鑰皆不相同，不可以直接複製。
如果有多台要架設，請記得更換密鑰！（這步驟很常忘記）

Step2. 編輯 docker-compose.yml

有關 docker 的設定方式就不贅述了。
有用過 docker 的朋友應該很熟悉 docker-compose 這指令。

現在要來做一個新的 docker-compose.yml 。

docker-compose.yml

version: '3.5'

services:
  web:
    image: jarischaefer/docker-librenms
    restart: always
    ports:
      - '80:80'
    volumes:
      - ./librenms_data/logs:/opt/librenms/logs
      - ./librenms_data/rrd:/opt/librenms/rrd
    environment:
      APP_KEY: base64:NA......................................SdA=
      DB_HOST: librenms_database
      DB_USER: librenms
      DB_PASS: Tuq.........tai
      DB_NAME: librenms
      POLLERS: 16
      BASE_URL: http://192.168.1.2
      TZ: Asia/Taipei
    depends_on:
      - mysql
  mysql:
    image: mariadb:10.5
    container_name: librenms_database
    restart: always
    volumes:
      - ./librenms_data/mysql:/var/lib/mysql
    environment:
      TZ: Asia/Taipei
      MYSQL_ROOT_PASSWORD: Cho.........lan
      MYSQL_USER: librenms
      MYSQL_PASSWORD: Tuq.........tai
      MYSQL_DATABASE: librenms

重要參數說明

web 部分

APP_KEY：密鑰（每台電腦皆不同，請自行產生）
DB_HOST：mysql 的 IP 位址（不需修改）
DB_USER：mysql 使用者
DB_PASS：mysql 密碼
DB_NAME：mysql 資料庫名稱
POLLERS：輪詢器數量
BASE_URL：預設網址（很重要，請記得改！就算是本機服務，也請修改成正確的網址。）
TZ：時區，這裡設定台灣 (Asia/Taipei)

mysql 資料庫部分

這裡使用 MariaDB 資料庫，要換成 mysql 5.7 也可以。

TZ：時區（與網頁伺服器一致即可）
MYSQL_ROOT_PASSWORD：資料庫 root 密碼
MYSQL_USER ：使用者（與 DB_USER 一致即可）
MYSQL_PASSWORD ：密碼（與 DB_PASS 一致即可）
MYSQL_DATABASE ：資料庫名稱（與 DB_NAME 一致即可）

Step3. 建立資料夾

建立相關路徑的資料夾，讓它能夠掛載。

$ mkdir -p ./librenms_data && \
mkdir -p ./librenms_data/logs && \
mkdir -p ./librenms_data/rrd && \
mkdir -p ./librenms_data/mysql

Step4. 啟動整組服務

利用 docker-compose 把整組服務啟動。

$ sudo docker-compose up -d

Step5. 初始化資料庫

服務整組起來之後，網頁瀏覽器應該可以看到這個訊息：

Database inconsistencies found during a database error, please fix to continue.

Your database is out of date!

不用太緊張，這是正常現象，等下下指令來初始化資料庫。

首先要先找到 librenms_web 的 container，
如果是 docker-compose 整組起來的話，可能會叫做 librenms_web_1 ，
執行指令前可以用 docker ps 指令來查看你的目前起的服務名稱（或 ID），確認一下。

$ sudo docker exec librenms_web_1 setup_database

這步驟是初始化它 LibreNMS 的資料庫。
如果失敗了，整個服務會起不來。

Step6. 建立 admin 管理者

它服務跑起來預設是「沒有任何帳號的」，
我們用該指令來建立 admin 管理者

$ sudo docker exec librenms_web_1 create_admin

librenms_web_1 名稱為 container_id，
可用 docker ps 指令來查看你的目前起的服務名稱（或 ID）。

這指令將會建立一個 admin 管理者：

帳號： admin
密碼： admin
E-Mail： [email protected]

記得去改密碼。記得去改密碼。記得去改密碼。
很重要講三次。

瀏覽你的本機網址，就可以看到 LibreNMS 的主頁面了。

背後的實現原理

建立健康度監控的操作步驟

Step1. 先建立 Device

再建立 Service

手動測試步驟

附註：在容器內找不到 ./check_http 程式？

舉一些範例

檢測 http 連結

測試指令

參數說明

檢測 https 連結

測試指令

參數說明

檢查 POST API (x-www-form-urlencoded)

測試指令

參數說明

檢查 POST API (json)

測試指令

參數說明

檢查 HTTP 狀態碼

測試指令

參數說明

檢查 SSL 憑證期限

測試指令

參數說明

個人小結

參考資料

抓下 Pull Request 的內容

設定 LINE 開發者帳號

1. 前往Line開發者網站並註冊帳戶

2. 新增一個 Channel (頻道)

3. 設置 webhook 以獲取「收件人ID」

4. 獲取「收件人ID」

LibreNMS 的通知設定

1. 設定 Alert transport (通知管道)

2. 在 Alert rules (監控規則) 中掛上 Alert transport (通知管道)

測試

手動觸發測試

參考資料

Gmail 建立應用程式密碼

LibreNMS 的通知設定

1. 設定發信方式

2. 建立通知管道 (Alert Transports)

3. 在監控規則中掛上通知管道

測試

手動觸發測試

參考資料

Step1. 產生密鑰

Step2. 編輯 docker-compose.yml

重要參數說明

web 部分

mysql 資料庫部分

Step3. 建立資料夾

Step4. 啟動整組服務

Step5. 初始化資料庫

Step6. 建立 admin 管理者

參考資料

附註：在容器內找不到 `./check_http` 程式？