首页 > 其他分享 >openGauss Prometheus-Exporter组件命令参考

openGauss Prometheus-Exporter组件命令参考

时间:2024-04-17 20:47:10浏览次数:29  
标签:web Exporter log -- ssl Prometheus disable file openGauss

命令参考

reprocessing-exporter的使用帮助详情:

gs_dbmind component reprocessing_exporter --help
usage:  [-h] [--disable-https] [--ssl-keyfile SSL_KEYFILE] [--ssl-certfile SSL_CERTFILE] [--ssl-ca-file SSL_CA_FILE] [--web.listen-address WEB.LISTEN_ADDRESS] [--web.listen-port WEB.LISTEN_PORT]
        [--collector.config COLLECTOR.CONFIG] [--log.filepath LOG.FILEPATH] [--log.level {debug,info,warn,error,fatal}] [-v]
        prometheus_host prometheus_port

Reprocessing Exporter: A re-processing module for metrics stored in the Prometheus server.

positional arguments:
  prometheus_host       from which host to pull data
  prometheus_port       the port to connect to the Prometheus host

optional arguments:
  -h, --help            show this help message and exit
  --disable-https       disable Https scheme
  --ssl-keyfile SSL_KEYFILE
                        set the path of ssl key file
  --ssl-certfile SSL_CERTFILE
                        set the path of ssl certificate file
  --ssl-ca-file SSL_CA_FILE
                        set the path of ssl ca file
  --web.listen-address WEB.LISTEN_ADDRESS
                        address on which to expose metrics and web interface
  --web.listen-port WEB.LISTEN_PORT
                        listen port to expose metrics and web interface
  --collector.config COLLECTOR.CONFIG
                        according to the content of the yaml file for metric collection
  --log.filepath LOG.FILEPATH
                        the path to log
  --log.level {debug,info,warn,error,fatal}
                        only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal]
  -v, --version         show program's version number and exit

表 1 reprocessing-exporter的命令行参数详情表

参数

参数说明

取值范围

prometheus_host

Prometheus-server的IP地址

-

prometheus_port

Prometheus-server的服务侦听端口号

1024-65535

-h, --help

帮助选项

-

--disable-https

禁用Https协议

-

--ssl-keyfile

Https协议使用的证书私钥文件路径

-

--ssl-certfile

Https协议使用的证书文件路径

-

--ssl-ca-file

Https协议使用的CA证书文件路径

  

--web.listen-address

该exporter服务的绑定IP

-

--web.listen-port

该exporter服务的侦听端口

1024-65535

--collector.config

显性指定的待采集指标配置文件路径

-

--log.filepath

日志文件保存路径,默认保存在当前目录下

-

--log.level

日志文件的打印级别,默认为INFO级别

debug, info, warn, error, fatal

--version

显示版本信息

-

openGauss-exporter的使用帮助详情:

gs_dbmind component opengauss_exporter --help
usage:  [-h] --url URL [--config-file CONFIG_FILE] [--include-databases INCLUDE_DATABASES] [--exclude-databases EXCLUDE_DATABASES] [--constant-labels CONSTANT_LABELS]
        [--web.listen-address WEB.LISTEN_ADDRESS] [--web.listen-port WEB.LISTEN_PORT] [--disable-cache] [--disable-settings-metrics]
        [--disable-statement-history-metrics] [--disable-https] [--disable-agent] [--ssl-keyfile SSL_KEYFILE] [--ssl-certfile SSL_CERTFILE] [--ssl-ca-file SSL_CA_FILE] [--parallel PARALLEL]
        [--log.filepath LOG.FILEPATH] [--log.level {debug,info,warn,error,fatal}] [-v]

openGauss Exporter (DBMind): Monitoring or controlling for openGauss.

optional arguments:
  -h, --help            show this help message and exit
  --url URL             openGauss database target url. It is recommended to connect to the postgres database through this URL, so that the exporter can actively discover and monitor other databases.
  --config-file CONFIG_FILE, --config CONFIG_FILE
                        path to config file.
  --include-databases INCLUDE_DATABASES
                        only scrape metrics from the given database list. a list of label=value separated by comma(,).
  --exclude-databases EXCLUDE_DATABASES
                        scrape metrics from the all auto-discovered databases excluding the list of database. a list of label=value separated by comma(,).
  --constant-labels CONSTANT_LABELS
                        a list of label=value separated by comma(,).
  --web.listen-address WEB.LISTEN_ADDRESS
                        address on which to expose metrics and web interface
  --web.listen-port WEB.LISTEN_PORT
                        listen port to expose metrics and web interface
  --disable-cache       force not using cache.
  --disable-settings-metrics
                        not collect pg_settings.yml metrics.
  --disable-statement-history-metrics
                        not collect statement-history metrics (including slow queries).
  --disable-https       disable Https scheme
  --disable-agent       by default, this exporter also assumes the role of DBMind-Agent, that is, executing database operation and maintenance actions issued by the DBMind service. With this argument,
                        users can disable the agent functionality, thereby prohibiting the DBMind service from making changes to the database.
  --ssl-keyfile SSL_KEYFILE
                        set the path of ssl key file
  --ssl-certfile SSL_CERTFILE
                        set the path of ssl certificate file
  --ssl-ca-file SSL_CA_FILE
                        set the path of ssl ca file
  --parallel PARALLEL   not collect pg_settings.yml metrics.
  --log.filepath LOG.FILEPATH
                        the path to log
  --log.level {debug,info,warn,error,fatal}
                        only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal]
  -v, --version         show program's version number and exit

表 2 openGauss-exporter的命令行参数详情表

参数

参数说明

取值范围

--url

数据库server的连接地址,例如 postgres://user:pwd@host:port/dbname

如果该url涉及到的各字段URL包含特殊字符(如@, /等),则需要通过URL编码进行转义,例如密码中的"@"应转义为%40, "/"应转义为%2F. 否则各字段的含义会被错误识别和切分,具体转义规则可以参考URL编码的转义规则, 该URL地址规则遵循 RFC-1738 标准。

--constant-labels

常量列表,k=v格式,用逗号隔开,表明该exporter自带的常量标签

格式如cluster_name=demo,cluster_id=1

-h, --help

帮助选项

-

--disable-https

禁用Https协议

-

--ssl-keyfile

Https协议使用的证书私钥文件路径

-

--ssl-certfile

Https协议使用的证书文件路径

-

--ssl-ca-file

Https协议使用的CA证书文件路径

-

--web.listen-address

该exporter服务的绑定IP

-

--web.listen-port

该exporter服务的侦听端口

1024-65535

--config, --config-file

显性指定的待采集指标配置文件路径

-

--log.filepath

日志文件保存路径,默认保存在当前目录下

-

--log.level

日志文件的打印级别,默认为INFO级别

debug, info, warn, error, fatal

--version

显示版本信息

-

--disable-cache

禁止使用缓存

-

--disable-settings-metrics

禁止采集pg_settings表的值

-

--disable-statement-history-metrics

禁止收集statement_history表中的慢SQL信息

-

--disable-agent

禁止agent行为

-

--include-databases

显性表明仅采集的数据库名,指定多个数据库时用逗号(,)隔开

-

--exclude-databases

显性表明不监控的数据库名,指定多个数据库时用逗号(,)隔开

-

--parallel

连接到openGauss的数据库连接池的大小

正整数

cmd-exporter的使用帮助详情:

usage:  [-h] [--constant-labels CONSTANT_LABELS]
                   [--web.listen-address WEB.LISTEN_ADDRESS]
                   [--web.listen-port WEB.LISTEN_PORT]
                   [--disable-https]
                   [--config CONFIG] [--ssl-keyfile SSL_KEYFILE]
                   [--ssl-certfile SSL_CERTFILE] [--ssl-ca-file SSL_CA_FILE]
                   [--parallel PARALLEL] [--log.filepath LOG.FILEPATH]
                   [--log.level {debug,info,warn,error,fatal}] [-v]

Command Exporter (DBMind): scrape metrics by performing shell commands.

optional arguments:
  -h, --help            show this help message and exit
  --constant-labels CONSTANT_LABELS
                        a list of label=value separated by comma(,).
  --web.listen-address WEB.LISTEN_ADDRESS
                        address on which to expose metrics and web interface
  --web.listen-port WEB.LISTEN_PORT
                        listen port to expose metrics and web interface
  --disable-https       disable Https scheme
  --config CONFIG       path to config dir or file.
  --ssl-keyfile SSL_KEYFILE
                        set the path of ssl key file
  --ssl-certfile SSL_CERTFILE
                        set the path of ssl certificate file
  --ssl-ca-file SSL_CA_FILE
                        set the path of ssl ca file
  --parallel PARALLEL   performing shell command in parallel.
  --log.filepath LOG.FILEPATH
                        the path to log
  --log.level {debug,info,warn,error,fatal}
                        only log messages with the given severity or above.
                        Valid levels: [debug, info, warn, error, fatal]
  -v, --version         show program's version number and exit

表 3 cmd-exporter的命令行参数详情表

参数

参数说明

取值范围

-h, --help

帮助选项

-

--disable-https

禁用Https协议

-

--ssl-keyfile

Https协议使用的证书私钥文件路径

-

--ssl-certfile

Https协议使用的证书文件路径

-

--ssl-ca-file

Https协议使用的CA证书文件路径

  

--web.listen-address

该exporter服务的绑定IP

-

--web.listen-port

该exporter服务的侦听端口

1024-65535

--config

显性指定的待采集指标配置文件路径

默认是该功能yamls目录下的default.yml文件,可以参考该配置文件格式,错误配置会报错

--log.filepath

日志文件保存路径,默认保存在当前目录下

-

--log.level

日志文件的打印级别,默认为INFO级别

debug, info, warn, error, fatal

--parallel

并行执行shell命令的并发度

正整数

--constant-labels

常量列表,k=v格式,用逗号隔开,表明该exporter自带的常量标签

格式如cluster_name=demo,cluster_id=1

--version

显示版本信息

-

标签:web,Exporter,log,--,ssl,Prometheus,disable,file,openGauss
From: https://www.cnblogs.com/renxyz/p/18141699

相关文章

  • openGauss Prometheus-Exporter组件使用指导
    使用指导用户可通过gs_dbmind命令启动对应的exporter。下面为用户演示一个完整的Prometheus监控平台的搭建过程。通过命令行进行Prometheus和所有exporter的启动:gs_dbmindcomponentdeployment--runprometheus和各个exporter单独的启动方式可以参考后续步骤,如果用户只采......
  • openGauss service子命令
    service子命令该子命令可用于对配置目录进行初始化,同时也可以实现启动和停止后台任务。配置目录初始化用户可通过gs_dbmindservicesetup子命令进行配置目录的初始化。该配置文件中可包括DBMind的配置文件、日志等内容。该目录中的部分文件说明:dbmind.conf:DBMind的参数配......
  • openGauss set子命令
    set子命令该命令用于修改配置文件dbmind.conf中的参数值,与用户手动修改配置文件dbmind.conf一般无差异。例如修改配置目录confpath中的配置文件dbmind.conf中TSDB配置部分,host参数的值,并将其设置为127.0.0.1。则可通过下述命令实现:gs_dbmindsetTSDBhost127.0.0.1-cconfpa......
  • openGauss Prometheus-Exporter组件常见问题处理
    常见问题处理提示需要用户提供--ssl-keyfile与--ssl-certfile选项:上述exporter默认采用Https模式通信,因此需要用户指定证书及其私钥文件的路径。相反,如果用户只想采用Http模式,则需要显性给定--disable-https选项,从而禁用Https协议。提示用户需要输入PEM密码(EnterPEMpass......
  • openGauss Prometheus-Exporter组件环境部署
    环境部署用户可以从Prometheus的官网上下载Prometheus-server和node-exporter,然后根据官方文档中的说明启动它们;也可以通过DBMind提供的快捷部署工具进行部署;如果用户自行部署,则可以跳到部署过程中为支持部署位置正确以及后续的运行和监测...。通过命令行进行Prometheus和......
  • openGauss plpython-fenced模式
    PLPythonFenced模式在fenced模式中添加plpython非安全语言。在数据库编译时需要将python集成进数据库中,在configure阶段加入--with-python选项。同时也可指定安装plpython的python路径,添加选项--with-includes='/python-dir=path'。在启动数据库之前配置GUC参数unix_socket_dir......
  • openGauss X-Tuner-参数调优与诊断获取帮助
    获取帮助启动调优程序之前,可以通过如下命令获取帮助信息:gs_dbmindcomponentxtuner--help输出帮助信息结果如下:usage:[-h][--databaseDATABASE][--db-userDB_USER][--db-portDB_PORT][--db-hostDB_HOST][--host-userHOST_USER][--host-ssh-portHOST_SSH_PORT......
  • openGauss X-Tuner-参数调优与诊断命令参考
    命令参考表1命令行参数参数参数说明取值范围mode指定调优程序运行的模式train,tune,recommend--tuner-config-file,-xX-Tuner的核心参数配置文件路径,默认路径为安装目录下的xtuner.conf---db-config-file,-f调优程序的用于登录到数据库宿主机上的连......
  • openGauss X-Tuner-参数调优与诊断使用示例
    使用示例X-Tuner支持三种模式,分别是获取参数诊断报告的recommend模式、训练强化学习模型的train模式、以及使用算法进行调优的tune模式。上述三种模式可以通过命令行参数来区别,通过配置文件来指定具体的细节。配置数据库连接信息三种模式连接数据库的配置项是相同的,有两种方式:......
  • openGauss workload级别索引推荐
    workload级别索引推荐对于workload级别的索引推荐,用户可通过运行数据库外的脚本使用此功能,本功能将包含有多条DML语句的workload作为输入,最终生成一批可对整体workload的执行表现进行优化的索引。同时,本功能提供从日志中或系统表中抽取业务数据SQL流水的功能。前提条件数据库......