# 对接Grafana插件（Linux）
Grafana是一个跨平台的开源的度量分析和可视化工具，可将通过将采集的数据查询进行可视化的展示，并及时通知。
LTS-Grafana是Grafana服务中的一个插件，它可以使用LTS的数据，并对数据进行可视化分析和展示。
#### 前提条件
- 已安装Grafana。Grafana版本要求使用9.0.0及以上版本。具体操作请参见[Grafana官方文档](https://docs.grafana.org/installation/?spm=a2c4g.11186623.0.0.546e6fcfshLLWW)。
- 下载[管道符版本LTS-Grafana插件压缩包](https://lts-grafana-new-cn-north-4.obs.cn-north-4.myhuaweicloud.com/LTS-Grafana-OBS-Static.2.0.26810.zip/1786450206272/LTS-Grafana-OBS-Static.2.0.26810.zip)。
- 需要在云日志服务控制台开通管道符功能才能使用LTS-Grafana插件。 目前此功能支持部分白名单用户使用的局点有：中国-香港、西南-贵阳二零二、华东-上海二、西南-贵阳二零三、华北三、华东-上海一、华北-北京四、华东-青岛、华南-广州、华南-深圳、西南-贵阳一、华东二、亚太-新加坡、华北-乌兰察布-汽车一、华北-乌兰察布一、亚太-曼谷，其他局点暂不支持该功能。
  
 
#### 安装云日志服务（LTS-Grafana）插件
1. 执行以下命令将云日志服务grafana插件项目压缩包解压到Grafana插件目录。 
   - 使用YUM或RPM安装的Grafana：
     {LTS_PLUGIN_VERSION}为LTS的Grafana插件版本号，例如：unzip LTS-Grafana-OBS-Static.2.0.26810.zip -d /var/lib/grafana/plugins。
     ```
     unzip LTS-Grafana-OBS-Static.{LTS_PLUGIN_VERSION}.zip -d /var/lib/grafana/plugins
     ```
     
   
   - 使用.tar.gz文件安装的Grafana： {LTS_PLUGIN_VERSION}为LTS的Grafana插件版本号，{PATH_TO}为Grafana的安装路径，{VERSION}为Grafana版本号。
     ```
     unzip LTS-Grafana-OBS-Static.{LTS_PLUGIN_VERSION}.zip -d {PATH_TO}/grafana-{VERSION}/plugins-bundled/internal/input-datasource
     ```
     如果执行命令时提示没有internal/input-datasource目录，需要执行"mkdir -p {PATH_TO}/grafana-{VERSION}/plugins-bundled/internal/input-datasource"命令创建目录。
     
   
   
   
   
2. 修改Grafana配置文件。 
   - 打开配置文件：
     - 使用YUM或RPM安装的Grafana：vim /etc/grafana/grafana.ini
     
     - 使用.tar.gz文件安装的Grafana：vim {PATH_TO}/grafana-{VERSION}/conf/defaults.ini
      
   
   - 在配置文件的\[plugins\]节点中，设置allow_loading_unsigned_plugins参数。
     ```
     allow_loading_unsigned_plugins = hw-hws-lts-grafana-datasource-plugin
     ```
     如果Grafana程序在运行中，建议使用kill命令终止Grafana进程。
     
   
   
   
   
3. 执行以下命令启动Grafana。 
   - 使用YUM或RPM安装的Grafana：
     ```
     systemctl restart grafana-server
     ```
     
   
   - 使用.tar.gz文件安装的Grafana：
     ```
     ./bin/grafana-server web
     ```
     
   
   
   
   
 
#### 添加数据源
1. 在左侧菜单栏中，单击![](https://support.huaweicloud.com/devg-lts/zh-cn_image_0000002185085853.png "点击放大") 选择Data Sources，进入Data Sources页面，单击Add data source，添加数据源，选择hws-lts-grafana-datasource-plugin。
   
   ![](https://support.huaweicloud.com/devg-lts/zh-cn_image_0000002185047513.png "点击放大")
   
   
2. 配置数据源。 
   图1配置数据源   
   ![](https://support.huaweicloud.com/devg-lts/zh-cn_image_0000002741393625.png "点击放大")
   表1数据源配置 
   | 参数                          | 说明                                                                                                                                                                                                                                                                                                                                           | 示例                                |
   |:---|:---|:---|
   | Name                        | 插件名称，可自定义。                                                                                                                                                                                                                                                                                                                                   | hws-lts-grafana-datasource-plugin |
   | Endpoint                    | 终端节点，根据自己的区域选择不同的终端节点。可参考[地区和终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/LTS)。                                                                                                                                                                                                                                              | -                                 |
   | AccesskeyId/SecretAccessKey | 用户访问凭证。登录LTS控制台，单击**账号名称\>我的凭证\>访问密钥**，在访问密钥页面中，可直接复制访问密钥ID。                                                                                                                                                                                                                                                                                 | -                                 |
   | 指定ProjectId                 | - 如果存在多个项目ID（projectId）场景，需要使用非默认project时，需要开启"指定ProjectId"，即可指定所需要的projectId。  - 如果是单个项目ID（projectId）场景，不开启"指定ProjectId"，则使用默认项目ID（projectId）。   | -                                 |
   | projectId                   | 开启"指定ProjectId"时需要填写账户的项目ID（projectId）。 登录LTS控制台，单击**账号名称\>我的凭证\>** **API凭证**，在API凭证页面中，可直接复制所属区域对应的项目ID。                                                                                                                                                                   | -                                 |
   | 默认日志流                       | 如果您需要指定数据源的日志流，可开启"默认日志流"，并填写streamId。                                                                                                                                                                                                                                                                                                       | -                                 |
      
   
   
3. 设置代理。如果需要使用代理的场景，需要开启代理设置参数。若不需要使用代理场景，则不需要设置该步骤。 
   表2代理设置 
   | 参数       | 说明                                                                                                                               | 示例          |
   |:---|:---|:---|
   | Scheme   | 协议                                                                                                                               | http、https等 |
   | Host     | 域名/IP                                                                                                                            | -           |
   | port     | 端口                                                                                                                               | 80          |
   | userName | 用户名 若输入的代理设置了用户名，则需要填写代理的用户名。 若输入的代理没有设置用户名，则不需要填写用户名，为空。 | -           |
   | password | 密码 若输入的代理设置了密码，则需要填写代理的密码。 若输入的代理没有设置密码，则不需要填写密码，为空。       | -           |
      
   
   
4. 添加仪表盘。 
   1. 在左侧菜单栏中，单击 选择Dashboards，在New dashboard页面中，单击add an empty panel。
   
   2. 在New dashboards页面中，选择hws-lts-grafana-datasource-plugin插件和填写对应的sql语句。
   
   3. 在右上角选择对应时间，并单击 ![](https://support.huaweicloud.com/devg-lts/zh-cn_image_0000002185047541.png) 按钮，可刷新请求最新的数据并展示。
      图2数据展示   
      ![](https://support.huaweicloud.com/devg-lts/zh-cn_image_0000002711556688.png "点击放大")
      LTS-Grafana插件相关参数配置规则如下：
      - 表格类型数据，需要将x-column参数的值给为"table"。若需要固定表格字段顺序，可通过Grafana的"Transformations \> Organize fields by name"功能实现自定义字段顺序（即固定表格字段顺序）。
        图3固定表格   
        ![](https://support.huaweicloud.com/devg-lts/zh-cn_image_0000002535686194.png "点击放大") 
      
      - 单值类型数据，例如数字图，需要将x-column参数值给成"single"，y-column为需要展示的数值列字段。
      
      - 时序图类型图表：有普通时序图和包含维度列时序图。
        - 普通时序图：x-column配置为时间列字段，y-column配置为需要展示的y轴字段，如有多个使用逗号分隔，例如：col1,col2,col3。
        
        - 包含维度列时序图：x-column配置为时间列字段，y-column配置为col1:col2。其中col1为聚合列，col2为数据列。
        
        
        ![](https://support.huaweicloud.com/devg-lts/public_sys-resources/note_3.0-zh-cn.png)
        时间字段如果使用time_format函数处理，则需要添加时区参数，例如：time_format(time_ceil(__time,'PT1M'),'%Y/%m/%d %H:%i:%s', '+0800')
        
      
      - 柱状图类型图表：x-column配置为"bar"，y-column配置为col1,col2。其中col1为类目列，col2为数据列。
      
      - 饼图类型图表：x-column配置为"pie"，y-column配置为col1,col2。其中col1为类目列，col2为数据列。