Added new gateway_lived_event_* metrics #199
Conversation
qboileau
left a comment
qboileau
left a comment
There was a problem hiding this comment.
Thank you for your contribution to GW Grafana dashboard.
Unfortunately, I couldn't test it because your changes broke the dashboard.
For dashboard to be imported by helm chart and work, you need to be careful of some aspects :
- keeping
__inputsthat are used when someone want to import manually the dashboard into their grafana, Inputs are used to ask for prometheus datasource name and gateway job label to target, they are also used with grafana operator to load and configure dashboard using valuesmetrics.grafana.datasources.prometheus. - Also keep template variable Datasource that is use by reference
${datasource}everywhere (variable/panel). - Use
${datasource}for prometheus datasource reference in your panels
We should add a documentation for Grafana dashboard contribution guidelines.
Usually what I do is adding a new panel in grafana then copy it's json format and place in into global dashboard json in panel sections, then replace datasource id with the variable and test a re-import via the chart.
It's tedious but I didn't find a better way to do it yet...
| "__inputs": [ | ||
| { | ||
| "name": "INPUT_DS_PROMETHEUS", | ||
| "label": "prometheus", | ||
| "description": "", | ||
| "type": "datasource", | ||
| "pluginId": "prometheus", | ||
| "pluginName": "Prometheus", | ||
| "value": "prometheus" | ||
| }, | ||
| { | ||
| "name": "INPUT_GATEWAY_JOB_NAME", | ||
| "label": "Gateway job name (app.kubernetes.io/instance by default)", | ||
| "description": "The name of the gateway to monitor", | ||
| "type": "constant", | ||
| "value": "conduktor-gateway" | ||
| } | ||
| ], | ||
| "__elements": {}, | ||
| "__requires": [ | ||
| { | ||
| "type": "panel", | ||
| "id": "bargauge", | ||
| "name": "Bar gauge", | ||
| "version": "" | ||
| }, | ||
| { | ||
| "type": "panel", | ||
| "id": "gauge", | ||
| "name": "Gauge", | ||
| "version": "" | ||
| }, | ||
| { | ||
| "type": "grafana", | ||
| "id": "grafana", | ||
| "name": "Grafana", | ||
| "version": "9.3.2" | ||
| }, |
There was a problem hiding this comment.
Restore __inputs and __requires
| "title": "Conduktor Gateway", | ||
| "version": 2, | ||
| "title": "Conduktor Gateway [conduktor/conduktor-gateway]", | ||
| "uid": "1a62a8e3-ffbc-48bf-9ac1-246fe17ca9c0", | ||
| "version": 7, |
There was a problem hiding this comment.
Restore default title, remove useless uid and update version from 2 to 3
| "version": "" | ||
| "datasource": { | ||
| "type": "prometheus", | ||
| "uid": "60299b50-80b2-44df-9318-0782f84417e2" |
There was a problem hiding this comment.
Use ${datasource} variable instead of a uid (one of many datasource reference replaced in this PR)
| "uid": "${datasource}" | ||
| "uid": "prometheus" |
There was a problem hiding this comment.
Restore ${datasource} variable (on all existing panel too)
| "JVM", | ||
| "Pod" | ||
| ], | ||
| "templating": { |
There was a problem hiding this comment.
Restore all variables previous state
- restore datasource variable
- restore queries
- restore datasource reference uid to use datasource variable
${datasource}instead - restore current selection to the default one
- remove options from job variable
Added new gateway_lived_event_* metrics