#trace #github-action #jaeger #ci #github-api

app gh-action-trace

gh-action-trace is a CLI to create traces for GitHub Action runs by retrieving Action runs metadata from the GitHub API

2 unstable releases

0.2.0 Dec 13, 2021
0.1.0 Nov 25, 2021

#24 in #github-action

MIT license

17KB
191 lines

gh-action-trace

gh-action-trace is a binary that can be used to generate traces for GitHub Action runs by retrieving the metadata from GitHub API.

Jaeger

Installation

cargo install gh-action-trace

Usage

First, Run jaeger locally to collect the traces.

docker run -d  -p6831:6831/udp -p6832:6832/udp -p16686:16686 jaegertracing/all-in-one:latest --log-level debug

Now, Run the binary to generate and send the traces to Jaeger. Though, The binary should work without a GitHub token, It is recommended to pass a GitHub token through the --token flag for the binary to not be rate-limited.

$ gh-action-trace --owner linkerd --repo linkerd2 --runs 100 --token <GITHUB_TOKEN>
Completed workflow CI                                                         10/10 [========================================] (0s)
Completed workflow Coverage                                                   10/10 [========================================] (0s)
Completed workflow CodeQL                                                     10/10 [========================================] (0s)
Completed workflow Integration tests                                          10/10 [========================================] (0s)
Completed workflow KinD integration                                           10/10 [========================================] (0s)
Completed workflow Lock Threads                                               10/10 [========================================] (0s)
Completed workflow Policy Controller                                          10/10 [========================================] (0s)
Completed workflow Release                                                    10/10 [========================================] (0s)
Completed workflow Static checks                                              10/10 [========================================] (0s)
Completed workflow Unit tests                                                 10/10 [========================================] (0s)
Completed workflow CI                                                         10/10 [========================================] (0s)

You should be able to see traces in the Jaeger UI. :)

Dependencies

~26–41MB
~759K SLoC