Skip to content

Add parameter for adding a separate row for status panels in status panels lib #1082

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
mshahzeb merged 8 commits into from
Oct 13, 2023
Merged

Add parameter for adding a separate row for status panels in status panels lib #1082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ea265a3
Add row optional flag in status panels lib and utils function
Oct 12, 2023
3249d3e
Fix typos
Oct 12, 2023
596d847
Add missing parameter
Oct 12, 2023
a415cc0
Add parameter to Readme
Oct 12, 2023
416ca25
Add default case for withRow to handle backward compatibility
Oct 13, 2023
4c5847b
Fix withRow true case
Oct 13, 2023
b2f84f4
Fix fmt
Oct 13, 2023
3b51e82
Update README
Oct 13, 2023
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
3 changes: 2 additions & 1 deletion grafana-cloud-integration-utils/util.libsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,8 @@ local integration_version_panel(version, statusPanelDataSource, height, width, x
panelsHeight=config.statusPanelsGridPos[0],
panelsWidth=config.statusPanelsGridPos[1],
rowPositionY=config.statusPanelsGridPos[3],
)).panels.statusPanelsWithRow,
withRow=(if std.objectHas(config, 'statusPanelsWithRow') then config.statusPanelsWithRow else true),
)).panels.statusPanels,
[
panel {
gridPos+: {
Expand Down
14 changes: 11 additions & 3 deletions status-panels-lib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ jb install https://github.com/grafana/jsonnet-libs/status-panels-lib
panelsHeight=2,
panelsWidth=8,
rowPositionY=10,
)).panels.statusPanelsWithRow
withRow=true,
)).panels.statusPanels
```

## Logs
Expand All @@ -51,7 +52,8 @@ jb install https://github.com/grafana/jsonnet-libs/status-panels-lib
panelsHeight=2,
panelsWidth=8,
rowPositionY=10,
)).panels.statusPanelsWithRow
withRow=true,
)).panels.statusPanels
```

## Only panels without row
Expand All @@ -67,6 +69,7 @@ jb install https://github.com/grafana/jsonnet-libs/status-panels-lib
panelsHeight=2,
panelsWidth=8,
rowPositionY=10,
withRow=false,
)).panels.statusPanels
```

Expand Down Expand Up @@ -123,6 +126,10 @@ Position (Default `0`)

Override the datetime unit for panels (Default `dateTimeFromNow`)

### withRow

Whether to add a separate row for the status panels (Default `true`)

## Sample Dashboard

`status-panel-dashboard.libsonnet`
Expand All @@ -149,7 +156,8 @@ local title = 'Status Panel Example';
panelsHeight=2,
panelsWidth=8,
rowPositionY=10,
)).panels.statusPanelsWithRow
withRow=true,
)).panels.statusPanels
)
}
}
Expand Down
3 changes: 3 additions & 0 deletions status-panels-lib/status-panels/main.libsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ local variables = import './variables.libsonnet';
panelsWidth=8,
rowPositionY=0,
dateTimeUnit='dateTimeFromNow',
withRow=true,
): {

local this = self,
Expand All @@ -39,7 +40,9 @@ local variables = import './variables.libsonnet';
panelsWidth,
rowPositionY,
dateTimeUnit,
withRow,
),

},

}
10 changes: 8 additions & 2 deletions status-panels-lib/status-panels/panels.libsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ function(
panelsWidth,
rowPositionY,
dateTimeUnit,
withRow,
)

{
Expand Down Expand Up @@ -95,7 +96,7 @@ function(
latestMetricReceivedLogs:: self.latestMetricReceivedInit(statusPanelsTargetLogs, 'logs'),
integrationVersion:: self.integrationVersionInit(integrationVersion),

statusPanels: utils.join([
statusPanelsWithOutRow: utils.join([
if type == 'metrics' || type == 'both' then
[
self.integrationStatusMetrics,
Expand All @@ -116,6 +117,11 @@ function(
[
self.row,
],
self.statusPanels,
self.statusPanelsWithOutRow,
]),

statusPanels: if withRow then
self.statusPanelsWithRow
else
self.statusPanelsWithOutRow,
}