Resource ExplorationAlert in pulumi-logtail.
Pulumi type: logtail:index/explorationAlert:ExplorationAlert.
name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.
Example#
Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.
Arguments#
| Property | Type | Required | Description |
|---|---|---|---|
additionalConditions | ExplorationAlertAdditionalCondition (input)[] | no | Additional conditions that must all be met together with the main alert condition for the alert to fire (logical AND, evaluated per series on the same time bucket). Up to 4 additional conditions; 'threshold' and 'relative' types only. |
aggregationInterval | number | no | The data aggregation interval in seconds. |
alertType | string | yes | The type of alert: 'threshold', 'relative', or 'anomaly_rrcf'. |
anomalySensitivity | number | no | Anomaly detection sensitivity 0-100 (only for 'anomaly_rrcf' type, lower = more sensitive). |
anomalyTrainingRangeDays | number | no | How many days of history to train the anomaly detection on, 1-30 (only for 'anomaly_rrcf' type). |
anomalyTrigger | string | no | Anomaly trigger mode: 'any', 'higher', or 'lower' (only for 'anomaly_rrcf' type). |
call | boolean | no | Enable phone call notifications. |
checkPeriod | number | no | How often to check the alert condition in seconds. Required for threshold and relative alerts; ignored for anomaly alerts, which derive their cadence from query_period. |
confirmationPeriod | number | no | The confirmation delay in seconds before triggering. |
criticalAlert | boolean | no | Mark as critical alert (bypasses quiet hours). |
email | boolean | no | Enable email notifications. |
escalationTarget | ExplorationAlertEscalationTarget (input) | no | The escalation target for this alert. Specify either team_id/team_name OR policy_id/policy_name. |
explorationId | string | yes | The ID of the exploration this alert belongs to. |
incidentCause | string | no | Incident description template (supports {{variable}} interpolation). |
incidentPerSeries | boolean | no | Create separate incidents per series. |
metadata | { [key: string]: string } | no | Custom metadata key-value pairs included in incident notifications. Use a plain string for a single value; for multiple values use jsonencode([...]). |
name | string | no | The name of this alert. |
onMissingData | string | no | What to do when the monitored query returns no data: 'treat_as_zero', 'dont_fire', 'treat_as_previous', or 'start_incident'. Only for threshold and relative alerts. |
operator | string | no | The comparison operator. Required for threshold and relative alerts; not used for anomaly alerts. For threshold: 'equal', 'not_equal', 'higher_than', 'higher_than_or_equal', 'lower_than', 'lower_than_or_equal'. For relative: 'increases_by', 'decreases_by', 'changes_by'. |
paused | boolean | no | Whether the alert is paused. |
push | boolean | no | Enable push notifications. |
queryPeriod | number | no | The query evaluation window in seconds. |
recoveryPeriod | number | no | The duration in seconds that a condition must be resolved before an incident is recovered. A value of 0 recovers the alert immediately, a value of -1 means never automatically recover an incident. |
seriesNames | string[] | no | Specific series to monitor. Conflicts with series_names_except; set to an empty list to alert on any series. |
seriesNamesExcepts | string[] | no | Monitor all series except these. Conflicts with series_names; set to an empty list to alert on any series. |
sms | boolean | no | Enable SMS notifications. |
sourceMode | string | no | Source selection mode: 'source_variable', 'platforms_single_source', or 'platforms_all_sources'. |
sourcePlatforms | string[] | no | Platform filters (used when sourceMode is 'platforms_*'). |
sourceVariable | string | no | Source reference (format: 'source:table_name'). If omitted, derived from the parent resource's source variable. |
stringValue | string | no | The string threshold value (only for threshold alerts with 'equal' or 'not_equal' operators). |
value | number | no | The numeric threshold value. Required for threshold and relative alerts. |
variableValues | ExplorationAlertVariableValue (input)[] | no | Values pinned for a dashboard or exploration variable when evaluating this alert. |
Outputs#
Computed outputs are produced by the provider. They are not constructor arguments.
| Property | Type | Computed | Description |
|---|---|---|---|
additionalConditions | ExplorationAlertAdditionalCondition (output)[] | no | Additional conditions that must all be met together with the main alert condition for the alert to fire (logical AND, evaluated per series on the same time bucket). Up to 4 additional conditions; 'threshold' and 'relative' types only. |
aggregationInterval | number | no | The data aggregation interval in seconds. |
alertType | string | no | The type of alert: 'threshold', 'relative', or 'anomaly_rrcf'. |
anomalySensitivity | number | no | Anomaly detection sensitivity 0-100 (only for 'anomaly_rrcf' type, lower = more sensitive). |
anomalyTrainingRangeDays | number | no | How many days of history to train the anomaly detection on, 1-30 (only for 'anomaly_rrcf' type). |
anomalyTrigger | string | no | Anomaly trigger mode: 'any', 'higher', or 'lower' (only for 'anomaly_rrcf' type). |
call | boolean | no | Enable phone call notifications. |
checkPeriod | number | no | How often to check the alert condition in seconds. Required for threshold and relative alerts; ignored for anomaly alerts, which derive their cadence from query_period. |
confirmationPeriod | number | no | The confirmation delay in seconds before triggering. |
createdAt | string | yes | The time when this alert was created. |
criticalAlert | boolean | no | Mark as critical alert (bypasses quiet hours). |
email | boolean | no | Enable email notifications. |
escalationTarget | ExplorationAlertEscalationTarget (output) | no | The escalation target for this alert. Specify either team_id/team_name OR policy_id/policy_name. |
explorationId | string | no | The ID of the exploration this alert belongs to. |
incidentCause | string | no | Incident description template (supports {{variable}} interpolation). |
incidentPerSeries | boolean | no | Create separate incidents per series. |
metadata | { [key: string]: string } | no | Custom metadata key-value pairs included in incident notifications. Use a plain string for a single value; for multiple values use jsonencode([...]). |
name | string | no | The name of this alert. |
onMissingData | string | no | What to do when the monitored query returns no data: 'treat_as_zero', 'dont_fire', 'treat_as_previous', or 'start_incident'. Only for threshold and relative alerts. |
operator | string | no | The comparison operator. Required for threshold and relative alerts; not used for anomaly alerts. For threshold: 'equal', 'not_equal', 'higher_than', 'higher_than_or_equal', 'lower_than', 'lower_than_or_equal'. For relative: 'increases_by', 'decreases_by', 'changes_by'. |
paused | boolean | no | Whether the alert is paused. |
pausedReason | string | yes | Read-only field explaining why the alert is paused (e.g., 'Manually paused', complexity issues, too many failures). |
push | boolean | no | Enable push notifications. |
queryPeriod | number | no | The query evaluation window in seconds. |
recoveryPeriod | number | no | The duration in seconds that a condition must be resolved before an incident is recovered. A value of 0 recovers the alert immediately, a value of -1 means never automatically recover an incident. |
seriesNames | string[] | no | Specific series to monitor. Conflicts with series_names_except; set to an empty list to alert on any series. |
seriesNamesExcepts | string[] | no | Monitor all series except these. Conflicts with series_names; set to an empty list to alert on any series. |
sms | boolean | no | Enable SMS notifications. |
sourceMode | string | no | Source selection mode: 'source_variable', 'platforms_single_source', or 'platforms_all_sources'. |
sourcePlatforms | string[] | no | Platform filters (used when sourceMode is 'platforms_*'). |
sourceVariable | string | no | Source reference (format: 'source:table_name'). If omitted, derived from the parent resource's source variable. |
stringValue | string | no | The string threshold value (only for threshold alerts with 'equal' or 'not_equal' operators). |
updatedAt | string | yes | The time when this alert was updated. |
value | number | no | The numeric threshold value. Required for threshold and relative alerts. |
variableValues | ExplorationAlertVariableValue (output)[] | no | Values pinned for a dashboard or exploration variable when evaluating this alert. |
ExplorationAlertAdditionalCondition (input)#
Input object ExplorationAlertAdditionalCondition. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
alertType | string | yes | The type of this condition: 'threshold' or 'relative'. Anomaly detection is only available as the main alert condition. |
operator | string | yes | The comparison operator. For threshold: 'equal', 'not_equal', 'higher_than', 'higher_than_or_equal', 'lower_than', 'lower_than_or_equal'. For relative: 'increases_by', 'decreases_by', 'changes_by'. |
seriesNames | string[] | no | Specific series this condition applies to. Conflicts with series_names_except; omit to apply to any series. |
seriesNamesExcepts | string[] | no | Apply this condition to all series except these. Conflicts with series_names; omit to apply to any series. |
stringValue | string | no | The string threshold value of this condition (only with 'equal' or 'not_equal' operators). Set exactly one of value and string_value. |
value | number | no | The numeric threshold value of this condition. |
ExplorationAlertEscalationTarget (input)#
Input object ExplorationAlertEscalationTarget. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
policyId | number | no | The Better Stack escalation policy ID. |
policyName | string | no | The Better Stack escalation policy name. |
teamId | number | no | The Better Stack team ID to escalate to. |
teamName | string | no | The Better Stack team name to escalate to. |
ExplorationAlertVariableValue (input)#
Input object ExplorationAlertVariableValue. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
name | string | yes | The name of an existing non-source dashboard or exploration variable. |
selectedLabel | string | no | The selected label for a predefined SQL variable. |
values | string[] | no | The values to use when evaluating this alert. |
ExplorationAlertAdditionalCondition (output)#
Output object ExplorationAlertAdditionalCondition. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
alertType | string | yes | The type of this condition: 'threshold' or 'relative'. Anomaly detection is only available as the main alert condition. |
operator | string | yes | The comparison operator. For threshold: 'equal', 'not_equal', 'higher_than', 'higher_than_or_equal', 'lower_than', 'lower_than_or_equal'. For relative: 'increases_by', 'decreases_by', 'changes_by'. |
seriesNames | string[] | no | Specific series this condition applies to. Conflicts with series_names_except; omit to apply to any series. |
seriesNamesExcepts | string[] | no | Apply this condition to all series except these. Conflicts with series_names; omit to apply to any series. |
stringValue | string | no | The string threshold value of this condition (only with 'equal' or 'not_equal' operators). Set exactly one of value and string_value. |
value | number | no | The numeric threshold value of this condition. |
ExplorationAlertEscalationTarget (output)#
Output object ExplorationAlertEscalationTarget. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
policyId | number | no | The Better Stack escalation policy ID. |
policyName | string | no | The Better Stack escalation policy name. |
teamId | number | no | The Better Stack team ID to escalate to. |
teamName | string | no | The Better Stack team name to escalate to. |
ExplorationAlertVariableValue (output)#
Output object ExplorationAlertVariableValue. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
name | string | yes | The name of an existing non-source dashboard or exploration variable. |
selectedLabel | string | no | The selected label for a predefined SQL variable. |
values | string[] | no | The values to use when evaluating this alert. |