devatherock/artifactory-badge

artifactory-badge

为JFrog Artifactory中托管的Docker仓库生成徽章的工具

概述

artifactory-badge是一款专为JFrog Artifactory中托管的Docker仓库设计的徽章生成工具，能够生成展示镜像下载量、大小、层数及最新版本等信息的徽章，方便集成到项目文档、README等场景，直观呈现Docker镜像的关键指标。

核心功能与特性

• 支持多种徽章类型：下载量、镜像大小、层数及最新版本徽章
• 灵活配置：通过环境变量和YAML文件自定义Artifactory连接信息、日志级别等参数
• 双生成模式：默认使用shields.io生成徽章，也支持自定义生成器
• 高效并行：可配置并行度获取镜像版本详情，提升性能
• 完善的日志控制：支持调试日志启用及JSON格式日志输出，便于故障排查

使用场景与适用范围

适用于需要在项目README、文档或监控面板中展示Artifactory托管Docker镜像相关指标的场景，帮助开发团队和用户快速了解镜像的下载量、版本状态等关键信息。

使用方法与配置说明

示例命令

bash
docker run --rm \
  -p 8080:8080 \
  -e ARTIFACTORY_URL=https://your-artifactory-url \
  -e ARTIFACTORY_API_KEY=your-api-key \
  docker.xuanyuan.run/devatherock/artifactory-badge:1.1.0

可配置属性

application.yml（可选）

用于设置日志级别等高级配置：

yaml
logger:
  levels:
    io.micronaut.http.server.netty.NettyRequestLifecycle: DEBUG # 可选，启用HTTP服务器访问日志

环境变量

API规范

应用运行时，可通过{host}/swagger-ui或{host}/swagger/artifactory-badge-{version}.yml访问完整API文档。主要端点如下：

• /docker/pulls?package=path/to/package - 生成下载量徽章
• /docker/image-size?package=path/to/package - 生成镜像大小徽章
• /docker/layers?package=path/to/package - 生成镜像层数徽章
• /version?package=path/to/package - 生成最新版本徽章

自定义生成器徽章示例

xml
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="144" height="20" role="img" aria-label="docker pulls: 47">
    <title>docker pulls: 47</title>
    <linearGradient id="s" x2="0" y2="100%">
        <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
        <stop offset="1" stop-opacity=".1"/>
    </linearGradient>
    <clipPath id="r">
        <rect width="144" height="20" rx="3" fill="#fff"/>
    </clipPath>
    <g clip-path="url(#r)">
        <rect width="112" height="20" fill="#555"/>
        <rect x="112" width="32" height="20" fill="#007ec6"/>
        <rect width="144" height="20" fill="url(#s)"/>
    </g>
    <g font-family="monospace">
        <text aria-hidden="true" x="0" y="15" fill="#fff" xml:space="preserve"> docker pulls </text>
        <text aria-hidden="true" x="112" y="15" fill="#fff" xml:space="preserve"> 47 </text>
    </g>
</svg>

故障排除

启用调试日志

• 设置LOGGER_LEVELS_ROOT=DEBUG：启用所有调试日志（框架及自定义代码）
• 设置LOGGER_LEVELS_IO_GITHUB_DEVATHEROCK=DEBUG：仅启用自定义代码调试日志
• 细粒度控制：提供自定义logback.xml文件，并设置LOGBACK_CONFIGURATION_FILE=/path/to/custom/logback.xml

JSON日志输出

参考https://github.com/logstash/logstash-logback-encoder%E6%96%87%E6%A1%A3%E8%87%AA%E5%AE%9A%E4%B9%89%E6%97%A5%E5%BF%97%E5%AD%97%E6%AE%B5%E5%92%8C%E6%A0%BC%E5%BC%8F%E3%80%82%E8%AE%BE%E7%BD%AE%60LOGBACK_CONFIGURATION_FILE=logback-json.xml%60%E5%8D%B3%E5%8F%AF%E8%BE%93%E5%87%BAJSON%E6%A0%BC%E5%BC%8F%E6%97%A5%E5%BF%97%E3%80%82