openGauss AI特性指南：DBMind的支持组件 open basedir

获取帮助

用户可以使用–help命令获取帮助信息。例如：

gs_dbmind 组件opengauss_exporter –help

gs_dbmind 组件reprocessing_exporter –help

gs_dbmind 组件cmd_exporter –help

命令参考

使用重新处理导出器的更多帮助：

gs_dbmind 组件reprocessing_exporter –help

use: [-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 {调试、信息、警告、错误、致命}] [-v]

prometheus_host prometheus_port

Reprocessing Exporter: 对Prometheus 服务器上存储的指标进行重新处理模块。

位置参数：

prometheus_host 从中提取数据的主机。

prometheus_port 连接Prometheus 主机的端口

可选参数：

-h, –help 显示此帮助消息并退出

–disable-https 禁用HTTPS 方案

–ssl-keyfile SSL_KEYFILE

设置ssl密钥文件路径

–ssl-certfile SSL_CERTFILE

设置SSL证书文件路径

–ssl-ca-文件SSL_CA_FILE

设置ssl ca文件的路径

–web.listen-address WEB.LISTEN_ADDRESS

发布指标和Web界面的地址

–web.listen-port WEB.LISTEN_PORT

用于公开指标和Web 界面的监听端口

–collector.config 收集器.CONFIG

根据yaml 文件的内容进行指标收集

–log.filepath 日志.filepath

日志路径

–log.level {调试、信息、警告、错误、致命}

仅记录指定严重性或更高严重性的消息。有效级别： [调试、信息、警告、错误、致命]。

-v, –version 显示程序版本号并退出

表1 Reprocessing-exporter 命令行参数详细信息

参数

参数说明

范围

普罗米修斯主机

普罗米修斯服务器IP地址

–

普罗米修斯端口

Prometheus服务器服务监听端口号

1024-65535

-h，–帮助

帮助选项

–

–禁用-https

禁用HTTPS 协议

–

–ssl 密钥文件

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

–

–ssl-证书文件

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

–

–ssl-ca-文件

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

–web.监听地址

导出器服务绑定IP

–

–web.监听端口

Exporter服务监听端口

1024-65535

–collector.config

明确指定要收集的指标配置文件的路径

–

–log.文件路径

日志文件保存路径。默认情况下，它将保存在当前目录中。

–

–日志级别

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

调试、信息、警告、错误、致命

– 版本

显示版本信息

–

有关使用OpenGauss-exporter 的更多帮助：

gs_dbmind 组件opengauss_exporter –help

use: [-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 ] [ – 平行线]

[–log.filepath LOG.FILEPATH] [–log.level {调试、信息、警告、错误、致命}] [-v]

openGauss Exporter (DBMind): 监视或控制openGauss。

可选参数：

-h, –help 显示此帮助消息并退出

–url URL openGauss数据库的目标URL。我们建议通过此URL 连接到postgres 数据库，以便导出器可以主动发现和监控其他数据库。

–config-文件CONFIG_FILE, –config CONFIG_FILE

配置文件的路径。

–include-数据库INCLUDE_DATABASES

仅从指定的数据库列表获取指标。标签=值的列表，以逗号（，）分隔。

–排除数据库EXCLUDE_DATABASES

从所有自动发现的数据库获取指标，逗号(,) 分隔的数据库列表除外。

–常量标签CONSTANT_LABELS

以逗号(,) 分隔的label=values 列表。

–web.listen-address WEB.LISTEN_ADDRESS

发布指标和Web界面的地址

–web.listen-port WEB.LISTEN_PORT

用于公开指标和Web 界面的监听端口

–disable-cache 强制不使用缓存。

–禁用设置指标

pg_settings.yml 不收集指标。

–禁用语句历史指标

不收集语句历史记录指标（包括慢查询）。

–disable-https 禁用HTTPS 方案

–disable-agent 默认情况下，此导出程序还承担DBMnd-Agent 的角色。即，使用该参数执行DBMnd服务发出的数据库操作和维护操作。

用户可以禁用代理功能以防止DBMind 服务对数据库进行更改。

–ssl-keyfile SSL_KEYFILE

设置ssl密钥文件路径

–ssl-certfile SSL_CERTFILE

设置ssl证书文件路径

–ssl-ca-文件SSL_CA_FILE

设置ssl ca文件的路径

–Parallel PARALLEL 不收集pg_settings.yml 指标。

–log.filepath 日志.filepath

日志路径

–log.level {调试、信息、警告、错误、致命}

仅记录指定严重性或更高严重性的消息。有效级别： [调试、信息、警告、错误、致命]。

-v, –version 显示程序版本号并退出

表2 openGauss-exporter命令行参数详细信息

参数

参数说明

范围

–网址

数据库服务器连接地址（例如postgres://user:pwd@host:port/dbname）

对于URL中的每个字段，如果URL中包含特殊字符（@、/等），则必须通过URL编码对其进行转义。例如，密码中的“@”必须转义为%40。 \’/\’ 必须转义为%2F。否则，每个字段的含义将被错误地识别和分割。 URL地址转义规则遵循RFC-1738标准。

–常量标签

以逗号分隔的常量列表，采用k=v 格式，指示导出器附带的常量标签。

格式类似于cluster_name=demo,cluster_id=1。

-h，–帮助

帮助选项

–

–禁用-https

禁用HTTPS 协议

–

–ssl 密钥文件

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

–

–ssl-证书文件

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

–

–ssl-ca-文件

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

–

–web.监听地址

导出器服务绑定IP

–

–web.监听端口

Exporter服务监听端口

1024-65535

–config, –config 文件

明确指定要收集的指标配置文件的路径

–

–log.文件路径

日志文件保存路径。默认情况下，它将保存在当前目录中。

–

–日志级别

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

调试、信息、警告、错误、致命

– 版本

显示版本信息

–

–禁用缓存

禁用缓存

–

–禁用设置指标

禁用从pg_settings 表收集值

–

–禁用语句历史指标

禁用在Statement_history表中收集慢SQL信息

–

–禁用代理

防止代理操作

–

–包括数据库

指定多个数据库时，仅指定需要收集的数据库名称，以逗号（,）分隔。

–

–排除数据库

如果要指定多个不监控的数据库名，请用逗号（,）分隔。

–

– 平行线

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

正整数

使用cmd-exporter 的更多帮助：

用法： [-h] [–常量标签CONSTANT_LABELS]

[–web.listen-address WEB.LISTEN_ADDRESS]

[–web.listen-port WEB.LISTEN_PORT]

[–禁用-https]

[–config CONFIG] [–ssl-keyfile SSL_KEYFILE]

[–ssl-certfile SSL_CERTFILE] [–ssl-ca-file SSL_CA_FILE]

[–并行并行] [–log.filepath LOG.FILEPATH]

[–log.level {调试、信息、警告、错误、致命}] [-v]

命令导出器(DBMind): 运行shell 命令并收集指标。

可选参数：

-h, –help 显示此帮助消息并退出

–常量标签CONSTANT_LABELS

以逗号(,) 分隔的label=values 列表。

–web.listen-address WEB.LISTEN_ADDRESS

发布指标和Web界面的地址

–web.listen-port WEB.LISTEN_PORT

用于公开指标和Web 界面的监听端口

–disable-https 禁用HTTPS 方案

–config config 配置目录或文件的路径。

–ssl-keyfile SSL_KEYFILE

设置ssl密钥文件路径

–ssl-certfile SSL_CERTFILE

设置SSL证书文件路径

–ssl-ca-文件SSL_CA_FILE

设置ssl ca文件的路径

–Parallel PARALLEL 并行执行shell 命令。

–log.filepath 日志.filepath

日志路径

–log.level {调试、信息、警告、错误、致命}

仅记录指定严重性或更高严重性的消息。

有效级别： [调试、信息、警告、错误、致命]

-v, –version 显示程序版本号并退出

表3 cmd-exporter命令行参数详细信息

参数

参数说明

范围

-h，–帮助

帮助选项

–

–禁用-https

禁用HTTPS 协议

–

–ssl 密钥文件

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

–

–ssl-证书文件

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

–

–ssl-ca-文件

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

–web.监听地址

导出器服务绑定IP

–

–web.监听端口

Exporter服务监听端口

1024-65535

–配置

明确指定要收集的指标配置文件的路径

默认值是位于函数yamls 目录中的default.yml 文件。如果配置文件格式错误，则会报错。

–log.文件路径

日志文件保存路径。默认情况下，它将保存在当前目录中。

–

–日志级别

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

调试、信息、警告、错误、致命

– 平行线

并行执行shell命令的并发性

正整数

–常量标签

k=v 格式的逗号分隔常量列表，指示导出器附带的常量标签。

格式类似于cluster_name=demo,cluster_id=1。

– 版本

显示版本信息

–

#openGauss 以上AI特性指南：DBMnd支持组件相关内容来源网络仅供参考。相关信息请参见官方公告。