Minimal Config
To get started with the service there is a minimal amount of configuration needed to get the service running. This configuration contains the following:
| environment variables | datatype | description |
|---|---|---|
| APP_GITHUB_ORG | string | the name of the organization |
| APP_GITHUB_APPLICATION_ID | number | The id of the Github App installed for authorizing the Api calls made by Github Metics (In the case of `AuthApp Github Metrics` is: 882159) |
| APP_GITHUB_APPLICATION_INSTALL_ID | number |
The id of the installation of the above mentioned Github App.
Can be retrived from the url when visiting https://github.com/organizations/<your-org>/settings/installations
and then clicking on Configure for AuthApp Github Metrics
|
| APP_GITHUB_APPLICATION_PEM | string with newlines |
A private key generated through the installation of the Github
App. This environement variable is just the whole pem
string provided by Github. For more information on how to create
this Github App check out the github authentication
page.
|
By default only the Repository Count and Workflow Runs features are active.
If you would like to collect any other metrics turn on the relevant features.
| datatype | default | description | |
|---|---|---|---|
| Workflow Runs | EXPORTER_WORKFLOW_RUNS_FEATURE |
||
| boolean | true |
Collects data on all workflow runs created since yesterday 00:00, this includes workflow-runs of all statuses. | |
| Active Workflow Runs | EXPORTER_ACTIVE_WORKFLOW_RUNS_FEATURE |
||
| boolean | false |
Collects data only the the currently active workflow-runs, meaning any workflow-run that has not failed or completed. | |
| Jobs | EXPORTER_JOBS_FEATURE |
||
| boolean | false |
Collects data on all jobs of all the workflow-runs created in the last 24 hours. | |
| Repository Count | EXPORTER_REPOSITORIES_FEATURE |
||
| boolean | true |
Collects data on the number of repositories in the organization. | |
| Workflow Run Build Times | EXPORTER_WORKFLOW_RUN_BUILD_TIMES_FEATURE |
||
| boolean | false |
Aggregates workflow-run build-times to both a total count as well as a average for all workflow-runs created in the last 24 hours. | |
| Self Hosted Runners | EXPORTER_SELF_HOSTED_RUNNERS_FEATURE |
||
| boolean | false |
Collects data on all self-hosted runners present on the organization as well as any repository that the token has access to. | |
| Pull Requests | EXPORTER_PULL_REQUESTS_FEATURE |
||
| boolean | false |
Aggregates status counts of pull requests over the last few days. | |