docs: improve ServeHTTP godoc with backwards compatibility note

tobert · Claude · Copilot · tobert · commit 36c3c35954e4 · 2025-11-11T22:52:59.000Z
Why: Copilot feedback on PR #18 correctly noted that backwards compatibility behavior should be documented in godoc, not just inline comments Approach: Added two lines to godoc explaining OTLP spec routing and backwards compatibility behavior for non-standard paths Learned: API behavior documentation belongs in godoc where users see it Next: Push changes and complete Copilot feedback evaluation Co-Authored-By: Claude <claude@anthropic.com> Co-Authored-By: Copilot <copilot@github.com>
diff --git a/otlpserver/httpserver.go b/otlpserver/httpserver.go
@@ -34,6 +34,8 @@ func NewHttpServer(cb TraceCallback, stop Stopper) *HttpServer {
 }
 
 // ServeHTTP routes requests to the appropriate handler based on URL path.
+// Routes /v1/traces to trace handler and /v1/logs to log handler per OTLP spec.
+// For backwards compatibility, all other paths are treated as trace endpoints.
 func (hs *HttpServer) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
 	// Route based on OTLP specification paths
 	switch req.RequestURI {

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,8 @@ func NewHttpServer(cb TraceCallback, stop Stopper) *HttpServer {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`// ServeHTTP routes requests to the appropriate handler based on URL path.`
	`37`	`+// Routes /v1/traces to trace handler and /v1/logs to log handler per OTLP spec.`
	`38`	`+// For backwards compatibility, all other paths are treated as trace endpoints.`
`37`	`39`	`func (hs HttpServer) ServeHTTP(rw http.ResponseWriter, req http.Request) {`
`38`	`40`	`// Route based on OTLP specification paths`
`39`	`41`	`switch req.RequestURI {`