在Jenkins中触发任务并在同一页上获取任务日志

111次阅读

问题描述

在使用Jenkins时，希望能够在触发任务的同时，在同一页上获取任务的日志。他形容这个需求类似于某些集成开发环境（IDE），其中我们可以在一侧运行代码，而在另一侧获取输出结果。用户想知道是否存在可以满足这一需求的工具，或者是否需要自行创建解决方案。

解决方案

请注意以下操作可能涉及插件的使用，以及对Jenkins的配置更改。操作前请做好备份。

方案1

Jenkins中存在一个插件可以满足您的需求：Display Console Output Plugin。
该插件的作用是在项目页面上显示最新的控制台日志。您可以尝试使用这个插件来实现在触发任务后，直接在同一页上查看任务的日志输出。然而，请注意，这个插件可能已经不再维护，因此对于插件的质量和稳定性不能保证。

方案2

使用插件是一种相对简单的方式，但需要注意插件是否与您的Jenkins版本兼容。如果您希望自定义解决方案，可能需要编写一些脚本来实现。

如果您对插件有顾虑，或者希望实现更定制化的解决方案，您可以考虑编写脚本或者使用其他方式来达到目标。以下是一个示例的思路，您可以根据自己的需要进行调整：

通过API触发任务: 使用Jenkins提供的API，您可以编写脚本来触发任务的构建。
实时获取日志: 在脚本中，您可以实时获取任务的控制台日志。这可以通过API或者直接读取Jenkins的日志文件来实现。
将日志嵌入页面: 将获取到的日志信息嵌入到您的自定义页面中，这样就可以在同一页上查看任务的输出。

以下是一个简单的示例脚本，演示了如何通过Jenkins API触发任务构建并获取控制台日志：

#!/bin/bash
# 替换以下参数为您的Jenkins信息和任务名
JENKINS_URL="Your_Jenkins_URL"
JOB_NAME="Your_Job_Name"

# 触发任务构建
BUILD_ID=$(curl -X POST "$JENKINS_URL/job/$JOB_NAME/build" --user "your_username:your_api_token" -s | jq -r '.queueItem.id')

# 等待构建完成
while [[ $(curl -s "$JENKINS_URL/queue/item/$BUILD_ID/api/json" --user "your_username:your_api_token" | jq -r '.executable.number') == "null" ]]; do
  sleep 1
done

# 获取控制台日志
BUILD_NUMBER=$(curl -s "$JENKINS_URL/queue/item/$BUILD_ID/api/json" --user "your_username:your_api_token" | jq -r '.executable.number')
LOG=$(curl -s "$JENKINS_URL/job/$JOB_NAME/$BUILD_NUMBER/consoleText" --user "your_username:your_api_token")

# 打印日志或将其嵌入您的页面
echo "$LOG"

请注意，上述脚本中的参数需要根据您的实际情况进行替换。这只是一个简单的示例，您可能需要根据您的环境和需求进行更多的定制。

无论您选择使用插件还是自定义脚本，都需要确保您的操作是安全的，并且在实际生产环境中进行充分的测试。

请根据您的具体情况选择合适的解决方案，以满足在Jenkins中触发任务并在同一页上获取任务日志的需求。

正文完