Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sysdig Provider
  3. API Docs
  4. MonitorAlertMetric
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs
sysdiglabs/terraform-provider-sysdig

sysdig.MonitorAlertMetric

Explore with Pulumi AI

sysdig logo
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs
sysdiglabs/terraform-provider-sysdig

    Example Usage

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

const sample = new sysdig.MonitorAlertMetric("sample", {
    capture: {
        duration: 15,
        filename: "CrashLoopBackOff",
    },
    description: "A Kubernetes pod failed to restart",
    metric: "sum(timeAvg(kubernetes.pod.restart.count)) > 2",
    multipleAlertsBies: [
        "kubernetes.cluster.name",
        "kubernetes.namespace.name",
        "kubernetes.deployment.name",
        "kubernetes.pod.name",
    ],
    severity: 6,
    triggerAfterMinutes: 1,
});

    import pulumi
import pulumi_sysdig as sysdig

sample = sysdig.MonitorAlertMetric("sample",
    capture={
        "duration": 15,
        "filename": "CrashLoopBackOff",
    },
    description="A Kubernetes pod failed to restart",
    metric="sum(timeAvg(kubernetes.pod.restart.count)) > 2",
    multiple_alerts_bies=[
        "kubernetes.cluster.name",
        "kubernetes.namespace.name",
        "kubernetes.deployment.name",
        "kubernetes.pod.name",
    ],
    severity=6,
    trigger_after_minutes=1)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sysdig/sysdig"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sysdig.NewMonitorAlertMetric(ctx, "sample", &sysdig.MonitorAlertMetricArgs{
			Capture: &sysdig.MonitorAlertMetricCaptureArgs{
				Duration: pulumi.Float64(15),
				Filename: pulumi.String("CrashLoopBackOff"),
			},
			Description: pulumi.String("A Kubernetes pod failed to restart"),
			Metric:      pulumi.String("sum(timeAvg(kubernetes.pod.restart.count)) > 2"),
			MultipleAlertsBies: pulumi.StringArray{
				pulumi.String("kubernetes.cluster.name"),
				pulumi.String("kubernetes.namespace.name"),
				pulumi.String("kubernetes.deployment.name"),
				pulumi.String("kubernetes.pod.name"),
			},
			Severity:            pulumi.Float64(6),
			TriggerAfterMinutes: pulumi.Float64(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var sample = new Sysdig.MonitorAlertMetric("sample", new()
    {
        Capture = new Sysdig.Inputs.MonitorAlertMetricCaptureArgs
        {
            Duration = 15,
            Filename = "CrashLoopBackOff",
        },
        Description = "A Kubernetes pod failed to restart",
        Metric = "sum(timeAvg(kubernetes.pod.restart.count)) > 2",
        MultipleAlertsBies = new[]
        {
            "kubernetes.cluster.name",
            "kubernetes.namespace.name",
            "kubernetes.deployment.name",
            "kubernetes.pod.name",
        },
        Severity = 6,
        TriggerAfterMinutes = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sysdig.MonitorAlertMetric;
import com.pulumi.sysdig.MonitorAlertMetricArgs;
import com.pulumi.sysdig.inputs.MonitorAlertMetricCaptureArgs;
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) {
        var sample = new MonitorAlertMetric("sample", MonitorAlertMetricArgs.builder()
            .capture(MonitorAlertMetricCaptureArgs.builder()
                .duration(15)
                .filename("CrashLoopBackOff")
                .build())
            .description("A Kubernetes pod failed to restart")
            .metric("sum(timeAvg(kubernetes.pod.restart.count)) > 2")
            .multipleAlertsBies(            
                "kubernetes.cluster.name",
                "kubernetes.namespace.name",
                "kubernetes.deployment.name",
                "kubernetes.pod.name")
            .severity(6)
            .triggerAfterMinutes(1)
            .build());

    }
}

    resources:
  sample:
    type: sysdig:MonitorAlertMetric
    properties:
      capture:
        duration: 15
        filename: CrashLoopBackOff
      description: A Kubernetes pod failed to restart
      metric: sum(timeAvg(kubernetes.pod.restart.count)) > 2
      multipleAlertsBies:
        - kubernetes.cluster.name
        - kubernetes.namespace.name
        - kubernetes.deployment.name
        - kubernetes.pod.name
      severity: 6
      triggerAfterMinutes: 1

    Create MonitorAlertMetric Resource

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

    Constructor syntax

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

@overload
def MonitorAlertMetric(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       metric: Optional[str] = None,
                       trigger_after_minutes: Optional[float] = None,
                       monitor_alert_metric_id: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       group_name: Optional[str] = None,
                       description: Optional[str] = None,
                       capture: Optional[MonitorAlertMetricCaptureArgs] = None,
                       multiple_alerts_bies: Optional[Sequence[str]] = None,
                       name: Optional[str] = None,
                       notification_channels: Optional[Sequence[float]] = None,
                       renotification_minutes: Optional[float] = None,
                       scope: Optional[str] = None,
                       severity: Optional[float] = None,
                       timeouts: Optional[MonitorAlertMetricTimeoutsArgs] = None,
                       custom_notification: Optional[MonitorAlertMetricCustomNotificationArgs] = None)
    func NewMonitorAlertMetric(ctx *Context, name string, args MonitorAlertMetricArgs, opts ...ResourceOption) (*MonitorAlertMetric, error)
    public MonitorAlertMetric(string name, MonitorAlertMetricArgs args, CustomResourceOptions? opts = null)
    public MonitorAlertMetric(String name, MonitorAlertMetricArgs args)
public MonitorAlertMetric(String name, MonitorAlertMetricArgs args, CustomResourceOptions options)

    type: sysdig:MonitorAlertMetric
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 MonitorAlertMetricArgs
    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 MonitorAlertMetricArgs
    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 MonitorAlertMetricArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitorAlertMetricArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitorAlertMetricArgs
    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 monitorAlertMetricResource = new Sysdig.MonitorAlertMetric("monitorAlertMetricResource", new()
{
    Metric = "string",
    TriggerAfterMinutes = 0,
    MonitorAlertMetricId = "string",
    Enabled = false,
    GroupName = "string",
    Description = "string",
    Capture = new Sysdig.Inputs.MonitorAlertMetricCaptureArgs
    {
        Duration = 0,
        Filename = "string",
        Filter = "string",
    },
    MultipleAlertsBies = new[]
    {
        "string",
    },
    Name = "string",
    NotificationChannels = new[]
    {
        0,
    },
    RenotificationMinutes = 0,
    Scope = "string",
    Severity = 0,
    Timeouts = new Sysdig.Inputs.MonitorAlertMetricTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
    CustomNotification = new Sysdig.Inputs.MonitorAlertMetricCustomNotificationArgs
    {
        Title = "string",
        Append = "string",
        Prepend = "string",
    },
});

    example, err := sysdig.NewMonitorAlertMetric(ctx, "monitorAlertMetricResource", &sysdig.MonitorAlertMetricArgs{
	Metric:               pulumi.String("string"),
	TriggerAfterMinutes:  pulumi.Float64(0),
	MonitorAlertMetricId: pulumi.String("string"),
	Enabled:              pulumi.Bool(false),
	GroupName:            pulumi.String("string"),
	Description:          pulumi.String("string"),
	Capture: &sysdig.MonitorAlertMetricCaptureArgs{
		Duration: pulumi.Float64(0),
		Filename: pulumi.String("string"),
		Filter:   pulumi.String("string"),
	},
	MultipleAlertsBies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	NotificationChannels: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	RenotificationMinutes: pulumi.Float64(0),
	Scope:                 pulumi.String("string"),
	Severity:              pulumi.Float64(0),
	Timeouts: &sysdig.MonitorAlertMetricTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	CustomNotification: &sysdig.MonitorAlertMetricCustomNotificationArgs{
		Title:   pulumi.String("string"),
		Append:  pulumi.String("string"),
		Prepend: pulumi.String("string"),
	},
})

    var monitorAlertMetricResource = new MonitorAlertMetric("monitorAlertMetricResource", MonitorAlertMetricArgs.builder()
    .metric("string")
    .triggerAfterMinutes(0)
    .monitorAlertMetricId("string")
    .enabled(false)
    .groupName("string")
    .description("string")
    .capture(MonitorAlertMetricCaptureArgs.builder()
        .duration(0)
        .filename("string")
        .filter("string")
        .build())
    .multipleAlertsBies("string")
    .name("string")
    .notificationChannels(0)
    .renotificationMinutes(0)
    .scope("string")
    .severity(0)
    .timeouts(MonitorAlertMetricTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .customNotification(MonitorAlertMetricCustomNotificationArgs.builder()
        .title("string")
        .append("string")
        .prepend("string")
        .build())
    .build());

    monitor_alert_metric_resource = sysdig.MonitorAlertMetric("monitorAlertMetricResource",
    metric="string",
    trigger_after_minutes=0,
    monitor_alert_metric_id="string",
    enabled=False,
    group_name="string",
    description="string",
    capture={
        "duration": 0,
        "filename": "string",
        "filter": "string",
    },
    multiple_alerts_bies=["string"],
    name="string",
    notification_channels=[0],
    renotification_minutes=0,
    scope="string",
    severity=0,
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    },
    custom_notification={
        "title": "string",
        "append": "string",
        "prepend": "string",
    })

    const monitorAlertMetricResource = new sysdig.MonitorAlertMetric("monitorAlertMetricResource", {
    metric: "string",
    triggerAfterMinutes: 0,
    monitorAlertMetricId: "string",
    enabled: false,
    groupName: "string",
    description: "string",
    capture: {
        duration: 0,
        filename: "string",
        filter: "string",
    },
    multipleAlertsBies: ["string"],
    name: "string",
    notificationChannels: [0],
    renotificationMinutes: 0,
    scope: "string",
    severity: 0,
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
    customNotification: {
        title: "string",
        append: "string",
        prepend: "string",
    },
});

    type: sysdig:MonitorAlertMetric
properties:
    capture:
        duration: 0
        filename: string
        filter: string
    customNotification:
        append: string
        prepend: string
        title: string
    description: string
    enabled: false
    groupName: string
    metric: string
    monitorAlertMetricId: string
    multipleAlertsBies:
        - string
    name: string
    notificationChannels:
        - 0
    renotificationMinutes: 0
    scope: string
    severity: 0
    timeouts:
        create: string
        delete: string
        read: string
        update: string
    triggerAfterMinutes: 0

    MonitorAlertMetric 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 MonitorAlertMetric resource accepts the following input properties:

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Team double
    Team ID that owns the alert.
    Version double
    Current version of the resource in Sysdig Monitor.
    Id string
    The provider-assigned unique ID for this managed resource.
    Team float64
    Team ID that owns the alert.
    Version float64
    Current version of the resource in Sysdig Monitor.
    id String
    The provider-assigned unique ID for this managed resource.
    team Double
    Team ID that owns the alert.
    version Double
    Current version of the resource in Sysdig Monitor.
    id string
    The provider-assigned unique ID for this managed resource.
    team number
    Team ID that owns the alert.
    version number
    Current version of the resource in Sysdig Monitor.
    id str
    The provider-assigned unique ID for this managed resource.
    team float
    Team ID that owns the alert.
    version float
    Current version of the resource in Sysdig Monitor.
    id String
    The provider-assigned unique ID for this managed resource.
    team Number
    Team ID that owns the alert.
    version Number
    Current version of the resource in Sysdig Monitor.

    Look up Existing MonitorAlertMetric Resource

    Get an existing MonitorAlertMetric 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?: MonitorAlertMetricState, opts?: CustomResourceOptions): MonitorAlertMetric
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capture: Optional[MonitorAlertMetricCaptureArgs] = None,
        custom_notification: Optional[MonitorAlertMetricCustomNotificationArgs] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        group_name: Optional[str] = None,
        metric: Optional[str] = None,
        monitor_alert_metric_id: Optional[str] = None,
        multiple_alerts_bies: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        notification_channels: Optional[Sequence[float]] = None,
        renotification_minutes: Optional[float] = None,
        scope: Optional[str] = None,
        severity: Optional[float] = None,
        team: Optional[float] = None,
        timeouts: Optional[MonitorAlertMetricTimeoutsArgs] = None,
        trigger_after_minutes: Optional[float] = None,
        version: Optional[float] = None) -> MonitorAlertMetric
    func GetMonitorAlertMetric(ctx *Context, name string, id IDInput, state *MonitorAlertMetricState, opts ...ResourceOption) (*MonitorAlertMetric, error)
    public static MonitorAlertMetric Get(string name, Input<string> id, MonitorAlertMetricState? state, CustomResourceOptions? opts = null)
    public static MonitorAlertMetric get(String name, Output<String> id, MonitorAlertMetricState state, CustomResourceOptions options)
    resources:  _:    type: sysdig:MonitorAlertMetric    get:      id: ${id}
    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:
    Capture MonitorAlertMetricCapture
    CustomNotification MonitorAlertMetricCustomNotification
    Description string
    Enabled bool
    GroupName string
    Metric string
    MonitorAlertMetricId string
    ID of the alert created.
    MultipleAlertsBies List<string>
    Name string
    NotificationChannels List<double>
    RenotificationMinutes double
    Scope string
    Severity double
    Team double
    Team ID that owns the alert.
    Timeouts MonitorAlertMetricTimeouts
    TriggerAfterMinutes double
    Version double
    Current version of the resource in Sysdig Monitor.
    Capture MonitorAlertMetricCaptureArgs
    CustomNotification MonitorAlertMetricCustomNotificationArgs
    Description string
    Enabled bool
    GroupName string
    Metric string
    MonitorAlertMetricId string
    ID of the alert created.
    MultipleAlertsBies []string
    Name string
    NotificationChannels []float64
    RenotificationMinutes float64
    Scope string
    Severity float64
    Team float64
    Team ID that owns the alert.
    Timeouts MonitorAlertMetricTimeoutsArgs
    TriggerAfterMinutes float64
    Version float64
    Current version of the resource in Sysdig Monitor.
    capture MonitorAlertMetricCapture
    customNotification MonitorAlertMetricCustomNotification
    description String
    enabled Boolean
    groupName String
    metric String
    monitorAlertMetricId String
    ID of the alert created.
    multipleAlertsBies List<String>
    name String
    notificationChannels List<Double>
    renotificationMinutes Double
    scope String
    severity Double
    team Double
    Team ID that owns the alert.
    timeouts MonitorAlertMetricTimeouts
    triggerAfterMinutes Double
    version Double
    Current version of the resource in Sysdig Monitor.
    capture MonitorAlertMetricCapture
    customNotification MonitorAlertMetricCustomNotification
    description string
    enabled boolean
    groupName string
    metric string
    monitorAlertMetricId string
    ID of the alert created.
    multipleAlertsBies string[]
    name string
    notificationChannels number[]
    renotificationMinutes number
    scope string
    severity number
    team number
    Team ID that owns the alert.
    timeouts MonitorAlertMetricTimeouts
    triggerAfterMinutes number
    version number
    Current version of the resource in Sysdig Monitor.
    capture Property Map
    customNotification Property Map
    description String
    enabled Boolean
    groupName String
    metric String
    monitorAlertMetricId String
    ID of the alert created.
    multipleAlertsBies List<String>
    name String
    notificationChannels List<Number>
    renotificationMinutes Number
    scope String
    severity Number
    team Number
    Team ID that owns the alert.
    timeouts Property Map
    triggerAfterMinutes Number
    version Number
    Current version of the resource in Sysdig Monitor.

    Supporting Types

    MonitorAlertMetricCapture, MonitorAlertMetricCaptureArgs

    Duration double
    Time frame in seconds of the capture.
    Filename string
    Defines the name of the capture file.
    Filter string
    Additional filter to apply to the capture. For example: proc.name contains nginx.
    Duration float64
    Time frame in seconds of the capture.
    Filename string
    Defines the name of the capture file.
    Filter string
    Additional filter to apply to the capture. For example: proc.name contains nginx.
    duration Double
    Time frame in seconds of the capture.
    filename String
    Defines the name of the capture file.
    filter String
    Additional filter to apply to the capture. For example: proc.name contains nginx.
    duration number
    Time frame in seconds of the capture.
    filename string
    Defines the name of the capture file.
    filter string
    Additional filter to apply to the capture. For example: proc.name contains nginx.
    duration float
    Time frame in seconds of the capture.
    filename str
    Defines the name of the capture file.
    filter str
    Additional filter to apply to the capture. For example: proc.name contains nginx.
    duration Number
    Time frame in seconds of the capture.
    filename String
    Defines the name of the capture file.
    filter String
    Additional filter to apply to the capture. For example: proc.name contains nginx.

    MonitorAlertMetricCustomNotification, MonitorAlertMetricCustomNotificationArgs

    Title string
    Sets the title of the alert. It is commonly defined as {{__alert_name__}} is {{__alert_status__}}.
    Append string
    Text to add after the alert template.
    Prepend string
    Text to add before the alert template.
    Title string
    Sets the title of the alert. It is commonly defined as {{__alert_name__}} is {{__alert_status__}}.
    Append string
    Text to add after the alert template.
    Prepend string
    Text to add before the alert template.
    title String
    Sets the title of the alert. It is commonly defined as {{__alert_name__}} is {{__alert_status__}}.
    append String
    Text to add after the alert template.
    prepend String
    Text to add before the alert template.
    title string
    Sets the title of the alert. It is commonly defined as {{__alert_name__}} is {{__alert_status__}}.
    append string
    Text to add after the alert template.
    prepend string
    Text to add before the alert template.
    title str
    Sets the title of the alert. It is commonly defined as {{__alert_name__}} is {{__alert_status__}}.
    append str
    Text to add after the alert template.
    prepend str
    Text to add before the alert template.
    title String
    Sets the title of the alert. It is commonly defined as {{__alert_name__}} is {{__alert_status__}}.
    append String
    Text to add after the alert template.
    prepend String
    Text to add before the alert template.

    MonitorAlertMetricTimeouts, MonitorAlertMetricTimeoutsArgs

    Create string
    Delete string
    Read string
    Update string
    Create string
    Delete string
    Read string
    Update string
    create String
    delete String
    read String
    update String
    create string
    delete string
    read string
    update string
    create str
    delete str
    read str
    update str
    create String
    delete String
    read String
    update String

    Import

    Metric Threshold alerts can be imported using the alert ID, e.g.

    $ pulumi import sysdig:index/monitorAlertMetric:MonitorAlertMetric example 12345

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

    Package Details

    Repository
    sysdig sysdiglabs/terraform-provider-sysdig
    License
    Notes
    This Pulumi package is based on the sysdig Terraform Provider.
    sysdig logo
    sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs
    sysdiglabs/terraform-provider-sysdig