Skip to content

Commit 3b31a19

Browse files
committed
docs: add logs documentation for SQLite Cloud platform
Add comprehensive documentation for the Logs feature, including log monitoring, filtering options, and detailed viewing capabilities.
1 parent 11a75aa commit 3b31a19

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed

sqlite-cloud/platform/logs.mdx

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: Logs
3+
description: View detailed insights into your SQLite Cloud project's operations to monitor activity, debug issues, and track system behavior in real time.
4+
category: platform
5+
status: publish
6+
slug: logs
7+
---
8+
import VideoPlayer from '@commons-components/Video/VideoPlayer.astro';
9+
import logsVideo from '@docs-website-assets/introduction/video/dashboard_logs.mp4';
10+
11+
12+
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.
13+
14+
<VideoPlayer src={logsVideo} />
15+
16+
---
17+
18+
## Key Features
19+
20+
- **Log Monitoring**: View recent log entries with manual refresh capability to get the latest activity
21+
- **Filtering Options**: Filter logs by time range, specific nodes, and search through messages
22+
- **Detailed Context**: Each log entry includes timestamp, severity level, source, and detailed message information
23+
24+
---
25+
26+
## Accessing Logs
27+
28+
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:
29+
30+
- **Time**: Timestamp when the event occurred (in UTC)
31+
- **Level**: Severity level of the log entry (e.g., ERROR, INFO, WARNING)
32+
- **Source**: Component or service that generated the log
33+
- **Log Type**: Category of the log entry (e.g., CLIENT, SYSTEM)
34+
- **Message**: Detailed description of the logged event
35+
36+
---
37+
38+
## Filtering Logs
39+
40+
### Timestamp Range
41+
42+
Use the timestamp range selector to filter logs by time period. Available options include:
43+
44+
- Last 30 minutes
45+
- Last hour
46+
- Last 12 hours
47+
- Last day
48+
- Last 3 days
49+
- Last week
50+
- Last 2 weeks
51+
- Last 30 days
52+
- Custom date range (using the calendar picker)
53+
54+
### Node Filtering
55+
56+
Filter logs by specific cluster nodes using the **Nodes** section on the left sidebar. You can:
57+
58+
- Search for specific nodes using the search box
59+
- Select individual nodes to view their logs
60+
- View the node location (e.g., US East)
61+
62+
### Search Logs
63+
64+
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.
65+
66+
---
67+
68+
## Viewing Log Details
69+
70+
Click on any log entry to view detailed information in the **Log Details** panel. This panel displays:
71+
72+
- **Timestamp**: Exact time of the event
73+
- **Level**: Severity level
74+
- **Source**: Originating component
75+
- **Node ID**: Specific node that generated the log
76+
- **Log Type**: Category of the event
77+
- **Message**: Full message with complete error details or event information
78+
79+
### Actions
80+
81+
- **Close**: Close the details panel
82+
- **Copy JSON**: Copy the complete log entry in JSON format for further analysis or sharing
83+
84+
---
85+
86+
## Refreshing Logs
87+
88+
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.
89+
90+
---
91+
92+
## Common Use Cases
93+
94+
### Debugging Errors
95+
96+
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.
97+
98+
### Monitoring Activity
99+
100+
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.
101+
102+
### Performance Analysis
103+
104+
Review logs during specific time periods to correlate events with performance issues or unexpected behavior in your application.

0 commit comments

Comments
 (0)