{"id":19002299,"url":"https://github.com/linkerd/linkerd2-ci-metrics","last_synced_at":"2026-04-20T10:30:18.841Z","repository":{"id":57529489,"uuid":"259971158","full_name":"linkerd/linkerd2-ci-metrics","owner":"linkerd","description":"CI reports","archived":false,"fork":false,"pushed_at":"2021-04-29T13:51:00.000Z","size":460,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-01T18:42:39.181Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linkerd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-29T15:53:21.000Z","updated_at":"2024-08-01T12:29:39.000Z","dependencies_parsed_at":"2022-08-26T03:33:00.102Z","dependency_job_id":null,"html_url":"https://github.com/linkerd/linkerd2-ci-metrics","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Flinkerd2-ci-metrics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Flinkerd2-ci-metrics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Flinkerd2-ci-metrics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Flinkerd2-ci-metrics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linkerd","download_url":"https://codeload.github.com/linkerd/linkerd2-ci-metrics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240026537,"owners_count":19736202,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T18:14:34.304Z","updated_at":"2026-04-20T10:30:18.782Z","avatar_url":"https://github.com/linkerd.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# linkerd2-ci-metrics\n\nThis project generates a report for the CI builds at the [Linkerd2\nrepo](https://github.com/linkerd/linkerd2). \n\nEach day a cronjob (as defined in `.github/workflows/build-report.yml`) will\ntrigger the creation of the report, which is uploaded as an artifact to the\nworkflow, under the Actions tab.\n\nThe report is a zip file containing a single file `report.html` that is\nself-contained, i.e. it doesn't depend on fetching external js libraries or any\nother kind of asset.\n\n### Reports\n\n![top screenshot](https://github.com/linkerd/linkerd2-ci-metrics/blob/master/screenshots/top.png)\n![bottom screenshot](https://github.com/linkerd/linkerd2-ci-metrics/blob/master/screenshots/bottom.png)\n\nThe first pane shows the global success of all the CI runs in the repo,\naggregating over all the workflow runs whose jobs weren't cancelled. Below\nthat rate is segregated per workflow.\n\nThe second plane shows the success rates per job, from less to more successful.\n\nThe bottom panes show the list of error messages captured through Github\nannotations from more to less frequent. These are shown just for the workflows\nthat run integration tests: Kind integration, Cloud integration and Release.\n\n### API Requests\n\nThe program makes use of Google's\n[go-github](https://github.com/google/go-github) library, to hit the following\nGithub APIs:\n\n```\n# This gives us a list of check suite IDs, for a given workflow name:\nGET /repos/linkerd/linkerd2/actions/workflows/:workflow_name/runs\n\n# For each check suite ID, this gives us the check run ID, job name,\n# completion status and timestamps:\nGET /repos/linkerd/linkerd2/check-suites/:check_suite_id/check-runs\n\n# For each check run ID, we invoke the annotations API which gives us the file\n# name and error message\nGET repos/linkerd/linkerd2/check-runs/:check_run_id/annotations\n```\n\nPlease note the report takes about an hour to generate, due to having imposed\nthrottling on the Github API requests to avoid hitting the rate limit.\n\n### Authentication\n\nThe Github API requests are authenticated using the `REPORTS_TOKEN` secret, containing\na Personal Access Token belonging to l5d-bot.\n\n### Testing\n\n`go test ./cmd` will test that the html report is generated without errors, using\nas inputs the list of jobs and annotations found under `./cmd/testdata/jobs.json`\nand `cmd/testdata/annotations.json`.\n\nYou can view the sample report generated with that data with `go test ./cmd -v`\n\nThose sample files under `./cmd/testdata` can be updated with real data by\nsetting the `REFRESH_DATA` environment variable prior to running, e.g.:\n\n```\nREFRESH_DATA=1 GITHUB_TOKEN=xxx go run ./cmd \u003e report.html\n```\n\n## License\n\nCopyright 2020, Linkerd Authors. All rights reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use\nthese files except in compliance with the License. You may obtain a copy of the\nLicense at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied. See the License for the\nspecific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkerd%2Flinkerd2-ci-metrics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinkerd%2Flinkerd2-ci-metrics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkerd%2Flinkerd2-ci-metrics/lists"}