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.

Below the graph, The information is laid out with five columns:

• Event - Shows you which event triggered an action.
• From | To - In case of a status update, it shows you the initial status and what it was updated to.
• Scope - Shows you the event’s scope of projects, as well as any folders that may be specified within that scope.
• Date - Shows you when the event or action took place.
• Status - Shows you the overall status of the actions triggered by the corresponding event: Pending, Success, or Failed.

You can access the pipeline canvas through an event by clicking the corresponding arrow → on the right. When the canvas opens, the event will be automatically selected.

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.

Actions

When you click on the event, it’ll expand to show you additional details below based on what actions were triggered by it. Actions that are linked together in one chain will be grouped together. This is to clarify each chain of actions individually.

Action information

Here are the available actions in a pipeline.You can expand an action to see its corresponding details by clicking on it under the event:

• Webhook – You’ll be able to see the Headers and Payload for both the request and response of this action.
• Email – You’ll see the email body, within which you can find the event that took place and the project it was triggered by.
• Custom – You’ll see an event JSON and a context object in the Input tab, and an output JSON, text or traceback in the Output tab. You can also view your custom action’s Logs so that you can closely monitor the automations and troubleshoot any given errors.

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.

📘

About event and action statuses

• An event’s status depends on the actions within:
  • If one action has the Pending status, but the rest have succeeded, then the event will have the Pending status as well.
  • If one action has failed but the rest haven't, then the event will have the Failed status.
  • Received and Revoked don't affect the overall status.
• If the action is Pending or Received, you can click the Revoke button to stop it from being carried out.

Filters

The monitoring graph 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 graph:

• Status - You can view your events and actions by status, and you can select multiple at once.
• Events - You can have the graph display event-based metrics.
• Actions - You can select both existing or custom actions to see their details on the graph. You may also type the name of an action to bring it up in 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:

• When clicking on a month, it'll expand the data and display it by the days of that month.
• If you click on a specific day, it'll then display the data by the hours of that day.

Filtering this way will bring up a date and time picker at the top of the chart. You can revert this filter by clicking on the corresponding back button.

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"

Send email action

• Event - "Folder status updated"
• From Value - "{folder_status}"
• To Value - "{folder_status}"
• Triggered by - "{team_name/project_name/folder_name}"