clambin/covid19

covid19

!GitHub tag (latest by date) !https://github.com/clambin/covid19/workflows/Build/badge.svg !Codecov !https://goreportcard.com/badge/github.com/clambin/covid19 !GitHub

镜像概述和主要用途

covid19是一个轻量级Covid-19跟踪工具，用于收集、存储和可视化全球Covid-19数据。其核心功能是从公共Covid-19跟踪API获取每日更新数据，存储到外部Postgres数据库，并通过Grafana实现数据可视化展示。

核心功能和特性

• 数据收集：定期从公共API获取全球Covid-19统计数据和国家人口数据
• 数据存储：将收集的数据持久化存储到Postgres数据库，支持自动表创建
• 数据可视化：通过Grafana提供数据可视化能力，包含国家视图和全球概览两种仪表板
• 通知功能：可配置针对特定国家的新数据通知
• 历史数据回填：提供工具支持新安装时的历史数据回填
• 多架构支持：Docker镜像支持amd64、arm64和arm32架构

使用场景和适用范围

适用于需要跟踪和分析全球Covid-19数据的个人、研究人员或组织，可用于构建自定义Covid-19数据监控面板，支持数据趋势分析和可视化展示。

详细使用方法和配置说明

安装方式

Docker镜像

主Covid-19跟踪器的Docker镜像可从https://hub.docker.com/r/clambin/covid19%E8%8E%B7%E5%8F%96%EF%BC%8C%E6%94%AF%E6%8C%81amd64%E3%80%81arm64%E5%92%8Carm32%E6%9E%B6%E6%9E%84%E3%80%82

拉取镜像命令：

bash
docker pull clambin/covid19

二进制文件

可从https://github.com/clambin/covid19/releases%E4%B8%8B%E8%BD%BD%E9%A2%84%E7%BC%96%E8%AF%91%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E3%80%82

源码构建

克隆仓库并从源码构建：

bash
git clone https://github.com/clambin/covid19.git
cd covid19
go build cmd/covid19/covid19.go
go build cmd/backfill/backfill.go

注意：需安装Go 1.16或更高版本。

配置说明

配置文件

使用YAML文件配置参数和行为，示例如下：

yaml
# Prometheus（可选）和Grafana的HTTP端口，默认8080
port: 8080
# 开启调试日志，默认false
debug: false
# Postgres数据库配置
postgres:
  # Postgres主机IP或域名
  host: postgres
  # Postgres端口，默认5432
  port: 5432
  # 数据库名称，默认"covid19"
  database: "covid19"
  # 数据库所有者，默认"covid"
  user: "covid"
  # 用户密码，也可通过pg_password环境变量提供
  password: "its4covid"
# 监控配置，用于设置新Covid数据的获取方式
monitor:
  # 开启Covid数据捕获，默认true
  enabled: true
  # 数据获取间隔，默认20m。建议不要设置过低，数据每日更新
  interval: 20m
  # API密钥配置
  rapidAPIKey:
    value: "long-rapid-api-key"
    # 也可指定存储API密钥的环境变量：
    # envVar: "KEY_ENV_VAR_NAME"
  # 通知配置，当指定国家有新数据时发送通知
  notifications:
    # 开启通知，默认true
    enabled: true
    # 通知发送URL，支持https://github.com/containrrr/shoutrrr定义的格式
    url:
      value: https://hooks.slack.com/services/token1/token2/token3
      # 也可指定存储URL的环境变量：
      # envVar: "URL_ENV_VAR_NAME"
    # 需要发送通知的国家列表
    countries:
      - 比利时
      - 美国

依赖组件配置

Postgres数据库

Covid19使用Postgres存储收集的数据，需创建数据库和具有表及索引创建权限的Postgres用户。表结构将由Covid19自动创建。

RapidAPI配置

Covid19通过RapidAPI.com上的两个API收集数据，需注册RapidAPI账号获取API密钥，并订阅以下服务：

• covid-19-coronavirus-statistics：提供最新Covid-19统计数据
• world-population：提供各国人口数据

Grafana配置

数据源配置

需在Grafana中配置Postgres和covid19数据源，可通过Grafana管理UI手动配置或使用数据源配置文件。示例配置文件：

yaml
apiVersion: 1
datasources:
  - id: 5
    orgid: 1
    name: covid19api
    type: grafana-simple-json-datasource
    access: proxy
    # covid19服务器URL
    url: http://covid19.default.svc:5000
    password: ""
    user: ""
    database: ""
    basicauth: false
    basicauthuser: null
    basicauthpassword: null
    isdefault: false
    jsondata: {}
    securejsondata: null
  - id: 3
    orgId: 1
    name: PostgreSQL
    type: postgres
    # Postgres数据库服务器URL
    url: postgres.default:5432
    # 数据库名称，与配置文件中一致
    database: covid19
    # 数据库用户，与配置文件中一致
    user: grafana
    secureJsonData:
      # 数据库用户密码
      password: "your-password-here"
    jsonData:
      sslmode: "disable"

仪表板

仓库包含两个示例仪表板：

• 国家视图仪表板：按国家展示详细数据
• 全球概览仪表板：展示全球病例、趋势和人均统计数据

历史数据回填

Covid19仅添加当日新数据，新安装时需手动回填历史数据，使用提供的backfill工具：

bash
backfill --postgres-host=<postgres-host> \
         --postgres-port=<postgres-port> \
         --postgres-user=<postgres-user> \
         --postgres-password=<postgres-password>

若使用默认端口和用户，可省略对应参数。

运行covid19

命令行选项

usage: covid19 --config=CONFIG [<flags>]

covid19

Flags:
  -h, --help           显示上下文相关帮助（也可尝试--help-long和--help-man）
  -v, --version        显示应用版本
      --debug          启用调试日志
      --config=CONFIG  配置文件路径（必需）

Docker运行示例

bash
docker run -d \
  --name covid19 \
  -p 8080:8080 \
  -v /path/to/config.yaml:/app/config.yaml \
  clambin/covid19 --config=/app/config.yaml

作者

• Christophe Lambin

许可证

本项目采用MIT许可证 - 详见LICENSE.md文件。