Day25 系統監控與警示

14th鐵人賽 sentry django monitor maintenance

yenshaoting

團隊台南巷弄美食獵人

2022-10-10 21:01:49

2696 瀏覽

分享至

摘要

改善完前端的頁面，要實作新功能之前，有一些維護事項或是小工作可以先做，因為系統功能逐漸變多，需要加上一些監控機制，讓我們可以即時知道錯誤，及時修復。
今天會介紹如何使用 Sentry 來監控系統。

概念說明

當網站平台上線後，我們會需要關注幾個重點：

可用性問題，伺服器是否在運行中？
- 需要設計備援機制以及重啟機制，可以使用負載平衡器、Docker、K8S等軟體來達成，在本系列文中不會介紹到。
效能監控議題，網站是否正常運行，是否有異常流量
- 基本概念是要在伺服器站點使用監控軟體，並將伺服器的資料收集起來再視覺化顯示出來。再接著設置系統異常的條件，若出現異常則透過信件簡訊等方式通知維護者。
- 雲端主機都會有VM的效能分析，也可以設置警示系統。
- 另外可使用效能監控服務，如 Prometheus Grafana 來協助收集網路流量、CPU、RAM的使用量，與設置警示。
網站運行過程中是否會出現Bug，出現了應該如何處理？
- 系統難免會有預期以外的狀況產生，進而造成平台發生錯誤，使用者得到預期以外的結果。
- 有愈完整的出錯紀錄，就愈能協助開發者改善系統，因此需要建立錯誤回報與收集系統。
- 通常會在程式碼嵌入Logger 收集系統的錯誤
  - PythonAnywhere會提供error.log給開發者查閱。
- 也可以使用錯誤回報軟體，如Sentry協助管理錯誤。

Sentry

Sentry 是一個開源的系統錯誤監控軟體，可以嵌入在各種語言各種框架環境之中，提供會員免費的額度與定量空間，協助會員收集錯誤，也可以協助監控系統效能。若是有能力自行管理主機，也能下載原始碼自行部署。

詳細介紹可參考

https://blog.starrocket.io/posts/open-source-saas-sentry-helps-developers-to-monitor-application-and-track-error/

?本日成果

Untitled

申請Sentry 帳號
- 可以直接使用Google 第三方登入
建立組織（Organization）
- 組織下可以有數個專案，這裡就以本專案的名稱作為組織名稱。
- 這裡實際使用會建立兩個專案，一個監控離線環境，一個監控正式環境。
建立專案（Project）
- 這裡可以看到多種平台都可以適用，可以依照自身需要，我們就選擇Django。
- 設定專案名稱
- 簡易教學
  官網會提供簡易的教學，教我們如何使用Sentry，要注意的是每個專案會有一個專屬的DSN，設定同一個DSN，就會由同一個Sentry專案來收集資訊，這點要注意一下。
- traces_sample_rate是要設定效能收集的頻率，生產環境中會調小。
觸發第一個錯誤，並查看錯誤資訊。
- 官網會教我們觸發一個 1/0 的錯誤
  在本地會出現下圖
- 在Sentry 專案中則會收到Issue
- Issue 中會詳細說明錯誤發生的地方，瀏覽器、網站路徑、Cookie、Session等，跟Djano預設的錯誤資訊差不多。
  - 在生產環境中不宜將Debug資訊讓使用者看到，透過Sentry能將錯誤收集整理起來，協助我們查閱。

設定環境變數

因為環境不同，DSN有所不同，因此這裡使用環境變數來設定不同錯誤，應該要送去不同的專案。

import sentry_sdk
from sentry_sdk.integrations.django import DjangoIntegration
SENTRY_CLIENT_DSN = os.getenv('SENTRY_CLIENT_DSN')
sentry_sdk.init(
    dsn=SENTRY_CLIENT_DSN,
    integrations=[
        DjangoIntegration(),
    ],

    traces_sample_rate=0.01,
    send_default_pii=True
)