aerospike/aerospike-prometheus-exporter

Aerospike Prometheus Exporter 镜像

概述

Aerospike Prometheus Exporter 镜像由Aerospike官方提供，用于从Aerospike数据库服务器节点收集性能指标，并将这些指标导出为Prometheus可识别的格式，以便进行监控和分析。该镜像支持灵活的配置选项，包括TLS加密、身份认证及指标过滤，适用于各种环境下的Aerospike集群监控需求。

更多详情

• https://github.com/aerospike/aerospike-prometheus-exporter
• https://github.com/aerospike/aerospike-monitoring

核心功能与特性

• 全面指标收集：支持收集Aerospike节点、命名空间、集合、XDR、作业（扫描/查询）及二级索引等多维度指标
• 灵活配置：通过环境变量或自定义配置文件进行配置，支持TLS加密（包括双向TLS）
• 安全认证：提供基本HTTP认证及Aerospike数据库认证支持
• 指标过滤：支持通过允许列表（Allowlist）和阻止列表（Blocklist）控制指标收集范围
• 日志管理：可配置日志级别和日志输出路径
• 高可扩展性：支持自定义指标标签，便于多环境指标区分

使用场景

• Aerospike数据库集群的实时性能监控
• 生产/开发/测试环境中Aerospike节点健康状态追踪
• 与Prometheus+Grafana组合构建Aerospike监控仪表盘
• 大规模Aerospike部署的指标集中收集与分析

使用方法

快速启动

使用以下命令快速启动 exporter 容器：

bash
docker run -itd --name exporter1 -e AS_HOST=172.17.0.2 -e AS_PORT=3000 -e METRIC_LABELS="type='development',source='aerospike'" docker.xuanyuan.run/aerospike/aerospike-prometheus-exporter:latest

关键环境变量说明：

• AS_HOST：Aerospike服务器节点IP地址
• AS_PORT：Aerospike服务器客户端访问端口

详细配置

配置方式

所有配置均可通过在docker run命令或docker-compose.yaml文件中设置对应的环境变量实现。

配置文件参考

以下是完整的配置文件模板（TOML格式），其中环境变量占位符需通过容器环境变量替换：

toml
[Agent]
# Exporter HTTPS (TLS) 配置
# Prometheus与Exporter之间的HTTPS通信

# TLS证书。
# 支持以下格式：
# 1. 证书文件路径                                      - "file:<文件路径>"
# 2. 包含base64编码证书的环境变量 - "env-b64:<包含base64编码证书的环境变量>"
# 3. Base64编码的证书                                 - "b64:<base64编码的证书>"
# 适用于'root_ca'、'cert_file'和'key_file'配置。

# 服务器证书
cert_file = "${AGENT_CERT_FILE}"

# 与服务器证书关联的私钥
key_file = "${AGENT_KEY_FILE}"

# 用于验证客户端证书的根CA（双向TLS）
root_ca = "${AGENT_ROOT_CA}"

# 加密key_file的密码。支持以下格式：
# 1. 直接指定密码                                                      - "<密码>"
# 2. 通过文件指定密码                                                      - "file:<包含密码的文件>"
# 3. 通过环境变量指定密码                                      - "env:<存储密码的环境变量>"
# 4. 通过包含base64编码密码的环境变量 - "env-b64:<包含base64编码密码的环境变量>"
# 5. Base64编码的密码                                        - "b64:<base64编码的密码>"
key_file_passphrase = "${AGENT_KEY_FILE_PASSPHRASE}"

# 添加到Prometheus指标的标签，例如 labels={zone="asia-south1-a", platform="google compute engine"}
labels = {${METRIC_LABELS}}

# 绑定地址和端口
bind = "${AGENT_BIND_HOST}:${AGENT_BIND_PORT}"

# 指标服务器超时时间（秒）
timeout = ${AGENT_TIMEOUT}

# Exporter日志配置
# 日志文件路径（可选，默认输出到控制台）
# 日志级别：info|warning,warn|error,err|debug|trace（默认info）
log_file = "${AGENT_LOG_FILE}"
log_level = "${AGENT_LOG_LEVEL}"

# '/metrics'端点的基本HTTP认证。
# 支持以下格式：
# 1. 直接指定凭证                                                      - "<凭证>"
# 2. 通过文件指定凭证                                                      - "file:<包含凭证的文件>"
# 3. 通过环境变量指定凭证                                      - "env:<存储凭证的环境变量>"
# 4. 通过包含base64编码凭证的环境变量 - "env-b64:<包含base64编码凭证的环境变量>"
# 5. Base64编码的凭证                                        - "b64:<base64编码的凭证>"
basic_auth_username="${BASIC_AUTH_USERNAME}"
basic_auth_password="${BASIC_AUTH_PASSWORD}"

[Aerospike]
# 数据库主机地址
db_host="${AS_HOST}"
# 数据库端口
db_port=${AS_PORT}

# TLS证书。
# 支持以下格式：
# 1. 证书文件路径                                      - "file:<文件路径>"
# 2. 包含base64编码证书的环境变量 - "env-b64:<包含base64编码证书的环境变量>"
# 3. Base64编码的证书                                 - "b64:<base64编码的证书>"
# 适用于'root_ca'、'cert_file'和'key_file'配置。

# 根证书文件
root_ca="${AS_ROOT_CA}"

# 证书文件
cert_file="${AS_CERT_FILE}"

# 密钥文件
key_file="${AS_KEY_FILE}"

# 加密key_file的密码。支持以下格式：
# 1. 直接指定密码                                                      - "<密码>"
# 2. 通过文件指定密码                                                      - "file:<包含密码的文件>"
# 3. 通过环境变量指定密码                                      - "env:<存储密码的环境变量>"
# 4. 通过包含base64编码密码的环境变量 - "env-b64:<包含base64编码密码的环境变量>"
# 5. Base64编码的密码                                        - "b64:<base64编码的密码>"
key_file_passphrase="${AS_KEY_FILE_PASSPHRASE}"

# 用于认证的节点TLS名称
node_tls_name="${AS_NODE_TLS_NAME}"

# Aerospike集群安全凭证。
# 支持以下格式：
# 1. 直接指定凭证                                                      - "<凭证>"
# 2. 通过文件指定凭证                                                      - "file:<包含凭证的文件>"
# 3. 通过环境变量指定凭证                                      - "env:<存储凭证的环境变量>"
# 4. 通过包含base64编码凭证的环境变量 - "env-b64:<包含base64编码凭证的环境变量>"
# 5. Base64编码的凭证                                        - "b64:<base64编码的凭证>"
# 适用于'user'和'password'配置。

# 数据库用户名
user="${AS_AUTH_USER}"

# 数据库密码
password="${AS_AUTH_PASSWORD}"

# 认证模式：internal（服务器内置）、external（LDAP等外部认证）
auth_mode="${AS_AUTH_MODE}"

# 向服务器节点发送命令的超时时间（秒）
timeout=${TICKER_TIMEOUT}

# 延迟指标导出的直方图桶数量。桶阈值范围从2^0到2^16（共17个桶）。
# 例如，latency_buckets_count=5将导出前5个桶，即<=1ms、<=2ms、<=4ms、<=8ms和<=16ms。
# 默认值：0（导出所有阈值桶）。
latency_buckets_count=${LATENCY_BUCKETS_COUNT}

# 指标允许列表 - 如指定，仅收集这些指标。空列表将排除所有指标。
# 注释掉以下允许列表配置将禁用指标过滤（即收集所有指标）。

# 命名空间指标允许列表
# namespace_metrics_allowlist=[${NAMESPACE_METRICS_ALLOWLIST}]

# 集合指标允许列表
# set_metrics_allowlist=[${SET_METRICS_ALLOWLIST}]

# 节点指标允许列表
# node_metrics_allowlist=[${NODE_METRICS_ALLOWLIST}]

# XDR指标允许列表（仅适用于Aerospike 5.0及以上版本）
# xdr_metrics_allowlist=[${XDR_METRICS_ALLOWLIST}]

# 作业（扫描/查询）指标允许列表
# job_metrics_allowlist = [${JOB_METRICS_ALLOWLIST}]

# 二级索引指标允许列表
# sindex_metrics_allowlist = [${SINDEX_METRICS_ALLOWLIST}]

# 指标阻止列表 - 如指定，这些指标将不被收集。

# 命名空间指标阻止列表
# namespace_metrics_blocklist=[${NAMESPACE_METRICS_BLOCKLIST}]

# 集合指标阻止列表
# set_metrics_blocklist=[${SET_METRICS_BLOCKLIST}]

# 节点指标阻止列表
# node_metrics_blocklist=[${NODE_METRICS_BLOCKLIST}]

# XDR指标阻止列表（仅适用于Aerospike 5.0及以上版本）
# xdr_metrics_blocklist=[${XDR_METRICS_BLOCKLIST}]

# 作业（扫描/查询）指标阻止列表
# job_metrics_blocklist = [${JOB_METRICS_BLOCKLIST}]

# 二级索引指标阻止列表
# sindex_metrics_blocklist = [${SINDEX_METRICS_BLOCKLIST}]

# 用户统计（用户统计仅在Aerospike 5.6+版本可用）
# 用户允许列表和阻止列表用于控制收集哪些用户的统计信息。
# 注意：此配置不支持通配符模式。

# user_metrics_users_allowlist=[${USER_METRICS_USERS_ALLOWLIST}]
# user_metrics_users_blocklist=[${USER_METRICS_USERS_BLOCKLIST}]

使用自定义配置文件

如需使用自定义配置文件，可通过--config选项指定容器内的配置文件路径，并通过卷挂载本地配置文件：

bash
docker run -itd --name exporter1 -v <主机上的配置文件路径>:<容器内的配置文件路径> docker.xuanyuan.run/aerospike/aerospike-prometheus-exporter:latest --config <容器内的配置文件路径>

示例：

bash
docker run -itd --name exporter1 -v /host/config.toml:/app/config.toml docker.xuanyuan.run/aerospike/aerospike-prometheus-exporter:latest --config /app/config.toml