Sentry實時應用錯誤跟蹤系統在Kubernetes中私有化部署

應用錯誤跟蹤系統：對軟體系統執行過程中產生的錯誤日誌進行收集從而實現監控告警。

雖然軟體錯誤❌是不可避免的，但是可以降低錯誤數。

提高對錯誤的治理能力能讓錯誤帶來的損失降到最低 ​?? 。

錯誤日誌監控在最頂層的業務層監控,有他將會幫助你打造更好的軟體！

我們需要業務場景下自己發現Bug的速度快於使用者報告Bug的速度，畢竟讓使用者報告已經晚了。

典型的這套系統的架構：錯誤日誌(前端、後端) => 傳輸(HTTP)=>錯誤跟蹤平臺(收集、展示、分析、告警)。

本文不討論哪款軟體來解決這個問題，只講Sentry這個輪子,SASS版本和私有部署版體驗幾乎一致

本文主要講了

應用錯誤需要監控的場景案例

Sentry有哪些功能

Sentry如何在k8s中私有化部署

本文由 www.iamle.com 流水理魚 原創，wx公眾號搜尋 流水理魚 或 liushuiliyu

SEO 關鍵字

Sentry私有化部署

Sentry helm部署

Sentry kubernets部署 k8s部署

1. 需要應用錯誤監控的場景案例

• 多年的老web專案需要https適配，因為老專案大量寫死了http://所以檔案修改數巨大，即便測試很仔細也不能保證完全沒問題
• 運營發現落地頁轉化異常了，有訪問沒表單提交，找到技術，技術發現是某個JS報錯，導致表單無法提交，造成推廣費用的損失
• 上線了一個功能，由於環境差異，只在生產環境才觸發，使用者報告了才去查問題
• 應用錯誤日誌雖然通過ELK採集了，但是缺乏及時分析和告警
• 特定的環境才產生錯誤，要解決問題的先去構建環境並復現錯誤，因為不清楚發生錯誤時的具體引數

2. Sentry有哪些功能

Sentry is cross-platform application monitoring, with a focus on error reporting.

Sentry跨平臺應用監控，專注錯誤報告。

Sentry英文直譯中文叫“哨兵”。

Sentry提供了一個應用程式監視平臺，可以幫助您實時識別問題。

• 提供WEB UI

• 提供SASS版和私有部署2種方式

• 開源，授權協議為BSL，只要你不拿他來做SASS服務賣錢，自用可以免費商用

• 提供幾乎所有主流開發語言和框架的SDK

• 提供完整的錯誤詳情

• 支援自動上報錯誤和手動上報錯誤

• 支援WEB前端、後端、APP

• 支援多專案管理

• 支援賬號許可權管理

• 提供統一錯誤的聚合分析

• 今日頭條等很多大公司都在用

3. 在Kubernets中部署Sentry

目前網上大部分都是講DockerCompose的部署方式

其實Helm Hub上可以找到Sentry的helm charts包(⑤)，那麼直接用Helm部署Sentry是最快速方便的

3.1 Sentry部署資源要求

下面給出一個部署資源情況參考，這基本也就是最低資源消耗情況了

• Kubernets儲存已經支援了動態PVC

• Kubernets已經支援Ingress

• 準備一個子域名 (例如, sentry.iamle.com)

• Helm部署Sentry會部署sentry-corn、sentry-web()、sentry-worker、Redis、PostgreSQL

• 空負載資源詳細sentry-corn(220MB/0.01Core）、sentry-web(850MB/0.012Core)、sentry-worker(2048MB/0.04Core)、Redis(132+179MB/0.04+0.054Core)、PostgreSQL(506MB/0.03Core)

• 空負載整體資源佔用情況，記憶體：3935MB、CPU核數：0.2 Cores、儲存PVC：34G

3.2 Helm 部署 Sentry

helm為helm3

使用國內加速的charts(微軟azure)

helm repo add stable http://mirror.azure.cn/kubernetes/charts
helm repo add incubator http://mirror.azure.cn/kubernetes/charts-incubator
helm repo update
helm search repo sentry
#NAME                             	CHART VERSION	APP VERSION	DESCRIPTION
#stable/sentry                    	4.2.0        	9.1.2      	Sentry is a cross-platform crash reporting and ...
#已經可以在stable repo 找到 sentry

## helm安裝sentry
kubectl create namespace sentry
helm install sentry stable/sentry \
-n sentry \
--set persistence.enabled=true,user.email=i@iamle.com,user.password=i@iamle.com \
--set ingress.enabled=true,ingress.hostname=sentry.iamle.com,service.type=ClusterIP \
--set email.host=smtp.yourhost.com,email.port=25 \
--set email.user=user,email.password=password,email.use_tls=false \
--wait
#引數一看就懂,更多安裝引數看文末的參考⑤
#第一次安裝需要耗時10分鐘以上，等等等，db-init-job初始化資料庫的時候花費了太多時間
#在安裝完成之前，訪問sentry.iamle.com會出現伺服器內部錯誤

#出現下面的內容就表示部署好了
#NAME: sentry
#LAST DEPLOYED: Sun Apr 19 21:01:26 2020
#NAMESPACE: sentry
#STATUS: deployed
#REVISION: 1
#TEST SUITE: None
#NOTES:
#1. Get the application URL by running these commands:
#  export POD_NAME=$(kubectl get pods --namespace sentry -l "app=sentry,role=web" -o jsonpath="{.items[0].metadata.name}")
#  echo "Visit http://127.0.0.1:8080 to use your application"
#  kubectl port-forward --namespace sentry $POD_NAME 8080:9000
#
#2. Log in with
#
#  USER: i@iamle.com
#  Get login password with
#    kubectl get secret --namespace sentry sentry -o jsonpath="{.data.user-password}" | base64 --decode

#檢視登陸密碼，也就是user.password設定的值
#kubectl get secret --namespace default sentry -o jsonpath="{.data.user-password}" | base64 --decode

#刪除sentry
#helm uninstall sentry -n sentry

ingress根據自己實際環境做一些微調，筆者的環境下ssl證照使用 cert-manager 自動管理，備註annotations就自動配置ssl

# sentry ingress示例
kubectl apply -f - <<EOF
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: sentry
  namespace: sentry
  annotations:
    kubernetes.io/ingress.class: nginx
    kubernetes.io/tls-acme: "true"
    cert-manager.io/cluster-issuer: letsencrypt-prod
spec:
  rules:
  - host: sentry.iamle.com
    http:
      paths:
      - path: /
        backend:
          serviceName: sentry
          servicePort: 9000
  tls:
  - hosts:
    - sentry.iamle.com
    secretName: sentry-cert
EOF

瀏覽器訪問

https://sentry.iamle.com 使用安裝時設定的賬號密碼登陸即可

3.3 Sentry新增一個專案

理論上是需要給每個專案都在Sentry中建立一個對應的專案

但是實際上這麼幹會比較麻煩，筆者建議對訪問量不大，比如後臺類的相同型別的新建一個專案即可

發現混在一起已經不好區分了，再去拆開也不遲

對於本身訪問量巨大的“前端”專案，建議在Sentry管理後臺的一對一配置

Projects 》 Add new Project 選擇一個JavaScript型別

⚠️ 官方提供的SDK是國外的CDN，實際使用的時候需要把https://browser.sentry-cdn.com/5.5.0/bundle.min.js下載後放在自己的OSS+CDN上

SDK和初始化程式碼一般放入全站頭部當中，當頁面有js錯誤的時候已經會自動上報了

我們用chrome的console手動上報一個訊息測試下sentry是否工作正常

Sentry.captureMessage("流水理魚 www.iamle.com")

3.4 Helm安裝sentry常見問題及解決

• 解決資料庫不能初始化的問題

  如果安裝過程資料庫不能初始化，可以手動初始化

kubectl exec -it -n sentry $(kubectl get pods  -n sentry  |grep sentry-web |awk '{print $1}') bash
sentry upgrade

• 手動建立一個新的管理員賬號

kubectl exec -it -n sentry $(kubectl get pods  -n sentry  |grep sentry-web |awk '{print $1}') bash
sentry createuser

4. 總結

本文看起來洋洋灑灑一大篇，實際上15分鐘就能部署好sentry?

Sentry不僅僅支援WEB前端，也支援桌面、APP、後端，全平臺?

注意如果要升級sentry，先備份資料先，之前的資料會被清空 ⚠️

如果遇到Sentry的部署、使用等問題可以在部落格 www.iamle.com 中找到我的wx，加群討論?

5. 參考

• ① Sentry官網 https://sentry.io

• ② Sentry文件 https://docs.sentry.io/

• ③ Sentry git倉庫 https://github.com/getsentry/sentry

• ④ Sentry官方社群 https://forum.sentry.io/

• ⑤ Sentry Helm chart https://hub.helm.sh/charts/stable/sentry

本文首發於Sentry實時應用錯誤跟蹤系統在Kubernetes中私有化部署 https://www.iamle.com/archives/2847.html，如要轉載請註明出處。
本文首發於流水理魚部落格，如要轉載請註明出處。
歡迎關注我的公眾號：流水理魚（liushuiliyu），全棧、雲原生、團隊管理交流。
如果您對相關文章感興趣，也可以關注我的部落格：www.iamle.com 上面有更多內容