Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Logs Dashboard Tool

Prev Next

Use the Logs Dashboard Tool to find troublesome API requests. Without it, you'd have to search through your entire environment's API requests. The tool also includes extra filters for faster, more targeted searches. When you find the request, you can return to the module performing it and fix the issue.

You can use the Logs Dashboard tool to review two types of API requests in your environment:

  • API requests with 400 and 500-level response codes. The 400 codes are client errors, and 500 codes are server errors.

  • API requests that take longer than two seconds to complete.

Both logs capture ingress requests only—that is, requests that cross into the Unqork network.

Example scenario:

frontend module A
  plugin
    remote execute module B
      plugin
        remote execute module C
      plugin
        external service D

The Logs Dashboard captures error and slow logs for module B only.

The Alerts Dashboard tool only supports AWS (Amazon Web Services) integration. It does not currently support Azure source logs.

In contrast, the Service Logs Dashboard captures:

  • All internal module executions, including:

    • Ingress requests

    • Internal requests

  • External service requests—requests that cross out of the Unqork network.

Filtering the Logs Dashboard

The Logs Dashboard displays all troublesome API requests in your environment. This can be a large Number of requests, so the tool includes built-in filters to save you time. You can filter by a date and time range or by the request's URL path. When you open the tool, the date and time range sets automatically to the last four hours. You can use these defaults to find a specific request or change them as needed.

The following sections describe each filter in more detail:

Filter

Description

Client

Your Unqork client credentials. These automatically populate when you open the tool.

You cannot adjust this field.

Environment

Your current Unqork environment. This field automatically populates when you open the tool.

You cannot adjust this field.

Start Date

The start date and time you want to filter API requests.

These fields automatically populate with:

  • The date you opened the tool.

  • The time is four hours before you opened the tool. The tool uses your current timezone.

End Date

The end date and time you want to filter API requests.

These fields automatically populate with:

  • The date you opened the tool.

  • The exact time you opened the tool. The tool uses your current timezone.

URL Path

Use this field to filter by a portion of the URL path of the API request. You can enter an API endpoint, like GetSubmissions or a module ID. Every call that includes that portion of the URL displays in the Logs Dashboard.

For example, to change the date and time range:

  1. From the date picker, select a Start Date.

  2. Below the Start Date picker, enter a time based on the 24-hour clock.

  3. From the date picker, select an End Date.

  4. Below the End Date picker, enter a time based on the 24-hour clock.

  5. Click Apply Filters.

The Logs Dashboard consists of two tables:

  • Error Logs

  • Slow Logs

Each table has its own built-in filters to help you find a specific API request. You can use any or all of these filters, depending on how specific you want to be. As you enter text into the fields, the results display automatically. You can also click the pagination buttons below the table to see more API requests. By default, the table displays ten requests at a time.

Let's explore each table.

The Error Logs table displays API requests with 400 and 500-level response codes. Keep in mind:

  • 400 codes are client error codes.

  • 500 codes are server error codes.

To learn more about HTTP status codes, view our HTTP Status Codes article.

You can also use filters to find a specific API request. These filters include:

Filter

Description

Timestamp

The date and time the API request was made. The tool uses your current timezone.

Status

The response code from the API call.

method

The execution method of the API call (, , PATCH, POST, ).

URL

Use this field to filter by a portion of the URL path of the API request. You can enter an API endpoint, like GetSubmissions or a module ID. Every call that includes that portion of the URL displays in the Logs Dashboard.

An ideal API request typically takes milliseconds to complete. But anything below a one-second completion time is acceptable. As complexity increases, API requests can take longer to complete. Any completion time beyond two seconds is slow. The Slow Logs table displays all slow API requests in your environment.

Use the table's filters to find a specific slow request:

Filter

Description

Timestamp

The date and time the API request was made. The tool uses your current timezone.

Duration(s)

The time it takes the API request to complete. The duration is measured in seconds.

Method

The execution method of the API call (, , PATCH, POST, DELETE).

Path

Use this field to filter by a portion of the URL path of the API request. You can enter an API endpoint, like GetSubmissions or a module ID. Every call that includes that portion of the URL displays in the Logs Dashboard.