// Serverpod logging — session.log, log levels, persistence, retention, console output. Use when adding logging or debugging server calls.
| name | serverpod-logging |
| description | Serverpod logging — session.log, log levels, persistence, retention, console output. Use when adding logging or debugging server calls. |
Use session.log() during a request. Logs flush when the session closes. Stored in DB and/or printed to console.
session.log('Operation completed');
session.log('Something went wrong',
level: LogLevel.warning,
exception: e,
stackTrace: stackTrace);
Uncaught endpoint exceptions are logged as session failures in serverpod_session_log.
serverpod MCP server.serverpod_log, serverpod_query_log, serverpod_session_log (when persistent enabled)text or json)Defaults: with database configured (PostgreSQL only), persistent on + console off; without database, persistent off + console on.
Under sessionLogs: in config YAML or env vars:
| Setting | Env var | Default |
|---|---|---|
| persistentEnabled | SERVERPOD_SESSION_PERSISTENT_LOG_ENABLED | true (with DB) |
| consoleEnabled | SERVERPOD_SESSION_CONSOLE_LOG_ENABLED | false (with DB) |
| consoleLogFormat | SERVERPOD_SESSION_CONSOLE_LOG_FORMAT | text |
| cleanupInterval | SERVERPOD_SESSION_LOG_CLEANUP_INTERVAL | 24h |
| retentionPeriod | SERVERPOD_SESSION_LOG_RETENTION_PERIOD | 90d |
| retentionCount | SERVERPOD_SESSION_LOG_RETENTION_COUNT | 100000 |
Set retention so log tables don't grow unbounded. Avoid logging sensitive data.
Companion app for viewing, searching, and filtering logs and inspecting failed/slow calls. Automatically available when using Serverpod Cloud.
Serverpod web server (Relic) — REST APIs, webhooks, middleware, static files, server-rendered HTML, SPAs, Flutter web. Use when adding HTTP routes, serving web pages or web apps, intercepting requests, or working with the Relic web server.
Serverpod overview — what it is, project structure, how to work with. Always use at least once when working with projects that use Serverpod.
Serverpod Authentication — Signing in users, verify if they are authenticated, assinging scopes (e.g., admin). Use when adding features that require the user to be signed in.
Serverpod ORM with PostgreSQL or SQLite — CRUD, filters, sorting, pagination, relations, transactions, raw SQL, client-side database. Use when querying the database or working with relations.
Serverpod database migrations — when and how to create/apply/repair migrations. Use whenever database schema changes are involved.
Real-time streaming in Serverpod — Stream parameters and return types, WebSocket lifecycle, error handling. Use when building real-time features, chat, live updates, or WebSocket streaming.