Logs and Analytics

In addition to managing application and theme assets on the platform, Dev Center enables developers to access logging and analytic tools such as:  

• Searching error logs
• Searching API Extension action logs
• Analyzing HTTP traffic metrics

Correlation ID Lookup

Error logs provide more detail about why an error occurred and can help you with troubleshooting. When a platform error occurs, the system logs it according to the unique identifier of the associated API request, known as a correlation ID. The correlation ID displays in either the Dev Center UI or API response body; depending on how you’re using the platform. You must search for error logs by correlation ID.

1. Log in to Dev Center.
2. Go to Logs > Correlation ID Lookup.
3. Enter a correlation ID associated with an error in the search text box at the top right.
4. Press enter.
5. Double click an error log to see details.

API Extension Action Logs

Action logs contain details about custom JavaScript functions that have been developed using the API Extension framework and installed on a tenant. You can only view action logs for tenants to which you have access. Log details vary based on the log level, or severity, a custom function is configured to use (e.g., debug, info, warn, error, and fatal). Refer to Action Management JSON Editor for more information.

Action logs can tell you:

• When a custom function began executing.
• When a custom function finished executing.
• How much time it took a custom function to execute.
• When and why a custom function failed to execute successfully.

To search for action logs:

1. Log in to Dev Center.
2. Go to Logs > Action Logs.
3. Click the Selected Tenant field and select a tenant from the drop-down menu that appears.
4. (Optional) Apply one or more of the following filters to narrow the results.
   • Start Date: The beginning date of the query.
   • Correlation ID: The unique ID of the API request that an application used to perform an action.
   • App Key: The unique ID of the application that performs an action.
   • Function ID: The type of action that an application performs.
   • Severity: The log level that actions use in an application.
5. Click Search.
6. Click a log to see details.
7. If desired, click View Related Entries to search for additional logs related to a selected log.

HTTP Traffic

HTTP traffic metrics are analytics that help you measure your site performance as experienced by visitors. Filters can refine the request data for more specific and custom criteria, while dimensions organize the data based on different categories and support filtering.

1. Log in to Dev Center.
2. Go to Logs > HTTP Traffic.
3. Select a Tenant, Hostname, and Time Range from the drop-down menus. If you select Custom Range for the time range, then enter a Start Date and End Date as prompted.
4. (Optional) If you want to further specify your results, click Add Filter. In the pop-up that appears:
   • Select a dimension to base the filter on.
   • Select a comparison operator available for that data type.
   • Enter a custom value that you want to compare visitor results to.
   • Click Add Filter. Repeat Step #4 to create additional filters if desired.

The summary graph will automatically update to display all requests according to your selections. Click the dimension tabs at the top to display the metrics based on HTTP methods or statuses, request paths, the visitor's country, the device types used to access a page, user agents, web browsers, IPs, the referer host (external links referring visits to a page), or edge locations (via the expanded menu on the far right).

Tables underneath the summary display the exact values for each analytic by their dimension, such as the examples below for HTTP Method and Request Path. These provide more granular details about request volumes. 

Hover over any table row and click a button that appears to Filter or Exclude that metric. This will refresh the graph and all tables to either only show data for that metric (if filtering) or remove that metric from the totals (if excluding).

You can remove active filters at any point by clicking the X or Clear All button where filters are displayed above the graph dimensions.