feat: Move from datadog to generic otel #1567
add telemetry pkg
- Loading branch information
commit e0e433ccb17a53d6e8bfcbc48a0398ed8ffda77c
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| package telemetry | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc" | ||
| "go.opentelemetry.io/otel/sdk/resource" | ||
| sdktrace "go.opentelemetry.io/otel/sdk/trace" | ||
| semconv "go.opentelemetry.io/otel/semconv/v1.4.0" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| // Exporter creates a grpc otlp exporter and sets it as the global trace provider. | ||
| // Caller is responsible for closing exporter to ensure all data is flushed. | ||
| func Exporter(ctx context.Context, service string) (func(), error) { | ||
| res, err := resource.New(ctx, | ||
| resource.WithAttributes( | ||
| // the service name used to display traces in backends | ||
| semconv.ServiceNameKey.String(service), | ||
| ), | ||
| ) | ||
|
|
||
| otlptracegrpc.NewClient() | ||
| exporter, err := otlptrace.New(ctx, otlptracegrpc.NewClient()) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("creating otlp exporter: %w", err) | ||
| } | ||
|
|
||
| tracerProvider := sdktrace.NewTracerProvider( | ||
| sdktrace.WithBatcher(exporter), | ||
| sdktrace.WithResource(res), | ||
| ) | ||
| otel.SetTracerProvider(tracerProvider) | ||
|
|
||
| return func() { | ||
| _ = tracerProvider.Shutdown(ctx) | ||
| }, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| package telemetry | ||
|
There was a problem hiding this comment. I think the name There was a problem hiding this comment. I was on the fence between the two There was a problem hiding this comment. I put this higher level BECAUSE I didn't want to exclude the provisioner apps. Those reasonably could be traced as well, and those distributed traces would be connected in otel with the right glue code. That being said, we are not currently using any tracing in the other apps, so I'm also fine to move to There was a problem hiding this comment. I think we isolate for now. Nothing else has an HTTP server, and if that's our primary point of tracing I'd be hesitant to say we'll do it for other things soon. |
||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| "github.com/go-chi/chi/middleware" | ||
| "github.com/go-chi/chi/v5" | ||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/codes" | ||
| ) | ||
|
|
||
| // HTTPMW adds tracing to http routes. | ||
| func HTTPMW(tracer string) func(http.Handler) http.Handler { | ||
| return func(next http.Handler) http.Handler { | ||
| return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) { | ||
| // start span with default span name. Span name will be updated once request finishes | ||
| _, span := otel.Tracer(tracer).Start(r.Context(), "http.request") | ||
| defer span.End() | ||
|
|
||
| wrw := middleware.NewWrapResponseWriter(rw, r.ProtoMajor) | ||
|
|
||
| // pass the span through the request context and serve the request to the next middleware | ||
| next.ServeHTTP(rw, r) | ||
|
|
||
| // set the resource name as we get it only once the handler is executed | ||
| resourceName := chi.RouteContext(r.Context()).RoutePattern() | ||
| if resourceName == "" { | ||
| resourceName = "unknown" | ||
| } | ||
| resourceName = r.Method + " " + resourceName | ||
| span.SetName(resourceName) | ||
|
|
||
| // set the status code | ||
| status := wrw.Status() | ||
| // 0 status means one has not yet been sent in which case net/http library will write StatusOK | ||
| if status == 0 { | ||
| status = http.StatusOK | ||
| } | ||
| span.SetAttributes(attribute.KeyValue{ | ||
| Key: "http.status_code", | ||
| Value: attribute.IntValue(status), | ||
| }) | ||
|
|
||
| // if 5XX we set the span to "error" status | ||
| if status >= 500 { | ||
| span.SetStatus(codes.Error, fmt.Sprintf("%d: %s", status, http.StatusText(status))) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where does this actually send data?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can add a comment, but they get shipped to a local otel exporter by default. You can change where it gets shipped with otel env vars like
OTEL_COLLECTOR_ENDPOINTand such, so we don't need to write any code to support the configuration. The datadog agent we have deployed ondev.coder.comhas a collector built in, so this will automatically start sending the otel data there.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh I see! Even just an external link would help. I was expecting
--traceto accept an endpoint to write traces.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done