Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions content/en/api/v1/dashboards/examples.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"title": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "",
"title_size": "16",
"title_align": "left",
"type": "distribution",
"xaxis": {
"scale": "linear",
"min": "auto",
"max": "auto",
"include_zero": true,
"num_buckets": 55
},
"yaxis": {
"scale": "linear",
"min": "auto",
"max": "auto",
"include_zero": true
},
"markers": [
{
"display_type": "percentile",
"value": "50"
},
{
"display_type": "percentile",
"value": "99"
},
{
"display_type": "percentile",
"value": "90"
}
],
"requests": [
{
"response_format": "scalar",
"queries": [
{
"data_source": "metrics",
"name": "query1",
"query": "avg:system.cpu.user{*} by {service}",
"aggregator": "avg"
}
]
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 4,
"height": 4
}
}
],
"layout_type": "ordered"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"title": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "",
"title_size": "16",
"title_align": "left",
"type": "heatmap",
"xaxis": {
"num_buckets": 75
},
"yaxis": {
"scale": "linear",
"min": "auto",
"max": "auto",
"include_zero": true,
"num_buckets": 55
},
"markers": [
{
"display_type": "percentile",
"value": "50"
},
{
"display_type": "percentile",
"value": "99"
}
],
"requests": [
{
"request_type": "histogram",
"query": {
"data_source": "metrics",
"name": "query1",
"query": "histogram:trace.servlet.request{*}"
}
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 4,
"height": 4
}
}
],
"layout_type": "ordered"
}
90 changes: 85 additions & 5 deletions content/en/api/v1/dashboards/widgets.json

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions content/en/api/v1/notebooks/examples.json

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions data/api/v1/CodeExamples.json
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,11 @@
"suffix": "_803346562",
"description": "Create a new dashboard with distribution widget and apm stats data"
},
{
"group": "dashboards",
"suffix": "_1093147852",
"description": "Create a new dashboard with distribution widget with markers and num_buckets"
},
{
"group": "dashboards",
"suffix": "_2432046716",
Expand Down Expand Up @@ -221,6 +226,11 @@
"suffix": "_1177423752",
"description": "Create a new dashboard with heatmap widget"
},
{
"group": "dashboards",
"suffix": "_2823363212",
"description": "Create a new dashboard with heatmap widget with markers and num_buckets"
},
{
"group": "dashboards",
"suffix": "_1200099236",
Expand Down
91 changes: 88 additions & 3 deletions data/api/v1/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1741,6 +1741,9 @@ components:
type: string
markers:
description: List of markers.
example:
- display_type: percentile
value: '90'
items:
$ref: '#/components/schemas/WidgetMarker'
type: array
Expand Down Expand Up @@ -1816,6 +1819,11 @@ components:
$ref: '#/components/schemas/ApmStatsQueryDefinition'
event_query:
$ref: '#/components/schemas/LogQueryDefinition'
formulas:
description: List of formulas that operate on queries.
items:
$ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: '#/components/schemas/LogQueryDefinition'
network_query:
Expand All @@ -1827,10 +1835,17 @@ components:
q:
description: Widget query.
type: string
queries:
description: List of queries that can be returned directly or used in formulas.
items:
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
query:
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
request_type:
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
response_format:
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: '#/components/schemas/LogQueryDefinition'
security_query:
Expand All @@ -1854,6 +1869,12 @@ components:
description: Specifies minimum value to show on the x-axis. It takes a number,
percentile (p90 === 90th percentile), or auto for default behavior.
type: string
num_buckets:
description: Number of value buckets to target, aka the resolution of the
value bins.
example: 100
format: int64
type: integer
scale:
default: linear
description: Specifies the scale type. Possible values are `linear`.
Expand Down Expand Up @@ -3821,6 +3842,14 @@ components:
type: array
legend_size:
$ref: '#/components/schemas/WidgetLegendSize'
markers:
description: List of markers.
example:
- display_type: percentile
value: '90'
items:
$ref: '#/components/schemas/WidgetMarker'
type: array
requests:
description: List of widget types.
example:
Expand All @@ -3845,8 +3874,10 @@ components:
type: string
type:
$ref: '#/components/schemas/HeatMapWidgetDefinitionType'
xaxis:
$ref: '#/components/schemas/HeatMapWidgetXAxis'
yaxis:
$ref: '#/components/schemas/WidgetAxis'
$ref: '#/components/schemas/HeatMapWidgetDefinitionYaxis'
required:
- type
- requests
Expand All @@ -3860,6 +3891,10 @@ components:
type: string
x-enum-varnames:
- HEATMAP
HeatMapWidgetDefinitionYaxis:
oneOf:
- $ref: '#/components/schemas/WidgetAxis'
- $ref: '#/components/schemas/HeatMapWidgetYAxis'
HeatMapWidgetRequest:
description: Updated heat map widget.
properties:
Expand Down Expand Up @@ -3888,6 +3923,10 @@ components:
items:
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
query:
$ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
request_type:
$ref: '#/components/schemas/DistributionWidgetHistogramRequestType'
response_format:
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
Expand All @@ -3897,6 +3936,49 @@ components:
style:
$ref: '#/components/schemas/WidgetStyle'
type: object
HeatMapWidgetXAxis:
description: X Axis controls for the heat map widget.
properties:
num_buckets:
description: Number of time buckets to target, aka the resolution of the
time bins. This is only applicable for distribution of points (group distributions
use the roll-up modifier).
example: 50
format: int64
type: integer
type: object
HeatMapWidgetYAxis:
description: Y Axis controls for the heat map widget.
properties:
include_zero:
description: Set to `true` to include zero.
type: boolean
label:
description: The label of the axis to display on the graph. Only usable
on Scatterplot Widgets.
type: string
max:
default: auto
description: Specifies maximum numeric value to show on the axis. Defaults
to `auto`.
type: string
min:
default: auto
description: Specifies minimum numeric value to show on the axis. Defaults
to `auto`.
type: string
num_buckets:
description: Number of value buckets to target, aka the resolution of the
value bins.
example: 50
format: int64
type: integer
scale:
default: linear
description: Specifies the scale type. Possible values are `linear`, `log`,
`sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
type: string
type: object
Host:
description: Object representing a host.
properties:
Expand Down Expand Up @@ -25383,7 +25465,7 @@ components:
display_type:
description: "Combination of:\n - A severity error, warning, ok, or info\n
\ - A line type: dashed, solid, or bold\nIn this case of a Distribution
widget, this can be set to be `x_axis_percentile`."
widget, this can be set to be `percentile`."
example: error dashed
type: string
label:
Expand All @@ -25394,8 +25476,11 @@ components:
description: Timestamp for the widget.
type: string
value:
description: Value to apply. Can be a single value y = 15 or a range of
description: 'Value to apply. Can be a single value y = 15 or a range of
values 0 < y < 10.

For Distribution widgets with `display_type` set to `percentile`, this
should be a numeric percentile value (e.g., "90" for P90).'
example: y = 15
type: string
required:
Expand Down
Loading