Skip to content

Latest commit

 

History

History
147 lines (84 loc) · 4.56 KB

CHANGELOG.md

File metadata and controls

147 lines (84 loc) · 4.56 KB

Changelog for unreleased

The following sections list the changes for unreleased.

Summary

  • Chg #45: Change docker image name
  • Chg #42: Drop darwin/386 release builds
  • Chg #46: Generate metrics documentation

Details

  • Change #45: Change docker image name

    We should use the same docker image name as all the other exporters within this organization. So we renamed the image from promhippie/github_exporter to promhippie/github-exporter to have the same naming convention as for the other exporters.

    promhippie#45

  • Change #42: Drop darwin/386 release builds

    We dropped the build of 386 builds on Darwin as this architecture is not supported by current Go versions anymore.

    promhippie#42

  • Change #46: Generate metrics documentation

    We have added a script to automatically generate the available metrics within the documentation to prevent any documentation gaps. Within the hack/ folder we got a small Go script which parses the available collectors and updates the documentation partial based on that.

    promhippie#46

Changelog for 1.0.1

The following sections list the changes for 1.0.1.

Summary

  • Fix #49: Fixed pointer references within exporters

Details

  • Bugfix #49: Fixed pointer references within exporters

    So far we directly accessed common attributes on repos within the collectors, but as there could be corner cases where some attribute could be missing we add conditions to make sure only set values are getting called.

    promhippie#49

Changelog for 1.0.0

The following sections list the changes for 1.0.0.

Summary

  • Fix #18: Handle private repos counts not available to non-organization member
  • Chg #12: Refactor structure and integrate more metrics
  • Enh #19: Allow insecure TLS via CLI flag
  • Enh #20: Add flag to set /metrics endpoint request timeout

Details

  • Bugfix #18: Handle private repos counts not available to non-organization member

    Fix the case where the account used to query GitHub API is not a member of a given organisation, it resulted in a segfault.

    promhippie#18

  • Change #12: Refactor structure and integrate more metrics

    The structure of the repository should get overhauled and beside that we should gather more metrics per organization and per repository. Additionally we should also add support for GitHub Enterprise as requested within #10.

    promhippie#12

  • Enhancement #19: Allow insecure TLS via CLI flag

    In some cases it can be desirable to ignore certificate errors from the GitHub API - such as in the case of connecting to a private instance of GitHub Enterprise which uses a self-signed cert. This is exposed via the environment variable GITHUB_EXPORTER_TLS_INSECURE and the flag --github.insecure.

    promhippie#19

  • Enhancement #20: Add flag to set /metrics endpoint request timeout

    When pulling a lot of data from the GitHub API, in some cases the default 10s timeout on the /metrics endpoint can be insufficient. This option allows the timeout to be configured via GITHUB_EXPORTER_WEB_TIMEOUT or --web.timeout

    promhippie#20

Changelog for 0.2.0

The following sections list the changes for 0.2.0.

Summary

  • Chg #4: Enforce a repo or an org flag
  • Chg #2: Renamed valid_response metric to up metric

Details

  • Change #4: Enforce a repo or an org flag

    The exporter requires at least one organization or repository to work properly, integrated a check that something have been set when launching the exporter.

    promhippie#4

  • Change #2: Renamed valid_response metric to up metric

    The previous metric github_valid_response doesn't match the Prometheus conventions, so it have been renamed to github_up which properly signals if the exporter can gather metrics or not.

    promhippie#2

Changelog for 0.1.0

The following sections list the changes for 0.1.0.

Summary

  • Chg #11: Initial release of basic version

Details

  • Change #11: Initial release of basic version

    Just prepared an initial basic version which could be released to the public.

    promhippie#11