Rate this page:
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.
The following app metrics are available to use on the developer console:
To view app metrics:
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.
The following metrics are available for all invocations.
This doesn’t include code executing in a Custom UI iframe, but includes functions invoked by .
Each metric is displayed as both a chart and a value. The value, displayed at the top of the screen, represents the overall or total value for that metric and includes any applied filters.
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.
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.
This section describes a Forge preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.
We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.
We're renaming the Export metrics API to App metrics API by 19 December 2023. See the Forge changelog for more details.
The following tags and dimensions are available with API metrics:
: Useful to bifurcate between product, external, and Graphql HTTP requests. This field can have one of the following values: , , , or .
: Represents the HTTP status code received for an API call. This field can have one of the following values: , , , , , , , , , , , or . Only available for metric.
: Represents the path of the HTTP request. This field can have one of the following values, depending on the type of API call:
For external HTTP requests, field will be captured as hostname. For example: ,
For product HTTP requests, field will have value.
In a future release, the templatized path for Product API calls will be capture, as such: , ,
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, . 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.
You can bookmark the URL on your browser to access metrics based on specific filtering criteria for quick access.
Rate this page: