Definition of Synthetic events.
Synthetic HTTP step execution details event
The following base fields are used for synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| timestamp | stableThe time (UNIX Epoch time in nanoseconds) when the event originated, typically when the source created it. If no original timestamp is available, it will be populated at ingest time and required for all events. In the case of a correlated event (for example, ITIL events), this time could be different from the event.start time, as this time represents the actual timestamp when the "update" for the event was created. |
|
| string | stableUnique identifier string of an event; is stable across multiple refreshes and updates. |
|
| string | stableDescribes the version of the event. |
|
| string | stableThe unique type identifier of a given event.Tags: |
|
| string | stableGives high-level information about what kind of information the event contains without being specific about the contents of the event. It helps to determine the record type of a raw event. 1Tags: |
|
Fixed value SYNTHETIC_EVENT.
The following fields are common for all synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe identifier of the monitor. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK.Tags: |
|
| string | resource stableAn entity ID of an entity of type MULTIPROTOCOL_MONITOR.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST.Tags: |
|
| string | experimentalThe name of the monitor. |
|
| string | experimentalThe identifier of the monitor step. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST_STEP.Tags: |
|
| string | experimentalThe name of the step. |
|
| long | experimentalThe sequence number of the step (numbered from 0). |
|
| array | experimentalIDs of monitored entities. |
|
| string | experimentalUser-defined primary grail tags, |
|
| string | resource stableThe security context is used in access permissions to limit the visibility. Learn more about the Dynatrace permission modelTags: |
The following result fields are used for synthetic monitor step execution events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalResult state of monitor execution. |
|
result.state MUST be one of the following:
| Value | Description |
|---|---|
| Fail |
| Success |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| record[] | experimentalA collection of custom log lines |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalHTTP request method. |
|
| string | experimentalThe peer certificate details. |
|
| string | experimentalHTTP request headers, |
|
| string | experimentalThe request body. |
|
| record[] | experimentalA collection of resolved ips. | |
| string | experimentalHTTP response headers, |
|
| string | experimentalThe response body. |
|
| string | experimentalThe response message. |
|
| string | experimentalThe HTTP request url. |
|
Synthetic batch status event
The following base fields are used for synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| timestamp | stableThe time (UNIX Epoch time in nanoseconds) when the event originated, typically when the source created it. If no original timestamp is available, it will be populated at ingest time and required for all events. In the case of a correlated event (for example, ITIL events), this time could be different from the event.start time, as this time represents the actual timestamp when the "update" for the event was created. |
|
| string | stableUnique identifier string of an event; is stable across multiple refreshes and updates. |
|
| string | stableDescribes the version of the event. |
|
| string | stableThe unique type identifier of a given event.Tags: |
|
| string | stableGives high-level information about what kind of information the event contains without being specific about the contents of the event. It helps to determine the record type of a raw event. 1Tags: |
|
Fixed value SYNTHETIC_EVENT.
The following fields are common for all synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe identifier of the monitor. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK.Tags: |
|
| string | resource stableAn entity ID of an entity of type MULTIPROTOCOL_MONITOR.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST.Tags: |
|
| string | experimentalThe name of the monitor. |
|
| string | experimentalThe identifier of the monitor step. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST_STEP.Tags: |
|
| string | experimentalThe name of the step. |
|
| long | experimentalThe sequence number of the step (numbered from 0). |
|
| array | experimentalIDs of monitored entities. |
|
| string | experimentalUser-defined primary grail tags, |
|
| string | resource stableThe security context is used in access permissions to limit the visibility. Learn more about the Dynatrace permission modelTags: |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe status of the batch. |
|
| string | experimentalThe source of the batch. |
|
| boolean | experimentalInformation whether performance issue validation was enabled. |
|
| boolean | experimentalInformation whether ssl certificate validation was enabled. |
|
| boolean | experimentalInformation whether the execution should provide a screenshot in case of success. |
|
| string | experimentalThe execution's processing mode |
|
| record[] | experimentalA collection of failed execution objects. Information about on-demand executions that failed. | |
| record[] | experimentalA collection of failed execution objects. Information about on-demand executions that failed to be executed. | |
| record[] | experimentalA collection of triggering problem objects. The details of problems encountered while triggering on-demand executions. | |
| string[] | experimentalThe metadata properties of the batch. 'key' being the metadata key. The value is a string defined by a user. |
|
| long[] | experimentalA collection of triggered executions ids. |
|
batch.status MUST be one of the following:
| Value | Description |
|---|---|
| Failed |
| Failed to execute |
| Not triggered |
| Running |
| Success |
batch.source MUST be one of the following:
| Value | Description |
|---|---|
| API |
| UI |
configuration.processing_mode MUST be one of the following:
| Value | Description |
|---|---|
| DISABLE_PROBLEM_DETECTION |
| EXECUTIONS_DETAILS_ONLY |
| STANDARD |
Batch result
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe number of triggered executions within the batch. |
|
| long | experimentalThe number of triggered executions with the result SUCCESS or FAILED. |
|
| long | experimentalThe number of triggered executions with the result FAILED. |
|
| long | experimentalThe number of executions that were triggered and not executed because of a problem with the Synthetic engine. |
|
| long | experimentalThe number of executions that were not triggered due to some problems. |
|
| duration | experimentalThe duration of the batch execution. |
|
| duration | experimentalThe sum of duration of the sum of all executions in batch. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableUnique UUID of a human user. If the system itself has to be represented, the constant 'system' is used. |
|
Synthetic browser monitor execution event
The following base fields are used for synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| timestamp | stableThe time (UNIX Epoch time in nanoseconds) when the event originated, typically when the source created it. If no original timestamp is available, it will be populated at ingest time and required for all events. In the case of a correlated event (for example, ITIL events), this time could be different from the event.start time, as this time represents the actual timestamp when the "update" for the event was created. |
|
| string | stableUnique identifier string of an event; is stable across multiple refreshes and updates. |
|
| string | stableDescribes the version of the event. |
|
| string | stableThe unique type identifier of a given event.Tags: |
|
| string | stableGives high-level information about what kind of information the event contains without being specific about the contents of the event. It helps to determine the record type of a raw event. 1Tags: |
|
Fixed value SYNTHETIC_EVENT.
The following fields are common for all synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe identifier of the monitor. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK.Tags: |
|
| string | resource stableAn entity ID of an entity of type MULTIPROTOCOL_MONITOR.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST.Tags: |
|
| string | experimentalThe name of the monitor. |
|
| string | experimentalThe identifier of the monitor step. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST_STEP.Tags: |
|
| string | experimentalThe name of the step. |
|
| long | experimentalThe sequence number of the step (numbered from 0). |
|
| array | experimentalIDs of monitored entities. |
|
| string | experimentalUser-defined primary grail tags, |
|
| string | resource stableThe security context is used in access permissions to limit the visibility. Learn more about the Dynatrace permission modelTags: |
The following base fields are used for synthetic execution events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe type of the execution. |
|
| timestamp | experimentalThe timestamp when execution was finished, in UTC milliseconds. |
|
| long | experimentalThe identifier of the batch (defined for on-demand executions only). | |
| string | resource stableAn entity ID of an entity of type SYNTHETIC_LOCATION.Tags: |
|
execution.type MUST be one of the following:
| Value | Description |
|---|---|
| on-creation |
| on-demand |
| on-demand with customized script |
| on-update |
| re-run |
| standard |
The following status fields are used for synthetic execution events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalStatus details. |
|
| string | experimentalThe on-demand status message. |
|
| string | experimentalThe details of the status. |
|
| string | experimentalThe category of the status. |
|
| long | experimentalNumeric representation of the status. |
|
| string | experimentalThe message returned by an execution or a status message. |
|
result.status.category MUST be one of the following:
| Value | Description |
|---|---|
| Execution fail |
| Not executed |
| Success |
| Unexpected error |
The following result fields are used for synthetic monitor execution events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe name of the failed step |
|
| long | deprecatedThe sequence ID of the step. Replaced by |
|
| long | experimentalThe sequence id of the step. |
|
| long | experimentalThe number of executed steps. |
|
| long | experimentalThe id of the engine which has executed the monitor. |
|
| string | experimentalThe type of synthetic location. |
|
| string | experimentalResult state of monitor execution. |
|
| string | resource experimentalHexadecimal identifier of the ActiveGate prefixed with |
|
result.location.type MUST be one of the following:
| Value | Description |
|---|---|
| Private |
| Public |
result.state MUST be one of the following:
| Value | Description |
|---|---|
| Fail |
| Success |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST.Tags: |
|
| boolean | experimentalShould we ignore this execution attempt (which was a failure) - will there be retry. |
|
| string | experimentalScreen capture mode |
|
| long | experimentalNext execution id for sequential mode. |
|
| long | experimentalRetried execution's id. |
|
| string | experimentalThe ME ID of the failed step. |
|
| string | experimentalThe type of the failed step. |
|
| string | experimentalThe URL of the failed step. |
|
execution.screen_capture MUST be one of the following:
| Value | Description |
|---|---|
| Capture on error |
| Capture on success |
| No capture |
result.failed_step.type MUST be one of the following:
| Value | Description |
|---|---|
| Click |
| Cookie |
| Javascript |
| Keystrokes |
| Navigate |
| Select option |
| Tap |
| Attribute | Type | Description | Examples |
|---|---|---|---|
dt.synthetic_engine.processing.end_timestamp | timestamp | experimental The end timestamp of the step/monitor execution as reported by executor. | 1629891693487 |
dt.synthetic_engine.processing.start_timestamp | timestamp | experimental The start timestamp of the step/monitor execution as reported by executor. | 1529891693487 |
result.statistics.duration | duration | experimental The duration of the monitor/step. | 456 |
result.statistics.end_timestamp | timestamp | experimental The end timestamp of the execution. | 1629891693487 |
result.statistics.events.count | long | experimental Number of events reported for this step/monitor. | 6 |
result.statistics.start_timestamp | timestamp | experimental The start timestamp of the execution. | 1629891693487 |
result.statistics.transfer_size | long | experimental The transfer size of the step/sum of all steps. | 678 |
result.statistics.user_actions.count | long | experimental Number of user actions reported for this step/monitor. | 3 |
result.statistics.user_actions.duration | duration | experimental Reported for browser_monitor_execution: Duration of browser monitor, calculated as a sum of all step-level user actions durations. Reported for browser_monitor_step_execution: Duration of individual browser monitor step, measured from the start of the first user action event of the step to the end of the last user action event of the step. | 456 |
result.statistics.user_actions.total_duration | duration | experimental Reported for browser_monitor_execution: Total duration of browser monitor, measured as a sum of all step-level values of "User actions total duration" metric. Reported for browser_monitor_step_execution: Total duration of individual browser monitor step, measured as a sum of durations of all user actions in the step. | 456 |
result.statistics.user_events.duration | duration | experimental Reported for browser_monitor_execution: Duration of browser monitor, calculated as a sum of all step-level user events durations. Reported for browser_monitor_step_execution: Duration of individual browser monitor step, measured from the start of the first event of the step to the end of the last event of the step. | 456 |
result.statistics.user_events.total_duration | duration | experimental Reported for browser_monitor_execution: Total duration of browser monitor, measured as a sum of all step-level values of "User events total duration" metric. Reported for browser_monitor_step_execution: Total duration of individual browser monitor step, measured as a sum of durations of all user events in the step. | 456 |
Synthetic browser monitor step execution event
The following base fields are used for synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| timestamp | stableThe time (UNIX Epoch time in nanoseconds) when the event originated, typically when the source created it. If no original timestamp is available, it will be populated at ingest time and required for all events. In the case of a correlated event (for example, ITIL events), this time could be different from the event.start time, as this time represents the actual timestamp when the "update" for the event was created. |
|
| string | stableUnique identifier string of an event; is stable across multiple refreshes and updates. |
|
| string | stableDescribes the version of the event. |
|
| string | stableThe unique type identifier of a given event.Tags: |
|
| string | stableGives high-level information about what kind of information the event contains without being specific about the contents of the event. It helps to determine the record type of a raw event. 1Tags: |
|
Fixed value SYNTHETIC_EVENT.
The following fields are common for all synthetic events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe identifier of the monitor. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK.Tags: |
|
| string | resource stableAn entity ID of an entity of type MULTIPROTOCOL_MONITOR.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST.Tags: |
|
| string | experimentalThe name of the monitor. |
|
| string | experimentalThe identifier of the monitor step. |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST_STEP.Tags: |
|
| string | experimentalThe name of the step. |
|
| long | experimentalThe sequence number of the step (numbered from 0). |
|
| array | experimentalIDs of monitored entities. |
|
| string | experimentalUser-defined primary grail tags, |
|
| string | resource stableThe security context is used in access permissions to limit the visibility. Learn more about the Dynatrace permission modelTags: |
The following base fields are used for synthetic execution events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe type of the execution. |
|
| timestamp | experimentalThe timestamp when execution was finished, in UTC milliseconds. |
|
| long | experimentalThe identifier of the batch (defined for on-demand executions only). | |
| string | resource stableAn entity ID of an entity of type SYNTHETIC_LOCATION.Tags: |
|
execution.type MUST be one of the following:
| Value | Description |
|---|---|
| on-creation |
| on-demand |
| on-demand with customized script |
| on-update |
| re-run |
| standard |
The following result fields are used for synthetic monitor step execution events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalResult state of monitor execution. |
|
result.state MUST be one of the following:
| Value | Description |
|---|---|
| Fail |
| Success |
The following status fields are used for synthetic execution events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalStatus details. |
|
| string | experimentalThe on-demand status message. |
|
| string | experimentalThe details of the status. |
|
| string | experimentalThe category of the status. |
|
| long | experimentalNumeric representation of the status. |
|
| string | experimentalThe message returned by an execution or a status message. |
|
result.status.category MUST be one of the following:
| Value | Description |
|---|---|
| Execution fail |
| Not executed |
| Success |
| Unexpected error |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe screenshot URI of the step. | |
| string | experimentalThe screenshot thumbnail URI of the step. | |
| string | experimentalType of the step. |
|
| string | experimentalThe URL of the step. |
|
step.type MUST be one of the following:
| Value | Description |
|---|---|
| Click |
| Cookie |
| Javascript |
| Keystrokes |
| Navigate |
| Select option |
| Tap |
| Attribute | Type | Description | Examples |
|---|---|---|---|
dt.synthetic_engine.processing.end_timestamp | timestamp | experimental The end timestamp of the step/monitor execution as reported by executor. | 1629891693487 |
dt.synthetic_engine.processing.start_timestamp | timestamp | experimental The start timestamp of the step/monitor execution as reported by executor. | 1529891693487 |
result.statistics.duration | duration | experimental The duration of the monitor/step. | 456 |
result.statistics.end_timestamp | timestamp | experimental The end timestamp of the execution. | 1629891693487 |
result.statistics.events.count | long | experimental Number of events reported for this step/monitor. | 6 |
result.statistics.start_timestamp | timestamp | experimental The start timestamp of the execution. | 1629891693487 |
result.statistics.user_actions.count | long | experimental Number of user actions reported for this step/monitor. | 3 |
result.statistics.user_actions.duration | duration | experimental Reported for browser_monitor_execution: Duration of browser monitor, calculated as a sum of all step-level user actions durations. Reported for browser_monitor_step_execution: Duration of individual browser monitor step, measured from the start of the first user action event of the step to the end of the last user action event of the step. | 456 |
result.statistics.user_actions.total_duration | duration | experimental Reported for browser_monitor_execution: Total duration of browser monitor, measured as a sum of all step-level values of "User actions total duration" metric. Reported for browser_monitor_step_execution: Total duration of individual browser monitor step, measured as a sum of durations of all user actions in the step. | 456 |
result.statistics.user_events.duration | duration | experimental Reported for browser_monitor_execution: Duration of browser monitor, calculated as a sum of all step-level user events durations. Reported for browser_monitor_step_execution: Duration of individual browser monitor step, measured from the start of the first event of the step to the end of the last event of the step. | 456 |
result.statistics.user_events.total_duration | duration | experimental Reported for browser_monitor_execution: Total duration of browser monitor, measured as a sum of all step-level values of "User events total duration" metric. Reported for browser_monitor_step_execution: Total duration of individual browser monitor step, measured as a sum of durations of all user events in the step. | 456 |