手把手教你建立 ASP.NET 自訂錯誤追蹤機制：XML 儲存、堆疊追蹤與全域攔截

專案上線後，錯誤日誌是排查問題的關鍵。本文完整示範如何從零建立一套輕量級錯誤追蹤系統：定義 XML 結構、實作寫入邏輯、整合 Web.config、攔截頁面與應用程式層級例外，並附上完整測試代碼與範例輸出。

一、設計 XML 結構

每筆錯誤記錄包含 9 個欄位：

<?xml version="1.0" encoding="utf-8"?>
<errorlog>
  <error>
    <datetime>發生時間</datetime>
    <filename>檔案名稱</filename>
    <classname>類別名稱</classname>
    <methodname>方法名稱</methodname>
    <errormethod>錯誤方法</errormethod>
    <message>錯誤訊息</message>
    <errordetails>詳細堆疊追蹤</errordetails>
    <IP>客戶端 IP</IP>
    <url>請求 URL</url>
  </error>
</errorlog>

二、實作 errorHandler 核心類別

靜態方法 WriteError(Exception ex, string fileName) 負責：

1. 從 Web.config 讀取 logfilepath 取得 XML 實體路徑；
2. 載入 XML、複製範本節點；
3. 透過 StackTrace 取得呼叫端 MethodBase 填入類別/方法名；
4. 擷取 Exception 詳細資訊（Message、StackTrace、TargetSite）；
5. 從 HttpContext.Current.Request 取得 IP 與 URL；
6. 寫入 XML 並儲存。

public static void WriteError(Exception ex, string fileName)
{
    XmlDocument doc = new XmlDocument();
    string strRootPath = ConfigurationManager.AppSettings["logfilepath"].ToString();
    string xmlPath = HttpContext.Current.Server.MapPath(strRootPath);
    doc.Load(xmlPath);

    XmlNode newNode = doc.ChildNodes[1].ChildNodes[0].CloneNode(true);
    StackFrame frame = new StackTrace().GetFrame(1);
    MethodBase method = frame.GetMethod();

    newNode.ChildNodes[0].InnerText = DateTime.Now.ToString();
    newNode.ChildNodes[1].InnerText = fileName;
    newNode.ChildNodes[2].InnerText = method.DeclaringType.FullName;
    newNode.ChildNodes[3].InnerText = method.Name;
    newNode.ChildNodes[4].InnerText = ex.TargetSite.Name;
    newNode.ChildNodes[5].InnerText = ex.Message;
    newNode.ChildNodes[6].InnerText = ex.StackTrace;
    newNode.ChildNodes[7].InnerText = HttpContext.Current.Request.UserHostAddress;
    newNode.ChildNodes[8].InnerText = HttpContext.Current.Request.Url.OriginalString;

    doc.ChildNodes[1].AppendChild(newNode);
    doc.Save(xmlPath);
}

三、Web.config 設定

<appSettings>
  <add key="logfilepath" value="~/errorHandling/errorlog.xml" />
</appSettings>

四、攔截測試：頁面層級與全域層級

1. Page_Load 攔截

protected void Page_Load(object sender, EventArgs e)
{
    try { throw new Exception("Custom error"); }
    catch (Exception ex)
    {
        Response.Write(ex.Message);
        errorHandler.WriteError(ex, "Default.aspx.cs");
    }
}

2. Global.asax Application_Error 攔截

void Application_Error(object sender, EventArgs e)
{
    errorHandler.WriteError(Server.GetLastError().GetBaseException(), "Global.asax");
}

五、實際輸出範例

<error>
  <datetime>2010-1-29 9:29:24</datetime>
  <filename>Default.aspx.vb</filename>
  <classname>kirin._Default</classname>
  <methodname>Page_Load</methodname>
  <errormethod>Page_Load</errormethod>
  <message>Custom error</message>
  <errordetails> 在 kirin._Default.Page_Load(Object sender, EventArgs e) 位置 C:\Demo\kirin_code_center\kirin\Default.aspx.cs:行號 16</errordetails>
  <IP>127.0.0.1</IP>
  <url>https://localhost:2192/default.aspx</url>
</error>

完整代碼下載：kirin_errorHandler.rar