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.
Before you begin
The content on this page is written under the assumption that your Forge app is running on an
older version of Forge runtime.
On the older version, the Logs screen would display like the following:
If you see a different screen, your Forge app may be on a
newer version of Forge runtime. The new experience
provides capabilities that further refine log results, including using new filters, such as
log levels, and searching for log messages.
If you want to move your app to the new runtime, run forge deploy in the Forge CLI. Site admins
may need to provide consent if a
major version upgrade
of their app is required.
The screen shows logs for all sites that users have granted you access to.
A maximum of 20 log events are displayed by default. To view more log events, select Load more logs
at the bottom of the page.
The table contains a list of your logs.
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
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. See Log messages for more details.
Logs are shown for a single invocation. To see logs for another invocation, select
Load logs for another invocation.
Expanding a row in the log table lets you view all log details, including the attributes
from the state of the app.
Invocation ID: A unique identifier for the specific app invocation that generated the log lines.
Trace ID: A request identifier that can be used to track log lines across different
Forge invocations and remote API calls.
Module: The name of the module where this log line was generated.
Function: The name of the function where this log line was generated.
Version: The version
of the app that's installed on the site.
Site: The name of the site where the app was invoked from.
Environment: The specific environment
(development, staging, or production) where the app is currently running in.
Product: The Atlassian product onto which the app is installed.
You can use filters to further refine your logs. Depending on the version of Forge Runtime that the
app is on, you may have varying filters that you can use.
Site: Narrows down the logs based on the site that your app is installed
onto, for example, https://your-domain.atlassian.net. You can select multiple sites.
Environment: Narrows down the logs for a specific app environment for your Forge app.
Time range: Narrows down the logs for a specific time range that you set. Choose from
a range of predefined values, such as the Last 24 hours, or choose a more specific time interval
using the Custom option.
You can’t filter by product. For example, you can’t narrow down logs just for Jira
instances on a particular site.
Logs are only available for the past 60 days and all dates are in UTC.
To clear your filters, select Reset to default.
To download a zipped file of the logs for your chosen filters, select the Download button.
The maximum file size of filtered logs you can download is 100MB.
The log access functionality in the developer console is an evolving feature.
When filtering by multiple sites, data is aggregated from all selected sites, rather
than individual sites.
Logs for only a maximum of 95 app installations can be displayed at a given time. We recommend using
filters to view logs for specific sites.
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.