Skip to content

STAC-22604 Fix documentation for MetricBinding Layouts #1599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LukaszMarchewka merged 1 commit into from
Apr 9, 2025
Merged

STAC-22604 Fix documentation for MetricBinding Layouts #1599

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 18 additions & 25 deletions use/metrics/k8s-add-charts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,12 @@ nodes:
alias:
scope:
layout:
weight:
layouts:
- pespective: Metrics
tab:
name:
weight:
section:
name:
weight:
metricPerspective:
tab:
section:
weight:
componentSummary:
weight:
```

The fields in this template are:
Expand Down Expand Up @@ -294,21 +291,17 @@ Any MetricsBinding without a specified layout will be displayed in a tab and sec
Here is an example configuration:
```
layout:
weight: 100
layouts:
- perspective: Metrics
tab:
name: AMQP
weight: 150
section:
name: Performance
weight: 300
metricPerspective:
tab: Kubernetes Pod
section: Performance
weight: 2
componentSummary:
weight: 2
```

Fields:
- `layout.weight` - This represents the weight of the chart within sections. The charts are sorted in ascending order by weight, followed by alphabetical order.
- `layout.layouts` - (array) This allows each chart to be added to multiple views (perspectives).
- `layout.layouts.perspective` - This is the type of perspective to display the chart. Currently, only the `Metrics` perspective is supported.
- `Metrics` - display on [Metrics perspective](/use/views/k8s-metrics-perspective.md)
- `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.
- `layout.layouts.section` - This is the section `name` and its `weight`. Sections are sorted alphabetically.
- `layout.metricPerspective` - Defines metrics to display on `Metrics Perspective`. Metrics are grouped into tabs and then sections.
- `layout.metricPerspective.tab` - Tab name. Tabs are sorted alphabetically.
- `layout.metricPerspective.section` - Section name. Sections are sorted alphabetically.
- `layout.metricPerspective.weight` - Metrics within a section are sorted primarily by weight (ascending) and secondarily by name (alphabetical).
- `layout.componentSummary` - Specifies metrics to display in the `Components details` sidebar upon component selection. Charts appear only when this property is defined.
- `layout.componentSummary.weight` - This represents the weight of the chart. Charts are sorted in ascending order by weight and then displays first 3 charts.