Streaming logs to external systems

Introduction

Copy

The workflow logs described in the previous page in this section are a powerful tool to enable seeing the context of current & past runs for a given workflow. This can be vital in providing key insights into the health of given workflows.

It is also possible to enable the streaming of workflow logs information to an external endpoint. This means you could use a system such as Datadog, Sentry, Redshift, New Relic or Kibana in order to conduct further analysis and display statistics in a meaningful dashboard, as is offered by these services.

This opens up all sorts of possibilities in terms of what you can do with filtering and visualizing your logs, to help identify patterns of success and failure, time taken and processing efficiency, across workflows and individual connectors (both third-party service and core/helpers), as illustrated by the following example dashboard:

The following shows an example of a graphic dashboard you could render with filters of log data:

And the following shows an example Datadog dashboard with a basic list of events and specific columns:

And an individual event:

Log event types

Copy

There are three main log event types in Tray:

• Execution

• Step

• Audit

The 'Execution' event type

Copy

An Execution event gives the details on the status of a workflow run. A key piece of info here being eventType which can be: created | started | retrying | failed | created_failed | manually_retried | successful | terminated

Execution payload format

Copy

The execution log payload format is:

1
{
2
  "header": {
3
    "payloadSize": 773,
4
    "version": 1
5
  },
6
  "logType": "execution_event",
7
  "eventType": "<created | started | retrying | failed | created_failed | manually_retried | successful | terminated>",
8
  "created": "<iso timestamp>",
9
  "executionCreated": "<iso timestamp>",
10
  "executionId": "<uuid>",
11
  "workflowId": "<uuid>",
12
  "organizationId": "<uuid>",
13
  // fields present in case of error
14
  "errorMessage": "<string | undefined>",
15
  "errorStepName": "<string | undefined>",
16
  "errorStepTitle": "<string | undefined>",
17
  "errorId": "<uuid | undefined>",
18
  "errorType": "<internal | input | connector | external>"
19
}

Execution example payload

Copy

And the following screenshot shows an example execution log payload:

Execution payload format (including Solution Instances)​

Copy

For Enterprise package customers using the Embedded bundle to build integrations for multiple End Users, the Execution event (which gives details on the status of a workflow run) includes solutionId, solutionInstanceId and sourceWorkflowId:

1
{
2
 "header": {
3
  "payloadSize": 773,
4
  "version": 1
5
 },
6
 "logType": "execution_event",
7
 "eventType": "<created | started | retrying | failed | created_failed | manually_retried | successful | terminated>",
8
 "created": "<iso timestamp>",
9
 "executionCreated": "<iso timestamp>",
10
 "executionId": "<uuid>",
11
 "workflowId": "<uuid>",
12
 "organizationId": "<uuid>",
13
 // embedded only
14
 "solutionId": "<uuid>",
15
 "solutionInstanceId": "<uuid>",
16
 "sourceWorkflowId": "<uuid>",
17
 // fields present in case of error
18
 "errorMessage": "<string | undefined>",
19
 "errorStepName": "<string | undefined>",
20
 "errorStepTitle": "<string | undefined>",
21
 "errorId": "<uuid | undefined>",
22
 "errorType": "<internal | input | connector | external>"
23
}

The 'Step' event type

Copy

A Step event gives details about the status of a specific step in a workflow. A key piece of info here being stepState which can be running | failure | success

It can be of logType 'input' or 'output' (as explained in the Intro to Logs and Debugging)

Step payload format

Copy

The standard step payload format is:

1
{
2
 "header": {
3
  "payloadSize": 773,
4
  "version": 1
5
 },
6
 "logType": "<step_input | step_output>",
7
 "created": "<iso timestamp>",
8
 "executionCreated": "<iso timestamp>",
9
 "executionId": "<uuid>",
10
 "workflowId": "<uuid>",
11
 "organizationId": "<uuid>",
12
 "stepName": "<string>",
13
 "stepState": "<running | failure | success>",
14
 "connectorName": "<string>",
15
 "connectorVersion": "<string>",
16
 "operation": "<string>",
17
 "executionStepUuid": "<uuid>",
18
 "correlationId": "<uuid>",
19
 // if enabled
20
 "data": "<object>",
21
 // fields present in case of error
22
 "errorMessage": "<string | undefined>",
23
 "errorId": "<uuid | undefined>",
24
 "errorType": "<internal | input | connector | external>"
25
}

Step payload example

Copy

And the following screenshot shows an example step log step_input payload:

And a step_output payload:

Enhanced error alerting payloads

Copy

Note that it is possible to turn on enhanced payloads for your error handling workflows.

This will mean that payloads coming through to your workflows using the Alerting Trigger will contain more detailed information on workflow errors, as they will have parsed the information directly from the third-party service which returned the error.

Please see our Error Handling documentation for full details.

The 'Audit' event type

Copy

Audit events inside of Tray are a powerful tool to be able to see the user and system generated actions performed on Workflows, Users and Authentications. Context given from these events can be vital to providing key insights into the usage of the Tray platform and also to provide a historical trail of user or system actioned events that took place in the Tray platform.

This allows customers to run their own real time analysis using the tooling of their choice and also have a copy of the logs for batch analysis later and also monitor the usage of the platform for auditing purposes.

Audit payload format

Copy

Each audit event has slightly different details, but the following is a sample format.

1
{
2
"eventType": "string",
3
"details": {"stepName": "string", "workflowId": "<uuid>"},
4
"organizationId": "<uuid>",
5
"timestamp": "<iso datetime>",
6
"impersonatedBy": {"userId": "string", "email": "string"},
7
"calledBy": {"userId": "string", "email": "string"}
8
}

Audit payload example

Copy

And the following screenshot shows an example audit log payload:

Please see the appendix below for a table which gives a list of all the Audit events available.

Audit payload example (including Solution Instances)​

Copy

For Enterprise customers with the Embedded bundle, there are several Embedded-specific Audit event types.

These are solutionInstanceWorkflowCreated, solutionInstanceWorkflowUpdated and solutionInstanceWorkflowDeleted

The following screenshot shows an example log for solutionInstanceWorkflowCreated:

Saving filters in your dashboard

Copy

The external service you are streaming your logs to will likely have the ability to filter data according to your needs.

There are obviously huge possibilities in terms of what filtering can be done. But some ways in which you might wish to filter are:

• By connectorName so you can have a dashboard which shows all information on how Salesforce connectors are running across all your workflows

• By stepState = retrying to get a view on all step events which are currently retrying

• By eventType = failed to monitor failing workflows

Setting up logs streaming

Copy

To begin the setup process please either:

- Contact your account manager

Or

- Click on 'Submit a ticket' in the 'Getting Help' section of the builder:

When creating a ticket you will be presented with the Log Streaming form:

The following table lists the basic required information we need to begin the setup process

Once set up you can then validate that your service is receiving the correct log types.

Example setup - Datadog

Copy

In order to set up Datadog for logs streaming you will need to go to the 'Integrations' section of your dashboard to retrieve both your API key and Application Key which you have configured for use with Tray:

Then simply provide us with your Organization/Email, Content type and Logs Type info as above

Questions & Feedback

Copy

In order to improve this feature, we'd like to hear from your experience in using Logs Streaming. To do so, navigate to the "Product Feedback" section of your Tray dashboard and mention 'Logs Streaming' in your message.

Appendix - Table of Audit log event types

Copy