Monitor SQL metrics (EAP)

Forge SQL will enter the preview phase in early February. Stay tuned for the Forge changelog announcement regarding the Forge SQL Preview release.

As of Monday, January 27, the Forge SQL Early Access Program (EAP) will end. The EAP environment will be decommissioned, and your app will no longer have access to the EAP database. All EAP data will be deleted in accordance with our EAP terms.

Forge SQL provides reliability and latency metrics to help you understand your app’s database interactions. To view these metrics:

Access the developer console.
Select your Forge app that you want to view metrics for.
Select Metrics in the left menu.
Select SQL in the left menu.

At this time, the developer console can provide metrics on HTTP response status codes and response times.

To view SQL metrics on the developer console, make sure to redeploy your app with the latest version of the Forge CLI.

HTTP response status codes

HTTP response status codes are indicators of whether or not a specific HTTP request has been successfully completed. When monitoring SQL performance, you can scan the volume of the most frequent responses for each status code. The data resolution of each chart depends on the time interval you've selected.

You can see a summary of the following status codes in the developer console:

Status code	Description
2xx - Success	Indicates client requests that are successfully received, understood, and processed by the server. The chart shows the total volume of successful responses against the selected time interval.
4xx - Client errors	Indicates that there's an issue with the client's request, such as invalid credentials or a storage quota exceeded for the SQL operation. These issues must be fixed on the client's side before retrying the request. The chart shows a breakdown of the volume of the most frequent client error responses against the selected time interval.
5xx - Server errors	Indicates that the server is experiencing errors or is unable to fulfill a valid request. These issues must be fixed on the server's side before retrying the request. The chart shows a breakdown of the volume of the most frequent server error responses against the selected time interval.

Query response time

Query response time is the total amount of time that it takes for an SQL operation to receive a request, process the request, and send a response back to the client. Response time starts as soon as the client initiates the request and ends as soon as the client receives a response from the server.

Percentiles are often used when measuring response times. Percentiles provide a different view of your performance data.

When monitoring response time, you can see a summary of the following percentiles involving the response times of all operations being performed by your Forge app:

Percentile	Description
P50 - Median	Indicates the value of the response time that's faster or equal to 50% of all responses. This is the typical performance of your database and is not skewed by extreme values.
P95 - 95th percentile	Indicates the value of the response time that's faster or equal to 95% of all query responses. If the P95 value is 170 ms, this means that the query response times of 95% of the requests your app receives is less than or equal to 170 ms. This helps give an understanding of what the slowest 5% of users may be experiencing with their response times.
P99 - 99th percentile	Indicates the value of the response time that's faster or equal to 99% of all query responses. If the P99 value is 170 ms, this means that the query response times of 99% of the requests your app receives is less than or equal to 170 ms. This helps give an understanding of what the slowest 1% of users may be experiencing with their response times.

You can also scan the latency of the 50th percentile, 95th percentile, and 99th percentile response times of SQL operations in the response time chart. The data resolution of the chart depends on the time interval you've selected.

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 24 hours, 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.

Your filter selections persist across different metrics. If you switch from one metric page to another, your chosen filters will remain active.

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 also bookmark the URL on your browser to access 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.

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.