182.md 10.3 KB
Newer Older
Lab机器人's avatar
readme  
Lab机器人 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
# Panel types for dashboards

> 原文:[https://docs.gitlab.com/ee/operations/metrics/dashboards/panel_types.html](https://docs.gitlab.com/ee/operations/metrics/dashboards/panel_types.html)

*   [Area or Line Chart](#area-or-line-chart)
*   [Anomaly chart](#anomaly-chart)
*   [Bar chart](#bar-chart)
*   [Column chart](#column-chart)
*   [Stacked column](#stacked-column)
*   [Single Stat](#single-stat)
*   [Percentile based results](#percentile-based-results)
*   [Heatmaps](#heatmaps)

# Panel types for dashboards[](#panel-types-for-dashboards "Permalink")

监视仪表板中支持以下面板类型.

## Area or Line Chart[](#area-or-line-chart "Permalink")

要将面积图面板类型添加到仪表盘,请查看以下样本仪表盘文件:

```
dashboard: 'Dashboard  Title'
panel_groups:
  - group: 'Group  Title'
    panels:
      - type: area-chart # or line-chart
        title: 'Area  Chart  Title'
        y_label: "Y-Axis"
        y_axis:
          format: number
          precision: 0
        metrics:
          - id: area_http_requests_total
            query_range: 'http_requests_total'
            label: "Instance:  {{instance}},  Method:  {{method}}"
            unit: "count" 
```

请注意以下属性:

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| type | string | no | 要渲染的面板类型. 区域面板类型的可选 |
| query_range | string | required | 对于区域面板类型,必须使用[范围查询](https://s0prometheus0io.icopy.site/docs/prometheus/latest/querying/api/) |

[![area panel chart](img/adf6de6d0c4125be4e7a25119c0193e1.png)](../../../user/project/integrations/img/prometheus_dashboard_area_panel_type_v12_8.png)

[版本 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696)开始,y 轴值将根据数据自动缩放. 以前,它总是从 0 开始.

## Anomaly chart[](#anomaly-chart "Permalink")

在 GitLab 12.5 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16530) .

要将异常图表面板类型添加到仪表盘,请添加*恰好具有* 3 个指标的面板.

第一个指标代表当前状态,第二个和第三个指标分别代表上限和下限:

```
dashboard: 'Dashboard  Title'
panel_groups:
  - group: 'Group  Title'
    panels:
      - type: anomaly-chart
        title: "Chart  Title"
        y_label: "Y-Axis"
        metrics:
          - id: anomaly_requests_normal
            query_range: 'http_requests_total'
            label: "#  of  Requests"
            unit: "count"
        metrics:
          - id: anomaly_requests_upper_limit
            query_range: 10000
            label: "Max  #  of  requests"
            unit: "count"
        metrics:
          - id: anomaly_requests_lower_limit
            query_range: 2000
            label: "Min  #  of  requests"
            unit: "count" 
```

请注意以下属性:

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| type | string | required | 异常面板类型必须为`anomaly-chart` |
| query_range | yes | required | 对于异常面板类型,必须在每个指标中使用[范围查询](https://s0prometheus0io.icopy.site/docs/prometheus/latest/querying/api/) . |

[![anomaly panel type](img/8a4af39c416005af074623092e32d782.png)](../../../user/project/integrations/img/prometheus_dashboard_anomaly_panel_type.png)

## Bar chart[](#bar-chart "Permalink")

要将条形图添加到仪表板,请查看以下样本仪表板文件:

```
dashboard: 'Dashboard  Title'
panel_groups:
  - group: 'Group  title'
    panels:
      - type: bar
        title: "Http  Handlers"
        x_label: 'Response  Size'
        y_axis:
          name: "Handlers"
        metrics:
          - id: prometheus_http_response_size_bytes_bucket
            query_range: "sum(increase(prometheus_http_response_size_bytes_bucket[1d]))  by  (handler)"
            unit: 'Bytes' 
```

请注意以下属性:

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | yes | 要渲染的面板类型. 对于条形图类型,设置为`bar` |
| `query_range` | yes | yes | 对于条形图,必须使用[范围查询](https://s0prometheus0io.icopy.site/docs/prometheus/latest/querying/api/) |

[![bar chart panel type](img/c61ac95a0fe55d92ab3c711ea814a8c8.png)](../../../user/project/integrations/img/prometheus_dashboard_bar_chart_panel_type_v12.10.png)

## Column chart[](#column-chart "Permalink")

要将列面板类型添加到仪表板,请查看以下样本仪表板文件:

```
dashboard: 'Dashboard  Title'
panel_groups:
  - group: 'Group  title'
    panels:
      - title: "Column"
        type: "column"
        metrics:
        - id: 1024_memory
          query: 'avg(sum(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"})  by  (job))  without  (job)  /  count(avg(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"})  without  (job))  /1024/1024'
          unit: MB
          label: "Memory  Usage" 
```

请注意以下属性:

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| type | string | yes | 要渲染的面板类型. 对于列面板类型,设置为`column` |
| query_range | yes | yes | 对于列面板类型,必须使用[范围查询](https://s0prometheus0io.icopy.site/docs/prometheus/latest/querying/api/) |

[![anomaly panel type](img/468eb44e935f615292705e2fc013ddb7.png)](../../../user/project/integrations/img/prometheus_dashboard_column_panel_type.png)

## Stacked column[](#stacked-column "Permalink")

在 GitLab 12.8 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/30583) .

要将堆叠的列面板类型添加到仪表板,请查看以下样本仪表板文件:

```
dashboard: 'Dashboard  title'
priority: 1
panel_groups:
  - group: 'Group  Title'
    priority: 5
    panels:
      - type: 'stacked-column'
        title: "Stacked  column"
        y_label: "y  label"
        x_label: 'x  label'
        metrics:
          - id: memory_1
            query_range: 'memory_query'
            label: "memory  query  1"
            unit: "count"
            series_name: 'group  1'
          - id: memory_2
            query_range: 'memory_query_2'
            label: "memory  query  2"
            unit: "count"
            series_name: 'group  2' 
```

[![stacked column panel type](img/62313a9f27e05c60c700ec9625e27d02.png)](../../../user/project/integrations/img/prometheus_dashboard_stacked_column_panel_type_v12_8.png)

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | yes | 要渲染的面板类型. 对于堆叠式柱面板类型,设置为" `stacked-column` |
| `query_range` | yes | yes | 对于堆叠式列面板类型,必须使用[范围查询](https://s0prometheus0io.icopy.site/docs/prometheus/latest/querying/api/) |

## Single Stat[](#single-stat "Permalink")

要将单个状态面板类型添加到仪表板,请查看以下样本仪表板文件:

```
dashboard: 'Dashboard  Title'
panel_groups:
  - group: 'Group  Title'
    panels:
      - title: "Single  Stat"
        type: "single-stat"
        metrics:
          - id: 10
            query: 'max(go_memstats_alloc_bytes{job="prometheus"})'
            unit: MB
            label: "Total" 
```

请注意以下属性:

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| type | string | yes | 要渲染的面板类型. 对于单一统计信息面板类型,设置为`single-stat` |
| field | string | no | 面板显示指标的值. 要使面板显示标签的值,请在该键中放置标签的名称. |
| query | string | yes | For single stat panel types, you must use an [instant query](https://s0prometheus0io.icopy.site/docs/prometheus/latest/querying/api/) |

[![single stat panel type](img/51902d01ed097ad499a4e6eb984d3e86.png)](../../../user/project/integrations/img/prometheus_dashboard_single_stat_panel_type.png)

## Percentile based results[](#percentile-based-results "Permalink")

在 GitLab 12.8 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/201946) .

有时需要将查询结果表示为 100 中的百分比值.您可以在面板定义的根部使用`max_value`属性:

```
dashboard: 'Dashboard  Title'
panel_groups:
  - group: 'Group  Title'
    panels:
      - title: "Single  Stat"
        type: "single-stat"
        max_value: 100
        metrics:
          - id: 10
            query: 'max(go_memstats_alloc_bytes{job="prometheus"})'
            unit: '%'
            label: "Total" 
```

例如,如果查询值为`53.6` ,则将`%`添加为单位将得出`53.6%`的单个统计值,但是如果查询的最大期望值为`120` ,则该值为`44.6%` . 添加`max_value`会导致显示正确的百分比值.

## Heatmaps[](#heatmaps "Permalink")

在 GitLab 12.5 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/30581) .

要将热图面板类型添加到仪表板,请查看以下样本仪表板文件:

```
dashboard: 'Dashboard  Title'
panel_groups:
  - group: 'Group  Title'
    panels:
      - title: "Heatmap"
        type: "heatmap"
        metrics:
          - id: 10
            query: 'sum(rate(nginx_upstream_responses_total{upstream=~"%{kube_namespace}-%{ci_environment_slug}-.*"}[60m]))  by  (status_code)'
            unit: req/sec
            label: "Status  code" 
```

请注意以下属性:

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| type | string | yes | 要渲染的面板类型. 对于热图面板类型,设置为`heatmap` |
| query_range | yes | yes | 对于区域面板类型,必须使用[范围查询](https://s0prometheus0io.icopy.site/docs/prometheus/latest/querying/api/) |

[![heatmap panel type](img/10fd27d874d8e6ace6b74801909782ae.png)](../../../user/project/integrations/img/heatmap_panel_type.png)

**警告:**当查询返回太多数据点时,热图数据桶的尺寸趋于向下至 0,从而使图表的数据不可见,如下图所示. 要解决此问题,请通过更改指标仪表板 UI 上的时间范围过滤器,或将**step**属性添加到仪表板的 YAML 文件中,来限制返回的数据量.

[![heatmap chart_too_much_data](img/c89e56a24555efe89bb446cf31b5f764.png)](../../../user/project/integrations/img/heatmap_chart_too_much_data_v_13_2.png)