phsmith/rundeck-exporter

Rundeck指标导出器，用于通过Prometheus监控Rundeck，通过API获取系统信息、指标、项目执行情况等数据，支持Rundeck API 31+版本，可导出CPU、内存使用及项目执行状态等Prometheus格式指标。

0 次下载activephsmith镜像

🚀轩辕镜像专业版更稳定💎一键安装 Docker 配置镜像源

中文简介版本下载

🚀轩辕镜像专业版更稳定💎一键安装 Docker 配置镜像源

Rundeck Prometheus指标导出器

![Docker Pulls]([] ![GitHub release (latest SemVer)]([]

!Rundeck-Grafana-Dashboard

示例仪表盘可在examples/grafana中找到

该导出器使用prometheus_client和requests Python模块，暴露Rundeck的以下指标：

RUNDECK_URL/api_version/system/info
RUNDECK_URL/api_version/metrics/metrics
RUNDECK_URL/api_version/project/project_name/executions
RUNDECK_URL/api_version/project/project_name/executions/running

其中version代表Rundeck API版本，如：31、32、33、34等。此代码已在Rundeck API 31+版本上测试通过。

[!Warning]

自4.x.x版本起，/api/<version>/metrics端点默认禁用，需在rundeck-config.properties中启用，或为Rundeck设置环境变量RUNDECK_METRICS_ENABLED=true以使导出器正常工作。详见config-file-reference.html#metrics-capturing

若启用审计日志，建议将默认日志级别从INFO调整，以防止日志过度增长。

指标

所有指标均以rundeck_ 为前缀导出。有关指标的详细信息可在文档中查看。

依赖

尽管仍提供requirements.txt文件，项目已使用UV进行Python包管理，推荐使用UV。

Python 3.10+
具有API请求权限的Rundeck令牌

安装依赖步骤：

sh
uv sync

或：

sh
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

API认证

需提供Rundeck令牌或用户名密码。令牌（RUNDECK_TOKEN）或密码（RUNDECK_USERPASSWORD）必须通过环境变量传递。与令牌/用户关联的ACL需至少包含以下策略规则：

system:read（系统上下文）
project:read（系统上下文）
events:read（项目上下文）

允许用户exporter获取系统指标及所有项目执行指标的ACL策略示例：

yaml
  by:
    username: exporter
  description: system:read
  for:
    resource:
    - allow:
      - read
      equals:
        kind: system
  context:
    application: rundeck
---
by:
  username: exporter
description: project:read
for:
  project:
  - allow:
    - read
    match:
      name: .*
context:
  application: rundeck
---
by:
  username: exporter
description: events:read
for:
  resource:
  - allow:
    - read
    equals:
      kind: event
  job:
  - allow:
    - read
    - view
context:
  project: .*
---
by:
  username: exporter
description: 允许节点的[read]权限
for:
  node:
  - allow:
    - read
    match:
      nodename: .*
context:
  project: .*

---
by:
  username: exporter
description: 允许所有节点的[read]权限
for:
  resource:
  - allow:
    - read
    equals:
      kind: node
context:
  project: .*

使用方法

rundeck_exporter支持以下参数：

text
$ rundeck_exporter --help

usage: rundeck_exporter [-h] [--debug] [-v] [--host RUNDECK_EXPORTER_HOST] [--port RUNDECK_EXPORTER_PORT] [--no_checks_in_passive_mode] [--threadpool_max_workers RUNDECK_EXPORTER_THREADPOOL_MAX_WORKERS] [--rundeck.requests.timeout RUNDECK_EXPORTER_REQUESTS_TIMEOUT] [--rundeck.url RUNDECK_URL] [--rundeck.skip_ssl] [--rundeck.api.version RUNDECK_API_VERSION]
                           [--rundeck.username RUNDECK_USERNAME] [--rundeck.projects.executions] [--rundeck.projects.executions.filter RUNDECK_PROJECT_EXECUTIONS_FILTER] [--rundeck.projects.executions.limit RUNDECK_PROJECTS_EXECUTIONS_LIMIT] [--rundeck.projects.executions.cache] [--rundeck.projects.filter RUNDECK_PROJECTS_FILTER [RUNDECK_PROJECTS_FILTER ...]]
                           [--rundeck.projects.nodes.info] [--rundeck.cached.requests.ttl RUNDECK_CACHED_REQUESTS_TTL] [--rundeck.cpu.stats] [--rundeck.memory.stats]

Rundeck指标导出器

required environment vars:
    RUNDECK_TOKEN        Rundeck API令牌
    RUNDECK_USERPASSWORD Rundeck用户密码（同时需要RUNDECK_USERNAME或--rundeck.username）

options:
  -h, --help            显示帮助信息并退出
  --debug               启用调试模式
  -v, --version         显示rundeck_exporter当前版本
  --host RUNDECK_EXPORTER_HOST
                        绑定地址，默认：127.0.0.1
  --port RUNDECK_EXPORTER_PORT
                        绑定端口，默认：9620
  --no_checks_in_passive_mode
                        当Rundeck主机处于被动执行模式时，不执行任何检查
  --threadpool_max_workers RUNDECK_EXPORTER_THREADPOOL_MAX_WORKERS
                        异步检查的线程池最大工作线程数，默认：(CPU数量) + 4
  --rundeck.requests.timeout RUNDECK_EXPORTER_REQUESTS_TIMEOUT
                        Rundeck API请求超时时间（秒）
  --rundeck.url RUNDECK_URL
                        Rundeck基础URL [必填]
  --rundeck.skip_ssl    跳过SSL证书验证
  --rundeck.api.version RUNDECK_API_VERSION
                        Rundeck API版本，默认：34
  --rundeck.username RUNDECK_USERNAME
                        具有系统信息访问权限的Rundeck用户
  --rundeck.projects.executions
                        获取项目执行指标
  --rundeck.projects.executions.filter RUNDECK_PROJECT_EXECUTIONS_FILTER
                        按时间段筛选最新项目执行，格式：[s]秒、[n]分钟、[h]小时、[d]天、[w]周、[m]月、[y]年，默认：5n
  --rundeck.projects.executions.limit RUNDECK_PROJECTS_EXECUTIONS_LIMIT
                        每个查询的项目执行结果最大数量，默认：20
  --rundeck.projects.executions.cache
                        缓存项目执行指标查询请求
  --rundeck.projects.filter RUNDECK_PROJECTS_FILTER [RUNDECK_PROJECTS_FILTER ...]
                        仅获取指定项目的执行指标（空格分隔）
  --rundeck.projects.nodes.info
                        显示项目节点信息指标（当前仅支持`rundeck_project_nodes_total`），项目数量较多时可能导致高CPU负载
  --rundeck.cached.requests.ttl RUNDECK_CACHED_REQUESTS_TTL
                        缓存请求过期时间（秒），默认：120
  --rundeck.cpu.stats   显示Rundeck CPU使用统计
  --rundeck.memory.stats
                        显示Rundeck内存使用统计

可选地，可通过以下环境变量配置rundeck_exporter：

变量	选项	描述
RUNDECK_EXPORTER_DEBUG	True False（默认）	启用调试模式
RUNDECK_EXPORTER_HOST	默认：127.0.0.1	绑定地址
RUNDECK_EXPORTER_PORT	默认：9620	绑定端口
RUNDECK_URL（必填）		Rundeck基础URL
RUNDECK_TOKEN（必填）		Rundeck API令牌
RUNDECK_USERNAME		具有系统信息访问权限的Rundeck用户
RUNDECK_USERPASSWORD		Rundeck用户密码（需同时提供RUNDECK_USERNAME或--rundeck.username）
RUNDECK_API_VERSION	默认：41	Rundeck API版本
RUNDECK_SKIP_SSL	True False（默认）	跳过SSL证书检查
RUNDECK_PROJECTS_EXECUTIONS	True False（默认）	获取项目执行指标
RUNDECK_PROJECTS_FILTER		仅获取指定项目的执行指标，如："project-1 project-2 ..."
RUNDECK_PROJECT_EXECUTIONS_FILTER	默认：5n	按时间段筛选项目执行，格式：[s]秒、[n]分钟、[h]小时、[d]天、[w]周、[m]月、[y]年
RUNDECK_PROJECTS_EXECUTIONS_LIMIT	默认：20	每个查询的项目执行结果最大数量
RUNDECK_PROJECTS_EXECUTIONS_CACHE	True False（默认）	缓存项目执行指标查询请求
RUNDECK_PROJECTS_NODES_INFO	True False（默认）	显示项目节点信息指标（当前仅支持`rundeck_project_nodes_total`），项目数量较多时可能导致高CPU负载
RUNDECK_CACHED_REQUESTS_TTL	默认：120	缓存请求过期时间（秒）
RUNDECK_CPU_STATS	True False（默认）	显示Rundeck CPU使用统计
RUNDECK_MEMORY_STATS	True False（默认）	显示Rundeck内存使用统计
RUNDECK_EXPORTER_NO_CHECKS_IN_PASSIVE_MODE	True False（默认）	当Rundeck主机处于被动执行模式时，不执行任何检查
RUNDECK_EXPORTER_THREADPOOL_MAX_WORKERS	默认：(CPU数量) + 4	异步检查的线程池最大工作线程数
RUNDECK_EXPORTER_REQUESTS_TIMEOUT	默认：30	Rundeck API请求超时时间（秒）

示例

sh
$ RUNDECK_TOKEN=xxxxxxxx uv run rundeck_exporter \
    --host=0.0.0.0 \
    --rundeck.url=http://localhost:4440 \
    --rundeck.skip_ssl \
    --rundeck.cpu.stats \
    --rundeck.memory.stats \
    --rundeck.projects.filter="project-1 project-2 project-n" \
    --rundeck.projects.executions \
    --rundeck.projects.executions.filter=5n \
    --rundeck.requests.timeout=10

从PyPI运行

sh
pip install rundeck-exporter
rundeck_exporter -v

使用Docker运行

sh
docker build -t rundeck-exporter .

docker run --rm -d -p 9620:9620 -e RUNDECK_TOKEN=$RUNDECK_TOKEN rundeck-exporter \
--host 0.0.0.0 \
--rundeck.url [***] \
--rundeck.skip_ssl

使用Docker Compose运行

sh
cd examples/docker-compose
docker compose up -d

Docker Compose服务包含：

Rundeck - http://localhost:4440
Rundeck Exporter - http://localhost:9620
Prometheus - http://localhost:9090（已配置抓取rundeck_exporter指标）
Grafana - http://localhost:3000（已配置Prometheus数据源和Rundeck仪表盘）

Docker Compose服务启动后，访问Rundeck的http://localhost:4440/user/profile生成新API令牌，将令牌填入docker-compose.yml的RUNDECK_TOKEN环境变量，然后再次运行docker compose up -d。===SHORT_DESC=== Rundeck指标导出器，用于通过Prometheus监控Rundeck，通过API获取系统信息、指标、执行情况等数据，支持Rundeck API 31+版本，可导出系统状态、项目执行及资源使用等Prometheus格式指标。 ===FULL_DESC===

Rundeck Prometheus指标导出器

![Docker Pulls]([] ![GitHub release (latest SemVer)]([]

!Rundeck-Grafana-Dashboard

示例仪表盘可在examples/grafana中找到

该导出器使用prometheus_client和requests Python模块，暴露通过以下Rundeck API端点获取的指标：

RUNDECK_URL/api_version/system/info
RUNDECK_URL/api_version/metrics/metrics
RUNDECK_URL/api_version/project/project_name/executions
RUNDECK_URL/api_version/project/project_name/executions/running

其中api_version代表Rundeck API版本，如：31、32、33、34等。此代码已在Rundeck API 31+版本上测试通过。

[!Warning]

自4.x.x版本起，/api/<version>/metrics端点默认禁用，需在rundeck-config.properties中启用，或为Rundeck设置环境变量RUNDECK_METRICS_ENABLED=true以使导出器正常工作。详见config-file-reference.html#metrics-capturing

若启用审计日志，建议将默认日志级别从INFO调整，以防止日志过度增长。

指标

所有指标均以rundeck_ 为前缀导出。有关指标的详细信息可在文档中查看。

依赖

尽管仍提供requirements.txt文件，项目已使用UV进行Python包管理，推荐使用UV。

Python 3.10+
具有API请求权限的Rundeck令牌

安装依赖步骤：

sh
uv sync

或：

sh
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

API认证

需提供Rundeck令牌或用户名密码。令牌（RUNDECK_TOKEN）或密码（RUNDECK_USERPASSWORD）必须通过环境变量传递。与令牌/用户关联的ACL需至少包含以下策略规则：

system:read（系统上下文）
project:read（系统上下文）
events:read（项目上下文）

允许用户exporter获取系统指标及所有项目

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

5

"Docker加速体验非常流畅，大镜像也能快速完成下载。"

常见问题

Q1:轩辕镜像免费版与专业版有什么区别？

免费版仅支持 Docker Hub 加速，不承诺可用性和速度；专业版支持更多镜像源，保证可用性和稳定速度，提供优先客服响应。

Q2:轩辕镜像免费版与专业版有分别支持哪些镜像？

免费版仅支持 docker.io；专业版支持 docker.io、gcr.io、ghcr.io、registry.k8s.io、nvcr.io、quay.io、mcr.microsoft.com、docker.elastic.co 等。

Q3:流量耗尽错误提示

当返回 402 Payment Required 错误时，表示流量已耗尽，需要充值流量包以恢复服务。

Q4:410 错误问题

通常由 Docker 版本过低导致，需要升级到 20.x 或更高版本以支持 V2 协议。

Q5:manifest unknown 错误

先检查 Docker 版本，版本过低则升级；版本正常则验证镜像信息是否正确。

Q6:镜像拉取成功后，如何去掉轩辕镜像域名前缀？

使用 docker tag 命令为镜像打上新标签，去掉域名前缀，使镜像名称更简洁。

查看全部问题→

轩辕镜像下载加速使用手册

探索更多轩辕镜像的使用方法，找到最适合您系统的配置方式

登录仓库拉取

通过 Docker 登录认证访问私有仓库

Linux

在 Linux 系统配置镜像加速服务

Windows/Mac

在 Docker Desktop 配置镜像加速

Docker Compose

Docker Compose 项目配置加速

K8s Containerd

Kubernetes 集群配置 Containerd

宝塔面板

在宝塔面板一键配置镜像加速

群晖

Synology 群晖 NAS 配置加速

飞牛

飞牛 fnOS 系统配置镜像加速

极空间

极空间 NAS 系统配置加速服务

爱快路由

爱快 iKuai 路由系统配置加速

绿联

绿联 NAS 系统配置镜像加速

威联通

QNAP 威联通 NAS 配置加速

Podman

Podman 容器引擎配置加速

Singularity/Apptainer

HPC 科学计算容器配置加速

其他仓库配置

ghcr、Quay、nvcr 等镜像仓库

专属域名拉取

无需登录使用专属域名加速

需要其他帮助？请查看我们的常见问题或官方QQ群: 13763429

rundeck-exporter Docker 镜像下载 - 轩辕镜像

rundeck-exporter 镜像详细信息和使用指南

rundeck-exporter 镜像标签列表和版本信息

rundeck-exporter 镜像拉取命令和加速下载

rundeck-exporter 镜像使用说明和配置指南

Docker 镜像加速服务 - 轩辕镜像平台

国内开发者首选的 Docker 镜像加速平台

极速拉取 Docker 镜像服务

相关 Docker 镜像推荐

热门 Docker 镜像下载

rundeck-exporter 镜像详细信息

rundeck-exporter 镜像标签列表

rundeck-exporter 镜像使用说明

rundeck-exporter 镜像拉取命令

Docker 镜像加速服务

轩辕镜像平台优势

镜像下载指南

相关 Docker 镜像推荐

rundeck-exporter 镜像详细说明

rundeck-exporter 使用指南

rundeck-exporter 配置说明

rundeck-exporter 官方文档

Rundeck Prometheus指标导出器

指标

依赖

API认证

使用方法

示例

从PyPI运行

使用Docker运行

使用Docker Compose运行

Rundeck Prometheus指标导出器

指标

依赖

API认证

用户好评

oldzhang

常见问题

轩辕镜像下载加速使用手册

登录仓库拉取

Linux

Windows/Mac

Docker Compose

K8s Containerd

宝塔面板

群晖

飞牛

极空间

爱快路由

绿联

威联通

Podman

Singularity/Apptainer

其他仓库配置

专属域名拉取