Menu
企业版 轻量版

文档

使用指导

用户可通过gs_dbmind命令启动对应的exporter。下面为用户演示一个完整的Prometheus监控平台的搭建过程。

  1. 部署openGauss-exporter:启动openGauss-exporter,采用默认侦听端口号9187,侦听地址为192.168.1.100,不采用https协议,则命令可以为:

    gs_dbmind component opengauss_exporter --url postgresql://user:password@ip:port/dbname --web.listen-address 192.168.1.100 --disable-https
    
  2. 部署reprocessing-exporter:启动reprocessing-exporter,采用默认侦听端口号8181,侦听地址为192.168.1.101,Prometheus-server IP与端口号为192.168.1.100:9090,采用https协议,则命令可以为:

    gs_dbmind component reprocessing_exporter 192.168.1.100 9090 --web.listen-address 192.168.1.101 --ssl-keyfile server.key --ssl-certfile server.crt
    
  3. 部署node-exporter:一般地,对于Prometheus监控平台都需要部署node-exporter用于监控Linux操作系统,后文提到的部分AI功能也需要依赖node-exporter采集Linux系统指标,故也需要用户来部署;只不过,该node-exporter为Prometheus自带组件,需要用户自行下载安装,下载地址为 https://prometheus.io/download/#node_exporter,使用方法详见:https://prometheus.io/docs/guides/node-exporter/#installing-and-running-the-node-exporter。用户可解压压缩包后直接运行该node-exporter进程,其默认端口号为9100,启动命令行为:

    ./node_exporter 
    
  4. 配置Prometheus-server,修改配置文件prometheus.yml,添加下述内容:

     scrape_configs:
     ...
       - job_name: 'opengauss_exporter'
         static_configs:
         - targets: ['192.168.1.100:9187']
       - job_name: 'reprocessing_exporter'
         scheme: https
         tls_config:
             ca_file: xxx.crt
         static_configs:
         - targets: ['127.0.0.1:8181']
       - job_name: 'node_exporter'
         static_configs:
         - targets: ['127.0.0.1:9100']
     ...
    

注意:
- openGauss-exporter中连接数据库的用户需要monitor admin或以上权限,否则会出现部分指标无法采集的情况。
- openGauss-exporter会从dbe_perf.statement_history中抽样慢SQL信息,dbe_perf.statement_history视图慢SQL记录与GUC参数log_min_duration_statement和track_stmnt_stat_level相关,其中log_min_duration_statement是慢SQL阈值,单位毫秒,具体值由用户设置;track_stmnt_stat_level是SQL记录级别,默认为'OFF,L0',即只记录慢SQL信息,级别为L0,用户在详细了解参数意义与作用情况下谨慎修改。
- openGauss-exporter采集数据库相关信息,主要包括部分系统表和视图中的数据(具体参见代码中opengauss_exporter中的配置文件),node-exporter采集系统指标信息,主要与系统磁盘、CPU等相关,reprocessing_exporter基于prometheus-server中的某些指标(具体参见代码中reprocessing_exporter中的配置文件)进行二次加工,最终提供加工后的数据供用户使用。
- prometheus-server在拉取exporter数据时有超时机制,超时时间由scrape_timeout(默认10s)控制,因此当exporter采集数据量较大时,用户可根据实际情况增大scrape_timeout以防止超时报错,另外需要注意的是scrape_interval(采集间隔)不能比scrape_timeout小,否则会出现异常。
- 如果数据库时区设置和系统不相同,可能会出现时间相关指标时间与系统时间不一致的情况,因此需要将用户时区与系统保持同步。
- 当使用https通信时,工具会检测证书与密钥文件权限以及证书有效期,如果文件权限大于600则会出现报警,证书有效期小于90天会出现报警。
- 当存在指标重复采集时,openGauss-exporter会出现异常,异常信息会打印到日志中。
- openGauss-exporter的–config、–disable-settings-metrics、–disable-statement-history-metrics三个参数需要注意,其存在以下几种情况:
1. 用户不指定其中任何参数,则工具会同时对yamls目录下的三个配置文件中的指标进行采集。
2. 用户显式指定–config,则工具不会采集yamls目录下default.yml中的指标,而会采集用户指定配置文件中的指标,同时pg_settings.yml和statements.yml正常采集,此时用户需要注意指定的配置文件中的指标和pg_settings.yml、statements.yml中的指标不能存在重复采集的现象。
3. 用户显式指定–disable-settings-metrics,则工具不会采集yamls目录下pg_settings.yml中的指标,用户显式指定–disable-statement-history-metrics,则工具不会采集yamls目录下statements.yml(慢SQL相关)中的指标。

本文档遵循知识共享许可协议CC 4.0 (http://creativecommons.org/Licenses/by/4.0/)。