如何在 Jsonnet 中为 Grafana 仪表板模板填充变量

时间:2021-06-14 20:02:45

标签: grafana grafana-templating jsonnet

我想使用单个模板通过 jsonnet/grafonnet 部署和管理许多类似的 Grafana 仪表板,其中在每个仪表板实例中替换变量。

到目前为止,我的(不起作用)方法的一个简化示例如下所示:

# main.jsonnet
(import 'template.json') {
  _config+:: {
    name: 'thing1',
  },
  metric:: {
    name: 'metric1',
  },
} +

(import 'template.json') {
  _config+:: {
    name: 'thing2',
  },
  metric:: {
    name: 'metric2',
  },
}
#template.json
local grafana = import 'github.com/grafana/grafonnet-lib/grafonnet/grafana.libsonnet';
local prometheus = grafana.prometheus;
local dashboard = grafana.dashboard;
local graphPanel = grafana.graphPanel;

{
  grafanaDashboards+:: {
    local fileName = $._config.name + '.json',
    fileName:
      dashboard.new(
        '%(name)s Dashboard' % $._config.name,
      ).addPanel(
        grafana.text.new(
          title='%(name)s dashboard' % $.metric.name,
          content='Dashboard for metric ' + $.metric.name,
        ),
      )
  },
}

然而,当渲染时,它只输出一个值为“thing2”“metric2”的仪表板。

这种模板的正确方法是什么?我正在寻找像这样输出多个仪表板...

dashboard1 - "thing1" "metric1"

dashboard2 - "thing2" metric2"

1 个答案:

答案 0 :(得分:1)

问题在于,在 main.jsonnet 中,您将 (+) metric2 合并到 metric1 内容之上,完全覆盖了它。

您需要为其中的每一个创建一个显式字段(数组也可以,但稍后在 jsonnet 中处理它更麻烦),然后您可以利用 jsonnet -m <dir> 为每个创建一个文件字段。

综合起来:

main.jsonnet

// main.jsonnet
{
  'dash1.json': (import 'template.jsonnet') {
    _config+:: {
      name: 'thing1',
    },
    metric:: {
      name: 'metric1',
    },
  }.grafanaDashboards,

  'dash2.json': (import 'template.jsonnet') {
    _config+:: {
      name: 'thing2',
    },
    metric:: {
      name: 'metric2',
    },
  }.grafanaDashboards,
}

template.jsonnet

差异:将所需的 gridPos 添加到该函数调用

//template.json
local grafana = import 'github.com/grafana/grafonnet-lib/grafonnet/grafana.libsonnet';
local prometheus = grafana.prometheus;
local dashboard = grafana.dashboard;
local graphPanel = grafana.graphPanel;

{
  grafanaDashboards+:: {
    local fileName = $._config.name + '.json',
    fileName:
      dashboard.new(
        '%(name)s Dashboard' % $._config.name,
      ).addPanel(
        grafana.text.new(
          title='%(name)s dashboard' % $.metric.name,
          content='Dashboard for metric ' + $.metric.name,
        ),
        gridPos=0  // required parameter, put 0 but dunno if ok
      ),
  },
}

命令行界面

使用 jsonnet-bundler 供应商导入的依赖项

# Download deps to vendor/
$ jb init
$ jb install https://github.com/grafana/grafonnet-lib
GET https://github.com/grafana/grafonnet-lib/archive/3082bfca110166cd69533fa3c0875fdb1b68c329.tar.gz 200

# Create dash{1,2}.json output from main.jsonnet fields
$ jsonnet -J vendor -m . main.jsonnet
./dash1.json
./dash2.json