Skip to content

Commit 7c3af6b

Browse files
Merge pull request #1599 from StackVista/STAC-22604-fix-metric-binding-layout-doc
STAC-22604 Fix documentation for MetricBinding Layouts
2 parents fda3ab4 + 15f65ab commit 7c3af6b

1 file changed

Lines changed: 18 additions & 25 deletions

File tree

use/metrics/k8s-add-charts.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,12 @@ nodes:
4747
alias:
4848
scope:
4949
layout:
50-
weight:
51-
layouts:
52-
- pespective: Metrics
53-
tab:
54-
name:
55-
weight:
56-
section:
57-
name:
58-
weight:
50+
metricPerspective:
51+
tab:
52+
section:
53+
weight:
54+
componentSummary:
55+
weight:
5956
```
6057

6158
The fields in this template are:
@@ -294,21 +291,17 @@ Any MetricsBinding without a specified layout will be displayed in a tab and sec
294291
Here is an example configuration:
295292
```
296293
layout:
297-
weight: 100
298-
layouts:
299-
- perspective: Metrics
300-
tab:
301-
name: AMQP
302-
weight: 150
303-
section:
304-
name: Performance
305-
weight: 300
294+
metricPerspective:
295+
tab: Kubernetes Pod
296+
section: Performance
297+
weight: 2
298+
componentSummary:
299+
weight: 2
306300
```
307-
308301
Fields:
309-
- `layout.weight` - This represents the weight of the chart within sections. The charts are sorted in ascending order by weight, followed by alphabetical order.
310-
- `layout.layouts` - (array) This allows each chart to be added to multiple views (perspectives).
311-
- `layout.layouts.perspective` - This is the type of perspective to display the chart. Currently, only the `Metrics` perspective is supported.
312-
- `Metrics` - display on [Metrics perspective](/use/views/k8s-metrics-perspective.md)
313-
- `layout.layouts.tab` - This indicates the tab `name` and its `weight`. Tabs are sorted ascending by weight (the lowest one from all `MetricBinding`), followed by alphabetical order.
314-
- `layout.layouts.section` - This is the section `name` and its `weight`. Sections are sorted alphabetically.
302+
- `layout.metricPerspective` - Defines metrics to display on `Metrics Perspective`. Metrics are grouped into tabs and then sections.
303+
- `layout.metricPerspective.tab` - Tab name. Tabs are sorted alphabetically.
304+
- `layout.metricPerspective.section` - Section name. Sections are sorted alphabetically.
305+
- `layout.metricPerspective.weight` - Metrics within a section are sorted primarily by weight (ascending) and secondarily by name (alphabetical).
306+
- `layout.componentSummary` - Specifies metrics to display in the `Components details` sidebar upon component selection. Charts appear only when this property is defined.
307+
- `layout.componentSummary.weight` - This represents the weight of the chart. Charts are sorted in ascending order by weight and then displays first 3 charts.

0 commit comments

Comments
 (0)