Irregularities in github_workflow_run_status

[hsolberg]

Hi!

According to the documentation the expected values from github_workflow_run_status is either 0 (failed), 1 (success), 2 (skipped) or 3 (in_progress). When we look at the metrics we only see values of 0 or 1 even though the runners have been observed with other states. The runners show the state long enough to expect the metric to change the value to 3.

Running $ gh run list --json name,status,conclusion reveals the problem. Seems the conclusion-field is only updated by GitHub Actions when the status-field is set to "completed".

  {
    "conclusion": "",
    "name": "Build repo",
    "status": "queued"
  },
  {
    "conclusion": "",
    "name": "Build repo",
    "status": "in_progress"
  },
  {
    "conclusion": "",
    "name": "Build repo",
    "status": "pending"
  },
  {
    "conclusion": "success",
    "name": "Build repo",
    "status": "completed"
  }

Looking at the code it seems the conclusion-field is used to set the value of the metric which explains why we only observe values of 0 or 1. Also 0 is used as a "catch all other status-variants" it seems?
I think it would be better to split this into separate metrics per status instead. That way you'll get a total number for metrics with the state "in_progress" for instance. github_workflow_run_in_progress with a counter of number of runners with that state so it's possible to sum+rate the metric.

I noticed it's a long time since the last release and any activity in general on the project, so I'm also wondering if this project is considered abandoned or just lacking feedback from users in general?

[deebsman]

I've hit this problem myself.

[hsolberg]

@moutonjeremy I noticed the updated README.md regarding changes to maintainers/project owners etc. Anyone on the new team that could take a look at this issue? Any progress towards solving this issue would be highly appreciated and please do reach out if the description is unclear. 🙂