1. Docs
2. Reference
3. API
4. @pulumi/signalfx

Package @pulumi/signalfx

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-signalfx repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-signalfx repo.

var signalfx = require("@pulumi/signalfx");

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

Modules

• aws
• azure
• config
• gcp
• jira
• opsgenie
• pagerduty
• slack
• types
• victorops

Resources

• AlertMutingRule
• Dashboard
• DashboardGroup
• DataLink
• Detector
• EventFeedChart
• HeatmapChart
• ListChart
• OrgToken
• Provider
• SingleValueChart
• Team
• TextChart
• TimeChart
• WebhookIntegration

Functions

• getAwsServices
• getAzureServices
• getDimensionValues

Others

• AlertMutingRuleArgs
• AlertMutingRuleState
• DashboardArgs
• DashboardGroupArgs
• DashboardGroupState
• DashboardState
• DataLinkArgs
• DataLinkState
• DetectorArgs
• DetectorState
• EventFeedChartArgs
• EventFeedChartState
• GetAwsServicesArgs
• GetAwsServicesResult
• GetAzureServicesArgs
• GetAzureServicesResult
• GetDimensionValuesArgs
• GetDimensionValuesResult
• getEnv
• getEnvBoolean
• getEnvNumber
• getVersion
• HeatmapChartArgs
• HeatmapChartState
• ListChartArgs
• ListChartState
• OrgTokenArgs
• OrgTokenState
• ProviderArgs
• SingleValueChartArgs
• SingleValueChartState
• TeamArgs
• TeamState
• TextChartArgs
• TextChartState
• TimeChartArgs
• TimeChartState
• WebhookIntegrationArgs
• WebhookIntegrationState

Resources

Resource AlertMutingRule

class AlertMutingRule extends CustomResource

Provides a SignalFx resource for managing alert muting rules. See Mute Notifications for more information.

WARNING SignalFx does not allow the start time of a currently active muting rule to be modified. As such, attempting to modify a currently active rule will destroy the existing rule and create a new rule. This may result in the emission of notifications.

Example Usage

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

const roolMooterOne = new signalfx.AlertMutingRule("roolMooterOne", {
    description: "mooted it NEW",
    startTime: 1573063243,
    stopTime: 0,
    detectors: [signalfx_detector.some_detector_id],
    filter: [{
        property: "foo",
        propertyValue: "bar",
    }],
});

constructor

new AlertMutingRule(name: string, args: AlertMutingRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a AlertMutingRule resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlertMutingRuleState, opts?: pulumi.CustomResourceOptions): AlertMutingRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AlertMutingRule

Returns true if the given object is an instance of AlertMutingRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string>;

The description for this muting rule

property detectors

public detectors: pulumi.Output<string[] | undefined>;

A convenience attribute that associated this muting rule with specific detector ids.

property effectiveStartTime

public effectiveStartTime: pulumi.Output<number>;

property filters

public filters: pulumi.Output<AlertMutingRuleFilter[]>;

Filters for this rule. See Creating muting rules from scratch for more information.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property startTime

public startTime: pulumi.Output<number>;

Starting time of an alert muting rule as a Unit time stamp in seconds.

property stopTime

public stopTime: pulumi.Output<number | undefined>;

Starting time of an alert muting rule as a Unix time stamp in seconds.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Dashboard

class Dashboard extends CustomResource

A dashboard is a curated collection of specific charts and supports dimensional filters, dashboard variables and time range options. These options are applied to all charts in the dashboard, providing a consistent view of the data displayed in that dashboard. This also means that when you open a chart to drill down for more details, you are viewing the same data that is visible in the dashboard view.

NOTE Since every dashboard is included in a dashboard group (SignalFx collection of dashboards), you need to create that first and reference it as shown in the example.

Example Usage

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

const mydashboard0 = new signalfx.Dashboard("mydashboard0", {
    dashboardGroup: signalfx_dashboard_group.mydashboardgroup0.id,
    timeRange: "-30m",
    filter: [{
        property: "collector",
        values: [
            "cpu",
            "Diamond",
        ],
    }],
    variable: [{
        property: "region",
        alias: "region",
        values: ["uswest-1-"],
    }],
    chart: [
        {
            chartId: signalfx_time_chart.mychart0.id,
            width: 12,
            height: 1,
        },
        {
            chartId: signalfx_time_chart.mychart1.id,
            width: 5,
            height: 2,
        },
    ],
});

Grid

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

const gridExample = new signalfx.Dashboard("gridExample", {
    dashboardGroup: signalfx_dashboard_group_example.id,
    grids: [{
        chartIds: pulumi.all([pulumi.all(signalfx_time_chart_rps.map(v => v.id)), pulumi.all(signalfx_time_chart_50ths.map(v => v.id)), pulumi.all(signalfx_time_chart_99ths.map(v => v.id)), pulumi.all(signalfx_time_chart_idle_workers.map(v => v.id)), pulumi.all(signalfx_time_chart_cpu_idle.map(v => v.id))]).apply(([signalfx_time_chart_rpsId, signalfx_time_chart_50thsId, signalfx_time_chart_99thsId, signalfx_time_chart_idle_workersId, signalfx_time_chart_cpu_idleId]) => signalfx_time_chart_rpsId.map(v => v).concat(signalfx_time_chart_50thsId.map(v => v), signalfx_time_chart_99thsId.map(v => v), signalfx_time_chart_idle_workersId.map(v => v), signalfx_time_chart_cpu_idleId.map(v => v))),
        height: 1,
        width: 3,
    }],
    timeRange: "-15m",
});

Column

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

const load = new signalfx.Dashboard("load", {
    columns: [
        {
            chartIds: [signalfx_single_value_chart_rps.map(v => v.id)],
            width: 2,
        },
        {
            chartIds: [signalfx_time_chart_cpu_capacity.map(v => v.id)],
            column: 2,
            width: 4,
        },
    ],
    dashboardGroup: signalfx_dashboard_group_example.id,
});

constructor

new Dashboard(name: string, args: DashboardArgs, opts?: pulumi.CustomResourceOptions)

Create a Dashboard resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Dashboard

Returns true if the given object is an instance of Dashboard. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorizedWriterTeams

public authorizedWriterTeams: pulumi.Output<string[] | undefined>;

Team IDs that have write access to this dashboard

property authorizedWriterUsers

public authorizedWriterUsers: pulumi.Output<string[] | undefined>;

User IDs that have write access to this dashboard

property charts

public charts: pulumi.Output<DashboardChart[] | undefined>;

Chart ID and layout information for the charts in the dashboard.

property chartsResolution

public chartsResolution: pulumi.Output<string | undefined>;

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

property columns

public columns: pulumi.Output<DashboardColumn[] | undefined>;

Column number for the layout.

property dashboardGroup

public dashboardGroup: pulumi.Output<string>;

The ID of the dashboard group that contains the dashboard.

property description

public description: pulumi.Output<string | undefined>;

Variable description.

property discoveryOptionsQuery

public discoveryOptionsQuery: pulumi.Output<string | undefined>;

property discoveryOptionsSelectors

public discoveryOptionsSelectors: pulumi.Output<string[] | undefined>;

property endTime

public endTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. You must specify timeSpanType = "absolute" too.

property eventOverlays

public eventOverlays: pulumi.Output<DashboardEventOverlay[] | undefined>;

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlay property instead.

property filters

public filters: pulumi.Output<DashboardFilter[] | undefined>;

Filter to apply to the charts when displaying the dashboard.

property grids

public grids: pulumi.Output<DashboardGrid[] | undefined>;

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the dashboard.

property selectedEventOverlays

public selectedEventOverlays: pulumi.Output<DashboardSelectedEventOverlay[] | undefined>;

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in eventOverlay, which are similar to the properties here.

property startTime

public startTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. You must specify timeSpanType = "absolute" too.

property timeRange

public timeRange: pulumi.Output<string | undefined>;

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

property url

public url: pulumi.Output<string>;

URL of the dashboard

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property variables

public variables: pulumi.Output<DashboardVariable[] | undefined>;

Dashboard variable to apply to each chart in the dashboard.

Resource DashboardGroup

class DashboardGroup extends CustomResource

In the SignalFx web UI, a dashboard group is a collection of dashboards.

NOTE Dashboard groups cannot be accessed directly, but just via a dashboard contained in them. This is the reason why make show won’t show any of yours dashboard groups.

Example Usage

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

const mydashboardgroup0 = new signalfx.DashboardGroup("mydashboardgroup0", {
    description: "Cool dashboard group",
    authorizedWriterTeams: [signalfx_team.mycoolteam.id],
    authorizedWriterUsers: ["abc123"],
});

Example Usage With Mirrored Dashboards

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

const mydashboardgroupWithmirrors = new signalfx.DashboardGroup("mydashboardgroupWithmirrors", {
    description: "Cool dashboard group",
    dashboard: [{
        dashboardId: signalfx_dashboard.gc_dashboard.id,
        nameOverride: "GC For My Service",
        descriptionOverride: "Garbage Collection dashboard maintained by JVM team",
        filter_override: [{
            property: "service",
            values: ["myservice"],
            negated: false,
        }],
        variable_override: [{
            property: "region",
            values: ["us-west1"],
            valuesSuggesteds: [
                "us-west-1",
                "us-east-1",
            ],
        }],
    }],
});

constructor

new DashboardGroup(name: string, args?: DashboardGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a DashboardGroup resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DashboardGroupState, opts?: pulumi.CustomResourceOptions): DashboardGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DashboardGroup

Returns true if the given object is an instance of DashboardGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorizedWriterTeams

public authorizedWriterTeams: pulumi.Output<string[] | undefined>;

Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorizedWriterTeams).

property authorizedWriterUsers

public authorizedWriterUsers: pulumi.Output<string[] | undefined>;

User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorizedWriterTeams).

property dashboards

public dashboards: pulumi.Output<DashboardGroupDashboard[] | undefined>;

Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

property description

public description: pulumi.Output<string | undefined>;

Description of the dashboard group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property importQualifiers

public importQualifiers: pulumi.Output<DashboardGroupImportQualifier[] | undefined>;

property name

public name: pulumi.Output<string>;

Name of the dashboard group.

property teams

public teams: pulumi.Output<string[] | undefined>;

Team IDs to associate the dashboard group to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DataLink

class DataLink extends CustomResource

Manage SignalFx Data Links.

Example Usage

Global link to a dashboard

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

const myDataLink = new signalfx.DataLink("myDataLink", {
    propertyName: "pname",
    propertyValue: "pvalue",
    target_signalfx_dashboard: [{
        isDefault: true,
        name: "sfxDash",
        dashboardGroupId: signalfx_dashboard_group.mydashboardgroup0.id,
        dashboardId: signalfx_dashboard.mydashboard0.id,
    }],
});

Dashboard specific link to an external URL

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

const myDataLinkDash = new signalfx.DataLink("myDataLinkDash", {
    contextDashboardId: signalfx_dashboard.mydashboard0.id,
    propertyName: "pname2",
    propertyValue: "pvalue",
    target_external_url: [{
        isDefault: false,
        name: "exUrl",
        timeFormat: "ISO8601",
        url: "https://www.example.com",
        propertyKeyMapping: {
            foo: "bar",
        },
    }],
});

constructor

new DataLink(name: string, args?: DataLinkArgs, opts?: pulumi.CustomResourceOptions)

Create a DataLink resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataLinkState, opts?: pulumi.CustomResourceOptions): DataLink

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DataLink

Returns true if the given object is an instance of DataLink. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property contextDashboardId

public contextDashboardId: pulumi.Output<string | undefined>;

If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property propertyName

public propertyName: pulumi.Output<string | undefined>;

Name (key) of the metadata that’s the trigger of a data link. If you specify propertyValue, you must specify propertyName.

property propertyValue

public propertyValue: pulumi.Output<string | undefined>;

Value of the metadata that’s the trigger of a data link. If you specify this property, you must also specify propertyName.

property targetExternalUrls

public targetExternalUrls: pulumi.Output<DataLinkTargetExternalUrl[] | undefined>;

Link to an external URL

property targetSignalfxDashboards

public targetSignalfxDashboards: pulumi.Output<DataLinkTargetSignalfxDashboard[] | undefined>;

Link to a SignalFx dashboard

property targetSplunks

public targetSplunks: pulumi.Output<DataLinkTargetSplunk[] | undefined>;

Link to an external URL

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Detector

class Detector extends CustomResource

Provides a SignalFx detector resource. This can be used to create and manage detectors. As SignalFx supports different notification mechanisms a comma-delimited string is used to provide inputs. If you’d like to specify multiple notifications, then each should be a member in the list.

NOTE If you’re interested in using SignalFx detector features such as Historical Anomaly, Resource Running Out, or others then consider building them in the UI first then using the “Show SignalFlow” feature to extract the value for programText. You may also consult the documentation for detector functions in signalflow-library.

Example Usage

Jira

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["Jira,credentialId"],
        }],
    }));
}

Opsgenie

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["Opsgenie,credentialId,responderName,responderId,Team"],
        }],
    }));
}

PagerDuty

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["PagerDuty,credentialId"],
        }],
    }));
}

Slack

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["Slack,credentialId,channel"],
        }],
    }));
}

Team

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["Team,teamId"],
        }],
    }));
}

TeamEmail

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["TeamEmail,teamId"],
        }],
    }));
}

VictorOps

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["VictorOps,credentialId,routingKey"],
        }],
    }));
}

Webhook

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

const applicationDelay: signalfx.Detector[];
for (const range = {value: 0}; range.value < _var.clusters.length; range.value++) {
    applicationDelay.push(new signalfx.Detector(`applicationDelay-${range.value}`, {
        description: `your application is slow - ${_var.clusters[range.value]}`,
        maxDelay: 30,
        authorizedWriterTeams: [signalfx_team.mycoolteam.id],
        authorizedWriterUsers: ["abc123"],
        programText: `signal = data('app.delay', filter('cluster','${_var.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')
`,
        rule: [{
            description: "maximum > 60 for 5m",
            severity: "Warning",
            detectLabel: "Processing old messages 5m",
            notifications: ["Webhook,credentialId,x,"],
        }],
    }));
}

constructor

new Detector(name: string, args: DetectorArgs, opts?: pulumi.CustomResourceOptions)

Create a Detector resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DetectorState, opts?: pulumi.CustomResourceOptions): Detector

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Detector

Returns true if the given object is an instance of Detector. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorizedWriterTeams

public authorizedWriterTeams: pulumi.Output<string[] | undefined>;

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 authorizedWriterUsers).

property authorizedWriterUsers

public authorizedWriterUsers: pulumi.Output<string[] | undefined>;

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 authorizedWriterTeams).

property description

public description: pulumi.Output<string | undefined>;

Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.

property disableSampling

public disableSampling: pulumi.Output<boolean | undefined>;

When false, the visualization may sample the output timeseries rather than displaying them all. false by default.

property endTime

public endTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxDelay

public maxDelay: pulumi.Output<number | undefined>;

How long (in seconds) to wait for late datapoints. See Delayed Datapoints for more info. Max value is 900 seconds (15 minutes). Auto (as little as possible) by default.

property name

public name: pulumi.Output<string>;

Name of the detector.

property programText

public programText: pulumi.Output<string>;

Signalflow program text for the detector. More info in the SignalFx docs.

property rules

public rules: pulumi.Output<DetectorRule[]>;

Set of rules used for alerting.

property showDataMarkers

public showDataMarkers: pulumi.Output<boolean | undefined>;

When true, markers will be drawn for each datapoint within the visualization. true by default.

property showEventLines

public showEventLines: pulumi.Output<boolean | undefined>;

When true, the visualization will display a vertical line for each event trigger. false by default.

property startTime

public startTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property teams

public teams: pulumi.Output<string[] | undefined>;

Team IDs to associate the detector to.

property timeRange

public timeRange: pulumi.Output<number | undefined>;

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.

property url

public url: pulumi.Output<string>;

URL of the detector

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vizOptions

public vizOptions: pulumi.Output<DetectorVizOption[] | undefined>;

Plot-level customization options, associated with a publish statement.

Resource EventFeedChart

class EventFeedChart extends CustomResource

Displays a listing of events as a widget in a dashboard.

Example Usage

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

const mynote0 = new signalfx.EventFeedChart("mynote0", {
    description: "Lorem ipsum dolor sit amet",
    programText: "A = events(eventType='Fart Testing').publish(label='A')",
    vizOptions: [{
        color: "orange",
        label: "A",
    }],
});

constructor

new EventFeedChart(name: string, args: EventFeedChartArgs, opts?: pulumi.CustomResourceOptions)

Create a EventFeedChart resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventFeedChartState, opts?: pulumi.CustomResourceOptions): EventFeedChart

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EventFeedChart

Returns true if the given object is an instance of EventFeedChart. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Description of the text note.

property endTime

public endTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the text note.

property programText

public programText: pulumi.Output<string>;

Signalflow program text for the chart. More infoin the SignalFx docs.

property startTime

public startTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property timeRange

public timeRange: pulumi.Output<number | undefined>;

From when to display data. SignalFx time syntax (e.g. "-5m", "-1h"). Conflicts with startTime and endTime.

property url

public url: pulumi.Output<string>;

URL of the chart

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource HeatmapChart

class HeatmapChart extends CustomResource

This chart type displays the specified plot in a heatmap fashion. This format is similar to the Infrastructure Navigator, with squares representing each source for the selected metric, and the color of each square representing the value range of the metric.

Example Usage

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

const myheatmapchart0 = new signalfx.HeatmapChart("myheatmapchart0", {
    colorRange: {
        color: "#ff0000",
        maxValue: 100,
        minValue: 0,
    },
    colorScales: [
        // You can only use one of colorRange or color_scale!
        {
            color: "green",
            gte: 99,
        },
        {
            color: "yellow",
            gte: 95,
            lt: 99, // This ensures we cover the range 95-99
        },
        {
            color: "red",
            lt: 95,
        },
    ],
    description: "Very cool Heatmap",
    disableSampling: true,
    groupBies: [
        "hostname",
        "host",
    ],
    hideTimestamp: true,
    programText: `myfilters = filter("clusterName", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
`,
    sortBy: "+host",
});

constructor

new HeatmapChart(name: string, args: HeatmapChartArgs, opts?: pulumi.CustomResourceOptions)

Create a HeatmapChart resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HeatmapChartState, opts?: pulumi.CustomResourceOptions): HeatmapChart

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is HeatmapChart

Returns true if the given object is an instance of HeatmapChart. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property colorRange

public colorRange: pulumi.Output<HeatmapChartColorRange | undefined>;

Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

property colorScales

public colorScales: pulumi.Output<HeatmapChartColorScale[] | undefined>;

One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: colorScale { gt = 60, color = "blue" } colorScale { lte = 60, color = "yellow" }. Look at this link.

property description

public description: pulumi.Output<string | undefined>;

Description of the chart.

property disableSampling

public disableSampling: pulumi.Output<boolean | undefined>;

If false, samples a subset of the output MTS, which improves UI performance. false by default.

property groupBies

public groupBies: pulumi.Output<string[] | undefined>;

Properties to group by in the heatmap (in nesting order).

property hideTimestamp

public hideTimestamp: pulumi.Output<boolean | undefined>;

Whether to show the timestamp in the chart. false by default.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxDelay

public maxDelay: pulumi.Output<number | undefined>;

How long (in seconds) to wait for late datapoints.

property minimumResolution

public minimumResolution: pulumi.Output<number | undefined>;

The minimum resolution (in seconds) to use for computing the underlying program.

property name

public name: pulumi.Output<string>;

Name of the chart.

property programText

public programText: pulumi.Output<string>;

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

property refreshInterval

public refreshInterval: pulumi.Output<number | undefined>;

How often (in seconds) to refresh the values of the heatmap.

property sortBy

public sortBy: pulumi.Output<string | undefined>;

The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).

property unitPrefix

public unitPrefix: pulumi.Output<string | undefined>;

Must be "Metric" or "Binary”. "Metric" by default.

property url

public url: pulumi.Output<string>;

URL of the chart

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ListChart

class ListChart extends CustomResource

This chart type displays current data values in a list format.

The name of each value in the chart reflects the name of the plot and any associated dimensions. We recommend you click the Pencil icon and give the plot a meaningful name, as in plot B below. Otherwise, just the raw metric name will be displayed on the chart, as in plot A below.

Example Usage

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

const mylistchart0 = new signalfx.ListChart("mylistchart0", {
    colorBy: "Metric",
    description: "Very cool List Chart",
    disableSampling: true,
    legendOptionsFields: [
        {
            enabled: false,
            property: "collector",
        },
        {
            enabled: true,
            property: "clusterName",
        },
        {
            enabled: true,
            property: "role",
        },
        {
            enabled: false,
            property: "collector",
        },
        {
            enabled: false,
            property: "host",
        },
    ],
    maxDelay: 2,
    maxPrecision: 2,
    programText: `myfilters = filter("clusterName", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
`,
    refreshInterval: 1,
    sortBy: "-value",
});

constructor

new ListChart(name: string, args: ListChartArgs, opts?: pulumi.CustomResourceOptions)

Create a ListChart resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ListChartState, opts?: pulumi.CustomResourceOptions): ListChart

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ListChart

Returns true if the given object is an instance of ListChart. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property colorBy

public colorBy: pulumi.Output<string | undefined>;

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

property colorScales

public colorScales: pulumi.Output<ListChartColorScale[] | undefined>;

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

property description

public description: pulumi.Output<string | undefined>;

Description of the chart.

property disableSampling

public disableSampling: pulumi.Output<boolean | undefined>;

If false, samples a subset of the output MTS, which improves UI performance. false by default.

property endTime

public endTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property legendFieldsToHides

public legendFieldsToHides: pulumi.Output<string[] | undefined>;

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legendOptionsFields.

property legendOptionsFields

public legendOptionsFields: pulumi.Output<ListChartLegendOptionsField[] | undefined>;

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legendFieldsToHide.

property maxDelay

public maxDelay: pulumi.Output<number | undefined>;

How long (in seconds) to wait for late datapoints.

property maxPrecision

public maxPrecision: pulumi.Output<number | undefined>;

Maximum number of digits to display when rounding values up or down.

property name

public name: pulumi.Output<string>;

Name of the chart.

property programText

public programText: pulumi.Output<string>;

Signalflow program text for the chart. More infoin the SignalFx docs.

property refreshInterval

public refreshInterval: pulumi.Output<number | undefined>;

How often (in seconds) to refresh the values of the list.

property secondaryVisualization

public secondaryVisualization: pulumi.Output<string | undefined>;

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

property sortBy

public sortBy: pulumi.Output<string | undefined>;

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sfMetric" for plot.

property startTime

public startTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property timeRange

public timeRange: pulumi.Output<number | undefined>;

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with startTime and endTime.

property unitPrefix

public unitPrefix: pulumi.Output<string | undefined>;

Must be "Metric" or "Binary”. "Metric" by default.

property url

public url: pulumi.Output<string>;

URL of the chart

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vizOptions

public vizOptions: pulumi.Output<ListChartVizOption[] | undefined>;

Plot-level customization options, associated with a publish statement.

Resource OrgToken

class OrgToken extends CustomResource

Manage SignalFx org tokens.

Example Usage

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

const myteamkey0 = new signalfx.OrgToken("myteamkey0", {
    description: "My team's rad key",
    hostOrUsageLimits: {
        containerLimit: 200,
        containerNotificationThreshold: 180,
        customMetricsLimit: 1000,
        customMetricsNotificationThreshold: 900,
        highResMetricsLimit: 1000,
        highResMetricsNotificationThreshold: 900,
        hostLimit: 100,
        hostNotificationThreshold: 90,
    },
    notifications: ["Email,foo-alerts@bar.com"],
});

constructor

new OrgToken(name: string, args?: OrgTokenArgs, opts?: pulumi.CustomResourceOptions)

Create a OrgToken resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OrgTokenState, opts?: pulumi.CustomResourceOptions): OrgToken

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is OrgToken

Returns true if the given object is an instance of OrgToken. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Description of the token.

property disabled

public disabled: pulumi.Output<boolean | undefined>;

Flag that controls enabling the token. If set to true, the token is disabled, and you can’t use it for authentication. Defaults to false.

property dpmLimits

public dpmLimits: pulumi.Output<OrgTokenDpmLimits | undefined>;

Specify DPM-based limits for this token.

property hostOrUsageLimits

public hostOrUsageLimits: pulumi.Output<OrgTokenHostOrUsageLimits | undefined>;

Specify Usage-based limits for this token.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the token.

property notifications

public notifications: pulumi.Output<string[] | undefined>;

Where to send notifications about this token’s limits. Please consult the Notification Format laid out in detectors.

property secret

public secret: pulumi.Output<string>;

The secret token created by the API. You cannot set this value.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the signalfx package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SingleValueChart

class SingleValueChart extends CustomResource

This chart type displays a single number in a large font, representing the current value of a single metric on a plot line.

If the time period is in the past, the number represents the value of the metric near the end of the time period.

Example Usage

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

const mysvchart0 = new signalfx.SingleValueChart("mysvchart0", {
    colorBy: "Dimension",
    description: "Very cool Single Value Chart",
    isTimestampHidden: true,
    maxDelay: 2,
    maxPrecision: 2,
    programText: `myfilters = filter("clusterName", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
`,
    refreshInterval: 1,
});

constructor

new SingleValueChart(name: string, args: SingleValueChartArgs, opts?: pulumi.CustomResourceOptions)

Create a SingleValueChart resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SingleValueChartState, opts?: pulumi.CustomResourceOptions): SingleValueChart

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SingleValueChart

Returns true if the given object is an instance of SingleValueChart. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property colorBy

public colorBy: pulumi.Output<string | undefined>;

Must be "Dimension", "Scale" or "Metric". "Dimension" by default.

property colorScales

public colorScales: pulumi.Output<SingleValueChartColorScale[] | undefined>;

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

property description

public description: pulumi.Output<string | undefined>;

Description of the chart.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property isTimestampHidden

public isTimestampHidden: pulumi.Output<boolean | undefined>;

Whether to hide the timestamp in the chart. false by default.

property maxDelay

public maxDelay: pulumi.Output<number | undefined>;

How long (in seconds) to wait for late datapoints

property maxPrecision

public maxPrecision: pulumi.Output<number | undefined>;

The maximum precision to for value displayed.

property name

public name: pulumi.Output<string>;

Name of the chart.

property programText

public programText: pulumi.Output<string>;

Signalflow program text for the chart. More info in the SignalFx docs.

property refreshInterval

public refreshInterval: pulumi.Output<number | undefined>;

How often (in seconds) to refresh the value.

property secondaryVisualization

public secondaryVisualization: pulumi.Output<string | undefined>;

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (None).

property showSparkLine

public showSparkLine: pulumi.Output<boolean | undefined>;

Whether to show a trend line below the current value. false by default.

property unitPrefix

public unitPrefix: pulumi.Output<string | undefined>;

Must be "Metric" or "Binary". "Metric" by default.

property url

public url: pulumi.Output<string>;

URL of the chart

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vizOptions

public vizOptions: pulumi.Output<SingleValueChartVizOption[] | undefined>;

Plot-level customization options, associated with a publish statement.

Resource Team

class Team extends CustomResource

Handles management of SignalFx teams.

You can configure team notification policies using this resource and the various notifications_* properties.

constructor

new Team(name: string, args?: TeamArgs, opts?: pulumi.CustomResourceOptions)

Create a Team resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TeamState, opts?: pulumi.CustomResourceOptions): Team

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Team

Returns true if the given object is an instance of Team. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Description of the team.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property members

public members: pulumi.Output<string[] | undefined>;

List of user IDs to include in the team.

property name

public name: pulumi.Output<string>;

Name of the team.

property notificationsCriticals

public notificationsCriticals: pulumi.Output<string[] | undefined>;

Where to send notifications for critical alerts

property notificationsDefaults

public notificationsDefaults: pulumi.Output<string[] | undefined>;

Where to send notifications for default alerts

property notificationsInfos

public notificationsInfos: pulumi.Output<string[] | undefined>;

Where to send notifications for info alerts

property notificationsMajors

public notificationsMajors: pulumi.Output<string[] | undefined>;

Where to send notifications for major alerts

property notificationsMinors

public notificationsMinors: pulumi.Output<string[] | undefined>;

Where to send notifications for minor alerts

property notificationsWarnings

public notificationsWarnings: pulumi.Output<string[] | undefined>;

Where to send notifications for warning alerts

property url

public url: pulumi.Output<string>;

URL of the team

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TextChart

class TextChart extends CustomResource

This special type of chart doesn’t display any metric data. Rather, it lets you place a text note on the dashboard.

Example Usage

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

const mynote0 = new signalfx.TextChart("mynote0", {
    description: "Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
    markdown: `    1. First ordered list item
    2. Another item
      * Unordered sub-list.
    1. Actual numbers don't matter, just that it's a number
      1. Ordered sub-list
    4. And another item.

       You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

       To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
       Note that this line is separate, but within the same paragraph.⋅⋅
       (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

    * Unordered list can use asterisks
    - Or minuses
    + Or pluses
`,
});

constructor

new TextChart(name: string, args: TextChartArgs, opts?: pulumi.CustomResourceOptions)

Create a TextChart resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TextChartState, opts?: pulumi.CustomResourceOptions): TextChart

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TextChart

Returns true if the given object is an instance of TextChart. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Description of the text note.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property markdown

public markdown: pulumi.Output<string>;

Markdown text to display.

property name

public name: pulumi.Output<string>;

Name of the text note.

property url

public url: pulumi.Output<string>;

URL of the chart

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TimeChart

class TimeChart extends CustomResource

Provides a SignalFx time chart resource. This can be used to create and manage the different types of time charts.

Time charts display data points over a period of time.

Example Usage

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

const mychart0 = new signalfx.TimeChart("mychart0", {
    axisLeft: {
        label: "CPU Total Idle",
        lowWatermark: 1000,
    },
    legendOptionsFields: [
        {
            enabled: false,
            property: "collector",
        },
        {
            enabled: false,
            property: "hostname",
        },
    ],
    plotType: "LineChart",
    programText: "data(\"cpu.total.idle\").publish(label=\"CPU Idle\")\n",
    showDataMarkers: true,
    timeRange: 3600,
    vizOptions: [{
        axis: "left",
        color: "orange",
        label: "CPU Idle",
    }],
});

constructor

new TimeChart(name: string, args: TimeChartArgs, opts?: pulumi.CustomResourceOptions)

Create a TimeChart resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TimeChartState, opts?: pulumi.CustomResourceOptions): TimeChart

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TimeChart

Returns true if the given object is an instance of TimeChart. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property axesIncludeZero

public axesIncludeZero: pulumi.Output<boolean | undefined>;

Force the chart to display zero on the y-axes, even if none of the data is near zero.

property axesPrecision

public axesPrecision: pulumi.Output<number | undefined>;

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

property axisLeft

public axisLeft: pulumi.Output<TimeChartAxisLeft | undefined>;

Set of axis options.

property axisRight

public axisRight: pulumi.Output<TimeChartAxisRight | undefined>;

Set of axis options.

property colorBy

public colorBy: pulumi.Output<string | undefined>;

Must be "Dimension" or "Metric". "Dimension" by default.

property description

public description: pulumi.Output<string | undefined>;

Description of the chart.

property disableSampling

public disableSampling: pulumi.Output<boolean | undefined>;

If false, samples a subset of the output MTS, which improves UI performance. false by default

property endTime

public endTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property eventOptions

public eventOptions: pulumi.Output<TimeChartEventOption[] | undefined>;

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

property histogramOptions

public histogramOptions: pulumi.Output<TimeChartHistogramOption[] | undefined>;

Only used when plotType is "Histogram". Histogram specific options.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property legendFieldsToHides

public legendFieldsToHides: pulumi.Output<string[] | undefined>;

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legendOptionsFields.

property legendOptionsFields

public legendOptionsFields: pulumi.Output<TimeChartLegendOptionsField[] | undefined>;

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legendFieldsToHide.

property maxDelay

public maxDelay: pulumi.Output<number | undefined>;

How long (in seconds) to wait for late datapoints.

property minimumResolution

public minimumResolution: pulumi.Output<number | undefined>;

The minimum resolution (in seconds) to use for computing the underlying program.

property name

public name: pulumi.Output<string>;

Name of the chart.

property onChartLegendDimension

public onChartLegendDimension: pulumi.Output<string | undefined>;

Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: "metric", "plotLabel" and any dimension.

property plotType

public plotType: pulumi.Output<string | undefined>;

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plotType by default.

property programText

public programText: pulumi.Output<string>;

Signalflow program text for the chart. More info in the SignalFx docs.

property showDataMarkers

public showDataMarkers: pulumi.Output<boolean | undefined>;

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

property showEventLines

public showEventLines: pulumi.Output<boolean | undefined>;

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

property stacked

public stacked: pulumi.Output<boolean | undefined>;

Whether area and bar charts in the visualization should be stacked. false by default.

property startTime

public startTime: pulumi.Output<number | undefined>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property tags

public tags: pulumi.Output<string[] | undefined>;

Tags associated with the chart

property timeRange

public timeRange: pulumi.Output<number | undefined>;

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with startTime and endTime.

property timezone

public timezone: pulumi.Output<string | undefined>;

Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set “timezone”: “Europe/Paris” and then use the transformation sum(cycle=“week”, cycle_start=“Monday”) in your chart’s SignalFlow program, the calendar window starts on Monday, Paris time. See the full list of timezones for more. "UTC" by default.

property unitPrefix

public unitPrefix: pulumi.Output<string | undefined>;

Must be "Metric" or "Binary”. "Metric" by default.

property url

public url: pulumi.Output<string>;

URL of the chart

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vizOptions

public vizOptions: pulumi.Output<TimeChartVizOption[] | undefined>;

Plot-level customization options, associated with a publish statement.

Resource WebhookIntegration

class WebhookIntegration extends CustomResource

SignalFx Webhook integration.

NOTE When managing integrations you’ll need to use an admin token to authenticate the SignalFx provider. Otherwise you’ll receive a 4xx error.

Example Usage

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

const webhookMyteam = new signalfx.WebhookResource("webhookMyteam", {
    enabled: true,
    headers: [{
        headerKey: "someHeader",
        headerValue: "valueForThatHeader",
    }],
    name: "Webhook - My Team",
    sharedSecret: "abc1234",
    url: "https://www.example.com",
});

constructor

new WebhookIntegration(name: string, args: WebhookIntegrationArgs, opts?: pulumi.CustomResourceOptions)

Create a WebhookIntegration resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WebhookIntegrationState, opts?: pulumi.CustomResourceOptions): WebhookIntegration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is WebhookIntegration

Returns true if the given object is an instance of WebhookIntegration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean>;

Whether the integration is enabled.

property headers

public headers: pulumi.Output<WebhookIntegrationHeader[] | undefined>;

A header to send with the request

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the integration.

property sharedSecret

public sharedSecret: pulumi.Output<string | undefined>;

property url

public url: pulumi.Output<string | undefined>;

The URL to request

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getAwsServices

getAwsServices(args?: GetAwsServicesArgs, opts?: pulumi.InvokeOptions): Promise<GetAwsServicesResult>

Function getAzureServices

getAzureServices(args?: GetAzureServicesArgs, opts?: pulumi.InvokeOptions): Promise<GetAzureServicesResult>

Function getDimensionValues

getDimensionValues(args: GetDimensionValuesArgs, opts?: pulumi.InvokeOptions): Promise<GetDimensionValuesResult>

Use this data source to get a list of dimension values matching the provided query.

NOTE This data source only allows 1000 values, as it’s kinda nuts to make anything with forEach that big in SignalFx. This is negotiable.

Others

interface AlertMutingRuleArgs

interface AlertMutingRuleArgs

The set of arguments for constructing a AlertMutingRule resource.

property description

description: pulumi.Input<string>;

The description for this muting rule

property detectors

detectors?: pulumi.Input<pulumi.Input<string>[]>;

A convenience attribute that associated this muting rule with specific detector ids.

property filters

filters: pulumi.Input<pulumi.Input<AlertMutingRuleFilter>[]>;

Filters for this rule. See Creating muting rules from scratch for more information.

property startTime

startTime: pulumi.Input<number>;

Starting time of an alert muting rule as a Unit time stamp in seconds.

property stopTime

stopTime?: pulumi.Input<number>;

Starting time of an alert muting rule as a Unix time stamp in seconds.

interface AlertMutingRuleState

interface AlertMutingRuleState

Input properties used for looking up and filtering AlertMutingRule resources.

property description

description?: pulumi.Input<string>;

The description for this muting rule

property detectors

detectors?: pulumi.Input<pulumi.Input<string>[]>;

A convenience attribute that associated this muting rule with specific detector ids.

property effectiveStartTime

effectiveStartTime?: pulumi.Input<number>;

property filters

filters?: pulumi.Input<pulumi.Input<AlertMutingRuleFilter>[]>;

Filters for this rule. See Creating muting rules from scratch for more information.

property startTime

startTime?: pulumi.Input<number>;

Starting time of an alert muting rule as a Unit time stamp in seconds.

property stopTime

stopTime?: pulumi.Input<number>;

Starting time of an alert muting rule as a Unix time stamp in seconds.

interface DashboardArgs

interface DashboardArgs

The set of arguments for constructing a Dashboard resource.

property authorizedWriterTeams

authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs that have write access to this dashboard

property authorizedWriterUsers

authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;

User IDs that have write access to this dashboard

property charts

charts?: pulumi.Input<pulumi.Input<DashboardChart>[]>;

Chart ID and layout information for the charts in the dashboard.

property chartsResolution

chartsResolution?: pulumi.Input<string>;

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

property columns

columns?: pulumi.Input<pulumi.Input<DashboardColumn>[]>;

Column number for the layout.

property dashboardGroup

dashboardGroup: pulumi.Input<string>;

The ID of the dashboard group that contains the dashboard.

property description

description?: pulumi.Input<string>;

Variable description.

property discoveryOptionsQuery

discoveryOptionsQuery?: pulumi.Input<string>;

property discoveryOptionsSelectors

discoveryOptionsSelectors?: pulumi.Input<pulumi.Input<string>[]>;

property endTime

endTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. You must specify timeSpanType = "absolute" too.

property eventOverlays

eventOverlays?: pulumi.Input<pulumi.Input<DashboardEventOverlay>[]>;

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlay property instead.

property filters

filters?: pulumi.Input<pulumi.Input<DashboardFilter>[]>;

Filter to apply to the charts when displaying the dashboard.

property grids

grids?: pulumi.Input<pulumi.Input<DashboardGrid>[]>;

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

property name

name?: pulumi.Input<string>;

Name of the dashboard.

property selectedEventOverlays

selectedEventOverlays?: pulumi.Input<pulumi.Input<DashboardSelectedEventOverlay>[]>;

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in eventOverlay, which are similar to the properties here.

property startTime

startTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. You must specify timeSpanType = "absolute" too.

property timeRange

timeRange?: pulumi.Input<string>;

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

property variables

variables?: pulumi.Input<pulumi.Input<DashboardVariable>[]>;

Dashboard variable to apply to each chart in the dashboard.

interface DashboardGroupArgs

interface DashboardGroupArgs

The set of arguments for constructing a DashboardGroup resource.

property authorizedWriterTeams

authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorizedWriterTeams).

property authorizedWriterUsers

authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;

User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorizedWriterTeams).

property dashboards

dashboards?: pulumi.Input<pulumi.Input<DashboardGroupDashboard>[]>;

Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

property description

description?: pulumi.Input<string>;

Description of the dashboard group.

property importQualifiers

importQualifiers?: pulumi.Input<pulumi.Input<DashboardGroupImportQualifier>[]>;

property name

name?: pulumi.Input<string>;

Name of the dashboard group.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs to associate the dashboard group to.

interface DashboardGroupState

interface DashboardGroupState

Input properties used for looking up and filtering DashboardGroup resources.

property authorizedWriterTeams

authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s team (or user id in authorizedWriterTeams).

property authorizedWriterUsers

authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;

User IDs that have write access to this dashboard group. Remember to use an admin’s token if using this feature and to include that admin’s user id (or team id in authorizedWriterTeams).

property dashboards

dashboards?: pulumi.Input<pulumi.Input<DashboardGroupDashboard>[]>;

Mirrored dashboards in this dashboard group. Note: This feature is not present in all accounts. Please contact support if you are unsure.

property description

description?: pulumi.Input<string>;

Description of the dashboard group.

property importQualifiers

importQualifiers?: pulumi.Input<pulumi.Input<DashboardGroupImportQualifier>[]>;

property name

name?: pulumi.Input<string>;

Name of the dashboard group.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs to associate the dashboard group to.

interface DashboardState

interface DashboardState

Input properties used for looking up and filtering Dashboard resources.

property authorizedWriterTeams

authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs that have write access to this dashboard

property authorizedWriterUsers

authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;

User IDs that have write access to this dashboard

property charts

charts?: pulumi.Input<pulumi.Input<DashboardChart>[]>;

Chart ID and layout information for the charts in the dashboard.

property chartsResolution

chartsResolution?: pulumi.Input<string>;

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

property columns

columns?: pulumi.Input<pulumi.Input<DashboardColumn>[]>;

Column number for the layout.

property dashboardGroup

dashboardGroup?: pulumi.Input<string>;

The ID of the dashboard group that contains the dashboard.

property description

description?: pulumi.Input<string>;

Variable description.

property discoveryOptionsQuery

discoveryOptionsQuery?: pulumi.Input<string>;

property discoveryOptionsSelectors

discoveryOptionsSelectors?: pulumi.Input<pulumi.Input<string>[]>;

property endTime

endTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. You must specify timeSpanType = "absolute" too.

property eventOverlays

eventOverlays?: pulumi.Input<pulumi.Input<DashboardEventOverlay>[]>;

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlay property instead.

property filters

filters?: pulumi.Input<pulumi.Input<DashboardFilter>[]>;

Filter to apply to the charts when displaying the dashboard.

property grids

grids?: pulumi.Input<pulumi.Input<DashboardGrid>[]>;

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

property name

name?: pulumi.Input<string>;

Name of the dashboard.

property selectedEventOverlays

selectedEventOverlays?: pulumi.Input<pulumi.Input<DashboardSelectedEventOverlay>[]>;

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in eventOverlay, which are similar to the properties here.

property startTime

startTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. You must specify timeSpanType = "absolute" too.

property timeRange

timeRange?: pulumi.Input<string>;

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

property url

url?: pulumi.Input<string>;

URL of the dashboard

property variables

variables?: pulumi.Input<pulumi.Input<DashboardVariable>[]>;

Dashboard variable to apply to each chart in the dashboard.

interface DataLinkArgs

interface DataLinkArgs

The set of arguments for constructing a DataLink resource.

property contextDashboardId

contextDashboardId?: pulumi.Input<string>;

If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.

property propertyName

propertyName?: pulumi.Input<string>;

Name (key) of the metadata that’s the trigger of a data link. If you specify propertyValue, you must specify propertyName.

property propertyValue

propertyValue?: pulumi.Input<string>;

Value of the metadata that’s the trigger of a data link. If you specify this property, you must also specify propertyName.

property targetExternalUrls

targetExternalUrls?: pulumi.Input<pulumi.Input<DataLinkTargetExternalUrl>[]>;

Link to an external URL

property targetSignalfxDashboards

targetSignalfxDashboards?: pulumi.Input<pulumi.Input<DataLinkTargetSignalfxDashboard>[]>;

Link to a SignalFx dashboard

property targetSplunks

targetSplunks?: pulumi.Input<pulumi.Input<DataLinkTargetSplunk>[]>;

Link to an external URL

interface DataLinkState

interface DataLinkState

Input properties used for looking up and filtering DataLink resources.

property contextDashboardId

contextDashboardId?: pulumi.Input<string>;

If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.

property propertyName

propertyName?: pulumi.Input<string>;

Name (key) of the metadata that’s the trigger of a data link. If you specify propertyValue, you must specify propertyName.

property propertyValue

propertyValue?: pulumi.Input<string>;

Value of the metadata that’s the trigger of a data link. If you specify this property, you must also specify propertyName.

property targetExternalUrls

targetExternalUrls?: pulumi.Input<pulumi.Input<DataLinkTargetExternalUrl>[]>;

Link to an external URL

property targetSignalfxDashboards

targetSignalfxDashboards?: pulumi.Input<pulumi.Input<DataLinkTargetSignalfxDashboard>[]>;

Link to a SignalFx dashboard

property targetSplunks

targetSplunks?: pulumi.Input<pulumi.Input<DataLinkTargetSplunk>[]>;

Link to an external URL

interface DetectorArgs

interface DetectorArgs

The set of arguments for constructing a Detector resource.

property authorizedWriterTeams

authorizedWriterTeams?: pulumi.Input<pulumi.Input<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 authorizedWriterUsers).

property authorizedWriterUsers

authorizedWriterUsers?: pulumi.Input<pulumi.Input<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 authorizedWriterTeams).

property description

description?: pulumi.Input<string>;

Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.

property disableSampling

disableSampling?: pulumi.Input<boolean>;

When false, the visualization may sample the output timeseries rather than displaying them all. false by default.

property endTime

endTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property maxDelay

maxDelay?: pulumi.Input<number>;

How long (in seconds) to wait for late datapoints. See Delayed Datapoints for more info. Max value is 900 seconds (15 minutes). Auto (as little as possible) by default.

property name

name?: pulumi.Input<string>;

Name of the detector.

property programText

programText: pulumi.Input<string>;

Signalflow program text for the detector. More info in the SignalFx docs.

property rules

rules: pulumi.Input<pulumi.Input<DetectorRule>[]>;

Set of rules used for alerting.

property showDataMarkers

showDataMarkers?: pulumi.Input<boolean>;

When true, markers will be drawn for each datapoint within the visualization. true by default.

property showEventLines

showEventLines?: pulumi.Input<boolean>;

When true, the visualization will display a vertical line for each event trigger. false by default.

property startTime

startTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs to associate the detector to.

property timeRange

timeRange?: pulumi.Input<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.

property vizOptions

vizOptions?: pulumi.Input<pulumi.Input<DetectorVizOption>[]>;

Plot-level customization options, associated with a publish statement.

interface DetectorState

interface DetectorState

Input properties used for looking up and filtering Detector resources.

property authorizedWriterTeams

authorizedWriterTeams?: pulumi.Input<pulumi.Input<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 authorizedWriterUsers).

property authorizedWriterUsers

authorizedWriterUsers?: pulumi.Input<pulumi.Input<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 authorizedWriterTeams).

property description

description?: pulumi.Input<string>;

Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.

property disableSampling

disableSampling?: pulumi.Input<boolean>;

When false, the visualization may sample the output timeseries rather than displaying them all. false by default.

property endTime

endTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property maxDelay

maxDelay?: pulumi.Input<number>;

How long (in seconds) to wait for late datapoints. See Delayed Datapoints for more info. Max value is 900 seconds (15 minutes). Auto (as little as possible) by default.

property name

name?: pulumi.Input<string>;

Name of the detector.

property programText

programText?: pulumi.Input<string>;

Signalflow program text for the detector. More info in the SignalFx docs.

property rules

rules?: pulumi.Input<pulumi.Input<DetectorRule>[]>;

Set of rules used for alerting.

property showDataMarkers

showDataMarkers?: pulumi.Input<boolean>;

When true, markers will be drawn for each datapoint within the visualization. true by default.

property showEventLines

showEventLines?: pulumi.Input<boolean>;

When true, the visualization will display a vertical line for each event trigger. false by default.

property startTime

startTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

Team IDs to associate the detector to.

property timeRange

timeRange?: pulumi.Input<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.

property url

url?: pulumi.Input<string>;

URL of the detector

property vizOptions

vizOptions?: pulumi.Input<pulumi.Input<DetectorVizOption>[]>;

Plot-level customization options, associated with a publish statement.

interface EventFeedChartArgs

interface EventFeedChartArgs

The set of arguments for constructing a EventFeedChart resource.

property description

description?: pulumi.Input<string>;

Description of the text note.

property endTime

endTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property name

name?: pulumi.Input<string>;

Name of the text note.

property programText

programText: pulumi.Input<string>;

Signalflow program text for the chart. More infoin the SignalFx docs.

property startTime

startTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property timeRange

timeRange?: pulumi.Input<number>;

From when to display data. SignalFx time syntax (e.g. "-5m", "-1h"). Conflicts with startTime and endTime.

interface EventFeedChartState

interface EventFeedChartState

Input properties used for looking up and filtering EventFeedChart resources.

property description

description?: pulumi.Input<string>;

Description of the text note.

property endTime

endTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property name

name?: pulumi.Input<string>;

Name of the text note.

property programText

programText?: pulumi.Input<string>;

Signalflow program text for the chart. More infoin the SignalFx docs.

property startTime

startTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property timeRange

timeRange?: pulumi.Input<number>;

From when to display data. SignalFx time syntax (e.g. "-5m", "-1h"). Conflicts with startTime and endTime.

property url

url?: pulumi.Input<string>;

URL of the chart

interface GetAwsServicesArgs

interface GetAwsServicesArgs

A collection of arguments for invoking getAwsServices.

property services

services?: GetAwsServicesService[];

interface GetAwsServicesResult

interface GetAwsServicesResult

A collection of values returned by getAwsServices.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property services

services?: GetAwsServicesService[];

interface GetAzureServicesArgs

interface GetAzureServicesArgs

A collection of arguments for invoking getAzureServices.

property services

services?: GetAzureServicesService[];

interface GetAzureServicesResult

interface GetAzureServicesResult

A collection of values returned by getAzureServices.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property services

services?: GetAzureServicesService[];

interface GetDimensionValuesArgs

interface GetDimensionValuesArgs

A collection of arguments for invoking getDimensionValues.

property query

query: string;

interface GetDimensionValuesResult

interface GetDimensionValuesResult

A collection of values returned by getDimensionValues.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property query

query: string;

property values

values: string[];

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface HeatmapChartArgs

interface HeatmapChartArgs

The set of arguments for constructing a HeatmapChart resource.

property colorRange

colorRange?: pulumi.Input<HeatmapChartColorRange>;

Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

property colorScales

colorScales?: pulumi.Input<pulumi.Input<HeatmapChartColorScale>[]>;

One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: colorScale { gt = 60, color = "blue" } colorScale { lte = 60, color = "yellow" }. Look at this link.

property description

description?: pulumi.Input<string>;

Description of the chart.

property disableSampling

disableSampling?: pulumi.Input<boolean>;

If false, samples a subset of the output MTS, which improves UI performance. false by default.

property groupBies

groupBies?: pulumi.Input<pulumi.Input<string>[]>;

Properties to group by in the heatmap (in nesting order).

property hideTimestamp

hideTimestamp?: pulumi.Input<boolean>;

Whether to show the timestamp in the chart. false by default.

property maxDelay

maxDelay?: pulumi.Input<number>;

How long (in seconds) to wait for late datapoints.

property minimumResolution

minimumResolution?: pulumi.Input<number>;

The minimum resolution (in seconds) to use for computing the underlying program.

property name

name?: pulumi.Input<string>;

Name of the chart.

property programText

programText: pulumi.Input<string>;

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

property refreshInterval

refreshInterval?: pulumi.Input<number>;

How often (in seconds) to refresh the values of the heatmap.

property sortBy

sortBy?: pulumi.Input<string>;

The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).

property unitPrefix

unitPrefix?: pulumi.Input<string>;

Must be "Metric" or "Binary”. "Metric" by default.

interface HeatmapChartState

interface HeatmapChartState

Input properties used for looking up and filtering HeatmapChart resources.

property colorRange

colorRange?: pulumi.Input<HeatmapChartColorRange>;

Values and color for the color range. Example: colorRange : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

property colorScales

colorScales?: pulumi.Input<pulumi.Input<HeatmapChartColorScale>[]>;

One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example: colorScale { gt = 60, color = "blue" } colorScale { lte = 60, color = "yellow" }. Look at this link.

property description

description?: pulumi.Input<string>;

Description of the chart.

property disableSampling

disableSampling?: pulumi.Input<boolean>;

If false, samples a subset of the output MTS, which improves UI performance. false by default.

property groupBies

groupBies?: pulumi.Input<pulumi.Input<string>[]>;

Properties to group by in the heatmap (in nesting order).

property hideTimestamp

hideTimestamp?: pulumi.Input<boolean>;

Whether to show the timestamp in the chart. false by default.

property maxDelay

maxDelay?: pulumi.Input<number>;

How long (in seconds) to wait for late datapoints.

property minimumResolution

minimumResolution?: pulumi.Input<number>;

The minimum resolution (in seconds) to use for computing the underlying program.

property name

name?: pulumi.Input<string>;

Name of the chart.

property programText

programText?: pulumi.Input<string>;

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

property refreshInterval

refreshInterval?: pulumi.Input<number>;

How often (in seconds) to refresh the values of the heatmap.

property sortBy

sortBy?: pulumi.Input<string>;

The property to use when sorting the elements. Must be prepended with + for ascending or - for descending (e.g. -foo).

property unitPrefix

unitPrefix?: pulumi.Input<string>;

Must be "Metric" or "Binary”. "Metric" by default.

property url

url?: pulumi.Input<string>;

URL of the chart

interface ListChartArgs

interface ListChartArgs

The set of arguments for constructing a ListChart resource.

property colorBy

colorBy?: pulumi.Input<string>;

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

property colorScales

colorScales?: pulumi.Input<pulumi.Input<ListChartColorScale>[]>;

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

property description

description?: pulumi.Input<string>;

Description of the chart.

property disableSampling

disableSampling?: pulumi.Input<boolean>;

If false, samples a subset of the output MTS, which improves UI performance. false by default.

property endTime

endTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property legendFieldsToHides

legendFieldsToHides?: pulumi.Input<pulumi.Input<string>[]>;

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legendOptionsFields.

property legendOptionsFields

legendOptionsFields?: pulumi.Input<pulumi.Input<ListChartLegendOptionsField>[]>;

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legendFieldsToHide.

property maxDelay

maxDelay?: pulumi.Input<number>;

How long (in seconds) to wait for late datapoints.

property maxPrecision

maxPrecision?: pulumi.Input<number>;

Maximum number of digits to display when rounding values up or down.

property name

name?: pulumi.Input<string>;

Name of the chart.

property programText

programText: pulumi.Input<string>;

Signalflow program text for the chart. More infoin the SignalFx docs.

property refreshInterval

refreshInterval?: pulumi.Input<number>;

How often (in seconds) to refresh the values of the list.

property secondaryVisualization

secondaryVisualization?: pulumi.Input<string>;

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

property sortBy

sortBy?: pulumi.Input<string>;

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sfMetric" for plot.

property startTime

startTime?: pulumi.Input<number>;

Seconds since epoch. Used for visualization. Conflicts with timeRange.

property timeRange

timeRange?: pulumi.Input<number>;

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with startTime and endTime.

property unitPrefix

unitPrefix?: pulumi.Input<string>;

Must be "Metric" or "Binary”. "Metric" by default.

property vizOptions

vizOptions?: pulumi.Input<pulumi.Input<ListChartVizOption>[]>;