Help Center/ Log Tank Service/ Developer Guide/ Interconnecting with the Grafana Plug-in/ Interconnecting with the Grafana Plug-in (Linux)
Updated on 2024-05-07 GMT+08:00
View PDF

Interconnecting with the Grafana Plug-in (Linux)

Grafana is a cross-platform open-source measurement analysis and visualization tool. It can query collected data, display the data in a visualized manner, and notify users in a timely manner.

LTS-Grafana is a plug-in of Grafana. It can analyze and display LTS data in a visualized manner.

Prerequisites

  • You have installed Grafana. For details, see Grafana official documentation.

    The Grafana version must be 9.0.0 or later.

  • Download the LTS-Grafana plug-in package.
  • The LTS-Grafana plug-in can be used only after the visualization function is enabled on the LTS console.

    Currently, this function is available to all users in regions CN South-Guangzhou, CN North-Beijing1, CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN Southwest-Guiyang1, CN-Hong Kong, AP-Bangkok, and AP-Singapore. It is also available to whitelisted users in regions AP-Jakarta and CN South-Shenzhen. It is not available in other regions.

Installing the LTS-Grafana Plug-in

  1. Run the following command to decompress the LTS Grafana plug-in package to the Grafana plug-in directory:

    • Grafana installed using YUM or RPM:
      unzip LTS-Grafana-OBS-Static.1.0.10.zip -d /var/lib/grafana/plugins
    • Grafana installed using a .tar.gz file:

      {PATH_TO} indicates the Grafana installation path, and {VERSION} indicates the Grafana version.

      unzip LTS-Grafana-OBS-Static.1.0.10.zip -d {PATH_TO}/grafana-{VERSION}/plugins-bundled/internal/input-datasource

  2. Modify the Grafana configuration file.

    • Open the configuration file:
      • Grafana installed using YUM or RPM: /etc/grafana/grafana.ini
      • Grafana installed using a .tar.gz file: {PATH_TO}/grafana-{VERSION}/conf/defaults.ini
    • Configure the allow_loading_unsigned_plugins parameter in the [plugins] section of the configuration file.
      allow_loading_unsigned_plugins = hw-hws-lts-grafana-datasource-plugin

  3. Restart Grafana.

    • Run the kill command to stop the Grafana process.
    • Run the following commands to start Grafana:
      • Grafana installed using YUM or RPM:
        systemctl restart grafana-server
      • Grafana installed using a .tar.gz file:
        ./bin/grafana-server web

Adding a Data Source

  1. In the navigation pane on the left, click and choose Data sources. On the Data sources page that is displayed, click Add data source to add a data source and select hws-lts-grafana-datasource-plugin.

  2. Configure the data source and click Save &test.

    Table 1 Parameters

    Parameter

    Description

    Example Value

    Name

    Plug-in name, which can be customized.

    hws-lts-grafana-datasource-plugin

    EndPoint

    Select an endpoint based on your region. For details, see Regions and Endpoints.

    -

    projectId
    Project ID of an account.
    NOTE:

    Log in to the LTS console, move the cursor to the account name and choose My Credentials > API Credentials. On the API Credentials page, copy the project ID of the region.

    -

    Log StreamId

    ID of the log stream with structuring configured.

    NOTE:

    Log in to the LTS console and choose Log Management. Click of the target log group and hover your cursor over the target log stream to copy its ID.

    -

    AccesskeyId/SecretAccessKey

    User access credential.

    NOTE:

    Log in to the LTS console, move the cursor to the account name and choose My Credentials > Access Keys. On the Access Keys page, copy the access key ID.

    -

  3. Add a dashboard.

    1. In the navigation pane on the left, choose Dashboards. On the New dashboard page, click add an empty panel.
    2. On the New dashboards page, select hws-lts-grafana-datasource-plugin and enter the corresponding SQL statement.

    3. Select the corresponding time in the upper right corner and click to refresh and display the latest data.

      Follow the following rules when configuring parameters of the LTS-Grafana plug-in:

      • For table data, set the x-column parameter to table.
      • For single-value data, set the x-column parameter to single.
      • For charts that contain dimension columns, set the x-column parameter to the time column field and y-column to col1:col2. col1 indicates the aggregation column, and col2 indicates the data column.
      • For bar charts, set the x-column parameter to bar and y-column to col1,col2. col1 indicates the category column, and col2 indicates the data column.
      • For pie charts, set the x-column parameter to pie and y-column to col1,col2. col1 indicates the category column, and col2 indicates the data column.