如何在 Grafana 镜像中添加仪表板配置 json 文件?

Posted

技术标签:

【中文标题】如何在 Grafana 镜像中添加仪表板配置 json 文件?【英文标题】:How to add dashboard configuration json file in Grafana image? 【发布时间】:2019-07-15 18:11:38 【问题描述】:

我有一个使用配置文件预先配置了 hawkular-datasource 的 grafana docker 映像。

运行 grafana 实例后,我有一个队友给的 json,可以在 grafana 内部导入,该 json 文件在导入时创建仪表板。

如何让仪表板默认显示在 Grafana 实例中?

我尝试将 json 文件复制到 /etc/grafana/provisioning/dashboards/ 文件夹并创建了一个新的 docker 映像。但是当我运行图像时,该实例不包含主页或其中任何位置的仪表板。

如何在 docker 镜像中添加这个 json 文件。我是否遵循正确的方法?

我试过这个http://docs.grafana.org/administration/provisioning/ 但这并没有太大帮助。有什么建议吗?

这是 json 文件。


    "id": null,
    "title": "Openshift Metrics",
    "tags": [],
    "style": "dark",
    "timezone": "browser",
    "editable": true,
    "hideControls": false,
    "sharedCrosshair": false,
    "rows": [
      
        "collapse": false,
        "editable": true,
        "height": "322px",
        "panels": [
          
            "content": "<center><p style='font-size: 40pt'>$app</p></center>",
            "editable": true,
            "error": false,
            "id": 23,
            "isNew": true,
            "links": [],
            "mode": "html",
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "span": 2,
            "style": 
              "font-size": "36pt"
            ,
            "title": "",
            "type": "text"
          ,
          
            "aliasColors": ,
            "bars": false,
            "datasource": "Hawk-DS",
            "editable": true,
            "error": false,
            "fill": 1,
            "grid": 
              "threshold1": null,
              "threshold1Color": "rgba(216, 200, 27, 0.27)",
              "threshold2": null,
              "threshold2Color": "rgba(234, 112, 112, 0.22)"
            ,
            "id": 9,
            "isNew": true,
            "legend": 
              "avg": false,
              "current": false,
              "max": false,
              "min": false,
              "show": true,
              "total": false,
              "values": false
            ,
            "lines": true,
            "linewidth": 2,
            "links": [],
            "nullPointMode": "connected",
            "percentage": false,
            "pointradius": 5,
            "points": false,
            "renderer": "flot",
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "seriesOverrides": [],
            "span": 6,
            "stack": false,
            "steppedLine": false,
            "targets": [
              
                "queryBy": "tags",
                "rate": false,
                "refId": "A",
                "seriesAggFn": "none",
                "tags": [
                  
                    "name": "container_name",
                    "value": "$app"
                  ,
                  
                    "name": "descriptor_name",
                    "value": "memory/usage"
                  
                ],
                "target": "select metric",
                "tagsQL": "container_name IN [$app] AND descriptor_name='memory/usage'",
                "timeAggFn": "avg",
                "type": "gauge"
              
            ],
            "timeFrom": null,
            "timeShift": null,
            "title": "Memory usage",
            "tooltip": 
              "msResolution": true,
              "shared": true,
              "sort": 0,
              "value_type": "cumulative"
            ,
            "type": "graph",
            "xaxis": 
              "show": true
            ,
            "yaxes": [
              
                "format": "bytes",
                "label": null,
                "logBase": 1,
                "max": null,
                "min": 0,
                "show": true
              ,
              
                "format": "short",
                "label": null,
                "logBase": 1,
                "max": null,
                "min": null,
                "show": true
              
            ]
          ,
          
            "cacheTimeout": null,
            "colorBackground": true,
            "colorValue": false,
            "colors": [
              "rgba(50, 172, 45, 0.97)",
              "rgba(237, 129, 40, 0.89)",
              "rgba(245, 54, 54, 0.9)"
            ],
            "datasource": "Hawk-DS",
            "editable": true,
            "error": false,
            "format": "bytes",
            "gauge": 
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            ,
            "height": "100px",
            "id": 12,
            "interval": null,
            "isNew": true,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              
                "name": "value to text",
                "value": 1
              ,
              
                "name": "range to text",
                "value": 2
              
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              
                "from": "null",
                "text": "N/A",
                "to": "null"
              
            ],
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "span": 2,
            "sparkline": 
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            ,
            "targets": [
              
                "queryBy": "tags",
                "rate": false,
                "refId": "A",
                "seriesAggFn": "sum",
                "tags": [
                  
                    "name": "container_name",
                    "value": "$app"
                  ,
                  
                    "name": "descriptor_name",
                    "value": "memory/usage"
                  
                ],
                "target": "select metric",
                "tagsQL": "container_name IN [$app] AND descriptor_name='memory/usage'",
                "timeAggFn": "live",
                "type": "gauge"
              
            ],
            "thresholds": "140000000,180000000",
            "title": "Live, all pods",
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              
                "op": "=",
                "text": "N/A",
                "value": "null"
              
            ],
            "valueName": "avg"
          ,
          
            "cacheTimeout": null,
            "colorBackground": true,
            "colorValue": false,
            "colors": [
              "rgba(50, 172, 45, 0.97)",
              "rgba(237, 129, 40, 0.89)",
              "rgba(245, 54, 54, 0.9)"
            ],
            "datasource": "Hawk-DS",
            "editable": true,
            "error": false,
            "format": "bytes",
            "gauge": 
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            ,
            "height": "100px",
            "id": 15,
            "interval": null,
            "isNew": true,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              
                "name": "value to text",
                "value": 1
              ,
              
                "name": "range to text",
                "value": 2
              
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              
                "from": "null",
                "text": "N/A",
                "to": "null"
              
            ],
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "span": 2,
            "sparkline": 
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            ,
            "targets": [
              
                "queryBy": "tags",
                "rate": false,
                "refId": "A",
                "seriesAggFn": "avg",
                "tags": [
                  
                    "name": "container_name",
                    "value": "$app"
                  ,
                  
                    "name": "descriptor_name",
                    "value": "memory/usage"
                  
                ],
                "target": "select metric",
                "tagsQL": "container_name IN [$app] AND descriptor_name='memory/usage'",
                "timeAggFn": "live",
                "type": "gauge"
              
            ],
            "thresholds": "140000000,180000000",
            "title": "Live per pod",
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              
                "op": "=",
                "text": "N/A",
                "value": "null"
              
            ],
            "valueName": "avg"
          ,
          
            "cacheTimeout": null,
            "colorBackground": true,
            "colorValue": false,
            "colors": [
              "rgba(50, 172, 45, 0.97)",
              "rgba(237, 129, 40, 0.89)",
              "rgba(245, 54, 54, 0.9)"
            ],
            "datasource": "Hawk-DS",
            "editable": true,
            "error": false,
            "format": "bytes",
            "gauge": 
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            ,
            "height": "100px",
            "id": 10,
            "interval": null,
            "isNew": true,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              
                "name": "value to text",
                "value": 1
              ,
              
                "name": "range to text",
                "value": 2
              
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              
                "from": "null",
                "text": "N/A",
                "to": "null"
              
            ],
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "span": 2,
            "sparkline": 
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            ,
            "targets": [
              
                "queryBy": "tags",
                "rate": false,
                "refId": "A",
                "seriesAggFn": "sum",
                "tags": [
                  
                    "name": "container_name",
                    "value": "$app"
                  ,
                  
                    "name": "descriptor_name",
                    "value": "memory/usage"
                  
                ],
                "target": "select metric",
                "tagsQL": "container_name IN [$app] AND descriptor_name='memory/usage'",
                "timeAggFn": "avg",
                "type": "gauge"
              
            ],
            "thresholds": "140000000,180000000",
            "title": "Average, all pods",
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              
                "op": "=",
                "text": "N/A",
                "value": "null"
              
            ],
            "valueName": "avg"
          ,
          
            "cacheTimeout": null,
            "colorBackground": true,
            "colorValue": false,
            "colors": [
              "rgba(50, 172, 45, 0.97)",
              "rgba(237, 129, 40, 0.89)",
              "rgba(245, 54, 54, 0.9)"
            ],
            "datasource": "Hawk-DS",
            "editable": true,
            "error": false,
            "format": "bytes",
            "gauge": 
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            ,
            "height": "100px",
            "id": 13,
            "interval": null,
            "isNew": true,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              
                "name": "value to text",
                "value": 1
              ,
              
                "name": "range to text",
                "value": 2
              
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              
                "from": "null",
                "text": "N/A",
                "to": "null"
              
            ],
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "span": 2,
            "sparkline": 
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            ,
            "targets": [
              
                "queryBy": "tags",
                "rate": false,
                "refId": "A",
                "seriesAggFn": "avg",
                "tags": [
                  
                    "name": "container_name",
                    "value": "$app"
                  ,
                  
                    "name": "descriptor_name",
                    "value": "memory/usage"
                  
                ],
                "target": "select metric",
                "tagsQL": "container_name IN [$app] AND descriptor_name='memory/usage'",
                "timeAggFn": "avg",
                "type": "gauge"
              
            ],
            "thresholds": "140000000,180000000",
            "title": "Average per pod",
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              
                "op": "=",
                "text": "N/A",
                "value": "null"
              
            ],
            "valueName": "avg"
          ,
          
            "cacheTimeout": null,
            "colorBackground": true,
            "colorValue": false,
            "colors": [
              "rgba(50, 172, 45, 0.97)",
              "rgba(237, 129, 40, 0.89)",
              "rgba(245, 54, 54, 0.9)"
            ],
            "datasource": "Hawk-DS",
            "editable": true,
            "error": false,
            "format": "bytes",
            "gauge": 
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            ,
            "height": "100px",
            "id": 11,
            "interval": null,
            "isNew": true,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              
                "name": "value to text",
                "value": 1
              ,
              
                "name": "range to text",
                "value": 2
              
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              
                "from": "null",
                "text": "N/A",
                "to": "null"
              
            ],
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "span": 2,
            "sparkline": 
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            ,
            "targets": [
              
                "queryBy": "tags",
                "rate": false,
                "refId": "A",
                "seriesAggFn": "sum",
                "tags": [
                  
                    "name": "container_name",
                    "value": "$app"
                  ,
                  
                    "name": "descriptor_name",
                    "value": "memory/usage"
                  
                ],
                "target": "select metric",
                "tagsQL": "container_name IN [$app] AND descriptor_name='memory/usage'",
                "timeAggFn": "max",
                "type": "gauge"
              
            ],
            "thresholds": "140000000,180000000",
            "title": "Max, all pods",
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              
                "op": "=",
                "text": "N/A",
                "value": "null"
              
            ],
            "valueName": "avg"
          ,
          
            "cacheTimeout": null,
            "colorBackground": true,
            "colorValue": false,
            "colors": [
              "rgba(50, 172, 45, 0.97)",
              "rgba(237, 129, 40, 0.89)",
              "rgba(245, 54, 54, 0.9)"
            ],
            "datasource": "Hawk-DS",
            "editable": true,
            "error": false,
            "format": "bytes",
            "gauge": 
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            ,
            "height": "100px",
            "id": 14,
            "interval": null,
            "isNew": true,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              
                "name": "value to text",
                "value": 1
              ,
              
                "name": "range to text",
                "value": 2
              
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              
                "from": "null",
                "text": "N/A",
                "to": "null"
              
            ],
            "repeatIteration": 1476706310439,
            "scopedVars": ,
            "span": 2,
            "sparkline": 
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            ,
            "targets": [
              
                "queryBy": "tags",
                "rate": false,
                "refId": "A",
                "seriesAggFn": "avg",
                "tags": [
                  
                    "name": "container_name",
                    "value": "$app"
                  ,
                  
                    "name": "descriptor_name",
                    "value": "memory/usage"
                  
                ],
                "target": "select metric",
                "tagsQL": "container_name IN [$app] AND descriptor_name='memory/usage'",
                "timeAggFn": "max",
                "type": "gauge"
              
            ],
            "thresholds": "140000000,180000000",
            "title": "Max per pod",
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              
                "op": "=",
                "text": "N/A",
                "value": "null"
              
            ],
            "valueName": "avg"
          
        ],
        "repeat": "app",
        "scopedVars": 
          "app": 
            "text": "aloha",
            "value": "aloha",
            "selected": true
          
        ,
        "title": "New row"
      
    ],
    "time": 
      "from": "now-30m",
      "to": "now"
    ,
    "timepicker": 
      "refresh_intervals": [
        "5s",
        "10s",
        "30s",
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "2h",
        "1d"
      ],
      "time_options": [
        "5m",
        "15m",
        "1h",
        "6h",
        "12h",
        "24h",
        "2d",
        "7d",
        "30d"
      ]
    ,
    "templating": 
      "list": [
        
          "current": ,
          "datasource": "Hawk-DS",
          "hide": 0,
          "includeAll": true,
          "label": "Application",
          "multi": true,
          "name": "app",
          "options": [],
          "query": "tags/container_name:*",
          "refresh": 1,
          "regex": "",
          "type": "query"
        
      ]
    ,
    "annotations": 
      "list": []
    ,
    "schemaVersion": 12,
    "version": 32,
    "links": [],
    "gnetId": null

【问题讨论】:

欢迎。请提供任何相关文件(json、Dockerfile、docker-compose.yml 等),以便我们帮助您调试您的场景。 添加了 json 文件。我不确定仪表板是否应该遵循特定的命名约定。请澄清。 你用什么命令行来启动你的 grafana 容器? 我们正在 Openshift 容器平台上部署容器。没有给出任何手动运行的命令。我想它会在内部处理它。 【参考方案1】:

您应该在该文件夹中放置一个指向 JSON 文件的 YAML 文件。比如写/etc/grafana/provisioning/dashboards/local.yml:

apiVersion: 1

providers:
- name: 'default'
  orgId: 1
  folder: ''
  type: file
  disableDeletion: false
  updateIntervalSeconds: 10 #how often Grafana will scan for changed dashboards
  options:
    path: /var/lib/grafana/dashboards

然后将您的 JSON 文件写入/var/lib/grafana/dashboards/openshift.json


在 Grafana 5 之前,我之前的解决方案是将整个 Docker 进程包装在一个脚本中,该脚本使用 API 在 Docker 容器启动后创建仪表板。您可以使用GF_SECURITY_ADMIN_PASSWORD 环境变量来设置密码。您也可以使用GF_AUTH_ANONYMOUS_ENABLED,但您需要确保外部世界无法访问它。

docker run -p 3000:3000 -e GF_AUTH_ANONYMOUS_ENABLED=true grafana/grafana ...
sleep 10  # wait for grafana to load (use a better method of waiting in production)
curl -skfS -XPOST --header "Content-Type: application/json" "http://localhost:3000/grafana/api/dashboards/db" --data-binary @dashboard.json

【讨论】:

但是有没有办法将它们作为 Docker 映像本身的一部分包含在主页上?就像我们在 docker 镜像的配置文件夹中添加数据源文件一样?

以上是关于如何在 Grafana 镜像中添加仪表板配置 json 文件?的主要内容,如果未能解决你的问题,请参考以下文章

如何在 grafana 仪表板中隐藏主机?

关于如何在 Grafana 绘制 Apache Hudi Metrics 仪表盘的教程

如何从代码在 Grafana 中配置 Cloudflare 应用程序?

如何在 Grafana 中构建显示 Jenkins 作业状态的仪表板?

如何在 Grafana 中添加下拉菜单?

无法在 grafana 仪表板中添加 sysdig 插件