5分鐘打造一個前端性能監控工具

来源:https://www.cnblogs.com/Selfocus/archive/2018/08/24/front-end-moniter.html
-Advertisement-
Play Games

為什麼監控 用（上）戶（帝）說，這個頁面怎麼這麼慢，還有沒有人管了？！ 簡單而言，有三點原因： 關註性能是工程師的本性 + 本分； 頁面性能對用戶體驗而言十分關鍵。每次重構對頁面性能的提升，僅靠工程師開發設備的測試數據是沒有說服力的，需要有大量的真實數據用於驗證； 資源掛了、載入出現異常，不能總靠用 ...


為什麼監控

用（上）戶（帝）說，這個頁面怎麼這麼慢，還有沒有人管了？！

簡單而言，有三點原因：

  • 關註性能是工程師的本性 + 本分；
  • 頁面性能對用戶體驗而言十分關鍵。每次重構對頁面性能的提升，僅靠工程師開發設備的測試數據是沒有說服力的，需要有大量的真實數據用於驗證；
  • 資源掛了、載入出現異常，不能總靠用戶投訴才後知後覺，需要主動報警。


一次性能重構，在千兆網速和萬元設備的條件下，頁面載入時間的提升可能只有0.1%，但是這樣的數（土）據（豪）不具備代表性。網路環境、硬體設備千差萬別，對於中低端設備而言，性能提升的主觀體驗更為明顯，對應的數據變化更具備代表性。

不少項目都會把資源上傳到 CDN。而 CDN 部分節點出現問題的時候，一般不能精準的告知“某某，你的 xx 資源掛了”，因此需要我們主動監控。

根據谷歌數據顯示，當頁面載入超過 10s 時，用戶會感到絕望，通常會離開當前頁面，並且很可能不再回來。

用什麼監控

關於前端性能指標，W3C 定義了強大的 Performance API，其中又包括了 High Resolution Time 、 Frame Timing 、 Navigation Timing 、 Performance Timeline 、Resource Timing 、 User Timing 等諸多具體標準。

本文主要涉及 Navigation Timing 以及 Resource Timing。截至到 2018 年中旬，各大主流瀏覽器均已完成了基礎實現。

Performance API 功能眾多，其中一項，就是將頁面自身以及頁面中各個資源的性能表現（時間細節）記錄了下來。而我們要做的就是查詢和使用。

讀者可以直接在瀏覽器控制臺中輸入 performance ，查看相關 API。

接下來，我們將使用瀏覽器提供的 window.performance 對象（Performance API 的具體實現），來實現一個簡易的前端性能監控工具。

5 分鐘擼一個前端性能監控工具

第一行代碼

將工具命名為 pMonitor，含義是 performance monitor。

const pMonitor = {}

監控哪些指標

既然是“5 分鐘實現一個 xxx”系列，那麼就要有取捨。因此，本文只挑選了最為重要的兩個指標進行監控：

  • 頁面載入時間
  • 資源請求時間

頁面載入

有關頁面載入的性能指標，可以在 Navigation Timing 中找到。Navigation Timing 包括了從請求頁面起，到頁面完成載入為止，各個環節的時間明細。
可以通過以下方式獲取 Navigation Timing 的具體內容：
const navTimes = performance.getEntriesByType('navigation')

getEntriesByType 是我們獲取性能數據的一種方式。performance 還提供了 getEntries 以及 getEntriesByName 等其他方式，由於“時間限制”，具體區別不在此贅述，各位看官可以移步到此：www.w3.org/TR/performa…。

返回結果是一個數組，其中的元素結構如下所示：
{
"connectEnd": 64.15495765894057,
"connectStart": 64.15495765894057,
"domainLookupEnd": 64.15495765894057,
"domainLookupStart": 64.15495765894057,
"domComplete": 2002.5385066728431,
"domContentLoadedEventEnd": 2001.7384263440083,
"domContentLoadedEventStart": 2001.2386167400286,
"domInteractive": 1988.638474368076,
"domLoading": 271.75174283737226,
"duration": 2002.9385468372606,
"entryType": "navigation",
"fetchStart": 64.15495765894057,
"loadEventEnd": 2002.9385468372606,
"loadEventStart": 2002.7383663540235,
"name": "document",
"navigationStart": 0,
"redirectCount": 0,
"redirectEnd": 0,
"redirectStart": 0,
"requestStart": 65.28225608537441,
"responseEnd": 1988.283025689508,
"responseStart": 271.75174283737226,
"startTime": 0,
"type": "navigate",
"unloadEventEnd": 0,
"unloadEventStart": 0,
"workerStart": 0.9636893776343863
}
關於各個欄位的時間含義，Navigation Timing Level 2 給出了詳細說明：

不難看出，細節滿滿。因此，能夠計算的內容十分豐富，例如 DNS 查詢時間，TLS 握手時間等等。可以說，只有想不到，沒有做不到～
既然我們關註的是頁面載入，那自然要讀取 domComplete:
const [{ domComplete }] = performance.getEntriesByType('navigation')
定義個方法，獲取 domComplete：
pMonitor.getLoadTime = () => {
const [{ domComplete }] = performance.getEntriesByType('navigation')
return domComplete
}
到此，我們獲得了準確的頁面載入時間。

資源載入

既然頁面有對應的 Navigation Timing，那靜態資源是不是也有對應的 Timing 呢？
答案是肯定的，其名為 Resource Timing。它包含了頁面中各個資源從發送請求起，到完成載入為止，各個環節的時間細節，和 Navigation Timing 十分類似。
獲取資源載入時間的關鍵字為 'resource', 具體方式如下：
performance.getEntriesByType('resource')

不難聯想，返回結果通常是一個很長的數組，因為包含了頁面上所有資源的載入信息。

每條信息的具體結構為：
{
"connectEnd": 462.95008929525244,
"connectStart": 462.95008929525244,
"domainLookupEnd": 462.95008929525244,
"domainLookupStart": 462.95008929525244,
"duration": 0.9620853673520173,
"entryType": "resource",
"fetchStart": 462.95008929525244,
"initiatorType": "img",
"name": "https://cn.bing.com/sa/simg/SharedSpriteDesktopRewards_022118.png",
"nextHopProtocol": "",
"redirectEnd": 0,
"redirectStart": 0,
"requestStart": 463.91217466260445,
"responseEnd": 463.91217466260445,
"responseStart": 463.91217466260445,
"startTime": 462.95008929525244,
"workerStart": 0
}

以上為 2018 年 7 月 7 日，在 cn.bing.com 下搜索 test 時，performance.getEntriesByType("resource") 返回的第二條結果。

我們關註的是資源載入的耗時情況，可以通過如下形式獲得：
const [{ startTime, responseEnd }] = performance.getEntriesByType('resource')
const loadTime = responseEnd - startTime

同 Navigation Timing 相似，關於 startTime 、 fetchStart、connectStart 和 requestStart 的區別， Resource Timing Level 2 給出了詳細說明：

並非所有的資源載入時間都需要關註，重點還是載入過慢的部分。
出於簡化考慮，定義 10s 為超時界限，那麼獲取超時資源的方法如下：
const SEC = 1000
const TIMEOUT = 10 * SEC
const setTime = (limit = TIMEOUT) => time => time >= limit
const isTimeout = setTime()
const getLoadTime = ({ startTime, responseEnd }) => responseEnd - startTime
const getName = ({ name }) => name
const resourceTimes = performance.getEntriesByType('resource')
const getTimeoutRes = resourceTimes
.filter(item => isTimeout(getLoadTime(item)))
.map(getName)

這樣一來，我們獲取了所有超時的資源列表。

簡單封裝一下：const SEC = 1000

const TIMEOUT = 10 * SEC
const setTime = (limit = TIMEOUT) => time => time >= limit
const getLoadTime = ({ requestStart, responseEnd }) =>
responseEnd - requestStart
const getName = ({ name }) => name
pMonitor.getTimeoutRes = (limit = TIMEOUT) => {
const isTimeout = setTime(limit)
const resourceTimes = performance.getEntriesByType('resource')
return resourceTimes.filter(item => isTimeout(getLoadTime(item))).map(getName)
}

上報數據


獲取數據之後，需要向服務端上報：
// 生成表單數據
const convert2FormData = (data = {}) =>
Object.entries(data).reduce((last, [key, value]) => {
if (Array.isArray(value)) {
return value.reduce((lastResult, item) => {
lastResult.append(`${key}[]`, item)
return lastResult
}, last)
}
last.append(key, value)
return last
}, new FormData())
// 拼接 GET 時的url
const makeItStr = (data = {}) =>
Object.entries(data)
.map(([k, v]) => `${k}=${v}`)
.join('&')
// 上報數據
pMonitor.log = (url, data = {}, type = 'POST') => {
const method = type.toLowerCase()
const urlToUse = method === 'get' ? `${url}?${makeItStr(data)}` : url
const body = method === 'get' ? {} : { body: convert2FormData(data) }
const option = {
method,
...body
}
fetch(urlToUse, option).catch(e => console.log(e))
}

回過頭來初始化


數據上傳的 url、超時時間等細節，因項目而異，所以需要提供一個初始化的方法：
// 緩存配置
let config = {}
/**
* @param {object} option
* @param {string} option.url 頁面載入數據的上報地址
* @param {string} option.timeoutUrl 頁面資源超時的上報地址
* @param {string=} [option.method='POST'] 請求方式
* @param {number=} [option.timeout=10000]
*/
pMonitor.init = option => {
const { url, timeoutUrl, method = 'POST', timeout = 10000 } = option
config = {
url,
timeoutUrl,
method,
timeout
}
// 綁定事件 用於觸發上報數據
pMonitor.bindEvent()
}

何時觸發

性能監控只是輔助功能，不應阻塞頁面載入，因此只有當頁面完成載入後，我們才進行數據獲取和上報（實際上，頁面載入完成前也獲取不到必要信息）：
// 封裝一個上報兩項核心數據的方法
pMonitor.logPackage = () => {
const { url, timeoutUrl, method } = config
const domComplete = pMonitor.getLoadTime()
const timeoutRes = pMonitor.getTimeoutRes(config.timeout)
// 上報頁面載入時間
pMonitor.log(url, { domeComplete }, method)
if (timeoutRes.length) {
pMonitor.log(
timeoutUrl,
{
timeoutRes
},
method
)
}
}
// 事件綁定
pMonitor.bindEvent = () => {
const oldOnload = window.onload
window.onload = e => {
if (oldOnload && typeof oldOnload === 'function') {
oldOnload(e)
}
// 儘量不影響頁面主線程
if (window.requestIdleCallback) {
window.requestIdleCallback(pMonitor.logPackage)
} else {
setTimeout(pMonitor.logPackage)
}
}
}

彙總
到此為止，一個完整的前端性能監控工具就完成了～全部代碼如下：
const base = {
log() {},
logPackage() {},
getLoadTime() {},
getTimeoutRes() {},
bindEvent() {},
init() {}
}

const pm = (function() {
// 向前相容
if (!window.performance) return base
const pMonitor = { ...base }
let config = {}
const SEC = 1000
const TIMEOUT = 10 * SEC
const setTime = (limit = TIMEOUT) => time => time >= limit
const getLoadTime = ({ startTime, responseEnd }) => responseEnd - startTime
const getName = ({ name }) => name
// 生成表單數據
const convert2FormData = (data = {}) =>
Object.entries(data).reduce((last, [key, value]) => {
if (Array.isArray(value)) {
return value.reduce((lastResult, item) => {
lastResult.append(`${key}[]`, item)
return lastResult
}, last)
}
last.append(key, value)
return last
}, new FormData())
// 拼接 GET 時的url
const makeItStr = (data = {}) =>
Object.entries(data)
.map(([k, v]) => `${k}=${v}`)
.join('&')
pMonitor.getLoadTime = () => {
const [{ domComplete }] = performance.getEntriesByType('navigation')
return domComplete
}
pMonitor.getTimeoutRes = (limit = TIMEOUT) => {
const isTimeout = setTime(limit)
const resourceTimes = performance.getEntriesByType('resource')
return resourceTimes
.filter(item => isTimeout(getLoadTime(item)))
.map(getName)
}
// 上報數據
pMonitor.log = (url, data = {}, type = 'POST') => {
const method = type.toLowerCase()
const urlToUse = method === 'get' ? `${url}?${makeItStr(data)}` : url
const body = method === 'get' ? {} : { body: convert2FormData(data) }
const init = {
method,
...body
}
fetch(urlToUse, init).catch(e => console.log(e))
}
// 封裝一個上報兩項核心數據的方法
pMonitor.logPackage = () => {
const { url, timeoutUrl, method } = config
const domComplete = pMonitor.getLoadTime()
const timeoutRes = pMonitor.getTimeoutRes(config.timeout)
// 上報頁面載入時間
pMonitor.log(url, { domeComplete }, method)
if (timeoutRes.length) {
pMonitor.log(
timeoutUrl,
{
timeoutRes
},
method
)
}
}
// 事件綁定
pMonitor.bindEvent = () => {
const oldOnload = window.onload
window.onload = e => {
if (oldOnload && typeof oldOnload === 'function') {
oldOnload(e)
}
// 儘量不影響頁面主線程
if (window.requestIdleCallback) {
window.requestIdleCallback(pMonitor.logPackage)
} else {
setTimeout(pMonitor.logPackage)
}
}
}

/**
* @param {object} option
* @param {string} option.url 頁面載入數據的上報地址
* @param {string} option.timeoutUrl 頁面資源超時的上報地址
* @param {string=} [option.method='POST'] 請求方式
* @param {number=} [option.timeout=10000]
*/
pMonitor.init = option => {
const { url, timeoutUrl, method = 'POST', timeout = 10000 } = option
config = {
url,
timeoutUrl,
method,
timeout
}
// 綁定事件 用於觸發上報數據
pMonitor.bindEvent()
}

return pMonitor
})()

export default pm
如何？是不是不複雜？甚至有點簡單～

再次看了看時間，5 分鐘什麼的，還是不要在意這些細節了吧 orz


補充說明
調用
如果想追（吹）求（毛）極（求）致（疵）的話，在頁面載入時，監測工具不應該占用主線程的 JavaScript 解析時間。因此，最好在頁面觸發 onload 事件後，採用非同步載入的方式：
// 在項目的入口文件的底部
const log = async () => {
const pMonitor = await import('/path/to/pMonitor.js')
pMonitor.init({ url: 'xxx', timeoutUrl: 'xxxx' })
pMonitor.logPackage()
// 可以進一步將 bindEvent 方法從源碼中刪除
}
const oldOnload = window.onload
window.onload = e => {
if (oldOnload && typeof oldOnload === 'string') {
oldOnload(e)
}
// 儘量不影響頁面主線程
if (window.requestIdleCallback) {
window.requestIdleCallback(log)
} else {
setTimeout(log)
}
}

 

跨域等請求問題
工具在數據上報時，沒有考慮跨域問題，也沒有處理 GET 和 POST 同時存在的情況。

5 分鐘還要什麼自行車！

如有需求，可以自行覆蓋 pMonitor.logPackage 方法，改為動態創建 <form/> 和 <iframe/> ，或者使用更為常見的圖片打點方式～
說好的報警呢？光有報沒有警？！
這個還是需要服務端配合的嘛[認真臉.jpg]。
既可以是每個項目對應不同的上報 url，也可以是統一的一套 url，項目分配唯一 id 作為區分。
當超時次數在規定時間內超過約定的閾值時，郵件/簡訊通知開發人員。
細粒度
現在僅僅針對超時資源進行了簡單統計，但是沒有上報具體的超時原因（DNS？TCP？request？ response？），這就留給讀者去優化了，動手試試吧～

下一步

本文介紹了關於頁面載入方面的性能監控，此外，JavaScript 代碼的解析 + 執行，也是制約頁面首屏渲染快慢的重要因素（特別是單頁面應用）。下一話，小編將帶領大家進一步探索 Performance Timeline Level 2，實現更多對於 JavaScript 運行時的性能監控，敬請期待～

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • react如何監聽路由url變化
    使用這些生命周期鉤子可以監聽到路由相同，參數不同的變化，但是監聽不到完全不相同的url的變化。即使路由不同，componentDidMount組件內容所更新的東西變了，但是代碼變了，頁面沒有變，找到了一種方法。withRouter 參考：https://reacttraining.com/react ...
  • 微信小程式APP（商超營銷類）經驗總結
    項目介紹 這是一款主射門店營銷的小程式。包括首頁、門店、營銷、個人設置、登錄、數據統計展示、營銷設置等。 本來要獨立完成整個項目，包括前後端一套的，有些意外因素，項目臨時收尾（說明：只完成了前端的部分，後端未完成）。 管理大師們說過：一個好的項目，必須有一個好的收尾，好的收尾，就一定要有好的經驗總結 ...
  • CSS實現圖片等比例縮小不變形
    img { /*等寬縮小不變形*/ /*width: 100%;*/ /*二選一*/ /*等高縮小不變形*/ height: 100%; } ...
  • Http的持久連接和管線化
    【要點】 1. 什麼是持久連接？ 2. 什麼是管線化？ 【總結】 1.什麼是持久連接？ (keep alive模式) HTTP1.1規定了預設保持長連接（HTTP persistent connection ，也有翻譯為持久連接）;數據傳輸完成了保持TCP連接不斷開（不發RST包、不四次握手），等待 ...
  • vue在傳值的時候經常遇到的問題
    在我用vue編寫程式的時候，在傳值的時候，經常會遇到些問題，像今天遇到了兩個問題，在用父傳子的方法去傳值，當父組件中的要傳的數據是for迴圈出來的或者是列表的時候，你想每次運行的事件，都去傳某一行，或者某部分數據的時候，在子組件中用mounted(){}，去載入並顯示在頁面上，還有就是在父傳子中，把 ...
  • 《React Native 精解與實戰》書籍連載「配置 iOS 與 Android 開發環境」
    此文是我的出版書籍[《React Native 精解與實戰》](http://rn.parryqiu.com/)連載分享，此書由機械工業出版社出版，書中詳解了 React Native 框架底層原理、React Native 組件佈局、組件與 API 的介紹與代碼實戰，以及 React Native... ...
  • Http協議之報文·方法·狀態碼
    【要點】 1. HTTP協議的主要特點 2. HTTP報文的組成部分 3. HTTP方法 4. POST 和 GET的區別 5. HTTP狀態碼 【總結】 HTTP協議的主要特點 主要特點：簡單快速， 靈活， 無連接（非keep-alive），無狀態 每個資源URI是固定的，想訪問某個資源 ，瀏覽器 ...
  • 二叉樹深度優先 求二叉樹最大深度
    深度優先遍歷：對每一個可能的分支路徑深入到不能再深入為止，而且每個結點只能訪問一次。要特別註意的是，二叉樹的深度優先遍歷比較特殊，可以細分為先序遍歷、中序遍歷、後序遍歷。 二叉樹最大深度： 如果二叉樹為空，則深度為0 如果不為空，分別求左子樹的深度和右子樹的深度，取最大的再加1。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類