custom workflow labels: custom_properties

[DriesdeKort]

Related to #339 .
This is probably a niche problem.

Would it be possible to, using the env variable GITHUB_EXPORTER_WORKFLOWS_LABELS, to add a label for a custom_properties key.
Example webhook

{
  "action": "completed",
  "workflow_job": {...}
  "repository": {
   ...
   "custom_properties": {
      "DEPARTMENT": "JAVATEAM"
   }
}

This way we can add a label for the departement. Each department can have their own dashboard with metrics that are only relevant to their repo.

[tboerger]

Can you explain more what you want to get in the end? Do you want to add labels which gets added to all metrics per exporter instance?

[DriesdeKort]

Indeed,

We have an organization on GitHub, with many repos. Each repo belongs to one of many “software teams”. I would like to be able to create a monitoring dashboard for the workflows of each “software team”.

Currently, the custom_properties field is used to show the relation between the repo and the according “software team”.

Documentation “GITHUB_EXPORTER_WORKFLOWS_LABELS List of labels used for workflow jobs, comma-separated list, defaults to owner, …”. Possibly this env flag can be used to dynamically create a label instead of a predefined/hard-coded key-value pair.

Now, repo is hardcoded to the value event.GetRepo().GetName()see code of pkg/store. It could be cool if I can add a label SoftwareTeam=.repository.custom_properties.software_team. The code would dynamically retrieve the value from the received webhook. Possibly this mapping can be stored in yaml. Another repo uses yaml config to rename their labels. Possibly your repo can use yaml to configure extra labels.

As an alternative, we could run a script that locally stores the relation between a repo and their software team (retrieved using the api of github). We can then run multiple instances (for each software team) of your exporter, each with different GITHUB_EXPORTER_REPOS.

Thanks in advance for your input and time.