View app metrics

App metrics show you how your Forge app is currently performing across all sites. This page explains how to view and filter the metrics for your app, including specific data about your app's invocation errors.

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.

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. Note, you can set up an alert for this metric.
• Invocation count: The total number of invocations, regardless of success or failure.
• Invocation errors: The number of invocations that failed with an error. They are grouped into the following error types:
  • 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.
• Invocation time: The time it takes for each function to successfully complete an invocation. The chart shows the distribution of invocation time as a histogram across different time buckets. The time is measured from inside the AWS lambda, and doesn't include cold start, but it includes the time it took for the lambda initialization phase to complete.

Each metric may be displayed as both a chart and a value. The value, if displayed at the top of the screen, represents the overall or total value for that metric and includes any applied filters.

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.

Each metric can also be grouped by app version or function, by selecting the Group by dropdown next to a chart.

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

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.

In this view, you can search, filter, and sort the data to identify errors across specific sites and installations. You can also group the chart by version and error type, by selecting the Group chart by dropdown above the chart.

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.

Invocation time

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

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

In this view, you can search, filter, and group the data to see invocation time across specific functions, environments, and time periods.

To group the chart by function or version, select the Group chart by dropdown above the chart. Note, this will only reflect in the chart data, not in the table data.