https://github.com/teleivo/github-action-metrics
Gather insights into GitHub actions
https://github.com/teleivo/github-action-metrics
actions github-actions metrics
Last synced: 6 months ago
JSON representation
Gather insights into GitHub actions
- Host: GitHub
- URL: https://github.com/teleivo/github-action-metrics
- Owner: teleivo
- License: mit
- Created: 2021-10-23T03:40:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T01:10:56.000Z (almost 2 years ago)
- Last Synced: 2025-01-01T20:26:51.679Z (over 1 year ago)
- Topics: actions, github-actions, metrics
- Language: TypeScript
- Homepage:
- Size: 1.03 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action Metrics
[](https://github.com/teleivo/github-action-metrics/actions/workflows/main.yml)
Analyze your [GitHub Actions](https://github.com/features/actions)!
Do you wonder
- why PRs take so long to be checked by your GitHub actions?
- how often PRs fail to pass a certain workflow, job or step?
- if caching dependencies did make a job run faster?
These are just a fraction of questions you can find answers to using this
project :blush:
## Architecture
This project provides a CLI which is a small wrapper around [GitHub's
Octokit](https://github.com/octokit/octokit.js) library. It will fetch GitHub
action data from https://docs.github.com/en/rest/reference/actions and store
it in a place of your choice. You can for example store it in a Git repository
on GitHub itself.
You can then index the data into
[Elasticsearch](https://www.elastic.co/elasticsearch/). Create visualizations
(graphs, metrics, dashboards, ...) to answer a lot of questions you have about
your use of GitHub actions.
## Elasticsearch and Kibana
### Initial Setup
Copy [the kibana config](./elk/config/kib01.example.yml)
```sh
cp ./elk/config/kib01.example.yml ./elk/config/kib01.yml
```
Start Elasticsearch and Kibana
```sh
docker compose up
```
Follow [Create passwords for built-in users](https://www.elastic.co/guide/en/elasticsearch/reference/7.15/security-minimal-setup.html#security-create-builtin-users)
by executing
```sh
docker exec -it es01 ./bin/elasticsearch-setup-passwords auto --batch
```
**Store passwords somewhere safe** and change the [elasticsearch.password](./elk/conf/kibana.yml),
Run
```sh
docker exec -it kib01 ./bin/kibana-keystore create
docker exec -it kib01 ./bin/kibana-keystore add elasticsearch.password
```
Add the `kibana_system` password when prompted.
Restart
```sh
docker compose restart
```
You should now be able to login using user `elastic` and the password that was
auto-generated.
### Index Data
Once you fetched GitHub workflow data and setup Elasticsearch and Kibana you
can index it using
```sh
gham index all \
--url http://localhost:9200 \
--workflow-id 10954 \
--source ~/metrics/data \
--user elastic --password $(password-manager get elasticsearch-password)
```
Create kibana index patterns
```sh
./elk/kibana_index_pattern.sh elastic --password $(password-manager get elasticsearch-password)
```
## Example Project
I started this project to analyze the test workflow we use at
[DHIS2](https://dhis2.org/about/). I wanted to know where time was spent, why
some test runs took 15min while others took 23min to finish. How could we
get faster feedback on PRs and reduce this variation in test duration?
Using this project I
- fetched GitHub action data every day using a scheduled GitHub action and
stored it in a [GitHub
repository](https://github.com/teleivo/dhis2-github-action-metrics)
- indexed and analyzed the data using Elasticsearch and Kibana