You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Creates an empty dashboard. You can then add panels by using `add_dashboard_panel`.
90
+
**Arguments**
91
+
-**name**: the name of the dashboard that will be created.
92
+
**Success Return Value**
93
+
A dictionary showing the details of the new dashboard.
94
+
**Example**
95
+
[examples/dashboard.py](examples/dashboard.py).
96
+
97
+
#### `find_dashboard_by(self, name)`
98
+
**Description**
99
+
Finds dashboards with the specified name. You can then delete the dashboard (with `delete_dashboard`) or edit panels (with `add_dashboard_panel` and `remove_dashboard_panel`)
100
+
**Arguments**
101
+
-**name**: the name of the dashboards to find.
102
+
**Success Return Value**
103
+
A list of dictionaries of dashboards matching the specified name.
Adds a panel to the dashboard. A panel can be a time series, or a top chart (i.e. bar chart), or a number panel.
110
+
**Arguments**
111
+
-**dashboard**: dashboard to edit
112
+
-**name**: name of the new panel
113
+
-**type**: type of the new panel. Valid values are: `timeSeries`, `top`, `number`
114
+
-**metrics**: list of metrics; Each metric must specified an `id` (e.g. `cpu.used.percent`) and if it's a value an `aggregation` dictionary with `time` and `group` to specify time aggregation and group aggregation respectively
115
+
-**scope**: filter to apply to the panel; Example: _kubernetes.namespace.name='production' and container.image='nginx'_.
116
+
-**sort_by**: Data sorting; The parameter is optional and it's a dictionary of `metric` and `mode` (it can be `desc` or `asc`)
117
+
-**paging**: Data pagination; The parameter is optional and limits the data points returned. The parameter is a dictionary of `from` and `to` with the index of the first and last point respectively
118
+
-**layout**: Size and position of the panel
119
+
**Success Return Value**
120
+
A dictionary showing the details of the edited dashboard.
0 commit comments