ASP.NET MVC Elmah Dashboard

2016-05-27

ASP.NET MVC Elmah Dashboard - 查看 Elmah 存在 SQL Server 的記錄

1500
0
2016-06-03

Elmah 有提供一個基本的記錄顯示介面，可以讓我們看到有哪些 Exception 被記錄下來，但長久下來要在一大多的 Exception Record 裡去找出問題或是作分析就會是一大難題，因為這個基本的顯示介面是相當陽春的，如果有將這些記錄存在 SQL Server 裡的話，還可以在 SSMS 裡去下 T-SQL 做資料查詢，但是要要查個 Exception 紀錄還要開啟 SSMS 也是蠻累人的，尤其是有些團隊的環境裡是不允許開發人員直接連接正式環境的 SQL Server，所以就無法使用 SSMS 去做查詢了。

如果有將 Elmah 所攔截的例外錯誤給存放到「SQL Server」的團隊，這邊向你們介紹一個簡單方便的套件「ASP.NET MVC ELMAH Dashboard」

無論是 ASP.NET WebFroms or MVC or WebApi，我都會在專案裡安裝使用 Elmah 來攔截紀錄例外錯誤，這個部落格裡也有很多篇文章在說明，Elmah 這套件真的是一個歷史悠久的工具，早在 2004 年就已經出現了，但是我真的很意外居然蠻多人是聽都沒有聽過，甚至有許多人是不懂為何要來攔截記錄錯誤（我就完全不懂這些人是如何知道網站發生了什麼例外錯誤，而且怎麼去做分析與修復？），有些團隊雖然沒有使用過 Elmah 而是選擇自己建立錯誤處理機制或是使用其他的錯誤攔截記錄機制，不管如何，例外錯誤的處理是不能夠掉以輕心的，問題往往都能夠從這些有被紀錄的 Exception 裡去被發現。

在正式進入介紹主題之前，先來回顧一下之前以 Elmah 為主題的文章：

ASP.NET MVC + ELMAH 監控並記錄你的網站錯誤資訊 1 基本安裝與介紹
ASP.NET MVC + ELMAH 監控並記錄你的網站錯誤資訊 2 修改 elmah 的預設瀏覽路徑
ASP.NET MVC + ELMAH 監控並記錄你的網站錯誤資訊 3 elmah 的信件通知設定與 favicon.icon 404 錯誤過濾
ASP.NET MVC + ELMAH 監控並記錄你的網站錯誤資訊 4 將 elmah 錯誤記錄儲存到 MS SQL Server 中
ELMAH - 自訂錯誤通知郵件的設定(於特定Exception)
ASP.NET MVC 使用Glimpse監測網站的一舉一動 3 - 結合ELMAH
ASP.NET MVC 3 使用 ELMAH 無法記錄正確 Http Status Code ? （此篇已收錄於 elmah 官網 Wiki - WebBase 單元中 http://code.google.com/p/elmah/wiki/WebBase）
ASP.NET MVC 使用 Elmah 但不安裝 Elmah.MVC 的 location 修改
 Elmah.MVC 2.0.0
ELMAH.MVC 2.0.1 - 可以自訂瀏覽路徑
 ELMAH - 設定錯誤通知信件的主旨
 ASP.NET MVC 與 Elmah.MVC 2.1.1 以及使用 Windows Azure SQL Database 的Schema 修改

另外還有在 2012-06-14 twMVC#2「攻略 ASP.NET MVC - 從無到有與效能剖析」這場研討會裡所另外準備「Log Reporting Dashboard」，這是將 Darren Weir 所創作的原始版本改寫為 ASP.NET MVC 3，在 twMVC 的 Github Repository 有將改寫後的原始碼分享出來，

https://github.com/twMVC/twMVC-2-2

雖然有改寫 Log Reporting Dashboard 並分享出來，但是在實際工作的專案裡有用的的次數卻是很少，很多無法使用的原因在於專案的 Log 不是存放在 SQL Server 裡。

上面雖然這麼說，但這篇要介紹的「ASP.NET MVC ELMAH Dashboard」這個套件的必要條件就是 Elmah 紀錄是存放到 SQL Server 裡，所以凡是存放到 Memory, XML 或其他儲存裝置的方式，就請不要在最後留言還問我存放到不是 SQL Server 的方式要怎麼使用這個套件，只能支援 SQL Server 喔！

http://www.arebis.be/MvcElmahDashboard/

https://www.nuget.org/packages/Arebis.Web.Mvc.ElmahDashboard/

http://www.arebis.be/MvcElmahDashboard/MvcElmahDashboard_Readme.html

直接給大家看最終完成結果

MVC Elmah Dashboard 首頁

Logs

Log Details

Log 查詢

安裝說明

Step.1

這邊以一個新建立的 ASP.NET MVC 5 網站為例，然後安裝基本的 Elmah 套件

SNAGHTML1f6da08a

Step.2

因為是要將 Elmah 存放在 SQL Server 裡，這裡是使用 LocalDB，所以在專案裡新增 LocalDB 並且建立 Elmah 存放 Exception 記錄的 Table，

[ELMAH.Error] Table Create Schema

--~Changing index [dbo].[ELMAH_Error].PK_ELMAH_Error to a clustered index.  You may    want to pick a different index to cluster on.
SET ANSI_NULLS ON
SET QUOTED_IDENTIFIER ON
IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].    [ELMAH_Error]') AND type in (N'U'))
BEGIN
CREATE TABLE [dbo].[ELMAH_Error](
[ErrorId] [uniqueidentifier] NOT NULL,
[Application] [nvarchar](60) NOT NULL,
[Host] [nvarchar](50) NOT NULL,
[Type] [nvarchar](100) NOT NULL,
[Source] [nvarchar](60) NOT NULL,
[Message] [nvarchar](500) NOT NULL,
[User] [nvarchar](50) NOT NULL,
[StatusCode] [int] NOT NULL,
[TimeUtc] [datetime] NOT NULL,
[Sequence] [int] IDENTITY(1,1) NOT NULL,
[AllXml] [nvarchar](max) NOT NULL,
CONSTRAINT [PK_ELMAH_Error] PRIMARY KEY CLUSTERED 
(
[ErrorId] ASC
)WITH (STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF)
)
END
 
IF NOT EXISTS (SELECT * FROM sys.indexes WHERE object_id = OBJECT_ID(N'[dbo].[ELMAH_Error]') AND name = N'IX_ELMAH_Error_App_Time_Seq')
CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_App_Time_Seq] ON [dbo].[ELMAH_Error] 
(
[Application] ASC,
[TimeUtc] DESC,
[Sequence] DESC
)WITH (STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, DROP_EXISTING = OFF, ONLINE  = OFF)
GO
IF NOT EXISTS (SELECT * FROM dbo.sysobjects WHERE id =     OBJECT_ID(N'[DF_ELMAH_Error_ErrorId]') AND type = 'D')
BEGIN
ALTER TABLE [dbo].[ELMAH_Error] ADD  CONSTRAINT [DF_ELMAH_Error_ErrorId]  DEFAULT (newid()) FOR [ErrorId]
END
 
GO
SET ANSI_NULLS ON
SET QUOTED_IDENTIFIER ON
IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[ELMAH_GetErrorsXml]') AND type in (N'P', N'PC'))
BEGIN
EXEC dbo.sp_executesql @statement = N'
CREATE PROCEDURE [dbo].[ELMAH_GetErrorsXml]
(
@Application NVARCHAR(60),
@PageIndex INT = 0,
@PageSize INT = 15,
@TotalCount INT OUTPUT
)
AS 
 
SET NOCOUNT ON
 
DECLARE @FirstTimeUTC DATETIME
DECLARE @FirstSequence INT
DECLARE @StartRow INT
DECLARE @StartRowIndex INT
 
SELECT 
    @TotalCount = COUNT(1) 
FROM 
    [ELMAH_Error]
WHERE 
    [Application] = @Application
 
-- Get the ID of the first error for the requested page
 
SET @StartRowIndex = @PageIndex * @PageSize + 1
 
IF @StartRowIndex <= @TotalCount
BEGIN
 
    SET ROWCOUNT @StartRowIndex
 
    SELECT  
        @FirstTimeUTC = [TimeUtc],
        @FirstSequence = [Sequence]
    FROM 
        [ELMAH_Error]
    WHERE   
        [Application] = @Application
    ORDER BY 
        [TimeUtc] DESC, 
        [Sequence] DESC
 
END
ELSE
BEGIN
 
    SET @PageSize = 0
 
END
 
-- Now set the row count to the requested page size and get
-- all records below it for the pertaining application.
 
SET ROWCOUNT @PageSize
 
SELECT 
    errorId     = [ErrorId], 
    application = [Application],
    host        = [Host], 
    type        = [Type],
    source      = [Source],
    message     = [Message],
    [user]      = [User],
    statusCode  = [StatusCode], 
    time        = CONVERT(VARCHAR(50), [TimeUtc], 126) + ''Z''
FROM 
    [ELMAH_Error] error
WHERE
    [Application] = @Application
AND
    [TimeUtc] <= @FirstTimeUTC
AND 
    [Sequence] <= @FirstSequence
ORDER BY
    [TimeUtc] DESC, 
    [Sequence] DESC
FOR
    XML AUTO
 
' 
END
GO
SET ANSI_NULLS ON
SET QUOTED_IDENTIFIER ON
IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[ELMAH_GetErrorXml]') AND type in (N'P', N'PC'))
BEGIN
EXEC dbo.sp_executesql @statement = N'
CREATE PROCEDURE [dbo].[ELMAH_GetErrorXml]
(
@Application NVARCHAR(60),
@ErrorId UNIQUEIDENTIFIER
)
AS
 
SET NOCOUNT ON
 
SELECT 
    [AllXml]
FROM 
    [ELMAH_Error]
WHERE
    [ErrorId] = @ErrorId
AND
    [Application] = @Application
 
' 
END
GO
SET ANSI_NULLS ON
SET QUOTED_IDENTIFIER ON
IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].    [ELMAH_LogError]') AND type in (N'P', N'PC'))
BEGIN
EXEC dbo.sp_executesql @statement = N'
CREATE PROCEDURE [dbo].[ELMAH_LogError]
(
@ErrorId UNIQUEIDENTIFIER,
@Application NVARCHAR(60),
@Host NVARCHAR(30),
@Type NVARCHAR(100),
@Source NVARCHAR(60),
@Message NVARCHAR(500),
@User NVARCHAR(50),
@AllXml NVARCHAR(MAX),
@StatusCode INT,
@TimeUtc DATETIME
)
AS
 
SET NOCOUNT ON
 
INSERT
INTO
    [ELMAH_Error]
    (
        [ErrorId],
        [Application],
        [Host],
        [Type],
        [Source],
        [Message],
        [User],
        [AllXml],
        [StatusCode],
        [TimeUtc]
    )
VALUES
    (
        @ErrorId,
        @Application,
        @Host,
        @Type,
        @Source,
        @Message,
        @User,
        @AllXml,
        @StatusCode,
        @TimeUtc
    )
 
' 
END
GO

如果要增加 Dashboard 搜尋的速度，建議增加 ELMAH.Error 幾個欄位的索引

CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_Application] ON [dbo].[ELMAH_Error] ([Application] ASC)
GO
CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_Host] ON [dbo].[ELMAH_Error] ([Host] ASC)
GO
CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_Type] ON [dbo].[ELMAH_Error] ([Type] ASC)
GO
CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_Source] ON [dbo].[ELMAH_Error] ([Source] ASC)
GO
CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_User] ON [dbo].[ELMAH_Error] ([User] ASC)
GO
CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_TimeUtc] ON [dbo].[ELMAH_Error] ([TimeUtc] ASC)
GO
CREATE NONCLUSTERED INDEX [IX_ELMAH_Error_Sequence] ON [dbo].[ELMAH_Error] ([Sequence] ASC)
GO

Step.3

再來就是修改 Web.Config 裡面的 Elmah 設定，讓 Elmah 的記錄能夠儲存到 LocalDB 裡，

<connectionStrings>
    <;add name="Elmah.Sql"
         connectionString="Data Source=(LocalDB)\MSSQLLocalDB;AttachDbFileName=|DataDirectory|\Sample.mdf;Integrated Security=True"
         providerName="System.Data.SqlClient" />;
</connectionStrings>