Monitor usage metrics

Forge usage metrics help you understand and identify issues with resource consumption in a Forge app. They provide insights into services, such as compute, storage, and logs. When monitoring usage metrics, we recommend using filters to refine the results.

View app resource usage

To view your app’s resource usage:

1. Access the developer console.

2. Select the Forge app that you want to view metrics for.

3. Select Usage in the left menu and then select the resource you want to view (e.g. Functions). Note that the daily data refresh occurs at 12:00 UTC.

4. To see a detailed breakdown of usage, select View Details for the specific resource you're interested in. You can use the date filter to customize the view, with the default setting showing data for the current calendar month.

View top site consumption

To view a breakdown of up to the top 20 installation sites for your app:

1. Access the developer console.

2. Select the Forge app that you want to view metrics for.

3. Select Usage in the left menu and then select the resource you want to view.

4. Select Site breakdown to view a list of up to the top 20 sites with the highest consumption of a particular resource.

Compute Usage

Compute, previously known as Function as a Service (FaaS), is measured in GB-seconds. This usage metric applies to compute functions used in any environment and represents the amount of computing resources your app consumes over time.

Compute functions in GB-seconds

Compute functions are measured by the duration your function runs and the amount of memory it consumes during that period. Currently for all Lambda functions, the memory allocation is fixed at 0.5 GB.

1
2
Compute in GB-sec = (Lambda Execution Time in seconds * 0.5) GB seconds

Storage usage

Storage metrics are measured in GB. These usage metrics apply to the use of Forge hosted storage in any environment.

Storage writes in GB

Storage writes are measured by the amount of data your app stores in key-value or entity storage. This metric tracks how much data your app writes to the Forge storage backend.

1
2
Storage writes in GB = Total Data Written to Storage in GB

Storage reads in GB

Storage reads are measured by the amount of data your app retrieves from key-value or entity storage. This metric tracks how much data your app reads from the Forge storage backend.

1
2
Storage reads in GB = Total Data Read from Storage in GB

Total storage used in GB

Total storage measures the size of your app data by combining the raw byte size of the data with a per-item storage overhead, which varies based on the features you have enabled. This metric includes the sum of all storage writes and is relevant to both key-value and entity storage.

1
2
Storage total in GB = Total Storage writes in GB

Logs usage

Log metrics are measured in GB. This usage metric represents the amount of logging performed by your app over a period of time.

Log writes in GB

Log writes are measured by the amount of data generated from your app's log statements using console.log() or similar methods. The metric includes the size of the log messages and any metadata. Metadata may include timestamps, log levels, and additional contexts such as stack traces or request IDs.

1
2
Log writes in GB = Total Data Written to Logs in GB

Filters

Use these filters to refine your metrics:

• 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 month, or choose a more specific time interval using the Custom option.

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

Use the date filter to refine your usage metrics. The date filter narrows down the usage metrics based on your chosen time interval. Choose from a range of predefined values, such as the Last month, or choose a more specific date interval using the Custom option.

You can also bookmark the URL on your browser to access usage metrics based on specific filtering criteria for quick access. This is useful for repeated checks of the same metrics, saving time and effort in reapplying preferred filters.

Limitations

• Usage metrics are available for the last 60 days.

• Site breakdown is available for up to the top 20 installations for the current month.

• Site filters will display sites that have had at least one invocation within the past 31 days.