Skip to content

Prometheus exporter for GItHub Tags/Releases and Docker repositories with CVE reports

License

Notifications You must be signed in to change notification settings

webdevops/apprelease-exporter

Repository files navigation

AppRelease and CVE Exporter

license DockerHub Quay.io

Prometheus exporter for Application releases supports Docker and GitHub and is able to fetch CVE reports via https://cve.circl.lu/.

Usage

Usage:
  apprelease-exporter [OPTIONS]

Application Options:
  -v, --verbose                     Verbose mode [$VERBOSE]
  -c, --config=                     Config path [$CONFIG]
      --bind=                       Server address (default: :8080) [$SERVER_BIND]
      --scrape-time=                Default scrape time (time.duration) (default: 12h) [$SCRAPE_TIME]
      --scrape-time.docker=         Scrape time for Docker (time.duration) [$SCRAPE_TIME_DOCKER]
      --scrape-time.github=         Scrape time for Github (time.duration) [$SCRAPE_TIME_GITHUB]
      --cve.url=                    URL to cve-search instance (see https://github.com/cve-search/cve-search) [$CVE_URL]
      --github.personalaccesstoken= GitHub personal access token [$GITHUB_PERSONALACCESSTOKEN]
      --github.scrape-wait=         Wait number between project waits (default: 2s) [$GITHUB_SCRAPEWAIT]
      --github.limit=               Number of results fetched from GitHub (default: 25) [$GITHUB_LIMIT]
      --docker.limit=               Number of tags fetched from Docker (default: 25) [$DOCKER_LIMIT]
      --cache.path=                 Cache path [$CACHE_PATH]
      --cache.ttl=                  Cache expiry (default: 24h) [$CACHE_TTL]

Help Options:
  -h, --help                        Show this help message

Configuration file

see example.yaml

Metrics

Metric Collector Description
apprelease_project_docker_release docker List of images with tags, value is created time from manifest
apprelease_project_docker_release_cve docker List of CVE reports (if configured) with CVSS as value
apprelease_project_github_release github List of GitHub repository releases, value is created time
apprelease_project_github_release_cve github List of CVE reports (if configured) with CVSS as value

Example