feature/actions: adding READMEs

patrickhuie19 · Sep 5, 2023 · 7373933 · 7373933
1 parent 451422d
commit 7373933
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
@@ -0,0 +1,15 @@
+# Github workflows
+
+## Traces
+
+`tracing.yml`:
+This gh action will check if PRs are marked with the `enable tracing` label. If so, on PR creation, sycronization, or labeling, then a sample CI workflow is kicked off that generates traces.
+
+Ephemeral OTEL collector, Grafana Tempo, and Grafana UI containers are deployed and kept up while the workflow executes (for 500 seconds). Ngrok tunnels are used to expose the Grafana UI container outside the github runner. 
+
+To view such traces, fork this repository and configure the following secrets:
+    NGROK_AUTH_TOKEN
+    NGROK_USER
+    NGROK_PASSWORD
+
+The tracing workflow will log the exposed endpoint, which you can paste into any browser. Visit `/explore` and select traces to view traces.
diff --git a/README.md b/README.md
@@ -31,6 +31,8 @@ go test ./... -v
 
 The gRPC services in this application can be instrumented OpenTelemetry tracing. Check out `example-otlp-agent-tempo-grafana`.
 
+Traces can also be generated in a mock tracing workflow and viewed in grafana. Checkout the Readme for the [tracing workflow](../grpc-app-auth/.github/workflows/README.md)
+
 ## Contributions
 
 Contributions and PRs are most welcome! Feel free to fork the repository, make your changes, and submit a pull request.