Skip to content

Commit 0345195

Browse files
committed
chore(docs): update logs documentation and navigation
1 parent 3b31a19 commit 0345195

File tree

2 files changed

+5
-24
lines changed

2 files changed

+5
-24
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: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import logsVideo from '@docs-website-assets/introduction/video/dashboard_logs.mp
1111

1212
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.
1313

14-
<VideoPlayer src={logsVideo} />
1514

1615
---
1716

@@ -21,16 +20,18 @@ Logs provide detailed insights into your SQLite Cloud project's operations, help
2120
- **Filtering Options**: Filter logs by time range, specific nodes, and search through messages
2221
- **Detailed Context**: Each log entry includes timestamp, severity level, source, and detailed message information
2322

23+
<VideoPlayer src={logsVideo} />
24+
2425
---
2526

2627
## Accessing Logs
2728

2829
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:
2930

3031
- **Time**: Timestamp when the event occurred (in UTC)
31-
- **Level**: Severity level of the log entry (e.g., ERROR, INFO, WARNING)
32+
- **Level**: Severity level of the log entry
3233
- **Source**: Component or service that generated the log
33-
- **Log Type**: Category of the log entry (e.g., CLIENT, SYSTEM)
34+
- **Log Type**: Category of the log entry
3435
- **Message**: Detailed description of the logged event
3536

3637
---
@@ -76,29 +77,8 @@ Click on any log entry to view detailed information in the **Log Details** panel
7677
- **Log Type**: Category of the event
7778
- **Message**: Full message with complete error details or event information
7879

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-
8480
---
8581

8682
## Refreshing Logs
8783

8884
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)