marcells/node-build-monitor-demo

node-build-monitor

镜像概述和主要用途

node-build-monitor 是一个用Node.js编写的构建监控工具，支持多种主流构建服务。它具有良好的可扩展性，可轻松集成新的构建服务，允许混合使用不同类型的服务，并通过响应式、可主题化的Web前端实时展示最新构建状态。该工具专为Docker容器化部署设计，配置简单，适用于开发团队实时监控项目构建状态。

核心功能和特性

• 多服务支持：兼容Travis CI、Jenkins、TeamCity、Azure DevOps等20+种构建服务
• 可扩展性：通过简单扩展即可支持新的构建服务
• 混合服务监控：可同时监控不同类型的构建服务
• 响应式Web前端：自适应不同设备屏幕，支持主题定制
• 自动更新：定期拉取最新构建状态并自动刷新界面
• Docker化部署：提供完整的Docker部署方案，包括Docker Compose和Kubernetes支持
• 灵活配置：支持自定义更新间隔、显示数量、排序方式等参数

支持的服务

• Travis CI
• Jenkins
• TeamCity
• Azure DevOps 和 Team Foundation Server 构建
• Azure DevOps 和 Team Foundation Server 发布
• https://github.com/marcells/tfs-proxy
• Team Foundation Server 2015/2017（本地部署）
• GitLab（本地部署，测试版）
• BuddyBuild
• Bamboo
• BambooDeploy
• Bitbucket Pipelines
• Buildkite
• Bitrise
• CCTray
• Shippable
• PRTG
• Circle CI
• Drone

使用场景和适用范围

• 开发团队实时监控多个项目的构建状态
• 构建服务器状态仪表盘展示
• DevOps流程中的持续集成/持续部署监控
• 混合使用多种构建服务的企业环境
• 需要自定义构建监控界面的场景

快速启动

运行方式选择

• 下载独立版本运行（最简单的运行方式）
• 使用Node手动运行（开发环境首选）
• 使用Docker Compose运行（生产环境首选）
• 在Kubernetes中运行（作为helm chart）

运行独立版本（最简单方式）

下载适用于您操作系统的独立版本，直接运行可执行文件即可。

手动运行（开发环境）

1. 克隆仓库：

   bash
   git clone https://github.com/marcells/node-build-monitor.git
   cd node-build-monitor
   

2. 安装依赖：

   bash
   npm install
   

3. 配置app/config.json文件

4. 启动应用：

   bash
   npm start
   

使用Docker Compose运行（生产环境）

1. 创建docker-compose.yml文件：

   yaml
   version: '3'
   services:
     build-monitor:
       image: marcells/node-build-monitor
       ports:
         - "3000:3000"
       volumes:
         - ./config.json:/app/config.json
       restart: always
   

2. 创建config.json配置文件

3. 启动服务：

   bash
   docker-compose up -d
   

4. 访问 http://localhost:3000 查看监控界面

在Kubernetes中运行（作为helm chart）

请参考项目的Kubernetes部署文档，使用helm chart进行部署。

详细配置说明

配置文件位置

构建监控配置可以放置在以下位置之一：

1. %HomeDirectory%/node-build-monitor-config.json
2. %PathOfExecutable%/config.json（仅适用于独立版本）
3. app/config.json

配置文件结构

json
{
  "monitor": {
    "interval": 30000,
    "numberOfBuilds": 12,
    "latestBuildOnly": false,
    "sortOrder": "date",
    "errorsFirst": false,
    "expandEnvironmentVariables": false,
    "debug": true
  },
  "services": [
    {
      "name": "Travis",
      "configuration": {
        "slug": "node-build-monitor"
      }
    },
    {
      "name": "Travis",
      "configuration": {
        "slug": "marcells/bloggy",
        "latestBuildOnly": true
      }
    }
  ]
}

Monitor部分设置

Services部分设置

services部分接受一个数组，每个元素描述一个构建服务配置（允许混合不同服务）：

• name：指定使用的服务名称
• configuration：服务的配置参数，因服务而异（详见下文各服务配置）

Travis CI配置

支持Travis CI构建服务。

json
{
  "name": "Travis",
  "configuration": {
    "slug": "marcells/node-build-monitor"
  }
}

Jenkins配置

支持Jenkins构建服务。支持单作业模式或单视图模式：单作业模式显示选定Jenkins作业的构建；单视图模式显示给定Jenkins视图中所有作业的构建。两种模式都可以限制每个作业的最大最近构建数。

json
{
  "name": "Jenkins",
  "configuration": {
    "url": "http://jenkins-server:8080",
    "username": "jenkins_username",
    "password": "jenkins_password",
    "job": "JenkinsJobName",
    "numberOfBuildsPerJob": 3,
    "options": {
      "strictSSL": false
    }
  }
}

TeamCity配置

支持TeamCity构建服务。

json
{
  "name": "TeamCity",
  "configuration": {
    "url": "http://teamcity_username:teamcity_password@teamcity-server:8111",
    "buildConfigurationId": "TeamCityProject_TeamCityBuildConfiguration",
    "branch": "master",
    "authentication": "ntlm",
    "username": "teamcity_username",
    "password": "teamcity_password",
    "useGuest": true,
    "reportFailedToStart": true
  }
}

Azure DevOps和Team Foundation Server构建配置

支持Azure Pipelines、Azure DevOps和Team Foundation Server构建服务。

json
{
  "name": "Tfs",
  "configuration": {
    "url": "https://{youraccount}.visualstudio.com or http://tfs-server:8080/tfs",
    "collection": "DefaultCollection",
    "project": "projectname",
    "username": "username",
    "pat": "personalaccesstoken",
    "queryparams": "&branchName=refs/heads/master&definitions=4,5,6,7&maxBuildsPerDefinition=1",
    "includeQueued": false,
    "showBuildStep": false
  }
}

注意：

• 创建个人访问令牌并授予读取构建的权限。
• 生成的URL格式为：https://{instance}/{collection}/{project}/_apis/build/builds?api-version=2.0[queryparams]
• 所有配置字段都是必填的。如果某个字段不需要（如queryparams），请在配置中提供空字符串。

其他服务配置

其他服务（如GitLab、BuddyBuild、Bamboo等）的配置请参考项目官方文档，配置结构类似，主要区别在于configuration部分的参数。