Skip to content

Monitor.md

Latest commit

 

History

History
58 lines (39 loc) · 8.54 KB

Monitor.md

File metadata and controls

58 lines (39 loc) · 8.54 KB

NotehubJs.Monitor

Properties

| Name | Type | Description | Notes | | ------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ---------- | | aggregateFunction | String | Aggregate function to apply to the selected values before applying the condition. [none, sum, average, max, min] | [optional] | | aggregateWindow | String | The time window to aggregate the selected values. It follows the format of a number followed by a time unit | [optional] | | alert | Boolean | If true, the monitor is in alert state. | [optional] | | alertRoutes | [MonitorAlertRoutesInner] | | [optional] | | conditionType | String | A comparison operation to apply to the value selected by the source_selector [greater_than, greater_than_or_equal_to, less_than, less_than_or_equal_to, equal_to, not_equal_to] | [optional] | | description | String | | [optional] | | disabled | Boolean | If true, the monitor will not be evaluated. | [optional] | | fleetFilter | [String] | | [optional] | | lastRoutedAt | String | The last time the monitor was evaluated and routed. | [optional] | | name | String | | [optional] | | notefileFilter | [String] | | [optional] | | perDevice | Boolean | Only relevant when using an aggregate_function. If true, the monitor will be evaluated per device, | rather than across the set of selected devices. If true then if a single device matches the specified criteria, | and alert will be created, otherwise the aggregate function will be applied across all devices. | [optional] | | routingCooldownPeriod | String | The time period to wait before routing another event after the monitor | has been triggered. It follows the format of a number followed by a time unit. | [optional] | | silenced | Boolean | If true, alerts will be created, but no notifications will be sent. | [optional] | | sourceSelector | String | A valid JSONata expression that selects the value to monitor from the source. | It should return a single, numeric value. | [optional] | | sourceType | String | The type of source to monitor. Supported values are "event" and "heartbeat". | [optional] | | threshold | Number | The type of condition to apply to the value selected by the source_selector | [optional] | | uid | String | | [optional] |

Enum: AggregateFunctionEnum

  • none (value: "none")

  • sum (value: "sum")

  • average (value: "average")

  • max (value: "max")

  • min (value: "min")

Enum: ConditionTypeEnum

  • greater_than (value: "greater_than")

  • greater_than_or_equal_to (value: "greater_than_or_equal_to")

  • less_than (value: "less_than")

  • less_than_or_equal_to (value: "less_than_or_equal_to")

  • equal_to (value: "equal_to")

  • not_equal_to (value: "not_equal_to")

  • count (value: "count")

Enum: SourceTypeEnum

  • event (value: "event")

  • heartbeat (value: "heartbeat")