Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. Slo
SignalFx v7.1.5 published on Wednesday, May 29, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.Slo

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.5 published on Wednesday, May 29, 2024 by Pulumi
pulumi/pulumi-signalfx

    Provides a Splunk Observability Cloud slo resource. This can be used to create and manage SLOs.

    To learn more about this feature take a look on documentation for SLO.

    Example

    resource "signalfx_slo" "foo_service_slo" {
  name        = "foo service SLO"
  type        = "RequestBased"
  description = "SLO monitoring for foo service"

  input {
    program_text       = "G = data('spans.count', filter=filter('sf_error', 'false') and filter('sf_service', 'foo-service'))\nT = data('spans.count', filter=filter('sf_service', 'foo-service'))"
    good_events_label  = "G"
    total_events_label = "T"
  }

  target {
    type              = "RollingWindow"
    slo               = 95
    compliance_period = "30d"

    alert_rule {
      type = "BREACH"

      rule {
        severity = "Warning"
        notifications = ["Email,foo-alerts@bar.com"]
      }
    }
  }
}

provider "signalfx" {}

    Notification format

    As Splunk Observability Cloud supports different notification mechanisms, use a comma-delimited string to provide inputs. If you want to specify multiple notifications, each must be a member in the list, like so:

    notifications = ["Email,foo-alerts@example.com", "Slack,credentialId,channel"]

    See Splunk Observability Cloud Docs for more information.

    Here are some example of how to configure each notification type:

    Email

    notifications = ["Email,foo-alerts@bar.com"]

    Jira

    Note that the credentialId is the Splunk-provided ID shown after setting up your Jira integration. See also signalfx.jira.Integration.

    notifications = ["Jira,credentialId"]

    OpsGenie

    Note that the credentialId is the Splunk-provided ID shown after setting up your Opsgenie integration. Team here is hardcoded as the responderType as that is the only acceptable type as per the API docs.

    notifications = ["Opsgenie,credentialId,responderName,responderId,Team"]

    PagerDuty

    notifications = ["PagerDuty,credentialId"]

    Slack

    Exclude the # on the channel name:

    notifications = ["Slack,credentialId,channel"]

    Team

    Sends notifications to a team.

    notifications = ["Team,teamId"]

    TeamEmail

    Sends an email to every member of a team.

    notifications = ["TeamEmail,teamId"]

    Splunk On-Call (formerly VictorOps)

    notifications = ["VictorOps,credentialId,routingKey"]

    Webhooks

    You need to include all the commas even if you only use a credential id.

    You can either configure a Webhook to use an existing integration’s credential id:

    notifications = ["Webhook,credentialId,,"]

    Or configure one inline:

    notifications = ["Webhook,,secret,url"]

    Create Slo Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Slo(name: string, args: SloArgs, opts?: CustomResourceOptions);
    @overload
def Slo(resource_name: str,
        args: SloArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Slo(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        input: Optional[SloInputArgs] = None,
        target: Optional[SloTargetArgs] = None,
        type: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None)
    func NewSlo(ctx *Context, name string, args SloArgs, opts ...ResourceOption) (*Slo, error)
    public Slo(string name, SloArgs args, CustomResourceOptions? opts = null)
    public Slo(String name, SloArgs args)
public Slo(String name, SloArgs args, CustomResourceOptions options)

    type: signalfx:Slo
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SloArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SloArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SloArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SloArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SloArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var sloResource = new SignalFx.Slo("sloResource", new()
{
    Input = new SignalFx.Inputs.SloInputArgs
    {
        ProgramText = "string",
        GoodEventsLabel = "string",
        TotalEventsLabel = "string",
    },
    Target = new SignalFx.Inputs.SloTargetArgs
    {
        AlertRules = new[]
        {
            new SignalFx.Inputs.SloTargetAlertRuleArgs
            {
                Rules = new[]
                {
                    new SignalFx.Inputs.SloTargetAlertRuleRuleArgs
                    {
                        Severity = "string",
                        Description = "string",
                        Disabled = false,
                        Notifications = new[]
                        {
                            "string",
                        },
                        ParameterizedBody = "string",
                        ParameterizedSubject = "string",
                        Parameters = new SignalFx.Inputs.SloTargetAlertRuleRuleParametersArgs
                        {
                            BurnRateThreshold1 = 0,
                            BurnRateThreshold2 = 0,
                            FireLasting = "string",
                            LongWindow1 = "string",
                            LongWindow2 = "string",
                            PercentErrorBudgetLeft = 0,
                            PercentOfLasting = 0,
                            ShortWindow1 = "string",
                            ShortWindow2 = "string",
                        },
                        RunbookUrl = "string",
                        Tip = "string",
                    },
                },
                Type = "string",
            },
        },
        Slo = 0,
        Type = "string",
        CompliancePeriod = "string",
        CycleStart = "string",
        CycleType = "string",
    },
    Type = "string",
    Description = "string",
    Name = "string",
});

    example, err := signalfx.NewSlo(ctx, "sloResource", &signalfx.SloArgs{
	Input: &signalfx.SloInputTypeArgs{
		ProgramText:      pulumi.String("string"),
		GoodEventsLabel:  pulumi.String("string"),
		TotalEventsLabel: pulumi.String("string"),
	},
	Target: &signalfx.SloTargetArgs{
		AlertRules: signalfx.SloTargetAlertRuleArray{
			&signalfx.SloTargetAlertRuleArgs{
				Rules: signalfx.SloTargetAlertRuleRuleArray{
					&signalfx.SloTargetAlertRuleRuleArgs{
						Severity:    pulumi.String("string"),
						Description: pulumi.String("string"),
						Disabled:    pulumi.Bool(false),
						Notifications: pulumi.StringArray{
							pulumi.String("string"),
						},
						ParameterizedBody:    pulumi.String("string"),
						ParameterizedSubject: pulumi.String("string"),
						Parameters: &signalfx.SloTargetAlertRuleRuleParametersArgs{
							BurnRateThreshold1:     pulumi.Float64(0),
							BurnRateThreshold2:     pulumi.Float64(0),
							FireLasting:            pulumi.String("string"),
							LongWindow1:            pulumi.String("string"),
							LongWindow2:            pulumi.String("string"),
							PercentErrorBudgetLeft: pulumi.Float64(0),
							PercentOfLasting:       pulumi.Float64(0),
							ShortWindow1:           pulumi.String("string"),
							ShortWindow2:           pulumi.String("string"),
						},
						RunbookUrl: pulumi.String("string"),
						Tip:        pulumi.String("string"),
					},
				},
				Type: pulumi.String("string"),
			},
		},
		Slo:              pulumi.Float64(0),
		Type:             pulumi.String("string"),
		CompliancePeriod: pulumi.String("string"),
		CycleStart:       pulumi.String("string"),
		CycleType:        pulumi.String("string"),
	},
	Type:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var sloResource = new Slo("sloResource", SloArgs.builder()
    .input(SloInputArgs.builder()
        .programText("string")
        .goodEventsLabel("string")
        .totalEventsLabel("string")
        .build())
    .target(SloTargetArgs.builder()
        .alertRules(SloTargetAlertRuleArgs.builder()
            .rules(SloTargetAlertRuleRuleArgs.builder()
                .severity("string")
                .description("string")
                .disabled(false)
                .notifications("string")
                .parameterizedBody("string")
                .parameterizedSubject("string")
                .parameters(SloTargetAlertRuleRuleParametersArgs.builder()
                    .burnRateThreshold1(0)
                    .burnRateThreshold2(0)
                    .fireLasting("string")
                    .longWindow1("string")
                    .longWindow2("string")
                    .percentErrorBudgetLeft(0)
                    .percentOfLasting(0)
                    .shortWindow1("string")
                    .shortWindow2("string")
                    .build())
                .runbookUrl("string")
                .tip("string")
                .build())
            .type("string")
            .build())
        .slo(0)
        .type("string")
        .compliancePeriod("string")
        .cycleStart("string")
        .cycleType("string")
        .build())
    .type("string")
    .description("string")
    .name("string")
    .build());

    slo_resource = signalfx.Slo("sloResource",
    input=signalfx.SloInputArgs(
        program_text="string",
        good_events_label="string",
        total_events_label="string",
    ),
    target=signalfx.SloTargetArgs(
        alert_rules=[signalfx.SloTargetAlertRuleArgs(
            rules=[signalfx.SloTargetAlertRuleRuleArgs(
                severity="string",
                description="string",
                disabled=False,
                notifications=["string"],
                parameterized_body="string",
                parameterized_subject="string",
                parameters=signalfx.SloTargetAlertRuleRuleParametersArgs(
                    burn_rate_threshold1=0,
                    burn_rate_threshold2=0,
                    fire_lasting="string",
                    long_window1="string",
                    long_window2="string",
                    percent_error_budget_left=0,
                    percent_of_lasting=0,
                    short_window1="string",
                    short_window2="string",
                ),
                runbook_url="string",
                tip="string",
            )],
            type="string",
        )],
        slo=0,
        type="string",
        compliance_period="string",
        cycle_start="string",
        cycle_type="string",
    ),
    type="string",
    description="string",
    name="string")

    const sloResource = new signalfx.Slo("sloResource", {
    input: {
        programText: "string",
        goodEventsLabel: "string",
        totalEventsLabel: "string",
    },
    target: {
        alertRules: [{
            rules: [{
                severity: "string",
                description: "string",
                disabled: false,
                notifications: ["string"],
                parameterizedBody: "string",
                parameterizedSubject: "string",
                parameters: {
                    burnRateThreshold1: 0,
                    burnRateThreshold2: 0,
                    fireLasting: "string",
                    longWindow1: "string",
                    longWindow2: "string",
                    percentErrorBudgetLeft: 0,
                    percentOfLasting: 0,
                    shortWindow1: "string",
                    shortWindow2: "string",
                },
                runbookUrl: "string",
                tip: "string",
            }],
            type: "string",
        }],
        slo: 0,
        type: "string",
        compliancePeriod: "string",
        cycleStart: "string",
        cycleType: "string",
    },
    type: "string",
    description: "string",
    name: "string",
});

    type: signalfx:Slo
properties:
    description: string
    input:
        goodEventsLabel: string
        programText: string
        totalEventsLabel: string
    name: string
    target:
        alertRules:
            - rules:
                - description: string
                  disabled: false
                  notifications:
                    - string
                  parameterizedBody: string
                  parameterizedSubject: string
                  parameters:
                    burnRateThreshold1: 0
                    burnRateThreshold2: 0
                    fireLasting: string
                    longWindow1: string
                    longWindow2: string
                    percentErrorBudgetLeft: 0
                    percentOfLasting: 0
                    shortWindow1: string
                    shortWindow2: string
                  runbookUrl: string
                  severity: string
                  tip: string
              type: string
        compliancePeriod: string
        cycleStart: string
        cycleType: string
        slo: 0
        type: string
    type: string

    Slo Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Slo resource accepts the following input properties:

    Input Pulumi.SignalFx.Inputs.SloInput
    Properties to configure an SLO object inputs
    Target Pulumi.SignalFx.Inputs.SloTarget
    Define target value of the service level indicator in the appropriate time period.
    Type string
    Type of the SLO. Currently just: "RequestBased" is supported.
    Description string
    Description of the SLO.
    Name string
    Name of the SLO. Each SLO name must be unique within an organization.
    Input SloInputTypeArgs
    Properties to configure an SLO object inputs
    Target SloTargetArgs
    Define target value of the service level indicator in the appropriate time period.
    Type string
    Type of the SLO. Currently just: "RequestBased" is supported.
    Description string
    Description of the SLO.
    Name string
    Name of the SLO. Each SLO name must be unique within an organization.
    input SloInput
    Properties to configure an SLO object inputs
    target SloTarget
    Define target value of the service level indicator in the appropriate time period.
    type String
    Type of the SLO. Currently just: "RequestBased" is supported.
    description String
    Description of the SLO.
    name String
    Name of the SLO. Each SLO name must be unique within an organization.
    input SloInput
    Properties to configure an SLO object inputs
    target SloTarget
    Define target value of the service level indicator in the appropriate time period.
    type string
    Type of the SLO. Currently just: "RequestBased" is supported.
    description string
    Description of the SLO.
    name string
    Name of the SLO. Each SLO name must be unique within an organization.
    input SloInputArgs
    Properties to configure an SLO object inputs
    target SloTargetArgs
    Define target value of the service level indicator in the appropriate time period.
    type str
    Type of the SLO. Currently just: "RequestBased" is supported.
    description str
    Description of the SLO.
    name str
    Name of the SLO. Each SLO name must be unique within an organization.
    input Property Map
    Properties to configure an SLO object inputs
    target Property Map
    Define target value of the service level indicator in the appropriate time period.
    type String
    Type of the SLO. Currently just: "RequestBased" is supported.
    description String
    Description of the SLO.
    name String
    Name of the SLO. Each SLO name must be unique within an organization.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Slo resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Slo Resource

    Get an existing Slo resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SloState, opts?: CustomResourceOptions): Slo
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        input: Optional[SloInputArgs] = None,
        name: Optional[str] = None,
        target: Optional[SloTargetArgs] = None,
        type: Optional[str] = None) -> Slo
    func GetSlo(ctx *Context, name string, id IDInput, state *SloState, opts ...ResourceOption) (*Slo, error)
    public static Slo Get(string name, Input<string> id, SloState? state, CustomResourceOptions? opts = null)
    public static Slo get(String name, Output<String> id, SloState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the SLO.
    Input Pulumi.SignalFx.Inputs.SloInput
    Properties to configure an SLO object inputs
    Name string
    Name of the SLO. Each SLO name must be unique within an organization.
    Target Pulumi.SignalFx.Inputs.SloTarget
    Define target value of the service level indicator in the appropriate time period.
    Type string
    Type of the SLO. Currently just: "RequestBased" is supported.
    Description string
    Description of the SLO.
    Input SloInputTypeArgs
    Properties to configure an SLO object inputs
    Name string
    Name of the SLO. Each SLO name must be unique within an organization.
    Target SloTargetArgs
    Define target value of the service level indicator in the appropriate time period.
    Type string
    Type of the SLO. Currently just: "RequestBased" is supported.
    description String
    Description of the SLO.
    input SloInput
    Properties to configure an SLO object inputs
    name String
    Name of the SLO. Each SLO name must be unique within an organization.
    target SloTarget
    Define target value of the service level indicator in the appropriate time period.
    type String
    Type of the SLO. Currently just: "RequestBased" is supported.
    description string
    Description of the SLO.
    input SloInput
    Properties to configure an SLO object inputs
    name string
    Name of the SLO. Each SLO name must be unique within an organization.
    target SloTarget
    Define target value of the service level indicator in the appropriate time period.
    type string
    Type of the SLO. Currently just: "RequestBased" is supported.
    description str
    Description of the SLO.
    input SloInputArgs
    Properties to configure an SLO object inputs
    name str
    Name of the SLO. Each SLO name must be unique within an organization.
    target SloTargetArgs
    Define target value of the service level indicator in the appropriate time period.
    type str
    Type of the SLO. Currently just: "RequestBased" is supported.
    description String
    Description of the SLO.
    input Property Map
    Properties to configure an SLO object inputs
    name String
    Name of the SLO. Each SLO name must be unique within an organization.
    target Property Map
    Define target value of the service level indicator in the appropriate time period.
    type String
    Type of the SLO. Currently just: "RequestBased" is supported.

    Supporting Types

    SloInput, SloInputArgs

    ProgramText string
    SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
    GoodEventsLabel string
    Label used in "program_text" that refers to the data block which contains the stream of successful events
    TotalEventsLabel string
    Label used in "program_text" that refers to the data block which contains the stream of total events
    ProgramText string
    SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
    GoodEventsLabel string
    Label used in "program_text" that refers to the data block which contains the stream of successful events
    TotalEventsLabel string
    Label used in "program_text" that refers to the data block which contains the stream of total events
    programText String
    SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
    goodEventsLabel String
    Label used in "program_text" that refers to the data block which contains the stream of successful events
    totalEventsLabel String
    Label used in "program_text" that refers to the data block which contains the stream of total events
    programText string
    SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
    goodEventsLabel string
    Label used in "program_text" that refers to the data block which contains the stream of successful events
    totalEventsLabel string
    Label used in "program_text" that refers to the data block which contains the stream of total events
    program_text str
    SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
    good_events_label str
    Label used in "program_text" that refers to the data block which contains the stream of successful events
    total_events_label str
    Label used in "program_text" that refers to the data block which contains the stream of total events
    programText String
    SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
    goodEventsLabel String
    Label used in "program_text" that refers to the data block which contains the stream of successful events
    totalEventsLabel String
    Label used in "program_text" that refers to the data block which contains the stream of total events

    SloTarget, SloTargetArgs

    AlertRules List<Pulumi.SignalFx.Inputs.SloTargetAlertRule>
    List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
    Slo double
    Target value in the form of a percentage
    Type string
    SLO target type can be the following type: "RollingWindow", "CalendarWindow"
    CompliancePeriod string
    Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
    CycleStart string
    It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
    CycleType string
    The cycle type of the calendar window, e.g. week, month.
    AlertRules []SloTargetAlertRule
    List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
    Slo float64
    Target value in the form of a percentage
    Type string
    SLO target type can be the following type: "RollingWindow", "CalendarWindow"
    CompliancePeriod string
    Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
    CycleStart string
    It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
    CycleType string
    The cycle type of the calendar window, e.g. week, month.
    alertRules List<SloTargetAlertRule>
    List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
    slo Double
    Target value in the form of a percentage
    type String
    SLO target type can be the following type: "RollingWindow", "CalendarWindow"
    compliancePeriod String
    Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
    cycleStart String
    It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
    cycleType String
    The cycle type of the calendar window, e.g. week, month.
    alertRules SloTargetAlertRule[]
    List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
    slo number
    Target value in the form of a percentage
    type string
    SLO target type can be the following type: "RollingWindow", "CalendarWindow"
    compliancePeriod string
    Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
    cycleStart string
    It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
    cycleType string
    The cycle type of the calendar window, e.g. week, month.
    alert_rules Sequence[SloTargetAlertRule]
    List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
    slo float
    Target value in the form of a percentage
    type str
    SLO target type can be the following type: "RollingWindow", "CalendarWindow"
    compliance_period str
    Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
    cycle_start str
    It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
    cycle_type str
    The cycle type of the calendar window, e.g. week, month.
    alertRules List<Property Map>
    List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
    slo Number
    Target value in the form of a percentage
    type String
    SLO target type can be the following type: "RollingWindow", "CalendarWindow"
    compliancePeriod String
    Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
    cycleStart String
    It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
    cycleType String
    The cycle type of the calendar window, e.g. week, month.

    SloTargetAlertRule, SloTargetAlertRuleArgs

    Rules List<Pulumi.SignalFx.Inputs.SloTargetAlertRuleRule>
    Set of rules used for alerting.
    Type string
    SLO alert rule can be one of the following types: BREACH, ERROR_BUDGET_LEFT, BURN_RATE. Within an SLO object, you can only specify one SLO alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See SLO alerts for more info.
    Rules []SloTargetAlertRuleRule
    Set of rules used for alerting.
    Type string
    SLO alert rule can be one of the following types: BREACH, ERROR_BUDGET_LEFT, BURN_RATE. Within an SLO object, you can only specify one SLO alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See SLO alerts for more info.
    rules List<SloTargetAlertRuleRule>
    Set of rules used for alerting.
    type String
    SLO alert rule can be one of the following types: BREACH, ERROR_BUDGET_LEFT, BURN_RATE. Within an SLO object, you can only specify one SLO alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See SLO alerts for more info.
    rules SloTargetAlertRuleRule[]
    Set of rules used for alerting.
    type string
    SLO alert rule can be one of the following types: BREACH, ERROR_BUDGET_LEFT, BURN_RATE. Within an SLO object, you can only specify one SLO alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See SLO alerts for more info.
    rules Sequence[SloTargetAlertRuleRule]
    Set of rules used for alerting.
    type str
    SLO alert rule can be one of the following types: BREACH, ERROR_BUDGET_LEFT, BURN_RATE. Within an SLO object, you can only specify one SLO alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See SLO alerts for more info.
    rules List<Property Map>
    Set of rules used for alerting.
    type String
    SLO alert rule can be one of the following types: BREACH, ERROR_BUDGET_LEFT, BURN_RATE. Within an SLO object, you can only specify one SLO alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See SLO alerts for more info.

    SloTargetAlertRuleRule, SloTargetAlertRuleRuleArgs

    Severity string
    The severity of the rule, must be one of: "Critical", "Major", "Minor", "Warning", "Info".
    Description string
    Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
    Disabled bool
    When true, notifications and events will not be generated for the detect label. false by default.
    Notifications List<string>
    List of strings specifying where notifications will be sent when an incident occurs. See Create SLO for more info.
    ParameterizedBody string
    Custom notification message body when an alert is triggered. See Alert message for more info.
    ParameterizedSubject string
    Custom notification message subject when an alert is triggered. See Alert message for more info.
    Parameters Pulumi.SignalFx.Inputs.SloTargetAlertRuleRuleParameters
    Parameters for the SLO alert rule. Each SLO alert rule type accepts different parameters. If not specified, default parameters are used.
    RunbookUrl string
    URL of page to consult when an alert is triggered. This can be used with custom notification messages.
    Tip string
    Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
    Severity string
    The severity of the rule, must be one of: "Critical", "Major", "Minor", "Warning", "Info".
    Description string
    Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
    Disabled bool
    When true, notifications and events will not be generated for the detect label. false by default.
    Notifications []string
    List of strings specifying where notifications will be sent when an incident occurs. See Create SLO for more info.
    ParameterizedBody string
    Custom notification message body when an alert is triggered. See Alert message for more info.
    ParameterizedSubject string
    Custom notification message subject when an alert is triggered. See Alert message for more info.
    Parameters SloTargetAlertRuleRuleParameters
    Parameters for the SLO alert rule. Each SLO alert rule type accepts different parameters. If not specified, default parameters are used.
    RunbookUrl string
    URL of page to consult when an alert is triggered. This can be used with custom notification messages.
    Tip string
    Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
    severity String
    The severity of the rule, must be one of: "Critical", "Major", "Minor", "Warning", "Info".
    description String
    Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
    disabled Boolean
    When true, notifications and events will not be generated for the detect label. false by default.
    notifications List<String>
    List of strings specifying where notifications will be sent when an incident occurs. See Create SLO for more info.
    parameterizedBody String
    Custom notification message body when an alert is triggered. See Alert message for more info.
    parameterizedSubject String
    Custom notification message subject when an alert is triggered. See Alert message for more info.
    parameters SloTargetAlertRuleRuleParameters
    Parameters for the SLO alert rule. Each SLO alert rule type accepts different parameters. If not specified, default parameters are used.
    runbookUrl String
    URL of page to consult when an alert is triggered. This can be used with custom notification messages.
    tip String
    Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
    severity string
    The severity of the rule, must be one of: "Critical", "Major", "Minor", "Warning", "Info".
    description string
    Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
    disabled boolean
    When true, notifications and events will not be generated for the detect label. false by default.
    notifications string[]
    List of strings specifying where notifications will be sent when an incident occurs. See Create SLO for more info.
    parameterizedBody string
    Custom notification message body when an alert is triggered. See Alert message for more info.
    parameterizedSubject string
    Custom notification message subject when an alert is triggered. See Alert message for more info.
    parameters SloTargetAlertRuleRuleParameters
    Parameters for the SLO alert rule. Each SLO alert rule type accepts different parameters. If not specified, default parameters are used.
    runbookUrl string
    URL of page to consult when an alert is triggered. This can be used with custom notification messages.
    tip string
    Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
    severity str
    The severity of the rule, must be one of: "Critical", "Major", "Minor", "Warning", "Info".
    description str
    Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
    disabled bool
    When true, notifications and events will not be generated for the detect label. false by default.
    notifications Sequence[str]
    List of strings specifying where notifications will be sent when an incident occurs. See Create SLO for more info.
    parameterized_body str
    Custom notification message body when an alert is triggered. See Alert message for more info.
    parameterized_subject str
    Custom notification message subject when an alert is triggered. See Alert message for more info.
    parameters SloTargetAlertRuleRuleParameters
    Parameters for the SLO alert rule. Each SLO alert rule type accepts different parameters. If not specified, default parameters are used.
    runbook_url str
    URL of page to consult when an alert is triggered. This can be used with custom notification messages.
    tip str
    Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
    severity String
    The severity of the rule, must be one of: "Critical", "Major", "Minor", "Warning", "Info".
    description String
    Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
    disabled Boolean
    When true, notifications and events will not be generated for the detect label. false by default.
    notifications List<String>
    List of strings specifying where notifications will be sent when an incident occurs. See Create SLO for more info.
    parameterizedBody String
    Custom notification message body when an alert is triggered. See Alert message for more info.
    parameterizedSubject String
    Custom notification message subject when an alert is triggered. See Alert message for more info.
    parameters Property Map
    Parameters for the SLO alert rule. Each SLO alert rule type accepts different parameters. If not specified, default parameters are used.
    runbookUrl String
    URL of page to consult when an alert is triggered. This can be used with custom notification messages.
    tip String
    Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.

    SloTargetAlertRuleRuleParameters, SloTargetAlertRuleRuleParametersArgs

    BurnRateThreshold1 double
    Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_1" parameter. See SLO alerts for more info.
    BurnRateThreshold2 double
    Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_2" parameter. See SLO alerts for more info.
    FireLasting string
    Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the fireLasting parameter. Default: "5m"
    LongWindow1 string
    Long window 1 used in burn rate alert calculation. This value must be longer than "short_window_1" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_1" parameter. See SLO alerts for more info.
    LongWindow2 string
    Long window 2 used in burn rate alert calculation. This value must be longer than "short_window_2" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_2" parameter. See SLO alerts for more info.
    PercentErrorBudgetLeft double
    Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: "ERROR_BUDGET_LEFT" alert rules use the "percent_error_budget_left" parameter. Default: 100
    PercentOfLasting double
    Percentage of the "fire_lasting" duration that the alert condition is met before the alert is triggered. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the "percent_of_lasting" parameter. Default: 100
    ShortWindow1 string
    Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_1". Note: "BURN_RATE" alert rules use the "short_window_1" parameter. See SLO alerts for more info.
    ShortWindow2 string
    Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_2". Note: "BURN_RATE" alert rules use the "short_window_2" parameter. See SLO alerts for more info.
    BurnRateThreshold1 float64
    Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_1" parameter. See SLO alerts for more info.
    BurnRateThreshold2 float64
    Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_2" parameter. See SLO alerts for more info.
    FireLasting string
    Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the fireLasting parameter. Default: "5m"
    LongWindow1 string
    Long window 1 used in burn rate alert calculation. This value must be longer than "short_window_1" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_1" parameter. See SLO alerts for more info.
    LongWindow2 string
    Long window 2 used in burn rate alert calculation. This value must be longer than "short_window_2" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_2" parameter. See SLO alerts for more info.
    PercentErrorBudgetLeft float64
    Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: "ERROR_BUDGET_LEFT" alert rules use the "percent_error_budget_left" parameter. Default: 100
    PercentOfLasting float64
    Percentage of the "fire_lasting" duration that the alert condition is met before the alert is triggered. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the "percent_of_lasting" parameter. Default: 100
    ShortWindow1 string
    Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_1". Note: "BURN_RATE" alert rules use the "short_window_1" parameter. See SLO alerts for more info.
    ShortWindow2 string
    Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_2". Note: "BURN_RATE" alert rules use the "short_window_2" parameter. See SLO alerts for more info.
    burnRateThreshold1 Double
    Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_1" parameter. See SLO alerts for more info.
    burnRateThreshold2 Double
    Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_2" parameter. See SLO alerts for more info.
    fireLasting String
    Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the fireLasting parameter. Default: "5m"
    longWindow1 String
    Long window 1 used in burn rate alert calculation. This value must be longer than "short_window_1" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_1" parameter. See SLO alerts for more info.
    longWindow2 String
    Long window 2 used in burn rate alert calculation. This value must be longer than "short_window_2" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_2" parameter. See SLO alerts for more info.
    percentErrorBudgetLeft Double
    Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: "ERROR_BUDGET_LEFT" alert rules use the "percent_error_budget_left" parameter. Default: 100
    percentOfLasting Double
    Percentage of the "fire_lasting" duration that the alert condition is met before the alert is triggered. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the "percent_of_lasting" parameter. Default: 100
    shortWindow1 String
    Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_1". Note: "BURN_RATE" alert rules use the "short_window_1" parameter. See SLO alerts for more info.
    shortWindow2 String
    Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_2". Note: "BURN_RATE" alert rules use the "short_window_2" parameter. See SLO alerts for more info.
    burnRateThreshold1 number
    Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_1" parameter. See SLO alerts for more info.
    burnRateThreshold2 number
    Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_2" parameter. See SLO alerts for more info.
    fireLasting string
    Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the fireLasting parameter. Default: "5m"
    longWindow1 string
    Long window 1 used in burn rate alert calculation. This value must be longer than "short_window_1" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_1" parameter. See SLO alerts for more info.
    longWindow2 string
    Long window 2 used in burn rate alert calculation. This value must be longer than "short_window_2" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_2" parameter. See SLO alerts for more info.
    percentErrorBudgetLeft number
    Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: "ERROR_BUDGET_LEFT" alert rules use the "percent_error_budget_left" parameter. Default: 100
    percentOfLasting number
    Percentage of the "fire_lasting" duration that the alert condition is met before the alert is triggered. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the "percent_of_lasting" parameter. Default: 100
    shortWindow1 string
    Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_1". Note: "BURN_RATE" alert rules use the "short_window_1" parameter. See SLO alerts for more info.
    shortWindow2 string
    Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_2". Note: "BURN_RATE" alert rules use the "short_window_2" parameter. See SLO alerts for more info.
    burn_rate_threshold1 float
    Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_1" parameter. See SLO alerts for more info.
    burn_rate_threshold2 float
    Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_2" parameter. See SLO alerts for more info.
    fire_lasting str
    Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the fireLasting parameter. Default: "5m"
    long_window1 str
    Long window 1 used in burn rate alert calculation. This value must be longer than "short_window_1" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_1" parameter. See SLO alerts for more info.
    long_window2 str
    Long window 2 used in burn rate alert calculation. This value must be longer than "short_window_2" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_2" parameter. See SLO alerts for more info.
    percent_error_budget_left float
    Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: "ERROR_BUDGET_LEFT" alert rules use the "percent_error_budget_left" parameter. Default: 100
    percent_of_lasting float
    Percentage of the "fire_lasting" duration that the alert condition is met before the alert is triggered. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the "percent_of_lasting" parameter. Default: 100
    short_window1 str
    Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_1". Note: "BURN_RATE" alert rules use the "short_window_1" parameter. See SLO alerts for more info.
    short_window2 str
    Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_2". Note: "BURN_RATE" alert rules use the "short_window_2" parameter. See SLO alerts for more info.
    burnRateThreshold1 Number
    Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_1" parameter. See SLO alerts for more info.
    burnRateThreshold2 Number
    Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: "BURN_RATE" alert rules use the "burn_rate_threshold_2" parameter. See SLO alerts for more info.
    fireLasting String
    Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the fireLasting parameter. Default: "5m"
    longWindow1 String
    Long window 1 used in burn rate alert calculation. This value must be longer than "short_window_1" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_1" parameter. See SLO alerts for more info.
    longWindow2 String
    Long window 2 used in burn rate alert calculation. This value must be longer than "short_window_2" and shorter than 90 days. Note: "BURN_RATE" alert rules use the "long_window_2" parameter. See SLO alerts for more info.
    percentErrorBudgetLeft Number
    Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: "ERROR_BUDGET_LEFT" alert rules use the "percent_error_budget_left" parameter. Default: 100
    percentOfLasting Number
    Percentage of the "fire_lasting" duration that the alert condition is met before the alert is triggered. Note: "BREACH" and "ERROR_BUDGET_LEFT" alert rules use the "percent_of_lasting" parameter. Default: 100
    shortWindow1 String
    Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_1". Note: "BURN_RATE" alert rules use the "short_window_1" parameter. See SLO alerts for more info.
    shortWindow2 String
    Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of "long_window_2". Note: "BURN_RATE" alert rules use the "short_window_2" parameter. See SLO alerts for more info.

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.5 published on Wednesday, May 29, 2024 by Pulumi
    pulumi/pulumi-signalfx