Monitoring

In the Monitoring tab, you can review every action that has been carried out by your automation and monitor them. The graph displays the various metrics of your automation pipelines, and it can also be filtered to highlight any specific information you’re looking for.

You can click the Monitoring icon on the corresponding pipeline to examine it using this tool.

On this chart, you can see the data of all actions that have taken place in your pipeline, displayed across a timeline. You can modify the time frame to look at the data in smaller or larger scales.

Filtering the chart

The monitoring chart can be filtered to help you examine your pipelines in detail. You can search manually in these filters to find the one you’re looking for with ease. There are three main filters you can utilize above the chart:

  • Status - You can view your actions by status, and you can select multiple at once.
  • Events - You can have the graph display action data based on the event that triggered it.
  • Actions - You can select both default or custom actions to see their details on the graph. For custom actions, you can select them by name from the dropdown list.

You can revert these filters at any time by clicking the Reset filters button at the top.

Date and Time

You can also filter the data by date and time by clicking on the bars of the graph:

  • Monthly
  • Daily
  • Hourly
  • By minutes
  • By seconds

The graph will show you the Daily time frame by default. You can click on the bars to change the time frame, for example: DaysHours, HoursMinutes, etc.

You can also access the previous time frame by selecting the corresponding back button at the top of the chart.

List of actions

Below the graph, you can see the information of every action laid out in a list with four columns:

  • Action name
  • Details
  • Creation date
  • Status

If a custom action is Pending or Received, you can click the Revoke button to stop it from being carried out.

You can click on an action to open a drawer menu with all of its corresponding data. The details are dependent on the action type (Custom, Webhook, or Email). From the top right corner of this menu, you may choose to view the action in its corresponding pipeline. For custom actions, you may also open them in the code editor directly from the menu.

Custom action

custom action

  • Details - This tab shows the action’s corresponding data based on its configuration. This includes the action’s status, secret, custom arguments, description, and its creation, start, and end dates.
  • Chain - The chain of triggers leading to the selected action.
  • Input - The event JSON and a context object.
  • Output - The output JSON, text or traceback.
  • Logs - The custom action’s logs, available so that you can closely monitor the automations and troubleshoot any given errors.

Webhook

webhook action

  • Details - This tab shows the action’s corresponding data based on its configuration. This includes the status, URL, secret, and its creation, start, and end dates.
  • Chain - The chain of triggers leading to the selected action.
  • Request - The corresponding request headers and payload.
  • Response - The corresponding response headers and payload, as well as the status code.

Email

email action

  • Details - This tab shows the action’s corresponding data based on its configuration. This includes the status, email, and its creation, start, and end dates.
  • Chain - The chain of triggers leading to the selected action.
  • Email body - The event that took place, and what it was triggered by, will show in this tab.

📘

All action types have creation dates, but the start and end dates depend on the status of the action.

Action statuses

An action can have one of these statuses:

  • Received - this shows when the action has been received by the system but it isn’t in progress yet.
  • Pending - this shows when the action is in progress.
  • Success - this shows when the action was carried out successfully.
  • Failed - this shows when the action failed to be carried out.
  • Revoked - this shows that the action was revoked before it could be carried out.

Download monitoring data

You can download a CSV file of your pipeline metrics to view and use them outside of the platform.

To do so, you can click on the Download CSV button above the monitoring graph.

Headers

Below, you can see a sample header for the webhooks. Please note that the Content-Type is always ”application/json”, and you can use the X-Authorization-Content-SHA256 key for authorization.

{
  "Host": "web:8001",
  "Accept": "application/json;charset=UTF-8",
  "X-Event": "item",
  "Connection": "close",
  "User-Agent": "python-urllib3/1.26.14",
  "X-Delivery": "0ae5560f-afa5-499b-b23e-118bb54a94bf",
  "Content-Type": "application/json",
  "Content-Length": "936",
  "Accept-Encoding": "identity",
  "X-Amzn-Trace-Id": "Root=1-63d79f8b-48d03ea01e91192b4e007ad2",
  "X-Forwarded-For": "44.193.142.184",
  "X-Forwarded-Port": "443",
  "X-Forwarded-Proto": "https",
  "X-Authorization-Content-Sha256": "aba5081f263ebb4dd762a4aad713dd56b833d7009b0d525736478935de12b767"
}

Payloads

You can find a few example payloads below for events and actions.

Item status updated

{
  "op": "u",
  "before": {
    "id": 41158539,
    "name": "test.jpeg",
    "qa_id": null,
    "qa_name": null,
    "team_id": 19744,
    "createdAt": 1675075465000,
    "folder_id": 309326,
    "is_pinned": false,
    "source_id": "4792bc5e-9ad6-4f04-85d9-2fcd63c088d1",
    "updatedAt": 1675075465000,
    "project_id": 122101,
    "annotator_id": null,
    "entropy_value": null,
    "annotator_name": null,
    "approval_status": null,
    "annotation_status": "NotStarted",
    "prediction_status": 1,
    "segmentation_status": 1
  },
  "after": {
    "id": 41158539,
    "name": "test.jpeg",
    "qa_id": null,
    "qa_name": null,
    "team_id": 19744,
    "createdAt": 1675075465000,
    "folder_id": 309326,
    "is_pinned": false,
    "source_id": "4792bc5e-9ad6-4f04-85d9-2fcd63c088d1",
    "updatedAt": 1675075467000,
    "project_id": 122101,
    "annotator_id": null,
    "entropy_value": null,
    "annotator_name": null,
    "approval_status": null,
    "annotation_status": "InProgress",
    "prediction_status": 1,
    "segmentation_status": 1
  },
  "ts_ms": 1675075467014,   
}

Item opened in the editor event

"ip_address",
"action",
"team_id",
"project_id",
"project_name",
"folder_id",
"item_id",
"item_name",
"user_name",
"user_role"