Monitoring
Learn how to query and visualize your Vercel usage, traffic, and more with the Monitoring tab.The Monitoring tab allows you to visualize, explore, and monitor your usage and traffic data with a powerful query editor.
Access the Monitoring tab from the Vercel dashboard.
Charts allow you to visually explore your query results in detail. To create a new chart, first click the Create a New Query button and add a title for the query. The chart containing the query results will appear and the query will be saved in the Team Queries folders in the left navigation bar.
Filters can be used to adjust the settings of a chart. These include a date range selector, a data granularity filter, and the ability to view a chart as a line or bar chart.
Graph view to visualize data and usage of your application.
For in-depth analysis, hover and move your mouse through the graph, and you will see a tool tip.
The tool tip shows you the aggregated data for the day you're hovering over.
On the left navigation bar, you will find a list of ready-to-use Example Queries that can be used to visualize your data. Vercel provides nine Example Queries:
Query Name | Description |
|---|---|
Requests by Hostname | The total number of requests grouped by host |
Requests by Project | The total number of requests grouped by project_id |
Bandwidth by Project, Hostname | The outgoing bandwidth grouped by host and project_id |
Bandwidth by Path, Hostname | The outgoing bandwidth grouped by host and source_path |
Request Cache Hits | The total number of request cache hits grouped by host |
Request Cache Misses | The total number of request cache misses grouped by host |
429 Status Codes by Host, Path | The total 429 (Too Many Requests) status code requests grouped by host and source_path |
5XX Status Codes by Host, Path | The total 5XX (server-related HTTPS error) status code requests grouped by host and source_path |
Execution by Host, Path | The total build execution time grouped by host and source_path |
You can create a new query to visualize and analyze your website usage and traffic as per your custom requirements. Click the Create a New Query button, that asks you to enter the name of the new query.
Create new queries from the top right button.
When you click, Create, you see a query template. Hit the Edit Query button, and it opens a query editor that has the following editable fields:
Property Name | Description | Configurations |
|---|---|---|
Visualize | Defines the field to visualize | Select fields like bandwidth_outgoing, execution, requests, serverless_function_duration, and memory_size |
Where | Define the conditions to filter your query on (just like a SQL where clause) | To query only the bandwidth for images you can filter by host and source_path for example host = 'acme.vercel.app' AND (like(source_path, '%.png') OR like(source_path, '%.jpg')) |
Grouped By | Split the data into groups based on the value of fields | Select functions from drop-down like host, source_path, host_id, etc. |
Limit | Defines the limit on the number of results the query will show | Select the number from drop-down for example 1, 3, 5, 10, and 15 |
You can also use the “+” button to the right of the “My Queries” and “Team Queries” folders to create new queries.
Click the '+' icon next to the query folder name to add new queries.
For example, a query to visualize Top Bandwidth Images on your website, it will have the following fields:
- Set the "Visualize" field to
bandwidth_outgoing. It will sum the bandwidth column for all the rows matching the query - Set the "Group By" field to
host = 'acme.vercel.app' AND (like(source_path, '%.png') OR like(source_path, '%.jpg'))which specifies that the results should be grouped by thesource_path,png, andjpg - Set the "Limit" of query results to 10
Next, click the Run Query button. The query editor will start generating query results which you can further refine by applying different filters and graph views.
Query editor from where you edit your new and existing queries.
You can create saved personal queries under the My Queries folder on the left navigation bar. These queries are only viewable and editable by the user that created the query.
To create a saved personal query, click on the (+) icon to the right of the My Queries folder. When the "Create New Query" modal appears, type in a name and click on the "Create" button. Use the query editor to modify your results and click "Run Query" to execute your query. To save your personal query, click the "Save" button in the upper right-hand corner.
Team Queries are saved queries that any user can access on a Team with the owner or member roles. These queries are located in the Team Queries folder on the left navigation bar.
To create a saved team query, click on the (+) icon to the right of the Team Queries folder. When the "Create New Query" modal appears, type in a name and click on the "Create" button. Use the query editor to modify your results and click "Run Query" to execute your query. To save your team query, click the "Save" button in the upper right-hand corner.
You can manage your saved personal and team queries right from the query console. Select a query from the left navigation bar and click on the vertical ellipsis (⋮) in the upper right-hand corner. You can choose to Duplicate, Rename, or Delete the selected query from the dropdown menu.
Duplicate, Rename and Delete a query from the query editor.
Alternatively, you can perform the same actions from the left navigation bar. Hover your mouse over a saved query and click on the vertical ellipsis (⋮) to view the drop-down menu.
Manage individual queries from the sidebar right next to their names.
Duplicating a query creates a copy of the query in the same folder as the original. Queries cannot be copied to another folder. In addition to being able to rename a saved query via the ellipses (⋮) drop-down menu, you can also click directly on the title of the saved query to edit it.
Deleting a saved personal or team query is permanent and irreversible. Once you have selected a saved query to delete, click the delete button in the confirmation modal to confirm the deletion.
Confirmation message before a query is deleted.
The Monitoring tab is in the beta stage and is currently available to all Enterprise accounts. Only users with the owner or member role can access the Monitoring tab. The retention time for the query-able data is 30 days.
The query-able data includes all the CDN requests, which means only the Edge, Lambda, External, and Static logs are displayed. Build logs are not present.
When using the Monitoring tab, you might run into errors like:
No data appears when you define a faulty location parameter that generates an invalid query. This incidental response appears as an error message at the bottom-right corner of the page. Make sure you choose a valid location for your query to fetch data.
Error message generated due to an invalid query.