1. Packages
  2. Signalfx Provider
  3. API Docs
  4. Detector
SignalFx v7.4.0 published on Monday, Nov 18, 2024 by Pulumi

signalfx.Detector

Explore with Pulumi AI

signalfx logo
SignalFx v7.4.0 published on Monday, Nov 18, 2024 by Pulumi

    Provides a Splunk Observability Cloud detector resource. This can be used to create and manage detectors.

    If you’re interested in using Splunk Observability Cloud detector features such as Historical Anomaly, Resource Running Out, or others, consider building them in the UI first and then use the “Show SignalFlow” feature to extract the value for program_text. You can also see the documentation for detector functions in signalflow-library.

    NOTE When you want to change or remove write permissions for a user other than yourself regarding detectors, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See Operations that require a session token for an administrator.

    Example

    import * as pulumi from "@pulumi/pulumi";
    import * as signalfx from "@pulumi/signalfx";
    
    const config = new pulumi.Config();
    const clusters = config.getObject("clusters") || [
        "clusterA",
        "clusterB",
    ];
    const applicationDelay: signalfx.Detector[] = [];
    for (const range = {value: 0}; range.value < clusters.length; range.value++) {
        applicationDelay.push(new signalfx.Detector(`application_delay-${range.value}`, {
            name: ` max average delay - ${clusters[range.value]}`,
            description: `your application is slow - ${clusters[range.value]}`,
            maxDelay: 30,
            tags: [
                "app-backend",
                "staging",
            ],
            authorizedWriterTeams: [mycoolteam.id],
            authorizedWriterUsers: ["abc123"],
            programText: `signal = data('app.delay', filter('cluster','${clusters[range.value]}'), extrapolation='last_value', maxExtrapolations=5).max()
    detect(when(signal > 60, '5m')).publish('Processing old messages 5m')
    detect(when(signal > 60, '30m')).publish('Processing old messages 30m')
    `,
            rules: [
                {
                    description: "maximum > 60 for 5m",
                    severity: "Warning",
                    detectLabel: "Processing old messages 5m",
                    notifications: ["Email,foo-alerts@bar.com"],
                },
                {
                    description: "maximum > 60 for 30m",
                    severity: "Critical",
                    detectLabel: "Processing old messages 30m",
                    notifications: ["Email,foo-alerts@bar.com"],
                },
            ],
        }));
    }
    
    import pulumi
    import pulumi_signalfx as signalfx
    
    config = pulumi.Config()
    clusters = config.get_object("clusters")
    if clusters is None:
        clusters = [
            "clusterA",
            "clusterB",
        ]
    application_delay = []
    for range in [{"value": i} for i in range(0, len(clusters))]:
        application_delay.append(signalfx.Detector(f"application_delay-{range['value']}",
            name=f" max average delay - {clusters[range['value']]}",
            description=f"your application is slow - {clusters[range['value']]}",
            max_delay=30,
            tags=[
                "app-backend",
                "staging",
            ],
            authorized_writer_teams=[mycoolteam["id"]],
            authorized_writer_users=["abc123"],
            program_text=f"""signal = data('app.delay', filter('cluster','{clusters[range["value"]]}'), extrapolation='last_value', maxExtrapolations=5).max()
    detect(when(signal > 60, '5m')).publish('Processing old messages 5m')
    detect(when(signal > 60, '30m')).publish('Processing old messages 30m')
    """,
            rules=[
                {
                    "description": "maximum > 60 for 5m",
                    "severity": "Warning",
                    "detect_label": "Processing old messages 5m",
                    "notifications": ["Email,foo-alerts@bar.com"],
                },
                {
                    "description": "maximum > 60 for 30m",
                    "severity": "Critical",
                    "detect_label": "Processing old messages 30m",
                    "notifications": ["Email,foo-alerts@bar.com"],
                },
            ]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		clusters := []string{
    			"clusterA",
    			"clusterB",
    		}
    		if param := cfg.GetObject("clusters"); param != nil {
    			clusters = param
    		}
    		var applicationDelay []*signalfx.Detector
    		for index := 0; index < len(clusters); index++ {
    			key0 := index
    			val0 := index
    			__res, err := signalfx.NewDetector(ctx, fmt.Sprintf("application_delay-%v", key0), &signalfx.DetectorArgs{
    				Name:        pulumi.Sprintf(" max average delay - %v", clusters[val0]),
    				Description: pulumi.Sprintf("your application is slow - %v", clusters[val0]),
    				MaxDelay:    pulumi.Int(30),
    				Tags: pulumi.StringArray{
    					pulumi.String("app-backend"),
    					pulumi.String("staging"),
    				},
    				AuthorizedWriterTeams: pulumi.StringArray{
    					mycoolteam.Id,
    				},
    				AuthorizedWriterUsers: pulumi.StringArray{
    					pulumi.String("abc123"),
    				},
    				ProgramText: pulumi.Sprintf("signal = data('app.delay', filter('cluster','%v'), extrapolation='last_value', maxExtrapolations=5).max()\ndetect(when(signal > 60, '5m')).publish('Processing old messages 5m')\ndetect(when(signal > 60, '30m')).publish('Processing old messages 30m')\n", clusters[val0]),
    				Rules: signalfx.DetectorRuleArray{
    					&signalfx.DetectorRuleArgs{
    						Description: pulumi.String("maximum > 60 for 5m"),
    						Severity:    pulumi.String("Warning"),
    						DetectLabel: pulumi.String("Processing old messages 5m"),
    						Notifications: pulumi.StringArray{
    							pulumi.String("Email,foo-alerts@bar.com"),
    						},
    					},
    					&signalfx.DetectorRuleArgs{
    						Description: pulumi.String("maximum > 60 for 30m"),
    						Severity:    pulumi.String("Critical"),
    						DetectLabel: pulumi.String("Processing old messages 30m"),
    						Notifications: pulumi.StringArray{
    							pulumi.String("Email,foo-alerts@bar.com"),
    						},
    					},
    				},
    			})
    			if err != nil {
    				return err
    			}
    			applicationDelay = append(applicationDelay, __res)
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SignalFx = Pulumi.SignalFx;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var clusters = config.GetObject<dynamic>("clusters") ?? new[]
        {
            "clusterA",
            "clusterB",
        };
        var applicationDelay = new List<SignalFx.Detector>();
        for (var rangeIndex = 0; rangeIndex < clusters.Length; rangeIndex++)
        {
            var range = new { Value = rangeIndex };
            applicationDelay.Add(new SignalFx.Detector($"application_delay-{range.Value}", new()
            {
                Name = $" max average delay - {clusters[range.Value]}",
                Description = $"your application is slow - {clusters[range.Value]}",
                MaxDelay = 30,
                Tags = new[]
                {
                    "app-backend",
                    "staging",
                },
                AuthorizedWriterTeams = new[]
                {
                    mycoolteam.Id,
                },
                AuthorizedWriterUsers = new[]
                {
                    "abc123",
                },
                ProgramText = @$"signal = data('app.delay', filter('cluster','{clusters[range.Value]}'), extrapolation='last_value', maxExtrapolations=5).max()
    detect(when(signal > 60, '5m')).publish('Processing old messages 5m')
    detect(when(signal > 60, '30m')).publish('Processing old messages 30m')
    ",
                Rules = new[]
                {
                    new SignalFx.Inputs.DetectorRuleArgs
                    {
                        Description = "maximum > 60 for 5m",
                        Severity = "Warning",
                        DetectLabel = "Processing old messages 5m",
                        Notifications = new[]
                        {
                            "Email,foo-alerts@bar.com",
                        },
                    },
                    new SignalFx.Inputs.DetectorRuleArgs
                    {
                        Description = "maximum > 60 for 30m",
                        Severity = "Critical",
                        DetectLabel = "Processing old messages 30m",
                        Notifications = new[]
                        {
                            "Email,foo-alerts@bar.com",
                        },
                    },
                },
            }));
        }
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.signalfx.Detector;
    import com.pulumi.signalfx.DetectorArgs;
    import com.pulumi.signalfx.inputs.DetectorRuleArgs;
    import com.pulumi.codegen.internal.KeyedValue;
    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) {
            final var config = ctx.config();
            final var clusters = config.get("clusters").orElse(        
                "clusterA",
                "clusterB");
            for (var i = 0; i < clusters.length(); i++) {
                new Detector("applicationDelay-" + i, DetectorArgs.builder()
                    .name(String.format(" max average delay - %s", clusters[range.value()]))
                    .description(String.format("your application is slow - %s", clusters[range.value()]))
                    .maxDelay(30)
                    .tags(                
                        "app-backend",
                        "staging")
                    .authorizedWriterTeams(mycoolteam.id())
                    .authorizedWriterUsers("abc123")
                    .programText("""
    signal = data('app.delay', filter('cluster','%s'), extrapolation='last_value', maxExtrapolations=5).max()
    detect(when(signal > 60, '5m')).publish('Processing old messages 5m')
    detect(when(signal > 60, '30m')).publish('Processing old messages 30m')
    ", clusters[range.value()]))
                    .rules(                
                        DetectorRuleArgs.builder()
                            .description("maximum > 60 for 5m")
                            .severity("Warning")
                            .detectLabel("Processing old messages 5m")
                            .notifications("Email,foo-alerts@bar.com")
                            .build(),
                        DetectorRuleArgs.builder()
                            .description("maximum > 60 for 30m")
                            .severity("Critical")
                            .detectLabel("Processing old messages 30m")
                            .notifications("Email,foo-alerts@bar.com")
                            .build())
                    .build());
    
            
    }
        }
    }
    
    Coming soon!
    

    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 Detector Resource

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

    Constructor syntax

    new Detector(name: string, args: DetectorArgs, opts?: CustomResourceOptions);
    @overload
    def Detector(resource_name: str,
                 args: DetectorArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Detector(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 program_text: Optional[str] = None,
                 rules: Optional[Sequence[DetectorRuleArgs]] = None,
                 end_time: Optional[int] = None,
                 authorized_writer_users: Optional[Sequence[str]] = None,
                 disable_sampling: Optional[bool] = None,
                 authorized_writer_teams: Optional[Sequence[str]] = None,
                 max_delay: Optional[int] = None,
                 min_delay: Optional[int] = None,
                 name: Optional[str] = None,
                 parent_detector_id: Optional[str] = None,
                 description: Optional[str] = None,
                 detector_origin: Optional[str] = None,
                 show_data_markers: Optional[bool] = None,
                 show_event_lines: Optional[bool] = None,
                 start_time: Optional[int] = None,
                 tags: Optional[Sequence[str]] = None,
                 teams: Optional[Sequence[str]] = None,
                 time_range: Optional[int] = None,
                 timezone: Optional[str] = None,
                 viz_options: Optional[Sequence[DetectorVizOptionArgs]] = None)
    func NewDetector(ctx *Context, name string, args DetectorArgs, opts ...ResourceOption) (*Detector, error)
    public Detector(string name, DetectorArgs args, CustomResourceOptions? opts = null)
    public Detector(String name, DetectorArgs args)
    public Detector(String name, DetectorArgs args, CustomResourceOptions options)
    
    type: signalfx:Detector
    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 DetectorArgs
    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 DetectorArgs
    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 DetectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DetectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DetectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var detectorResource = new SignalFx.Detector("detectorResource", new()
    {
        ProgramText = "string",
        Rules = new[]
        {
            new SignalFx.Inputs.DetectorRuleArgs
            {
                DetectLabel = "string",
                Severity = "string",
                Description = "string",
                Disabled = false,
                Notifications = new[]
                {
                    "string",
                },
                ParameterizedBody = "string",
                ParameterizedSubject = "string",
                RunbookUrl = "string",
                Tip = "string",
            },
        },
        EndTime = 0,
        AuthorizedWriterUsers = new[]
        {
            "string",
        },
        DisableSampling = false,
        AuthorizedWriterTeams = new[]
        {
            "string",
        },
        MaxDelay = 0,
        MinDelay = 0,
        Name = "string",
        ParentDetectorId = "string",
        Description = "string",
        DetectorOrigin = "string",
        ShowDataMarkers = false,
        ShowEventLines = false,
        StartTime = 0,
        Tags = new[]
        {
            "string",
        },
        Teams = new[]
        {
            "string",
        },
        TimeRange = 0,
        Timezone = "string",
        VizOptions = new[]
        {
            new SignalFx.Inputs.DetectorVizOptionArgs
            {
                Label = "string",
                Color = "string",
                DisplayName = "string",
                ValuePrefix = "string",
                ValueSuffix = "string",
                ValueUnit = "string",
            },
        },
    });
    
    example, err := signalfx.NewDetector(ctx, "detectorResource", &signalfx.DetectorArgs{
    	ProgramText: pulumi.String("string"),
    	Rules: signalfx.DetectorRuleArray{
    		&signalfx.DetectorRuleArgs{
    			DetectLabel: pulumi.String("string"),
    			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"),
    			RunbookUrl:           pulumi.String("string"),
    			Tip:                  pulumi.String("string"),
    		},
    	},
    	EndTime: pulumi.Int(0),
    	AuthorizedWriterUsers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DisableSampling: pulumi.Bool(false),
    	AuthorizedWriterTeams: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	MaxDelay:         pulumi.Int(0),
    	MinDelay:         pulumi.Int(0),
    	Name:             pulumi.String("string"),
    	ParentDetectorId: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	DetectorOrigin:   pulumi.String("string"),
    	ShowDataMarkers:  pulumi.Bool(false),
    	ShowEventLines:   pulumi.Bool(false),
    	StartTime:        pulumi.Int(0),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Teams: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TimeRange: pulumi.Int(0),
    	Timezone:  pulumi.String("string"),
    	VizOptions: signalfx.DetectorVizOptionArray{
    		&signalfx.DetectorVizOptionArgs{
    			Label:       pulumi.String("string"),
    			Color:       pulumi.String("string"),
    			DisplayName: pulumi.String("string"),
    			ValuePrefix: pulumi.String("string"),
    			ValueSuffix: pulumi.String("string"),
    			ValueUnit:   pulumi.String("string"),
    		},
    	},
    })
    
    var detectorResource = new Detector("detectorResource", DetectorArgs.builder()
        .programText("string")
        .rules(DetectorRuleArgs.builder()
            .detectLabel("string")
            .severity("string")
            .description("string")
            .disabled(false)
            .notifications("string")
            .parameterizedBody("string")
            .parameterizedSubject("string")
            .runbookUrl("string")
            .tip("string")
            .build())
        .endTime(0)
        .authorizedWriterUsers("string")
        .disableSampling(false)
        .authorizedWriterTeams("string")
        .maxDelay(0)
        .minDelay(0)
        .name("string")
        .parentDetectorId("string")
        .description("string")
        .detectorOrigin("string")
        .showDataMarkers(false)
        .showEventLines(false)
        .startTime(0)
        .tags("string")
        .teams("string")
        .timeRange(0)
        .timezone("string")
        .vizOptions(DetectorVizOptionArgs.builder()
            .label("string")
            .color("string")
            .displayName("string")
            .valuePrefix("string")
            .valueSuffix("string")
            .valueUnit("string")
            .build())
        .build());
    
    detector_resource = signalfx.Detector("detectorResource",
        program_text="string",
        rules=[{
            "detect_label": "string",
            "severity": "string",
            "description": "string",
            "disabled": False,
            "notifications": ["string"],
            "parameterized_body": "string",
            "parameterized_subject": "string",
            "runbook_url": "string",
            "tip": "string",
        }],
        end_time=0,
        authorized_writer_users=["string"],
        disable_sampling=False,
        authorized_writer_teams=["string"],
        max_delay=0,
        min_delay=0,
        name="string",
        parent_detector_id="string",
        description="string",
        detector_origin="string",
        show_data_markers=False,
        show_event_lines=False,
        start_time=0,
        tags=["string"],
        teams=["string"],
        time_range=0,
        timezone="string",
        viz_options=[{
            "label": "string",
            "color": "string",
            "display_name": "string",
            "value_prefix": "string",
            "value_suffix": "string",
            "value_unit": "string",
        }])
    
    const detectorResource = new signalfx.Detector("detectorResource", {
        programText: "string",
        rules: [{
            detectLabel: "string",
            severity: "string",
            description: "string",
            disabled: false,
            notifications: ["string"],
            parameterizedBody: "string",
            parameterizedSubject: "string",
            runbookUrl: "string",
            tip: "string",
        }],
        endTime: 0,
        authorizedWriterUsers: ["string"],
        disableSampling: false,
        authorizedWriterTeams: ["string"],
        maxDelay: 0,
        minDelay: 0,
        name: "string",
        parentDetectorId: "string",
        description: "string",
        detectorOrigin: "string",
        showDataMarkers: false,
        showEventLines: false,
        startTime: 0,
        tags: ["string"],
        teams: ["string"],
        timeRange: 0,
        timezone: "string",
        vizOptions: [{
            label: "string",
            color: "string",
            displayName: "string",
            valuePrefix: "string",
            valueSuffix: "string",
            valueUnit: "string",
        }],
    });
    
    type: signalfx:Detector
    properties:
        authorizedWriterTeams:
            - string
        authorizedWriterUsers:
            - string
        description: string
        detectorOrigin: string
        disableSampling: false
        endTime: 0
        maxDelay: 0
        minDelay: 0
        name: string
        parentDetectorId: string
        programText: string
        rules:
            - description: string
              detectLabel: string
              disabled: false
              notifications:
                - string
              parameterizedBody: string
              parameterizedSubject: string
              runbookUrl: string
              severity: string
              tip: string
        showDataMarkers: false
        showEventLines: false
        startTime: 0
        tags:
            - string
        teams:
            - string
        timeRange: 0
        timezone: string
        vizOptions:
            - color: string
              displayName: string
              label: string
              valuePrefix: string
              valueSuffix: string
              valueUnit: string
    

    Detector Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Detector resource accepts the following input properties:

    ProgramText string
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    Rules List<Pulumi.SignalFx.Inputs.DetectorRule>
    Set of rules used for alerting.
    AuthorizedWriterTeams List<string>
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    AuthorizedWriterUsers List<string>
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    Description string
    Description of the detector.
    DetectorOrigin string
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    DisableSampling bool
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    MaxDelay int
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    MinDelay int
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    Name string
    Name of the detector.
    ParentDetectorId string
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    ShowDataMarkers bool
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    ShowEventLines bool
    When true, the visualization will display a vertical line for each event trigger. false by default.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Tags List<string>
    Tags associated with the detector.
    Teams List<string>
    Team IDs to associate the detector to.
    TimeRange int
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    VizOptions List<Pulumi.SignalFx.Inputs.DetectorVizOption>
    Plot-level customization options, associated with a publish statement.
    ProgramText string
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    Rules []DetectorRuleArgs
    Set of rules used for alerting.
    AuthorizedWriterTeams []string
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    AuthorizedWriterUsers []string
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    Description string
    Description of the detector.
    DetectorOrigin string
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    DisableSampling bool
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    MaxDelay int
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    MinDelay int
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    Name string
    Name of the detector.
    ParentDetectorId string
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    ShowDataMarkers bool
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    ShowEventLines bool
    When true, the visualization will display a vertical line for each event trigger. false by default.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Tags []string
    Tags associated with the detector.
    Teams []string
    Team IDs to associate the detector to.
    TimeRange int
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    VizOptions []DetectorVizOptionArgs
    Plot-level customization options, associated with a publish statement.
    programText String
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules List<DetectorRule>
    Set of rules used for alerting.
    authorizedWriterTeams List<String>
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorizedWriterUsers List<String>
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description String
    Description of the detector.
    detectorOrigin String
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disableSampling Boolean
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    endTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    maxDelay Integer
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    minDelay Integer
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name String
    Name of the detector.
    parentDetectorId String
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    showDataMarkers Boolean
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    showEventLines Boolean
    When true, the visualization will display a vertical line for each event trigger. false by default.
    startTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags List<String>
    Tags associated with the detector.
    teams List<String>
    Team IDs to associate the detector to.
    timeRange Integer
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    vizOptions List<DetectorVizOption>
    Plot-level customization options, associated with a publish statement.
    programText string
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules DetectorRule[]
    Set of rules used for alerting.
    authorizedWriterTeams string[]
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorizedWriterUsers string[]
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description string
    Description of the detector.
    detectorOrigin string
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disableSampling boolean
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    endTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    maxDelay number
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    minDelay number
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name string
    Name of the detector.
    parentDetectorId string
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    showDataMarkers boolean
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    showEventLines boolean
    When true, the visualization will display a vertical line for each event trigger. false by default.
    startTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags string[]
    Tags associated with the detector.
    teams string[]
    Team IDs to associate the detector to.
    timeRange number
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    vizOptions DetectorVizOption[]
    Plot-level customization options, associated with a publish statement.
    program_text str
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules Sequence[DetectorRuleArgs]
    Set of rules used for alerting.
    authorized_writer_teams Sequence[str]
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorized_writer_users Sequence[str]
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description str
    Description of the detector.
    detector_origin str
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disable_sampling bool
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    end_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    max_delay int
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    min_delay int
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name str
    Name of the detector.
    parent_detector_id str
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    show_data_markers bool
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    show_event_lines bool
    When true, the visualization will display a vertical line for each event trigger. false by default.
    start_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags Sequence[str]
    Tags associated with the detector.
    teams Sequence[str]
    Team IDs to associate the detector to.
    time_range int
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone str
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    viz_options Sequence[DetectorVizOptionArgs]
    Plot-level customization options, associated with a publish statement.
    programText String
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules List<Property Map>
    Set of rules used for alerting.
    authorizedWriterTeams List<String>
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorizedWriterUsers List<String>
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description String
    Description of the detector.
    detectorOrigin String
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disableSampling Boolean
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    endTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    maxDelay Number
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    minDelay Number
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name String
    Name of the detector.
    parentDetectorId String
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    showDataMarkers Boolean
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    showEventLines Boolean
    When true, the visualization will display a vertical line for each event trigger. false by default.
    startTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags List<String>
    Tags associated with the detector.
    teams List<String>
    Team IDs to associate the detector to.
    timeRange Number
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    vizOptions List<Property Map>
    Plot-level customization options, associated with a publish statement.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LabelResolutions Dictionary<string, int>
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    Url string
    The URL of the detector.
    Id string
    The provider-assigned unique ID for this managed resource.
    LabelResolutions map[string]int
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    Url string
    The URL of the detector.
    id String
    The provider-assigned unique ID for this managed resource.
    labelResolutions Map<String,Integer>
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    url String
    The URL of the detector.
    id string
    The provider-assigned unique ID for this managed resource.
    labelResolutions {[key: string]: number}
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    url string
    The URL of the detector.
    id str
    The provider-assigned unique ID for this managed resource.
    label_resolutions Mapping[str, int]
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    url str
    The URL of the detector.
    id String
    The provider-assigned unique ID for this managed resource.
    labelResolutions Map<Number>
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    url String
    The URL of the detector.

    Look up Existing Detector Resource

    Get an existing Detector 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?: DetectorState, opts?: CustomResourceOptions): Detector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorized_writer_teams: Optional[Sequence[str]] = None,
            authorized_writer_users: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            detector_origin: Optional[str] = None,
            disable_sampling: Optional[bool] = None,
            end_time: Optional[int] = None,
            label_resolutions: Optional[Mapping[str, int]] = None,
            max_delay: Optional[int] = None,
            min_delay: Optional[int] = None,
            name: Optional[str] = None,
            parent_detector_id: Optional[str] = None,
            program_text: Optional[str] = None,
            rules: Optional[Sequence[DetectorRuleArgs]] = None,
            show_data_markers: Optional[bool] = None,
            show_event_lines: Optional[bool] = None,
            start_time: Optional[int] = None,
            tags: Optional[Sequence[str]] = None,
            teams: Optional[Sequence[str]] = None,
            time_range: Optional[int] = None,
            timezone: Optional[str] = None,
            url: Optional[str] = None,
            viz_options: Optional[Sequence[DetectorVizOptionArgs]] = None) -> Detector
    func GetDetector(ctx *Context, name string, id IDInput, state *DetectorState, opts ...ResourceOption) (*Detector, error)
    public static Detector Get(string name, Input<string> id, DetectorState? state, CustomResourceOptions? opts = null)
    public static Detector get(String name, Output<String> id, DetectorState 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:
    AuthorizedWriterTeams List<string>
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    AuthorizedWriterUsers List<string>
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    Description string
    Description of the detector.
    DetectorOrigin string
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    DisableSampling bool
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    LabelResolutions Dictionary<string, int>
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    MaxDelay int
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    MinDelay int
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    Name string
    Name of the detector.
    ParentDetectorId string
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    ProgramText string
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    Rules List<Pulumi.SignalFx.Inputs.DetectorRule>
    Set of rules used for alerting.
    ShowDataMarkers bool
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    ShowEventLines bool
    When true, the visualization will display a vertical line for each event trigger. false by default.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Tags List<string>
    Tags associated with the detector.
    Teams List<string>
    Team IDs to associate the detector to.
    TimeRange int
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    Url string
    The URL of the detector.
    VizOptions List<Pulumi.SignalFx.Inputs.DetectorVizOption>
    Plot-level customization options, associated with a publish statement.
    AuthorizedWriterTeams []string
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    AuthorizedWriterUsers []string
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    Description string
    Description of the detector.
    DetectorOrigin string
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    DisableSampling bool
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    LabelResolutions map[string]int
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    MaxDelay int
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    MinDelay int
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    Name string
    Name of the detector.
    ParentDetectorId string
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    ProgramText string
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    Rules []DetectorRuleArgs
    Set of rules used for alerting.
    ShowDataMarkers bool
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    ShowEventLines bool
    When true, the visualization will display a vertical line for each event trigger. false by default.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Tags []string
    Tags associated with the detector.
    Teams []string
    Team IDs to associate the detector to.
    TimeRange int
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    Timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    Url string
    The URL of the detector.
    VizOptions []DetectorVizOptionArgs
    Plot-level customization options, associated with a publish statement.
    authorizedWriterTeams List<String>
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorizedWriterUsers List<String>
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description String
    Description of the detector.
    detectorOrigin String
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disableSampling Boolean
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    endTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    labelResolutions Map<String,Integer>
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    maxDelay Integer
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    minDelay Integer
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name String
    Name of the detector.
    parentDetectorId String
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    programText String
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules List<DetectorRule>
    Set of rules used for alerting.
    showDataMarkers Boolean
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    showEventLines Boolean
    When true, the visualization will display a vertical line for each event trigger. false by default.
    startTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags List<String>
    Tags associated with the detector.
    teams List<String>
    Team IDs to associate the detector to.
    timeRange Integer
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    url String
    The URL of the detector.
    vizOptions List<DetectorVizOption>
    Plot-level customization options, associated with a publish statement.
    authorizedWriterTeams string[]
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorizedWriterUsers string[]
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description string
    Description of the detector.
    detectorOrigin string
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disableSampling boolean
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    endTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    labelResolutions {[key: string]: number}
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    maxDelay number
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    minDelay number
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name string
    Name of the detector.
    parentDetectorId string
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    programText string
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules DetectorRule[]
    Set of rules used for alerting.
    showDataMarkers boolean
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    showEventLines boolean
    When true, the visualization will display a vertical line for each event trigger. false by default.
    startTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags string[]
    Tags associated with the detector.
    teams string[]
    Team IDs to associate the detector to.
    timeRange number
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone string
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    url string
    The URL of the detector.
    vizOptions DetectorVizOption[]
    Plot-level customization options, associated with a publish statement.
    authorized_writer_teams Sequence[str]
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorized_writer_users Sequence[str]
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description str
    Description of the detector.
    detector_origin str
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disable_sampling bool
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    end_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    label_resolutions Mapping[str, int]
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    max_delay int
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    min_delay int
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name str
    Name of the detector.
    parent_detector_id str
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    program_text str
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules Sequence[DetectorRuleArgs]
    Set of rules used for alerting.
    show_data_markers bool
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    show_event_lines bool
    When true, the visualization will display a vertical line for each event trigger. false by default.
    start_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags Sequence[str]
    Tags associated with the detector.
    teams Sequence[str]
    Team IDs to associate the detector to.
    time_range int
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone str
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    url str
    The URL of the detector.
    viz_options Sequence[DetectorVizOptionArgs]
    Plot-level customization options, associated with a publish statement.
    authorizedWriterTeams List<String>
    Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in authorized_writer_users).
    authorizedWriterUsers List<String>
    User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in authorized_writer_teams).
    description String
    Description of the detector.
    detectorOrigin String
    Indicates how a detector was created. The possible values are: Standard and AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    disableSampling Boolean
    When false, the visualization may sample the output timeseries rather than displaying them all. false by default.
    endTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    labelResolutions Map<Number>
    The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
    maxDelay Number
    allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
    minDelay Number
    How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
    name String
    Name of the detector.
    parentDetectorId String
    ID of the AutoDetect parent detector from which this detector is customized and created. This property is required for detectors with detectorOrigin of type AutoDetectCustomization. The value can only be set when creating the detector and cannot be modified later.
    programText String
    Signalflow program text for the detector. More info in the Splunk Observability Cloud docs.
    rules List<Property Map>
    Set of rules used for alerting.
    showDataMarkers Boolean
    When true, markers will be drawn for each datapoint within the visualization. true by default.
    showEventLines Boolean
    When true, the visualization will display a vertical line for each event trigger. false by default.
    startTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    tags List<String>
    Tags associated with the detector.
    teams List<String>
    Team IDs to associate the detector to.
    timeRange Number
    Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 corresponds to -1h in web UI. 3600 by default.
    timezone String
    The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
    url String
    The URL of the detector.
    vizOptions List<Property Map>
    Plot-level customization options, associated with a publish statement.

    Supporting Types

    DetectorRule, DetectorRuleArgs

    DetectLabel string
    A detect label which matches a detect label within program_text.
    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 A Single Detector for more info.
    ParameterizedBody string
    Custom notification message body when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    ParameterizedSubject string
    Custom notification message subject when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    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.
    DetectLabel string
    A detect label which matches a detect label within program_text.
    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 A Single Detector for more info.
    ParameterizedBody string
    Custom notification message body when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    ParameterizedSubject string
    Custom notification message subject when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    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.
    detectLabel String
    A detect label which matches a detect label within program_text.
    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 A Single Detector for more info.
    parameterizedBody String
    Custom notification message body when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    parameterizedSubject String
    Custom notification message subject when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    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.
    detectLabel string
    A detect label which matches a detect label within program_text.
    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 A Single Detector for more info.
    parameterizedBody string
    Custom notification message body when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    parameterizedSubject string
    Custom notification message subject when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    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.
    detect_label str
    A detect label which matches a detect label within program_text.
    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 A Single Detector for more info.
    parameterized_body str
    Custom notification message body when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    parameterized_subject str
    Custom notification message subject when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    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.
    detectLabel String
    A detect label which matches a detect label within program_text.
    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 A Single Detector for more info.
    parameterizedBody String
    Custom notification message body when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    parameterizedSubject String
    Custom notification message subject when an alert is triggered. See Set Up Detectors to Trigger Alerts for more info.
    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.

    DetectorVizOption, DetectorVizOptionArgs

    Label string
    Label used in the publish statement that displays the plot (metric time series data) you want to customize.
    Color string
    Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
    DisplayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    ValuePrefix string

    , value_suffix - (Optional) Arbitrary prefix/suffix to display with the value of this plot.

    Notes

    Use both max_delay in your detector configuration and an extrapolation policy in your program text to reduce false positives and false negatives.

    ValueSuffix string
    An arbitrary suffix to display with the value of this plot
    ValueUnit string
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week.
    Label string
    Label used in the publish statement that displays the plot (metric time series data) you want to customize.
    Color string
    Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
    DisplayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    ValuePrefix string

    , value_suffix - (Optional) Arbitrary prefix/suffix to display with the value of this plot.

    Notes

    Use both max_delay in your detector configuration and an extrapolation policy in your program text to reduce false positives and false negatives.

    ValueSuffix string
    An arbitrary suffix to display with the value of this plot
    ValueUnit string
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week.
    label String
    Label used in the publish statement that displays the plot (metric time series data) you want to customize.
    color String
    Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
    displayName String
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix String

    , value_suffix - (Optional) Arbitrary prefix/suffix to display with the value of this plot.

    Notes

    Use both max_delay in your detector configuration and an extrapolation policy in your program text to reduce false positives and false negatives.

    valueSuffix String
    An arbitrary suffix to display with the value of this plot
    valueUnit String
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week.
    label string
    Label used in the publish statement that displays the plot (metric time series data) you want to customize.
    color string
    Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
    displayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix string

    , value_suffix - (Optional) Arbitrary prefix/suffix to display with the value of this plot.

    Notes

    Use both max_delay in your detector configuration and an extrapolation policy in your program text to reduce false positives and false negatives.

    valueSuffix string
    An arbitrary suffix to display with the value of this plot
    valueUnit string
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week.
    label str
    Label used in the publish statement that displays the plot (metric time series data) you want to customize.
    color str
    Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
    display_name str
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    value_prefix str

    , value_suffix - (Optional) Arbitrary prefix/suffix to display with the value of this plot.

    Notes

    Use both max_delay in your detector configuration and an extrapolation policy in your program text to reduce false positives and false negatives.

    value_suffix str
    An arbitrary suffix to display with the value of this plot
    value_unit str
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week.
    label String
    Label used in the publish statement that displays the plot (metric time series data) you want to customize.
    color String
    Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
    displayName String
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix String

    , value_suffix - (Optional) Arbitrary prefix/suffix to display with the value of this plot.

    Notes

    Use both max_delay in your detector configuration and an extrapolation policy in your program text to reduce false positives and false negatives.

    valueSuffix String
    An arbitrary suffix to display with the value of this plot
    valueUnit String
    A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week.

    Import

    Detectors can be imported using their string ID (recoverable from URL: /#/detector/v2/abc123/edit, e.g.

    $ pulumi import signalfx:index/detector:Detector application_delay abc123
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.4.0 published on Monday, Nov 18, 2024 by Pulumi