ASP.NET 2.0 新增的診斷相關服務關注的人不多,真正拿來用的人更少。但對正在靠它分析站點穩定性的團隊來說,有個能力會非常關鍵:讓 ASP.NET Ajax 的客戶端腳本錯誤也能進到診斷日誌,這樣才能取得更完整的資料,追出站點不穩定的來源。
在解釋這個服務之前,不妨先自問:如果要自己實作一套客戶端診斷服務,你會怎麼做?我的答案大概是這樣——寫一個 Web Service 負責收集錯誤資訊並寫進資料庫,再寫一段 JS 攔截客戶端異常、把它送到該服務。ASP.NET Futures(May CTP)提供的客戶端診斷服務,思路幾乎一樣,只是設計得更通用、更好擴充。
使用時,先在頁面上擺一個 Diagnostics 控制項,它的工作就是向客戶端輸出那段用來攔截異常的 JS。熟悉 ASP.NET Ajax 控制項設計的人大概已經猜到了:它是一個 ScriptControl。如果你有一個客戶端元件想以控制項形式部署到 Page 上,這個例子正好說明了方向——考慮繼承 IScriptControl 介面。
接著要建立接收診斷資訊的 Web Service。新增一個名為 DiagnosticsService.asmx 的服務,把它的 code-behind 宣告改成:
<%@ WebService Language="C#" Class="Microsoft.Web.Preview.Diagnostics.DiagnosticsService, Microsoft.Web.Preview" %>
這樣一來,這個服務用的就不是你寫的 code-behind,而是直接指向上述的 DiagnosticsService 類別——需要的函式都在裡面,你一行程式都不用補。那麼,記錄客戶端診斷資訊的程式碼到底寫在哪?先別急,往下看。
順帶一提,Futures 目前的做法跟原本 ASP.NET Ajax 的風格有點格格不入:它沒有直接用 HttpHandler 暴露服務,而是要求開發者自行部署一個 asmx 檔案。這個做法未來可能調整,屆時就不必手動部署了。
仔細看 DiagnosticsService,你會發現它有一個 OnClientException 事件,這才是重點。為了確保所有客戶端異常都能被記錄,你可以在 Global.asax 的 Application_Start 中綁定它,放在 HttpModule 裡綁也可以。事件處理函式中,你會透過 EventArgs 拿到一個 ExceptionServerInfo 型別,裡頭包含這些與客戶端異常相關的屬性:
拿到之後,用你喜歡的方式寫日誌即可——自己的資料庫,或是 ASP.NET 2.0 的 health monitor。
還有一件事很重要:這項服務預設是關閉的,必須在設定檔中宣告並啟用。先註冊 config section:
<configSections>
<sectionGroup name="microsoft.web.preview" type="Microsoft.Web.Preview.Configuration.PreviewSectionGroup, Microsoft.Web.Preview">
<section name="diagnostics" type="Microsoft.Web.Preview.Configuration.DiagnosticsSection, Microsoft.Web.Preview"/>
</sectionGroup>
</configSections>
再打開開關:
<microsoft.web.preview> <diagnostics enabled="true"/> </microsoft.web.preview>
完成這兩步,客戶端腳本出錯時,堆疊、行號、來源檔案、使用者代理等等資訊就會隨著事件一併送到你的日誌裡。對以 JavaScript 為主要 UI 層的專案來說,這幾乎等於替瀏覽器端裝上了一顆黑盒子。