wavefront.getAlert

Explore with Pulumi AI

Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as wavefront from "@pulumi/wavefront";

// Get the information about the alert.
const example = wavefront.getAlert({
    id: "alert-id",
});

import pulumi
import pulumi_wavefront as wavefront

# Get the information about the alert.
example = wavefront.get_alert(id="alert-id")

package main

import (
	"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get the information about the alert.
		_, err := wavefront.LookupAlert(ctx, &wavefront.LookupAlertArgs{
			Id: "alert-id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;

return await Deployment.RunAsync(() => 
{
    // Get the information about the alert.
    var example = Wavefront.GetAlert.Invoke(new()
    {
        Id = "alert-id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.WavefrontFunctions;
import com.pulumi.wavefront.inputs.GetAlertArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Get the information about the alert.
        final var example = WavefrontFunctions.getAlert(GetAlertArgs.builder()
            .id("alert-id")
            .build());

    }
}

variables:
  # Get the information about the alert.
  example:
    fn::invoke:
      Function: wavefront:getAlert
      Arguments:
        id: alert-id

Using getAlert

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAlert(args: GetAlertArgs, opts?: InvokeOptions): Promise<GetAlertResult>
function getAlertOutput(args: GetAlertOutputArgs, opts?: InvokeOptions): Output<GetAlertResult>

def get_alert(id: Optional[str] = None,
              targets: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetAlertResult
def get_alert_output(id: Optional[pulumi.Input[str]] = None,
              targets: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAlertResult]

func LookupAlert(ctx *Context, args *LookupAlertArgs, opts ...InvokeOption) (*LookupAlertResult, error)
func LookupAlertOutput(ctx *Context, args *LookupAlertOutputArgs, opts ...InvokeOption) LookupAlertResultOutput

> Note: This function is named LookupAlert in the Go SDK.

public static class GetAlert 
{
    public static Task<GetAlertResult> InvokeAsync(GetAlertArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertResult> Invoke(GetAlertInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlertResult> getAlert(GetAlertArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: wavefront:index/getAlert:getAlert
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The ID associated with the alert data to be fetched.
Targets Dictionary<string, string>: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

Id string: The ID associated with the alert data to be fetched.
Targets map[string]string: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

id String: The ID associated with the alert data to be fetched.
targets Map<String,String>: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

id string: The ID associated with the alert data to be fetched.
targets {[key: string]: string}: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

id str: The ID associated with the alert data to be fetched.
targets Mapping[str, str]: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

id String: The ID associated with the alert data to be fetched.
targets Map<String>: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

getAlert Result

The following output properties are available:

AdditionalInformation string: User-supplied additional explanatory information about this alert.
AlertTriageDashboards List<GetAlertAlertTriageDashboard>: A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
AlertType string: The type of alert in Wavefront.
CanModifies List<string>: A list of users or groups that can modify the alert.
CanViews List<string>: A list of users or groups that can view the alert.
Condition string: A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
Conditions Dictionary<string, string>: A map of severity to condition for which this alert will trigger.
DisplayExpression string: A second query the results of which are displayed in the alert user interface instead of the condition query.
EvaluateRealtimeData bool: A Boolean flag to enable real-time evaluation.
FailingHostLabelPairs List<GetAlertFailingHostLabelPair>: A list of failing host label pairs.
Id string: The ID of the alert in Wavefront.
InMaintenanceHostLabelPairs List<GetAlertInMaintenanceHostLabelPair>: A list of in maintenance host label pairs.
IncludeObsoleteMetrics bool: A Boolean flag indicating whether to include obsolete metrics or not.
Minutes int: The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
Name string: The name of the alert as it is displayed in Wavefront.
NotificationResendFrequencyMinutes int: How often to re-trigger a continually failing alert.
ProcessRateMinutes int: The specified query is executed every process_rate_minutes minutes.
ResolveAfterMinutes int: The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves.
RunbookLinks List<string>: A list of user-supplied runbook links for this alert.
Severity string: The severity of the alert.
SeverityLists List<string>
Statuses List<string>: The status of the alert.
Tags List<string>: A set of tags assigned to the alert.
Target string: An email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes.
Targets Dictionary<string, string>: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

AdditionalInformation string: User-supplied additional explanatory information about this alert.
AlertTriageDashboards []GetAlertAlertTriageDashboard: A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
AlertType string: The type of alert in Wavefront.
CanModifies []string: A list of users or groups that can modify the alert.
CanViews []string: A list of users or groups that can view the alert.
Condition string: A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
Conditions map[string]string: A map of severity to condition for which this alert will trigger.
DisplayExpression string: A second query the results of which are displayed in the alert user interface instead of the condition query.
EvaluateRealtimeData bool: A Boolean flag to enable real-time evaluation.
FailingHostLabelPairs []GetAlertFailingHostLabelPair: A list of failing host label pairs.
Id string: The ID of the alert in Wavefront.
InMaintenanceHostLabelPairs []GetAlertInMaintenanceHostLabelPair: A list of in maintenance host label pairs.
IncludeObsoleteMetrics bool: A Boolean flag indicating whether to include obsolete metrics or not.
Minutes int: The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
Name string: The name of the alert as it is displayed in Wavefront.
NotificationResendFrequencyMinutes int: How often to re-trigger a continually failing alert.
ProcessRateMinutes int: The specified query is executed every process_rate_minutes minutes.
ResolveAfterMinutes int: The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves.
RunbookLinks []string: A list of user-supplied runbook links for this alert.
Severity string: The severity of the alert.
SeverityLists []string
Statuses []string: The status of the alert.
Tags []string: A set of tags assigned to the alert.
Target string: An email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes.
Targets map[string]string: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

additionalInformation String: User-supplied additional explanatory information about this alert.
alertTriageDashboards List<GetAlertAlertTriageDashboard>: A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
alertType String: The type of alert in Wavefront.
canModifies List<String>: A list of users or groups that can modify the alert.
canViews List<String>: A list of users or groups that can view the alert.
condition String: A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
conditions Map<String,String>: A map of severity to condition for which this alert will trigger.
displayExpression String: A second query the results of which are displayed in the alert user interface instead of the condition query.
evaluateRealtimeData Boolean: A Boolean flag to enable real-time evaluation.
failingHostLabelPairs List<GetAlertFailingHostLabelPair>: A list of failing host label pairs.
id String: The ID of the alert in Wavefront.
inMaintenanceHostLabelPairs List<GetAlertInMaintenanceHostLabelPair>: A list of in maintenance host label pairs.
includeObsoleteMetrics Boolean: A Boolean flag indicating whether to include obsolete metrics or not.
minutes Integer: The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
name String: The name of the alert as it is displayed in Wavefront.
notificationResendFrequencyMinutes Integer: How often to re-trigger a continually failing alert.
processRateMinutes Integer: The specified query is executed every process_rate_minutes minutes.
resolveAfterMinutes Integer: The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves.
runbookLinks List<String>: A list of user-supplied runbook links for this alert.
severity String: The severity of the alert.
severityLists List<String>
statuses List<String>: The status of the alert.
tags List<String>: A set of tags assigned to the alert.
target String: An email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes.
targets Map<String,String>: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

additionalInformation string: User-supplied additional explanatory information about this alert.
alertTriageDashboards GetAlertAlertTriageDashboard[]: A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
alertType string: The type of alert in Wavefront.
canModifies string[]: A list of users or groups that can modify the alert.
canViews string[]: A list of users or groups that can view the alert.
condition string: A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
conditions {[key: string]: string}: A map of severity to condition for which this alert will trigger.
displayExpression string: A second query the results of which are displayed in the alert user interface instead of the condition query.
evaluateRealtimeData boolean: A Boolean flag to enable real-time evaluation.
failingHostLabelPairs GetAlertFailingHostLabelPair[]: A list of failing host label pairs.
id string: The ID of the alert in Wavefront.
inMaintenanceHostLabelPairs GetAlertInMaintenanceHostLabelPair[]: A list of in maintenance host label pairs.
includeObsoleteMetrics boolean: A Boolean flag indicating whether to include obsolete metrics or not.
minutes number: The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
name string: The name of the alert as it is displayed in Wavefront.
notificationResendFrequencyMinutes number: How often to re-trigger a continually failing alert.
processRateMinutes number: The specified query is executed every process_rate_minutes minutes.
resolveAfterMinutes number: The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves.
runbookLinks string[]: A list of user-supplied runbook links for this alert.
severity string: The severity of the alert.
severityLists string[]
statuses string[]: The status of the alert.
tags string[]: A set of tags assigned to the alert.
target string: An email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes.
targets {[key: string]: string}: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

additional_information str: User-supplied additional explanatory information about this alert.
alert_triage_dashboards Sequence[GetAlertAlertTriageDashboard]: A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
alert_type str: The type of alert in Wavefront.
can_modifies Sequence[str]: A list of users or groups that can modify the alert.
can_views Sequence[str]: A list of users or groups that can view the alert.
condition str: A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
conditions Mapping[str, str]: A map of severity to condition for which this alert will trigger.
display_expression str: A second query the results of which are displayed in the alert user interface instead of the condition query.
evaluate_realtime_data bool: A Boolean flag to enable real-time evaluation.
failing_host_label_pairs Sequence[GetAlertFailingHostLabelPair]: A list of failing host label pairs.
id str: The ID of the alert in Wavefront.
in_maintenance_host_label_pairs Sequence[GetAlertInMaintenanceHostLabelPair]: A list of in maintenance host label pairs.
include_obsolete_metrics bool: A Boolean flag indicating whether to include obsolete metrics or not.
minutes int: The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
name str: The name of the alert as it is displayed in Wavefront.
notification_resend_frequency_minutes int: How often to re-trigger a continually failing alert.
process_rate_minutes int: The specified query is executed every process_rate_minutes minutes.
resolve_after_minutes int: The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves.
runbook_links Sequence[str]: A list of user-supplied runbook links for this alert.
severity str: The severity of the alert.
severity_lists Sequence[str]
statuses Sequence[str]: The status of the alert.
tags Sequence[str]: A set of tags assigned to the alert.
target str: An email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes.
targets Mapping[str, str]: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.

additionalInformation String: User-supplied additional explanatory information about this alert.
alertTriageDashboards List<Property Map>: A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
alertType String: The type of alert in Wavefront.
canModifies List<String>: A list of users or groups that can modify the alert.
canViews List<String>: A list of users or groups that can view the alert.
condition String: A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
conditions Map<String>: A map of severity to condition for which this alert will trigger.
displayExpression String: A second query the results of which are displayed in the alert user interface instead of the condition query.
evaluateRealtimeData Boolean: A Boolean flag to enable real-time evaluation.
failingHostLabelPairs List<Property Map>: A list of failing host label pairs.
id String: The ID of the alert in Wavefront.
inMaintenanceHostLabelPairs List<Property Map>: A list of in maintenance host label pairs.
includeObsoleteMetrics Boolean: A Boolean flag indicating whether to include obsolete metrics or not.
minutes Number: The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
name String: The name of the alert as it is displayed in Wavefront.
notificationResendFrequencyMinutes Number: How often to re-trigger a continually failing alert.
processRateMinutes Number: The specified query is executed every process_rate_minutes minutes.
resolveAfterMinutes Number: The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves.
runbookLinks List<String>: A list of user-supplied runbook links for this alert.
severity String: The severity of the alert.
severityLists List<String>
statuses List<String>: The status of the alert.
tags List<String>: A set of tags assigned to the alert.
target String: An email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes.
targets Map<String>: A comma-separated list of the email addresses or integration endpoints (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list.