search

actions / actions-runner-controller

Kubernetes controller for GitHub Actions self-hosted runners
Apache License 2.0
4.69k stars 1.11k forks source link

Adding support for open telemetry #1386

Open kwngo opened 2 years ago

kwngo commented 2 years ago

Is your feature request related to a problem? Please describe. Often we have trouble distinguishing whether root cause of any issue is something with the controller or our own self-hosted infrastructure. For example I'd like to see how long specific methods in the reconcilation loop are taking to run, to rule out any issues.

Describe the solution you'd like Similar to open metrics I'm thinking we can add support for open telemetry.

Describe alternatives you've considered We've enabled the open metrics which has already given us a lot more insight, but I think tracing will take it further.

Additional context

mumoshu commented 2 years ago

@kwngo Hey! This doesn't sound too bad, but I'm unsure it is worth the effort, or how we should prioritize this over other important issues.

What are the exact use-cases you have in mind? Have you ever encountered any performance problems using ARC, caused by GitHub API slowness, K8s slowness, or ARC's logic bug that makes it very slow to respond, etc? Or is this being suggested only to prepare for such events?

github-actions[bot] commented 2 years ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

mumoshu commented 2 years ago

Until we have a concrete set of requirements for what we want from tracing, we might better hold on until the tracing framework is finalized and added to controller-runtime, so that we don't repeat the effort. https://github.com/kubernetes-sigs/controller-runtime/issues/305

mumoshu commented 2 years ago

But adding some trace "logs" to some important code paths of ARC would still make sense, regardless of whether we adopt OpenTelemetry tracing. If anyone has any request to add a specific trace log to certain code path in ARC, please raise a feature request for that with your use-case. Thanks 🙏

pathcl commented 10 months ago

any ongoing effort? Im interested in working on it :)

isaacsanders commented 1 month ago

I was just thinking about how nice it would be to have an integration with github actions that works with the docker buildkit otel trace. It would just need to provide a TRACEPARENT and a TRACESTATE env var to work together.