Wavefront v3.1.2 published on Friday, May 10, 2024 by Pulumi
wavefront.getDashboards
Explore with Pulumi AI
Use this data source to get information about all Wavefront dashboards.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as wavefront from "@pulumi/wavefront";
// Get the information about all dashboards.
const example = wavefront.getDashboards({
limit: 10,
offset: 0,
});
import pulumi
import pulumi_wavefront as wavefront
# Get the information about all dashboards.
example = wavefront.get_dashboards(limit=10,
offset=0)
package main
import (
"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Get the information about all dashboards.
_, err := wavefront.GetDashboards(ctx, &wavefront.GetDashboardsArgs{
Limit: pulumi.IntRef(10),
Offset: pulumi.IntRef(0),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;
return await Deployment.RunAsync(() =>
{
// Get the information about all dashboards.
var example = Wavefront.GetDashboards.Invoke(new()
{
Limit = 10,
Offset = 0,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.WavefrontFunctions;
import com.pulumi.wavefront.inputs.GetDashboardsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Get the information about all dashboards.
final var example = WavefrontFunctions.getDashboards(GetDashboardsArgs.builder()
.limit(10)
.offset(0)
.build());
}
}
variables:
# Get the information about all dashboards.
example:
fn::invoke:
Function: wavefront:getDashboards
Arguments:
limit: 10
offset: 0
Using getDashboards
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDashboards(args: GetDashboardsArgs, opts?: InvokeOptions): Promise<GetDashboardsResult>
function getDashboardsOutput(args: GetDashboardsOutputArgs, opts?: InvokeOptions): Output<GetDashboardsResult>def get_dashboards(limit: Optional[int] = None,
offset: Optional[int] = None,
opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
def get_dashboards_output(limit: Optional[pulumi.Input[int]] = None,
offset: Optional[pulumi.Input[int]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDashboardsResult]func GetDashboards(ctx *Context, args *GetDashboardsArgs, opts ...InvokeOption) (*GetDashboardsResult, error)
func GetDashboardsOutput(ctx *Context, args *GetDashboardsOutputArgs, opts ...InvokeOption) GetDashboardsResultOutput> Note: This function is named GetDashboards in the Go SDK.
public static class GetDashboards
{
public static Task<GetDashboardsResult> InvokeAsync(GetDashboardsArgs args, InvokeOptions? opts = null)
public static Output<GetDashboardsResult> Invoke(GetDashboardsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: wavefront:index/getDashboards:getDashboards
arguments:
# arguments dictionaryThe following arguments are supported:
getDashboards Result
The following output properties are available:
- Dashboards
List<Get
Dashboards Dashboard> - List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Limit int
- Offset int
- Dashboards
[]Get
Dashboards Dashboard - List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Limit int
- Offset int
- dashboards
List<Get
Dashboards Dashboard> - List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
- id String
- The provider-assigned unique ID for this managed resource.
- limit Integer
- offset Integer
- dashboards
Get
Dashboards Dashboard[] - List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
- id string
- The provider-assigned unique ID for this managed resource.
- limit number
- offset number
- dashboards
Sequence[Get
Dashboards Dashboard] - List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
- id str
- The provider-assigned unique ID for this managed resource.
- limit int
- offset int
- dashboards List<Property Map>
- List of all Wavefront dashboards. For each dashboard you will see a list of attributes.
- id String
- The provider-assigned unique ID for this managed resource.
- limit Number
- offset Number
Supporting Types
GetDashboardsDashboard
- Can
Modifies List<string> - A list of users that have modify ACL access to the dashboard.
- Can
Views List<string> - A list of users that have view ACL access to the dashboard.
- Chart
Title stringBg Color - Chart
Title stringColor - Chart
Title intScalar - Created
Epoch intMillis - Creator
Id string - Customer string
- Default
End intTime - Default
Start intTime - Default
Time stringWindow - Deleted bool
- Description string
- Description of the chart.
- Display
Description bool - Display
Query boolParameters - Whether the dashboard parameters section is opened by default when the dashboard is shown.
- Display
Section boolTable Of Contents - Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
- Event
Filter stringType - How charts belonging to this dashboard should display events.
BYCHARTis default if unspecified. Valid options are:BYCHART,AUTOMATIC,ALL,NONE,BYDASHBOARD, andBYCHARTANDDASHBOARD. - Event
Query string - Favorite bool
- bool
- Id string
- Name string
- The name of the parameters.
- Num
Charts int - Num
Favorites int - Parameter
Details List<GetDashboards Dashboard Parameter Detail> - The current JSON representation of dashboard parameters. See parameter details.
- Parameters Dictionary<string, object>
- Sections
List<Get
Dashboards Dashboard Section> - System
Owned bool - List<string>
- A set of tags to assign to this resource.
- Updated
Epoch intMillis - Updater
Id string - Url string
- Unique identifier, also a URL slug of the dashboard.
- Views
Last intDay - Views
Last intMonth - Views
Last intWeek
- Can
Modifies []string - A list of users that have modify ACL access to the dashboard.
- Can
Views []string - A list of users that have view ACL access to the dashboard.
- Chart
Title stringBg Color - Chart
Title stringColor - Chart
Title intScalar - Created
Epoch intMillis - Creator
Id string - Customer string
- Default
End intTime - Default
Start intTime - Default
Time stringWindow - Deleted bool
- Description string
- Description of the chart.
- Display
Description bool - Display
Query boolParameters - Whether the dashboard parameters section is opened by default when the dashboard is shown.
- Display
Section boolTable Of Contents - Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
- Event
Filter stringType - How charts belonging to this dashboard should display events.
BYCHARTis default if unspecified. Valid options are:BYCHART,AUTOMATIC,ALL,NONE,BYDASHBOARD, andBYCHARTANDDASHBOARD. - Event
Query string - Favorite bool
- bool
- Id string
- Name string
- The name of the parameters.
- Num
Charts int - Num
Favorites int - Parameter
Details []GetDashboards Dashboard Parameter Detail - The current JSON representation of dashboard parameters. See parameter details.
- Parameters map[string]interface{}
- Sections
[]Get
Dashboards Dashboard Section - System
Owned bool - []string
- A set of tags to assign to this resource.
- Updated
Epoch intMillis - Updater
Id string - Url string
- Unique identifier, also a URL slug of the dashboard.
- Views
Last intDay - Views
Last intMonth - Views
Last intWeek
- can
Modifies List<String> - A list of users that have modify ACL access to the dashboard.
- can
Views List<String> - A list of users that have view ACL access to the dashboard.
- chart
Title StringBg Color - chart
Title StringColor - chart
Title IntegerScalar - created
Epoch IntegerMillis - creator
Id String - customer String
- default
End IntegerTime - default
Start IntegerTime - default
Time StringWindow - deleted Boolean
- description String
- Description of the chart.
- display
Description Boolean - display
Query BooleanParameters - Whether the dashboard parameters section is opened by default when the dashboard is shown.
- display
Section BooleanTable Of Contents - Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
- event
Filter StringType - How charts belonging to this dashboard should display events.
BYCHARTis default if unspecified. Valid options are:BYCHART,AUTOMATIC,ALL,NONE,BYDASHBOARD, andBYCHARTANDDASHBOARD. - event
Query String - favorite Boolean
- Boolean
- id String
- name String
- The name of the parameters.
- num
Charts Integer - num
Favorites Integer - parameter
Details List<GetDashboards Dashboard Parameter Detail> - The current JSON representation of dashboard parameters. See parameter details.
- parameters Map<String,Object>
- sections
List<Get
Dashboards Dashboard Section> - system
Owned Boolean - List<String>
- A set of tags to assign to this resource.
- updated
Epoch IntegerMillis - updater
Id String - url String
- Unique identifier, also a URL slug of the dashboard.
- views
Last IntegerDay - views
Last IntegerMonth - views
Last IntegerWeek
- can
Modifies string[] - A list of users that have modify ACL access to the dashboard.
- can
Views string[] - A list of users that have view ACL access to the dashboard.
- chart
Title stringBg Color - chart
Title stringColor - chart
Title numberScalar - created
Epoch numberMillis - creator
Id string - customer string
- default
End numberTime - default
Start numberTime - default
Time stringWindow - deleted boolean
- description string
- Description of the chart.
- display
Description boolean - display
Query booleanParameters - Whether the dashboard parameters section is opened by default when the dashboard is shown.
- display
Section booleanTable Of Contents - Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
- event
Filter stringType - How charts belonging to this dashboard should display events.
BYCHARTis default if unspecified. Valid options are:BYCHART,AUTOMATIC,ALL,NONE,BYDASHBOARD, andBYCHARTANDDASHBOARD. - event
Query string - favorite boolean
- boolean
- id string
- name string
- The name of the parameters.
- num
Charts number - num
Favorites number - parameter
Details GetDashboards Dashboard Parameter Detail[] - The current JSON representation of dashboard parameters. See parameter details.
- parameters {[key: string]: any}
- sections
Get
Dashboards Dashboard Section[] - system
Owned boolean - string[]
- A set of tags to assign to this resource.
- updated
Epoch numberMillis - updater
Id string - url string
- Unique identifier, also a URL slug of the dashboard.
- views
Last numberDay - views
Last numberMonth - views
Last numberWeek
- can_
modifies Sequence[str] - A list of users that have modify ACL access to the dashboard.
- can_
views Sequence[str] - A list of users that have view ACL access to the dashboard.
- chart_
title_ strbg_ color - chart_
title_ strcolor - chart_
title_ intscalar - created_
epoch_ intmillis - creator_
id str - customer str
- default_
end_ inttime - default_
start_ inttime - default_
time_ strwindow - deleted bool
- description str
- Description of the chart.
- display_
description bool - display_
query_ boolparameters - Whether the dashboard parameters section is opened by default when the dashboard is shown.
- display_
section_ booltable_ of_ contents - Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
- event_
filter_ strtype - How charts belonging to this dashboard should display events.
BYCHARTis default if unspecified. Valid options are:BYCHART,AUTOMATIC,ALL,NONE,BYDASHBOARD, andBYCHARTANDDASHBOARD. - event_
query str - favorite bool
- bool
- id str
- name str
- The name of the parameters.
- num_
charts int - num_
favorites int - parameter_
details Sequence[GetDashboards Dashboard Parameter Detail] - The current JSON representation of dashboard parameters. See parameter details.
- parameters Mapping[str, Any]
- sections
Sequence[Get
Dashboards Dashboard Section] - system_
owned bool - Sequence[str]
- A set of tags to assign to this resource.
- updated_
epoch_ intmillis - updater_
id str - url str
- Unique identifier, also a URL slug of the dashboard.
- views_
last_ intday - views_
last_ intmonth - views_
last_ intweek
- can
Modifies List<String> - A list of users that have modify ACL access to the dashboard.
- can
Views List<String> - A list of users that have view ACL access to the dashboard.
- chart
Title StringBg Color - chart
Title StringColor - chart
Title NumberScalar - created
Epoch NumberMillis - creator
Id String - customer String
- default
End NumberTime - default
Start NumberTime - default
Time StringWindow - deleted Boolean
- description String
- Description of the chart.
- display
Description Boolean - display
Query BooleanParameters - Whether the dashboard parameters section is opened by default when the dashboard is shown.
- display
Section BooleanTable Of Contents - Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown.
- event
Filter StringType - How charts belonging to this dashboard should display events.
BYCHARTis default if unspecified. Valid options are:BYCHART,AUTOMATIC,ALL,NONE,BYDASHBOARD, andBYCHARTANDDASHBOARD. - event
Query String - favorite Boolean
- Boolean
- id String
- name String
- The name of the parameters.
- num
Charts Number - num
Favorites Number - parameter
Details List<Property Map> - The current JSON representation of dashboard parameters. See parameter details.
- parameters Map<Any>
- sections List<Property Map>
- system
Owned Boolean - List<String>
- A set of tags to assign to this resource.
- updated
Epoch NumberMillis - updater
Id String - url String
- Unique identifier, also a URL slug of the dashboard.
- views
Last NumberDay - views
Last NumberMonth - views
Last NumberWeek
GetDashboardsDashboardParameterDetail
- Default
Value string - The default value of the parameter.
- Dynamic
Field stringType - For
DYNAMICparameter types, the type of the field. Valid options areSOURCE,SOURCE_TAG,METRIC_NAME,TAG_KEY, andMATCHING_SOURCE_TAG. - Hide
From boolView - If
truethe parameter will only be shown on the edit view of the dashboard. - Label string
- The label for the parameter.
- Parameter
Type string - The type of the parameter.
SIMPLE,LIST, orDYNAMIC. - Query
Value string - For
DYNAMICparameter types, the query to execute to return values. - Tag
Key string - For
TAG_KEYdynamic field types, the tag key to return. - Values
To Dictionary<string, string>Readable Strings - A string to string map. At least one of the keys must match the value of
default_value.
- Default
Value string - The default value of the parameter.
- Dynamic
Field stringType - For
DYNAMICparameter types, the type of the field. Valid options areSOURCE,SOURCE_TAG,METRIC_NAME,TAG_KEY, andMATCHING_SOURCE_TAG. - Hide
From boolView - If
truethe parameter will only be shown on the edit view of the dashboard. - Label string
- The label for the parameter.
- Parameter
Type string - The type of the parameter.
SIMPLE,LIST, orDYNAMIC. - Query
Value string - For
DYNAMICparameter types, the query to execute to return values. - Tag
Key string - For
TAG_KEYdynamic field types, the tag key to return. - Values
To map[string]stringReadable Strings - A string to string map. At least one of the keys must match the value of
default_value.
- default
Value String - The default value of the parameter.
- dynamic
Field StringType - For
DYNAMICparameter types, the type of the field. Valid options areSOURCE,SOURCE_TAG,METRIC_NAME,TAG_KEY, andMATCHING_SOURCE_TAG. - hide
From BooleanView - If
truethe parameter will only be shown on the edit view of the dashboard. - label String
- The label for the parameter.
- parameter
Type String - The type of the parameter.
SIMPLE,LIST, orDYNAMIC. - query
Value String - For
DYNAMICparameter types, the query to execute to return values. - tag
Key String - For
TAG_KEYdynamic field types, the tag key to return. - values
To Map<String,String>Readable Strings - A string to string map. At least one of the keys must match the value of
default_value.
- default
Value string - The default value of the parameter.
- dynamic
Field stringType - For
DYNAMICparameter types, the type of the field. Valid options areSOURCE,SOURCE_TAG,METRIC_NAME,TAG_KEY, andMATCHING_SOURCE_TAG. - hide
From booleanView - If
truethe parameter will only be shown on the edit view of the dashboard. - label string
- The label for the parameter.
- parameter
Type string - The type of the parameter.
SIMPLE,LIST, orDYNAMIC. - query
Value string - For
DYNAMICparameter types, the query to execute to return values. - tag
Key string - For
TAG_KEYdynamic field types, the tag key to return. - values
To {[key: string]: string}Readable Strings - A string to string map. At least one of the keys must match the value of
default_value.
- default_
value str - The default value of the parameter.
- dynamic_
field_ strtype - For
DYNAMICparameter types, the type of the field. Valid options areSOURCE,SOURCE_TAG,METRIC_NAME,TAG_KEY, andMATCHING_SOURCE_TAG. - hide_
from_ boolview - If
truethe parameter will only be shown on the edit view of the dashboard. - label str
- The label for the parameter.
- parameter_
type str - The type of the parameter.
SIMPLE,LIST, orDYNAMIC. - query_
value str - For
DYNAMICparameter types, the query to execute to return values. - tag_
key str - For
TAG_KEYdynamic field types, the tag key to return. - values_
to_ Mapping[str, str]readable_ strings - A string to string map. At least one of the keys must match the value of
default_value.
- default
Value String - The default value of the parameter.
- dynamic
Field StringType - For
DYNAMICparameter types, the type of the field. Valid options areSOURCE,SOURCE_TAG,METRIC_NAME,TAG_KEY, andMATCHING_SOURCE_TAG. - hide
From BooleanView - If
truethe parameter will only be shown on the edit view of the dashboard. - label String
- The label for the parameter.
- parameter
Type String - The type of the parameter.
SIMPLE,LIST, orDYNAMIC. - query
Value String - For
DYNAMICparameter types, the query to execute to return values. - tag
Key String - For
TAG_KEYdynamic field types, the tag key to return. - values
To Map<String>Readable Strings - A string to string map. At least one of the keys must match the value of
default_value.
GetDashboardsDashboardSection
- Name string
- The name of the parameters.
- Rows
List<Get
Dashboards Dashboard Section Row>
- Name string
- The name of the parameters.
- Rows
[]Get
Dashboards Dashboard Section Row
- name String
- The name of the parameters.
- rows
List<Get
Dashboards Dashboard Section Row>
- name string
- The name of the parameters.
- rows
Get
Dashboards Dashboard Section Row[]
- name str
- The name of the parameters.
- rows
Sequence[Get
Dashboards Dashboard Section Row]
- name String
- The name of the parameters.
- rows List<Property Map>
GetDashboardsDashboardSectionRow
- Charts
List<Get
Dashboards Dashboard Section Row Chart> - Height
Factor int - Name string
- The name of the parameters.
- Charts
[]Get
Dashboards Dashboard Section Row Chart - Height
Factor int - Name string
- The name of the parameters.
- charts
List<Get
Dashboards Dashboard Section Row Chart> - height
Factor Integer - name String
- The name of the parameters.
- charts
Get
Dashboards Dashboard Section Row Chart[] - height
Factor number - name string
- The name of the parameters.
- charts
Sequence[Get
Dashboards Dashboard Section Row Chart] - height_
factor int - name str
- The name of the parameters.
- charts List<Property Map>
- height
Factor Number - name String
- The name of the parameters.
GetDashboardsDashboardSectionRowChart
- Base int
- The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
- Chart
Attributes string - Chart
Settings List<GetDashboards Dashboard Section Row Chart Chart Setting> - Description string
- Description of the chart.
- Include
Obsolete boolMetrics - Interpolate
Points boolKey - Name string
- The name of the parameters.
- No
Default boolEvents - Sources
List<Get
Dashboards Dashboard Section Row Chart Source> - Summarization string
- Summarization strategy for the chart. MEAN is default.
- Units string
- String to label the units of the chart on the Y-Axis.
- Base int
- The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
- Chart
Attributes string - Chart
Settings []GetDashboards Dashboard Section Row Chart Chart Setting - Description string
- Description of the chart.
- Include
Obsolete boolMetrics - Interpolate
Points boolKey - Name string
- The name of the parameters.
- No
Default boolEvents - Sources
[]Get
Dashboards Dashboard Section Row Chart Source - Summarization string
- Summarization strategy for the chart. MEAN is default.
- Units string
- String to label the units of the chart on the Y-Axis.
- base Integer
- The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
- chart
Attributes String - chart
Settings List<GetDashboards Dashboard Section Row Chart Chart Setting> - description String
- Description of the chart.
- include
Obsolete BooleanMetrics - interpolate
Points BooleanKey - name String
- The name of the parameters.
- no
Default BooleanEvents - sources
List<Get
Dashboards Dashboard Section Row Chart Source> - summarization String
- Summarization strategy for the chart. MEAN is default.
- units String
- String to label the units of the chart on the Y-Axis.
- base number
- The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
- chart
Attributes string - chart
Settings GetDashboards Dashboard Section Row Chart Chart Setting[] - description string
- Description of the chart.
- include
Obsolete booleanMetrics - interpolate
Points booleanKey - name string
- The name of the parameters.
- no
Default booleanEvents - sources
Get
Dashboards Dashboard Section Row Chart Source[] - summarization string
- Summarization strategy for the chart. MEAN is default.
- units string
- String to label the units of the chart on the Y-Axis.
- base int
- The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
- chart_
attributes str - chart_
settings Sequence[GetDashboards Dashboard Section Row Chart Chart Setting] - description str
- Description of the chart.
- include_
obsolete_ boolmetrics - interpolate_
points_ boolkey - name str
- The name of the parameters.
- no_
default_ boolevents - sources
Sequence[Get
Dashboards Dashboard Section Row Chart Source] - summarization str
- Summarization strategy for the chart. MEAN is default.
- units str
- String to label the units of the chart on the Y-Axis.
- base Number
- The base of logarithmic scale charts. Omit or set to 0 for the default linear scale. Usually set to 10 for the traditional logarithmic scale.
- chart
Attributes String - chart
Settings List<Property Map> - description String
- Description of the chart.
- include
Obsolete BooleanMetrics - interpolate
Points BooleanKey - name String
- The name of the parameters.
- no
Default BooleanEvents - sources List<Property Map>
- summarization String
- Summarization strategy for the chart. MEAN is default.
- units String
- String to label the units of the chart on the Y-Axis.
GetDashboardsDashboardSectionRowChartChartSetting
- bool
- This setting is deprecated.
- string
- This setting is deprecated.
- List<string>
- For the tabular view, a list of point tags to display when using the
customtag display mode. - Expected
Data intSpacing - Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
- Fixed
Legend List<string>Display Stats - (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
- Fixed
Legend boolEnabled - (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
- Fixed
Legend stringFilter Field - (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are
CURRENT,MEAN,MEDIAN,SUM,MIN,MAX, andCOUNT. - Fixed
Legend intFilter Limit - (Optional) Number of series to include in the fixed legend.
- Fixed
Legend stringFilter Sort - (Optional) Whether to display
TOPorBOTTOMranked series in a fixed legend. Valid options areTOP, andBOTTOM. - Fixed
Legend boolHide Label - (Optional) This setting is deprecated.
- Fixed
Legend stringPosition - (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are
RIGHT,TOP,LEFT,BOTTOM. - Fixed
Legend boolUse Raw Stats - (Optional) If
true, the legend uses non-summarized stats instead of summarized. - Group
By boolSource - For the tabular view, whether to group multi metrics into a single row by a common source. If set to
false, each source is displayed in its own row. If set totrue, multiple metrics for the same host are displayed as different columns in the same row. - Invert
Dynamic boolLegend Hover Control - (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- Line
Type string - Plot interpolation type.
linearis default. Valid options arelinear,step-before,step-after,basis,cardinal, andmonotone. - Max double
- Max value of the Y-axis. Set to null or leave blank for auto.
- Min double
- Min value of the Y-axis. Set to null or leave blank for auto.
- int
- For the tabular view defines how many point tags to display.
- Plain
Markdown stringContent - The markdown content for a Markdown display, in plain text.
- Show
Hosts bool - For the tabular view, whether to display sources. Default is
true. - Show
Labels bool - For the tabular view, whether to display labels. Default is
true. - Show
Raw boolValues - For the tabular view, whether to display raw values. Default is
false. - Sort
Values boolDescending - For the tabular view, whether to display values in descending order. Default is
false. - Sparkline
Decimal intPrecision - For the single stat view, the decimal precision of the displayed number.
- Sparkline
Display stringColor - For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
- Sparkline
Display stringFont Size - For the single stat view, the font size of the displayed text, in percent.
- Sparkline
Display stringHorizontal Position - For the single stat view, the horizontal position of the displayed text. Valid options are
MIDDLE,LEFT,RIGHT. - Sparkline
Display stringPostfix - For the single stat view, a string to append to the displayed text.
- Sparkline
Display stringPrefix - For the single stat view, a string to add before the displayed text.
- Sparkline
Display stringValue Type - For the single stat view, where to display the name of the query or the value of the query. Valid options are
VALUEorLABEL. - Sparkline
Display stringVertical Position - This setting is deprecated.
- Sparkline
Fill stringColor - For the single stat view, the color of the background fill. Values should be in RGBA format.
- Sparkline
Line stringColor - For the single stat view, the color of the line. Values should be in RGBA format.
- Sparkline
Size string - For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are
BACKGROUND,BOTTOM,NONE. - Sparkline
Value stringColor Map Apply To - For the single stat view, whether to apply dynamic color settings to the displayed
TEXTorBACKGROUND. Valid options areTEXTorBACKGROUND. - Sparkline
Value List<string>Color Map Colors - For the single stat view, a list of colors that differing query values map to. Must contain one more element than
sparkline_value_color_map_values_v2. Values should be in RGBA format. - Sparkline
Value List<int>Color Map Values - This setting is deprecated.
- Sparkline
Value List<double>Color Map Values V2s - For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than
sparkline_value_color_map_colors. - Sparkline
Value List<string>Text Map Texts - For the single stat view, a list of display text values that different query values map to. Must contain one more element than
sparkline_value_text_map_thresholds. - Sparkline
Value List<double>Text Map Thresholds - For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than
sparkline_value_text_map_text. - Stack
Type string - Type of stacked chart (applicable only if chart type is
stacked).zero(default) means stacked from y=0.expandmeans normalized from 0 to 1.wigglemeans minimize weighted changes.silhouettemeans to center the stream. Valid options arezero,expand,wiggle,silhouette, andbars. - Tag
Mode string - For the tabular view, which mode to use to determine which point tags to display. Valid options are
all,top, orcustom. - Time
Based boolColoring - For x-y scatterplots, whether to color more recent points as darker than older points.
- Type string
- Chart Type.
linerefers to the Line Plot,scatterto the Point Plot,stacked-areato the Stacked Area plot,tableto the Tabular View,scatterplot-xyto Scatter Plot,markdown-widgetto the Markdown display, andsparklineto the Single Stat view. Valid options areline,scatterplot,stacked-area,stacked-column,table,scatterplot-xy,markdown-widget,sparkline,globe,nodemap,top-k,status-list, andhistogram. - Window
Size int - Width, in minutes, of the time window to use for
lastwindowing. - Windowing string
- For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are
fullorlast. - Xmax double
- For x-y scatterplots, max value for the X-axis. Set to null for auto.
- Xmin double
- For x-y scatterplots, min value for the X-axis. Set to null for auto.
- Y0Scale
Si boolBy1024 - Y0Unit
Autoscaling bool - (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- Y1Max double
- Y1Min double
- Y1Scale
Si boolBy1024 - Y1Unit
Autoscaling bool - (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
- Y1Units string
- For plots with multiple Y-axes, units for right side Y-axis.
- Ymax double
- For x-y scatterplots, max value for the Y-axis. Set to null for auto.
- Ymin double
- For x-y scatterplots, min value for the Y-axis. Set to null for auto.
- bool
- This setting is deprecated.
- string
- This setting is deprecated.
- []string
- For the tabular view, a list of point tags to display when using the
customtag display mode. - Expected
Data intSpacing - Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
- Fixed
Legend []stringDisplay Stats - (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
- Fixed
Legend boolEnabled - (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
- Fixed
Legend stringFilter Field - (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are
CURRENT,MEAN,MEDIAN,SUM,MIN,MAX, andCOUNT. - Fixed
Legend intFilter Limit - (Optional) Number of series to include in the fixed legend.
- Fixed
Legend stringFilter Sort - (Optional) Whether to display
TOPorBOTTOMranked series in a fixed legend. Valid options areTOP, andBOTTOM. - Fixed
Legend boolHide Label - (Optional) This setting is deprecated.
- Fixed
Legend stringPosition - (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are
RIGHT,TOP,LEFT,BOTTOM. - Fixed
Legend boolUse Raw Stats - (Optional) If
true, the legend uses non-summarized stats instead of summarized. - Group
By boolSource - For the tabular view, whether to group multi metrics into a single row by a common source. If set to
false, each source is displayed in its own row. If set totrue, multiple metrics for the same host are displayed as different columns in the same row. - Invert
Dynamic boolLegend Hover Control - (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- Line
Type string - Plot interpolation type.
linearis default. Valid options arelinear,step-before,step-after,basis,cardinal, andmonotone. - Max float64
- Max value of the Y-axis. Set to null or leave blank for auto.
- Min float64
- Min value of the Y-axis. Set to null or leave blank for auto.
- int
- For the tabular view defines how many point tags to display.
- Plain
Markdown stringContent - The markdown content for a Markdown display, in plain text.
- Show
Hosts bool - For the tabular view, whether to display sources. Default is
true. - Show
Labels bool - For the tabular view, whether to display labels. Default is
true. - Show
Raw boolValues - For the tabular view, whether to display raw values. Default is
false. - Sort
Values boolDescending - For the tabular view, whether to display values in descending order. Default is
false. - Sparkline
Decimal intPrecision - For the single stat view, the decimal precision of the displayed number.
- Sparkline
Display stringColor - For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
- Sparkline
Display stringFont Size - For the single stat view, the font size of the displayed text, in percent.
- Sparkline
Display stringHorizontal Position - For the single stat view, the horizontal position of the displayed text. Valid options are
MIDDLE,LEFT,RIGHT. - Sparkline
Display stringPostfix - For the single stat view, a string to append to the displayed text.
- Sparkline
Display stringPrefix - For the single stat view, a string to add before the displayed text.
- Sparkline
Display stringValue Type - For the single stat view, where to display the name of the query or the value of the query. Valid options are
VALUEorLABEL. - Sparkline
Display stringVertical Position - This setting is deprecated.
- Sparkline
Fill stringColor - For the single stat view, the color of the background fill. Values should be in RGBA format.
- Sparkline
Line stringColor - For the single stat view, the color of the line. Values should be in RGBA format.
- Sparkline
Size string - For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are
BACKGROUND,BOTTOM,NONE. - Sparkline
Value stringColor Map Apply To - For the single stat view, whether to apply dynamic color settings to the displayed
TEXTorBACKGROUND. Valid options areTEXTorBACKGROUND. - Sparkline
Value []stringColor Map Colors - For the single stat view, a list of colors that differing query values map to. Must contain one more element than
sparkline_value_color_map_values_v2. Values should be in RGBA format. - Sparkline
Value []intColor Map Values - This setting is deprecated.
- Sparkline
Value []float64Color Map Values V2s - For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than
sparkline_value_color_map_colors. - Sparkline
Value []stringText Map Texts - For the single stat view, a list of display text values that different query values map to. Must contain one more element than
sparkline_value_text_map_thresholds. - Sparkline
Value []float64Text Map Thresholds - For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than
sparkline_value_text_map_text. - Stack
Type string - Type of stacked chart (applicable only if chart type is
stacked).zero(default) means stacked from y=0.expandmeans normalized from 0 to 1.wigglemeans minimize weighted changes.silhouettemeans to center the stream. Valid options arezero,expand,wiggle,silhouette, andbars. - Tag
Mode string - For the tabular view, which mode to use to determine which point tags to display. Valid options are
all,top, orcustom. - Time
Based boolColoring - For x-y scatterplots, whether to color more recent points as darker than older points.
- Type string
- Chart Type.
linerefers to the Line Plot,scatterto the Point Plot,stacked-areato the Stacked Area plot,tableto the Tabular View,scatterplot-xyto Scatter Plot,markdown-widgetto the Markdown display, andsparklineto the Single Stat view. Valid options areline,scatterplot,stacked-area,stacked-column,table,scatterplot-xy,markdown-widget,sparkline,globe,nodemap,top-k,status-list, andhistogram. - Window
Size int - Width, in minutes, of the time window to use for
lastwindowing. - Windowing string
- For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are
fullorlast. - Xmax float64
- For x-y scatterplots, max value for the X-axis. Set to null for auto.
- Xmin float64
- For x-y scatterplots, min value for the X-axis. Set to null for auto.
- Y0Scale
Si boolBy1024 - Y0Unit
Autoscaling bool - (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- Y1Max float64
- Y1Min float64
- Y1Scale
Si boolBy1024 - Y1Unit
Autoscaling bool - (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
- Y1Units string
- For plots with multiple Y-axes, units for right side Y-axis.
- Ymax float64
- For x-y scatterplots, max value for the Y-axis. Set to null for auto.
- Ymin float64
- For x-y scatterplots, min value for the Y-axis. Set to null for auto.
- Boolean
- This setting is deprecated.
- String
- This setting is deprecated.
- List<String>
- For the tabular view, a list of point tags to display when using the
customtag display mode. - expected
Data IntegerSpacing - Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
- fixed
Legend List<String>Display Stats - (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed
Legend BooleanEnabled - (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
- fixed
Legend StringFilter Field - (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are
CURRENT,MEAN,MEDIAN,SUM,MIN,MAX, andCOUNT. - fixed
Legend IntegerFilter Limit - (Optional) Number of series to include in the fixed legend.
- fixed
Legend StringFilter Sort - (Optional) Whether to display
TOPorBOTTOMranked series in a fixed legend. Valid options areTOP, andBOTTOM. - fixed
Legend BooleanHide Label - (Optional) This setting is deprecated.
- fixed
Legend StringPosition - (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are
RIGHT,TOP,LEFT,BOTTOM. - fixed
Legend BooleanUse Raw Stats - (Optional) If
true, the legend uses non-summarized stats instead of summarized. - group
By BooleanSource - For the tabular view, whether to group multi metrics into a single row by a common source. If set to
false, each source is displayed in its own row. If set totrue, multiple metrics for the same host are displayed as different columns in the same row. - invert
Dynamic BooleanLegend Hover Control - (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line
Type String - Plot interpolation type.
linearis default. Valid options arelinear,step-before,step-after,basis,cardinal, andmonotone. - max Double
- Max value of the Y-axis. Set to null or leave blank for auto.
- min Double
- Min value of the Y-axis. Set to null or leave blank for auto.
- Integer
- For the tabular view defines how many point tags to display.
- plain
Markdown StringContent - The markdown content for a Markdown display, in plain text.
- show
Hosts Boolean - For the tabular view, whether to display sources. Default is
true. - show
Labels Boolean - For the tabular view, whether to display labels. Default is
true. - show
Raw BooleanValues - For the tabular view, whether to display raw values. Default is
false. - sort
Values BooleanDescending - For the tabular view, whether to display values in descending order. Default is
false. - sparkline
Decimal IntegerPrecision - For the single stat view, the decimal precision of the displayed number.
- sparkline
Display StringColor - For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
- sparkline
Display StringFont Size - For the single stat view, the font size of the displayed text, in percent.
- sparkline
Display StringHorizontal Position - For the single stat view, the horizontal position of the displayed text. Valid options are
MIDDLE,LEFT,RIGHT. - sparkline
Display StringPostfix - For the single stat view, a string to append to the displayed text.
- sparkline
Display StringPrefix - For the single stat view, a string to add before the displayed text.
- sparkline
Display StringValue Type - For the single stat view, where to display the name of the query or the value of the query. Valid options are
VALUEorLABEL. - sparkline
Display StringVertical Position - This setting is deprecated.
- sparkline
Fill StringColor - For the single stat view, the color of the background fill. Values should be in RGBA format.
- sparkline
Line StringColor - For the single stat view, the color of the line. Values should be in RGBA format.
- sparkline
Size String - For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are
BACKGROUND,BOTTOM,NONE. - sparkline
Value StringColor Map Apply To - For the single stat view, whether to apply dynamic color settings to the displayed
TEXTorBACKGROUND. Valid options areTEXTorBACKGROUND. - sparkline
Value List<String>Color Map Colors - For the single stat view, a list of colors that differing query values map to. Must contain one more element than
sparkline_value_color_map_values_v2. Values should be in RGBA format. - sparkline
Value List<Integer>Color Map Values - This setting is deprecated.
- sparkline
Value List<Double>Color Map Values V2s - For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than
sparkline_value_color_map_colors. - sparkline
Value List<String>Text Map Texts - For the single stat view, a list of display text values that different query values map to. Must contain one more element than
sparkline_value_text_map_thresholds. - sparkline
Value List<Double>Text Map Thresholds - For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than
sparkline_value_text_map_text. - stack
Type String - Type of stacked chart (applicable only if chart type is
stacked).zero(default) means stacked from y=0.expandmeans normalized from 0 to 1.wigglemeans minimize weighted changes.silhouettemeans to center the stream. Valid options arezero,expand,wiggle,silhouette, andbars. - tag
Mode String - For the tabular view, which mode to use to determine which point tags to display. Valid options are
all,top, orcustom. - time
Based BooleanColoring - For x-y scatterplots, whether to color more recent points as darker than older points.
- type String
- Chart Type.
linerefers to the Line Plot,scatterto the Point Plot,stacked-areato the Stacked Area plot,tableto the Tabular View,scatterplot-xyto Scatter Plot,markdown-widgetto the Markdown display, andsparklineto the Single Stat view. Valid options areline,scatterplot,stacked-area,stacked-column,table,scatterplot-xy,markdown-widget,sparkline,globe,nodemap,top-k,status-list, andhistogram. - window
Size Integer - Width, in minutes, of the time window to use for
lastwindowing. - windowing String
- For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are
fullorlast. - xmax Double
- For x-y scatterplots, max value for the X-axis. Set to null for auto.
- xmin Double
- For x-y scatterplots, min value for the X-axis. Set to null for auto.
- y0Scale
Si BooleanBy1024 - y0Unit
Autoscaling Boolean - (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1Max Double
- y1Min Double
- y1Scale
Si BooleanBy1024 - y1Unit
Autoscaling Boolean - (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
- y1Units String
- For plots with multiple Y-axes, units for right side Y-axis.
- ymax Double
- For x-y scatterplots, max value for the Y-axis. Set to null for auto.
- ymin Double
- For x-y scatterplots, min value for the Y-axis. Set to null for auto.
- boolean
- This setting is deprecated.
- string
- This setting is deprecated.
- string[]
- For the tabular view, a list of point tags to display when using the
customtag display mode. - expected
Data numberSpacing - Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
- fixed
Legend string[]Display Stats - (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed
Legend booleanEnabled - (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
- fixed
Legend stringFilter Field - (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are
CURRENT,MEAN,MEDIAN,SUM,MIN,MAX, andCOUNT. - fixed
Legend numberFilter Limit - (Optional) Number of series to include in the fixed legend.
- fixed
Legend stringFilter Sort - (Optional) Whether to display
TOPorBOTTOMranked series in a fixed legend. Valid options areTOP, andBOTTOM. - fixed
Legend booleanHide Label - (Optional) This setting is deprecated.
- fixed
Legend stringPosition - (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are
RIGHT,TOP,LEFT,BOTTOM. - fixed
Legend booleanUse Raw Stats - (Optional) If
true, the legend uses non-summarized stats instead of summarized. - group
By booleanSource - For the tabular view, whether to group multi metrics into a single row by a common source. If set to
false, each source is displayed in its own row. If set totrue, multiple metrics for the same host are displayed as different columns in the same row. - invert
Dynamic booleanLegend Hover Control - (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line
Type string - Plot interpolation type.
linearis default. Valid options arelinear,step-before,step-after,basis,cardinal, andmonotone. - max number
- Max value of the Y-axis. Set to null or leave blank for auto.
- min number
- Min value of the Y-axis. Set to null or leave blank for auto.
- number
- For the tabular view defines how many point tags to display.
- plain
Markdown stringContent - The markdown content for a Markdown display, in plain text.
- show
Hosts boolean - For the tabular view, whether to display sources. Default is
true. - show
Labels boolean - For the tabular view, whether to display labels. Default is
true. - show
Raw booleanValues - For the tabular view, whether to display raw values. Default is
false. - sort
Values booleanDescending - For the tabular view, whether to display values in descending order. Default is
false. - sparkline
Decimal numberPrecision - For the single stat view, the decimal precision of the displayed number.
- sparkline
Display stringColor - For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
- sparkline
Display stringFont Size - For the single stat view, the font size of the displayed text, in percent.
- sparkline
Display stringHorizontal Position - For the single stat view, the horizontal position of the displayed text. Valid options are
MIDDLE,LEFT,RIGHT. - sparkline
Display stringPostfix - For the single stat view, a string to append to the displayed text.
- sparkline
Display stringPrefix - For the single stat view, a string to add before the displayed text.
- sparkline
Display stringValue Type - For the single stat view, where to display the name of the query or the value of the query. Valid options are
VALUEorLABEL. - sparkline
Display stringVertical Position - This setting is deprecated.
- sparkline
Fill stringColor - For the single stat view, the color of the background fill. Values should be in RGBA format.
- sparkline
Line stringColor - For the single stat view, the color of the line. Values should be in RGBA format.
- sparkline
Size string - For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are
BACKGROUND,BOTTOM,NONE. - sparkline
Value stringColor Map Apply To - For the single stat view, whether to apply dynamic color settings to the displayed
TEXTorBACKGROUND. Valid options areTEXTorBACKGROUND. - sparkline
Value string[]Color Map Colors - For the single stat view, a list of colors that differing query values map to. Must contain one more element than
sparkline_value_color_map_values_v2. Values should be in RGBA format. - sparkline
Value number[]Color Map Values - This setting is deprecated.
- sparkline
Value number[]Color Map Values V2s - For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than
sparkline_value_color_map_colors. - sparkline
Value string[]Text Map Texts - For the single stat view, a list of display text values that different query values map to. Must contain one more element than
sparkline_value_text_map_thresholds. - sparkline
Value number[]Text Map Thresholds - For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than
sparkline_value_text_map_text. - stack
Type string - Type of stacked chart (applicable only if chart type is
stacked).zero(default) means stacked from y=0.expandmeans normalized from 0 to 1.wigglemeans minimize weighted changes.silhouettemeans to center the stream. Valid options arezero,expand,wiggle,silhouette, andbars. - tag
Mode string - For the tabular view, which mode to use to determine which point tags to display. Valid options are
all,top, orcustom. - time
Based booleanColoring - For x-y scatterplots, whether to color more recent points as darker than older points.
- type string
- Chart Type.
linerefers to the Line Plot,scatterto the Point Plot,stacked-areato the Stacked Area plot,tableto the Tabular View,scatterplot-xyto Scatter Plot,markdown-widgetto the Markdown display, andsparklineto the Single Stat view. Valid options areline,scatterplot,stacked-area,stacked-column,table,scatterplot-xy,markdown-widget,sparkline,globe,nodemap,top-k,status-list, andhistogram. - window
Size number - Width, in minutes, of the time window to use for
lastwindowing. - windowing string
- For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are
fullorlast. - xmax number
- For x-y scatterplots, max value for the X-axis. Set to null for auto.
- xmin number
- For x-y scatterplots, min value for the X-axis. Set to null for auto.
- y0Scale
Si booleanBy1024 - y0Unit
Autoscaling boolean - (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1Max number
- y1Min number
- y1Scale
Si booleanBy1024 - y1Unit
Autoscaling boolean - (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
- y1Units string
- For plots with multiple Y-axes, units for right side Y-axis.
- ymax number
- For x-y scatterplots, max value for the Y-axis. Set to null for auto.
- ymin number
- For x-y scatterplots, min value for the Y-axis. Set to null for auto.
- bool
- This setting is deprecated.
- str
- This setting is deprecated.
- Sequence[str]
- For the tabular view, a list of point tags to display when using the
customtag display mode. - expected_
data_ intspacing - Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
- fixed_
legend_ Sequence[str]display_ stats - (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed_
legend_ boolenabled - (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
- fixed_
legend_ strfilter_ field - (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are
CURRENT,MEAN,MEDIAN,SUM,MIN,MAX, andCOUNT. - fixed_
legend_ intfilter_ limit - (Optional) Number of series to include in the fixed legend.
- fixed_
legend_ strfilter_ sort - (Optional) Whether to display
TOPorBOTTOMranked series in a fixed legend. Valid options areTOP, andBOTTOM. - fixed_
legend_ boolhide_ label - (Optional) This setting is deprecated.
- fixed_
legend_ strposition - (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are
RIGHT,TOP,LEFT,BOTTOM. - fixed_
legend_ booluse_ raw_ stats - (Optional) If
true, the legend uses non-summarized stats instead of summarized. - group_
by_ boolsource - For the tabular view, whether to group multi metrics into a single row by a common source. If set to
false, each source is displayed in its own row. If set totrue, multiple metrics for the same host are displayed as different columns in the same row. - invert_
dynamic_ boollegend_ hover_ control - (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line_
type str - Plot interpolation type.
linearis default. Valid options arelinear,step-before,step-after,basis,cardinal, andmonotone. - max float
- Max value of the Y-axis. Set to null or leave blank for auto.
- min float
- Min value of the Y-axis. Set to null or leave blank for auto.
- int
- For the tabular view defines how many point tags to display.
- plain_
markdown_ strcontent - The markdown content for a Markdown display, in plain text.
- show_
hosts bool - For the tabular view, whether to display sources. Default is
true. - show_
labels bool - For the tabular view, whether to display labels. Default is
true. - show_
raw_ boolvalues - For the tabular view, whether to display raw values. Default is
false. - sort_
values_ booldescending - For the tabular view, whether to display values in descending order. Default is
false. - sparkline_
decimal_ intprecision - For the single stat view, the decimal precision of the displayed number.
- sparkline_
display_ strcolor - For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
- sparkline_
display_ strfont_ size - For the single stat view, the font size of the displayed text, in percent.
- sparkline_
display_ strhorizontal_ position - For the single stat view, the horizontal position of the displayed text. Valid options are
MIDDLE,LEFT,RIGHT. - sparkline_
display_ strpostfix - For the single stat view, a string to append to the displayed text.
- sparkline_
display_ strprefix - For the single stat view, a string to add before the displayed text.
- sparkline_
display_ strvalue_ type - For the single stat view, where to display the name of the query or the value of the query. Valid options are
VALUEorLABEL. - sparkline_
display_ strvertical_ position - This setting is deprecated.
- sparkline_
fill_ strcolor - For the single stat view, the color of the background fill. Values should be in RGBA format.
- sparkline_
line_ strcolor - For the single stat view, the color of the line. Values should be in RGBA format.
- sparkline_
size str - For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are
BACKGROUND,BOTTOM,NONE. - sparkline_
value_ strcolor_ map_ apply_ to - For the single stat view, whether to apply dynamic color settings to the displayed
TEXTorBACKGROUND. Valid options areTEXTorBACKGROUND. - sparkline_
value_ Sequence[str]color_ map_ colors - For the single stat view, a list of colors that differing query values map to. Must contain one more element than
sparkline_value_color_map_values_v2. Values should be in RGBA format. - sparkline_
value_ Sequence[int]color_ map_ values - This setting is deprecated.
- sparkline_
value_ Sequence[float]color_ map_ values_ v2s - For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than
sparkline_value_color_map_colors. - sparkline_
value_ Sequence[str]text_ map_ texts - For the single stat view, a list of display text values that different query values map to. Must contain one more element than
sparkline_value_text_map_thresholds. - sparkline_
value_ Sequence[float]text_ map_ thresholds - For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than
sparkline_value_text_map_text. - stack_
type str - Type of stacked chart (applicable only if chart type is
stacked).zero(default) means stacked from y=0.expandmeans normalized from 0 to 1.wigglemeans minimize weighted changes.silhouettemeans to center the stream. Valid options arezero,expand,wiggle,silhouette, andbars. - tag_
mode str - For the tabular view, which mode to use to determine which point tags to display. Valid options are
all,top, orcustom. - time_
based_ boolcoloring - For x-y scatterplots, whether to color more recent points as darker than older points.
- type str
- Chart Type.
linerefers to the Line Plot,scatterto the Point Plot,stacked-areato the Stacked Area plot,tableto the Tabular View,scatterplot-xyto Scatter Plot,markdown-widgetto the Markdown display, andsparklineto the Single Stat view. Valid options areline,scatterplot,stacked-area,stacked-column,table,scatterplot-xy,markdown-widget,sparkline,globe,nodemap,top-k,status-list, andhistogram. - window_
size int - Width, in minutes, of the time window to use for
lastwindowing. - windowing str
- For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are
fullorlast. - xmax float
- For x-y scatterplots, max value for the X-axis. Set to null for auto.
- xmin float
- For x-y scatterplots, min value for the X-axis. Set to null for auto.
- y0_
scale_ boolsi_ by1024 - y0_
unit_ boolautoscaling - (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1_
max float - y1_
min float - y1_
scale_ boolsi_ by1024 - y1_
unit_ boolautoscaling - (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
- y1_
units str - For plots with multiple Y-axes, units for right side Y-axis.
- ymax float
- For x-y scatterplots, max value for the Y-axis. Set to null for auto.
- ymin float
- For x-y scatterplots, min value for the Y-axis. Set to null for auto.
- Boolean
- This setting is deprecated.
- String
- This setting is deprecated.
- List<String>
- For the tabular view, a list of point tags to display when using the
customtag display mode. - expected
Data NumberSpacing - Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid in line plots. Default is 60.
- fixed
Legend List<String>Display Stats - (Optional) For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed
Legend BooleanEnabled - (Optional) Whether to enable a fixed tabular legend adjacent to the chart.
- fixed
Legend StringFilter Field - (Optional) Statistic to use for determining whether a series is displayed on the fixed legend. Valid options are
CURRENT,MEAN,MEDIAN,SUM,MIN,MAX, andCOUNT. - fixed
Legend NumberFilter Limit - (Optional) Number of series to include in the fixed legend.
- fixed
Legend StringFilter Sort - (Optional) Whether to display
TOPorBOTTOMranked series in a fixed legend. Valid options areTOP, andBOTTOM. - fixed
Legend BooleanHide Label - (Optional) This setting is deprecated.
- fixed
Legend StringPosition - (Optional) Where the fixed legend should be displayed with respect to the chart. Valid options are
RIGHT,TOP,LEFT,BOTTOM. - fixed
Legend BooleanUse Raw Stats - (Optional) If
true, the legend uses non-summarized stats instead of summarized. - group
By BooleanSource - For the tabular view, whether to group multi metrics into a single row by a common source. If set to
false, each source is displayed in its own row. If set totrue, multiple metrics for the same host are displayed as different columns in the same row. - invert
Dynamic BooleanLegend Hover Control - (Optional) Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line
Type String - Plot interpolation type.
linearis default. Valid options arelinear,step-before,step-after,basis,cardinal, andmonotone. - max Number
- Max value of the Y-axis. Set to null or leave blank for auto.
- min Number
- Min value of the Y-axis. Set to null or leave blank for auto.
- Number
- For the tabular view defines how many point tags to display.
- plain
Markdown StringContent - The markdown content for a Markdown display, in plain text.
- show
Hosts Boolean - For the tabular view, whether to display sources. Default is
true. - show
Labels Boolean - For the tabular view, whether to display labels. Default is
true. - show
Raw BooleanValues - For the tabular view, whether to display raw values. Default is
false. - sort
Values BooleanDescending - For the tabular view, whether to display values in descending order. Default is
false. - sparkline
Decimal NumberPrecision - For the single stat view, the decimal precision of the displayed number.
- sparkline
Display StringColor - For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in RGBA format.
- sparkline
Display StringFont Size - For the single stat view, the font size of the displayed text, in percent.
- sparkline
Display StringHorizontal Position - For the single stat view, the horizontal position of the displayed text. Valid options are
MIDDLE,LEFT,RIGHT. - sparkline
Display StringPostfix - For the single stat view, a string to append to the displayed text.
- sparkline
Display StringPrefix - For the single stat view, a string to add before the displayed text.
- sparkline
Display StringValue Type - For the single stat view, where to display the name of the query or the value of the query. Valid options are
VALUEorLABEL. - sparkline
Display StringVertical Position - This setting is deprecated.
- sparkline
Fill StringColor - For the single stat view, the color of the background fill. Values should be in RGBA format.
- sparkline
Line StringColor - For the single stat view, the color of the line. Values should be in RGBA format.
- sparkline
Size String - For the single stat view, this determines whether the sparkline of the statistic is displayed in the chart. Valid options are
BACKGROUND,BOTTOM,NONE. - sparkline
Value StringColor Map Apply To - For the single stat view, whether to apply dynamic color settings to the displayed
TEXTorBACKGROUND. Valid options areTEXTorBACKGROUND. - sparkline
Value List<String>Color Map Colors - For the single stat view, a list of colors that differing query values map to. Must contain one more element than
sparkline_value_color_map_values_v2. Values should be in RGBA format. - sparkline
Value List<Number>Color Map Values - This setting is deprecated.
- sparkline
Value List<Number>Color Map Values V2s - For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one element less than
sparkline_value_color_map_colors. - sparkline
Value List<String>Text Map Texts - For the single stat view, a list of display text values that different query values map to. Must contain one more element than
sparkline_value_text_map_thresholds. - sparkline
Value List<Number>Text Map Thresholds - For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one element less than
sparkline_value_text_map_text. - stack
Type String - Type of stacked chart (applicable only if chart type is
stacked).zero(default) means stacked from y=0.expandmeans normalized from 0 to 1.wigglemeans minimize weighted changes.silhouettemeans to center the stream. Valid options arezero,expand,wiggle,silhouette, andbars. - tag
Mode String - For the tabular view, which mode to use to determine which point tags to display. Valid options are
all,top, orcustom. - time
Based BooleanColoring - For x-y scatterplots, whether to color more recent points as darker than older points.
- type String
- Chart Type.
linerefers to the Line Plot,scatterto the Point Plot,stacked-areato the Stacked Area plot,tableto the Tabular View,scatterplot-xyto Scatter Plot,markdown-widgetto the Markdown display, andsparklineto the Single Stat view. Valid options areline,scatterplot,stacked-area,stacked-column,table,scatterplot-xy,markdown-widget,sparkline,globe,nodemap,top-k,status-list, andhistogram. - window
Size Number - Width, in minutes, of the time window to use for
lastwindowing. - windowing String
- For the tabular view, whether to use the full time window for the query or the last X minutes. Valid options are
fullorlast. - xmax Number
- For x-y scatterplots, max value for the X-axis. Set to null for auto.
- xmin Number
- For x-y scatterplots, min value for the X-axis. Set to null for auto.
- y0Scale
Si BooleanBy1024 - y0Unit
Autoscaling Boolean - (Optional) Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1Max Number
- y1Min Number
- y1Scale
Si BooleanBy1024 - y1Unit
Autoscaling Boolean - (Optional) Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units.
- y1Units String
- For plots with multiple Y-axes, units for right side Y-axis.
- ymax Number
- For x-y scatterplots, max value for the Y-axis. Set to null for auto.
- ymin Number
- For x-y scatterplots, min value for the Y-axis. Set to null for auto.
GetDashboardsDashboardSectionRowChartSource
- Disabled bool
- Whether the source is disabled.
- Name string
- The name of the parameters.
- Query string
- Query expression to plot on the chart.
- Querybuilder
Enabled bool - Scatter
Plot stringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X, orY. - Secondary
Axis bool - Source
Color string - Source
Description string - A description for the purpose of this source.
- Disabled bool
- Whether the source is disabled.
- Name string
- The name of the parameters.
- Query string
- Query expression to plot on the chart.
- Querybuilder
Enabled bool - Scatter
Plot stringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X, orY. - Secondary
Axis bool - Source
Color string - Source
Description string - A description for the purpose of this source.
- disabled Boolean
- Whether the source is disabled.
- name String
- The name of the parameters.
- query String
- Query expression to plot on the chart.
- querybuilder
Enabled Boolean - scatter
Plot StringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X, orY. - secondary
Axis Boolean - source
Color String - source
Description String - A description for the purpose of this source.
- disabled boolean
- Whether the source is disabled.
- name string
- The name of the parameters.
- query string
- Query expression to plot on the chart.
- querybuilder
Enabled boolean - scatter
Plot stringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X, orY. - secondary
Axis boolean - source
Color string - source
Description string - A description for the purpose of this source.
- disabled bool
- Whether the source is disabled.
- name str
- The name of the parameters.
- query str
- Query expression to plot on the chart.
- querybuilder_
enabled bool - scatter_
plot_ strsource - For scatter plots, does this query source the X-axis or the Y-axis,
X, orY. - secondary_
axis bool - source_
color str - source_
description str - A description for the purpose of this source.
- disabled Boolean
- Whether the source is disabled.
- name String
- The name of the parameters.
- query String
- Query expression to plot on the chart.
- querybuilder
Enabled Boolean - scatter
Plot StringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X, orY. - secondary
Axis Boolean - source
Color String - source
Description String - A description for the purpose of this source.
Package Details
- Repository
- Wavefront pulumi/pulumi-wavefront
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
wavefrontTerraform Provider.