Skip to content

Commit

Permalink
Add make target to sanitise dashboards and update all dashboards for …
Browse files Browse the repository at this point in the history
…grafana 9
  • Loading branch information
david-martin committed May 16, 2024
1 parent 6564f82 commit 78350af
Show file tree
Hide file tree
Showing 6 changed files with 137 additions and 67 deletions.
4 changes: 2 additions & 2 deletions config/observability/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ Some example alerting rules are available in the [/examples](/examples) folder.

## Exporting a dashboard for use with Grafana Community Platform or other Grafana Instances

Following the steps in [Editing dashboards](#editing-dashboards), we need to make one export where the toggle "Export for sharing manually" is toggled. Once this is saved, run the following from `config/observability` .
Following the steps in [Editing dashboards](#editing-dashboards), export the dashboard json with the toggle "Export for sharing manually" on. Once all dashboard json files sare saved/udpated, run the following make target to sanitise it for use in both the Grafana Community Platform for sharing, and for use as a mounted configmap volume locally.

Check failure on line 52 in config/observability/README.md

View workflow job for this annotation

GitHub Actions / github.com/client9/misspell

[github.com/client9/misspell] config/observability/README.md#L52

"udpated" is a misspelling of "updated"
Raw output
config/observability/README.md:52:183: "udpated" is a misspelling of "updated"

```bash
universal-dashboard.sh <"Export for sharing manually" JSON file> /path/to/<JSON file>
make dashboard-cleanup
```

Now, you have a universal dashboard file you can use to import into your Grafana instance, but also use for uploading to the Grafana Community Platform.
75 changes: 44 additions & 31 deletions examples/dashboards/app_developer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"__elements": [],
"__requires": [
{
"type": "panel",
Expand All @@ -11,7 +10,7 @@
"type": "grafana",
"id": "grafana",
"name": "Grafana",
"version": "8.5.5"
"version": "9.5.3"
},
{
"type": "datasource",
Expand Down Expand Up @@ -72,7 +71,6 @@
"gnetId": 7630,
"graphTooltip": 1,
"id": null,
"iteration": 1715589343999,
"links": [],
"liveNow": false,
"panels": [
Expand Down Expand Up @@ -100,7 +98,7 @@
"kuadrant"
]
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"title": "Kuadrant Dashboards",
"type": "dashlist"
},
Expand All @@ -118,10 +116,15 @@
},
"id": 153,
"options": {
"code": {
"language": "plaintext",
"showLineNumbers": false,
"showMiniMap": false
},
"content": "#### Overview of API/HTTPRoute Metrics\n\nThe row of panels below is repeated for each HTTPRoute resource in your cluster.\nThey provide real-time & historical insights into the performance and health of each API.\nMetrics displayed include request rates, success/error breakdown, and latency percentiles, giving a snapshot of API efficiency and reliability.\nUse this dashboard to monitor traffic patterns, identify potential issues, and ensure optimal performance of your services.\n\n*Important: HTTPRoutes must include a \"service\" and \"deployment\" label with a value that matches the name of the service & deployment being routed to. eg. \"service=myapp, deployment=myapp\"*",
"mode": "markdown"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"title": "App Developer Dashboard",
"type": "text"
},
Expand Down Expand Up @@ -152,7 +155,9 @@
},
"custom": {
"align": "center",
"displayMode": "auto",
"cellOptions": {
"type": "auto"
},
"inspect": false
},
"mappings": [],
Expand All @@ -169,14 +174,16 @@
"overrides": []
},
"gridPos": {
"h": 2,
"h": 3,
"w": 24,
"x": 0,
"y": 8
},
"id": 97,
"options": {
"cellHeight": "sm",
"footer": {
"countRows": false,
"fields": "",
"reducer": [
"sum"
Expand All @@ -185,7 +192,7 @@
},
"showHeader": true
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -346,6 +353,8 @@
"mode": "palette-classic"
},
"custom": {
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"axisSoftMin": 0,
Expand Down Expand Up @@ -439,14 +448,15 @@
"h": 6,
"w": 9,
"x": 0,
"y": 10
"y": 11
},
"id": 99,
"options": {
"legend": {
"calcs": [],
"displayMode": "list",
"placement": "bottom"
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "multi",
Expand Down Expand Up @@ -524,7 +534,7 @@
"h": 2,
"w": 2,
"x": 9,
"y": 10
"y": 11
},
"id": 137,
"options": {
Expand All @@ -541,7 +551,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -592,7 +602,7 @@
"h": 2,
"w": 2,
"x": 11,
"y": 10
"y": 11
},
"id": 149,
"options": {
Expand All @@ -609,7 +619,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -641,6 +651,8 @@
"mode": "palette-classic"
},
"custom": {
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"axisSoftMin": 0,
Expand Down Expand Up @@ -736,14 +748,15 @@
"h": 6,
"w": 9,
"x": 13,
"y": 10
"y": 11
},
"id": 129,
"options": {
"legend": {
"calcs": [],
"displayMode": "list",
"placement": "bottom"
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "multi",
Expand Down Expand Up @@ -820,7 +833,7 @@
"h": 2,
"w": 2,
"x": 22,
"y": 10
"y": 11
},
"id": 139,
"options": {
Expand All @@ -837,7 +850,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -888,7 +901,7 @@
"h": 2,
"w": 2,
"x": 9,
"y": 12
"y": 13
},
"id": 147,
"options": {
Expand All @@ -905,7 +918,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -956,7 +969,7 @@
"h": 2,
"w": 2,
"x": 11,
"y": 12
"y": 13
},
"id": 150,
"options": {
Expand All @@ -973,7 +986,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -1023,7 +1036,7 @@
"h": 2,
"w": 2,
"x": 22,
"y": 12
"y": 13
},
"id": 146,
"options": {
Expand All @@ -1040,7 +1053,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -1091,7 +1104,7 @@
"h": 2,
"w": 2,
"x": 9,
"y": 14
"y": 15
},
"id": 148,
"options": {
Expand All @@ -1108,7 +1121,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -1159,7 +1172,7 @@
"h": 2,
"w": 2,
"x": 11,
"y": 14
"y": 15
},
"id": 151,
"options": {
Expand All @@ -1176,7 +1189,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand Down Expand Up @@ -1226,7 +1239,7 @@
"h": 2,
"w": 2,
"x": 22,
"y": 14
"y": 15
},
"id": 138,
"options": {
Expand All @@ -1243,7 +1256,7 @@
},
"textMode": "auto"
},
"pluginVersion": "8.5.5",
"pluginVersion": "9.5.3",
"targets": [
{
"datasource": {
Expand All @@ -1264,7 +1277,7 @@
}
],
"refresh": "30s",
"schemaVersion": 36,
"schemaVersion": 38,
"style": "dark",
"tags": [
"kuadrant"
Expand Down
Loading

0 comments on commit 78350af

Please sign in to comment.