Plane DocsSign in

View container logs ​

If you need to check the logs for troubleshooting or to monitor what’s happening in specific Plane services like the API or Worker, you can access them directly from the command line.

To view logs, start by running the command ↓:

bash
sudo prime-cli monitor

This brings up a table of Plane's containers. Move between them with the arrow keys; the selected container's logs stream in the pane below the table.

text
▲ Previous Service | Next Service ▼ | Scroll Logs: ◄ ► | Quit: q

  ID            Name                 Status   Image
  9d40226a0c04  plane-proxy-1        running  registry.plane.tools/plane/caddy:latest
  0aa67c8a0738  plane-space-1        running  registry.plane.tools/plane/space-enterprise
  634df09ba980  plane-live-1         running  registry.plane.tools/plane/live-enterprise
  faca09be6ee2  plane-admin-1        running  registry.plane.tools/plane/admin-enterprise
  1068bfe930c8  plane-web-1          running  registry.plane.tools/plane/web-enterprise
  214f3c4eb760  plane-worker-1       running  registry.plane.tools/plane/backend-enterprise
  0e12526dee37  plane-beat-worker-1  running  registry.plane.tools/plane/backend-enterprise
  945fd2f1b0ae  plane-migrator-1     exited   registry.plane.tools/plane/backend-enterprise
> d6359663f5a8  plane-api-1          running  registry.plane.tools/plane/backend-enterprise
  bfa5bebe1be3  plane-plane-minio-1  running  registry.plane.tools/plane/minio:latest
  6648b4bfccb6  plane-plane-db-1     running  registry.plane.tools/plane/postgres:15.5-alpine
  27143368a397  plane-plane-mq-1     running  registry.plane.tools/plane/rabbitmq:3.13.6-management-alpine
  ba3f010db021  plane-plane-redis-1  running  registry.plane.tools/plane/valkey:7.2.5-alpine
  ed284a410f81  plane-monitor-1      running  registry.plane.tools/plane/monitor-enterprise

"GET / HTTP/1.1" 200
"GET / HTTP/1.1" 200
"GET / HTTP/1.1" 200

WARNING

Prime CLI is for Docker installations only. These commands only work on Plane instances originally installed using prime-cli.

Community Edition

Here’s how to view logs for any service in Plane Community Edition, whether it’s the API, Worker, Redis, or others. This can be really helpful when troubleshooting or just getting insights into how each service is running.

  1. Start by running the setup script:

    bash
    ./setup.sh

    This will bring up the main menu with options. Select 6 to view logs.

    Select a Action you want to perform:
   1) Install (x86_64)
   2) Start
   3) Stop
   4) Restart
   5) Upgrade
   6) View Logs
   7) Backup Data
   8) Exit

Action [2]: 6

  2. After choosing 6, you’ll see a sub-menu listing all available services:

    Select a Service you want to view the logs for:
   1) Web
   2) Space
   3) API
   4) Worker
   5) Beat-Worker
   6) Migrator
   7) Proxy
   8) Redis
   9) Postgres
   10) Minio
   0) Back to Main Menu

Service:

  3. Pick the service whose logs you’d like to check. For example, if you want to view the API logs, type 3.

    After selecting a service, you’ll see the logs in real-time. Here’s an example of what API logs might look like:

    api-1  | Waiting for database...
api-1  | Database available!
api-1  | Waiting for database migrations to complete...
api-1  | Waiting for database migrations to complete...
api-1  | Waiting for database migrations to complete...
api-1  | Waiting for database migrations to complete...
api-1  | Waiting for database migrations to complete...
api-1  | Waiting for database migrations to complete...
api-1  | Waiting for database migrations to complete...
api-1  | No migrations Pending. Starting processes ...
api-1  | Instance registered
api-1  | ENABLE_SIGNUP loaded with value from environment variable.
api-1  | ENABLE_EMAIL_PASSWORD loaded with value from environment variable.
api-1  | ENABLE_MAGIC_LINK_LOGIN loaded with value from environment variable.
api-1  | GOOGLE_CLIENT_ID loaded with value from environment variable.
api-1  | GITHUB_CLIENT_ID loaded with value from environment variable.
api-1  | GITHUB_CLIENT_SECRET loaded with value from environment variable.
api-1  | EMAIL_HOST loaded with value from environment variable.
api-1  | EMAIL_HOST_USER loaded with value from environment variable.
api-1  | EMAIL_HOST_PASSWORD loaded with value from environment variable.
api-1  | EMAIL_PORT loaded with value from environment variable.
api-1  | EMAIL_FROM loaded with value from environment variable.
api-1  | EMAIL_USE_TLS loaded with value from environment variable.
api-1  | EMAIL_USE_SSL loaded with value from environment variable.
api-1  | OPENAI_API_KEY loaded with value from environment variable.
api-1  | GPT_ENGINE loaded with value from environment variable.
api-1  | UNSPLASH_ACCESS_KEY loaded with value from environment variable.
api-1  | Checking bucket...
api-1  | Bucket 'uploads' does not exist. Creating bucket...
api-1  | Bucket 'uploads' created successfully.
api-1  | Public read access policy set for bucket 'uploads'.
api-1  | Cache Cleared
api-1  | [2024-05-02 03:56:01 +0000] [1] [INFO] Starting gunicorn 21.2.0
api-1  | [2024-05-02 03:56:01 +0000] [1] [INFO] Listening at: http://0.0.0.0:8000 (1)
api-1  | [2024-05-02 03:56:01 +0000] [1] [INFO] Using worker: uvicorn.workers.UvicornWorker
api-1  | [2024-05-02 03:56:01 +0000] [25] [INFO] Booting worker with pid: 25
api-1  | [2024-05-02 03:56:03 +0000] [25] [INFO] Started server process [25]
api-1  | [2024-05-02 03:56:03 +0000] [25] [INFO] Waiting for application startup.
api-1  | [2024-05-02 03:56:03 +0000] [25] [INFO] ASGI 'lifespan' protocol appears unsupported.
api-1  | [2024-05-02 03:56:03 +0000] [25] [INFO] Application startup complete.

  4. To exit the logs, use CTRL+C. This will take you back to the main menu where you can select another action or view logs from a different service.