@pulumi/newrelic 4.3.0 → 4.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dashboard.d.ts +24 -25
- package/dashboard.js +3 -7
- package/dashboard.js.map +1 -1
- package/index.d.ts +1 -0
- package/index.js +5 -0
- package/index.js.map +1 -1
- package/nrqlAlertCondition.d.ts +127 -1
- package/nrqlAlertCondition.js +97 -1
- package/nrqlAlertCondition.js.map +1 -1
- package/oneDashboardRaw.d.ts +45 -29
- package/oneDashboardRaw.js +45 -29
- package/oneDashboardRaw.js.map +1 -1
- package/package.json +2 -2
- package/package.json.dev +1 -1
- package/serviceLevel.d.ts +169 -0
- package/serviceLevel.js +124 -0
- package/serviceLevel.js.map +1 -0
- package/types/input.d.ts +142 -82
- package/types/output.d.ts +145 -85
package/types/input.d.ts
CHANGED
|
@@ -151,103 +151,32 @@ export interface AlertMutingRuleSchedule {
|
|
|
151
151
|
weeklyRepeatDays?: pulumi.Input<pulumi.Input<string>[]>;
|
|
152
152
|
}
|
|
153
153
|
export interface DashboardFilter {
|
|
154
|
-
/**
|
|
155
|
-
* (Optional) A list of attributes belonging to the specified event types to enable filtering for.
|
|
156
|
-
*/
|
|
157
154
|
attributes?: pulumi.Input<pulumi.Input<string>[]>;
|
|
158
|
-
/**
|
|
159
|
-
* (Optional) A list of event types to enable filtering for.
|
|
160
|
-
*/
|
|
161
155
|
eventTypes: pulumi.Input<pulumi.Input<string>[]>;
|
|
162
156
|
}
|
|
163
157
|
export interface DashboardWidget {
|
|
164
|
-
/**
|
|
165
|
-
* (Optional) The account ID to use when querying data. If `accountId` is omitted, the widget will use the account ID associated with the API key used in your provider configuration. You can also use `accountId` to configure cross-account widgets or simply to be explicit about which account the widget will be pulling data from.
|
|
166
|
-
*/
|
|
167
158
|
accountId?: pulumi.Input<number>;
|
|
168
|
-
/**
|
|
169
|
-
* (Required) Column position of widget from top left, starting at `1`.
|
|
170
|
-
*/
|
|
171
159
|
column: pulumi.Input<number>;
|
|
172
160
|
compareWiths?: pulumi.Input<pulumi.Input<inputs.DashboardWidgetCompareWith>[]>;
|
|
173
|
-
/**
|
|
174
|
-
* (Optional) The ID of a dashboard to link to from the widget's facets.
|
|
175
|
-
* * `attributeSheet`, `comparisonLineChart`, `eventFeed`, `eventTable`, `funnel`, `histogram`, `lineChart`, `rawJson`, `singleEvent`, or `uniquesList`:
|
|
176
|
-
*/
|
|
177
161
|
drilldownDashboardId?: pulumi.Input<number>;
|
|
178
|
-
/**
|
|
179
|
-
* (Required) The duration, in ms, of the time window represented in the chart.
|
|
180
|
-
*/
|
|
181
162
|
duration?: pulumi.Input<number>;
|
|
182
|
-
/**
|
|
183
|
-
* (Optional) The end time of the time window represented in the chart in epoch time. When not set, the time window will end at the current time.
|
|
184
|
-
*/
|
|
185
163
|
endTime?: pulumi.Input<number>;
|
|
186
|
-
/**
|
|
187
|
-
* (Required) A collection of entity IDs to display data. These are typically application IDs.
|
|
188
|
-
*/
|
|
189
164
|
entityIds?: pulumi.Input<pulumi.Input<number>[]>;
|
|
190
|
-
/**
|
|
191
|
-
* (Optional) Can be set to "host" to facet the metric data by host.
|
|
192
|
-
*/
|
|
193
165
|
facet?: pulumi.Input<string>;
|
|
194
|
-
/**
|
|
195
|
-
* (Optional) Height of the widget. Valid values are `1` to `3` inclusive. Defaults to `1`.
|
|
196
|
-
*/
|
|
197
166
|
height?: pulumi.Input<number>;
|
|
198
|
-
/**
|
|
199
|
-
* (Optional) The limit of distinct data series to display. Requires `orderBy` to be set.
|
|
200
|
-
*/
|
|
201
167
|
limit?: pulumi.Input<number>;
|
|
202
|
-
/**
|
|
203
|
-
* (Required) A nested block that describes a metric. Nested `metric` blocks support the following arguments:
|
|
204
|
-
*/
|
|
205
168
|
metrics?: pulumi.Input<pulumi.Input<inputs.DashboardWidgetMetric>[]>;
|
|
206
|
-
/**
|
|
207
|
-
* (Optional) Description of the widget.
|
|
208
|
-
*/
|
|
209
169
|
notes?: pulumi.Input<string>;
|
|
210
|
-
/**
|
|
211
|
-
* (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
|
|
212
|
-
* * `markdown`:
|
|
213
|
-
*/
|
|
214
170
|
nrql?: pulumi.Input<string>;
|
|
215
|
-
/**
|
|
216
|
-
* (Optional) Set the order of the results. Required when using `limit`.
|
|
217
|
-
* * `applicationBreakdown`:
|
|
218
|
-
*/
|
|
219
171
|
orderBy?: pulumi.Input<string>;
|
|
220
172
|
rawMetricName?: pulumi.Input<string>;
|
|
221
|
-
/**
|
|
222
|
-
* (Required) Row position of widget from top left, starting at `1`.
|
|
223
|
-
*/
|
|
224
173
|
row: pulumi.Input<number>;
|
|
225
|
-
/**
|
|
226
|
-
* (Required) The markdown source to be rendered in the widget.
|
|
227
|
-
* * `metricLineChart`:
|
|
228
|
-
*/
|
|
229
174
|
source?: pulumi.Input<string>;
|
|
230
|
-
/**
|
|
231
|
-
* (Required) Threshold above which the displayed value will be styled with a red color.
|
|
232
|
-
*/
|
|
233
175
|
thresholdRed?: pulumi.Input<number>;
|
|
234
|
-
/**
|
|
235
|
-
* (Optional) Threshold above which the displayed value will be styled with a yellow color.
|
|
236
|
-
* * `facetBarChart`, `facetPieChart`, `facetTable`, `facetedAreaChart`, `facetedLineChart`, or `heatmap`:
|
|
237
|
-
*/
|
|
238
176
|
thresholdYellow?: pulumi.Input<number>;
|
|
239
|
-
/**
|
|
240
|
-
* The title of the dashboard.
|
|
241
|
-
*/
|
|
242
177
|
title: pulumi.Input<string>;
|
|
243
|
-
/**
|
|
244
|
-
* (Required) How the widget visualizes data. Valid values are `billboard`, `gauge`, `billboardComparison`, `facetBarChart`, `facetedLineChart`, `facetPieChart`, `facetTable`, `facetedAreaChart`, `heatmap`, `attributeSheet`, `singleEvent`, `histogram`, `funnel`, `rawJson`, `eventFeed`, `eventTable`, `uniquesList`, `lineChart`, `comparisonLineChart`, `markdown`, and `metricLineChart`.
|
|
245
|
-
*/
|
|
246
178
|
visualization: pulumi.Input<string>;
|
|
247
179
|
widgetId?: pulumi.Input<number>;
|
|
248
|
-
/**
|
|
249
|
-
* (Optional) Width of the widget. Valid values are `1` to `3` inclusive. Defaults to `1`.
|
|
250
|
-
*/
|
|
251
180
|
width?: pulumi.Input<number>;
|
|
252
181
|
}
|
|
253
182
|
export interface DashboardWidgetCompareWith {
|
|
@@ -256,21 +185,12 @@ export interface DashboardWidgetCompareWith {
|
|
|
256
185
|
}
|
|
257
186
|
export interface DashboardWidgetCompareWithPresentation {
|
|
258
187
|
color: pulumi.Input<string>;
|
|
259
|
-
/**
|
|
260
|
-
* (Required) The metric name to display.
|
|
261
|
-
*/
|
|
262
188
|
name: pulumi.Input<string>;
|
|
263
189
|
}
|
|
264
190
|
export interface DashboardWidgetMetric {
|
|
265
|
-
/**
|
|
266
|
-
* (Required) The metric name to display.
|
|
267
|
-
*/
|
|
268
191
|
name: pulumi.Input<string>;
|
|
269
192
|
scope?: pulumi.Input<string>;
|
|
270
193
|
units?: pulumi.Input<string>;
|
|
271
|
-
/**
|
|
272
|
-
* (Required) The metric values to display.
|
|
273
|
-
*/
|
|
274
194
|
values?: pulumi.Input<pulumi.Input<string>[]>;
|
|
275
195
|
}
|
|
276
196
|
export interface EntityTagsTag {
|
|
@@ -334,6 +254,8 @@ export interface NrqlAlertConditionNrql {
|
|
|
334
254
|
/**
|
|
335
255
|
* Represented in minutes and must be within 1-20 minutes (inclusive). NRQL queries are evaluated in one-minute time windows. The start time depends on this value. It's recommended to set this to 3 minutes. An offset of less than 3 minutes will trigger violations sooner, but you may see more false positives and negatives due to data latency. With `evaluationOffset` set to 3 minutes, the NRQL time window applied to your query will be: `SINCE 3 minutes ago UNTIL 2 minutes ago`.<br>
|
|
336
256
|
* <small>\***Note**: One of `evaluationOffset` _or_ `sinceValue` must be set, but not both.</small>
|
|
257
|
+
*
|
|
258
|
+
* @deprecated use `signal.aggregation_method` attribute instead
|
|
337
259
|
*/
|
|
338
260
|
evaluationOffset?: pulumi.Input<number>;
|
|
339
261
|
/**
|
|
@@ -344,7 +266,7 @@ export interface NrqlAlertConditionNrql {
|
|
|
344
266
|
* **DEPRECATED:** Use `evaluationOffset` instead. The value to be used in the `SINCE <X> minutes ago` clause for the NRQL query. Must be between 1-20 (inclusive). <br>
|
|
345
267
|
* <small>\***Note**: One of `evaluationOffset` _or_ `sinceValue` must be set, but not both.</small>
|
|
346
268
|
*
|
|
347
|
-
* @deprecated use `
|
|
269
|
+
* @deprecated use `signal.aggregation_method` attribute instead
|
|
348
270
|
*/
|
|
349
271
|
sinceValue?: pulumi.Input<string>;
|
|
350
272
|
}
|
|
@@ -475,6 +397,10 @@ export interface OneDashboardPage {
|
|
|
475
397
|
* (Optional) A nested block that describes a Pie widget. See Nested widget blocks below for details.
|
|
476
398
|
*/
|
|
477
399
|
widgetPies?: pulumi.Input<pulumi.Input<inputs.OneDashboardPageWidgetPy>[]>;
|
|
400
|
+
/**
|
|
401
|
+
* (Optional) A nested block that describes a Stacked Bar widget. See Nested widget blocks below for details.
|
|
402
|
+
*/
|
|
403
|
+
widgetStackedBars?: pulumi.Input<pulumi.Input<inputs.OneDashboardPageWidgetStackedBar>[]>;
|
|
478
404
|
/**
|
|
479
405
|
* (Optional) A nested block that describes a Table widget. See Nested widget blocks below for details.
|
|
480
406
|
*/
|
|
@@ -523,6 +449,7 @@ export interface OneDashboardPageWidgetBar {
|
|
|
523
449
|
* (Required) Column position of widget from top left, starting at `1`.
|
|
524
450
|
*/
|
|
525
451
|
column: pulumi.Input<number>;
|
|
452
|
+
filterCurrentDashboard?: pulumi.Input<boolean>;
|
|
526
453
|
/**
|
|
527
454
|
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
528
455
|
*/
|
|
@@ -853,7 +780,7 @@ export interface OneDashboardPageWidgetMarkdown {
|
|
|
853
780
|
row: pulumi.Input<number>;
|
|
854
781
|
/**
|
|
855
782
|
* (Required) The markdown source to be rendered in the widget.
|
|
856
|
-
* * `
|
|
783
|
+
* * `widgetStackedBar`
|
|
857
784
|
*/
|
|
858
785
|
text?: pulumi.Input<string>;
|
|
859
786
|
/**
|
|
@@ -870,6 +797,7 @@ export interface OneDashboardPageWidgetPy {
|
|
|
870
797
|
* (Required) Column position of widget from top left, starting at `1`.
|
|
871
798
|
*/
|
|
872
799
|
column: pulumi.Input<number>;
|
|
800
|
+
filterCurrentDashboard?: pulumi.Input<boolean>;
|
|
873
801
|
/**
|
|
874
802
|
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
875
803
|
*/
|
|
@@ -904,11 +832,50 @@ export interface OneDashboardPageWidgetPyNrqlQuery {
|
|
|
904
832
|
*/
|
|
905
833
|
query: pulumi.Input<string>;
|
|
906
834
|
}
|
|
835
|
+
export interface OneDashboardPageWidgetStackedBar {
|
|
836
|
+
/**
|
|
837
|
+
* (Required) Column position of widget from top left, starting at `1`.
|
|
838
|
+
*/
|
|
839
|
+
column: pulumi.Input<number>;
|
|
840
|
+
/**
|
|
841
|
+
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
842
|
+
*/
|
|
843
|
+
height?: pulumi.Input<number>;
|
|
844
|
+
id?: pulumi.Input<string>;
|
|
845
|
+
/**
|
|
846
|
+
* (Required) A nested block that describes a NRQL Query. See Nested nrql\_query blocks below for details.
|
|
847
|
+
* * `linkedEntityGuids`: (Optional) Related entity GUIDs. Currently only supports Dashboard entity GUIDs.
|
|
848
|
+
*/
|
|
849
|
+
nrqlQueries: pulumi.Input<pulumi.Input<inputs.OneDashboardPageWidgetStackedBarNrqlQuery>[]>;
|
|
850
|
+
/**
|
|
851
|
+
* (Required) Row position of widget from top left, starting at `1`.
|
|
852
|
+
*/
|
|
853
|
+
row: pulumi.Input<number>;
|
|
854
|
+
/**
|
|
855
|
+
* (Required) A title for the widget.
|
|
856
|
+
*/
|
|
857
|
+
title: pulumi.Input<string>;
|
|
858
|
+
/**
|
|
859
|
+
* (Optional) Width of the widget. Valid values are `1` to `12` inclusive. Defaults to `4`.
|
|
860
|
+
*/
|
|
861
|
+
width?: pulumi.Input<number>;
|
|
862
|
+
}
|
|
863
|
+
export interface OneDashboardPageWidgetStackedBarNrqlQuery {
|
|
864
|
+
/**
|
|
865
|
+
* Determines the New Relic account where the dashboard will be created. Defaults to the account associated with the API key used.
|
|
866
|
+
*/
|
|
867
|
+
accountId?: pulumi.Input<number>;
|
|
868
|
+
/**
|
|
869
|
+
* (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
|
|
870
|
+
*/
|
|
871
|
+
query: pulumi.Input<string>;
|
|
872
|
+
}
|
|
907
873
|
export interface OneDashboardPageWidgetTable {
|
|
908
874
|
/**
|
|
909
875
|
* (Required) Column position of widget from top left, starting at `1`.
|
|
910
876
|
*/
|
|
911
877
|
column: pulumi.Input<number>;
|
|
878
|
+
filterCurrentDashboard?: pulumi.Input<boolean>;
|
|
912
879
|
/**
|
|
913
880
|
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
914
881
|
*/
|
|
@@ -975,6 +942,10 @@ export interface OneDashboardRawPageWidget {
|
|
|
975
942
|
*/
|
|
976
943
|
height?: pulumi.Input<number>;
|
|
977
944
|
id?: pulumi.Input<string>;
|
|
945
|
+
/**
|
|
946
|
+
* (Optional) Related entity GUIDs.
|
|
947
|
+
*/
|
|
948
|
+
linkedEntityGuids?: pulumi.Input<pulumi.Input<string>[]>;
|
|
978
949
|
/**
|
|
979
950
|
* (Required) Row position of widget from top left, starting at `1`.
|
|
980
951
|
*/
|
|
@@ -992,6 +963,95 @@ export interface OneDashboardRawPageWidget {
|
|
|
992
963
|
*/
|
|
993
964
|
width?: pulumi.Input<number>;
|
|
994
965
|
}
|
|
966
|
+
export interface ServiceLevelEvents {
|
|
967
|
+
/**
|
|
968
|
+
* The ID of the account where the entity (e.g, APM Service, Browser application, Workload, etc.) belongs to,
|
|
969
|
+
* and that contains the NRDB data for the SLI/SLO calculations.
|
|
970
|
+
*/
|
|
971
|
+
accountId: pulumi.Input<number>;
|
|
972
|
+
/**
|
|
973
|
+
* The definition of the bad responses. If you define an SLI from valid and bad events, you must leave the good events argument empty.
|
|
974
|
+
*/
|
|
975
|
+
badEvents?: pulumi.Input<inputs.ServiceLevelEventsBadEvents>;
|
|
976
|
+
/**
|
|
977
|
+
* The definition of good responses. If you define an SLI from valid and good events, you must leave the bad events argument empty.
|
|
978
|
+
*/
|
|
979
|
+
goodEvents?: pulumi.Input<inputs.ServiceLevelEventsGoodEvents>;
|
|
980
|
+
/**
|
|
981
|
+
* The definition of valid requests.
|
|
982
|
+
*/
|
|
983
|
+
validEvents: pulumi.Input<inputs.ServiceLevelEventsValidEvents>;
|
|
984
|
+
}
|
|
985
|
+
export interface ServiceLevelEventsBadEvents {
|
|
986
|
+
/**
|
|
987
|
+
* The event type where NRDB data will be fetched from.
|
|
988
|
+
*/
|
|
989
|
+
from: pulumi.Input<string>;
|
|
990
|
+
/**
|
|
991
|
+
* A filter that specifies all the NRDB events that are considered in this SLI (e.g, those that refer to a particular entity).
|
|
992
|
+
* a particular entity and were successful).
|
|
993
|
+
* a particular entity and returned an error).
|
|
994
|
+
*/
|
|
995
|
+
where?: pulumi.Input<string>;
|
|
996
|
+
}
|
|
997
|
+
export interface ServiceLevelEventsGoodEvents {
|
|
998
|
+
/**
|
|
999
|
+
* The event type where NRDB data will be fetched from.
|
|
1000
|
+
*/
|
|
1001
|
+
from: pulumi.Input<string>;
|
|
1002
|
+
/**
|
|
1003
|
+
* A filter that specifies all the NRDB events that are considered in this SLI (e.g, those that refer to a particular entity).
|
|
1004
|
+
* a particular entity and were successful).
|
|
1005
|
+
* a particular entity and returned an error).
|
|
1006
|
+
*/
|
|
1007
|
+
where?: pulumi.Input<string>;
|
|
1008
|
+
}
|
|
1009
|
+
export interface ServiceLevelEventsValidEvents {
|
|
1010
|
+
/**
|
|
1011
|
+
* The event type where NRDB data will be fetched from.
|
|
1012
|
+
*/
|
|
1013
|
+
from: pulumi.Input<string>;
|
|
1014
|
+
/**
|
|
1015
|
+
* A filter that specifies all the NRDB events that are considered in this SLI (e.g, those that refer to a particular entity).
|
|
1016
|
+
* a particular entity and were successful).
|
|
1017
|
+
* a particular entity and returned an error).
|
|
1018
|
+
*/
|
|
1019
|
+
where?: pulumi.Input<string>;
|
|
1020
|
+
}
|
|
1021
|
+
export interface ServiceLevelObjective {
|
|
1022
|
+
/**
|
|
1023
|
+
* The description of the SLI.
|
|
1024
|
+
*/
|
|
1025
|
+
description?: pulumi.Input<string>;
|
|
1026
|
+
/**
|
|
1027
|
+
* A short name for the SLI that will help anyone understand what it is about.
|
|
1028
|
+
*/
|
|
1029
|
+
name?: pulumi.Input<string>;
|
|
1030
|
+
/**
|
|
1031
|
+
* The target for your SLO, valid values between `0` and `100`. Up to 5 decimals accepted.
|
|
1032
|
+
*/
|
|
1033
|
+
target: pulumi.Input<number>;
|
|
1034
|
+
/**
|
|
1035
|
+
* Time window is the period for the SLO.
|
|
1036
|
+
*/
|
|
1037
|
+
timeWindow: pulumi.Input<inputs.ServiceLevelObjectiveTimeWindow>;
|
|
1038
|
+
}
|
|
1039
|
+
export interface ServiceLevelObjectiveTimeWindow {
|
|
1040
|
+
/**
|
|
1041
|
+
* Rolling window.
|
|
1042
|
+
*/
|
|
1043
|
+
rolling: pulumi.Input<inputs.ServiceLevelObjectiveTimeWindowRolling>;
|
|
1044
|
+
}
|
|
1045
|
+
export interface ServiceLevelObjectiveTimeWindowRolling {
|
|
1046
|
+
/**
|
|
1047
|
+
* Valid values are `1`, `7`, `14`, `28` and `30`.
|
|
1048
|
+
*/
|
|
1049
|
+
count: pulumi.Input<number>;
|
|
1050
|
+
/**
|
|
1051
|
+
* The only supported value is `DAY`.
|
|
1052
|
+
*/
|
|
1053
|
+
unit: pulumi.Input<string>;
|
|
1054
|
+
}
|
|
995
1055
|
export declare namespace insights {
|
|
996
1056
|
interface EventEvent {
|
|
997
1057
|
attributes: pulumi.Input<pulumi.Input<inputs.insights.EventEventAttribute>[]>;
|
package/types/output.d.ts
CHANGED
|
@@ -150,103 +150,32 @@ export interface AlertMutingRuleSchedule {
|
|
|
150
150
|
weeklyRepeatDays?: string[];
|
|
151
151
|
}
|
|
152
152
|
export interface DashboardFilter {
|
|
153
|
-
/**
|
|
154
|
-
* (Optional) A list of attributes belonging to the specified event types to enable filtering for.
|
|
155
|
-
*/
|
|
156
153
|
attributes?: string[];
|
|
157
|
-
/**
|
|
158
|
-
* (Optional) A list of event types to enable filtering for.
|
|
159
|
-
*/
|
|
160
154
|
eventTypes: string[];
|
|
161
155
|
}
|
|
162
156
|
export interface DashboardWidget {
|
|
163
|
-
/**
|
|
164
|
-
* (Optional) The account ID to use when querying data. If `accountId` is omitted, the widget will use the account ID associated with the API key used in your provider configuration. You can also use `accountId` to configure cross-account widgets or simply to be explicit about which account the widget will be pulling data from.
|
|
165
|
-
*/
|
|
166
157
|
accountId?: number;
|
|
167
|
-
/**
|
|
168
|
-
* (Required) Column position of widget from top left, starting at `1`.
|
|
169
|
-
*/
|
|
170
158
|
column: number;
|
|
171
159
|
compareWiths?: outputs.DashboardWidgetCompareWith[];
|
|
172
|
-
/**
|
|
173
|
-
* (Optional) The ID of a dashboard to link to from the widget's facets.
|
|
174
|
-
* * `attributeSheet`, `comparisonLineChart`, `eventFeed`, `eventTable`, `funnel`, `histogram`, `lineChart`, `rawJson`, `singleEvent`, or `uniquesList`:
|
|
175
|
-
*/
|
|
176
160
|
drilldownDashboardId?: number;
|
|
177
|
-
/**
|
|
178
|
-
* (Required) The duration, in ms, of the time window represented in the chart.
|
|
179
|
-
*/
|
|
180
161
|
duration?: number;
|
|
181
|
-
/**
|
|
182
|
-
* (Optional) The end time of the time window represented in the chart in epoch time. When not set, the time window will end at the current time.
|
|
183
|
-
*/
|
|
184
162
|
endTime?: number;
|
|
185
|
-
/**
|
|
186
|
-
* (Required) A collection of entity IDs to display data. These are typically application IDs.
|
|
187
|
-
*/
|
|
188
163
|
entityIds?: number[];
|
|
189
|
-
/**
|
|
190
|
-
* (Optional) Can be set to "host" to facet the metric data by host.
|
|
191
|
-
*/
|
|
192
164
|
facet?: string;
|
|
193
|
-
/**
|
|
194
|
-
* (Optional) Height of the widget. Valid values are `1` to `3` inclusive. Defaults to `1`.
|
|
195
|
-
*/
|
|
196
165
|
height?: number;
|
|
197
|
-
/**
|
|
198
|
-
* (Optional) The limit of distinct data series to display. Requires `orderBy` to be set.
|
|
199
|
-
*/
|
|
200
166
|
limit?: number;
|
|
201
|
-
/**
|
|
202
|
-
* (Required) A nested block that describes a metric. Nested `metric` blocks support the following arguments:
|
|
203
|
-
*/
|
|
204
167
|
metrics?: outputs.DashboardWidgetMetric[];
|
|
205
|
-
/**
|
|
206
|
-
* (Optional) Description of the widget.
|
|
207
|
-
*/
|
|
208
168
|
notes?: string;
|
|
209
|
-
/**
|
|
210
|
-
* (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
|
|
211
|
-
* * `markdown`:
|
|
212
|
-
*/
|
|
213
169
|
nrql?: string;
|
|
214
|
-
/**
|
|
215
|
-
* (Optional) Set the order of the results. Required when using `limit`.
|
|
216
|
-
* * `applicationBreakdown`:
|
|
217
|
-
*/
|
|
218
170
|
orderBy?: string;
|
|
219
171
|
rawMetricName: string;
|
|
220
|
-
/**
|
|
221
|
-
* (Required) Row position of widget from top left, starting at `1`.
|
|
222
|
-
*/
|
|
223
172
|
row: number;
|
|
224
|
-
/**
|
|
225
|
-
* (Required) The markdown source to be rendered in the widget.
|
|
226
|
-
* * `metricLineChart`:
|
|
227
|
-
*/
|
|
228
173
|
source?: string;
|
|
229
|
-
/**
|
|
230
|
-
* (Required) Threshold above which the displayed value will be styled with a red color.
|
|
231
|
-
*/
|
|
232
174
|
thresholdRed?: number;
|
|
233
|
-
/**
|
|
234
|
-
* (Optional) Threshold above which the displayed value will be styled with a yellow color.
|
|
235
|
-
* * `facetBarChart`, `facetPieChart`, `facetTable`, `facetedAreaChart`, `facetedLineChart`, or `heatmap`:
|
|
236
|
-
*/
|
|
237
175
|
thresholdYellow?: number;
|
|
238
|
-
/**
|
|
239
|
-
* The title of the dashboard.
|
|
240
|
-
*/
|
|
241
176
|
title: string;
|
|
242
|
-
/**
|
|
243
|
-
* (Required) How the widget visualizes data. Valid values are `billboard`, `gauge`, `billboardComparison`, `facetBarChart`, `facetedLineChart`, `facetPieChart`, `facetTable`, `facetedAreaChart`, `heatmap`, `attributeSheet`, `singleEvent`, `histogram`, `funnel`, `rawJson`, `eventFeed`, `eventTable`, `uniquesList`, `lineChart`, `comparisonLineChart`, `markdown`, and `metricLineChart`.
|
|
244
|
-
*/
|
|
245
177
|
visualization: string;
|
|
246
178
|
widgetId: number;
|
|
247
|
-
/**
|
|
248
|
-
* (Optional) Width of the widget. Valid values are `1` to `3` inclusive. Defaults to `1`.
|
|
249
|
-
*/
|
|
250
179
|
width?: number;
|
|
251
180
|
}
|
|
252
181
|
export interface DashboardWidgetCompareWith {
|
|
@@ -255,21 +184,12 @@ export interface DashboardWidgetCompareWith {
|
|
|
255
184
|
}
|
|
256
185
|
export interface DashboardWidgetCompareWithPresentation {
|
|
257
186
|
color: string;
|
|
258
|
-
/**
|
|
259
|
-
* (Required) The metric name to display.
|
|
260
|
-
*/
|
|
261
187
|
name: string;
|
|
262
188
|
}
|
|
263
189
|
export interface DashboardWidgetMetric {
|
|
264
|
-
/**
|
|
265
|
-
* (Required) The metric name to display.
|
|
266
|
-
*/
|
|
267
190
|
name: string;
|
|
268
191
|
scope?: string;
|
|
269
192
|
units?: string;
|
|
270
|
-
/**
|
|
271
|
-
* (Required) The metric values to display.
|
|
272
|
-
*/
|
|
273
193
|
values?: string[];
|
|
274
194
|
}
|
|
275
195
|
export interface EntityTagsTag {
|
|
@@ -358,6 +278,8 @@ export interface NrqlAlertConditionNrql {
|
|
|
358
278
|
/**
|
|
359
279
|
* Represented in minutes and must be within 1-20 minutes (inclusive). NRQL queries are evaluated in one-minute time windows. The start time depends on this value. It's recommended to set this to 3 minutes. An offset of less than 3 minutes will trigger violations sooner, but you may see more false positives and negatives due to data latency. With `evaluationOffset` set to 3 minutes, the NRQL time window applied to your query will be: `SINCE 3 minutes ago UNTIL 2 minutes ago`.<br>
|
|
360
280
|
* <small>\***Note**: One of `evaluationOffset` _or_ `sinceValue` must be set, but not both.</small>
|
|
281
|
+
*
|
|
282
|
+
* @deprecated use `signal.aggregation_method` attribute instead
|
|
361
283
|
*/
|
|
362
284
|
evaluationOffset?: number;
|
|
363
285
|
/**
|
|
@@ -368,7 +290,7 @@ export interface NrqlAlertConditionNrql {
|
|
|
368
290
|
* **DEPRECATED:** Use `evaluationOffset` instead. The value to be used in the `SINCE <X> minutes ago` clause for the NRQL query. Must be between 1-20 (inclusive). <br>
|
|
369
291
|
* <small>\***Note**: One of `evaluationOffset` _or_ `sinceValue` must be set, but not both.</small>
|
|
370
292
|
*
|
|
371
|
-
* @deprecated use `
|
|
293
|
+
* @deprecated use `signal.aggregation_method` attribute instead
|
|
372
294
|
*/
|
|
373
295
|
sinceValue?: string;
|
|
374
296
|
}
|
|
@@ -499,6 +421,10 @@ export interface OneDashboardPage {
|
|
|
499
421
|
* (Optional) A nested block that describes a Pie widget. See Nested widget blocks below for details.
|
|
500
422
|
*/
|
|
501
423
|
widgetPies?: outputs.OneDashboardPageWidgetPy[];
|
|
424
|
+
/**
|
|
425
|
+
* (Optional) A nested block that describes a Stacked Bar widget. See Nested widget blocks below for details.
|
|
426
|
+
*/
|
|
427
|
+
widgetStackedBars?: outputs.OneDashboardPageWidgetStackedBar[];
|
|
502
428
|
/**
|
|
503
429
|
* (Optional) A nested block that describes a Table widget. See Nested widget blocks below for details.
|
|
504
430
|
*/
|
|
@@ -547,12 +473,13 @@ export interface OneDashboardPageWidgetBar {
|
|
|
547
473
|
* (Required) Column position of widget from top left, starting at `1`.
|
|
548
474
|
*/
|
|
549
475
|
column: number;
|
|
476
|
+
filterCurrentDashboard?: boolean;
|
|
550
477
|
/**
|
|
551
478
|
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
552
479
|
*/
|
|
553
480
|
height?: number;
|
|
554
481
|
id: string;
|
|
555
|
-
linkedEntityGuids
|
|
482
|
+
linkedEntityGuids: string[];
|
|
556
483
|
/**
|
|
557
484
|
* (Required) A nested block that describes a NRQL Query. See Nested nrql\_query blocks below for details.
|
|
558
485
|
* * `linkedEntityGuids`: (Optional) Related entity GUIDs. Currently only supports Dashboard entity GUIDs.
|
|
@@ -877,7 +804,7 @@ export interface OneDashboardPageWidgetMarkdown {
|
|
|
877
804
|
row: number;
|
|
878
805
|
/**
|
|
879
806
|
* (Required) The markdown source to be rendered in the widget.
|
|
880
|
-
* * `
|
|
807
|
+
* * `widgetStackedBar`
|
|
881
808
|
*/
|
|
882
809
|
text?: string;
|
|
883
810
|
/**
|
|
@@ -894,12 +821,13 @@ export interface OneDashboardPageWidgetPy {
|
|
|
894
821
|
* (Required) Column position of widget from top left, starting at `1`.
|
|
895
822
|
*/
|
|
896
823
|
column: number;
|
|
824
|
+
filterCurrentDashboard?: boolean;
|
|
897
825
|
/**
|
|
898
826
|
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
899
827
|
*/
|
|
900
828
|
height?: number;
|
|
901
829
|
id: string;
|
|
902
|
-
linkedEntityGuids
|
|
830
|
+
linkedEntityGuids: string[];
|
|
903
831
|
/**
|
|
904
832
|
* (Required) A nested block that describes a NRQL Query. See Nested nrql\_query blocks below for details.
|
|
905
833
|
* * `linkedEntityGuids`: (Optional) Related entity GUIDs. Currently only supports Dashboard entity GUIDs.
|
|
@@ -928,17 +856,56 @@ export interface OneDashboardPageWidgetPyNrqlQuery {
|
|
|
928
856
|
*/
|
|
929
857
|
query: string;
|
|
930
858
|
}
|
|
859
|
+
export interface OneDashboardPageWidgetStackedBar {
|
|
860
|
+
/**
|
|
861
|
+
* (Required) Column position of widget from top left, starting at `1`.
|
|
862
|
+
*/
|
|
863
|
+
column: number;
|
|
864
|
+
/**
|
|
865
|
+
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
866
|
+
*/
|
|
867
|
+
height?: number;
|
|
868
|
+
id: string;
|
|
869
|
+
/**
|
|
870
|
+
* (Required) A nested block that describes a NRQL Query. See Nested nrql\_query blocks below for details.
|
|
871
|
+
* * `linkedEntityGuids`: (Optional) Related entity GUIDs. Currently only supports Dashboard entity GUIDs.
|
|
872
|
+
*/
|
|
873
|
+
nrqlQueries: outputs.OneDashboardPageWidgetStackedBarNrqlQuery[];
|
|
874
|
+
/**
|
|
875
|
+
* (Required) Row position of widget from top left, starting at `1`.
|
|
876
|
+
*/
|
|
877
|
+
row: number;
|
|
878
|
+
/**
|
|
879
|
+
* (Required) A title for the widget.
|
|
880
|
+
*/
|
|
881
|
+
title: string;
|
|
882
|
+
/**
|
|
883
|
+
* (Optional) Width of the widget. Valid values are `1` to `12` inclusive. Defaults to `4`.
|
|
884
|
+
*/
|
|
885
|
+
width?: number;
|
|
886
|
+
}
|
|
887
|
+
export interface OneDashboardPageWidgetStackedBarNrqlQuery {
|
|
888
|
+
/**
|
|
889
|
+
* Determines the New Relic account where the dashboard will be created. Defaults to the account associated with the API key used.
|
|
890
|
+
*/
|
|
891
|
+
accountId: number;
|
|
892
|
+
/**
|
|
893
|
+
* (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
|
|
894
|
+
*/
|
|
895
|
+
query: string;
|
|
896
|
+
}
|
|
931
897
|
export interface OneDashboardPageWidgetTable {
|
|
932
898
|
/**
|
|
933
899
|
* (Required) Column position of widget from top left, starting at `1`.
|
|
934
900
|
*/
|
|
935
901
|
column: number;
|
|
902
|
+
filterCurrentDashboard?: boolean;
|
|
936
903
|
/**
|
|
937
904
|
* (Optional) Height of the widget. Valid values are `1` to `12` inclusive. Defaults to `3`.
|
|
938
905
|
*/
|
|
939
906
|
height?: number;
|
|
940
907
|
id: string;
|
|
941
|
-
linkedEntityGuids
|
|
908
|
+
linkedEntityGuids: string[];
|
|
942
909
|
/**
|
|
943
910
|
* (Required) A nested block that describes a NRQL Query. See Nested nrql\_query blocks below for details.
|
|
944
911
|
* * `linkedEntityGuids`: (Optional) Related entity GUIDs. Currently only supports Dashboard entity GUIDs.
|
|
@@ -999,6 +966,10 @@ export interface OneDashboardRawPageWidget {
|
|
|
999
966
|
*/
|
|
1000
967
|
height?: number;
|
|
1001
968
|
id: string;
|
|
969
|
+
/**
|
|
970
|
+
* (Optional) Related entity GUIDs.
|
|
971
|
+
*/
|
|
972
|
+
linkedEntityGuids?: string[];
|
|
1002
973
|
/**
|
|
1003
974
|
* (Required) Row position of widget from top left, starting at `1`.
|
|
1004
975
|
*/
|
|
@@ -1016,6 +987,95 @@ export interface OneDashboardRawPageWidget {
|
|
|
1016
987
|
*/
|
|
1017
988
|
width?: number;
|
|
1018
989
|
}
|
|
990
|
+
export interface ServiceLevelEvents {
|
|
991
|
+
/**
|
|
992
|
+
* The ID of the account where the entity (e.g, APM Service, Browser application, Workload, etc.) belongs to,
|
|
993
|
+
* and that contains the NRDB data for the SLI/SLO calculations.
|
|
994
|
+
*/
|
|
995
|
+
accountId: number;
|
|
996
|
+
/**
|
|
997
|
+
* The definition of the bad responses. If you define an SLI from valid and bad events, you must leave the good events argument empty.
|
|
998
|
+
*/
|
|
999
|
+
badEvents?: outputs.ServiceLevelEventsBadEvents;
|
|
1000
|
+
/**
|
|
1001
|
+
* The definition of good responses. If you define an SLI from valid and good events, you must leave the bad events argument empty.
|
|
1002
|
+
*/
|
|
1003
|
+
goodEvents?: outputs.ServiceLevelEventsGoodEvents;
|
|
1004
|
+
/**
|
|
1005
|
+
* The definition of valid requests.
|
|
1006
|
+
*/
|
|
1007
|
+
validEvents: outputs.ServiceLevelEventsValidEvents;
|
|
1008
|
+
}
|
|
1009
|
+
export interface ServiceLevelEventsBadEvents {
|
|
1010
|
+
/**
|
|
1011
|
+
* The event type where NRDB data will be fetched from.
|
|
1012
|
+
*/
|
|
1013
|
+
from: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* A filter that specifies all the NRDB events that are considered in this SLI (e.g, those that refer to a particular entity).
|
|
1016
|
+
* a particular entity and were successful).
|
|
1017
|
+
* a particular entity and returned an error).
|
|
1018
|
+
*/
|
|
1019
|
+
where?: string;
|
|
1020
|
+
}
|
|
1021
|
+
export interface ServiceLevelEventsGoodEvents {
|
|
1022
|
+
/**
|
|
1023
|
+
* The event type where NRDB data will be fetched from.
|
|
1024
|
+
*/
|
|
1025
|
+
from: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* A filter that specifies all the NRDB events that are considered in this SLI (e.g, those that refer to a particular entity).
|
|
1028
|
+
* a particular entity and were successful).
|
|
1029
|
+
* a particular entity and returned an error).
|
|
1030
|
+
*/
|
|
1031
|
+
where?: string;
|
|
1032
|
+
}
|
|
1033
|
+
export interface ServiceLevelEventsValidEvents {
|
|
1034
|
+
/**
|
|
1035
|
+
* The event type where NRDB data will be fetched from.
|
|
1036
|
+
*/
|
|
1037
|
+
from: string;
|
|
1038
|
+
/**
|
|
1039
|
+
* A filter that specifies all the NRDB events that are considered in this SLI (e.g, those that refer to a particular entity).
|
|
1040
|
+
* a particular entity and were successful).
|
|
1041
|
+
* a particular entity and returned an error).
|
|
1042
|
+
*/
|
|
1043
|
+
where?: string;
|
|
1044
|
+
}
|
|
1045
|
+
export interface ServiceLevelObjective {
|
|
1046
|
+
/**
|
|
1047
|
+
* The description of the SLI.
|
|
1048
|
+
*/
|
|
1049
|
+
description?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* A short name for the SLI that will help anyone understand what it is about.
|
|
1052
|
+
*/
|
|
1053
|
+
name?: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* The target for your SLO, valid values between `0` and `100`. Up to 5 decimals accepted.
|
|
1056
|
+
*/
|
|
1057
|
+
target: number;
|
|
1058
|
+
/**
|
|
1059
|
+
* Time window is the period for the SLO.
|
|
1060
|
+
*/
|
|
1061
|
+
timeWindow: outputs.ServiceLevelObjectiveTimeWindow;
|
|
1062
|
+
}
|
|
1063
|
+
export interface ServiceLevelObjectiveTimeWindow {
|
|
1064
|
+
/**
|
|
1065
|
+
* Rolling window.
|
|
1066
|
+
*/
|
|
1067
|
+
rolling: outputs.ServiceLevelObjectiveTimeWindowRolling;
|
|
1068
|
+
}
|
|
1069
|
+
export interface ServiceLevelObjectiveTimeWindowRolling {
|
|
1070
|
+
/**
|
|
1071
|
+
* Valid values are `1`, `7`, `14`, `28` and `30`.
|
|
1072
|
+
*/
|
|
1073
|
+
count: number;
|
|
1074
|
+
/**
|
|
1075
|
+
* The only supported value is `DAY`.
|
|
1076
|
+
*/
|
|
1077
|
+
unit: string;
|
|
1078
|
+
}
|
|
1019
1079
|
export declare namespace insights {
|
|
1020
1080
|
interface EventEvent {
|
|
1021
1081
|
attributes: outputs.insights.EventEventAttribute[];
|