באופן עקרוני, תיעוד אמור להיות מבוצע על ידי כלי, אתה לא אמור להמציא את הגלגל מחדש (ראה לקמן)
תיעוד בשכבת ה-SQL
יש ל-SQLServer יש אפשרות מובנית לתיעוד על ידי שימוש במעקב שינויים
ראה כאן מדריך בנושא: https://www.sqlshack.com/creating-a-sql-server-audit-using-sql-server-change-tracking/
היתרון באפשרות הזו הוא: שהכל מתחיל ונגמר ב-SQL, ללא צורך בכלים נוספים
החיסרון בגישה הזו הוא: שהכל מתחיל ונגמר ב-SQL... קשה מאוד לתשאל את הנתונים במקרה שרוצים לחקור אירוע, התיעוד מבוצע לתוך הDB, ולא לתוך קבצי טקסט חיצוניים, ושיטה זו עלולה בקלות להוסיף המון רעשי רקע לפעילות השוטפת של ה-DB
תיעוד בשכבת DAL
אם יש לך שכבת DataAccess, למשל API שמבצע את השליפה של הנתונים.
בדוטנט מומלץ להשתמש בכלי תיעוד כגון Serilog
שיטה זו היא העדיפה ביותר: אפשר לבנות לוגים מבניים Structured logs שניתנים לתחקור בקלות על ידי כלי אנליטיקה של לוגים, כמו SEQ
אפשר לתעד לקבצי json יומיים, לשלוט על כמות המידע שנצבר ולהגדיר מתי למחוק לוגים ישנים, ל-Serilog יש אפשרות לנקז את הלוגים שלו לכמה אפיקים במקביל. למשל: תוכל לשלוח בו זמנית את הלוגים שלך לקבצים בדיסק, לקונסול, וגם לשרת לוגים כמו SEQ או QRadar שנותנים לך המון אפשרויות להצגה נוחה של הפעילות, ניתוח ושאילתות פילוח (מי המשתמשים שנכנסו הכי הרבה בחודש האחרון, מה הזמן הממוצע שמשתמש מחובר למערכת וכו')
החיסרון? לא תמיד יש שכבת DAL מסודרת. אבל אם זה המקרה, אז יש כאן בעיה הרבה יותר גדולה מבעיית חוסר התיעוד.
להמציא את הגלגל
זה בפירוש לא מומלץ לכל מקרה, ואני בספק אם יש לזה מקום מעשי בכלל, אבל במקרה הנדיר שכן, אתה יכול לבנות כלי מהיר ומלוכלך לתיעוד ב-SQL:
SQL Server 2016 ומעלה:
CREATE PROCEDURE [dbo].[fn_GetJsonData]
-- =================================================
-- Description: Get JSON data from a table row
-- =================================================
@TableName NVARCHAR(max),
@Id INT,
@Columns NVARCHAR(max) = '*',
@JsonData NVARCHAR(max) OUTPUT
AS
BEGIN
SET NOCOUNT ON;
DECLARE @Sql NVARCHAR(max) = 'SELECT @JsonData=(SELECT TOP 1 ' + @Columns + ' FROM ' + @TableName + ' WHERE Id=' + CAST(@Id AS VARCHAR) + ' FOR JSON AUTO, WITHOUT_ARRAY_WRAPPER)'
EXEC sp_executesql @Sql,
N'@JsonData NVARCHAR(max) OUTPUT',
@JsonData OUTPUT
END
GO
טבלת תיעוד פשוטה:
CREATE TABLE MySimpleAudit (
Id INT identity(1, 1) PRIMARY KEY,
TableName NVARCHAR(max),
OriginalData NVARCHAR(max),
NewData NVARCHAR(max),
LogTimeStamp DATETIME2 DEFAULT getutcdate()
)
כדי לתעד, אתה צריך לקרוא לפרוצדורה הנ"ל לפני השינוי ואחריו, ולתעד את השינויים לטבלה:
-- Init variables:
DECLARE @OriginalData NVARCHAR(max), @NewData NVARCHAR(max);
-- Get original data:
EXEC [dbo].[fn_GetJsonData] @TableName = 'Payments',
@Id = 1234,
@Columns = 'Id,Amount',
@JsonData = @OriginalData OUTPUT
-- Do manipulations on the table:
-- ...........
---
-- Get Changes:
EXEC [dbo].[fn_GetJsonData] @TableName = 'Payments',
@Id = 1234,
@Columns = 'Id,Amount',
@JsonData = @NewData OUTPUT
INSERT INTO [MySimpleAudit] (TableName, OriginalData, NewData)
VALUES ('Payments', @OriginalData, @NewData)