wavefront.Dashboard
Explore with Pulumi AI
Provides a Wavefront Dashboard resource. This allows dashboards to be created, updated, and deleted.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.User;
import com.pulumi.wavefront.UserArgs;
import com.pulumi.wavefront.Dashboard;
import com.pulumi.wavefront.DashboardArgs;
import com.pulumi.wavefront.inputs.DashboardSectionArgs;
import com.pulumi.wavefront.inputs.DashboardParameterDetailArgs;
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) {
var basic = new User("basic", UserArgs.builder()
.email("test+tftesting@example.com")
.groups(
"agent_management",
"alerts_management")
.build());
var testDashboard = new Dashboard("testDashboard", DashboardArgs.builder()
.name("Terraform Test Dashboard")
.description("testing, testing")
.url("tftestcreate")
.displaySectionTableOfContents(true)
.displayQueryParameters(true)
.canViews(basic.id())
.sections(DashboardSectionArgs.builder()
.name("section 1")
.rows(DashboardSectionRowArgs.builder()
.charts(DashboardSectionRowChartArgs.builder()
.name("chart 1")
.description("chart number 1")
.units("something per unit")
.sources(DashboardSectionRowChartSourceArgs.builder()
.name("source name")
.query("ts()")
.build())
.chartSetting(DashboardSectionRowChartChartSettingArgs.builder()
.type("linear")
.build())
.summarization("MEAN")
.build())
.build())
.build())
.parameterDetails(DashboardParameterDetailArgs.builder()
.name("param1")
.label("param1")
.defaultValue("Label")
.hideFromView(false)
.parameterType("SIMPLE")
.valuesToReadableStrings(Map.of("Label", "test"))
.build())
.tags(
"b",
"terraform",
"a",
"test")
.build());
}
}
resources:
basic:
type: wavefront:User
properties:
email: test+tftesting@example.com
groups:
- agent_management
- alerts_management
testDashboard:
type: wavefront:Dashboard
name: test_dashboard
properties:
name: Terraform Test Dashboard
description: testing, testing
url: tftestcreate
displaySectionTableOfContents: true
displayQueryParameters: true
canViews:
- ${basic.id}
sections:
- name: section 1
rows:
- charts:
- name: chart 1
description: chart number 1
units: something per unit
sources:
- name: source name
query: ts()
chartSetting:
type: linear
summarization: MEAN
parameterDetails:
- name: param1
label: param1
defaultValue: Label
hideFromView: false
parameterType: SIMPLE
valuesToReadableStrings:
Label: test
tags:
- b
- terraform
- a
- test
Create Dashboard Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
args: DashboardArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Dashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
sections: Optional[Sequence[DashboardSectionArgs]] = None,
tags: Optional[Sequence[str]] = None,
url: Optional[str] = None,
can_modifies: Optional[Sequence[str]] = None,
can_views: Optional[Sequence[str]] = None,
display_query_parameters: Optional[bool] = None,
display_section_table_of_contents: Optional[bool] = None,
event_filter_type: Optional[str] = None,
name: Optional[str] = None,
parameter_details: Optional[Sequence[DashboardParameterDetailArgs]] = None)
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
type: wavefront:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dashboardResource = new Wavefront.Dashboard("dashboardResource", new()
{
Description = "string",
Sections = new[]
{
new Wavefront.Inputs.DashboardSectionArgs
{
Name = "string",
Rows = new[]
{
new Wavefront.Inputs.DashboardSectionRowArgs
{
Charts = new[]
{
new Wavefront.Inputs.DashboardSectionRowChartArgs
{
ChartSetting = new Wavefront.Inputs.DashboardSectionRowChartChartSettingArgs
{
Type = "string",
SparklineDisplayPrefix = "string",
Y1Units = "string",
ExpectedDataSpacing = 0,
FixedLegendDisplayStats = new[]
{
"string",
},
FixedLegendEnabled = false,
FixedLegendFilterField = "string",
FixedLegendFilterLimit = 0,
FixedLegendFilterSort = "string",
FixedLegendHideLabel = false,
FixedLegendPosition = "string",
FixedLegendUseRawStats = false,
GroupBySource = false,
InvertDynamicLegendHoverControl = false,
LineType = "string",
Max = 0,
Min = 0,
NumTags = 0,
PlainMarkdownContent = "string",
ShowHosts = false,
ShowLabels = false,
ShowRawValues = false,
SortValuesDescending = false,
SparklineDecimalPrecision = 0,
SparklineDisplayColor = "string",
SparklineDisplayFontSize = "string",
SparklineDisplayHorizontalPosition = "string",
Y1min = 0,
CustomTags = new[]
{
"string",
},
SparklineValueColorMapColors = new[]
{
"string",
},
SparklineDisplayVerticalPosition = "string",
SparklineFillColor = "string",
SparklineLineColor = "string",
SparklineSize = "string",
SparklineValueColorMapApplyTo = "string",
SparklineDisplayValueType = "string",
SparklineValueColorMapValues = new[]
{
0,
},
SparklineValueColorMapValuesV2s = new[]
{
0,
},
SparklineValueTextMapTexts = new[]
{
"string",
},
SparklineValueTextMapThresholds = new[]
{
0,
},
StackType = "string",
TagMode = "string",
TimeBasedColoring = false,
ColumnTags = "string",
WindowSize = 0,
Windowing = "string",
Xmax = 0,
Xmin = 0,
Y0ScaleSiBy1024 = false,
Y0UnitAutoscaling = false,
Y1ScaleSiBy1024 = false,
Y1UnitAutoscaling = false,
AutoColumnTags = false,
Y1max = 0,
SparklineDisplayPostfix = "string",
Ymax = 0,
Ymin = 0,
},
Name = "string",
Sources = new[]
{
new Wavefront.Inputs.DashboardSectionRowChartSourceArgs
{
Name = "string",
Query = "string",
Disabled = false,
QueryBuilderEnabled = false,
ScatterPlotSource = "string",
SourceDescription = "string",
},
},
Summarization = "string",
Units = "string",
Base = 0,
ChartAttribute = "string",
Description = "string",
NoDefaultEvents = false,
},
},
},
},
},
},
Tags = new[]
{
"string",
},
Url = "string",
CanModifies = new[]
{
"string",
},
CanViews = new[]
{
"string",
},
DisplayQueryParameters = false,
DisplaySectionTableOfContents = false,
EventFilterType = "string",
Name = "string",
ParameterDetails = new[]
{
new Wavefront.Inputs.DashboardParameterDetailArgs
{
DefaultValue = "string",
HideFromView = false,
Label = "string",
Name = "string",
ParameterType = "string",
ValuesToReadableStrings =
{
{ "string", "string" },
},
DynamicFieldType = "string",
QueryValue = "string",
TagKey = "string",
},
},
});
example, err := wavefront.NewDashboard(ctx, "dashboardResource", &wavefront.DashboardArgs{
Description: pulumi.String("string"),
Sections: wavefront.DashboardSectionArray{
&wavefront.DashboardSectionArgs{
Name: pulumi.String("string"),
Rows: wavefront.DashboardSectionRowArray{
&wavefront.DashboardSectionRowArgs{
Charts: wavefront.DashboardSectionRowChartArray{
&wavefront.DashboardSectionRowChartArgs{
ChartSetting: &wavefront.DashboardSectionRowChartChartSettingArgs{
Type: pulumi.String("string"),
SparklineDisplayPrefix: pulumi.String("string"),
Y1Units: pulumi.String("string"),
ExpectedDataSpacing: pulumi.Int(0),
FixedLegendDisplayStats: pulumi.StringArray{
pulumi.String("string"),
},
FixedLegendEnabled: pulumi.Bool(false),
FixedLegendFilterField: pulumi.String("string"),
FixedLegendFilterLimit: pulumi.Int(0),
FixedLegendFilterSort: pulumi.String("string"),
FixedLegendHideLabel: pulumi.Bool(false),
FixedLegendPosition: pulumi.String("string"),
FixedLegendUseRawStats: pulumi.Bool(false),
GroupBySource: pulumi.Bool(false),
InvertDynamicLegendHoverControl: pulumi.Bool(false),
LineType: pulumi.String("string"),
Max: pulumi.Float64(0),
Min: pulumi.Float64(0),
NumTags: pulumi.Int(0),
PlainMarkdownContent: pulumi.String("string"),
ShowHosts: pulumi.Bool(false),
ShowLabels: pulumi.Bool(false),
ShowRawValues: pulumi.Bool(false),
SortValuesDescending: pulumi.Bool(false),
SparklineDecimalPrecision: pulumi.Int(0),
SparklineDisplayColor: pulumi.String("string"),
SparklineDisplayFontSize: pulumi.String("string"),
SparklineDisplayHorizontalPosition: pulumi.String("string"),
Y1min: pulumi.Float64(0),
CustomTags: pulumi.StringArray{
pulumi.String("string"),
},
SparklineValueColorMapColors: pulumi.StringArray{
pulumi.String("string"),
},
SparklineDisplayVerticalPosition: pulumi.String("string"),
SparklineFillColor: pulumi.String("string"),
SparklineLineColor: pulumi.String("string"),
SparklineSize: pulumi.String("string"),
SparklineValueColorMapApplyTo: pulumi.String("string"),
SparklineDisplayValueType: pulumi.String("string"),
SparklineValueColorMapValues: pulumi.IntArray{
pulumi.Int(0),
},
SparklineValueColorMapValuesV2s: pulumi.Float64Array{
pulumi.Float64(0),
},
SparklineValueTextMapTexts: pulumi.StringArray{
pulumi.String("string"),
},
SparklineValueTextMapThresholds: pulumi.Float64Array{
pulumi.Float64(0),
},
StackType: pulumi.String("string"),
TagMode: pulumi.String("string"),
TimeBasedColoring: pulumi.Bool(false),
ColumnTags: pulumi.String("string"),
WindowSize: pulumi.Int(0),
Windowing: pulumi.String("string"),
Xmax: pulumi.Float64(0),
Xmin: pulumi.Float64(0),
Y0ScaleSiBy1024: pulumi.Bool(false),
Y0UnitAutoscaling: pulumi.Bool(false),
Y1ScaleSiBy1024: pulumi.Bool(false),
Y1UnitAutoscaling: pulumi.Bool(false),
AutoColumnTags: pulumi.Bool(false),
Y1max: pulumi.Float64(0),
SparklineDisplayPostfix: pulumi.String("string"),
Ymax: pulumi.Float64(0),
Ymin: pulumi.Float64(0),
},
Name: pulumi.String("string"),
Sources: wavefront.DashboardSectionRowChartSourceArray{
&wavefront.DashboardSectionRowChartSourceArgs{
Name: pulumi.String("string"),
Query: pulumi.String("string"),
Disabled: pulumi.Bool(false),
QueryBuilderEnabled: pulumi.Bool(false),
ScatterPlotSource: pulumi.String("string"),
SourceDescription: pulumi.String("string"),
},
},
Summarization: pulumi.String("string"),
Units: pulumi.String("string"),
Base: pulumi.Int(0),
ChartAttribute: pulumi.String("string"),
Description: pulumi.String("string"),
NoDefaultEvents: pulumi.Bool(false),
},
},
},
},
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Url: pulumi.String("string"),
CanModifies: pulumi.StringArray{
pulumi.String("string"),
},
CanViews: pulumi.StringArray{
pulumi.String("string"),
},
DisplayQueryParameters: pulumi.Bool(false),
DisplaySectionTableOfContents: pulumi.Bool(false),
EventFilterType: pulumi.String("string"),
Name: pulumi.String("string"),
ParameterDetails: wavefront.DashboardParameterDetailArray{
&wavefront.DashboardParameterDetailArgs{
DefaultValue: pulumi.String("string"),
HideFromView: pulumi.Bool(false),
Label: pulumi.String("string"),
Name: pulumi.String("string"),
ParameterType: pulumi.String("string"),
ValuesToReadableStrings: pulumi.StringMap{
"string": pulumi.String("string"),
},
DynamicFieldType: pulumi.String("string"),
QueryValue: pulumi.String("string"),
TagKey: pulumi.String("string"),
},
},
})
var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
.description("string")
.sections(DashboardSectionArgs.builder()
.name("string")
.rows(DashboardSectionRowArgs.builder()
.charts(DashboardSectionRowChartArgs.builder()
.chartSetting(DashboardSectionRowChartChartSettingArgs.builder()
.type("string")
.sparklineDisplayPrefix("string")
.y1Units("string")
.expectedDataSpacing(0)
.fixedLegendDisplayStats("string")
.fixedLegendEnabled(false)
.fixedLegendFilterField("string")
.fixedLegendFilterLimit(0)
.fixedLegendFilterSort("string")
.fixedLegendHideLabel(false)
.fixedLegendPosition("string")
.fixedLegendUseRawStats(false)
.groupBySource(false)
.invertDynamicLegendHoverControl(false)
.lineType("string")
.max(0)
.min(0)
.numTags(0)
.plainMarkdownContent("string")
.showHosts(false)
.showLabels(false)
.showRawValues(false)
.sortValuesDescending(false)
.sparklineDecimalPrecision(0)
.sparklineDisplayColor("string")
.sparklineDisplayFontSize("string")
.sparklineDisplayHorizontalPosition("string")
.y1min(0)
.customTags("string")
.sparklineValueColorMapColors("string")
.sparklineDisplayVerticalPosition("string")
.sparklineFillColor("string")
.sparklineLineColor("string")
.sparklineSize("string")
.sparklineValueColorMapApplyTo("string")
.sparklineDisplayValueType("string")
.sparklineValueColorMapValues(0)
.sparklineValueColorMapValuesV2s(0)
.sparklineValueTextMapTexts("string")
.sparklineValueTextMapThresholds(0)
.stackType("string")
.tagMode("string")
.timeBasedColoring(false)
.columnTags("string")
.windowSize(0)
.windowing("string")
.xmax(0)
.xmin(0)
.y0ScaleSiBy1024(false)
.y0UnitAutoscaling(false)
.y1ScaleSiBy1024(false)
.y1UnitAutoscaling(false)
.autoColumnTags(false)
.y1max(0)
.sparklineDisplayPostfix("string")
.ymax(0)
.ymin(0)
.build())
.name("string")
.sources(DashboardSectionRowChartSourceArgs.builder()
.name("string")
.query("string")
.disabled(false)
.queryBuilderEnabled(false)
.scatterPlotSource("string")
.sourceDescription("string")
.build())
.summarization("string")
.units("string")
.base(0)
.chartAttribute("string")
.description("string")
.noDefaultEvents(false)
.build())
.build())
.build())
.tags("string")
.url("string")
.canModifies("string")
.canViews("string")
.displayQueryParameters(false)
.displaySectionTableOfContents(false)
.eventFilterType("string")
.name("string")
.parameterDetails(DashboardParameterDetailArgs.builder()
.defaultValue("string")
.hideFromView(false)
.label("string")
.name("string")
.parameterType("string")
.valuesToReadableStrings(Map.of("string", "string"))
.dynamicFieldType("string")
.queryValue("string")
.tagKey("string")
.build())
.build());
dashboard_resource = wavefront.Dashboard("dashboardResource",
description="string",
sections=[wavefront.DashboardSectionArgs(
name="string",
rows=[wavefront.DashboardSectionRowArgs(
charts=[wavefront.DashboardSectionRowChartArgs(
chart_setting=wavefront.DashboardSectionRowChartChartSettingArgs(
type="string",
sparkline_display_prefix="string",
y1_units="string",
expected_data_spacing=0,
fixed_legend_display_stats=["string"],
fixed_legend_enabled=False,
fixed_legend_filter_field="string",
fixed_legend_filter_limit=0,
fixed_legend_filter_sort="string",
fixed_legend_hide_label=False,
fixed_legend_position="string",
fixed_legend_use_raw_stats=False,
group_by_source=False,
invert_dynamic_legend_hover_control=False,
line_type="string",
max=0,
min=0,
num_tags=0,
plain_markdown_content="string",
show_hosts=False,
show_labels=False,
show_raw_values=False,
sort_values_descending=False,
sparkline_decimal_precision=0,
sparkline_display_color="string",
sparkline_display_font_size="string",
sparkline_display_horizontal_position="string",
y1min=0,
custom_tags=["string"],
sparkline_value_color_map_colors=["string"],
sparkline_display_vertical_position="string",
sparkline_fill_color="string",
sparkline_line_color="string",
sparkline_size="string",
sparkline_value_color_map_apply_to="string",
sparkline_display_value_type="string",
sparkline_value_color_map_values=[0],
sparkline_value_color_map_values_v2s=[0],
sparkline_value_text_map_texts=["string"],
sparkline_value_text_map_thresholds=[0],
stack_type="string",
tag_mode="string",
time_based_coloring=False,
column_tags="string",
window_size=0,
windowing="string",
xmax=0,
xmin=0,
y0_scale_si_by1024=False,
y0_unit_autoscaling=False,
y1_scale_si_by1024=False,
y1_unit_autoscaling=False,
auto_column_tags=False,
y1max=0,
sparkline_display_postfix="string",
ymax=0,
ymin=0,
),
name="string",
sources=[wavefront.DashboardSectionRowChartSourceArgs(
name="string",
query="string",
disabled=False,
query_builder_enabled=False,
scatter_plot_source="string",
source_description="string",
)],
summarization="string",
units="string",
base=0,
chart_attribute="string",
description="string",
no_default_events=False,
)],
)],
)],
tags=["string"],
url="string",
can_modifies=["string"],
can_views=["string"],
display_query_parameters=False,
display_section_table_of_contents=False,
event_filter_type="string",
name="string",
parameter_details=[wavefront.DashboardParameterDetailArgs(
default_value="string",
hide_from_view=False,
label="string",
name="string",
parameter_type="string",
values_to_readable_strings={
"string": "string",
},
dynamic_field_type="string",
query_value="string",
tag_key="string",
)])
const dashboardResource = new wavefront.Dashboard("dashboardResource", {
description: "string",
sections: [{
name: "string",
rows: [{
charts: [{
chartSetting: {
type: "string",
sparklineDisplayPrefix: "string",
y1Units: "string",
expectedDataSpacing: 0,
fixedLegendDisplayStats: ["string"],
fixedLegendEnabled: false,
fixedLegendFilterField: "string",
fixedLegendFilterLimit: 0,
fixedLegendFilterSort: "string",
fixedLegendHideLabel: false,
fixedLegendPosition: "string",
fixedLegendUseRawStats: false,
groupBySource: false,
invertDynamicLegendHoverControl: false,
lineType: "string",
max: 0,
min: 0,
numTags: 0,
plainMarkdownContent: "string",
showHosts: false,
showLabels: false,
showRawValues: false,
sortValuesDescending: false,
sparklineDecimalPrecision: 0,
sparklineDisplayColor: "string",
sparklineDisplayFontSize: "string",
sparklineDisplayHorizontalPosition: "string",
y1min: 0,
customTags: ["string"],
sparklineValueColorMapColors: ["string"],
sparklineDisplayVerticalPosition: "string",
sparklineFillColor: "string",
sparklineLineColor: "string",
sparklineSize: "string",
sparklineValueColorMapApplyTo: "string",
sparklineDisplayValueType: "string",
sparklineValueColorMapValues: [0],
sparklineValueColorMapValuesV2s: [0],
sparklineValueTextMapTexts: ["string"],
sparklineValueTextMapThresholds: [0],
stackType: "string",
tagMode: "string",
timeBasedColoring: false,
columnTags: "string",
windowSize: 0,
windowing: "string",
xmax: 0,
xmin: 0,
y0ScaleSiBy1024: false,
y0UnitAutoscaling: false,
y1ScaleSiBy1024: false,
y1UnitAutoscaling: false,
autoColumnTags: false,
y1max: 0,
sparklineDisplayPostfix: "string",
ymax: 0,
ymin: 0,
},
name: "string",
sources: [{
name: "string",
query: "string",
disabled: false,
queryBuilderEnabled: false,
scatterPlotSource: "string",
sourceDescription: "string",
}],
summarization: "string",
units: "string",
base: 0,
chartAttribute: "string",
description: "string",
noDefaultEvents: false,
}],
}],
}],
tags: ["string"],
url: "string",
canModifies: ["string"],
canViews: ["string"],
displayQueryParameters: false,
displaySectionTableOfContents: false,
eventFilterType: "string",
name: "string",
parameterDetails: [{
defaultValue: "string",
hideFromView: false,
label: "string",
name: "string",
parameterType: "string",
valuesToReadableStrings: {
string: "string",
},
dynamicFieldType: "string",
queryValue: "string",
tagKey: "string",
}],
});
type: wavefront:Dashboard
properties:
canModifies:
- string
canViews:
- string
description: string
displayQueryParameters: false
displaySectionTableOfContents: false
eventFilterType: string
name: string
parameterDetails:
- defaultValue: string
dynamicFieldType: string
hideFromView: false
label: string
name: string
parameterType: string
queryValue: string
tagKey: string
valuesToReadableStrings:
string: string
sections:
- name: string
rows:
- charts:
- base: 0
chartAttribute: string
chartSetting:
autoColumnTags: false
columnTags: string
customTags:
- string
expectedDataSpacing: 0
fixedLegendDisplayStats:
- string
fixedLegendEnabled: false
fixedLegendFilterField: string
fixedLegendFilterLimit: 0
fixedLegendFilterSort: string
fixedLegendHideLabel: false
fixedLegendPosition: string
fixedLegendUseRawStats: false
groupBySource: false
invertDynamicLegendHoverControl: false
lineType: string
max: 0
min: 0
numTags: 0
plainMarkdownContent: string
showHosts: false
showLabels: false
showRawValues: false
sortValuesDescending: false
sparklineDecimalPrecision: 0
sparklineDisplayColor: string
sparklineDisplayFontSize: string
sparklineDisplayHorizontalPosition: string
sparklineDisplayPostfix: string
sparklineDisplayPrefix: string
sparklineDisplayValueType: string
sparklineDisplayVerticalPosition: string
sparklineFillColor: string
sparklineLineColor: string
sparklineSize: string
sparklineValueColorMapApplyTo: string
sparklineValueColorMapColors:
- string
sparklineValueColorMapValues:
- 0
sparklineValueColorMapValuesV2s:
- 0
sparklineValueTextMapTexts:
- string
sparklineValueTextMapThresholds:
- 0
stackType: string
tagMode: string
timeBasedColoring: false
type: string
windowSize: 0
windowing: string
xmax: 0
xmin: 0
y0ScaleSiBy1024: false
y0UnitAutoscaling: false
y1ScaleSiBy1024: false
y1UnitAutoscaling: false
y1Units: string
y1max: 0
y1min: 0
ymax: 0
ymin: 0
description: string
name: string
noDefaultEvents: false
sources:
- disabled: false
name: string
query: string
queryBuilderEnabled: false
scatterPlotSource: string
sourceDescription: string
summarization: string
units: string
tags:
- string
url: string
Dashboard Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Dashboard resource accepts the following input properties:
- Description string
- Human-readable description of the dashboard.
- Sections
List<Dashboard
Section> - Dashboard chart sections. See dashboard sections.
- List<string>
- A set of tags to assign to this resource.
- Url string
- Unique identifier, also a URL slug of the dashboard.
- Can
Modifies List<string> - A list of users/groups/roles that can modify the dashboard.
- Can
Views List<string> - A list of users/groups/roles that can view the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - Name string
- Name of the dashboard.
- Parameter
Details List<DashboardParameter Detail> - The current JSON representation of dashboard parameters. See parameter details.
- Description string
- Human-readable description of the dashboard.
- Sections
[]Dashboard
Section Args - Dashboard chart sections. See dashboard sections.
- []string
- A set of tags to assign to this resource.
- Url string
- Unique identifier, also a URL slug of the dashboard.
- Can
Modifies []string - A list of users/groups/roles that can modify the dashboard.
- Can
Views []string - A list of users/groups/roles that can view the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - Name string
- Name of the dashboard.
- Parameter
Details []DashboardParameter Detail Args - The current JSON representation of dashboard parameters. See parameter details.
- description String
- Human-readable description of the dashboard.
- sections
List<Dashboard
Section> - Dashboard chart sections. See dashboard sections.
- List<String>
- A set of tags to assign to this resource.
- url String
- Unique identifier, also a URL slug of the dashboard.
- can
Modifies List<String> - A list of users/groups/roles that can modify the dashboard.
- can
Views List<String> - A list of users/groups/roles that can view the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name String
- Name of the dashboard.
- parameter
Details List<DashboardParameter Detail> - The current JSON representation of dashboard parameters. See parameter details.
- description string
- Human-readable description of the dashboard.
- sections
Dashboard
Section[] - Dashboard chart sections. See dashboard sections.
- string[]
- A set of tags to assign to this resource.
- url string
- Unique identifier, also a URL slug of the dashboard.
- can
Modifies string[] - A list of users/groups/roles that can modify the dashboard.
- can
Views string[] - A list of users/groups/roles that can view the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name string
- Name of the dashboard.
- parameter
Details DashboardParameter Detail[] - The current JSON representation of dashboard parameters. See parameter details.
- description str
- Human-readable description of the dashboard.
- sections
Sequence[Dashboard
Section Args] - Dashboard chart sections. See dashboard sections.
- Sequence[str]
- A set of tags to assign to this resource.
- url str
- Unique identifier, also a URL slug of the dashboard.
- can_
modifies Sequence[str] - A list of users/groups/roles that can modify the dashboard.
- can_
views Sequence[str] - A list of users/groups/roles that can view the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name str
- Name of the dashboard.
- parameter_
details Sequence[DashboardParameter Detail Args] - The current JSON representation of dashboard parameters. See parameter details.
- description String
- Human-readable description of the dashboard.
- sections List<Property Map>
- Dashboard chart sections. See dashboard sections.
- List<String>
- A set of tags to assign to this resource.
- url String
- Unique identifier, also a URL slug of the dashboard.
- can
Modifies List<String> - A list of users/groups/roles that can modify the dashboard.
- can
Views List<String> - A list of users/groups/roles that can view the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name String
- Name of the dashboard.
- parameter
Details List<Property Map> - The current JSON representation of dashboard parameters. See parameter details.
Outputs
All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Dashboard Resource
Get an existing Dashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DashboardState, opts?: CustomResourceOptions): Dashboard
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
can_modifies: Optional[Sequence[str]] = None,
can_views: Optional[Sequence[str]] = None,
description: Optional[str] = None,
display_query_parameters: Optional[bool] = None,
display_section_table_of_contents: Optional[bool] = None,
event_filter_type: Optional[str] = None,
name: Optional[str] = None,
parameter_details: Optional[Sequence[DashboardParameterDetailArgs]] = None,
sections: Optional[Sequence[DashboardSectionArgs]] = None,
tags: Optional[Sequence[str]] = None,
url: Optional[str] = None) -> Dashboard
func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Can
Modifies List<string> - A list of users/groups/roles that can modify the dashboard.
- Can
Views List<string> - A list of users/groups/roles that can view the dashboard.
- Description string
- Human-readable description of the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - Name string
- Name of the dashboard.
- Parameter
Details List<DashboardParameter Detail> - The current JSON representation of dashboard parameters. See parameter details.
- Sections
List<Dashboard
Section> - Dashboard chart sections. See dashboard sections.
- List<string>
- A set of tags to assign to this resource.
- Url string
- Unique identifier, also a URL slug of the dashboard.
- Can
Modifies []string - A list of users/groups/roles that can modify the dashboard.
- Can
Views []string - A list of users/groups/roles that can view the dashboard.
- Description string
- Human-readable description of the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - Name string
- Name of the dashboard.
- Parameter
Details []DashboardParameter Detail Args - The current JSON representation of dashboard parameters. See parameter details.
- Sections
[]Dashboard
Section Args - Dashboard chart sections. See dashboard sections.
- []string
- A set of tags to assign to this resource.
- Url string
- Unique identifier, also a URL slug of the dashboard.
- can
Modifies List<String> - A list of users/groups/roles that can modify the dashboard.
- can
Views List<String> - A list of users/groups/roles that can view the dashboard.
- description String
- Human-readable description of the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name String
- Name of the dashboard.
- parameter
Details List<DashboardParameter Detail> - The current JSON representation of dashboard parameters. See parameter details.
- sections
List<Dashboard
Section> - Dashboard chart sections. See dashboard sections.
- List<String>
- A set of tags to assign to this resource.
- url String
- Unique identifier, also a URL slug of the dashboard.
- can
Modifies string[] - A list of users/groups/roles that can modify the dashboard.
- can
Views string[] - A list of users/groups/roles that can view the dashboard.
- description string
- Human-readable description of the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name string
- Name of the dashboard.
- parameter
Details DashboardParameter Detail[] - The current JSON representation of dashboard parameters. See parameter details.
- sections
Dashboard
Section[] - Dashboard chart sections. See dashboard sections.
- string[]
- A set of tags to assign to this resource.
- url string
- Unique identifier, also a URL slug of the dashboard.
- can_
modifies Sequence[str] - A list of users/groups/roles that can modify the dashboard.
- can_
views Sequence[str] - A list of users/groups/roles that can view the dashboard.
- description str
- Human-readable description of the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name str
- Name of the dashboard.
- parameter_
details Sequence[DashboardParameter Detail Args] - The current JSON representation of dashboard parameters. See parameter details.
- sections
Sequence[Dashboard
Section Args] - Dashboard chart sections. See dashboard sections.
- Sequence[str]
- A set of tags to assign to this resource.
- url str
- Unique identifier, also a URL slug of the dashboard.
- can
Modifies List<String> - A list of users/groups/roles that can modify the dashboard.
- can
Views List<String> - A list of users/groups/roles that can view the dashboard.
- description String
- Human-readable description of the dashboard.
- 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.
BYCHART
is default if unspecified. Valid options are:BYCHART
,AUTOMATIC
,ALL
,NONE
,BYDASHBOARD
, andBYCHARTANDDASHBOARD
. - name String
- Name of the dashboard.
- parameter
Details List<Property Map> - The current JSON representation of dashboard parameters. See parameter details.
- sections List<Property Map>
- Dashboard chart sections. See dashboard sections.
- List<String>
- A set of tags to assign to this resource.
- url String
- Unique identifier, also a URL slug of the dashboard.
Supporting Types
DashboardParameterDetail, DashboardParameterDetailArgs
- Default
Value string - The default value of the parameter.
- Hide
From boolView - If
true
the parameter will only be shown on the edit view of the dashboard. - Label string
- The label for the parameter.
- Name string
- The name of the parameters.
- Parameter
Type string - The type of the parameter.
SIMPLE
,LIST
, orDYNAMIC
. - Values
To Dictionary<string, string>Readable Strings - A string->string map. At least one of the keys must match the value of
default_value
. - Dynamic
Field stringType - For
DYNAMIC
parameter types, the type of the field. Valid options areSOURCE
,SOURCE_TAG
,METRIC_NAME
,TAG_KEY
, andMATCHING_SOURCE_TAG
. - Query
Value string - For
DYNAMIC
parameter types, the query to execute to return values. - Tag
Key string - for
TAG_KEY
dynamic field types, the tag key to return.
- Default
Value string - The default value of the parameter.
- Hide
From boolView - If
true
the parameter will only be shown on the edit view of the dashboard. - Label string
- The label for the parameter.
- Name string
- The name of the parameters.
- Parameter
Type string - The type of the parameter.
SIMPLE
,LIST
, orDYNAMIC
. - Values
To map[string]stringReadable Strings - A string->string map. At least one of the keys must match the value of
default_value
. - Dynamic
Field stringType - For
DYNAMIC
parameter types, the type of the field. Valid options areSOURCE
,SOURCE_TAG
,METRIC_NAME
,TAG_KEY
, andMATCHING_SOURCE_TAG
. - Query
Value string - For
DYNAMIC
parameter types, the query to execute to return values. - Tag
Key string - for
TAG_KEY
dynamic field types, the tag key to return.
- default
Value String - The default value of the parameter.
- hide
From BooleanView - If
true
the parameter will only be shown on the edit view of the dashboard. - label String
- The label for the parameter.
- name String
- The name of the parameters.
- parameter
Type String - The type of the parameter.
SIMPLE
,LIST
, orDYNAMIC
. - values
To Map<String,String>Readable Strings - A string->string map. At least one of the keys must match the value of
default_value
. - dynamic
Field StringType - For
DYNAMIC
parameter types, the type of the field. Valid options areSOURCE
,SOURCE_TAG
,METRIC_NAME
,TAG_KEY
, andMATCHING_SOURCE_TAG
. - query
Value String - For
DYNAMIC
parameter types, the query to execute to return values. - tag
Key String - for
TAG_KEY
dynamic field types, the tag key to return.
- default
Value string - The default value of the parameter.
- hide
From booleanView - If
true
the parameter will only be shown on the edit view of the dashboard. - label string
- The label for the parameter.
- name string
- The name of the parameters.
- parameter
Type string - The type of the parameter.
SIMPLE
,LIST
, orDYNAMIC
. - values
To {[key: string]: string}Readable Strings - A string->string map. At least one of the keys must match the value of
default_value
. - dynamic
Field stringType - For
DYNAMIC
parameter types, the type of the field. Valid options areSOURCE
,SOURCE_TAG
,METRIC_NAME
,TAG_KEY
, andMATCHING_SOURCE_TAG
. - query
Value string - For
DYNAMIC
parameter types, the query to execute to return values. - tag
Key string - for
TAG_KEY
dynamic field types, the tag key to return.
- default_
value str - The default value of the parameter.
- hide_
from_ boolview - If
true
the parameter will only be shown on the edit view of the dashboard. - label str
- The label for the parameter.
- name str
- The name of the parameters.
- parameter_
type str - The type of the parameter.
SIMPLE
,LIST
, orDYNAMIC
. - values_
to_ Mapping[str, str]readable_ strings - A string->string map. At least one of the keys must match the value of
default_value
. - dynamic_
field_ strtype - For
DYNAMIC
parameter types, the type of the field. Valid options areSOURCE
,SOURCE_TAG
,METRIC_NAME
,TAG_KEY
, andMATCHING_SOURCE_TAG
. - query_
value str - For
DYNAMIC
parameter types, the query to execute to return values. - tag_
key str - for
TAG_KEY
dynamic field types, the tag key to return.
- default
Value String - The default value of the parameter.
- hide
From BooleanView - If
true
the parameter will only be shown on the edit view of the dashboard. - label String
- The label for the parameter.
- name String
- The name of the parameters.
- parameter
Type String - The type of the parameter.
SIMPLE
,LIST
, orDYNAMIC
. - values
To Map<String>Readable Strings - A string->string map. At least one of the keys must match the value of
default_value
. - dynamic
Field StringType - For
DYNAMIC
parameter types, the type of the field. Valid options areSOURCE
,SOURCE_TAG
,METRIC_NAME
,TAG_KEY
, andMATCHING_SOURCE_TAG
. - query
Value String - For
DYNAMIC
parameter types, the query to execute to return values. - tag
Key String - for
TAG_KEY
dynamic field types, the tag key to return.
DashboardSection, DashboardSectionArgs
- Name string
- Name of this section.
- Rows
List<Dashboard
Section Row> - See dashboard section rows.
- Name string
- Name of this section.
- Rows
[]Dashboard
Section Row - See dashboard section rows.
- name String
- Name of this section.
- rows
List<Dashboard
Section Row> - See dashboard section rows.
- name string
- Name of this section.
- rows
Dashboard
Section Row[] - See dashboard section rows.
- name str
- Name of this section.
- rows
Sequence[Dashboard
Section Row] - See dashboard section rows.
- name String
- Name of this section.
- rows List<Property Map>
- See dashboard section rows.
DashboardSectionRow, DashboardSectionRowArgs
- Charts
List<Dashboard
Section Row Chart> - Charts in this section. See dashboard chart.
- Charts
[]Dashboard
Section Row Chart - Charts in this section. See dashboard chart.
- charts
List<Dashboard
Section Row Chart> - Charts in this section. See dashboard chart.
- charts
Dashboard
Section Row Chart[] - Charts in this section. See dashboard chart.
- charts
Sequence[Dashboard
Section Row Chart] - Charts in this section. See dashboard chart.
- charts List<Property Map>
- Charts in this section. See dashboard chart.
DashboardSectionRowChart, DashboardSectionRowChartArgs
- Chart
Setting DashboardSection Row Chart Chart Setting - Chart settings. See chart settings.
- Name string
- Name of the source.
- Sources
List<Dashboard
Section Row Chart Source> - Query expression to plot on the chart. See chart source queries.
- Summarization string
- Summarization strategy for the chart. MEAN is default. Valid options are,
MEAN
,MEDIAN
,MIN
,MAX
,SUM
,COUNT
,LAST
,FIRST
. - 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
Attribute string - Description string
- Description of the chart.
- No
Default boolEvents - Show events related to the sources included in queries
- Chart
Setting DashboardSection Row Chart Chart Setting - Chart settings. See chart settings.
- Name string
- Name of the source.
- Sources
[]Dashboard
Section Row Chart Source - Query expression to plot on the chart. See chart source queries.
- Summarization string
- Summarization strategy for the chart. MEAN is default. Valid options are,
MEAN
,MEDIAN
,MIN
,MAX
,SUM
,COUNT
,LAST
,FIRST
. - 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
Attribute string - Description string
- Description of the chart.
- No
Default boolEvents - Show events related to the sources included in queries
- chart
Setting DashboardSection Row Chart Chart Setting - Chart settings. See chart settings.
- name String
- Name of the source.
- sources
List<Dashboard
Section Row Chart Source> - Query expression to plot on the chart. See chart source queries.
- summarization String
- Summarization strategy for the chart. MEAN is default. Valid options are,
MEAN
,MEDIAN
,MIN
,MAX
,SUM
,COUNT
,LAST
,FIRST
. - 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
Attribute String - description String
- Description of the chart.
- no
Default BooleanEvents - Show events related to the sources included in queries
- chart
Setting DashboardSection Row Chart Chart Setting - Chart settings. See chart settings.
- name string
- Name of the source.
- sources
Dashboard
Section Row Chart Source[] - Query expression to plot on the chart. See chart source queries.
- summarization string
- Summarization strategy for the chart. MEAN is default. Valid options are,
MEAN
,MEDIAN
,MIN
,MAX
,SUM
,COUNT
,LAST
,FIRST
. - 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
Attribute string - description string
- Description of the chart.
- no
Default booleanEvents - Show events related to the sources included in queries
- chart_
setting DashboardSection Row Chart Chart Setting - Chart settings. See chart settings.
- name str
- Name of the source.
- sources
Sequence[Dashboard
Section Row Chart Source] - Query expression to plot on the chart. See chart source queries.
- summarization str
- Summarization strategy for the chart. MEAN is default. Valid options are,
MEAN
,MEDIAN
,MIN
,MAX
,SUM
,COUNT
,LAST
,FIRST
. - units str
- 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_
attribute str - description str
- Description of the chart.
- no_
default_ boolevents - Show events related to the sources included in queries
- chart
Setting Property Map - Chart settings. See chart settings.
- name String
- Name of the source.
- sources List<Property Map>
- Query expression to plot on the chart. See chart source queries.
- summarization String
- Summarization strategy for the chart. MEAN is default. Valid options are,
MEAN
,MEDIAN
,MIN
,MAX
,SUM
,COUNT
,LAST
,FIRST
. - 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
Attribute String - description String
- Description of the chart.
- no
Default BooleanEvents - Show events related to the sources included in queries
DashboardSectionRowChartChartSetting, DashboardSectionRowChartChartSettingArgs
- Type string
- Chart Type.
line
refers to the Line Plot,scatter
to the Point Plot,stacked-area
to the Stacked Area plot,table
to the Tabular View,scatterplot-xy
to Scatter Plot,markdown-widget
to the Markdown display, andsparkline
to 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
. - 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
custom
tag 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 in line plots. Default is 60.
- Fixed
Legend List<string>Display Stats - For a chart with a fixed legend, a list of statistics to display in the legend.
- Fixed
Legend boolEnabled - Whether to enable a fixed tabular legend adjacent to the chart.
- Fixed
Legend stringFilter Field - 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 - Number of series to include in the fixed legend.
- Fixed
Legend stringFilter Sort - Whether to display
TOP
orBOTTOM
ranked series in a fixed legend. Valid options areTOP
, andBOTTOM
. - Fixed
Legend boolHide Label - This setting is deprecated.
- Fixed
Legend stringPosition - Where the fixed legend should be displayed with respect to the chart.
Valid options are
RIGHT
,TOP
,LEFT
,BOTTOM
. - Fixed
Legend boolUse Raw Stats - 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
false
, each source is displayed in its own row. iftrue
, multiple metrics for the same host are displayed as different columns in the same row. - Invert
Dynamic boolLegend Hover Control - Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- Line
Type string - Plot interpolation type.
linear
is 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
VALUE
orLABEL
. - 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(,,,,)
. - 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
TEXT
orBACKGROUND
. Valid options areTEXT
orBACKGROUND
. - 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 inrgba(,,,,)
. - 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.expand
means normalized from 0 to 1.wiggle
means minimize weighted changes.silhouette
means 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.
- Window
Size int - Width, in minutes, of the time window to use for
last
windowing. - Windowing string
- For the tabular view, whether to use the full time window for the query or the last X minutes.
Valid options are
full
orlast
. - 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 - Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- Y0Unit
Autoscaling bool - Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- Y1Scale
Si boolBy1024 - Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- Y1Unit
Autoscaling bool - 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.
- Y1max double
- For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.
- Y1min double
- For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.
- 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.
- Type string
- Chart Type.
line
refers to the Line Plot,scatter
to the Point Plot,stacked-area
to the Stacked Area plot,table
to the Tabular View,scatterplot-xy
to Scatter Plot,markdown-widget
to the Markdown display, andsparkline
to 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
. - 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
custom
tag 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 in line plots. Default is 60.
- Fixed
Legend []stringDisplay Stats - For a chart with a fixed legend, a list of statistics to display in the legend.
- Fixed
Legend boolEnabled - Whether to enable a fixed tabular legend adjacent to the chart.
- Fixed
Legend stringFilter Field - 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 - Number of series to include in the fixed legend.
- Fixed
Legend stringFilter Sort - Whether to display
TOP
orBOTTOM
ranked series in a fixed legend. Valid options areTOP
, andBOTTOM
. - Fixed
Legend boolHide Label - This setting is deprecated.
- Fixed
Legend stringPosition - Where the fixed legend should be displayed with respect to the chart.
Valid options are
RIGHT
,TOP
,LEFT
,BOTTOM
. - Fixed
Legend boolUse Raw Stats - 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
false
, each source is displayed in its own row. iftrue
, multiple metrics for the same host are displayed as different columns in the same row. - Invert
Dynamic boolLegend Hover Control - Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- Line
Type string - Plot interpolation type.
linear
is 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
VALUE
orLABEL
. - 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(,,,,)
. - 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
TEXT
orBACKGROUND
. Valid options areTEXT
orBACKGROUND
. - 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 inrgba(,,,,)
. - 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.expand
means normalized from 0 to 1.wiggle
means minimize weighted changes.silhouette
means 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.
- Window
Size int - Width, in minutes, of the time window to use for
last
windowing. - Windowing string
- For the tabular view, whether to use the full time window for the query or the last X minutes.
Valid options are
full
orlast
. - 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 - Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- Y0Unit
Autoscaling bool - Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- Y1Scale
Si boolBy1024 - Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- Y1Unit
Autoscaling bool - 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.
- Y1max float64
- For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.
- Y1min float64
- For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.
- 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.
- type String
- Chart Type.
line
refers to the Line Plot,scatter
to the Point Plot,stacked-area
to the Stacked Area plot,table
to the Tabular View,scatterplot-xy
to Scatter Plot,markdown-widget
to the Markdown display, andsparkline
to 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
. - 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
custom
tag 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 in line plots. Default is 60.
- fixed
Legend List<String>Display Stats - For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed
Legend BooleanEnabled - Whether to enable a fixed tabular legend adjacent to the chart.
- fixed
Legend StringFilter Field - 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 - Number of series to include in the fixed legend.
- fixed
Legend StringFilter Sort - Whether to display
TOP
orBOTTOM
ranked series in a fixed legend. Valid options areTOP
, andBOTTOM
. - fixed
Legend BooleanHide Label - This setting is deprecated.
- fixed
Legend StringPosition - Where the fixed legend should be displayed with respect to the chart.
Valid options are
RIGHT
,TOP
,LEFT
,BOTTOM
. - fixed
Legend BooleanUse Raw Stats - 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
false
, each source is displayed in its own row. iftrue
, multiple metrics for the same host are displayed as different columns in the same row. - invert
Dynamic BooleanLegend Hover Control - Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line
Type String - Plot interpolation type.
linear
is 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
VALUE
orLABEL
. - 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(,,,,)
. - 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
TEXT
orBACKGROUND
. Valid options areTEXT
orBACKGROUND
. - 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 inrgba(,,,,)
. - 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.expand
means normalized from 0 to 1.wiggle
means minimize weighted changes.silhouette
means 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.
- window
Size Integer - Width, in minutes, of the time window to use for
last
windowing. - windowing String
- For the tabular view, whether to use the full time window for the query or the last X minutes.
Valid options are
full
orlast
. - 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 - Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y0Unit
Autoscaling Boolean - Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1Scale
Si BooleanBy1024 - Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y1Unit
Autoscaling Boolean - 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.
- y1max Double
- For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.
- y1min Double
- For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.
- 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.
- type string
- Chart Type.
line
refers to the Line Plot,scatter
to the Point Plot,stacked-area
to the Stacked Area plot,table
to the Tabular View,scatterplot-xy
to Scatter Plot,markdown-widget
to the Markdown display, andsparkline
to 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
. - 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
custom
tag 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 in line plots. Default is 60.
- fixed
Legend string[]Display Stats - For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed
Legend booleanEnabled - Whether to enable a fixed tabular legend adjacent to the chart.
- fixed
Legend stringFilter Field - 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 - Number of series to include in the fixed legend.
- fixed
Legend stringFilter Sort - Whether to display
TOP
orBOTTOM
ranked series in a fixed legend. Valid options areTOP
, andBOTTOM
. - fixed
Legend booleanHide Label - This setting is deprecated.
- fixed
Legend stringPosition - Where the fixed legend should be displayed with respect to the chart.
Valid options are
RIGHT
,TOP
,LEFT
,BOTTOM
. - fixed
Legend booleanUse Raw Stats - 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
false
, each source is displayed in its own row. iftrue
, multiple metrics for the same host are displayed as different columns in the same row. - invert
Dynamic booleanLegend Hover Control - Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line
Type string - Plot interpolation type.
linear
is 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
VALUE
orLABEL
. - 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(,,,,)
. - 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
TEXT
orBACKGROUND
. Valid options areTEXT
orBACKGROUND
. - 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 inrgba(,,,,)
. - 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.expand
means normalized from 0 to 1.wiggle
means minimize weighted changes.silhouette
means 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.
- window
Size number - Width, in minutes, of the time window to use for
last
windowing. - windowing string
- For the tabular view, whether to use the full time window for the query or the last X minutes.
Valid options are
full
orlast
. - 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 - Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y0Unit
Autoscaling boolean - Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1Scale
Si booleanBy1024 - Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y1Unit
Autoscaling boolean - 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.
- y1max number
- For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.
- y1min number
- For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.
- 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.
- type str
- Chart Type.
line
refers to the Line Plot,scatter
to the Point Plot,stacked-area
to the Stacked Area plot,table
to the Tabular View,scatterplot-xy
to Scatter Plot,markdown-widget
to the Markdown display, andsparkline
to 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
. - 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
custom
tag 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 in line plots. Default is 60.
- fixed_
legend_ Sequence[str]display_ stats - For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed_
legend_ boolenabled - Whether to enable a fixed tabular legend adjacent to the chart.
- fixed_
legend_ strfilter_ field - 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 - Number of series to include in the fixed legend.
- fixed_
legend_ strfilter_ sort - Whether to display
TOP
orBOTTOM
ranked series in a fixed legend. Valid options areTOP
, andBOTTOM
. - fixed_
legend_ boolhide_ label - This setting is deprecated.
- fixed_
legend_ strposition - Where the fixed legend should be displayed with respect to the chart.
Valid options are
RIGHT
,TOP
,LEFT
,BOTTOM
. - fixed_
legend_ booluse_ raw_ stats - 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
false
, each source is displayed in its own row. iftrue
, multiple metrics for the same host are displayed as different columns in the same row. - invert_
dynamic_ boollegend_ hover_ control - Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line_
type str - Plot interpolation type.
linear
is 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
VALUE
orLABEL
. - 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(,,,,)
. - 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
TEXT
orBACKGROUND
. Valid options areTEXT
orBACKGROUND
. - 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 inrgba(,,,,)
. - 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.expand
means normalized from 0 to 1.wiggle
means minimize weighted changes.silhouette
means 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.
- window_
size int - Width, in minutes, of the time window to use for
last
windowing. - windowing str
- For the tabular view, whether to use the full time window for the query or the last X minutes.
Valid options are
full
orlast
. - 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 - Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y0_
unit_ boolautoscaling - Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1_
scale_ boolsi_ by1024 - Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y1_
unit_ boolautoscaling - 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.
- y1max float
- For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.
- y1min float
- For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.
- 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.
- type String
- Chart Type.
line
refers to the Line Plot,scatter
to the Point Plot,stacked-area
to the Stacked Area plot,table
to the Tabular View,scatterplot-xy
to Scatter Plot,markdown-widget
to the Markdown display, andsparkline
to 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
. - 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
custom
tag 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 in line plots. Default is 60.
- fixed
Legend List<String>Display Stats - For a chart with a fixed legend, a list of statistics to display in the legend.
- fixed
Legend BooleanEnabled - Whether to enable a fixed tabular legend adjacent to the chart.
- fixed
Legend StringFilter Field - 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 - Number of series to include in the fixed legend.
- fixed
Legend StringFilter Sort - Whether to display
TOP
orBOTTOM
ranked series in a fixed legend. Valid options areTOP
, andBOTTOM
. - fixed
Legend BooleanHide Label - This setting is deprecated.
- fixed
Legend StringPosition - Where the fixed legend should be displayed with respect to the chart.
Valid options are
RIGHT
,TOP
,LEFT
,BOTTOM
. - fixed
Legend BooleanUse Raw Stats - 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
false
, each source is displayed in its own row. iftrue
, multiple metrics for the same host are displayed as different columns in the same row. - invert
Dynamic BooleanLegend Hover Control - Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed).
- line
Type String - Plot interpolation type.
linear
is 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
VALUE
orLABEL
. - 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(,,,,)
. - 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
TEXT
orBACKGROUND
. Valid options areTEXT
orBACKGROUND
. - 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 inrgba(,,,,)
. - 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.expand
means normalized from 0 to 1.wiggle
means minimize weighted changes.silhouette
means 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.
- window
Size Number - Width, in minutes, of the time window to use for
last
windowing. - windowing String
- For the tabular view, whether to use the full time window for the query or the last X minutes.
Valid options are
full
orlast
. - 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 - Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y0Unit
Autoscaling Boolean - Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units.
- y1Scale
Si BooleanBy1024 - Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI).
- y1Unit
Autoscaling Boolean - 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.
- y1max Number
- For plots with multiple Y-axes, max value for the right side Y-axis. Set null for auto.
- y1min Number
- For plots with multiple Y-axes, min value for the right side Y-axis. Set null for auto.
- 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.
DashboardSectionRowChartSource, DashboardSectionRowChartSourceArgs
- Name string
- Name of the source.
- Query string
- Query expression to plot on the chart.
- Disabled bool
- Whether the source is disabled.
- Query
Builder boolEnabled - Whether or not this source line should have the query builder enabled.
- Scatter
Plot stringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X
, orY
. - Source
Description string - A description for the purpose of this source.
- Name string
- Name of the source.
- Query string
- Query expression to plot on the chart.
- Disabled bool
- Whether the source is disabled.
- Query
Builder boolEnabled - Whether or not this source line should have the query builder enabled.
- Scatter
Plot stringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X
, orY
. - Source
Description string - A description for the purpose of this source.
- name String
- Name of the source.
- query String
- Query expression to plot on the chart.
- disabled Boolean
- Whether the source is disabled.
- query
Builder BooleanEnabled - Whether or not this source line should have the query builder enabled.
- scatter
Plot StringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X
, orY
. - source
Description String - A description for the purpose of this source.
- name string
- Name of the source.
- query string
- Query expression to plot on the chart.
- disabled boolean
- Whether the source is disabled.
- query
Builder booleanEnabled - Whether or not this source line should have the query builder enabled.
- scatter
Plot stringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X
, orY
. - source
Description string - A description for the purpose of this source.
- name str
- Name of the source.
- query str
- Query expression to plot on the chart.
- disabled bool
- Whether the source is disabled.
- query_
builder_ boolenabled - Whether or not this source line should have the query builder enabled.
- scatter_
plot_ strsource - For scatter plots, does this query source the X-axis or the Y-axis,
X
, orY
. - source_
description str - A description for the purpose of this source.
- name String
- Name of the source.
- query String
- Query expression to plot on the chart.
- disabled Boolean
- Whether the source is disabled.
- query
Builder BooleanEnabled - Whether or not this source line should have the query builder enabled.
- scatter
Plot StringSource - For scatter plots, does this query source the X-axis or the Y-axis,
X
, orY
. - source
Description String - A description for the purpose of this source.
Import
Dashboards can be imported by using the id
, e.g.:
$ pulumi import wavefront:index/dashboard:Dashboard dashboard tftestimport
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Wavefront pulumi/pulumi-wavefront
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
wavefront
Terraform Provider.