How to View Logs in App Platform

Validated on 5 Apr 2023 • Last edited on 23 May 2024 logs | build and run | doctl | hash

App Platform is a Platform-as-a-Service (PaaS) offering that allows developers to publish code directly to DigitalOcean servers without worrying about the underlying infrastructure.

You can view activity, build, deployment, and runtime logs in App Platform using the control panel, CLI, and API. You can also enable log forwarding to forward application logs to external log providers.

Types of Logs

App Platform records several different types of information about your app to during each stage of its deployment. You can access and review the following logs:

Activity: Maintains a timeline of your app’s deployments, including the commit hash that triggered the build, how long the build took, and the build’s start and end times.
Deployment details: Contains overview information about a specific deployment, including build duration and the amount of time that was billed during deployment. This page also contains the deployment’s build and deploy logs.
- Build log: Records the commands and subsequent build processes used to build the app, including any errors or warnings emitted by the software building the app. These can be helpful for identifying issues with the application’s code or dependencies that may need to be addressed before the application can be deployed.
- Deploy log: Records the deployment of the app to its server, including any errors or warnings emitted from the software being used to host the app.
Runtime log: Records messages and errors emitted by the app and its components while running. These logs can be useful for troubleshooting issues with the application’s logic or functionality.
Crash log: Records the log output from the instance before it crashed and a potential reason for the crash.

View Logs Using the Automation

The CLI command and API endpoint used to retrieve an app’s logs require the app’s ID. You can retrieve a list of your apps and their IDs using the doctl apps list command or the /v2/apps endpoint.

How to view logs using the DigitalOcean CLI

To view logs via the command-line, follow these steps:

Install doctl, the DigitalOcean command-line tool.
Create a personal access token, and save it for use with doctl.
Use the token to grant doctl access to your DigitalOcean account.
```
              doctl auth init
            
```

Finally, view logs with doctl apps logs. The basic usage looks like this, but you'll want to read the usage docs for more details:

              doctl apps logs <app id> <component name (defaults to all components)> [flags]

The following example retrieves the build logs for the app with the ID f81d4fae-7dec-11d0-a765-00a0c91e6bf6 and the component web

                   doctl apps logs f81d4fae-7dec-11d0-a765-00a0c91e6bf6 web --type build

How to view logs using the DigitalOcean API

To view logs using the DigitalOcean API, follow these steps:

Create a personal access token, and save it for use with the API.

Send a GET request to https://api.digitalocean.com/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs

cURL

To view logs with cURL, call:


                curl -X GET \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
  "https://api.digitalocean.com/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs"

Python


                import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.apps.get_logs(app_id="4f6c71e2", deployment_id="3aa4d20e", component_name="component")

The live_url returned may use either the https:// or wss:// protocols and will keep pushing live logs as they become available.

View Logs Using the Control Panel

To view app resource logs, click Apps in the left menu and then click your app.

Activity Logs

To view the activity for an app, click the Activity tab. This displays your app’s timeline of deployments.

Deployment Logs

To view logs and information for a specific deployment, click the Activity tab and then click the deployment link in the headline of the deployment you want to review. From here, you can review the deployment’s Build logs and Deploy logs.

Deployment log entry screen with build and deploy logs displayed

Runtime Logs

To view runtime logs, click the Runtime Logs tab, then click a resource to view its logs. The logs show within a few minutes after the app deploys. The logs are updated in real time while the resource is running.

Crash Logs

Crash logs are available after a container crashes and restarts. You can only access crash logs using doctl, the official DigitalOcean CLI.

To access the log from before the last crash, run the following command in a terminal, replacing <your-app-ID> with your app’s ID:

doctl apps logs <your-app-ID> --type=run_restarted

To retrieve a list of app IDs, run doctl apps list.

Optionally, you can retrieve crash logs for a specific component by adding the component’s name as an additional argument, like this:

doctl apps logs <your-app-ID> <component-name> --type=run_restarted