mirantis/get-ucp-job-logs

docker-get-ucp-job-logs 镜像文档

镜像概述

docker-get-ucp-job-logs 是一个轻量级Docker镜像，用于从Docker Universal Control Plane (UCP) 服务器获取作业日志和相关信息。通过简单的环境变量配置，用户可以快速检索特定类型作业的执行日志或基本信息，帮助诊断UCP作业运行问题、监控作业状态及进行审计分析。

核心功能与特性

• 多作业类型支持：可获取"any"（任意类型）、"cleanup-db"（数据库清理）、"ldap-sync"（LDAP同步）等类型的作业数据
• 灵活数据获取：支持仅获取作业基本信息（如ID、状态、时间）或完整执行日志
• 自定义筛选：可指定获取作业的数量限制，或通过作业ID精准获取特定作业的日志
• 调试支持：提供DEBUG模式，便于问题排查
• 简单配置：通过环境变量即可完成所有参数配置，无需复杂的配置文件

使用场景

• UCP作业故障排查：获取失败作业的详细日志以分析错误原因
• 作业状态监控：定期获取作业基本信息，监控作业执行状态和频率
• 审计与合规：收集历史作业数据，满足审计需求
• LDAP同步或数据库清理作业的专项监控

使用方法与配置说明

环境变量配置

必填环境变量

可选环境变量

使用示例

1. 基本用法（获取指定类型的最近10个作业日志）

bash
docker run --rm \
  -e UCP_URL=ucp.example.com \
  -e USERNAME=username \
  -e PASSWORD=password \
  -e JOB_TYPE=ldap-sync \
  -e JOB_LIMIT=10 \
  -e JOB_INFO_ONLY=false \
  -e DEBUG=false \
  mirantis/get-ucp-job-logs

2. 仅获取作业基本信息

获取最近1个任意类型作业的基本信息（不包含详细日志）：

bash
docker run --rm \
  -e UCP_URL=ucp.example.com \
  -e USERNAME=username \
  -e PASSWORD=password \
  -e JOB_TYPE=any \
  -e JOB_LIMIT=1 \
  -e JOB_INFO_ONLY=true \
  mirantis/get-ucp-job-logs

输出示例：

json
{
  "id": "b9f9acab-1dd8-4299-a53c-6b02ff8cb2b0",
  "workerID": "c0196a58-ff85-449d-baaf-0cfc5b144a43",
  "status": "error",
  "scheduledAt": "2017-12-15T22:00:00Z",
  "lastUpdated": "2017-12-15T22:00:10.174Z",
  "action": "ldap-sync",
  "args": [],
  "errorMessage": "process exited with error: exit status 1"
}

3. 获取特定作业ID的详细日志

bash
docker run --rm \
  -e UCP_URL=ucp.example.com \
  -e USERNAME=username \
  -e PASSWORD=password \
  -e JOB_INFO_ONLY=false \
  -e DEBUG=false \
  -e JOB_ID=eebf554d-e061-4d63-b910-5c4c5aa02083 \
  mirantis/get-ucp-job-logs

输出示例（包含完整日志）：

====== BEGIN job logs from eebf554d-e061-4d63-b910-5c4c5aa02083 ======
{
  "id": "eebf554d-e061-4d63-b910-5c4c5aa02083",
  "workerID": "c0196a58-ff85-449d-baaf-0cfc5b144a43",
  "status": "error",
  "scheduledAt": "2017-12-15T20:00:00Z",
  "lastUpdated": "2017-12-15T20:00:10.163Z",
  "action": "ldap-sync",
  "args": [],
  "errorMessage": "process exited with error: exit status 1"
}

{"level":"info","msg":"connecting to db ...","time":"2017-12-15T20:00:00Z"}
{"level":"debug","msg":"connecting to DB Addrs: [192.168.1.61:***]","time":"2017-12-15T20:00:00Z"}
...（完整日志内容）...
====== END job logs from eebf554d-e061-4d63-b910-5c4c5aa02083 ======