Last updated Sep 26, 2022

Rate this page:

View app logs and installations

View app logs

App logs give you the information you need in order to debug your apps. Logs are enabled by default when a user installs your app, and are displayed in the developer console. If you need to view app logs for a site where the user has disabled log access, you can ask them to re-enable access.

To view app logs:

  1. Access the developer console.
  2. In the left menu, select Logs.

You'll see a page like this, showing logs for all sites that users have granted you access to.

A list of logs and the associated filters

Log table

The table contains a list of your logs.

  • Date/Time(UTC): Displays the time that the log was created in UTC.

  • Details: Shows a concatenated preview of the log message. Select anywhere in a row to expand it and view the entire log message, along with all of the attributes from the state of the app, such as Invocation ID and Product.

  • Level: Displays the log level. This can be chosen by your app, by inserting log statements such as console.log, console.warn in your app’s code. Unhandled errors are assigned the Error level, and include both app errors and platform errors.

Logs are shown for a single invocation. To see logs for another invocation, select Load logs for another invocation.

Filters

Use these filters to refine your logs:

  • Site: Narrows down the logs based on the site that your app is installed onto, for example https://your-domain.atlassian.net.

    • Note, you can’t filter by product. For example, you can’t narrow down logs just for Jira instances on a particular site.
  • Environment: Narrows down the logs for a specific app environment for your Forge app.

  • Date: Narrows down the logs based on your chosen time interval.

    • Choose from a range of predefined values, such as the Last 24 hours, or choose a more specific time interval using the Custom option.

    • Note, logs are only available for the past 60 days and all dates are in UTC.

To download a zipped file of the logs for your chosen filters, select the Download button.

Limitations

The log access functionality in the developer console is an evolving feature. We're exploring ways to improve and overcome the following limitations:

  • When filtering by multiple sites, data is aggregated from all selected sites, rather than individual sites.
  • Log filters don't allow for multi-select.
  • Log filters don't include filtering by log level (warn or info).

View app installations

To see a list of sites that your app is currently installed onto, select Installations in the left menu.

The developer console installations screen

Rate this page: