Module types/output

namespace insights

namespace plugins

APIs

namespace insights

interface EventEvent

interface EventEvent

property attributes

attributes: EventEventAttribute[];

property timestamp

timestamp?: undefined | number;

property type

type: string;

interface EventEventAttribute

interface EventEventAttribute

property key

key: string;

property type

type?: undefined | string;

property value

value: string;

namespace plugins

interface AlertConditionTerm

interface AlertConditionTerm

property duration

duration: number;

property operator

operator?: undefined | string;

property priority

priority?: undefined | string;

property threshold

threshold: number;

property timeFunction

timeFunction: string;

interface WorkloadEntitySearchQuery

interface WorkloadEntitySearchQuery

property query

query: string;

The query.

APIs

interface AlertChannelConfig

interface AlertChannelConfig

property apiKey

apiKey?: undefined | string;

The API key for integrating with OpsGenie.

property authPassword

authPassword?: undefined | string;

Specifies an authentication password for use with a channel. Supported by the webhook channel type.

property authType

authType?: undefined | string;

Specifies an authentication method for use with a channel. Supported by the webhook channel type. Only HTTP basic authentication is currently supported via the value BASIC.

property authUsername

authUsername?: undefined | string;

Specifies an authentication username for use with a channel. Supported by the webhook channel type.

property baseUrl

baseUrl?: undefined | string;

The base URL of the webhook destination.

property channel

channel?: undefined | string;

The Slack channel to send notifications to. * opsgenie

property headers

headers?: undefined | {[key: string]: string};

A map of key/value pairs that represents extra HTTP headers to be sent along with the webhook payload.

property headersString

headersString?: undefined | string;

Use instead of headers if the desired payload is more complex than a list of key/value pairs (e.g. a set of headers that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with headers.

property includeJsonAttachment

includeJsonAttachment?: undefined | string;

0 or 1. Flag for whether or not to attach a JSON document containing information about the associated alert to the email that is sent to recipients. * webhook

property key

key?: undefined | string;

The key for integrating with VictorOps.

property payload

payload?: undefined | {[key: string]: string};

A map of key/value pairs that represents the webhook payload. Must provide payloadType if setting this argument.

property payloadString

payloadString?: undefined | string;

Use instead of payload if the desired payload is more complex than a list of key/value pairs (e.g. a payload that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with payload.

property payloadType

payloadType?: undefined | string;

Can either be application/json or application/x-www-form-urlencoded. The payloadType argument is required if payload is set. * pagerduty

property recipients

recipients?: undefined | string;

A set of recipients for targeting notifications. Multiple values are comma separated.

property region

region?: undefined | string;

The data center region to store your data. Valid values are US and EU. Default is US.

property routeKey

routeKey?: undefined | string;

The route key for integrating with VictorOps. * slack

property serviceKey

serviceKey?: undefined | string;

Specifies the service key for integrating with Pagerduty. * victorops

property tags

tags?: undefined | string;

A set of tags for targeting notifications. Multiple values are comma separated.

property teams

teams?: undefined | string;

A set of teams for targeting notifications. Multiple values are comma separated.

property url

url?: undefined | string;

Your organization’s Slack URL.

property userId

userId?: undefined | string;

interface AlertConditionTerm

interface AlertConditionTerm

property duration

duration: number;

property operator

operator?: undefined | string;

property priority

priority?: undefined | string;

property threshold

threshold: number;

property timeFunction

timeFunction: string;

interface DashboardFilter

interface DashboardFilter

property attributes

attributes?: string[];

property eventTypes

eventTypes: string[];

interface DashboardWidget

interface DashboardWidget

property column

column: number;

property compareWiths

compareWiths?: DashboardWidgetCompareWith[];

property drilldownDashboardId

drilldownDashboardId?: undefined | number;

property duration

duration?: undefined | number;

property endTime

endTime?: undefined | number;

property entityIds

entityIds?: number[];

property facet

facet?: undefined | string;

property height

height?: undefined | number;

property limit

limit?: undefined | number;

property metrics

metrics?: DashboardWidgetMetric[];

property notes

notes?: undefined | string;

property nrql

nrql?: undefined | string;

property orderBy

orderBy?: undefined | string;

property rawMetricName

rawMetricName: string;

property row

row: number;

property source

source?: undefined | string;

property thresholdRed

thresholdRed?: undefined | number;

property thresholdYellow

thresholdYellow?: undefined | number;

property title

title: string;

The title of the dashboard.

property visualization

visualization: string;

property widgetId

widgetId: number;

property width

width?: undefined | number;

interface DashboardWidgetCompareWith

interface DashboardWidgetCompareWith

property offsetDuration

offsetDuration: string;

property presentation

presentation: DashboardWidgetCompareWithPresentation;

interface DashboardWidgetCompareWithPresentation

interface DashboardWidgetCompareWithPresentation

property color

color: string;

property name

name: string;

interface DashboardWidgetMetric

interface DashboardWidgetMetric

property name

name: string;

property scope

scope?: undefined | string;

property units

units?: undefined | string;

property values

values?: string[];

interface GetAlertChannelConfig

interface GetAlertChannelConfig

property apiKey

apiKey?: undefined | string;

property authPassword

authPassword?: undefined | string;

property authType

authType?: undefined | string;

property authUsername

authUsername?: undefined | string;

property baseUrl

baseUrl?: undefined | string;

property channel

channel?: undefined | string;

property headers

headers?: undefined | {[key: string]: string};

property includeJsonAttachment

includeJsonAttachment?: undefined | string;

property key

key?: undefined | string;

property payload

payload?: undefined | {[key: string]: string};

property payloadType

payloadType?: undefined | string;

property recipients

recipients?: undefined | string;

property region

region?: undefined | string;

property routeKey

routeKey?: undefined | string;

property serviceKey

serviceKey?: undefined | string;

property tags

tags?: undefined | string;

property teams

teams?: undefined | string;

property url

url?: undefined | string;

property userId

userId?: undefined | string;

interface InfraAlertConditionCritical

interface InfraAlertConditionCritical

property duration

duration: number;

property timeFunction

timeFunction?: undefined | string;

property value

value?: undefined | number;

interface InfraAlertConditionWarning

interface InfraAlertConditionWarning

property duration

duration: number;

property timeFunction

timeFunction?: undefined | string;

property value

value?: undefined | number;

interface NrqlAlertConditionNrql

interface NrqlAlertConditionNrql

property query

query: string;

property sinceValue

sinceValue: string;

interface NrqlAlertConditionTerm

interface NrqlAlertConditionTerm

property duration

duration: number;

property operator

operator?: undefined | string;

property priority

priority?: undefined | string;

property threshold

threshold: number;

property timeFunction

timeFunction: string;