chore: add some comments

uptrace · Oct 4, 2022 · 6b6a44f · 6b6a44f
1 parent 3221d18
commit 6b6a44f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/otelplay/otelplay.go b/otelplay/otelplay.go
@@ -28,6 +28,11 @@ func TraceURL(span trace.Span) string {
 	}
 }
 
+// ConfigureOpentelemetry configures Opentelemetry to export spans to Uptrace, Jaeger,
+// or console depending on environment variables.
+//
+// You can use it to run examples, but don't use it in your applications. Instead, use
+// uptrace-go or opentelemetry-go directly. See https://uptrace.dev/get/uptrace-go.html
 func ConfigureOpentelemetry(ctx context.Context) func() {
 	switch {
 	case os.Getenv("UPTRACE_DSN") != "":