Last updated Sep 13, 2022

Rate this page:

Monitor your apps

Monitor Forge app performance and debug your apps, using app metrics and logs in the developer console.

View app metrics

App metrics show you how your app is currently performing across all sites.

To view app metrics:

  1. Access the developer console.
  2. Select the Forge app that you want to view metrics for.
  3. Select Metrics in the left menu.

Metrics screen

The screen shows all sites that your Forge app is currently installed on, where there has been at least one invocation in the last 14 days.

Metrics

The following metrics are available for all function invocations. Note, this doesn’t include code executing in a Custom UI iframe, but includes functions invoked by @forge/bridge.

  • Invocation success rate: The percentage of successful vs. failed invocations, across all functions. An invocation is considered successful if the function doesn’t fail with an invocation error.
  • Invocation count: The total number of invocations, regardless of success or failure.
  • Invocation errors: The number of invocations that failed with an error. These are grouped by:
    • Out of memory: The function has exhausted the available memory.
    • Timeout: The function has not been successful within a time limit.
    • Unhandled exception: The function threw an uncaught exception. This category may include exceeding other platform limits such as network requests. To learn more about why the exception was thrown, view your app logs by selecting Logs in the left hand menu. For more information, see View app logs and installations.

Filters

Use these filters to refine your metrics:

  • All sites: Narrows down the metrics based on the sites that your app is installed onto, for example, <your-site>.atlassian.net. You can select multiple sites.

  • Environment: Narrows down the metrics for a specific app environment for your app.

  • Date: Narrows down the metrics 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:

    • Metrics are only shown for sites with at least one invocation in the past 14 days.
    • All dates are in Coordinated Universal Time (UTC).
    • Each chart's data resolution depends on the time interval you've selected. For example 'Last 24 hours' shows data at a 30 minute resolution, and 'Last hour' shows data at a 1 minute resolution.
    • Metrics may not always be accurate because undelivered metrics data isn’t back-filled and data sampling might be used for some metrics.

You can bookmark the URL on your browser to access metrics based on specific filtering criteria for quick access.

You must use data in accordance with the privacy rights that you've obtained from your user. For more information, see the Atlassian Developer Terms and Forge Terms.

Invocation errors

To learn more about your app's invocation errors, select the chart title, or select the More actions () menu on the chart and View details.

The following screen appears, showing site-specific information about your app's invocation errors.

The metrics drill down page

In this view, you can search, filter, and sort the data to identify errors across specific sites and installations.

Note:

  • Metrics are shown according to the selected time range.
  • The data displayed in the chart will be filtered according to the sites selected in the table.
  • By default, the table is sorted by error count, but you can sort by any column.

View app logs and installations

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 monitoring functionality in the developer console is an evolving feature. We're exploring ways to improve the monitoring capabilities 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).

Rate this page: