You need to enable JavaScript to run this app.
导航

通过Grafana插件自定义看板

最近更新时间2024.04.18 16:13:13

首次发布时间2024.04.16 15:39:51

如果您希望集成Grafana,云监控提供了Grafana插件,用于适配开源软件Grafana的数据源。本文介绍如何通过Grafana插件对数据进行自定义Dashboard展示。

注意事项

  • 为避免该功能使用中断,请在使用前,开通云监控按量付费,详情请参见开通按量付费
    目前使用该功能免费,后续会按照使用该插件调用相关API的调用次数按量计费。
  • 云产品通过Grafana插件获取监控数据源需运行在Grafana 7.3或更高的版本上。请提前安装Grafana环境,详情请参见Grafana下载与安装
  • 如果是子账号配置云监控数据源服务,请为子账号授权云监控只读权限CloudMonitorReadOnlyAccess,详情请参见为IAM用户授权

步骤一:安装Grafana插件并配置

在已安装Grafana环境的机器上,安装Grafana插件。

  1. 执行以下命令,下载插件到目录/var/lib/grafana/plugins/

    cd /var/lib/grafana/plugins/
    wget https://lf-cdn-tos.bytescm.com/obj/static/toutiao/paas/cloud-monitor-grafana-plugin/vestack-cloudmonitor-datasource-1.0.0.tar.gz
    
  2. 执行以下命令,将插件解压到目录vestack-cloudmonitor-datasource

    tar -xzvf vestack-cloudmonitor-datasource-1.0.0.tar.gz
    
  3. 配置云监控数据源服务插件。

    1. 执行以下命令,打开目录/usr/share/grafana/conf中的配置文件defaults.ini

      cd /usr/share/grafana/conf
        vi defaults.ini
      
    2. 配置allow_loading_unsigned_plugins为插件的解压目录vestack-cloudmonitor-datasource,允许未签名的云监控数据源服务插件运行。

      allow_loading_unsigned_plugins = vestack-cloudmonitor-datasource
      
    3. 按Esc键,输入:wq,再按Enter键,保存并退出文件defaults.ini

  4. 执行以下命令,重启Grafana服务。

    service grafana-server restart
    

步骤二:配置云监控数据源服务

  1. 登录Grafana。

  2. 在左侧菜单选择Data sources,然后单击右上角Add new data source
    图片

  3. 完成以下配置,然后单击Save & Test
    图片
    配置项说明:

    参数

    说明

    Name

    数据源名称。默认名称为Cloud Monitor

    Access Key ID

    火山引擎主账号或者IAM用户的AccessKey ID。如何获取AK、SK,请参见Access Key(密钥)管理

    Secret Key ID

    火山引擎主账号或者IAM用户的SecretKey ID。如何获取AK、SK,请参见Access Key(密钥)管理

步骤三: 添加监控大盘和监控图表

  1. New dashboard页面,单击Add an empty panel

  2. Query页签,选择数据源Cloud Monitor,并设置目标云服务的监控指标。
    图片
    配置项说明:

    参数

    说明

    是否支持模板变量

    Namespace

    要查询的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace。


    使用模板变量配置的详细步骤,请参见使用Grafana模板变量

    region

    地域列表会根据 Namespace 选项自动获取,单击选择某一地域。


    使用模板变量配置的详细步骤,请参见使用Grafana模板变量

    MetricName

    要查询的监控指标名称。参见云产品监控指标下各产品的MetricName。

    SubNamespace

    要查询的指标所属的维度。SubNamespace在不同Namespace下的可选值不同,参见云产品监控指标下各产品的SubNamespace。

    资源

    要查询的监控产品资源的分类。

    资源名称

    要查询的监控产品资源,会根据所选Namespace、region、和资源自动获取,单击选择某一资源。


    使用模板变量配置的详细步骤,请参见使用Grafana模板变量

    Period

    查询数据的间隔粒度,支持秒(s)、分钟(m)、时(h)、天(d)和周(w)粒度。
    例如查询10分钟内的数据,并根据1分钟进行分割,则会返回10条数据。当时间选段较长时,不建议使用小单位作为间隔,否则将会导致数据集过大。关于传入Period后,StartTime、EndTime偏移的说明,请参见Period说明

    GroupBy

    要查询的指标所使用的分组维度。默认所有Dimension会作为指标分组维度。如果指标存在可选Dimension,使用时需要额外指定GroupBy参数。详情请参见查看云产品监控下各产品的可选Dimensions。
    注意SDK必须升级到以下版本,才支持通过GroupBy筛选分组维度。

    • Python:1.0.37版本以上
    • Go:1.0.97版本以上
    • Java:0.1.75版本以上。

  3. 在右侧设置监控图表的名称、类型、展示样式等。

  4. 单击右上角的Apply,创建监控图表。

  5. 单击右上角的Save,创建监控大盘。

  6. 在Manage页签,单击目标监控大盘,查看监控图表。