v4.0.1

Changelog for 4.0.1

The following sections list the changes for 4.0.1.

Summary

• Fix #413: Show errors for database ping
• Fix #414: Fix PostgreSQL identifiers to be bigint
• Fix #417: Runner ID was being set to run ID for workflow_job
• Fix #418: Include identifier in labels for workflow jobs
• Fix #418: Update conclusion and completed_at columns

Details

• Bugfix #413: Show errors for database ping

  To get more details why a ping to the database fails while starting the exporter
  we have added an error output to the logging.

  #413

• Bugfix #414: Fix PostgreSQL identifiers to be bigint

  Since Github submit 64bit integers for the identifier of workflow jobs we had to
  fix the type to BIGINT for the database schema to avoid errors related to
  store events.

  #414

• Bugfix #417: Runner ID was being set to run ID for workflow_job

  While implementing the workflow job collector we simply attached the wrong
  identifier to the runner id which was base on the run ID. Future webhooks will
  store the right ID now.

  #417

• Bugfix #418: Include identifier in labels for workflow jobs

  To avoid errors related to already scraped metrics we have added the identifier
  to the default labels for the workflow job collector.

  #418

• Bugfix #418: Update conclusion and completed_at columns

  For the new workflow job collector we had been missing the conclusion and
  completed_at values, they will be stored by future webhook events.

  #418

v4.0.0

Changelog for 4.0.0

The following sections list the changes for 4.0.0.

Summary

• Chg #393: Switch to official logging library
• Chg #405: New metrics and configs for workflow job collector
• Chg #412: Change config and metric names for workflows
• Enh #368: Add actor.login label to workflow collector

Details

• Change #393: Switch to official logging library

  Since there have been a structured logger part of the Go standard library we
  thought it's time to replace the library with that. Be aware that log messages
  should change a little bit.

  #393

• Change #405: New metrics and configs for workflow job collector

  We have added a new metric for the duration of the time since the workflow job
  was created, defined in minutes. Beside that we have added two additional
  configurations to query the workflows for a specific status and you are able to
  define a different timeframe than 12 hours now.

  #405

• Change #412: Change config and metric names for workflows

  We introduced a BREAKING CHANGE by renaming the config variables and metrics
  related to the workflows. Previously you had to set --collector.workflows or
  GITHUB_EXPORTER_COLLECTOR_WORKFLOWS to enable the collector, for being
  consistent with the new workflow job collector we have renamed them to
  --collector.workflow_runs and GITHUB_EXPORTER_COLLECTOR_WORKFLOW_JOBS, so be
  aware about that. Additionally we have also renamed the metrics a tiny bit
  matching the same suffix. We renamed them as an example from
  github_workflow_status to github_workflow_run_status.

  #412

• Enhancement #368: Add actor.login label to workflow collector

  Export an actor.login label for workflow collector which could be added to the
  labels optionally, please keep the label cardinality in mind while enabling this
  label.

  #368

v3.1.2

Changelog for 3.1.2

The following sections list the changes for 3.1.2.

Summary

• Fix #296: Drop out of order event if same timestamp as existing completed event

Details

• Bugfix #296: Drop out of order event if same timestamp as existing completed event

  We've fixed the behavior of out of order workflow events with the same
  timestamp, by preferring an already recorded completed event

  #296
  #298
  #312

v3.1.1

Changelog for 3.1.1

The following sections list the changes for 3.1.1.

Summary

• Fix #296: Drop out of order workflow webhook events
• Fix #300: Rename package followin upstream genji package

Details

• Bugfix #296: Drop out of order workflow webhook events

  We've fixed the behavior of out of order workflow events by dropping them, since
  the events order is not guaranteed by GitHub

  #296
  #298

• Bugfix #300: Rename package followin upstream genji package

  The upstream project of the genji database implementation have been renamed, to
  stay being able to upgrade the library we are force to rename it within this
  project as well. We keep the driver name compatible to existing installations.

  #300

v3.1.0

Changelog for 3.1.0

The following sections list the changes for 3.1.0.

Summary

• Fix #278: Create SQLite directory if it doesn't exist
• Enh #277: Configurable labels for runner metrics
• Enh #281: Add metrics for workflow timestamps

Details

• Bugfix #278: Create SQLite directory if it doesn't exist

  We have integrated a fix to always try to create the directory for the SQLite
  database if it doesn't exist. The exporter will fail to start if the directory
  does not exist and if it fails to create the directory for the database file.

  #278

• Enhancement #277: Configurable labels for runner metrics

  Initially we had a static list of available labels for the runner metrics, with
  this change we are getting more labels like the GitHub runner labels as
  Prometheus labels while they are configurable to avoid a high cardinality of
  Prometheus labels. Now you are able to get labels for owner, id, name,
  os, status and optionally labels.

  #277

• Enhancement #281: Add metrics for workflow timestamps

  We added new metrics to show multiple timestamps for the workflows like when the
  workflow have been created, updated and started. Please look at the
  documentation for the exact naming of these new metrics.

  #281

v3.0.1

Changelog for 3.0.1

The following sections list the changes for 3.0.1.

Summary

• Fix #270: Correctly store and retrieve records
• Fix #272: Add SQLite and Genji if supported

Details

• Bugfix #270: Correctly store and retrieve records

  We had introduced a bug while switching between golang's sqlx and sql packages, with this fix
  all workflows should be stored and retrieved correctly.

  You got to make sure to delete the database which have been created with the 3.0.0 release as the
  migration setup have been changed.

  #270

• Bugfix #272: Add SQLite and Genji if supported

  We haven't been able to build all supported binaries as some have been lacking support for the
  use libraries for SQLite and Genji. We have added build tags which enables or disables the
  database drivers if needed.

  #272

v3.0.0

Changelog for 3.0.0

The following sections list the changes for 3.0.0.

Summary

• Fix #267: Use right date for workflow durations
• Chg #245: Read secrets form files
• Enh #261: Rebuild workflow collector based on webhooks

Details

• Bugfix #267: Use right date for workflow durations

  We had used the creation date to detect the workflow duration, this have been replaced by the run
  started date to show the right duration time for the workflow.

  #267

• Change #245: Read secrets form files

  We have added proper support to load secrets like the token or the private key for app
  authentication from files or from base64-encoded strings. Just provide the flags or
  environment variables for token or private key with a DSN formatted string like
  file://path/to/file or base64://Zm9vYmFy.

  Since the private key for GitHub App authentication had been provided in base64-encoded
  format this is a breaking change as this won't work anymore until you prefix the value with
  base64://.

  #245

• Enhancement #261: Rebuild workflow collector based on webhooks

  We have rebuilt the workflow collector based on GitHub webhooks to get a more stable behavior
  and to avoid running into many rate limits. Receiving changes directly from gitHub instead of
  requesting it should improve the behavior a lot. Please read the docs to see how you can setup the
  required webhooks within GitHub, opening up the exporter for GitHub should be the most simple
  part.

  #261

v2.4.0

Changelog for 2.4.0

The following sections list the changes for 2.4.0.

Summary

• Enh #247: Add metrics for organization seats

Details

• Enhancement #247: Add metrics for organization seats

  We had been missing metrics about available and remaining seats within organizations. This
  change adds the two metrics github_org_filled_seats and github_org_seats related to
  that.

  #247

v2.3.0

Changelog for 2.3.0

The following sections list the changes for 2.3.0.

Summary

• Fix #230: Properly handle workflow status results
• Enh #228: Enable app support for GitHub Enterprise

Details

• Bugfix #230: Properly handle workflow status results

  While a workflow is running the conclusion property provides an empty string, in order to get a
  proper value in this case we have changed the metric value to the status property which offers a
  useable fallback.

  #230

• Enhancement #228: Enable app support for GitHub Enterprise

  Previously we had support for GitHub applications for the SaaS version only, with this change
  you are also able to use application registration for GitHub Enterprise.

  #228

v2.2.1

Changelog for 2.2.1

The following sections list the changes for 2.2.1.

Summary

• Fix #216: Resolve nil pointer issues with responses

Details

• Bugfix #216: Resolve nil pointer issues with responses

  We have introduced previously a feature where we made sure to close all response bodies, but we
  forgot to properly check if these responses are really valid which lead to nil pointer
  dereference issues.

  #216