Skip to content

Commit 3e42802

Browse files
authored
Merge pull request #139 from sqlitecloud/stage
docs: add logs documentation for SQLite Cloud platform
2 parents 8ebc072 + 0345195 commit 3e42802

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

sqlite-cloud/_nav.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,7 @@ const sidebarNav: SidebarNavStruct = [
299299
},
300300
{ title: "Backups", filePath: "backups", type: "inner", level: 0 },
301301
{ title: "Query Analyzer", filePath: "analyzer", type: "inner", level: 0 },
302+
{ title: "Logs", filePath: "logs", type: "inner", level: 0 },
302303
{ title: "Extensions", filePath: "extensions", type: "inner", level: 0 },
303304
{ title: "Weblite (REST API)", filePath: "weblite", type: "inner", level: 0 },
304305

sqlite-cloud/platform/logs.mdx

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
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+
15+
---
16+
17+
## Key Features
18+
19+
- **Log Monitoring**: View recent log entries with manual refresh capability to get the latest activity
20+
- **Filtering Options**: Filter logs by time range, specific nodes, and search through messages
21+
- **Detailed Context**: Each log entry includes timestamp, severity level, source, and detailed message information
22+
23+
<VideoPlayer src={logsVideo} />
24+
25+
---
26+
27+
## Accessing Logs
28+
29+
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:
30+
31+
- **Time**: Timestamp when the event occurred (in UTC)
32+
- **Level**: Severity level of the log entry
33+
- **Source**: Component or service that generated the log
34+
- **Log Type**: Category of the log entry
35+
- **Message**: Detailed description of the logged event
36+
37+
---
38+
39+
## Filtering Logs
40+
41+
### Timestamp Range
42+
43+
Use the timestamp range selector to filter logs by time period. Available options include:
44+
45+
- Last 30 minutes
46+
- Last hour
47+
- Last 12 hours
48+
- Last day
49+
- Last 3 days
50+
- Last week
51+
- Last 2 weeks
52+
- Last 30 days
53+
- Custom date range (using the calendar picker)
54+
55+
### Node Filtering
56+
57+
Filter logs by specific cluster nodes using the **Nodes** section on the left sidebar. You can:
58+
59+
- Search for specific nodes using the search box
60+
- Select individual nodes to view their logs
61+
- View the node location (e.g., US East)
62+
63+
### Search Logs
64+
65+
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.
66+
67+
---
68+
69+
## Viewing Log Details
70+
71+
Click on any log entry to view detailed information in the **Log Details** panel. This panel displays:
72+
73+
- **Timestamp**: Exact time of the event
74+
- **Level**: Severity level
75+
- **Source**: Originating component
76+
- **Node ID**: Specific node that generated the log
77+
- **Log Type**: Category of the event
78+
- **Message**: Full message with complete error details or event information
79+
80+
---
81+
82+
## Refreshing Logs
83+
84+
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.

0 commit comments

Comments
 (0)