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

Resources

Others

Resources

Resource Dashboard

class Dashboard extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/dashboard.html.markdown.

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): boolean

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 charts

public charts: pulumi.Output<outputs.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<outputs.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 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<outputs.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<outputs.DashboardFilter[] | undefined>;

Filter to apply to the charts when displaying the dashboard.

property grids

public grids: pulumi.Output<outputs.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<outputs.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<outputs.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",
});

Example Usage With Mirrored Dashboards

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

const mydashboardgroupWithmirrors = new signalfx.DashboardGroup("mydashboardgroupWithmirrors", {
    // You can add as many of these as you like. Make sure your account
    // supports this feature!
    dashboards: [{
        dashboardId: signalfx_dashboard_gc_dashboard.id,
        descriptionOverride: "Garbage Collection dashboard maintained by JVM team",
        filterOverrides: [{
            negated: false,
            property: "service",
            values: ["myservice"],
        }],
        nameOverride: "GC For My Service",
        variableOverrides: [{
            property: "region",
            values: ["us-west1"],
            valuesSuggesteds: [
                "us-west-1",
                "us-east-1",
            ],
        }],
    }],
    description: "Cool dashboard group",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/dashboard_group.html.markdown.

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): boolean

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 dashboards

public dashboards: pulumi.Output<outputs.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 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 Detector

class Detector extends CustomResource

Provides a SignalFx detector resource. This can be used to create and manage detectors.

Example Usage

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

const config = new pulumi.Config();
const clusters = config.get("clusters") || [
    "clusterA",
    "clusterB",
];

const applicationDelay: signalfx.Detector[] = [];
for (let i = 0; i < clusters.length; i++) {
    applicationDelay.push(new signalfx.Detector(`application_delay-${i}`, {
        description: `your application is slow - ${clusters[i]}`,
        maxDelay: 30,
        programText: `    signal = data('app.delay', filter('cluster','${clusters[i]}'), extrapolation='last_value', maxExtrapolations=5).max()
    detect(when(signal > 60, '5m')).publish('Processing old messages 5m')
    detect(when(signal > 60, '30m')).publish('Processing old messages 30m')
`,
        rules: [
            {
                description: "maximum > 60 for 5m",
                detectLabel: "Processing old messages 5m",
                notifications: ["Email,foo-alerts@bar.com"],
                severity: "Warning",
            },
            {
                description: "maximum > 60 for 30m",
                detectLabel: "Processing old messages 30m",
                notifications: ["Email,foo-alerts@bar.com"],
                severity: "Critical",
            },
        ],
    }));
}

Notification Format

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, like so:

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

This will likely be changed in a future iteration of the provider. See SignalFX Docs for more information. For now, here are some example of how to configure each notification type:

Email
import * as pulumi from "@pulumi/pulumi";
Opsgenie

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

import * as pulumi from "@pulumi/pulumi";
PagerDuty
import * as pulumi from "@pulumi/pulumi";
Slack

Include the # on the channel name!

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

Sends notifications to a team.

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

Sends an email to every member of a team.

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

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/detector.html.markdown.

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): boolean

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 description

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

Description of the detector.

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 https://signalfx-product-docs.readthedocs-hosted.com/en/latest/charts/chart-builder.html#delayed-datapoints for more info. Max value is 900 seconds (15 minutes).

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 at https://developers.signalfx.com/docs/signalflow-overview.

property rules

public rules: pulumi.Output<outputs.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. false 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 = -1h. Defaults to 3600.

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.

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",
    }],
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/event_feed_chart.html.markdown.

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): boolean

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 info at https://developers.signalfx.com/docs/signalflow-overview.

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", {
    // You must specify one of `colorRange` or `colorScale`
    colorRange: {
        color: "#ff0000",
        maxValue: 100,
        minValue: 0,
    },
    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",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/heatmap_chart.html.markdown.

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): boolean

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<outputs.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<outputs.HeatmapChartColorScale[] | 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 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",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/list_chart.html.markdown.

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): boolean

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<outputs.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 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 lastUpdated

public lastUpdated: pulumi.Output<number>;

Latest timestamp the resource was updated

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<outputs.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 The name of the property to display. Note the special values of plotLabel (corresponding with the API’s sfMetric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed. * enabled True or False depending on if you want the property to be shown or hidden.

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 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 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 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<outputs.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"],
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/org_token.html.markdown.

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): boolean

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<outputs.OrgTokenDpmLimits | undefined>;

Specify DPM-based limits for this token.

property hostOrUsageLimits

public hostOrUsageLimits: pulumi.Output<outputs.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>;

List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info

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.

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/index.html.markdown.

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): boolean

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,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/single_value_chart.html.markdown.

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): boolean

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<outputs.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 at https://developers.signalfx.com/docs/signalflow-overview.

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<outputs.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.

Example Usage

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

const myteam0 = new signalfx.Team("myteam0", {
    description: "Super great team no jerks definitely",
    notificationsCriticals: ["PagerDuty,credentialId"],
    notificiationsInfo: ["Email,notify@example.com"],
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/team.html.markdown.

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): boolean

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>;

Members of team 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
`,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/text_chart.html.markdown.

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): boolean

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: true,
            property: "shcName",
        },
        {
            enabled: true,
            property: "role",
        },
        {
            enabled: false,
            property: "collector",
        },
        {
            enabled: false,
            property: "prefix",
        },
        {
            enabled: false,
            property: "hostname",
        },
    ],
    plotType: "LineChart",
    programText: `myfilters = filter("shcName", "prod") and filter("role", "splunkSearchhead")
data("cpu.total.idle", filter=myfilters).publish(label="CPU Idle")
`,
    showDataMarkers: true,
    timeRange: 3600,
    vizOptions: [{
        axis: "left",
        color: "orange",
        label: "CPU Idle",
    }],
});

This content is derived from https://github.com/terraform-providers/terraform-provider-signalfx/blob/master/website/docs/r/time_chart.html.markdown.

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): boolean

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<outputs.TimeChartAxisLeft | undefined>;

Set of axis options.

property axisRight

public axisRight: pulumi.Output<outputs.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<outputs.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<outputs.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<outputs.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 The name of the property to display. Note the special values of plotLabel (corresponding with the API’s sfMetric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed. * enabled True or False depending on if you want the property to be shown or hidden.

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 at https://developers.signalfx.com/docs/signalflow-overview.

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<outputs.TimeChartVizOption[] | undefined>;

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

Others

interface DashboardArgs

interface DashboardArgs

The set of arguments for constructing a Dashboard resource.

property charts

charts?: pulumi.Input<pulumi.Input<inputs.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<inputs.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 endTime

endTime?: pulumi.Input<number>;

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

property eventOverlays

eventOverlays?: pulumi.Input<pulumi.Input<inputs.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<inputs.DashboardFilter>[]>;

Filter to apply to the charts when displaying the dashboard.

property grids

grids?: pulumi.Input<pulumi.Input<inputs.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<inputs.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<inputs.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 dashboards

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

dashboards?: pulumi.Input<pulumi.Input<inputs.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 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 charts

charts?: pulumi.Input<pulumi.Input<inputs.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<inputs.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 endTime

endTime?: pulumi.Input<number>;

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

property eventOverlays

eventOverlays?: pulumi.Input<pulumi.Input<inputs.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<inputs.DashboardFilter>[]>;

Filter to apply to the charts when displaying the dashboard.

property grids

grids?: pulumi.Input<pulumi.Input<inputs.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<inputs.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<inputs.DashboardVariable>[]>;

Dashboard variable to apply to each chart in the dashboard.

interface DetectorArgs

interface DetectorArgs

The set of arguments for constructing a Detector resource.

property description

description?: pulumi.Input<string>;

Description of the detector.

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 https://signalfx-product-docs.readthedocs-hosted.com/en/latest/charts/chart-builder.html#delayed-datapoints for more info. Max value is 900 seconds (15 minutes).

property name

name?: pulumi.Input<string>;

Name of the detector.

property programText

programText: pulumi.Input<string>;

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

property rules

rules: pulumi.Input<pulumi.Input<inputs.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. false 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 = -1h. Defaults to 3600.

interface DetectorState

interface DetectorState

Input properties used for looking up and filtering Detector resources.

property description

description?: pulumi.Input<string>;

Description of the detector.

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 https://signalfx-product-docs.readthedocs-hosted.com/en/latest/charts/chart-builder.html#delayed-datapoints for more info. Max value is 900 seconds (15 minutes).

property name

name?: pulumi.Input<string>;

Name of the detector.

property programText

programText?: pulumi.Input<string>;

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

property rules

rules?: pulumi.Input<pulumi.Input<inputs.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. false 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 = -1h. Defaults to 3600.

property url

url?: pulumi.Input<string>;

URL of the detector

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 info at https://developers.signalfx.com/docs/signalflow-overview.

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 info at https://developers.signalfx.com/docs/signalflow-overview.

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

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<inputs.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<inputs.HeatmapChartColorScale>[]>;

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 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<inputs.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<inputs.HeatmapChartColorScale>[]>;

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 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<inputs.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 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<inputs.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 The name of the property to display. Note the special values of plotLabel (corresponding with the API’s sfMetric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed. * enabled True or False depending on if you want the property to be shown or hidden.

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 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 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 unitPrefix

unitPrefix?: pulumi.Input<string>;

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

property vizOptions

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

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

interface ListChartState

interface ListChartState

Input properties used for looking up and filtering ListChart resources.

property colorBy

colorBy?: pulumi.Input<string>;

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

property colorScales

colorScales?: pulumi.Input<pulumi.Input<inputs.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 lastUpdated

lastUpdated?: pulumi.Input<number>;

Latest timestamp the resource was updated

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<inputs.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 The name of the property to display. Note the special values of plotLabel (corresponding with the API’s sfMetric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed. * enabled True or False depending on if you want the property to be shown or hidden.

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 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 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 unitPrefix

unitPrefix?: pulumi.Input<string>;

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

property url

url?: pulumi.Input<string>;

URL of the chart

property vizOptions

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

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

interface OrgTokenArgs

interface OrgTokenArgs

The set of arguments for constructing a OrgToken resource.

property description

description?: pulumi.Input<string>;

Description of the token.

property disabled

disabled?: pulumi.Input<boolean>;

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

dpmLimits?: pulumi.Input<inputs.OrgTokenDpmLimits>;

Specify DPM-based limits for this token.

property hostOrUsageLimits

hostOrUsageLimits?: pulumi.Input<inputs.OrgTokenHostOrUsageLimits>;

Specify Usage-based limits for this token.

property name

name?: pulumi.Input<string>;

Name of the token.

property notifications

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

List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info

interface OrgTokenState

interface OrgTokenState

Input properties used for looking up and filtering OrgToken resources.

property description

description?: pulumi.Input<string>;

Description of the token.

property disabled

disabled?: pulumi.Input<boolean>;

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

dpmLimits?: pulumi.Input<inputs.OrgTokenDpmLimits>;

Specify DPM-based limits for this token.

property hostOrUsageLimits

hostOrUsageLimits?: pulumi.Input<inputs.OrgTokenHostOrUsageLimits>;

Specify Usage-based limits for this token.

property name

name?: pulumi.Input<string>;

Name of the token.

property notifications

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

List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property apiUrl

apiUrl?: pulumi.Input<string>;

API URL for your SignalFx org, may include a realm

property authToken

authToken?: pulumi.Input<string>;

SignalFx auth token

property customAppUrl

customAppUrl?: pulumi.Input<string>;

Application URL for your SignalFx org, often customzied for organizations using SSO

interface SingleValueChartArgs

interface SingleValueChartArgs

The set of arguments for constructing a SingleValueChart resource.

property colorBy

colorBy?: pulumi.Input<string>;

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

property colorScales

colorScales?: pulumi.Input<pulumi.Input<inputs.SingleValueChartColorScale>[]>;

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 isTimestampHidden

isTimestampHidden?: pulumi.Input<boolean>;

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

property maxDelay

maxDelay?: pulumi.Input<number>;

How long (in seconds) to wait for late datapoints

property maxPrecision

maxPrecision?: pulumi.Input<number>;

The maximum precision to for value displayed.

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 value.

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 (None).

property showSparkLine

showSparkLine?: pulumi.Input<boolean>;

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

property unitPrefix

unitPrefix?: pulumi.Input<string>;

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

property vizOptions

vizOptions?: pulumi.Input<pulumi.Input<inputs.SingleValueChartVizOption>[]>;

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

interface SingleValueChartState

interface SingleValueChartState

Input properties used for looking up and filtering SingleValueChart resources.

property colorBy

colorBy?: pulumi.Input<string>;

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

property colorScales

colorScales?: pulumi.Input<pulumi.Input<inputs.SingleValueChartColorScale>[]>;

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 isTimestampHidden

isTimestampHidden?: pulumi.Input<boolean>;

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

property maxDelay

maxDelay?: pulumi.Input<number>;

How long (in seconds) to wait for late datapoints

property maxPrecision

maxPrecision?: pulumi.Input<number>;

The maximum precision to for value displayed.

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 value.

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 (None).

property showSparkLine

showSparkLine?: pulumi.Input<boolean>;

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

property unitPrefix

unitPrefix?: pulumi.Input<string>;

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

property url

url?: pulumi.Input<string>;

URL of the chart

property vizOptions

vizOptions?: pulumi.Input<pulumi.Input<inputs.SingleValueChartVizOption>[]>;

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

interface TeamArgs

interface TeamArgs

The set of arguments for constructing a Team resource.

property description

description?: pulumi.Input<string>;

Description of the team.

property members

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

Members of team team

property name

name?: pulumi.Input<string>;

Name of the team.

property notificationsCriticals

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

Where to send notifications for critical alerts

property notificationsDefaults

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

Where to send notifications for default alerts

property notificationsInfos

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

Where to send notifications for info alerts

property notificationsMajors

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

Where to send notifications for major alerts

property notificationsMinors

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

Where to send notifications for minor alerts

property notificationsWarnings

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

Where to send notifications for warning alerts

interface TeamState

interface TeamState

Input properties used for looking up and filtering Team resources.

property description

description?: pulumi.Input<string>;

Description of the team.

property members

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

Members of team team

property name

name?: pulumi.Input<string>;

Name of the team.

property notificationsCriticals

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

Where to send notifications for critical alerts

property notificationsDefaults

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

Where to send notifications for default alerts

property notificationsInfos

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

Where to send notifications for info alerts

property notificationsMajors

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

Where to send notifications for major alerts

property notificationsMinors

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

Where to send notifications for minor alerts

property notificationsWarnings

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

Where to send notifications for warning alerts

property url

url?: pulumi.Input<string>;

URL of the team

interface TextChartArgs

interface TextChartArgs

The set of arguments for constructing a TextChart resource.

property description

description?: pulumi.Input<string>;

Description of the text note.

property markdown

markdown: pulumi.Input<string>;

Markdown text to display.

property name

name?: pulumi.Input<string>;

Name of the text note.

interface TextChartState

interface TextChartState

Input properties used for looking up and filtering TextChart resources.

property description

description?: pulumi.Input<string>;

Description of the text note.

property markdown

markdown?: pulumi.Input<string>;

Markdown text to display.

property name

name?: pulumi.Input<string>;

Name of the text note.

property url

url?: pulumi.Input<string>;

URL of the chart

interface TimeChartArgs

interface TimeChartArgs

The set of arguments for constructing a TimeChart resource.

property axesIncludeZero

axesIncludeZero?: pulumi.Input<boolean>;

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

property axesPrecision

axesPrecision?: pulumi.Input<number>;

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

property axisLeft

axisLeft?: pulumi.Input<inputs.TimeChartAxisLeft>;

Set of axis options.

property axisRight

axisRight?: pulumi.Input<inputs.TimeChartAxisRight>;

Set of axis options.

property colorBy

colorBy?: pulumi.Input<string>;

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

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 eventOptions

eventOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartEventOption>[]>;

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

histogramOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartHistogramOption>[]>;

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

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<inputs.TimeChartLegendOptionsField>[]>;

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 The name of the property to display. Note the special values of plotLabel (corresponding with the API’s sfMetric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed. * enabled True or False depending on if you want the property to be shown or hidden.

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 onChartLegendDimension

onChartLegendDimension?: pulumi.Input<string>;

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

plotType?: pulumi.Input<string>;

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

property programText

programText: pulumi.Input<string>;

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

property showDataMarkers

showDataMarkers?: pulumi.Input<boolean>;

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

property showEventLines

showEventLines?: pulumi.Input<boolean>;

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

property stacked

stacked?: pulumi.Input<boolean>;

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

property startTime

startTime?: pulumi.Input<number>;

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

property tags

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

Tags associated with the chart

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 timezone

timezone?: pulumi.Input<string>;

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

unitPrefix?: pulumi.Input<string>;

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

property vizOptions

vizOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartVizOption>[]>;

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

interface TimeChartState

interface TimeChartState

Input properties used for looking up and filtering TimeChart resources.

property axesIncludeZero

axesIncludeZero?: pulumi.Input<boolean>;

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

property axesPrecision

axesPrecision?: pulumi.Input<number>;

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

property axisLeft

axisLeft?: pulumi.Input<inputs.TimeChartAxisLeft>;

Set of axis options.

property axisRight

axisRight?: pulumi.Input<inputs.TimeChartAxisRight>;

Set of axis options.

property colorBy

colorBy?: pulumi.Input<string>;

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

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 eventOptions

eventOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartEventOption>[]>;

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

histogramOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartHistogramOption>[]>;

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

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<inputs.TimeChartLegendOptionsField>[]>;

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 The name of the property to display. Note the special values of plotLabel (corresponding with the API’s sfMetric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed. * enabled True or False depending on if you want the property to be shown or hidden.

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 onChartLegendDimension

onChartLegendDimension?: pulumi.Input<string>;

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

plotType?: pulumi.Input<string>;

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

property programText

programText?: pulumi.Input<string>;

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

property showDataMarkers

showDataMarkers?: pulumi.Input<boolean>;

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

property showEventLines

showEventLines?: pulumi.Input<boolean>;

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

property stacked

stacked?: pulumi.Input<boolean>;

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

property startTime

startTime?: pulumi.Input<number>;

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

property tags

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

Tags associated with the chart

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 timezone

timezone?: pulumi.Input<string>;

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

unitPrefix?: pulumi.Input<string>;

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

property url

url?: pulumi.Input<string>;

URL of the chart

property vizOptions

vizOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartVizOption>[]>;

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