covid19

README

covid19

A lightweight Covid-19 tracker.

Introduction

This package tracks global Covid-19 data. It consists of three executables:

• covid19-loader retrieves the latest updates from a public Covid-19 tracker and stores them in an external Postgres DB
• covid19-population-loader retrieves the latest population figures from a public tracker and stores them in an external Postgres DB
• covid19-handler implements the targets for the contained Grafana dashboards

Installation

Docker images for the different programs is available on ghcr.io:

• covid19-loader
• covid19-population-loader
• covid19-handler

Images are available for amd64, arm64 & arm32. Binaries are also available on github.

Configuration

Configuration file

Use the following yaml file to configure parameters & desired behaviour:

# HTTP port for Prometheus (optional) & Grafana. Default is 8080
port: 8080
# Turn on debug logging. Default is false
debug: false
# Configuration for Postgres DB
postgres:
  # Postgres Host IP or host
  host: postgres
  # Postgres Port. Default is 5432
  port: 5432
  # Postgres database name. Default is "covid19"
  database: "covid19"
  # Postgres owner of the database. Default is "covid"
  user: "covid"
  # Password for user. 
  # Alternatively, can be provided through pg_password environment variable
  password: "some-password"
# Monitor section to configure how new covid data should be retrieved
monitor:
  # API Key for the APIs. See below.
  rapidAPIKey:
    value: "long-rapid-api-key"
    # alternatively, specify an environment variable that holds the API Key:
    # envVar: "KEY_ENV_VAR_NAME"
  # covid19 can be configured to send a notification when new data is found for a set of countries
  notifications:
    # Turn on notifications. Default is true
    enabled: true
    # URL to send notifications to. See https://github.com/containrrr/shoutrrr for options
    url:
      value: https://hooks.slack.com/services/token1/token2/token3
      # alternatively, specify an environment variable that holds the API Key:
      # envVar: "URL_ENV_VAR_NAME"
    # List of country names for which to send an event
    countries:
      - Belgium
      - US

Postgres

Covid19 uses a Postgres database to store collected data. Create a database and postgres user with permissions to create new tables & indexes. Covid19 will handle table creation itself.

RapidAPI

Covid19 uses two APIs published on RapidAPI.com to collect new data. You will need to create an account, which will give you an API Key. Add this key to the configuration file above and subscribe to the following two services:

• https://rapidapi.com/KishCom/api/covid-19-coronavirus-statistics
• https://rapidapi.com/aldair.sr99/api/world-population/

The first one offers the latest Covid-19 statistics. The second one provides population figures for each country.

Grafana data sources

The covid19 Grafana data source will need to be configured in Grafana. This can be done manually through the Grafana admin UI, or through a datasource provisioning file, e.g.

apiVersion: 1
datasources:
  - id: 5
    orgid: 1
    name: covid19
    type: grafana-simple-json-datasource
    access: proxy
    # URL of covid19 server
    url: http://covid19.default.svc:5000
    password: ""
    user: ""
    database: ""
    basicauth: false
    basicauthuser: null
    basicauthpassword: null
    isdefault: false
    jsondata: {}
    securejsondata: null

Running

Command-line options

Each program supports the same command-line arguments:

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

Flags:
-h, --help       Show context-sensitive help (also try --help-long and --help-man).
-v, --version    Show application version.
--debug          Log debug messages
--config=CONFIG  Configuration file

Grafana

The repo contains sample dashboards. One dashboard provides a view per country. A second one provides an overview of cases, evolution, per capita stats across the world.

Authors

• Christophe Lambin

License

This project is licensed under the MIT License - see the license file for details.