Plugins 〉Tencent Cloud Monitor

Application
commercial

Tencent Cloud Monitor

  • Overview
  • Installation
  • Change log
  • Related content

Tencent Cloud Monitor Grafana App

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

Tencent Cloud Monitor Grafana App

English | 简体中文

Note: This plugin requires Grafana version >= 7.0 to run from version 2.0.0, for Grafana installation, please read Download Grafana.

Table of Contents

Introduction

Tencent Cloud Monitoring provides users with load and performance monitoring metrics of multiple cloud products such as Cloud Virtual Machine (CVM) and Cloud Databases (CDB). Users can use cloud monitoring consoles, cloud monitoring APIs, and other methods to retrieve relevant monitoring data. Tencent Cloud Monitor Grafana App is an application plugin that adapts to the open-source software Grafana. It retrieves monitoring data by calling Tencent Cloud Monitoring API 3.0, and displays the data on a custom Dashboard.

This plugin provides representative Dashboard templates for CVM Monitoring, TencentDB for MySQL Monitoring and Cloud Load Balancer etc.

Support monitoring , more cloud product metrics are being improved.

Product NameNamespaceMetric DocumentsInstance Documents
CVM MonitoringQCE/CVMhttps://intl.cloud.tencent.com/document/product/248/6843https://intl.cloud.tencent.com/document/product/213/33258
TencentDB for MySQLQCE/CDBhttps://intl.cloud.tencent.com/document/product/248/11006https://intl.cloud.tencent.com/document/product/236/15872
TencentDB for PostgreSQLQCE/POSTGREShttps://intl.cloud.tencent.com/document/product/248/17945https://intl.cloud.tencent.com/document/product/409/16773
TencentDB for MongoDBQCE/CMONGOhttps://intl.cloud.tencent.com/document/product/248/35671https://intl.cloud.tencent.com/document/api/240/34702
TencentDB for RedisQCE/REDIShttps://intl.cloud.tencent.com/document/product/248/34641https://intl.cloud.tencent.com/document/product/239/32065
TencentDB for TDSQL-C (CynosDB)QCE/CYNOSDB_MYSQLhttps://intl.cloud.tencent.com/document/product/248/37383https://intl.cloud.tencent.com/document/product/248/37383
TencentDB for TcaplusDBQCE/TCAPLUShttps://intl.cloud.tencent.com/document/product/248/34592https://intl.cloud.tencent.com/document/product/248/34592
TencentDB for SQL ServerQCE/SQLSERVERhttps://intl.cloud.tencent.com/document/product/248/11008https://intl.cloud.tencent.com/document/api/238/32115
TDSQL for MySQLQCE/TDMYSQLhttps://intl.cloud.tencent.com/document/product/248/40012https://intl.cloud.tencent.com/document/api/1042/34442
Content Delivery Network (CDN)QCE/CDNhttps://intl.cloud.tencent.com/document/product/248/39554https://intl.cloud.tencent.com/document/api/228/34020
CDN ProvinceQCE/CDN_LOG_DATAhttps://intl.cloud.tencent.com/document/product/248/39556https://intl.cloud.tencent.com/document/api/228/34020
Bandwidth PacketQCE/BWPhttps://intl.cloud.tencent.com/document/product/248/34645https://intl.cloud.tencent.com/document/api/215/36919
Message Queue CKafkaQCE/CKAFKAhttps://intl.cloud.tencent.com/document/product/248/17297https://intl.cloud.tencent.com/document/api/597/35357
Cloud Load Balancer Public NetworkQCE/LB_PUBLIChttps://intl.cloud.tencent.com/document/product/248/10997https://intl.cloud.tencent.com/document/product/214/33830
Cloud Load Balancer Private Network Layer-4 ProtocolQCE/LB_PRIVATEhttps://intl.cloud.tencent.com/document/product/248/39529https://intl.cloud.tencent.com/document/product/214/33830
Cloud Load Balancer Layer-7 ProtocolQCE/LOADBALANCEhttps://intl.cloud.tencent.com/document/product/248/39530https://intl.cloud.tencent.com/document/product/214/33830
Elastic IPQCE/LBhttps://intl.cloud.tencent.com/document/product/248/34646https://intl.cloud.tencent.com/document/api/215/16702
Cloud File Storage (CFS)QCE/CFShttps://intl.cloud.tencent.com/document/product/248/34644https://intl.cloud.tencent.com/document/api/582/34514
Serverless Cloud Function (SCF)QCE/SCF_V2https://intl.cloud.tencent.com/document/product/248/34638https://intl.cloud.tencent.com/document/api/583/18582
Private Network Dedicated TunnelQCE/DCXhttps://intl.cloud.tencent.com/document/product/248/10995https://intl.cloud.tencent.com/document/api/216/19819
Private Network Direct ConnectionQCE/DChttps://intl.cloud.tencent.com/document/product/248/10994https://intl.cloud.tencent.com/document/api/216/35330
Private Network VPN GatewayQCE/VPNGWhttps://intl.cloud.tencent.com/document/product/248/10988https://intl.cloud.tencent.com/document/api/215/17514
Private Network Direct Connect GatewayQCE/DCGhttps://intl.cloud.tencent.com/document/product/248/10990https://intl.cloud.tencent.com/document/api/215/36913
Private Network NAT GatewayQCE/NAT_GATEWAYhttps://intl.cloud.tencent.com/document/product/248/10991https://intl.cloud.tencent.com/document/api/215/34752
Private Network Peering ConnectionQCE/PCXhttps://intl.cloud.tencent.com/document/product/248/10986https://cloud.tencent.com/document/api/215/2101?lang=en
Private Network VPN GatewayQCE/VPNXhttps://intl.cloud.tencent.com/document/product/248/10988https://intl.cloud.tencent.com/document/api/215/17515
Private Network Anycast EIPQCE/CEIP_SUMMARYhttps://intl.cloud.tencent.com/document/product/248/39552https://intl.cloud.tencent.com/document/api/215/16702
Private Network Network DetectionQCE/VPC_NET_DETECThttps://intl.cloud.tencent.com/document/product/248/39557https://intl.cloud.tencent.com/document/product/215/34742
Private Network Cloud Connect NetworkQCE/VBChttps://intl.cloud.tencent.com/document/product/248/10987https://intl.cloud.tencent.com/document/api/215/34787
API GatewayQCE/APIGATEWAYhttps://intl.cloud.tencent.com/document/product/248/19130https://intl.cloud.tencent.com/document/api/628/36627
Cloud Block StorageQCE/BLOCK_STORAGEhttps://intl.cloud.tencent.com/document/product/248/37085https://intl.cloud.tencent.com/document/api/362/16315
ElasticsearchQCE/CEShttps://intl.cloud.tencent.com/document/product/248/34642https://intl.cloud.tencent.com/document/api/845/32214
CMQ Queue ServiceQCE/CMQhttps://intl.cloud.tencent.com/document/product/248/34643https://intl.cloud.tencent.com/document/api/406/35944
CMQ Topic SubscriptionQCE/CMQTOPIChttps://intl.cloud.tencent.com/document/product/248/11013https://intl.cloud.tencent.com/document/api/406/35944
Tencent Distributed Message QueueQCE/TDMQhttps://cloud.tencent.com/document/product/248/51450https://cloud.tencent.com/document/api/1179/52183?lang=en
Cloud Physical Machine 1.0QCE/CPMhttps://cloud.tencent.com/document/product/248/45881https://cloud.tencent.com/document/api/386/32904?lang=en
CPM Peering ConnectionQCE/BM_PCXhttps://cloud.tencent.com/document/product/248/45884https://cloud.tencent.com/document/product/1024/36903?lang=en
CPM Load Balancer Public NetworkQCE/BM_LBhttps://cloud.tencent.com/document/product/248/45886https://cloud.tencent.com/document/api/1027/33280?lang=en
CPM Load Balancer Private NetworkQCE/BM_INTRA_LBhttps://cloud.tencent.com/document/product/248/45885https://cloud.tencent.com/document/api/1027/33280?lang=en
Elastic MapReduce(HDFS)QCE/TXMR_HDFShttps://cloud.tencent.com/document/product/248/44797https://intl.cloud.tencent.com/document/api/1026/31052
Elastic MapReduce(HBASE)QCE/TXMR_HBASEhttps://cloud.tencent.com/document/product/248/45567https://intl.cloud.tencent.com/document/api/1026/31052
Elastic MapReduce(HIVE)QCE/TXMR_HIVEhttps://cloud.tencent.com/document/product/248/45569https://intl.cloud.tencent.com/document/api/1026/31052
Elastic MapReduce(NODE)QCE/TXMR_NODEhttps://cloud.tencent.com/document/product/248/45570https://intl.cloud.tencent.com/document/api/1026/31052
Elastic MapReduce(PRESTO)QCE/TXMR_PRESTOhttps://cloud.tencent.com/document/product/248/45571https://intl.cloud.tencent.com/document/api/1026/31052
Elastic MapReduce(SPARK)QCE/TXMR_SPARKhttps://cloud.tencent.com/document/product/248/45572https://intl.cloud.tencent.com/document/api/1026/31052
Elastic MapReduce(YARN)QCE/TXMR_YARNhttps://cloud.tencent.com/document/product/248/45573https://intl.cloud.tencent.com/document/api/1026/31052
Elastic MapReduce(ZOOKEEPER)QCE/TXMR_ZOOKEEPERhttps://cloud.tencent.com/document/product/248/45574https://intl.cloud.tencent.com/document/api/1026/31052
Edge Computing Machine Compute MonitorQCE/ECMhttps://cloud.tencent.com/document/product/248/45124https://cloud.tencent.com/document/api/1108/42565
Edge Computing Machine Block StorageQCE/ECM_BLOCK_STORAGEhttps://cloud.tencent.com/document/product/248/45123https://cloud.tencent.com/document/api/1108/42565
Edge Computing Machine Load BalancerQCE/ECM_LBhttps://cloud.tencent.com/document/product/248/54253https://cloud.tencent.com/document/api/1108/48459
Web Application FirewallQCE/WAFhttps://cloud.tencent.com/document/product/248/48124https://cloud.tencent.com/document/api/627/53601?lang=en
Cloud Object StorageQCE/COShttps://cloud.tencent.com/document/product/248/45140https://intl.cloud.tencent.com/document/product/436/8291
Global Application Acceleration PlatformQCE/QAAPhttps://cloud.tencent.com/document/product/248/45062https://intl.cloud.tencent.com/document/api/608/33101

Get Started

Installation

Prerequisites: Tencent Cloud Monitor Grafana App Plugin requires Grafana version >= 7.0 to run, for Grafana installation, please read Download Grafana.

There are multiple ways to install tencentcloud-monitor-grafana-app, please choose one of the methods below.

Use Grafana CLI

Get list of available versions:

$ grafana-cli plugins list-versions tencentcloud-monitor-app

Install the latest plugin:

$ grafana-cli plugins install tencentcloud-monitor-app

*If customized plugins directory, use the --pluginsDir param to overwrite.

Restart grafana after installing plugins:

$ systemctl restart grafana-server

Read more about installing plugins in Grafana plugins installation guide.

Warning: The only reliable installation method is grafana-cli. Any other way should be treated as a workaround and doesn't provide any backward-compatibility guaranties.

From GitHub Releases

  1. Go to the GitHub releases and find the latest release.
  2. Download .zip package with the plugin from release assets (asset name is tencentcloud-monitor-app-[x.x.x].zip) and unpack it into Grafana's plugins folder (${GRAFANA_HOME}/data/plugins), see docs here if you can't find your plugin folder.
  3. Restart Grafana server.

From Source Code

If you want to build a package yourself, or contribute, read Contribution Guide.

Upgrade

$ grafana-cli plugins update tencentcloud-monitor-app

Restart grafana after upgrading plugins:

$ systemctl restart grafana-server

From 1.x version

$ grafana-cli plugins upgrade tencentcloud-monitor-app

Note: you need to re-configure the datasource after the upgrade.

More Options

You can read more options by running help command below:

$ grafana-cli plugins --help

Enable plugin

Hover Settings Icon in the side menu and select Plugins. Successfully installed if the Tencent Cloud Monitor APP plugin is displayed in the plugin list. Plugin Search Click Enable in the plugin config page. Plugin Enable

Configure Datasource

Tencent Cloud Monitor Grafana App Plugin retrieves monitoring data of each cloud product metrics by calling the Cloud Monitoring API, and configures the data source of the corresponding cloud product through the following steps.

  1. Hover Settings Icon in the side menu and select Data Sources. Datasource Add
  2. Click Add data source on the top right corner of the page and select Tencent Cloud Monitoring data source. Datasource Add
  3. Name is the data source name, default name is Tencent Cloud Monitoring.
  4. SecretId and SecretKey are the security certificate information required to call the Cloud Monitoring API. Both can be retrieved through the Tencent Cloud console Cloud API key page;
  5. Toggle Cloud Products to enable/disable.
  6. Click Save & Test button to test the connection, the data source can be used in the Dashboard after the connection is successful. Datasource Config

Create Dashboard

There are three ways to create a Dashboard:

Quick Creation

Hover Plus Icon in the side menu and select +Dashboard.

Dashboards Manage Page

Hover Menu Icon in the side menu and select Manage. Click on the New Dashboard button to create a new Dashboard. At the same time, you can perform various management operations on Dashboard on this page, such as creating new folders, moving Dashboard, and importing Dashboard.

Import Dashboard Templates

Hover Settings Icon in the side menu and select Plugins. Select the Tencent Cloud Monitor plugin, navigate to Dashboards tab and import dashboard templates from here.

Import Plugin Dashboard

Configure Panel

CVM Panel Query

After creating the Dashboard, you can get the corresponding monitoring data monitored by Tencent Cloud by configuring the Panel. Now take a simple Graph as an example to show how to configure Panel information.

  1. Click Add Query button in a new panel, navigate to the first Query tab.
  2. Select Datasource to Tencent Cloud Monitoring.
  3. The Namespace is for example QCE/CVM for CVM monitoring.
  4. The Region list will be automatically retrieved according to the Namespace seleciton.
  5. The MetricName list will be retrieved after Namespace and Region are selected, read documents for each cloud products here.
  6. The Period list will be retrieved after MetricName is selected.
  7. The Instance corresponds to Instance.N in the input params, read documents for each cloud products here.
  • In order to adapt to the habits of different users, the instance list will be displayed in different fields, default ID for each cloud products, respectively.
  • Show Details toggle button will only show when not selecting template variables, toggle the button to see detailed instance query parameter. The default params are Offset = 0 and Limit = 20.
  • Note: In this app, a single query of monitoring data is an atomic operation, that is, to query the monitoring data of a certain metric of a certain instance, so the instance can only be single-selected. If you need to query the monitoring data of multiple instances, click on the Add Query button in upper right corner of the page.

Template Variables

Template Variables is a Dashboard optimization feature provided by Grafana to create highly reusable and interactive Dashboards. The general idea of template variables is to allow Grafana to obtain different metrics from the data source and provide a way to dynamically change it without modifying the dashboard. Tencent Cloud Monitor Grafana App currently provides variables such as region, CVM, and TencentDB for MySQL instances.

Notes: All Instance Queries allow customizing dropdown list values by display param, for example: Namespace=QCE/REDIS&Action=DescribeInstances&Region=$region&display=${InstanceId}-${InstanceName}. If display and InstanceAlias appear at the same time, the dropdown list will only show values of display.

From version 2.1.0, payload is supported for advanced query, for example you can enter the following query for filtering the instances with zone equals to ap-guangzhou-1:

Namespace=QCE/CVM&
Action=DescribeInstances&
Region=ap-guangzhou&
InstanceAlias=InstanceId&
payload={
  "Filters":[
    {
      "Name": "zone",
      "Values": ["ap-guangzhou-1"]
    }
  ]
}

Pay attention that payload is a strict JSON string.

The template variables that have been provided are shown in the following table:

VariableDescriptionExample
RegionPlease refer to Region API Documents. Action is fixed as DescribeRegions, Namespace is the unique namespace for each cloud products, e.g. QCE/CVM QCE/CDB etc. Region support single-selected as a template variable, The first region will be selected if multi-selected region or selected All.Namespace=QCE/CVM&Action=DescribeRegions
CVM instancesPlease refer to CVM Instance Documents. Namespace is fixed asQCE/CVM, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as InstanceId, can be selected as InstanceNamePrivateIpAddressesPublicIpAddresses. CVM instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CVM&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=PublicIpAddresses
TencentDB for MySQL instancesPlease refer to TencentDB for MySQL Instance Documents. Namespace is fixed asQCE/CDB, Action is fixed asDescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as InstanceId, can be selected as InstanceNameVip. CDB MySQL instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CDB&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=InstanceId
TencentDB for PostgreSQL instancesPlease refer to TencentDB for PostgreSQL Instance Documents. Namespace is fixed asQCE/CDB, Action is fixed asDescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as DBInstanceId, can be selected as DBInstanceName, PrivateIpAddresses, PublicIpAddresses. CDB PostgreSQL instance allow single-selected and multi-selected when using template variable.Namespace=QCE/POSTGRES&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=DBInstanceId
Private Network NAT Gateway instancesPlease refer to Private Network NAT Gateway Instance Documents. Namespace is fixed asQCE/NAT_GATEWAY, Action is fixed asDescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as NatGatewayId, can be selected as NatGatewayName. Private Network Nat Gateway instance allow single-selected and multi-selected when using template variable.Namespace=QCE/NAT_GATEWAY&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=NatGatewayId
Private Network Peering Connection instancesPlease refer to Private Network Peering Connection Instance Documents. Namespace is fixed asQCE/PCX, Action is fixed asDescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as peeringConnectionId, can be selected as peeringConnectionName. Peering Connection instance allow single-selected and multi-selected when using template variable (use multi listeners for Cloud Load Balance).Namespace=QCE/PCX&Region=ap-beijing&Action=DescribeInstances&InstanceAlias=peeringConnectionId
Cloud Load Balancer Private Network Layer-4 Protocol instancesPlease refer to Cloud Load Balancer Instance Documents. Namespace can be QCE/LB_PRIVATE, QCE/LB_PUBLIC, QCE/LOADBALANCE, Action is fixed asDescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAliasis default as LoadBalancerId, can be selected as LoadBalancerName, LoadBalancerVips, allowing single-selected and multi-selected.Namespace=QCE/LB_PRIVATE&Action=DescribeInstances&Region=$region&InstanceAlias=LoadBalancerId
Cloud Load Balancer Private Network Layer-4 Protocol listenersPlease refer to Cloud Load Balancer Listener Documents. Namespace can be QCE/LB_PRIVATE, QCE/LB_PUBLIC, QCE/LOADBALANCE, Action is fixed asDescribeListeners. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. Instance is an instance ID, can be specific value such as lbl-rbw529fz, or a template variable, such as $instance. listenerAlias is default as ListenerId, can be selected as ListenerName, Port, allowing single-selected and multi-selected.Namespace=QCE/LB_PRIVATE&Action=DescribeListeners&Region=$region&Instance=$instance&listenerAlias=ListenerId
TencentDB for MongoDBPlease refer to TencentDB for MongoDB Instance Documents. Namespace is fixed as QCE/CMONGO, Action is fixed as DescribeDBInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as InstanceId, can be selected as InstanceName. CMONGO instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CMONGO&Region=$region&Action=DescribeDBInstances
TencentDB for RedisPlease refer to TencentDB for Redis Instance Documents. Namespace is fixed as QCE/REDIS, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as InstanceId, can be selected as InstanceName. REDIS instance allow single-selected and multi-selected when using template variable.Namespace=QCE/REDIS&Region=$region&Action=DescribeInstances
Content Delivery Network (CDN)Please refer to CDN Instance Documents. Namespace is fixed as QCE/CDN, Action is fixed as DescribeDomains. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as Domain, can be selected as Domain, ProjectId. CDN instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CDN&Region=$region&Action=DescribeDomains
Bandwidth PacketPlease refer to BWP Instance Documents. Namespace is fixed as QCE/BWP, Action is fixed as DescribeBandwidthPackages. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as BandwidthPackageId, can be selected as BandwidthPackageId, BandwidthPackageName. BWP instance allow single-selected and multi-selected when using template variable.Namespace=QCE/BWP&Region=$region&Action=DescribeBandwidthPackages
Message Queue CKafkaPlease refer to Message Queue CKafka Instance Documents. Namespace is fixed as QCE/CKAFKA, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as InstanceId, can be selected as InstanceName. CKAFKA instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CKAFKA&Region=$region&Action=DescribeInstances
Elastic IPPlease refer to Instance Documents. Namespace is fixed as QCE/LB, Action is fixed as DescribeAddresses. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as AddressId, can be selected as AddressId, AddressName, AddressIp. EIP instance allow single-selected and multi-selected when using template variable.Namespace=QCE/LB&Region=$region&Action=DescribeAddresses
Cloud File StoragePlease refer to Instance Documents. Namespace is fixed as QCE/CFS, Action is fixed as DescribeCfsFileSystems. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as FileSystemId, can be selected as FileSystemId, FsName. CFS instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CFS&Region=$region&Action=DescribeCfsFileSystems
Serverless Cloud FunctionPlease refer to Instance Documents. Namespace is fixed as QCE/SCF_V2, Action is fixed as ListFunctions. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAliasis default as FunctionId, can be selected as FunctionId, FunctionName. SCF instance allow single-selected and multi-selected when using template variable.Namespace=QCE/SCF_V2&Region=$region&Action=ListFunctions
Dedicated TunnelPlease refer to Instance Documents. Namespace is fixed as QCE/DCX, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as DirectConnectTunnelId, can be selected as DirectConnectTunnelName. DCX instance allow single-selected and multi-selected when using template variable.Namespace=QCE/DCX&Region=$region&Action=DescribeInstances
Direct ConnectionPlease refer to Instance Documents. Namespace is fixed as QCE/DC, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as DirectConnectId, can be selected as DirectConnectName. DC instance allow single-selected and multi-selected when using template variable.Namespace=QCE/DC&Region=$region&Action=DescribeInstances
TencentDB for CYNOSDB_MYSQLPlease refer to Instance Documents. Namespace is fixed as QCE/CYNOSDB_MYSQL, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceName. CYNOSDBMYSQLinstance allow single-selected and multi-selected when using template variable.Namespace=QCE/CYNOSDB_MYSQL&Region=$region&Action=DescribeInstances
TencentDB for TcaplusDBPlease refer to Instance Documents. Namespace is fixed as QCE/TCAPLUS, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceName. TCAPLUS instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TCAPLUS&Region=$region&Action=DescribeInstances
TencentDB for SQL ServerPlease refer to Instance Documents. Namespace is fixed as QCE/SQLSERVER, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as Name. SQLSERVER instance allow single-selected and multi-selected when using template variable.Namespace=QCE/SQLSERVER&Region=$region&Action=DescribeInstances
VPN GatewayPlease refer to Instance Documents. Namespace is fixed as QCE/VPNGW, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as VpnGatewayId, can be selected as VpnGatewayName. VPNGW instance allow single-selected and multi-selected when using template variable.Namespace=QCE/VPNGW&Region=$region&Action=DescribeInstances
Direct Connect GatewayPlease refer to Instance Documents. Namespace is fixed as QCE/DCG, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as DirectConnectGatewayId, can be selected as DirectConnectGatewayName. DCGinstance allow single-selected and multi-selected when using template variable.Namespace=QCE/DCG&Region=$region&Action=DescribeInstances
CDN Province DomainsPlease refer to Instance Documents. Namespace is fixed as QCE/CDN_LOG_DATA, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as Domain, can be selected as ProjectId.Namespace=QCE/CDN_LOG_DATA&Region=$region&Action=DescribeInstances
CDN Province Map InfoPlease refer to Instance Documents. Namespace is fixed as QCE/CDN_LOG_DATA, Action is fixed as DescribeMapInfo. Region can be specific value such as ap-beijing, or a template variable, such as $region. Instance can be a template variable, such as $instance. Name is required for retreiving data.Namespace=QCE/CDN_LOG_DATA&Region=$region&Action=DescribeInstances&Instance=$instance&Name=isp
API GatewayPlease refer to Instance Documents. Namespace is fixed as QCE/APIGATEWAY, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as ServiceId, can be selected as ServiceName.Namespace=QCE/APIGATEWAY&Region=$region&Action=DescribeInstances
API Gateway ServiceEnvironmentPlease refer to Instance Documents. Namespace is fixed as QCE/APIGATEWAY, Action is fixed as DescribeServiceEnvironmentList. Region can be specific value such as ap-beijing, or a template variable, such as $region. Instance can be specific value, or a template variable, such as $instance.Namespace=QCE/APIGATEWAY&Region=$region&Action=DescribeInstances&Instance=$instance
Cloud Block StoragePlease refer to Instance Documents. Namespace is fixed as QCE/BLOCK_STORAGE, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as DiskId, can be selected as DiskName. CBS instance allow single-selected and multi-selected when using template variable.Namespace=QCE/BLOCK_STORAGE&Region=$region&Action=DescribeInstances
ElasticsearchPlease refer to Instance Documents. Namespace is fixed as QCE/CES, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceName. CES instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CES&Region=$region&Action=DescribeInstances
CMQ Queue ServicePlease refer to Instance Documents. Namespace is fixed as QCE/CMQ, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as QueueName, can be selected as QueueId. CMQ instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CMQ&Region=$region&Action=DescribeInstances
CMQ Topic SubscriptionPlease refer to Instance Documents. Namespace is fixed as QCE/CMQTOPIC, Action is fixed as DescribeInstances. Region can be specific value such as ap-beijing, or a template variable, such as $region. InstanceAlias is default as TopicName, can be selected as TopicId. CMQTOPICinstance allow single-selected and multi-selected when using template variable.Namespace=QCE/CMQTOPIC&Region=$region&Action=DescribeInstances
TDSQL for MySQLPlease refer to Instance Documents. Namespace is fixed as QCE/TDMYSQL, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceId, InstanceName. TDMYSQL instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TDMYSQL&Action=DescribeInstances&Region=$region&InstanceAlias=InstanceId
Private Network VPN GatewayPlease refer to Instance Documents. Namespace is fixed as QCE/VPNX, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as VpnConnectionId, can be selected as VpnConnectionId, VpnConnectionName. VPNX instance allow single-selected and multi-selected when using template variable.Namespace=QCE/VPNX&Action=DescribeInstances&Region=$region&InstanceAlias=VpnConnectionId
Private Network Anycast EIPPlease refer to Instance Documents. Namespace is fixed as QCE/CEIP_SUMMARY, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as AddressId, can be selected as AddressId, AddressName, AddressIp. CEIP_SUMMARY instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CEIP_SUMMARY&Action=DescribeInstances&Region=$region&InstanceAlias=AddressId
Private Network Network DetectionPlease refer to Instance Documents. Namespace is fixed as QCE/VPC_NET_DETECT, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as NetDetectId, can be selected as NetDetectId, NetDetectName. VPC_NET_DETECT instance allow single-selected and multi-selected when using template variable.Namespace=QCE/VPC_NET_DETECT&Action=DescribeInstances&Region=$region&InstanceAlias=NetDetectId
Private Network Cloud Connect NetworkPlease refer to Instance Documents. Namespace is fixed as QCE/VBC, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as CcnId, can be selected as CcnId, CcnName. VBC instance allow single-selected and multi-selected when using template variable.Namespace=QCE/VBC&Action=DescribeInstances&Region=$region&InstanceAlias=CcnId
Cloud Object StoragePlease refer to Instance Documents. Namespace is fixed as QCE/COS, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as BucketName, can be selected as BucketName. COS instance allow single-selected and multi-selected when using template variable.Namespace=QCE/COS&Action=DescribeInstances&Region=$region&InstanceAlias=BucketName
Tencent Distributed Message QueuePlease refer to Instance Documents. Namespace is fixed as QCE/TDMQ, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. TDMQ instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TDMQ&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Cloud Physical Machine 1.0Please refer to Instance Documents. Namespace is fixed as QCE/CPM, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceId, Name. CPM instance allow single-selected and multi-selected when using template variable.Namespace=QCE/CPM&Action=DescribeInstances&Region=$region&InstanceAlias=InstanceId
CPM Peering ConnectionPlease refer to Instance Documents. Namespace is fixed as QCE/BM_PCX, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as VpcPeerConnectionId, can be selected as VpcPeerConnectionId, VpcPeerConnectionName. BM_PCX instance allow single-selected and multi-selected when using template variable.Namespace=QCE/BM_PCX&Action=DescribeInstances&Region=$region&InstanceAlias=VpcPeerConnectionId
CPM Load Balancer Public NetworkPlease refer to Instance Documents. Namespace is fixed as QCE/BM_LB, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as LoadBalancerId, can be selected as LoadBalancerId, LoadBalancerVips, LoadBalancerName. BM_LB instance allow single-selected and multi-selected when using template variable.Namespace=QCE/BM_LB&Action=DescribeInstances&Region=$region&InstanceAlias=LoadBalancerId
CPM Load Balancer Private NetworkPlease refer to Instance Documents. Namespace is fixed as QCE/BM_INTRA_LB, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as LoadBalancerId, can be selected as LoadBalancerId, LoadBalancerVips, LoadBalancerName. BM_INTRA_LB instance allow single-selected and multi-selected when using template variable.Namespace=QCE/BM_INTRA_LB&Action=DescribeInstances&Region=$region&InstanceAlias=LoadBalancerId
Elastic MapReduce(HDFS)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_HDFS, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. HDFS instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_HDFS&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Elastic MapReduce(HBASE)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_HBASE, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. EMR HBASE instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_HBASE&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Elastic MapReduce(HIVE)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_HIVE, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. EMR HIVE instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_HIVE&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Elastic MapReduce(NODE)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_NODE, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. EMR NODE instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_NODE&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Elastic MapReduce(PRESTO)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_PRESTO, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. EMR PRESTO instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_PRESTO&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Elastic MapReduce(SPARK)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_SPARK, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. EMR SPARK instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_SPARK&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Elastic MapReduce(YARN)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_YARN, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. EMR YARN instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_YARN&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Elastic MapReduce(ZOOKEEPER)Please refer to Instance Documents. Namespace is fixed as QCE/TXMR_ZOOKEEPER, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as ClusterId, can be selected as ClusterId, ClusterName. EMR instance allow single-selected and multi-selected when using template variable.Namespace=QCE/TXMR_ZOOKEEPER&Action=DescribeInstances&Region=$region&InstanceAlias=ClusterId
Global Application Acceleration PlatformPlease refer to Instance Documents. Namespace is fixed as QCE/QAAP, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceId. QAAP instance allow single-selected and multi-selected when using template variable.Namespace=QCE/QAAP&Action=DescribeInstances&Region=$region&InstanceAlias=InstanceId
Edge Computing Machine Compute MonitorPlease refer to Instance Documents. Namespace is fixed as QCE/ECM, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceId, InstanceName. ECM instance allow single-selected and multi-selected when using template variable.Namespace=QCE/ECM&Action=DescribeInstances&Region=$region&InstanceAlias=InstanceId
Edge Computing Machine Block StoragePlease refer to Instance Documents. Namespace is fixed as QCE/ECM_BLOCK_STORAGE, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as InstanceId, can be selected as InstanceId, InstanceName. ECM_BLOCK_STORAGE instance allow single-selected and multi-selected when using template variable.Namespace=QCE/ECM_BLOCK_STORAGE&Action=DescribeInstances&Region=$region&InstanceAlias=InstanceId
Edge Computing Machine Load BalancerPlease refer to Instance Documents. Namespace is fixed as QCE/ECM_LB, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as LoadBalancerId, can be selected as LoadBalancerId, LoadBalancerName. ECM_LB instance allow single-selected and multi-selected when using template variable.Namespace=QCE/ECM_LB&Action=DescribeInstances&Region=$region&InstanceAlias=LoadBalancerId
Web Application FirewallPlease refer to Web Instance Documents. Namespace is fixed as QCE/WAF, Action is fixed as DescribeInstances. Region can be specific value such as ap-guangzhou, or a template variable, such as $region. InstanceAlias is default as Domain, can be selected as Domain, ProjectId. WAF instance allow single-selected and multi-selected when using template variable.Namespace=QCE/WAF&Action=DescribeInstances&Region=$region&InstanceAlias=Domain

Create Template Variable

  1. Hover the Settings Icon on the top right corner of any Dashboard Page.
  2. Click Variables Tab on the left bar and Add variable.

Edit Template Variable

  • Name is usually an English String.
  • Label is a custom name for the variable. (e.g. set "region" to Name and "地区" to Label).
  • Type is the type to query, here we can only select the Query option, as requesting the list from the data source.
  • Data source is the source you configured in Grafana Datasource Configuration.
  • Refresh is to define when the variable data is updated.
  • Query is the variable query statement, please refer to the variable example and description in the above table for details.

After filling in the variable information, you can preview the query variable value at the bottom of the page. If it matches the expected value, click the Add button to add the variable. After successfully adding, click Save on the right menu to save to the Dashboard configuration.

Take the cloud server stand-alone monitoring Dashboard as an example to show how to configure cascading variables: regional variables and cloud server instance variables, as shown in the figure below.

Variable Region Config

Variable Instance Config

Use Template Variable

After the variable is created, the variable selection box will be displayed in the upper left corner of the Dashboard page, and the variable value can be switched. There are two kinds of quoting syntax for variables, $varname and [[varname]]. Variables are often used in Panel query statements. Take cloud server stand-alone monitoring Dashboard as an example to show how to use variables in queries, as shown in the figure below. In addition, variables can also be applied to Panel titles, Text panels, etc.

Variable Dashboard

Variable Panel Query

Contact Us

If you have any questions using this app, you are welcome to create an issue or to scan the QR code below to add QQ group chat:

QQ Group (861359693)
QQ Group

Contribution Guide

Welcome everyone to participate in the development of Tencent Cloud Monitoring Grafana App and contribute!

You can choose the following contribution methods:

We will add you into our contributor list

Read more in the Contribution Guide document.

License

Tencent Cloud Monitor Grafana App is delivered under the Apache License 2.0

For more information, visit the docs on plugin installation.

TencentCloud Monitor Grafana App


[2.1.0] - 2021-05-01

Added

Fixed

  • Import preset dashboard templates under "Tencent Cloud Monitor" folder.
  • Change CVM template variable value from PublicIp to InstanceId.
  • Known bugs when setting template variable refresh method to never.
  • percent unit in preset dashboard templates.
  • InstanceAlias display issue on when hovering the graph and in the legend.

[2.0.2] - 2021-04-13

Added

  • Plugin signing script.

Fixed

  • Set English as the main readme language in dist/
  • Other minor document fixes.

[2.0.1] - 2021-04-07

Fixed

  • Readme display issues on https://grafana.com/grafana/plugins/tencentcloud-monitor-app.
  • Update screenshot images.
  • Multi backend plugin process.

[2.0.0] - 2021-04-06

2.0.0 Feature highlights

We are now officially on Grafana Plugins, the plugin is signed and safer!

Breaking changes

Added

Fixed

  • Backend datasource for secretId/secretKey authorization (#19).

Installation

Prerequisites: Grafana version >= 7.0.

$ grafana-cli plugins install tencentcloud-monitor-app

See detailed guide in README.md.


[1.5.0] - 2021-04-02

Added

Fixed

  • Preset dashboard templates. (#47)
  • Remove $region in CDN monitoring.
  • Other known issues.

See detailed guide in README.md.


[1.4.4] - 2021-03-23

Added

  • Contributors and Contribution guide in README (#33).

Fixed

  • Allow using variables to get instance data in SCF monitoring (#32) (#37).
  • Some minor fix.

See detailed guide in README.md.


[1.4.3] - 2021-03-10

Added

See detailed guide in README.md.


[1.4.2] - 2021-03-08

Added

  • Add URL for instance Template Variable value, more readable URL for users.
  • Add display param in query for customizing dropdown list values. For example: Namespace=QCE/REDIS&Action=DescribeInstances&Region=$region&display=${InstanceId}-${InstanceName}.
    Note: if display and InstanceAlias appear at the same time, the dropdown list will only show values of display.
  • Allow search when selecting namespaces.

Fixed

  • Some known errors.

See detailed guide in README.md.


[1.4.1] - 2021-03-03

Fixed

  • Fix Redis dashboard

Removed

  • Remove (QCE/REDIS_MEM) namespace

See detailed guide in README.md.


[1.4.0] - 2021-03-01

Added

See detailed guide in README.md.


[1.3.1] - 2021-01-29

Added

See detailed guide in README.md.


[1.0.0] - 2021-01-22

1.0.0 Feature highlights

Tencent Cloud Monitoring provides users with load and performance monitoring metrics of multiple cloud products such as Cloud Virtual Machine (CVM) and Cloud Databases (CDB). Users can use cloud monitoring consoles, cloud monitoring APIs, and other methods to retrieve relevant monitoring data. Tencent Cloud Monitor Grafana App is an application plugin that adapts to the open-source software Grafana. It retrieves monitoring data by calling Tencent Cloud Monitoring API 3.0, and displays the data on a custom Dashboard.

Added

  • Grafana plugin subscription preparation (#21), docker support for development.

Installation

Prerequisites: Tencent Cloud Monitor Grafana App Plugin requires Grafana version > 6.x to run, for Grafana installation, please read Download Grafana.

  1. Go to the GitHub releases and find the latest release.
  2. Download .zip package with the plugin from release assets (asset name is tencentcloud-monitor-app-[x.x.x].zip) and unpack it into Grafana's plugins folder (${GRAFANA_HOME}/data/plugins), see docs here if you can't find your plugin folder.
  3. Restart Grafana server.
  4. Hover Settings Icon in the side menu and select Plugins. Successfully installed if the Tencent Cloud Monitor APP plugin is displayed in the plugin list.
  5. Click Enable in the plugin config page.

See detailed guide in README.md.