Merge pull request #17 from severalnines/CCX-5079

CCX-5079: add db logs docs
severalnines · Dec 10, 2024 · 3c04ee6 · 3c04ee6
2 parents 91be8f5 + f47a8f0
commit 3c04ee6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/user/Howto/Logs-Viewer.md b/docs/user/Howto/Logs-Viewer.md
@@ -0,0 +1,18 @@
+# Logs Viewer
+
+The Logs Viewer provides a comprehensive view of Database logs. The generated logs can be accessed for troubleshooting. 
+It provides real-time access to essential logs, such as error logs, slow query logs though UI.
+
+## Logs Viewer Columns
+
+- **Name**: The file path or identifier of the log file.
+- **When**: The timestamp indicating the most recent update or entry in the log file.
+- **Actions**: Options to view, download the log file for further analysis.
+
+## Example Logs
+
+![Logs viewer](../images/logs.png)
+
+---
+
+The Logs Viewer is a critical tool for system administrators, enabling real-time monitoring and investigation of log files. With clear timestamps and actionable options, it ensures efficient identification and resolution of issues to maintain the stability of datastore operations.
diff --git a/docs/user/images/logs.png b/docs/user/images/logs.png