Skip to content
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

documenting dashboard data types > done #79

Merged
merged 1 commit into from
Jul 1, 2024
Merged

documenting dashboard data types > done #79

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/commands/yaml_structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Dict
| ----------------------------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------------------------- | ---------- |
| type<br /> | `String`<br /> | Data type<br />Options: [`advancedTable`] | | True |
| advancedTableColumns<br /> | `List` | **Required with ​**​`advancedTable`​**​ Data type**<br />List of metrics, where each metric represent a column on the table | | True |
| custom_key | `String` | custom key for the metric result key, <br />*Example: ​*​`🥕 \{\{pod\}\}` would be translated to `🥕 POD-NAME` <br /> | default labels result (string composed of summed labels .. ex. `sum(metric) by (pod, namespace)` | False |
| custom_key | `String` | custom key for the metric result key, <br /><br /> | default labels result string composed of summed labels .. ex. `sum(metric) by (pod, namespace)` | False |
| executeadvancedTableOptions | `Dict` | Graph options with `advancedTable` data type | | False |


Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/yaml_structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ visualization:
| box<br /> | `Boolean` | The layout box to display the graph in,<br />*Example*: `right` , `right_a` , `left_b` | <br /> | True |
| type | | Graph data type - Options: [`asciiGraph`, `progressBarList`, `simpleTable`, `advancedTable`] | | True |
| metricUnit | `String` | the metirc value unit - Options: [`None`, `byte`, `mb`, `gb`, `tb`, `seconds`, `percentage`] | | |
| custom_key | `String` | custom key for the metric result key, <br />*Example: ​*​`🥕 \{{pod}}\` would be translated to `🥕 POD-NAME` <br /> | Metric default result key | |
| custom_key | `String` | custom key for the metric result key, <br /> <br /> | Metric default result key | |
| asciiGraphOptions | `Dict` | Graph options with `asciiGraph` data type | | False |
| progressBarListOptions | `Dict` | Graph options with `progressBarList` data type | | False |
| simpleTableOptions | `Dict` | Graph options with `simpleTable` data type | | False |
Expand Down