Make refresh configurable from values.yaml (#204)

MatusJenca2 · matofeder · commit 7c51994e6ff9 · 2025-05-29T15:06:21.000+02:00
Update release pipeline (#206) Signed-off-by: Matus Jenca <matus.jenca@dnation.cloud>
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -24,7 +24,7 @@ on:
 
 jobs:
   lint-chart:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Checkout
       uses: actions/checkout@v2
@@ -42,10 +42,10 @@ jobs:
         config: .github/ct.yaml
 
   lint-appVersion:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Check if jsonnet folder changed
       uses: dorny/paths-filter@v2
@@ -62,7 +62,7 @@ jobs:
         echo "::set-output name=app-version::$app"
 
     - name: Checkout main branch
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         ref: main
 
@@ -81,7 +81,7 @@ jobs:
         comparison: notEqual
 
   lint-jsonnet:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     needs:
     - lint-chart
     - lint-appVersion
@@ -102,7 +102,7 @@ jobs:
       run: make json-rules
 
   install-chart:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     needs:
     - lint-chart
     - lint-appVersion
diff --git a/.github/workflows/generate-docs.yaml b/.github/workflows/generate-docs.yaml
@@ -29,10 +29,10 @@ on:
 
 jobs:
   generate-docs-and-page:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Fetch history
       run: git fetch --prune --unshallow
@@ -45,7 +45,7 @@ jobs:
       run: make docs-generate
 
     - name: Deploy docs
-      uses: peaceiris/actions-gh-pages@v3
+      uses: peaceiris/actions-gh-pages@v4
       with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs/site
diff --git a/.github/workflows/release-cicd-jsonnet.yaml b/.github/workflows/release-cicd-jsonnet.yaml
@@ -25,10 +25,10 @@ on:
 
 jobs:
   tag:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Fetch history
       run: git fetch --prune --unshallow
@@ -45,7 +45,7 @@ jobs:
         git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
     - name: Tag branch
-      uses: anothrNick/github-tag-action@1.26.0
+      uses: anothrNick/github-tag-action@1.67.0
       env:
         GITHUB_TOKEN: ${{ secrets.CICD_TOKEN }}
         CUSTOM_TAG: 'cicd-jsonnet-v${{ steps.version.outputs.version }}'
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -26,10 +26,10 @@ on:
 
 jobs:
   release:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Fetch history
       run: git fetch --prune --unshallow
@@ -49,9 +49,9 @@ jobs:
         git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
-        python-version: 3.6
+        python-version: 3.10
 
     - name: Install Chartpress
       run: |
@@ -64,18 +64,18 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.CICD_TOKEN }}
 
     - name: Tag branch
-      uses: anothrNick/github-tag-action@1.39.0
+      uses: anothrNick/github-tag-action@1.67.0
       env:
         GITHUB_TOKEN: ${{ secrets.CICD_TOKEN }}
         CUSTOM_TAG: 'v${{ steps.version.outputs.chart }}'
         RELEASE_BRANCHES: main
 
   generate-changelog:
     needs: release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: dNationCloud/kubernetes-monitoring
           ref: main
diff --git a/chart/Chart.yaml b/chart/Chart.yaml
@@ -15,8 +15,8 @@
 
 apiVersion: v2
 name: dnation-kubernetes-monitoring
-version: 2.7.1
-appVersion: 2.7.1
+version: 2.7.2
+appVersion: 2.7.2
 description: A set of Grafana dashboards and Prometheus alerts to cover Kubernetes monitoring in an easy way using a drill-down principle.
 keywords:
 - dnation
diff --git a/jsonnet/config.libsonnet b/jsonnet/config.libsonnet
@@ -36,6 +36,7 @@
       isLoki: true,
       editable: true,
       tooltip: 'shared_crosshair',
+      // refresh: "" (empty string) to disable refresh
       refresh: '10s',
       time_from: 'now-5m',
       color: {
@@ -57,9 +58,9 @@
         critical: 'red',
         invalid: 'black',  // invalid range is always from minus infinity to 'lowest' thredhold if it is defined
       },
-      dataLinkCommonArgs: 'refresh=%s&var-datasource=$datasource&var-cluster=$cluster&from=$__from&to=$__to' % [self.refresh],
-      dataLinkCommonArgsNoCluster: 'refresh=%s&var-datasource=$datasource&from=$__from&to=$__to' % [self.refresh],
-      dataLinkCommonArgsBlackbox: 'refresh=%s&var-datasource=$datasource&var-target=$target&from=$__from&to=$__to' % [self.refresh],
+      dataLinkCommonArgs: 'var-datasource=$datasource&var-cluster=$cluster&from=$__from&to=$__to',
+      dataLinkCommonArgsNoCluster: 'var-datasource=$datasource&from=$__from&to=$__to',
+      dataLinkCommonArgsBlackbox: 'var-datasource=$datasource&var-target=$target&from=$__from&to=$__to',
       templateRefresh: 'time',  // on time range change
       templateSort: 5,  // case insensitive ascent sort
       ids: {
diff --git a/jsonnet/dashboards/hosts/host-monitoring.libsonnet b/jsonnet/dashboards/hosts/host-monitoring.libsonnet
@@ -59,15 +59,15 @@ local text = grafana.text;
           title='Critical',
           expr='sum(ALERTS{alertname!="Watchdog", severity="critical", alertgroup=~"%s|%s", job=~"%s"}) OR on() vector(0)' % [$._config.prometheusRules.alertGroupHost, $._config.prometheusRules.alertGroupHostApp, std.join('|', alertJobs)],
         )
-        .addDataLink({ title: 'Detail', url: '/d/%s?var-alertmanager=$alertmanager&var-severity=critical&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s' % [$._config.grafanaDashboards.ids.alertHostOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupHost, $._config.prometheusRules.alertGroupHostApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
+        .addDataLink({ title: 'Detail', url: $.addRefreshParam('/d/%s?var-alertmanager=$alertmanager&var-severity=critical&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s') % [$._config.grafanaDashboards.ids.alertHostOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupHost, $._config.prometheusRules.alertGroupHostApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
         .addThresholds($.grafanaThresholds($._config.templates.commonThresholds.criticalPanel)),
 
       local warningPanel =
         alertPanel(
           title='Warning',
           expr='sum(ALERTS{alertname!="Watchdog", severity="warning", alertgroup=~"%s|%s", job=~"%s"}) OR on() vector(0)' % [$._config.prometheusRules.alertGroupHost, $._config.prometheusRules.alertGroupHostApp, std.join('|', alertJobs)],
         )
-        .addDataLink({ title: 'Detail', url: '/d/%s?var-alertmanager=$alertmanager&var-severity=warning&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s' % [$._config.grafanaDashboards.ids.alertHostOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupHost, $._config.prometheusRules.alertGroupHostApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
+        .addDataLink({ title: 'Detail', url: $.addRefreshParam('/d/%s?var-alertmanager=$alertmanager&var-severity=warning&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s') % [$._config.grafanaDashboards.ids.alertHostOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupHost, $._config.prometheusRules.alertGroupHostApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
         .addThresholds($.grafanaThresholds($._config.templates.commonThresholds.warningPanel)),
 
       local hostStatsPanels = [
diff --git a/jsonnet/dashboards/k8s/cpu-namespace-overview.libsonnet b/jsonnet/dashboards/k8s/cpu-namespace-overview.libsonnet
@@ -55,7 +55,7 @@ local graphPanel = grafana.graphPanel;
             { alias: 'CPU Limit', pattern: 'Value #E', type: 'number', decimals: 2 },
             { alias: 'CPU Usage (only defined limit)', pattern: 'Value #F', type: 'number', decimals: 2 },
             { alias: 'CPU Usage (total)', pattern: 'Value #G', type: 'number', decimals: 2 },
-            { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: '/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s' % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },
+            { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: $.addRefreshParam('/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s') % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },
           ]
         )
         .addTargets(
diff --git a/jsonnet/dashboards/k8s/memory-namespace-overview.libsonnet b/jsonnet/dashboards/k8s/memory-namespace-overview.libsonnet
@@ -51,7 +51,7 @@ local graphPanel = grafana.graphPanel;
             { alias: 'Memory Limit', pattern: 'Value #E', type: 'number', unit: 'bytes', decimals: 2 },
             { alias: 'Memory Usage (only defined limit)', pattern: 'Value #F', type: 'number', unit: 'bytes', decimals: 2 },
             { alias: 'Memory Usage (total)', pattern: 'Value #G', type: 'number', unit: 'bytes', decimals: 2 },
-            { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: '/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s' % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },
+            { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: $.addRefreshParam('/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s') % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },
           ]
         )
         .addTargets(
diff --git a/jsonnet/dashboards/k8s/node-overview-dashboards.libsonnet b/jsonnet/dashboards/k8s/node-overview-dashboards.libsonnet
@@ -32,7 +32,7 @@ local polystatPanel = grafana.polystatPanel;
           title=templatePanel.title,
           datasource=templatePanel.datasource,
           description=templatePanel.description,
-          default_click_through=templatePanel.default_click_through,
+          default_click_through=$.addRefreshParam(templatePanel.default_click_through),
           global_unit_format=templatePanel.global_unit_format,
           global_thresholds=templatePanel.global_thresholds,
           hexagon_sort_by_direction=templatePanel.hexagon_sort_by_direction,
diff --git a/jsonnet/dashboards/vms/vm-monitoring.libsonnet b/jsonnet/dashboards/vms/vm-monitoring.libsonnet
@@ -58,15 +58,15 @@ local text = grafana.text;
           title='Critical',
           expr='ALERTS{alertname!="Watchdog", severity="critical", alertgroup=~"%s|%s", job=~"%s"} OR on() vector(0)' % [$._config.prometheusRules.alertGroupClusterVM, $._config.prometheusRules.alertGroupClusterVMApp, std.join('|', alertJobs)],
         )
-        .addDataLink({ title: 'Detail', url: '/d/%s?var-alertmanager=$alertmanager&var-severity=critical&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s' % [$._config.grafanaDashboards.ids.alertVMOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupClusterVM, $._config.prometheusRules.alertGroupClusterVMApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
+        .addDataLink({ title: 'Detail', url: $.addRefreshParam('/d/%s?var-alertmanager=$alertmanager&var-severity=critical&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s') % [$._config.grafanaDashboards.ids.alertVMOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupClusterVM, $._config.prometheusRules.alertGroupClusterVMApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
         .addThresholds($.grafanaThresholds($._config.templates.commonThresholds.criticalPanel)),
 
       local warningPanel =
         alertPanel(
           title='Warning',
           expr='ALERTS{alertname!="Watchdog", severity="warning", alertgroup=~"%s|%s", job=~"%s"} OR on() vector(0)' % [$._config.prometheusRules.alertGroupClusterVM, $._config.prometheusRules.alertGroupClusterVMApp, std.join('|', alertJobs)],
         )
-        .addDataLink({ title: 'Detail', url: '/d/%s?var-alertmanager=$alertmanager&var-severity=warning&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s' % [$._config.grafanaDashboards.ids.alertVMOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupClusterVM, $._config.prometheusRules.alertGroupClusterVMApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
+        .addDataLink({ title: 'Detail', url: $.addRefreshParam('/d/%s?var-alertmanager=$alertmanager&var-severity=warning&var-job=%s&var-alertgroup=%s&var-alertgroup=%s&%s') % [$._config.grafanaDashboards.ids.alertVMOverview, std.join('&var-job=', alertJobs), $._config.prometheusRules.alertGroupClusterVM, $._config.prometheusRules.alertGroupClusterVMApp, $._config.grafanaDashboards.dataLinkCommonArgs] })
         .addThresholds($.grafanaThresholds($._config.templates.commonThresholds.warningPanel)),
 
       local vmStatsPanels = [
@@ -120,17 +120,19 @@ local text = grafana.text;
         .addTarget(prometheus.target(tpl.panel.expr % { job: 'job=~"%s"' % app.jobName }))
         .addMappings(tpl.panel.mappings)
         .addDataLinks(
-          if std.length(tpl.panel.dataLinks) > 0 then
-            [
-              dataLink {
-                url: dataLink.url % { job: app.jobName },
-              }
-              for dataLink in tpl.panel.dataLinks
-            ]
-          else if std.objectHas($._config.grafanaDashboards.ids, tpl.templateName) then
-            [{ title: 'Detail', url: '/d/%s?var-job=%s&%s' % [$._config.grafanaDashboards.ids[tpl.templateName], app.jobName, $._config.grafanaDashboards.dataLinkCommonArgs] }]
-          else
-            []
+          $.updateDataLinksCommonArgs(
+            if std.length(tpl.panel.dataLinks) > 0 then
+              [
+                dataLink {
+                  url: dataLink.url % { job: app.jobName },
+                }
+                for dataLink in tpl.panel.dataLinks
+              ]
+            else if std.objectHas($._config.grafanaDashboards.ids, tpl.templateName) then
+              [{ title: 'Detail', url: '/d/%s?var-job=%s&%s' % [$._config.grafanaDashboards.ids[tpl.templateName], app.jobName, $._config.grafanaDashboards.dataLinkCommonArgs] }]
+            else
+              []
+          )
         )
         .addThresholds($.grafanaThresholds(tpl.panel.thresholds))
         {
diff --git a/jsonnet/util.libsonnet b/jsonnet/util.libsonnet
@@ -434,16 +434,28 @@
     else
       defaultDashboardId,
 
+  addRefreshParam(preprocess_url)::
+    /**
+     *
+     * @param preprocess_url might be with or without refresh parameter.
+     * @return url with added refresh parameter from config if suitable.
+     */
+      local refreh_sep =  if std.length(std.findSubstr('?', preprocess_url)) > 0 then '&' else '?';
+      // remove &refresh= if disabled to be consistent with how "refresh" from a dashboard JSON displays in URL
+      local refresh_param = if std.length(std.findSubstr('refresh=', preprocess_url)) > 0 ||  $._config.grafanaDashboards.refresh == "" then ""
+                            else "%srefresh=%s" % [refreh_sep, $._config.grafanaDashboards.refresh];
+      preprocess_url + refresh_param,
+
   updateDataLinksCommonArgs(datalinks, tableLink=false)::
     /**
      *
      * @param array Datalinks for panel.
      * @param boolean tableLink if processed datalinks are from table or panels.
-     * @return array Datalinks for panel.
+     * @return array Datalinks for panel with refresh parameter.
      */
     local urlField = if tableLink then 'linkUrl' else 'url';
     [
-      local urlFieldValue = if tableLink then datalink.linkUrl else datalink.url;
+      local urlFieldValue = utils.addRefreshParam(if tableLink then datalink.linkUrl else datalink.url);
       if std.objectHas(datalink, urlField) then
         datalink { [urlField]: urlFieldValue }
       else

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ local graphPanel = grafana.graphPanel;`
`55`	`55`	`{ alias: 'CPU Limit', pattern: 'Value #E', type: 'number', decimals: 2 },`
`56`	`56`	`{ alias: 'CPU Usage (only defined limit)', pattern: 'Value #F', type: 'number', decimals: 2 },`
`57`	`57`	`{ alias: 'CPU Usage (total)', pattern: 'Value #G', type: 'number', decimals: 2 },`
`58`		`- { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: '/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s' % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },`
	`58`	`+ { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: $.addRefreshParam('/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s') % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },`
`59`	`59`	`]`
`60`	`60`	`)`
`61`	`61`	`.addTargets(`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ local graphPanel = grafana.graphPanel;`
`51`	`51`	`{ alias: 'Memory Limit', pattern: 'Value #E', type: 'number', unit: 'bytes', decimals: 2 },`
`52`	`52`	`{ alias: 'Memory Usage (only defined limit)', pattern: 'Value #F', type: 'number', unit: 'bytes', decimals: 2 },`
`53`	`53`	`{ alias: 'Memory Usage (total)', pattern: 'Value #G', type: 'number', unit: 'bytes', decimals: 2 },`
`54`		`- { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: '/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s' % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },`
	`54`	`+ { alias: 'Namespace', pattern: 'namespace', link: true, linkTooltip: 'Detail', linkUrl: $.addRefreshParam('/d/%s?var-namespace=$__cell&var-instance=${instance:text}&%s') % [$._config.grafanaDashboards.ids.containerDetail, $._config.grafanaDashboards.dataLinkCommonArgs] },`
`55`	`55`	`]`
`56`	`56`	`)`
`57`	`57`	`.addTargets(`