From 3b31a19fb8c1edf74c36c0a18fda855e8acb02a9 Mon Sep 17 00:00:00 2001 From: TizianoT Date: Tue, 2 Dec 2025 14:29:55 +0100 Subject: [PATCH 1/2] docs: add logs documentation for SQLite Cloud platform Add comprehensive documentation for the Logs feature, including log monitoring, filtering options, and detailed viewing capabilities. --- sqlite-cloud/platform/logs.mdx | 104 +++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 sqlite-cloud/platform/logs.mdx diff --git a/sqlite-cloud/platform/logs.mdx b/sqlite-cloud/platform/logs.mdx new file mode 100644 index 0000000..2240e67 --- /dev/null +++ b/sqlite-cloud/platform/logs.mdx @@ -0,0 +1,104 @@ +--- +title: Logs +description: View detailed insights into your SQLite Cloud project's operations to monitor activity, debug issues, and track system behavior in real time. +category: platform +status: publish +slug: logs +--- +import VideoPlayer from '@commons-components/Video/VideoPlayer.astro'; +import logsVideo from '@docs-website-assets/introduction/video/dashboard_logs.mp4'; + + +Logs provide detailed insights into your SQLite Cloud project's operations, helping you monitor activity, debug issues, and track system behavior in real time. The Logs panel displays a comprehensive view of all events occurring across your cluster nodes. + + + +--- + +## Key Features + +- **Log Monitoring**: View recent log entries with manual refresh capability to get the latest activity +- **Filtering Options**: Filter logs by time range, specific nodes, and search through messages +- **Detailed Context**: Each log entry includes timestamp, severity level, source, and detailed message information + +--- + +## Accessing Logs + +Navigate to the **Logs** section from your SQLite Cloud dashboard to view your project's log entries. The interface displays logs in a table format with the following columns: + +- **Time**: Timestamp when the event occurred (in UTC) +- **Level**: Severity level of the log entry (e.g., ERROR, INFO, WARNING) +- **Source**: Component or service that generated the log +- **Log Type**: Category of the log entry (e.g., CLIENT, SYSTEM) +- **Message**: Detailed description of the logged event + +--- + +## Filtering Logs + +### Timestamp Range + +Use the timestamp range selector to filter logs by time period. Available options include: + +- Last 30 minutes +- Last hour +- Last 12 hours +- Last day +- Last 3 days +- Last week +- Last 2 weeks +- Last 30 days +- Custom date range (using the calendar picker) + +### Node Filtering + +Filter logs by specific cluster nodes using the **Nodes** section on the left sidebar. You can: + +- Search for specific nodes using the search box +- Select individual nodes to view their logs +- View the node location (e.g., US East) + +### Search Logs + +Use the search box at the top of the logs table to filter entries by message content. This helps you quickly locate specific errors or events. + +--- + +## Viewing Log Details + +Click on any log entry to view detailed information in the **Log Details** panel. This panel displays: + +- **Timestamp**: Exact time of the event +- **Level**: Severity level +- **Source**: Originating component +- **Node ID**: Specific node that generated the log +- **Log Type**: Category of the event +- **Message**: Full message with complete error details or event information + +### Actions + +- **Close**: Close the details panel +- **Copy JSON**: Copy the complete log entry in JSON format for further analysis or sharing + +--- + +## Refreshing Logs + +Click the **Refresh** button in the top-right corner to manually update the log list and view the most recent entries. This ensures you're viewing the latest activity from your cluster. + +--- + +## Common Use Cases + +### Debugging Errors + +When troubleshooting issues, filter logs by ERROR level and the relevant time period to quickly identify problems. For example, database constraint violations, connection issues, or query errors will appear in the logs with detailed error messages. + +### Monitoring Activity + +Track client connections, query executions, and system events by reviewing logs across different log types and sources. This helps you understand usage patterns and system behavior. + +### Performance Analysis + +Review logs during specific time periods to correlate events with performance issues or unexpected behavior in your application. From 03451956072964f026a3f542ab7aed15c28ded66 Mon Sep 17 00:00:00 2001 From: TizianoT Date: Tue, 2 Dec 2025 15:34:18 +0100 Subject: [PATCH 2/2] chore(docs): update logs documentation and navigation --- sqlite-cloud/_nav.ts | 1 + sqlite-cloud/platform/logs.mdx | 28 ++++------------------------ 2 files changed, 5 insertions(+), 24 deletions(-) diff --git a/sqlite-cloud/_nav.ts b/sqlite-cloud/_nav.ts index 7ada738..ec1fb7b 100644 --- a/sqlite-cloud/_nav.ts +++ b/sqlite-cloud/_nav.ts @@ -299,6 +299,7 @@ const sidebarNav: SidebarNavStruct = [ }, { title: "Backups", filePath: "backups", type: "inner", level: 0 }, { title: "Query Analyzer", filePath: "analyzer", type: "inner", level: 0 }, + { title: "Logs", filePath: "logs", type: "inner", level: 0 }, { title: "Extensions", filePath: "extensions", type: "inner", level: 0 }, { title: "Weblite (REST API)", filePath: "weblite", type: "inner", level: 0 }, diff --git a/sqlite-cloud/platform/logs.mdx b/sqlite-cloud/platform/logs.mdx index 2240e67..f7a511b 100644 --- a/sqlite-cloud/platform/logs.mdx +++ b/sqlite-cloud/platform/logs.mdx @@ -11,7 +11,6 @@ import logsVideo from '@docs-website-assets/introduction/video/dashboard_logs.mp Logs provide detailed insights into your SQLite Cloud project's operations, helping you monitor activity, debug issues, and track system behavior in real time. The Logs panel displays a comprehensive view of all events occurring across your cluster nodes. - --- @@ -21,6 +20,8 @@ Logs provide detailed insights into your SQLite Cloud project's operations, help - **Filtering Options**: Filter logs by time range, specific nodes, and search through messages - **Detailed Context**: Each log entry includes timestamp, severity level, source, and detailed message information + + --- ## Accessing Logs @@ -28,9 +29,9 @@ Logs provide detailed insights into your SQLite Cloud project's operations, help Navigate to the **Logs** section from your SQLite Cloud dashboard to view your project's log entries. The interface displays logs in a table format with the following columns: - **Time**: Timestamp when the event occurred (in UTC) -- **Level**: Severity level of the log entry (e.g., ERROR, INFO, WARNING) +- **Level**: Severity level of the log entry - **Source**: Component or service that generated the log -- **Log Type**: Category of the log entry (e.g., CLIENT, SYSTEM) +- **Log Type**: Category of the log entry - **Message**: Detailed description of the logged event --- @@ -76,29 +77,8 @@ Click on any log entry to view detailed information in the **Log Details** panel - **Log Type**: Category of the event - **Message**: Full message with complete error details or event information -### Actions - -- **Close**: Close the details panel -- **Copy JSON**: Copy the complete log entry in JSON format for further analysis or sharing - --- ## Refreshing Logs Click the **Refresh** button in the top-right corner to manually update the log list and view the most recent entries. This ensures you're viewing the latest activity from your cluster. - ---- - -## Common Use Cases - -### Debugging Errors - -When troubleshooting issues, filter logs by ERROR level and the relevant time period to quickly identify problems. For example, database constraint violations, connection issues, or query errors will appear in the logs with detailed error messages. - -### Monitoring Activity - -Track client connections, query executions, and system events by reviewing logs across different log types and sources. This helps you understand usage patterns and system behavior. - -### Performance Analysis - -Review logs during specific time periods to correlate events with performance issues or unexpected behavior in your application.