cfje/your-kit-resource

YourKit Concourse Resource 镜像文档

1. 镜像概述

YourKit Concourse Resource是针对Concourse CI/CD平台设计的资源类型镜像，旨在将YourKit性能分析工具无缝集成到自动化流水线中。通过该资源，用户可在持续集成/部署（CI/CD）流程中自动化执行应用性能数据收集、生成性能分析报告等操作，实现对应用性能的持续监控与优化。

2. 核心功能与特性

2.1 核心功能

• Concourse集成：作为Concourse资源类型，支持在pipeline中定义为资源，通过get/put步骤触发性能分析流程
• 性能数据收集：集成YourKit工具链，支持对Java等应用进行CPU、内存、线程等性能指标采集
• 报告生成：自动生成YourKit格式的性能分析报告，支持导出为HTML、XML等格式
• 配置灵活：支持通过参数自定义性能分析范围、采样频率、报告输出路径等

2.2 特性

• 与YourKit最新版本兼容，支持主流性能分析功能
• 轻量级设计，最小化对CI/CD流水线执行效率的影响
• 支持与Concourse Secrets集成，安全管理YourKit授权信息

3. 使用场景与适用范围

3.1 典型使用场景

• CI流程性能测试：在应用构建完成后，自动启动性能测试并通过该资源收集分析数据
• CD流程性能验证：在应用部署前/后，执行性能检查并生成报告，作为部署决策依据
• 持续性能监控：定期在流水线中触发性能数据收集，跟踪应用性能变化趋势

3.2 适用范围

• 基于Concourse CI/CD平台构建的自动化流水线
• 使用Java等YourKit支持的编程语言开发的应用
• 需要在持续交付流程中纳入性能监控的团队或项目

4. 使用方法与配置说明

4.1 资源类型定义

在Concourse pipeline中，需先定义资源类型（resource_types）：

yaml
resource_types:
- name: yourkit-resource
  type: docker-image
  source:
    repository: yourkit/concourse-resource  # 假设官方镜像仓库路径
    tag: latest  # 建议指定具体版本号

4.2 资源配置

定义具体资源实例，配置YourKit授权信息、应用目标等参数：

yaml
resources:
- name: app-performance-report
  type: yourkit-resource
  source:
    yourkit_license_key: ((yourkit-license-key))  # 通过Concourse Secrets注入
    app_target: "http://app-under-test:8080"  # 待分析应用地址
    report_format: "html"  # 报告格式，支持html/xml
    output_path: "performance-reports"  # 报告输出路径（相对于资源工作目录）

4.3 在Job中使用

在pipeline的job中，通过get或put步骤使用资源：

4.3.1 收集性能数据并生成报告（put步骤）

yaml
jobs:
- name: collect-performance-data
  plan:
  - get: app-code  # 假设已定义应用代码资源
  - task: build-and-run-app
    config:
      # 构建并启动待测试应用的任务配置
  - put: app-performance-report
    params:
      duration: "300"  # 性能数据采集时长（秒）
      sampling_rate: "10ms"  # 采样频率
      include_threads: "true"  # 是否包含线程分析

4.3.2 获取历史报告（get步骤）

yaml
jobs:
- name: analyze-performance-trend
  plan:
  - get: app-performance-report
    trigger: true  # 当报告更新时触发任务
  - task: compare-reports
    config:
      # 对比历史报告的任务配置，分析性能变化

4.4 配置参数说明

5. 注意事项

• 确保待分析应用已配置YourKit代理（如JVM参数-agentpath:<yourkit-agent-path>）
• YourKit授权密钥建议通过Concourse Secrets管理，避免明文暴露
• 根据应用负载调整duration和sampling_rate参数，避免过度采集影响应用性能
• 报告文件较大时，建议结合Concourse的artifact资源或外部存储服务（如S3）进行持久化存储