異常監(jiān)控項目架構(gòu)

目錄

內(nèi)容

1. 簡介

前端監(jiān)控 是一套用于 監(jiān)測 前端項目運行時情況，及時上報錯、統(tǒng)計錯誤、性能和用戶行為的系統(tǒng)。它能我們及時地發(fā)現(xiàn)線上客戶端產(chǎn)品的錯誤、了解客戶端產(chǎn)品的性能 等；

目前提供了如下功能：

  • 用戶行為
    • 用戶在線時長
    • 菜單點擊量
    • 用戶增長
  • 異常監(jiān)控
    • 頁面性能
    • 錯誤看板
  • 報警
    • 報警配置
    • 報警日志

2. 項目成員

整個前端監(jiān)控項目由以下幾部分組成

  • 上報SDK：負責收集前端異常的 SDK；此 SDK 運行于需要被監(jiān)測的前端項目中，會在需要時將相關(guān)數(shù)據(jù)上報到 日志任務；
  • 日志任務：日志任務的作用是記錄 SDK 上報的數(shù)據(jù)，并定期處理數(shù)據(jù)，然后將處理后的數(shù)據(jù)存入 數(shù)據(jù)庫；
  • 管理系統(tǒng)：用來展示被監(jiān)控項目的異常情況，是整個組織中的展示層，數(shù)據(jù)從 Web服務 獲取；
  • Web服務：管理系統(tǒng) 的 后端服務，用來給后臺管理web項目提供 數(shù)據(jù)；
項目關(guān)系圖

此圖是由 dot 和 plantUML 語言繪成，如需修改，請看 [項目關(guān)系圖.dot][]、[項目關(guān)系圖.puml][]

各部分的倉庫地址如下：

  • 監(jiān)控后臺倉庫：包含 日志任務 和 Web服務；各服務的代碼入口代碼文件如下：
    • 日志任務： 源代碼入口：src/fee，構(gòu)建包入口：dist/fee；
    • Web服務：源代碼入口：src/app，構(gòu)建包入口：dist/fee；
  • 監(jiān)控前端倉庫：包含 管理系統(tǒng)；
  • 上報SDK：包含 SDK；

3. 整體架構(gòu)

整個監(jiān)控項目的整體架構(gòu)如下：


整體架構(gòu)

各個模塊的詳細的介紹如下

3.1. 上報SDK

上報SDK 運行于被監(jiān)控的前端項目中，用于收集相關(guān)數(shù)據(jù) 并將收集的數(shù)據(jù)上報給 后端服務。

上報的數(shù)據(jù)分為兩類：

  • 自動上報的數(shù)據(jù)：
    • 錯誤類型數(shù)據(jù)：主要是常見的JavaScript語法錯誤、運行錯誤、咨詢加載錯誤；通過監(jiān)聽全局錯誤事件、全局異常事件來獲取。
    • 性能相關(guān)數(shù)據(jù)：如：文檔開始獲取、開始解析、解析完成 等等；
    • 環(huán)境相關(guān)數(shù)據(jù)：主要是獲取 userAgent 相關(guān)的環(huán)境數(shù)據(jù)
  • 手動上報的數(shù)據(jù)：
    • 用戶行為數(shù)據(jù)：主要是用戶平均在線時長、用戶菜單點擊量等；
    • 業(yè)務錯誤數(shù)據(jù)：主要是業(yè)務上的邏輯錯誤，這類錯誤在 語言層面不算是錯誤，所以不能自動收集，需要開發(fā)人員自定義格式進行手動上報；

3.2. 日志任務

日志任務是用來 消費、清洗 SDK 上報的數(shù)據(jù)的，這個過程中，每一個環(huán)境都有相應的定時任務來處理，所以的定時任務統(tǒng)一由 Task:Manager 命令來統(tǒng)一調(diào)度，所以，我們需要通過 Task:Manager 命令來啟動日志任務。

3.2.1. 日志任務數(shù)據(jù)處理流程

從 SDK 上報數(shù)據(jù) 到 存入數(shù)據(jù)庫，這個數(shù)據(jù)的處理過程如下：

日志任務數(shù)據(jù)處理流程
  1. 數(shù)據(jù)收集：上報SDK 收集數(shù)據(jù)，然后將數(shù)據(jù)發(fā)送給后端；
  2. 生成日志：Nginx 將上報的數(shù)據(jù)記錄成日志文件；
  3. 結(jié)構(gòu)化數(shù)據(jù)：通過 SaveLog 命令將上一步生成的日志轉(zhuǎn)成 JSON 格式 并保存成 以分鐘為單位分隔的文件；
  4. 解析并存入原始表：通過 Parse 命令解析上一步的 JSON 數(shù)據(jù)，然后將數(shù)據(jù)存入到數(shù)據(jù)庫相應的原始數(shù)據(jù)表中；
  5. 統(tǒng)計：通過 Summary 命令對上一步解析后的數(shù)據(jù)進行統(tǒng)計，并將統(tǒng)計結(jié)果存入 數(shù)據(jù)庫的 結(jié)果數(shù)據(jù)表 和 Redis 中；

3.2.2. 命令的語法及作用

日志任務應用的入口文件是 dist/fee.js，所以，我們需要通過 node dist/fee.js 命令 參數(shù) 的方式來執(zhí)行下面描述的命令，比如：執(zhí)行 Utils:GenerateSQL命令的的方式為 node dist/fee.js Utils:GenerateSQL '1,2,3' 2020-12 2021-04。

由于 package.json 配置了 fee.js 的腳本，所以你也可以用 npm run fee 命令 參數(shù) 來執(zhí)行相應的命令。

結(jié)構(gòu)化

  • SaveLog:Kafka：解析kafka日志, 按日志創(chuàng)建時間將原日志和解析后合法的json日志落在log文件中, 每運行30s自動退出
    • 語法：SaveLog:Kafka
  • SaveLog:Nginx：每一分鐘讀取Nginx日志文件，并解析
    • 語法：SaveLog:Nginx

監(jiān)控

  • WatchDog:Alarm：根據(jù)報警配置，監(jiān)測每一條報警配置對應的項目錯誤
    • 語法：WatchDog:Alarm
  • WatchDog:Saas：[按分鐘] 檢查最近5分鐘內(nèi)錯誤數(shù)是否超出閾值, 自動報警
    • 語法：WatchDog:Saas
      解析
  • Parse:Monitor：[按分鐘] 解析kafka日志, 分析Monitor
    • 語法：Parse:Monitor <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm> <日志掃描范圍下限,格式為 YYYY-MM-DD HH:mm>
  • Parse:UV：[按小時] 解析kafka日志, 分析記錄指定時間范圍內(nèi)的uv
    • 語法：Parse:UV <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm> <日志掃描范圍下限 YYYY-MM-DD HH:mm>
  • Parse:TimeOnSiteByHour：[按小時] 解析kafka日志, 分析記錄指定時間范圍內(nèi)用戶停留時長
    • Parse:TimeOnSiteByHour <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm> <日志掃描范圍下限,格式為YYYY-MM-DD HH:mm>
  • Parse:Device：[按天] 解析kafka日志, 分析指定時間范圍Device
    • Parse:Device <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm> <日志掃描范圍下限 YYYY-MM-DD HH:mm>
  • Parse:MenuClick：[按天] 解析kafka日志, 用戶點擊情況
    • Parse:MenuClick <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm> <日志掃描范圍下限 YYYY-MM-DD HH:mm>
  • Parse:Performance：[按小時] 解析kafka日志, 分析分鐘級別的指定時間范圍內(nèi)的性能指標
    • Parse:Performance <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm> <日志掃描范圍下限 YYYY-MM-DD HH:mm>
  • Parse:UserFirstLoginAt：[按天] 解析kafka日志, 記錄用戶首次登陸時間
    • Parse:UserFirstLoginAt <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm> <日志掃描范圍下限 YYYY-MM-DD HH:mm>

統(tǒng)計

  • Summary:Error：[按分鐘/按小時/按天] 根據(jù)歷史數(shù)據(jù), 匯總分析錯誤數(shù)

    • 語法：Summary:Error <所統(tǒng)計時間,格式為：分 YYYY-MM-DD HH:mm | 小時 YYYY-MM-DD HH | 天 YYYY-MM-DD> <統(tǒng)計類型： minute | hour | day >

  • Summary:HttpError：[按天/按月] 基于數(shù)據(jù)表做統(tǒng)計, 統(tǒng)計http error分布情況

    • 語法：Summary:HttpError <按月/按天統(tǒng)計錯誤情況,格式為 YYYY-MM-DD | YYYY-MM> <日志統(tǒng)計格式:day | month >

  • Summary:NewUser：[按小時/按天/按月] 根據(jù)歷史數(shù)據(jù), 匯總分析記錄指定時間范圍內(nèi)的新增用戶數(shù)

    • 語法：Summary:NewUser <所統(tǒng)計時間,格式為： 小時 YYYY-MM-DD HH | 天 YYYY-MM-DD | 月 YYYY-MM> <統(tǒng)計類型：hour | day | month >

  • Summary:Performance：[按小時/按天/按月] 根據(jù)歷史數(shù)據(jù), 匯總分析記錄指定時間范圍內(nèi)的性能指標數(shù)據(jù)

    • 語法：Summary:Performance <所統(tǒng)計時間,格式為: 小時 YYYY-MM-DD HH | 天 YYYY-MM-DD | 月 YYYY-MM> <統(tǒng)計類型 : hour | day | month >

  • Summary:SystemBrowser：[按月] 基于數(shù)據(jù)庫統(tǒng)計瀏覽器占比

    • 語法：Summary:SystemBrowser <按月統(tǒng)計瀏覽器分布情況,格式為 YYYY-MM> <日志統(tǒng)計格式: month>

  • Summary:SystemDevice：[按月] 基于數(shù)據(jù)庫統(tǒng)計設(shè)備占比

    • 語法：Summary:SystemDevice <按月統(tǒng)計設(shè)備分布情況,格式為 YYYY-MM> <日志統(tǒng)計格式:month>

  • Summary:SystemOS：[按月]基于數(shù)據(jù)庫統(tǒng)計操作系統(tǒng)占比

    • 語法：Summary:SystemOS <按月統(tǒng)計系統(tǒng)分布情況,格式為 YYYY-MM> <日志統(tǒng)計格式:month>

  • Summary:SystemRuntimeVersion：[按月]基于數(shù)據(jù)庫統(tǒng)計版本占比

    • 語法：Summary:SystemRuntimeVersion <按月統(tǒng)計系統(tǒng)版本情況,格式為 YYYY-MM> <日志統(tǒng)計格式:month>

  • Summary:TimeOnSite：[按天/按月] 根據(jù)歷史數(shù)據(jù), 匯總分析記錄指定時間范圍內(nèi)用戶停留時長

    • 語法：Summary:TimeOnSite <所統(tǒng)計時間,格式為 YYYY-MM-DD | YYYY-MM > <日志統(tǒng)計格式: day | month >

  • Summary:UV：[按小時/按天/按月] 根據(jù)歷史數(shù)據(jù), 匯總分析記錄指定時間范圍內(nèi)的uv

    • 語法：Summary:UV <所統(tǒng)計時間,格式為: 小時 YYYY-MM-DD HH | 天 YYYY-MM-DD | 月 YYYY-MM> <統(tǒng)計類型: hour | day | month >

緩存

  • CreateCache:UpdatePerOneMinute：[每10分鐘執(zhí)行一次] 主動調(diào)用方法, 更新Redis緩存, 每10分鐘更新一次
    • 語法：CreateCache:UpdatePerOneMinute

工具

  • Utils:CleanOldLog：只保留當前月內(nèi)數(shù)據(jù), 每月20號之后自動刪除上個月數(shù)據(jù)

    • 語法：Utils:CleanOldLog

  • Utils:ReProcessLog：只保留當前月內(nèi)數(shù)據(jù), 每月20號之后自動刪除上個月數(shù)據(jù)

    • 語法：Utils:ReProcessLog <日志掃描范圍上限,格式為 YYYY-MM-DD HH:mm > <日志掃描范圍下限,格式為 YYYY-MM-DD HH:mm>

  • Utils:TestUC：測試UC接口

    • 語法：Utils:TestUC

  • Utils:Test：專業(yè)粘貼調(diào)試代碼

    • 語法：Utils:Test

  • Utils:GenerateSQL：生成項目在指定日期范圍內(nèi)的建表SQL

    • 語法：Utils:GenerateSQL <項目id列表,逗號分割> <建表日期開始時間(包括該時間),格式為 YYYY-MM> <建表日期結(jié)束時間(包括該時間), 格式為 YYYY-MM>

  • Utils:TemplateSQL：生成項目在指定日期范圍內(nèi)的建表SQL

    • 語法：Utils:TemplateSQL>

其它

  • Task:Manager：任務調(diào)度主進程, 只能啟動一次
    • 語法：Task:Manager
  • Command:Demo：任務調(diào)度主進程, 只能啟動一次
    • 語法：Command:Demo <必傳,用戶名> [可選,稱謂] < --onlyFlag:必傳,flag,只有true/false兩個值 > < --logName=@value:必傳,日志文件名> [--isTest?=@value:可選,是否處于測試環(huán)境]

3.2.3. 執(zhí)行周期

一次性命令： 整個應用生命周期只需要執(zhí)行一次

  • Task:Manager

每分鐘執(zhí)行一次：

  • SaveLog:Kafka：[按分鐘] 每分鐘啟動一次SaveLog
  • SaveLog:Nginx：[按分鐘] 每分鐘啟動一次SaveLog
  • WatchDog:Alarm：[按分鐘] 每分鐘啟動一次WatchDog:Alarm, 監(jiān)控平臺運行情況
  • Parse:Monitor：[按分鐘] 解析kafka日志, 分析錯誤詳情
  • Summary:Error：[按分鐘] 每分鐘運行Summary:Error, 分別統(tǒng)計前2,3,4,5,10分鐘內(nèi)的數(shù)據(jù)

每10分鐘執(zhí)行一次的任務：

  • CreateCache:UpdatePerOneMinute: 主動調(diào)用方法, 更新Redis緩存,
  • Parse:UV、Parse:TimeOnSiteByHour、Parse:Performance、Parse:Monitor：解析最近15分鐘內(nèi)的數(shù)據(jù)
  • Summary:UV、Summary:NewUser、Summary:Performance、Summary:Error：分別解析當前小時 和 一小時前

每1小時執(zhí)行一次的任務： 每小時15分30秒啟動

  • Parse:Device、Parse:MenuClick、Parse:UserFirstLoginAt：解析昨天到今天的數(shù)據(jù)
  • Summary:UV、Summary:NewUser、Summary:Performance、Summary:Error、Summary:TimeOnSite：處理當日數(shù)據(jù)

每6小時執(zhí)行一次的任務： 每過6小時在35分45秒啟動

  • Summary:UV、Summary:NewUser、Summary:Performance、Summary:Error、Summary:TimeOnSite：處理當日數(shù)據(jù)
  • Summary:UV、Summary:NewUser、Summary:Performance、Summary:TimeOnSite、Summary:SystemBrowser、Summary:SystemDevice、Summary:SystemOS：分別處理 當月 和 上月 的數(shù)據(jù)
  • Utils:CleanOldLog：清理歷史log

3.3. 管理系統(tǒng)

管理系統(tǒng) 是一個 Web應用，是用來以圖形化的方式展示 上報SDK 收集的各種數(shù)據(jù)，并提供了一些 用戶、權(quán)限、項目管理的功能，詳情請看 監(jiān)控前端倉庫。

3.4. Web服務

Web服務 是 管理系統(tǒng) 的后端服務，應用程序的入口文件是 dist/app。

3.5. 公司基礎(chǔ)設(shè)施

監(jiān)控項目接入了公司的基礎(chǔ)服務，如：PMS、MySQL、Redis、Kafka、Zookeeper 等等。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容