📝 Ngày 28: Sitecore Logs & Diagnostics

Debug trong Sitecore gần như 100% dựa vào logs.
Nếu bạn hiểu cách hoạt động log và các công cụ diagnostics, bạn sẽ xử lý lỗi nhanh hơn rất nhiều.

🔍 1. Các loại Log trong Sitecore

Sitecore sinh ra nhiều loại log khác nhau nằm trong:

✔ 1.1 Sitecore Log (quan trọng nhất)

Tên file dạng:

Chứa:

• Runtime errors

• Rendering errors

• Database error

• Pipeline lỗi

• Crawler/Indexing warnings

• Performance warnings

✔ 1.2 Crawling / Index Logs

Dùng khi debug:

• Không index item

• Search trả sai kết quả

✔ 1.3 Publishing Logs

Dùng để kiểm tra:

• Publish failed

• Publish không chạy

• Publish performance issues

✔ 1.4 Diagnostic Logs (Azure setup)

Trong môi trường Azure:

✔ 1.5 xConnect Logs

Nếu dùng XP hoặc Marketing Automation:

• xconnect-search.txt

• xconnect-collection.txt

• xconnect-tracking.txt

Debug:

• Analytics

• Contact/Interaction tracking

📌 2. Cách đọc Log hiệu quả

💡 Tìm các từ khóa sau:

• ERROR

• FATAL

• EXCEPTION

• WARN

• InnerException

• Stack Trace

Ví dụ stack trace:

⚡ 3. Tăng mức độ log (Debug Mode)

Mặc định Sitecore log ở mức INFO.

Bạn có thể bật DEBUG mode để ghi log chi tiết hơn:

Mở file:

Tìm:

Đổi thành:

⚠ Chỉ bật debug trong môi trường DEV, không bật ở PROD vì:

• Log quá nặng

• Ảnh hưởng performance

🧪 4. Log trong code C# (rất thường dùng)

Sử dụng Sitecore.Diagnostics:

Ghi log có context:

Ghi log lỗi:

🛠 5. /sitecore/admin trang hỗ trợ Diagnostics

Sitecore có nhiều trang admin giúp debug nhanh:

🧰 5.1 /sitecore/admin/showconfig.aspx

Xem toàn bộ cấu hình sau khi merge file config + patch.

🧰 5.2 /sitecore/admin/stats.aspx

Xem:

• CPU usage

• Memory usage

• Cache usage

🧰 5.3 /sitecore/admin/cache.aspx

Xem và xóa cache:

• Data Cache

• Item Cache

• HTML Cache

• Media Cache

🧰 5.4 /sitecore/admin/index.aspx

Quản lý index (Solr)

🧰 5.5 /sitecore/admin/serialization.aspx

Kiểm tra serialization

🧰 5.6 /sitecore/admin/ShowServicesConfig.aspx

Debug các dịch vụ

🧩 6. Debug theo Rendering

Muốn debug component nào, bạn nên:

1. Bật trình tự pipeline rendering

2. Log tại Controller / View Rendering

Ví dụ:

🚨 7. Common Errors trong log & cách xử lý

❌ NullReferenceException

→ Thiếu datasource, thiếu item, sai field name.

❌ SqlException

→ DB connection lỗi, query timeout.

❌ Could not find layout

→ Sai đường dẫn layout hoặc thiếu file view.

❌ The model item passed into the dictionary is of type…

→ Model binding MVC sai type.

❌ Media request error

→ File media bị hỏng hoặc không publish.

🧾 8. Log Viewer Tool (rất quan trọng)

Sitecore có desktop Log Viewer:

Hoặc bạn có thể dùng:

✔ Sitecore Log Analyzer

https://github.com/Sitecore/Sitecore-Log-Analyzer

Tính năng:

• Highlight lỗi

• Group theo loại exception

• Filter theo thời gian

• Tìm stack trace

🎯 Bài tập ngày 28

✔ Bài 1

Tìm log mới nhất trong folder:

✔ Bài 2

Tạo lỗi NullReference trong controller và xem log xuất hiện thế nào.

✔ Bài 3

Bật DEBUG LogLevel trong dev → kiểm tra log chi tiết.

✔ Bài 4

Dùng Log Analyzer để đọc log 1 ngày.