_id (Primary Key)
objectid
The unique identifier for the record
| Requires a Non-Null Value | Yes |
accountId
objectid
A reference to the account that owns this observer record.
| Requires a Non-Null Value | Yes |
projectId
objectid
A reference to the project that owns this observer record.
| Requires a Non-Null Value | Yes |
processId
objectid
A reference to the process that owns this observer record.
| Requires a Non-Null Value | Yes |
active
boolean
When enabled the observer will monitor the data flow for success and error occurrences.
| Requires a Non-Null Value | Yes |
| Default Value | Yes |
testInterval
integer
How often, in minutes, the observer test will execute.
| Requires a Non-Null Value | Yes |
| Default Value | 5 |
testPeriod
integer
The timespan before the test execution that will be included in the evaluation.
| Requires a Non-Null Value | Yes |
| Default Value | 10 |
testType
options
The operator that determines how to analyze the success and error logs.
| Requires a Non-Null Value | Yes |
| Allowed Values | | PERCENT_WITH_SUCCESS | Test for a specific percentage of all requests that had a success logged. | | PERCENT_WITH_ERROR | Test for a specific percentage of all requests that had an error logged. | | TOTAL_WITH_SUCCESS | Test for a specific total number of all requests that had a success logged. | | TOTAL_WITH_ERROR | Test for a specific total number of all requests that had an error logged. |
|
| Default Value | PERCENT_WITH_SUCCESS |
testCondition
options
The threshold operator that is applied to the test.
| Requires a Non-Null Value | Yes |
| Allowed Values | | GOES_ABOVE | The percentage or total of logged actions has risen above the defined threshold. | | DROPS_BELOW | The percentage or total of logged action has fallen below the defined threshold. |
|
| Default Value | GOES_ABOVE |
testTitle Title
string
The label that identifies the test results in the admin panel observers report.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
testValue
float
The threshold that must be met in a specific occurrence of a test to trigger an action
| Requires a Non-Null Value | Yes |
| Default Value | 0 |
testThreshold
integer
The number of consecutive occurrences that the test has been met to trigger an action.
| Requires a Non-Null Value | Yes |
| Default Value | 1 |
inAlarm
boolean
Indicates whether the observer has presently encountered conditions which have triggered an alert state.
| Requires a Non-Null Value | Yes |
| Default Value | No |
thresholdCount
integer
| Requires a Non-Null Value | Yes |
| Default Value | 0 |
lastAlarm
datetime
The most recent date and time when the observer was in an alarm state
| Requires a Non-Null Value | Yes |
| Default Value | Thu Jan 01 1970 00:00:00 GMT+0000 (Coordinated Universal Time) |
lastClear
datetime
The most recent date and time when the observer entered an all clear state.
| Requires a Non-Null Value | Yes |
| Default Value | Tue Nov 19 2024 16:33:11 GMT+0000 (Coordinated Universal Time) |
alertState
options
The action to take when the defined conditions of the test are met.
| Requires a Non-Null Value | Yes |
| Allowed Values | | ALERT | The observer will enter an alert state. | | CLEAR | The observer will enter an all clear state. |
|
| Default Value | ALERT |
publishOnAlert
boolean
When enabled the observer will send messages to the associated subscription topic when the observer enters an alert state.
| Requires a Non-Null Value | Yes |
| Default Value | Yes |
publishOnClear
boolean
When enabled the observer will send messages to the associated subscription topic when the observer enters the all clear state.
| Requires a Non-Null Value | Yes |
| Default Value | Yes |
alertMessageTopic
objectid
The message subscription list to send messages to when the observer enters an alert state.
| Requires a Non-Null Value | No |
alertMessageTitle
string
When the observers enters the alert state the message sent to subscribers will contain this value as the subject. Accepts template syntax.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
alertMessageContent
string
When the observers enters the alert state the message sent to subscribers will contain this value as the message content. Accepts template syntax.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
clearMessageTopic
objectid
The message subscription list to send messages to when the observer enters an all clear state.
| Requires a Non-Null Value | No |
clearMessageTitle
string
When the observers enters the all clear state the message sent to subscribers will contain this value as the subject. Accepts template syntax.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
clearMessageContent
string
When the observers enters the all clear state the message sent to subscribers will contain this value as the message content. Accepts template syntax.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
nextRunTime
datetime
| Requires a Non-Null Value | Yes |
| Default Value | __auto__ |
createdTime
datetime
System managed property. Set to the timestamp of when the record is created.
| Requires a Non-Null Value | Yes |
| Default Value | __auto__ |
modifiedTime
datetime
System managed property. Set to the timestamp of when the record is updated.
| Requires a Non-Null Value | Yes |
| Default Value | __auto__ |
eventRecords
join
| Data Model | eventRecords |
| Local Property | observers._id |
| Foreign Property | eventRecords.observerId |