Tablestore:Connect to Grafana

Usage notes

The regions that support the Grafana visualization feature depend on the data model used.

• Wide table model: supports all regions.

• Time series model: supports China (Hangzhou), China (Shanghai), China (Beijing), China (Zhangjiakou), China (Ulanqab), China (Shenzhen), China (Chengdu), China (Hong Kong), Japan (Tokyo), Singapore, Malaysia (Kuala Lumpur), Indonesia (Jakarta), Germany (Frankfurt), UK (London), US (Silicon Valley), US (Virginia), and SAU (Riyadh - Partner Region).

Step 1: Install the Tablestore plug-in

Step 2: Configure a data source

1. Log on to Grafana.

   1. In a browser, enter http://<x.x.x.x>:3000/ to open the Grafana logon page.

      Note

      <x.x.x.x> specifies the IP address of the server where Grafana is installed. For example, if Grafana is installed on Windows, the logon address is http://localhost:3000.

   2. Enter your Email or username and Password, and then click Log in.

      Note

      The default username and password are both admin. When you log on for the first time, you are prompted to change the password.

2. In the Grafana left-side navigation pane, choose Connections > Data sources.

3. On the Data sources page, click + Add new data source.

4. On the Add data source page, in the Others section, click aliyun-tablestore-grafana-datasource.

5. On the Settings tab, configure the parameters as described in the following table.

   Parameter	Example	Description
   Name	aliyun-tablestore-grafana-datasource	The name of the data source. Enter a custom name if needed. The default value is aliyun-tablestore-grafana-datasource.
   Default		Set the Tablestore data source as the default data source.
   Endpoint	https://myinstance.cn-hangzhou.ots.aliyuncs.com	Enter the endpoint of the Tablestore instance that you want to access.
   Instance	myinstance	The name of the Tablestore instance.
   AccessId	************************	The AccessKey ID of the Alibaba Cloud account or RAM user that has permissions to access Tablestore.
   AccessKey	********************************	The AccessKey secret of the Alibaba Cloud account or RAM user that has permissions to access Tablestore.

6. Click Save & test.

   After the connection succeeds, the interface displays the Data source is working message.

   

Step 3: Create a dashboard panel

1. In the Grafana left-side navigation pane, click Dashboards.

2. On the Dashboards page, click New and then select New dashboard.

   

3. On the New dashboard page, click + Add visualization.

4. In the Select data source dialog box, select the Tablestore data source that you configured.

   

5. On the Edit panel page, configure the query conditions on the Queries tab.

   The following table describes the parameters.

   Parameter	Example	Description
   Query	SELECT * FROM your_table WHERE $__unixMicroTimeRangeFilter(_time)AND _m_name = "your_measurement" AND tag_value_at(_tags, "your_tag")="your_tag_value" LIMIT 1000	The SQL query statement. For more information, see Query data. Important In the WHERE clause, you must use a predefined macro to filter data by time range, such as $__unixMicroTimeRangeFilter in the example. To view more time macros, click "Show Help" on the configuration page. If you want to display data in a time series chart, the query must return a time column that is represented by a numeric timestamp. Also, configure the name of the time column.
   Format As	Timeseries	The format of the results. Valid values: Timeseries (Default): A standard time series chart. FlowGraph: A multi-dimensional chart. Table: A standard table. Note If the table data lacks a time column when you query it from a wide table model using SQL, click Switch to table to display the query results in table format, or click Open visualization suggestions to view and select additional recommended visualization options.
   Time Column	_time	The name of the time column in the returned data. The time column is used as the x-axis of the time series chart. This parameter is available when you set Format As to Timeseries or FlowGraph.
   Aggregation Column	_field_name#:#_double_value	Converts multiple rows of single-column data at the same point in time into a single row of multi-column data. This parameter is used to convert data in single-value model into data in multi-value model. The data in single-value model is the results that are obtained when you use SQL to query a time series table in Tablestore. This parameter is available when you set Format As to FlowGraph. The format is <Data point name column>#:#<Value column>.

6. Click Run SQL to execute the SQL statement and view or debug the results.

7. Configure and save the dashboard panel.

   1. In the right-side pane, specify the name, type, and display style of the monitoring chart.

      

   2. In the upper-right corner, click Save dashboard. In the Save dashboard dialog box, specify the Title, Description, and Folder for the dashboard. Then, click Save.

   3. In the upper-right corner, click Save dashboard. In the Save dashboard dialog box, click Save.

Step 4: View monitoring data

In the Grafana left-side navigation pane, choose Dashboards. Click the dashboard in the destination folder to view all its monitoring charts.