CustomMonitoringSignal interface
model interface CustomMonitoringSignal
- Extends
Properties
| component |
[Required] Reference to the component asset used to calculate the custom metrics. |
| input |
Monitoring assets to take as input. Key is the component input port name, value is the data asset. |
| inputs | Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value. |
| metric |
[Required] A list of metrics to calculate and their associated thresholds. |
| signal |
[Required] Specifies the type of signal to monitor. |
Inherited Properties
| notification |
The current notification mode for this signal. |
| properties | Property dictionary. Properties can be added, but not removed or altered. |
Property Details
componentId
[Required] Reference to the component asset used to calculate the custom metrics.
componentId: string
Property Value
string
inputAssets
Monitoring assets to take as input. Key is the component input port name, value is the data asset.
inputAssets?: Record<string, MonitoringInputDataBaseUnion>
Property Value
Record<string, MonitoringInputDataBaseUnion>
inputs
Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.
inputs?: Record<string, JobInputUnion>
Property Value
Record<string, JobInputUnion>
metricThresholds
[Required] A list of metrics to calculate and their associated thresholds.
metricThresholds: CustomMetricThreshold[]
Property Value
signalType
[Required] Specifies the type of signal to monitor.
signalType: "Custom"
Property Value
"Custom"
Inherited Property Details
notificationTypes
The current notification mode for this signal.
notificationTypes?: string[]
Property Value
string[]
Inherited From MonitoringSignalBase.notificationTypes
properties
Property dictionary. Properties can be added, but not removed or altered.
properties?: Record<string, string>
Property Value
Record<string, string>
Inherited From MonitoringSignalBase.properties