Differences

This shows you the differences between two versions of the page.

--- software:squirrel:log_viewer [2025/03/14 20:45] – support@smikar.com
+++ software:squirrel:log_viewer [2025/03/26 13:18] (current) – support@smikar.com
@@ Line 1: / Line 1: @@
-=====Squirrel Log Viewer=====
+===== 📄 Squirrel Log Viewer =====
-**Overview**
+==== 🔍 Overview ====
-The Log Viewer in Squirrel is a powerful tool designed for real-time monitoring and diagnostics. It allows administrators and users to keep track of critical events such as logins, restore checks, archive requests, and system operations. This feature is essential for maintaining the integrity of the Squirrel system, ensuring smooth operations, and identifying potential issues promptly. The intuitive interface makes it easy to filter, search, and export logs for in-depth analysis and auditing.
+The **Log Viewer** in [[https://www.smikar.com/squirrel/|Squirrel]] is a powerful diagnostic and auditing tool designed for real-time visibility into system operations. It enables both administrators and support staff to monitor key activities such as:
-The log entries provide detailed information about each event, including the timestamp, event type, and a description of the action taken. This helps users trace the history of specific files, monitor user activity, and troubleshoot any errors or unexpected behaviors in the system.
+- Login attempts
+- Archive and restore actions
+- System-level processes
+- Errors and warnings
+By providing deep insights into event history, the Log Viewer plays a crucial role in maintaining the integrity and reliability of the Squirrel platform.
 {{:software:squirrel:squirrel_log_viewer.png?400}}
-**Key Features**
+----
+==== 🧰 Key Features ====
+The Log Viewer interface is intuitive and built for both speed and precision. It includes several tools to help you find, filter, and export log data with ease:
+- **🔎 Search Logs**
+  Use the keyword-based **Search Bar** to quickly find entries by username, file GUID, or action type (e.g., "archive", "restore").
+- **📂 Event Type Filtering**
+  Narrow results using the **Event Filter Dropdown**, allowing you to focus on specific categories such as:
+  - `Info` – General operations and status messages
+  - `Warnings` – Potential issues that may require attention
+  - `Errors` – Critical failures or unsuccessful operations
+- **📅 Date Picker**
+  Select a specific day to view log entries from that date — useful for auditing and time-based troubleshooting.
+- **↔️ Pagination Controls**
+  Easily navigate through large sets of log data using **Previous/Next** buttons at the bottom of the table.
+- **📥 Export to CSV**
+  Export the current log view to a `.csv` file for external analysis, audit reporting, or record keeping.
+- **🔄 Refresh Logs**
+  Click **Refresh Logs** at any time to load the most recent entries and ensure you're viewing up-to-date activity.
+----
+==== 📋 Log Table Structure ====
-The Log Viewer Interface is designed for simplicity and efficiency, providing multiple tools for exploring and managing logs. At the top of the interface, you will find the Search Bar, which allows you to filter logs by keywords. This is especially useful when searching for a specific file GUID or user activity. Next to the search bar, the Event Filter Dropdown enables you to narrow down logs by event type, such as Info, Warnings or Error events, allowing you to focus on specific operations.
+The log entries are displayed in a clean, tabular format with the following columns:
-For more precise log exploration, you can use the Date Picker to select logs from a particular date. Once the desired logs are displayed, you can download the data by clicking Export to CSV. This exports the current log view, which is useful for generating reports or conducting external analysis.
+- **🕒 Timestamp**
+  The exact date and time the event occurred. Crucial for tracking activity sequences or investigating incidents.
-The log entries themselves are presented in a tabular format, with a Refresh Logs button available to update the table with the latest data. The Pagination Controls at the bottom make it easy to navigate through large volumes of logs, with each page displaying a manageable subset of entries.
+- **📌 Event Type**
+  Categorizes the event as Info, Warning, or Error. These tags help prioritize what needs attention.
-  * Search Logs: Quickly find relevant logs using keywords. Search for username or action (like archive or restore).
+- **📝 Details**
-  * Event Filtering: Filter logs by event type to focus on specific actions (e.g., Info, Warnings and Errors).
+  A descriptive summary of the action taken. Depending on the event, this may include:
-  * Date Picker: Select a specific date to view logs from that day.
+  - File GUID or Site GUID
-  * Pagination: Easily navigate through pages of logs.
+  - Action performed (archive, restore, login)
-  * Export to CSV: Download the logs as a CSV file for external analysis or reporting.
+  - User involved
+  - Status or outcome
+Each entry tells a clear story of what occurred, when, and who initiated it.
-**Log Table:**
+----
-The Log Table serves as the core element of the Log Viewer, displaying a structured view of all log entries. Each entry is composed of three primary fields: Timestamp, Event Type, and Details.
+==== 💼 Use Cases ====
-  * Timestamp: Indicates the exact date and time when the event occurred. This is essential for tracking when actions were performed and correlating events across different parts of the system.
+Here are some common scenarios where the Log Viewer proves invaluable:
-  * Event Type: This field specifies the category of the event, such as [info] for informational messages, [error] for error reports, and other levels of severity. This classification allows users to quickly distinguish between routine events and critical issues.
-  * Details: This column contains a detailed description of the logged event. Depending on the type of event, it may include information such as the username, file GUID, site GUID, and the action performed. For example, a restore entry will show that a specific file was restored, along with the user who initiated the check.
-  * Pagination Controls: Navigate between multiple pages of logs using the Previous and Next buttons.
-  * Refresh Logs: Click Refresh Logs to load the latest entries.
+- **Troubleshooting Errors:** Filter for `Error` logs to identify failed archive or restore attempts.
+- **Auditing User Activity:** Track who restored or archived what — and when.
+- **File History Tracing:** Follow the timeline of a specific file by searching its GUID.
+- **System Monitoring:** Watch for signs of unusual system activity or high volume actions.
+----
+If you need help interpreting logs or exporting them for analysis, please contact [support@smikar.com](mailto:support@smikar.com).