- Release Notes
- Getting Started
- Access and Permissions
- Interacting with Insights
- Historical data export
- Logs
- Performance and Scalability
- Real-time data export
- Overview
- Preparing Splunk
- Configure real-time data export to Splunk
- Real Time Data Export Data Model
Real Time Data Export Data Model
Every change in the system is represented by an event logged JSON format.
The following event types are supported:
-
Events describing jobs:
job.createdjob.startedjob.stoppedjob.pendingjob.completedjob.faultedjob.stoppingjob.terminating
-
Events describing queue items:
queueitem.addedqueueItem.retriedqueueItem.updatedqueueItem.transactionAbandonedqueueItem.transactionCompletedqueueItem.transactionFailedqueueItem.transactionRetriedqueueItem.transactionStarted
-
Events describing machines:
machine.createdmachine.updatedmachine.deletedmachineSession.statusmachine.assignmachine.unassign
Because different events describe different entities and changes to the system, they have different content (JSON fields).
Each event is delivered in JSON format and has the following:
- Event-specific body
- Common fields
- Metadata
job.created event. The example is formatted with new lines and comments describing each section for readability. Real events do not have
this formatting and are delivered as a single-line string.
{
/*********************
event-specific body
**********************/
"body": {
"Job": {
"Key": "<job-key>",
"CreationTime": null,
"State": "Pending",
"StartTime": "<job-start-time>",
"EndTime": null,
"ProcessName": "<process-name>",
"DisplayName": "<display-name>",
"RobotName": "<robot-name>",
"HostMachineName": "<host-machine-name>"
},
/*********************
common fields
**********************/
"EventType": "job.started",
"SchemaVersion": "0.0.1",
"Timestamp": "<timestamp>",
"TenantKey": "<tenant-key>",
"TenantName": "<tenant-name>",
"FolderName": "<folder-name>",
"FullFolderPath": "<folder-path>",
"FolderKey": "<folder-key>"
},
/*********************
metadata
**********************/
"x-opt-sequence-number": <sequence-number>,
"x-opt-offset": "<offset>",
"x-opt-enqueued-time": <enqueued-time>,
"Diagnostic-Id": "<diagnostic-id>"
}{
/*********************
event-specific body
**********************/
"body": {
"Job": {
"Key": "<job-key>",
"CreationTime": null,
"State": "Pending",
"StartTime": "<job-start-time>",
"EndTime": null,
"ProcessName": "<process-name>",
"DisplayName": "<display-name>",
"RobotName": "<robot-name>",
"HostMachineName": "<host-machine-name>"
},
/*********************
common fields
**********************/
"EventType": "job.started",
"SchemaVersion": "0.0.1",
"Timestamp": "<timestamp>",
"TenantKey": "<tenant-key>",
"TenantName": "<tenant-name>",
"FolderName": "<folder-name>",
"FullFolderPath": "<folder-path>",
"FolderKey": "<folder-key>"
},
/*********************
metadata
**********************/
"x-opt-sequence-number": <sequence-number>,
"x-opt-offset": "<offset>",
"x-opt-enqueued-time": <enqueued-time>,
"Diagnostic-Id": "<diagnostic-id>"
}Common fields appear in every event.
|
Name |
Type |
Description |
|---|---|---|
|
EventType |
|
The type of event. |
|
SchemaVersion |
|
The version of the schema. Different versions may have different event types and fields supported. |
|
Timestamp |
|
UTC timestamp of the event. |
|
TenantKey |
|
The unique identifier of the tenant that generated the event. |
|
TenantName |
|
Name of the tenant that generated the event. |
|
FolderName |
|
Name of the Orchestrator folder in which the event was generated. |
|
FullFolderPath |
|
If a folder is a subfolder of another folder, this field displays the full path. |
|
FolderKey |
|
The unique identifier of the folder. |
{
"EventType": "queueItem.transactionCompleted",
"SchemaVersion": "0.0.1",
"Timestamp": "<timestamp>",
"TenantKey": "<tenant-key>",
"TenantName": "<tenant-name>",
"FolderName": "<folder-name>",
"FullFolderPath": "<folder-path>",
"FolderKey": "<folder-key>"
}{
"EventType": "queueItem.transactionCompleted",
"SchemaVersion": "0.0.1",
"Timestamp": "<timestamp>",
"TenantKey": "<tenant-key>",
"TenantName": "<tenant-name>",
"FolderName": "<folder-name>",
"FullFolderPath": "<folder-path>",
"FolderKey": "<folder-key>"
}|
Name |
Type |
Description |
|---|---|---|
|
Key |
|
Unique identifier of a job. |
|
CreationTime |
|
Timestamp when the job was created. |
|
StartTime |
|
Timestamp when the job started. |
|
EndTime |
|
Timestamp when the job completed. |
|
State |
|
The state of job. Supported values: •
Pending•
Running•
Stopping•
Terminating•
Faulted•
Successful•
Stopped•
Suspended•
Resumed |
|
ProcessName |
|
Name of the package that the job was created from. |
|
DisplayName |
|
Name provided to a process in Orchestrator. |
|
RobotName |
|
Name of the robot executing the job. |
|
HostMachineName |
|
Machine on which the job is being executed. |
{
"body": {
"Job": {
"Key": "<job-key>",
"CreationTime": "<creation-time>",
"State": "Running",
"StartTime": "<start-time>",
"EndTime": null,
"ProcessName": "<process-name>",
"DisplayName": "<display-name>",
"RobotName": "<robot-name>",
"HostMachineName": "<host-machine-name>",
},
... common fields ...
"EventType": "job.started",
... more common fields ...
}{
"body": {
"Job": {
"Key": "<job-key>",
"CreationTime": "<creation-time>",
"State": "Running",
"StartTime": "<start-time>",
"EndTime": null,
"ProcessName": "<process-name>",
"DisplayName": "<display-name>",
"RobotName": "<robot-name>",
"HostMachineName": "<host-machine-name>",
},
... common fields ...
"EventType": "job.started",
... more common fields ...
}|
Name |
Type |
Description |
|---|---|---|
|
QueueItem |
JSON object | |
|
Key |
|
Unique identifier of the queue item. |
|
QueueDefinitionId |
|
Numeric identifier of a queue that the queue item belongs to. |
|
Status |
|
The status of the queue item. Supported values: •
New•
InProgress•
Failed•
Successful•
Abandoned•
Retried•
Deleted•
Unknown |
|
ReviewStatus |
|
The review status of the queue item. Supported values: •
None•
InReview•
Verified•
Retried•
Unknown |
|
DueDate |
|
Latest date and time at which the item should be processed. |
|
Priority |
|
The priority of the queue item. Supported values: •
High•
Normal•
Low•
Unknown |
|
CreationTime |
|
Timestamp when the queue item was created. |
|
StartProcessing |
|
Timestamp when the queue item started processing. |
|
EndProcessing |
|
Timestamp when the queue item finished processing (successfully or not). |
|
DefferDate |
|
The earliest date and time at which the item should be available for processing. If empty, the item can be processed as soon as possible. |
|
SecondsInPreviousAttempt |
|
The number of seconds that the last failed processing attempt lasted. |
|
RetryNumber |
|
The number of times this queue item has been processed. |
|
Progress |
|
String filed added by developers in UiPath Studio which is used to keep track on the business flow progress. |
|
AnalyticsData |
|
A collection of key-value pairs containing the data from the
Analytics property added by developers in Studio via the Set Transaction Status activity.
|
|
Output |
|
A collection of key-value pairs containing the data from the
Output property added by developers in Studio via the Set Transaction Status activity.
|
|
SpecificData |
|
A collection of key-value pairs containing the data from the
Specific Content property added by developers in Studio via the Set Transaction Status activity.
A collection of key value pairs containing custom data configured in the Add Queue Item activity in UiPath Studio. |
|
CreatorJobId |
|
The ID of the job that created the queue item. |
|
ExecutorJobId |
|
The ID of the job that executed the queue item. |
|
ProcessExceptionReason |
|
Summary of reason the queue item processing failed. |
|
ProcessExceptionDetails |
|
Additional details on the queue item failure. |
|
ProcessExceptionType |
|
For queue items that finished with an error this field describes the type of error (exception). Supported values: •
ApplicationException•
BusinessException•
None |
|
Queue |
JSON Object | |
|
Key |
|
Unique identifier of the queue. |
|
Name |
|
The name of the queue. |
|
Description |
|
Additional information about a queue in order to better identify it. |
|
MaxNumberOfRetries |
|
The number of times an item of this queue can be retried if its' processing fails. |
|
EnforceUniqueReference |
|
States whether the
Item Reference field should be unique per Queue item.
|
|
SlaInMinutes |
|
Integer value representing the Queue SLA in minutes. |
|
RiskSlaInMinutes |
|
Integer value representing the Queue Risk SLA in minutes. |
{
"body": {
"QueueItem": {
"Key": "<queue-item-key>",
"QueueDefinitionId": <queue-definition-id>,
"Status": "New",
"ReviewStatus": "None",
"DueDate": "<due-date>",
"Priority": "High",
"CreationTime": "<creation-time>",
"StartProcessing": "<start-processing-time>",
"EndProcessing": null,
"DefferDate": "<deffer-time>",
"SecondsInPreviousAttempt": 0,
"RetryNumber": 1,
"Progress": "<progress>",
"ProcessExceptionReason": null,
"ProcessExceptionDetails": null,
"ProcessExceptionType": null
},
"Queue": {
"Key": "<queue-key>",
"Name": "<queue-name>",
"Description": "<queue-description>",
"MaxNumberOfRetries": 1,
"EnforceUniqueReference": false,
"SlaInMinutes": 0,
"RiskSlaInMinutes": 0
},
},
... common fields ...
}{
"body": {
"QueueItem": {
"Key": "<queue-item-key>",
"QueueDefinitionId": <queue-definition-id>,
"Status": "New",
"ReviewStatus": "None",
"DueDate": "<due-date>",
"Priority": "High",
"CreationTime": "<creation-time>",
"StartProcessing": "<start-processing-time>",
"EndProcessing": null,
"DefferDate": "<deffer-time>",
"SecondsInPreviousAttempt": 0,
"RetryNumber": 1,
"Progress": "<progress>",
"ProcessExceptionReason": null,
"ProcessExceptionDetails": null,
"ProcessExceptionType": null
},
"Queue": {
"Key": "<queue-key>",
"Name": "<queue-name>",
"Description": "<queue-description>",
"MaxNumberOfRetries": 1,
"EnforceUniqueReference": false,
"SlaInMinutes": 0,
"RiskSlaInMinutes": 0
},
},
... common fields ...
}|
Name |
Type |
Description |
|---|---|---|
|
MachineKey |
|
Unique identifier of the machine. |
|
MachineName |
|
Custom name of the machine. |
|
HostMachineName |
|
Name of the host machine which is mapped to the UiPath machine. |
|
ServiceUsername |
|
Name of the user under which the robot service on the machine is running. |
|
MachineStatus |
|
Status of the machine. Supported values: •
Available•
Busy•
Disconnected•
Unknown |
|
Timestamp |
|
Timestamp of the machine session event. |
|
IsUnresponsive |
|
A check to see if the machine is responsive to connection from Orchestrator. Supported values: •
true•
falseA machine can still be available but be unresponsive. Once it is unresponsive for ten minutes, it becomes disconnected or unknown. |
{
"body": {
"MachineSession": {
"MachineKey": "<machine-key>",
"MachineName": "<machine-name>",
"MachineId": <machine-id>,
"HostMachineName": "<host-machine-name>",
"ServiceUsername": "<service-username>",
"MachineStatus": "Disconnected",
"ReportingTime": "<reporting-time>",
"IsUnresponsive": false
},
... common fields ...
"EventType":"machineSession.status",
... more common fields ...
}{
"body": {
"MachineSession": {
"MachineKey": "<machine-key>",
"MachineName": "<machine-name>",
"MachineId": <machine-id>,
"HostMachineName": "<host-machine-name>",
"ServiceUsername": "<service-username>",
"MachineStatus": "Disconnected",
"ReportingTime": "<reporting-time>",
"IsUnresponsive": false
},
... common fields ...
"EventType":"machineSession.status",
... more common fields ...
}|
Name |
Type |
Description |
|---|---|---|
|
AutomationCloudSlots |
|
Number of Automation Cloud<b>TM</b> slots to be reserved at runtime. |
|
HeadlessSlots |
|
Number of Headless slots to be reserved at runtime. |
|
MachineId |
|
Machine integer id, unique per Orchestrator instance. |
|
MachineKey |
|
Unique identifier of a machine. |
|
MachineName |
|
Custom name of the machine. |
|
NonProductionSlots |
|
Number of
NonProduction slots to be reserved at runtime.
|
|
UnattendedSlots |
|
Number of
Unattended slots to be reserved at runtime.
|
{
"body": {
"Machine": {
"MachineName": "<machine-name>",
"MachineKey": "<machine-key>",
"NonProductionSlots": 1,
"HeadlessSlots": 0,
"AutomationCloudSlots": 0,
"UnattendedSlots": 0
},
... common fields ...
}{
"body": {
"Machine": {
"MachineName": "<machine-name>",
"MachineKey": "<machine-key>",
"NonProductionSlots": 1,
"HeadlessSlots": 0,
"AutomationCloudSlots": 0,
"UnattendedSlots": 0
},
... common fields ...
}|
Name |
Type |
Values |
|---|---|---|
|
MachineKey |
|
Unique identifier of a machine. |
|
MachineName |
|
Custom name of the machine. |
{
"body": {
"MachineAssign": {
"MachineKey": "<machine-key>",
"MachineName": "<machine-name>"
},
"EventType": "machine.unassigned",
... common fields ...
}
}{
"body": {
"MachineAssign": {
"MachineKey": "<machine-key>",
"MachineName": "<machine-name>"
},
"EventType": "machine.unassigned",
... common fields ...
}
}|
Name |
Type |
Description |
|---|---|---|
|
fileName |
|
The name of the
.xaml file being executed.
|
|
initiatedBy |
|
The source of the execution. Possible values: •
Assistant•
Studio•
StudioX•
StudioPro•
Orchestrator•
CommandLine•
RobotAPI |
|
JobId |
string/guid |
The
JobKey, a unique identifier for the job.
|
|
level |
|
Logging level of the log. Possible values: •
Trace•
Info•
Warn•
Error•
Fatal |
|
logType |
|
The type of the robot log. Possible values: •
User•
Default•
Error•
Business•
ExecutionStep•
BusinessIteration•
Info•
Security•
Technical |
|
machineId |
|
Machine integer id, unique per Orchestrator instance. |
|
machineName |
|
Custom name of the machine. |
|
message |
|
The message of the robot log. Possible values: •
execution started•
execution ended• custom message |
|
processName |
|
The process name the robot is executing. |
|
processVersion |
|
The version of the process. |
|
robotName |
|
The name of the robot. |
|
windowsIdentity |
|
The name of the user that performed the action that was logged. |
|
processingExceptionReason |
|
The reason for the exception. Only present in Transaction End logs. |
|
processingExceptionType |
|
The type of the exception. Only present in Transaction End logs. Possible values: •
ApplicationException•
BusinessException |
|
queueItemPriority |
|
The priority of the queue item. Only present in Transaction End logs. Possible values: •
High•
Normal•
Low |
|
queueItemReviewStatus |
|
The review status of the queue item. Only present in Transaction End logs. Possible values: •
InReview•
Verified•
Reported•
Retried |
|
queueName |
|
The queue name from which the robot is executing queue items. |
|
transactionExecutionTime |
|
The execution time in seconds for the transaction. Only has values when processing queue items. |
|
transactionId |
string/Guid |
The unique key of the transaction. Only has values when processing queue items. |
|
transactionState |
|
The transaction state. Only has values when processing queue items. Possible values: •
Started•
Ended•
Postponed |
|
transactionStatus |
|
The transaction status. Only has values when processing queue items. Possible values: •
ApplicationException•
Start•
SystemError•
Failed•
BusinessException•
Success•
InProgress |
|
totalExecutionTimeInSeconds |
|
The execution time for the transaction, measured in seconds. Only has values when processing queue items. |
|
activityInfo |
|
The activity info JSON containing
DisplayName, State (Faulted, Closed, or Executing), Activity, and Arguments.
|
|
timestamp |
|
Time the event was generated. |
|
MachineKey |
|
Unique identifier of the machine executing the job. |
|
CustomFields |
|
A JSON that contains the fields defined in the AddLogFields activity in Studio. |
{
"body": {
"Level": "Info",
"MachineKey": "<machine-key>",
"RobotLog": {
"message": "Transaction Ended",
"level": "Information",
"logType": "Default",
"CustomFields": {
"Custom fields 1": "value1",
"Custom fields 2": 2,
},
"timeStamp": "<timestamp>",
"fingerprint": "<fingerprint>",
"windowsIdentity": "<windows-identity>",
"machineName": "<machine-name>",
"fileName": "<filename>",
"transactionExecutionTime": 0.6733966,
"queueItemPriority": "Normal",
"processingExceptionReason": "",
"transactionStatus": "Successful",
"queueName": "<queue-name>",
"transactionState": "Ended",
"processingExceptionType": "",
"transactionId": "<transaction-id>",
"queueItemReviewStatus": "None",
"processName": "<process-name>",
"processVersion": "1.0.6",
"jobId": "<job-id>",
"robotName": "<robot-name>",
"machineId": <machine-id>,
"organizationUnitId": <organization-unit-id>
},
"EventType": "robotlog",
... common fields ...
},
}{
"body": {
"Level": "Info",
"MachineKey": "<machine-key>",
"RobotLog": {
"message": "Transaction Ended",
"level": "Information",
"logType": "Default",
"CustomFields": {
"Custom fields 1": "value1",
"Custom fields 2": 2,
},
"timeStamp": "<timestamp>",
"fingerprint": "<fingerprint>",
"windowsIdentity": "<windows-identity>",
"machineName": "<machine-name>",
"fileName": "<filename>",
"transactionExecutionTime": 0.6733966,
"queueItemPriority": "Normal",
"processingExceptionReason": "",
"transactionStatus": "Successful",
"queueName": "<queue-name>",
"transactionState": "Ended",
"processingExceptionType": "",
"transactionId": "<transaction-id>",
"queueItemReviewStatus": "None",
"processName": "<process-name>",
"processVersion": "1.0.6",
"jobId": "<job-id>",
"robotName": "<robot-name>",
"machineId": <machine-id>,
"organizationUnitId": <organization-unit-id>
},
"EventType": "robotlog",
... common fields ...
},
}
