/tencentcloud-monitor-grafana-app

Tencent Cloud Monitor App Plugin for Grafana

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Tencent Cloud Monitor Grafana App

Marketplace Downloads License Change Log GitHub code size in bytes PRs Welcome

腾讯云监控插件 @ Grafana

简体中文 | English

注意:该插件从 2.0.0 版本起的最低运行要求为 Grafana 7.0 或更高的版本上。请优先安装 Grafana 环境,详情参考 Grafana 安装文档

目录

简介

腾讯云监控 为用户提供云服务器、云数据库等多个云产品的负载和性能监控指标,用户可以使用云监控控制台、云监控 API 等方式获取相关监控数据。腾讯云监控应用插件 Tencent Cloud Monitor App,是一款适配开源软件 Grafana 的应用插件,通过调用 腾讯云监控 API 3.0 的方式获取监控数据,并对数据进行自定义 Dashboard 展示。

该插件提供了云服务器、云数据库 MySQL、负载均衡 等具有代表性的 Dashboard 预设模板

支持的云产品监控及文档如下表所示,更多云产品的监控指标数据源在陆续完善中。

产品名称 命名空间 指标文档 实例列表接口文档
CVM 云服务器 QCE/CVM https://cloud.tencent.com/document/api/248/6843 https://cloud.tencent.com/document/api/213/15728
CDB 云数据库 MySQL QCE/CDB https://cloud.tencent.com/document/api/248/45147 https://cloud.tencent.com/document/api/236/15872
云数据库 PostgreSql QCE/POSTGRES https://cloud.tencent.com/document/product/248/45105 https://cloud.tencent.com/document/api/409/16773
云数据库 MongoDB QCE/CMONGO https://cloud.tencent.com/document/product/248/45104 https://cloud.tencent.com/document/api/240/38568
云数据库 Redis QCE/REDIS_MEM https://cloud.tencent.com/document/product/248/49729 https://cloud.tencent.com/document/api/239/20018
云数据库 TDSQL-C (原CynosDB) QCE/CYNOSDB_MYSQL https://cloud.tencent.com/document/product/248/45106 https://cloud.tencent.com/product/cynosdb
云数据库 TcaplusDB QCE/TCAPLUS https://cloud.tencent.com/document/product/248/45107 https://cloud.tencent.com/document/api/1003/48334
云数据库 SQL Server QCE/SQLSERVER https://cloud.tencent.com/document/product/248/45146 https://cloud.tencent.com/document/api/238/19969
CDN 内容分发式网络 QCE/CDN https://cloud.tencent.com/document/product/248/50386 https://cloud.tencent.com/document/api/228/41118
CDN 省份域名 QCE/CDN_LOG_DATA https://cloud.tencent.com/document/product/248/50388 https://cloud.tencent.com/document/api/228/41118
BWP 带宽包 QCE/BWP https://cloud.tencent.com/document/product/248/45098 https://cloud.tencent.com/document/api/215/19209
CKafka 消息队列 QCE/CKAFKA https://cloud.tencent.com/document/product/248/45121 https://cloud.tencent.com/document/api/597/40835
CLB 公网负载均衡 QCE/LB_PUBLIC https://cloud.tencent.com/document/product/248/51898 https://cloud.tencent.com/document/api/214/30685
CLB 内网负载均衡四层协议 QCE/LB_PRIVATE https://cloud.tencent.com/document/product/248/51899 https://cloud.tencent.com/document/api/214/30685
CLB 负载均衡七层协议 QCE/LOADBALANCE https://cloud.tencent.com/document/product/248/51901 https://cloud.tencent.com/document/api/214/30685
LB 弹性公网IP QCE/LB https://cloud.tencent.com/document/product/248/45099 https://cloud.tencent.com/document/api/215/16702
CFS 文件存储 QCE/CFS https://cloud.tencent.com/document/product/248/45143 https://cloud.tencent.com/document/api/582/38170
SCF 云函数 QCE/SCF_V2 https://cloud.tencent.com/document/product/248/45130 https://cloud.tencent.com/document/api/583/18582
专线接入 专用通道 QCE/DCX https://cloud.tencent.com/document/product/248/45101 https://cloud.tencent.com/document/api/216/19819
专线接入 物理专线 QCE/DC https://cloud.tencent.com/document/product/248/45102 https://cloud.tencent.com/document/api/216/34826
私有网络 VPN 网关 QCE/VPNGW https://cloud.tencent.com/document/product/248/45070 https://cloud.tencent.com/document/api/215/17514
私有网络 专线网关 QCE/DCG https://cloud.tencent.com/document/product/248/45072 https://cloud.tencent.com/document/api/215/30644
私有网络 NAT 网关 QCE/NAT_GATEWAY https://cloud.tencent.com/document/product/248/45069 https://cloud.tencent.com/document/api/215/36034
私有网络 对等连接 QCE/PCX https://cloud.tencent.com/document/product/248/45096 https://cloud.tencent.com/document/product/215/2101
API 网关 QCE/APIGATEWAY https://cloud.tencent.com/document/product/248/45127 https://cloud.tencent.com/document/api/628/45198
CBS 云硬盘 QCE/BLOCK_STORAGE https://cloud.tencent.com/document/product/248/45411 https://cloud.tencent.com/document/api/362/16315
Elasticsearch QCE/CES https://cloud.tencent.com/document/product/248/45129 https://cloud.tencent.com/document/api/845/30631
CMQ 消息队列服务 QCE/CMQ https://cloud.tencent.com/document/product/248/45114 https://cloud.tencent.com/document/api/406/42624
CMQ 消息队列主题订阅 QCE/CMQTOPIC https://cloud.tencent.com/document/product/248/45113 https://cloud.tencent.com/document/api/406/42637

入门指南

安装与更新

前置条件:腾讯云监控应用插件是运行在 Grafana 7.0 或更高的版本上。请优先安装 Grafana 环境,详情参考 Grafana 安装文档

使用 Grafana CLI 安装:

$ grafana-cli plugins install tencentcloud-monitor-app

或者阅读更多安装与更新方式

启用插件

鼠标悬浮左侧导航栏的 齿轮 图标,点击 Plugins 选项,进入 Plugins 管理页面,如果插件列表中正常展示 Tencent Cloud Monitor APP 插件,表示插件安装成功;

Plugin Search

进入应用详情页面,点击 Enable 按钮,启用成功后,即可在 Grafana 中使用腾讯云监控应用插件。

Plugin Enable

配置数据源

腾讯云监控应用插件通过调用 云监控 API 的方式获取各云产品的监控指标数据,通过以下步骤,配置相应云产品的数据源。

  1. 鼠标悬浮左侧导航栏的 齿轮 图标,单击 【Data Sources】选项,进入数据源管理页面; Datasource Add
  2. 点击右上角的 Add data source 按钮,然后单击【Tencent Cloud Monitoring】数据源,进入数据源配置页面; Datasource Choose
  3. Name 数据源名称,可以是任意名称,默认为 Tencent Cloud Monitoring
  4. SecretIdSecretKey 是调用云监控 API 必需的安全证书信息,二者可以通过腾讯云控制台 云 API 密钥页面 获取;
  5. 选择需要获取监控数据的云产品;
  6. 单击【Save & Test】按钮,测试数据源的配置信息是否正确,配置成功后,即可以在 Dashboard 中使用该数据源。 Datasource Config

创建 Dashboard

支持快捷创建、管理页面和导入模板三种方式创建 Dashboard。

快捷创建

鼠标悬浮左侧导航栏的 加号 图标,单击【Dashboard】选项,即可创建一个新的 Dashboard。

管理页面

鼠标悬浮左侧导航栏的 田字格 图标,单击【Manage】选项,进入 Dashboard 管理页面,单击【New Dashboard】按钮,即可创建一个新的 Dashboard。同时,在该页面可以对 Dashboard 进行各种管理操作,如新建文件夹、移动 Dashboard、导入 Dashboard 等。

导入模板

鼠标悬浮左侧导航栏的 齿轮 图标,单击【Plugins】选项,进入 Plugins 管理页面。然后,单击【Tencent Cloud Monitor】应用,进入应用详情页面,切换至 Dashboards 选项卡,选择 Dashbboard 模板导入。

Import Plugin Dashboard

配置 Panel 数据

CVM Panel Query

创建 Dashboard 之后,通过配置 Panel 信息,即可获取腾讯云监控的相应监控数据。现在以简单的 Graph 为例,展示如何配置 Panel 信息。

  1. 点击 New Panel 面板的 Add Query 选项,进入 Panel 配置页面。在左侧第一个 Query 选项卡,选择 上面配置的腾讯云监控数据源。
  2. Namespace 命名空间,例如云服务器监控的命名空间为 QCE/CVM
  3. Region 地域,地域列表会根据 Namespace 选项自动获取,单击选择某一地域。
  4. MetricName 指标名称,指标列表会根据 NamespaceRegion 选项自动获取,单击选择某一指标。点击查看各个云产品的指标文档。
  5. Period 监控统计周期,周期列表会根据 MetricName 选项自动获取,单击选择某一统计周期。
  6. Instance 实例,对应输入参数的 Instances.N 字段,实例列表会自动获取。点击查看各个云产品的实例列表接口文档。
    • 为了适应不同用户的习惯,实例列表会以不同的字段展示,默认以各产品的 ID 展示。
    • Show Details 按钮仅在选择非模板变量时显示,切换 Show Detailstrue,可展示实例请求参数,默认参数为Offset = 0Limit = 20。如果需要变更实例查询条件,可参考接口文档,配置相应参数。
    • 注意: 在本应用中,监控数据的单次查询为原子操作,即查询某一实例的某一指标的监控数据,故实例只能单选,如需查询多实例的监控数据,点击底部 + Query 增加新的查询。

模板变量

模板变量 Variables 是 Grafana 提供的一种 Dashboard 优化特性,用于创建高度可复用和交互式 Dashboard。模板变量的一般**是允许 Grafana 从数据源获得不同的度量,并提供一种无需修改仪表板就可以动态更改它的方法。腾讯云监控应用目前提供了地域、云服务器实例、云数据库 MySQL 实例 等变量。

所有实例类 Query 支持自定义下拉框选项展示字段,通过 display 字段设置,如:Namespace=QCE/CVM&Action=DescribeInstances&Region=$region&display=${InstanceId}-${InstanceName}。如果同时存在 InstanceAliasdisplay 字段,则仅会展示 display 的值。

已经提供的模板变量如下表所示:

变量 描述 示例
地域 参考 地域接口文档Action 固定为 DescribeRegionsNamespace 为云产品对应的命名空间,如 QCE/CVM QCE/CDB等。地区作为变量模板,只支持单选,如设置成多选或者选中 All, 默认选中第一个地区值。 Namespace=QCE/CVM&Action=DescribeRegions
CVM 云服务器实例 参考 云服务器查询实例列表接口文档Namespace 固定为QCE/CVMAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceNamePrivateIpAddressesPublicIpAddresses。云服务器实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CVM&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=PublicIpAddresses
CDB 云数据库 MySQL 实例 参考 云数据库MySQL查询实例列表接口文档Namespace 固定为QCE/CDBAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceNameVip。云数据库实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CDB&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=InstanceId
云数据库 PostgreSql 实例 参考 云数据库PostgreSQL查询实例列表接口文档Namespace 固定为QCE/CDBAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 DBInstanceId,可选值为 DBInstanceName, PrivateIpAddresses, PublicIpAddresses。云数据库实例作为模板变量,同时支持单选和多选。 Namespace=QCE/POSTGRES&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=DBInstanceId
云数据库 MongoDB 实例 参考 CMONGO实例查询实例列表接口文档Namespace 固定为QCE/CMONGOAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceName。CMONGO实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CMONGO&Region=$region&Action=DescribeInstances
云数据库 Redis 实例 参考 REDIS实例查询实例列表接口文档Namespace 固定为QCE/REDISAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceName。REDIS实例作为模板变量,同时支持单选和多选。 Namespace=QCE/REDIS&Region=$region&Action=DescribeInstances
云数据库 TDSQL-C (原CynosDB) 参考 CYNOSDBMYSQL实例查询实例列表接口文档Namespace 固定为QCE/CYNOSDB_MYSQLAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceName。CYNOSDBMYSQL实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CYNOSDB_MYSQL&Region=$region&Action=DescribeInstances
云数据库 TcaplusDB 实例 参考 TCAPLUS实例查询实例列表接口文档Namespace 固定为QCE/TCAPLUSAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceName。TCAPLUS实例作为模板变量,同时支持单选和多选。 Namespace=QCE/TCAPLUS&Region=$region&Action=DescribeInstances
云数据库 SQL Server 实例 参考 SQLSERVER实例查询实例列表接口文档Namespace 固定为QCE/SQLSERVERAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 Name。SQLSERVER实例作为模板变量,同时支持单选和多选。 Namespace=QCE/SQLSERVER&Region=$region&Action=DescribeInstances
私有网络 NateGateway 实例 参考 私有网络Nat网关查询实例列表接口文档Namespace 固定为QCE/NAT_GATEWAYAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 NatGatewayId,可选值为 NatGatewayName。NateGateway 网关实例作为模板变量,同时支持单选和多选。 Namespace=QCE/NAT_GATEWAY&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=NatGatewayId
私有网络对等连接实例 参考 私有网络对等连接查询实例列表接口文档Namespace 固定为QCE/PCXAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 peeringConnectionId,可选值为 peeringConnectionName。对等连接实例作为模板变量,同时支持单选和多选(如果是负载均衡则不支持多选,可选多个监听器)。 Namespace=QCE/PCX&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=peeringConnectionId
CLB 负载均衡实例 参考 负载均衡实例列表接口文档Namespace 可为QCE/LB_PRIVATEQCE/LB_PUBLICQCE/LOADBALANCEAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-guangzhou;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 LoadBalancerId,可选值为 LoadBalancerNameLoadBalancerVips。同时支持单选和多选。 Namespace=QCE/LB_PRIVATE&Action=DescribeInstances&Region=$region&InstanceAlias=LoadBalancerId
负载均衡监听器 参考 负载均衡监听器列表接口文档Namespace 可为QCE/LB_PRIVATEQCE/LB_PUBLICQCE/LOADBALANCEAction 固定为DescribeListenersRegion 为地域参数,可以为特定的地域值,如 ap-guangzhou;也可以为变量值,如 $regionInstance 为实例id,可以为特定的实例,如 lbl-rbw529fz;也可以为变量值,如 $instancelistenerAlias 为监听器的展示字段,默认为 ListenerId,可选值为 ListenerNamePort。同时支持单选和多选。 Namespace=QCE/LB_PRIVATE&Action=DescribeListeners&Region=$region&Instance=$instance&listenerAlias=ListenerId
CDN 内容分发式网络实例 参考 CDN实例查询实例列表接口文档Namespace 固定为QCE/CDNAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 Domain,可选值为 Domain, ProjectId。CDN实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CDN&Region=$region&Action=DescribeInstances
CDN 省份域名 参考 CDNPROVINCE实例查询实例列表接口文档Namespace 固定为QCE/CDN_LOG_DATAAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 Domain,可选值为 ProjectId Namespace=QCE/CDN_LOG_DATA&Region=$region&Action=DescribeInstances
CDN 省份运营商 参考 CDNPROVINCE的map信息列表接口文档Namespace 固定为QCE/CDN_LOG_DATAAction 固定为DescribeMapInfoRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstance 为实例,可为变量值,如$instanceName为接口必填参数,用于获取运营商或者省份列表,isp-运营商,district-省份。详见参考文档 Namespace=QCE/CDN_LOG_DATA&Region=$region&Action=DescribeInstances&Instance=$instance&Name=isp
BWP 带宽包实例 参考 BWP实例查询实例列表接口文档Namespace 固定为QCE/BWPAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 BandwidthPackageId,可选值为 BandwidthPackageId, BandwidthPackageName。BWP实例作为模板变量,同时支持单选和多选。 Namespace=QCE/BWP&Region=$region&Action=DescribeInstances
CKafka 消息队列实例 参考 CKAFKA实例查询实例列表接口文档Namespace 固定为QCE/CKAFKAAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceName。CKAFKA实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CKAFKA&Region=$region&Action=DescribeInstances
LB 弹性公网IP 实例 参考 LB实例查询实例列表接口文档Namespace 固定为QCE/LBAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 AddressId,可选值为 AddressId, AddressName, AddressIp。LB实例作为模板变量,同时支持单选和多选。 Namespace=QCE/LB&Region=$region&Action=DescribeInstances
CFS 文件存储实例 参考 CFS实例查询实例列表接口文档Namespace 固定为QCE/CFSAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 FileSystemId,可选值为 FileSystemId, FsName。CFS实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CFS&Region=$region&Action=DescribeInstances
SCF云函数实例 参考 SCF实例查询实例列表接口文档Namespace 固定为QCE/SCF_V2Action 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 FunctionId,可选值为 FunctionId, FunctionName。SCF实例作为模板变量,同时支持单选和多选。 Namespace=QCE/SCF_V2&Region=$region&Action=DescribeInstances
DCX 专线接入-专用通道实例 参考 DCX实例查询实例列表接口文档Namespace 固定为QCE/DCXAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 DirectConnectTunnelId,可选值为 DirectConnectTunnelName。DCX实例作为模板变量,同时支持单选和多选。 Namespace=QCE/DCX&Region=$region&Action=DescribeInstances
DC 专线接入-物理专线实例 参考 DC实例查询实例列表接口文档Namespace 固定为QCE/DCAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 DirectConnectId,可选值为 DirectConnectName。DC实例作为模板变量,同时支持单选和多选。 Namespace=QCE/DC&Region=$region&Action=DescribeInstances
私有网络-VPN 网关实例 参考 VPNGW实例查询实例列表接口文档Namespace 固定为QCE/VPNGWAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 VpnGatewayId,可选值为 VpnGatewayName。VPNGW实例作为模板变量,同时支持单选和多选。 Namespace=QCE/VPNGW&Region=$region&Action=DescribeInstances
私有网络-专线网关实例 参考 DCG实例查询实例列表接口文档Namespace 固定为QCE/DCGAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 DirectConnectGatewayId,可选值为 DirectConnectGatewayName。DCG实例作为模板变量,同时支持单选和多选。 Namespace=QCE/DCG&Region=$region&Action=DescribeInstances
API 网关实例 参考 APIGATEWAY实例查询实例列表接口文档Namespace 固定为QCE/APIGATEWAYAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 ServiceId,可选值为 ServiceName Namespace=QCE/APIGATEWAY&Region=$region&Action=DescribeInstances
API 网关服务环境 参考 APIGATEWAY服务环境列表接口文档Namespace 固定为QCE/APIGATEWAYAction 固定为DescribeServiceEnvironmentListRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstance 为实例,可以为特定的地域值;也可以为变量值,如 $instance Namespace=QCE/APIGATEWAY&Region=$region&Action=DescribeInstances&Instance=$instance
CBS 云硬盘实例 参考 CBS实例查询实例列表接口文档Namespace 固定为QCE/BLOCK_STORAGEAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 DiskId,可选值为 DiskName。CBS实例作为模板变量,同时支持单选和多选。 Namespace=QCE/BLOCK_STORAGE&Region=$region&Action=DescribeInstances
Elasticsearch 实例 参考 CES实例查询实例列表接口文档Namespace 固定为QCE/CESAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 InstanceId,可选值为 InstanceName。CES实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CES&Region=$region&Action=DescribeInstances
CMQ 消息队列实例 参考 CMQ实例查询实例列表接口文档Namespace 固定为QCE/CMQAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 QueueName,可选值为 QueueId。CMQ实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CMQ&Region=$region&Action=DescribeInstances
CMQ 消息队列主题订阅实例 参考 CMQTOPIC实例查询实例列表接口文档Namespace 固定为QCE/CMQTOPICAction 固定为DescribeInstancesRegion 为地域参数,可以为特定的地域值,如 ap-beijing;也可以为变量值,如 $regionInstanceAlias 为实例的展示字段,默认为 TopicName,可选值为 TopicId。CMQTOPIC实例作为模板变量,同时支持单选和多选。 Namespace=QCE/CMQTOPIC&Region=$region&Action=DescribeInstances

创建变量

  1. 进入某一 Dashboard 页面,点击右上角的 齿轮 图标,进入 Dashboard 设置页面;
  2. 点击左侧 Variables 选项,进入变量设置页面,然后点击 + Add variable 按钮,进入变量编辑页面;

编辑变量

  • Name 变量名,一般为英文字符串,在 Dashboard 的编辑中使用该变量名替换原特定值。
  • Label 变量的可见标签,用于更显式地描述变量名称。例如,Name 设置为 "region",Lable 可设置为 "地区"。
  • Type 变量查询方式,此处只能选择 Query 方式,即通过向数据源发送请求获取变量的列表。
  • Data source 要获取变量列表的数据源,选择已配置的任意腾讯云监控数据源。
  • Refresh 更新变量的方式,定义变量数据何时被更新。
  • Query 变量查询语句,详情参见上述表格的变量示例和描述。

变量信息填写完毕,可在页面下方预览查询得到的变量值,如果与期望值相符,点击 Add 按钮添加变量。添加成功后,点击右侧菜单的 Save 保存至 Dashboard 配置。

以云服务器单机监控 Dashboard 为例,展示如何配置级联变量:地域变量、云服务器实例变量,如下图所示。

Variable Region Config

Variable Instance Config

如需多选实例可将 Selection Options 下的 Multi-value 激活;地域模板变量仅支持单选;

应用变量

创建变量后,在 Dashboard 页面的左上角会展示变量选择框,可以切换变量值。变量有两种引用语法,$varname[[varname]]。变量常用于 Panel 的查询语句中,以云服务器单机监控 Dashboard 为例,展示如何在查询中使用变量,如下图所示。此外,变量还可以应用在 Panel 标题、Text 文本面板等。

Variable Dashboard

Variable Panel Query

FAQs

Q: 插件支持在同一个 Panel 中多地域查询吗?

A: 如果在 Dashboard 中使用 region 模板变量,则仅支持单地域查询。多地域实例对比可在同一个 Panel 中建多个 Query Target;

Q: 插件支持在同地域多个实例对比吗?

A: 可以将模板变量中 Selection Options 下的 Multi-value 设置为 true, Dashboard 中下拉框便可以进行多选实例,如图所示:

Q: 实例下拉框的选项显示的是 InstanceId ,如何改成 InstanceName

A: 可以在模板变量中使用 InstanceAlias=InstanceName ,或者使用 display 属性进行拼接,例:

  1. Namespace=QCE/CVM&Action=DescribeInstances&Region=$region&InstanceAlias=InstanceName
  2. Namespace=QCE/CVM&Action=DescribeInstances&Region=$region&display=${InstanceId}-${InstanceName}

如果同时存在 InstanceAliasdisplay 字段,则仅会展示 display 的值。

联系我们

若在使用过程中遇到任何问题,您可以在此创建 issue,或者扫码添加 云监控插件@Grafana 使用交流QQ群,我们将竭诚为您服务!

QQ 群 (861359693)
861359693

贡献者 ✨

感谢这些可爱的人对此项目的热爱 (emoji key):

All Contributors


heriky

💻

jamesxwang

💻 📖

leonlysu

💻

smallpath

💻

susiezhao

💻

taoran34

💻

Cloudlie

💻🐛

woson-wang

🐛

该项目遵循 all-contributors 规范。 欢迎任何形式的贡献!

贡献指南

欢迎大家参与到 腾讯云监控插件 @ Grafana 的开发工作,贡献一份力量!

您可以选择如下的贡献方式:

我们会将您加入 我们的贡献者名单

贡献方式请参考 贡献指南 文档。

许可证

腾讯云监控应用插件在 Apache License 2.0 许可证下提供。