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.

View app logs

To view app logs:

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

The screen shows logs for all sites that users have granted you access to.

Log table

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 platform errors.
• 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.

Log attributes

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.

Search for logs

You can search for logs using invocation ID, trace ID, log messages, and modules. This helps narrow down log search results.

To search for logs:

1. In the search box above, enter the attributes of the logs you’re searching for.
2. Hit Enter on your keyboard or select the search icon.

To clear your search results, select the X button in the search box.

Filters

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 a maximum of 50 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.
• Log level: Narrows down the logs based on the log level type that you set.

Download app logs

You can download app logs, based on the filters you've chosen.

To download app logs:

1. Use filters to further refine your logs as necessary.

2. Select the Download button.

3. In the menu that appears, select one of the following format options:

   • Logs as .csv, where data values are separated by commas, allowing for data transfer with little or no reformatting needed.
   • Logs as .log, which is a zipped file that contains a .log file, making it easier for systems to consume downladed files programmatically.

Limitations

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 3500 app installations can be displayed at a given time. We recommend using filters to view logs for specific sites.