mirror of
https://github.com/sourcegraph/sourcegraph.git
synced 2026-02-06 19:21:50 +00:00
084a10ba3b
This will be my last PR related to the backend tracing work I've been doing. This is a set of small cleanups to the `trace` package that I've collecting as I have worked on tracing and used tracing. Following this PR, the `trace` package is just a very lightweight wrapper around the standard OpenTelemetry APIs. I think it's best to keep the package around rather than using opentelemetry directly because it easy to add convenience methods (which I would be sad to lose). Each commit is self-contained and has a descriptive message. If anyone wants to pick up where I'm leaving off, here are a few things left undone: - Convert Zoekt to use OpenTelemetry rather than OpenTracing - Add OpenTelemetry support to other services like syntect-server - Merge the `internal/trace` and `internal/tracer` packages - Consider adding a type that conforms to the OpenTelemetry `Span` interface but also writes to `x/net/trace` that can be enabled when tracing is not available. - Remove unrelated code from the `trace` and `tracer` package (see [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@a6759b95dbd8e5e3a604f7fd452b0b85f37091d9/-/blob/internal/tracer/tracer.go?L75-83) and [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@769fbbf5008e8decc63967dbff53f26333620265/-/blob/internal/trace/buckets.go?L3-7)) - Noodle on a `Traceable` interface (one that impls `Attr()` or `Attrs()`) so types can be easily added with `SetAttributes()` - Experiment with sampling - Experiment with replacing `policy.ShouldTrace` with native opentelemetry tools ## Test plan Tested manually that tracing still looks good locally. Will test on other instances when it rolls out. <!-- All pull requests REQUIRE a test plan: https://docs.sourcegraph.com/dev/background-information/testing_principles -->
15 lines
373 B
Go
15 lines
373 B
Go
package trace
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/sourcegraph/log"
|
|
)
|
|
|
|
// Logger will set the TraceContext on l if ctx has one. This is an expanded
|
|
// convenience function around l.WithTrace for the common case.
|
|
func Logger(ctx context.Context, l log.Logger) log.Logger {
|
|
// Attach any trace (WithTrace no-ops if empty trace is provided)
|
|
return l.WithTrace(Context(ctx))
|
|
}
|