From f02a261624ce01b67b793503ae5fb60e06a8a858 Mon Sep 17 00:00:00 2001 From: Bartek Plotka Date: Fri, 5 Jul 2019 09:59:38 +0100 Subject: [PATCH] Updated github.com/opentracing-contrib/go-stdlib to latest version for flusher. Signed-off-by: Bartek Plotka --- go.sum | 4 +- .../opentracing-contrib/go-stdlib/LICENSE | 218 +++++++++++++-- .../go-stdlib/nethttp/client.go | 146 ++++++++-- .../go-stdlib/nethttp/server.go | 101 +++++-- .../nethttp/status-code-tracker-old.go | 145 ++++++++++ .../go-stdlib/nethttp/status-code-tracker.go | 257 ++++++++++++++++++ vendor/modules.txt | 2 +- 7 files changed, 801 insertions(+), 72 deletions(-) create mode 100644 vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker-old.go create mode 100644 vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker.go diff --git a/go.sum b/go.sum index 835d2f0fad..0d94486f5b 100644 --- a/go.sum +++ b/go.sum @@ -252,8 +252,8 @@ github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+W github.com/onsi/gomega v0.0.0-20190113212917-5533ce8a0da3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= github.com/onsi/gomega v1.4.3 h1:RE1xgDvH7imwFD45h+u2SgIfERHlS2yNG4DObb5BSKU= github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= -github.com/opentracing-contrib/go-stdlib v0.0.0-20170113013457-1de4cc2120e7 h1:8KbikWulLUcMM96hBxjgoo6gTmCkG6HYSDohv/WygYU= -github.com/opentracing-contrib/go-stdlib v0.0.0-20170113013457-1de4cc2120e7/go.mod h1:PLldrQSroqzH70Xl+1DQcGnefIbqsKR7UDaiux3zV+w= +github.com/opentracing-contrib/go-stdlib v0.0.0-20190519235532-cf7a6c988dc9 h1:QsgXACQhd9QJhEmRumbsMQQvBtmdS0mafoVEBplWXEg= +github.com/opentracing-contrib/go-stdlib v0.0.0-20190519235532-cf7a6c988dc9/go.mod h1:PLldrQSroqzH70Xl+1DQcGnefIbqsKR7UDaiux3zV+w= github.com/opentracing/opentracing-go v1.0.2 h1:3jA2P6O1F9UOrWVpwrIo17pu01KWvNWg4X946/Y5Zwg= github.com/opentracing/opentracing-go v1.0.2/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o= github.com/openzipkin/zipkin-go v0.1.6/go.mod h1:QgAqvLzwWbR/WpD4A3cGpPtJrZXNIiJc5AZX7/PBEpw= diff --git a/vendor/github.com/opentracing-contrib/go-stdlib/LICENSE b/vendor/github.com/opentracing-contrib/go-stdlib/LICENSE index c259d12907..261eeb9e9f 100644 --- a/vendor/github.com/opentracing-contrib/go-stdlib/LICENSE +++ b/vendor/github.com/opentracing-contrib/go-stdlib/LICENSE @@ -1,27 +1,201 @@ -Copyright (c) 2016, opentracing-contrib -All rights reserved. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. + 1. Definitions. -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. -* Neither the name of go-stdlib nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/client.go b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/client.go index 861a69265c..375105d27b 100644 --- a/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/client.go +++ b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/client.go @@ -10,6 +10,7 @@ import ( "github.com/opentracing/opentracing-go" "github.com/opentracing/opentracing-go/ext" + "github.com/opentracing/opentracing-go/log" ) type contextKey int @@ -18,6 +19,8 @@ const ( keyTracer contextKey = iota ) +const defaultComponentName = "net/http" + // Transport wraps a RoundTripper. If a request is being traced with // Tracer, Transport will inject the current span into the headers, // and set HTTP related tags on the span. @@ -28,8 +31,11 @@ type Transport struct { } type clientOptions struct { - opName string - disableClientTrace bool + operationName string + componentName string + disableClientTrace bool + disableInjectSpanContext bool + spanObserver func(span opentracing.Span, r *http.Request) } // ClientOption contols the behavior of TraceRequest. @@ -37,9 +43,17 @@ type ClientOption func(*clientOptions) // OperationName returns a ClientOption that sets the operation // name for the client-side span. -func OperationName(opName string) ClientOption { +func OperationName(operationName string) ClientOption { return func(options *clientOptions) { - options.opName = opName + options.operationName = operationName + } +} + +// ComponentName returns a ClientOption that sets the component +// name for the client-side span. +func ComponentName(componentName string) ClientOption { + return func(options *clientOptions) { + options.componentName = componentName } } @@ -51,6 +65,24 @@ func ClientTrace(enabled bool) ClientOption { } } +// InjectSpanContext returns a ClientOption that turns on or off +// injection of the Span context in the request HTTP headers. +// If this option is not used, the default behaviour is to +// inject the span context. +func InjectSpanContext(enabled bool) ClientOption { + return func(options *clientOptions) { + options.disableInjectSpanContext = !enabled + } +} + +// ClientSpanObserver returns a ClientOption that observes the span +// for the client-side span. +func ClientSpanObserver(f func(span opentracing.Span, r *http.Request)) ClientOption { + return func(options *clientOptions) { + options.spanObserver = f + } +} + // TraceRequest adds a ClientTracer to req, tracing the request and // all requests caused due to redirects. When tracing requests this // way you must also use Transport. @@ -76,7 +108,9 @@ func ClientTrace(enabled bool) ClientOption { // return nil // } func TraceRequest(tr opentracing.Tracer, req *http.Request, options ...ClientOption) (*http.Request, *Tracer) { - opts := &clientOptions{} + opts := &clientOptions{ + spanObserver: func(_ opentracing.Span, _ *http.Request) {}, + } for _, opt := range options { opt(opts) } @@ -96,19 +130,29 @@ type closeTracker struct { func (c closeTracker) Close() error { err := c.ReadCloser.Close() - c.sp.LogEvent("Closed body") + c.sp.LogFields(log.String("event", "ClosedBody")) c.sp.Finish() return err } +// TracerFromRequest retrieves the Tracer from the request. If the request does +// not have a Tracer it will return nil. +func TracerFromRequest(req *http.Request) *Tracer { + tr, ok := req.Context().Value(keyTracer).(*Tracer) + if !ok { + return nil + } + return tr +} + // RoundTrip implements the RoundTripper interface. func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error) { rt := t.RoundTripper if rt == nil { rt = http.DefaultTransport } - tracer, ok := req.Context().Value(keyTracer).(*Tracer) - if !ok { + tracer := TracerFromRequest(req) + if tracer == nil { return rt.RoundTrip(req) } @@ -116,9 +160,13 @@ func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error) { ext.HTTPMethod.Set(tracer.sp, req.Method) ext.HTTPUrl.Set(tracer.sp, req.URL.String()) + tracer.opts.spanObserver(tracer.sp, req) + + if !tracer.opts.disableInjectSpanContext { + carrier := opentracing.HTTPHeadersCarrier(req.Header) + tracer.sp.Tracer().Inject(tracer.sp.Context(), opentracing.HTTPHeaders, carrier) + } - carrier := opentracing.HTTPHeadersCarrier(req.Header) - tracer.sp.Tracer().Inject(tracer.sp.Context(), opentracing.HTTPHeaders, carrier) resp, err := rt.RoundTrip(req) if err != nil { @@ -126,6 +174,9 @@ func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error) { return resp, err } ext.HTTPStatusCode.Set(tracer.sp, uint16(resp.StatusCode)) + if resp.StatusCode >= http.StatusInternalServerError { + ext.Error.Set(tracer.sp, true) + } if req.Method == "HEAD" { tracer.sp.Finish() } else { @@ -149,18 +200,23 @@ func (h *Tracer) start(req *http.Request) opentracing.Span { if parent != nil { spanctx = parent.Context() } - opName := h.opts.opName - if opName == "" { - opName = "HTTP Client" + operationName := h.opts.operationName + if operationName == "" { + operationName = "HTTP Client" } - root := h.tr.StartSpan(opName, opentracing.ChildOf(spanctx)) + root := h.tr.StartSpan(operationName, opentracing.ChildOf(spanctx)) h.root = root } ctx := h.root.Context() h.sp = h.tr.StartSpan("HTTP "+req.Method, opentracing.ChildOf(ctx)) ext.SpanKindRPCClient.Set(h.sp) - ext.Component.Set(h.sp, "net/http") + + componentName := h.opts.componentName + if componentName == "" { + componentName = defaultComponentName + } + ext.Component.Set(h.sp, componentName) return h.sp } @@ -197,54 +253,88 @@ func (h *Tracer) clientTrace() *httptrace.ClientTrace { func (h *Tracer) getConn(hostPort string) { ext.HTTPUrl.Set(h.sp, hostPort) - h.sp.LogEvent("Get conn") + h.sp.LogFields(log.String("event", "GetConn")) } func (h *Tracer) gotConn(info httptrace.GotConnInfo) { h.sp.SetTag("net/http.reused", info.Reused) h.sp.SetTag("net/http.was_idle", info.WasIdle) - h.sp.LogEvent("Got conn") + h.sp.LogFields(log.String("event", "GotConn")) } func (h *Tracer) putIdleConn(error) { - h.sp.LogEvent("Put idle conn") + h.sp.LogFields(log.String("event", "PutIdleConn")) } func (h *Tracer) gotFirstResponseByte() { - h.sp.LogEvent("Got first response byte") + h.sp.LogFields(log.String("event", "GotFirstResponseByte")) } func (h *Tracer) got100Continue() { - h.sp.LogEvent("Got 100 continue") + h.sp.LogFields(log.String("event", "Got100Continue")) } func (h *Tracer) dnsStart(info httptrace.DNSStartInfo) { - h.sp.LogEventWithPayload("DNS start", info.Host) + h.sp.LogFields( + log.String("event", "DNSStart"), + log.String("host", info.Host), + ) } -func (h *Tracer) dnsDone(httptrace.DNSDoneInfo) { - h.sp.LogEvent("DNS done") +func (h *Tracer) dnsDone(info httptrace.DNSDoneInfo) { + fields := []log.Field{log.String("event", "DNSDone")} + for _, addr := range info.Addrs { + fields = append(fields, log.String("addr", addr.String())) + } + if info.Err != nil { + fields = append(fields, log.Error(info.Err)) + } + h.sp.LogFields(fields...) } func (h *Tracer) connectStart(network, addr string) { - h.sp.LogEventWithPayload("Connect start", network+":"+addr) + h.sp.LogFields( + log.String("event", "ConnectStart"), + log.String("network", network), + log.String("addr", addr), + ) } func (h *Tracer) connectDone(network, addr string, err error) { - h.sp.LogEventWithPayload("Connect done", network+":"+addr) + if err != nil { + h.sp.LogFields( + log.String("message", "ConnectDone"), + log.String("network", network), + log.String("addr", addr), + log.String("event", "error"), + log.Error(err), + ) + } else { + h.sp.LogFields( + log.String("event", "ConnectDone"), + log.String("network", network), + log.String("addr", addr), + ) + } } func (h *Tracer) wroteHeaders() { - h.sp.LogEvent("Wrote headers") + h.sp.LogFields(log.String("event", "WroteHeaders")) } func (h *Tracer) wait100Continue() { - h.sp.LogEvent("Wait 100 continue") + h.sp.LogFields(log.String("event", "Wait100Continue")) } func (h *Tracer) wroteRequest(info httptrace.WroteRequestInfo) { if info.Err != nil { + h.sp.LogFields( + log.String("message", "WroteRequest"), + log.String("event", "error"), + log.Error(info.Err), + ) ext.Error.Set(h.sp, true) + } else { + h.sp.LogFields(log.String("event", "WroteRequest")) } - h.sp.LogEvent("Wrote request") } diff --git a/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/server.go b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/server.go index e94acc33db..e98f2b36de 100644 --- a/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/server.go +++ b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/server.go @@ -4,26 +4,21 @@ package nethttp import ( "net/http" + "net/url" opentracing "github.com/opentracing/opentracing-go" "github.com/opentracing/opentracing-go/ext" ) -type statusCodeTracker struct { - http.ResponseWriter - status int -} - -func (w *statusCodeTracker) WriteHeader(status int) { - w.status = status - w.ResponseWriter.WriteHeader(status) -} - type mwOptions struct { - opNameFunc func(r *http.Request) string + opNameFunc func(r *http.Request) string + spanFilter func(r *http.Request) bool + spanObserver func(span opentracing.Span, r *http.Request) + urlTagFunc func(u *url.URL) string + componentName string } -// MWOption contols the behavior of the Middleware. +// MWOption controls the behavior of the Middleware. type MWOption func(*mwOptions) // OperationNameFunc returns a MWOption that uses given function f @@ -34,6 +29,40 @@ func OperationNameFunc(f func(r *http.Request) string) MWOption { } } +// MWComponentName returns a MWOption that sets the component name +// for the server-side span. +func MWComponentName(componentName string) MWOption { + return func(options *mwOptions) { + options.componentName = componentName + } +} + +// MWSpanFilter returns a MWOption that filters requests from creating a span +// for the server-side span. +// Span won't be created if it returns false. +func MWSpanFilter(f func(r *http.Request) bool) MWOption { + return func(options *mwOptions) { + options.spanFilter = f + } +} + +// MWSpanObserver returns a MWOption that observe the span +// for the server-side span. +func MWSpanObserver(f func(span opentracing.Span, r *http.Request)) MWOption { + return func(options *mwOptions) { + options.spanObserver = f + } +} + +// MWURLTagFunc returns a MWOption that uses given function f +// to set the span's http.url tag. Can be used to change the default +// http.url tag, eg to redact sensitive information. +func MWURLTagFunc(f func(u *url.URL) string) MWOption { + return func(options *mwOptions) { + options.urlTagFunc = f + } +} + // Middleware wraps an http.Handler and traces incoming requests. // Additionally, it adds the span to the request's context. // @@ -49,32 +78,66 @@ func OperationNameFunc(f func(r *http.Request) string) MWOption { // mw := nethttp.Middleware( // tracer, // http.DefaultServeMux, -// nethttp.OperationName(func(r *http.Request) string { +// nethttp.OperationNameFunc(func(r *http.Request) string { // return "HTTP " + r.Method + ":/api/customers" // }), +// nethttp.MWSpanObserver(func(sp opentracing.Span, r *http.Request) { +// sp.SetTag("http.uri", r.URL.EscapedPath()) +// }), // ) func Middleware(tr opentracing.Tracer, h http.Handler, options ...MWOption) http.Handler { + return MiddlewareFunc(tr, h.ServeHTTP, options...) +} + +// MiddlewareFunc wraps an http.HandlerFunc and traces incoming requests. +// It behaves identically to the Middleware function above. +// +// Example: +// http.ListenAndServe("localhost:80", nethttp.MiddlewareFunc(tracer, MyHandler)) +func MiddlewareFunc(tr opentracing.Tracer, h http.HandlerFunc, options ...MWOption) http.HandlerFunc { opts := mwOptions{ opNameFunc: func(r *http.Request) string { return "HTTP " + r.Method }, + spanFilter: func(r *http.Request) bool { return true }, + spanObserver: func(span opentracing.Span, r *http.Request) {}, + urlTagFunc: func(u *url.URL) string { + return u.String() + }, } for _, opt := range options { opt(&opts) } fn := func(w http.ResponseWriter, r *http.Request) { + if !opts.spanFilter(r) { + h(w, r) + return + } ctx, _ := tr.Extract(opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(r.Header)) sp := tr.StartSpan(opts.opNameFunc(r), ext.RPCServerOption(ctx)) ext.HTTPMethod.Set(sp, r.Method) - ext.HTTPUrl.Set(sp, r.URL.String()) - ext.Component.Set(sp, "net/http") - w = &statusCodeTracker{w, 200} + ext.HTTPUrl.Set(sp, opts.urlTagFunc(r.URL)) + opts.spanObserver(sp, r) + + // set component name, use "net/http" if caller does not specify + componentName := opts.componentName + if componentName == "" { + componentName = defaultComponentName + } + ext.Component.Set(sp, componentName) + + sct := &statusCodeTracker{ResponseWriter: w} r = r.WithContext(opentracing.ContextWithSpan(r.Context(), sp)) - h.ServeHTTP(w, r) + defer func() { + ext.HTTPStatusCode.Set(sp, uint16(sct.status)) + if sct.status >= http.StatusInternalServerError || !sct.wroteheader { + ext.Error.Set(sp, true) + } + sp.Finish() + }() - ext.HTTPStatusCode.Set(sp, uint16(w.(*statusCodeTracker).status)) - sp.Finish() + h(sct.wrappedResponseWriter(), r) } return http.HandlerFunc(fn) } diff --git a/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker-old.go b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker-old.go new file mode 100644 index 0000000000..8704e5169b --- /dev/null +++ b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker-old.go @@ -0,0 +1,145 @@ +// +build go1.7,!go1.8 + +package nethttp + +import ( + "io" + "net/http" +) + +type statusCodeTracker struct { + http.ResponseWriter + status int + wroteheader bool +} + +func (w *statusCodeTracker) WriteHeader(status int) { + w.status = status + w.wroteheader = true + w.ResponseWriter.WriteHeader(status) +} + +func (w *statusCodeTracker) Write(b []byte) (int, error) { + if !w.wroteheader { + w.wroteheader = true + w.status = 200 + } + return w.ResponseWriter.Write(b) +} + +// wrappedResponseWriter returns a wrapped version of the original +// ResponseWriter and only implements the same combination of additional +// interfaces as the original. This implementation is based on +// https://github.com/felixge/httpsnoop. +func (w *statusCodeTracker) wrappedResponseWriter() http.ResponseWriter { + var ( + hj, i0 = w.ResponseWriter.(http.Hijacker) + cn, i1 = w.ResponseWriter.(http.CloseNotifier) + fl, i3 = w.ResponseWriter.(http.Flusher) + rf, i4 = w.ResponseWriter.(io.ReaderFrom) + ) + i2 := false + + switch { + case !i0 && !i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + }{w} + case !i0 && !i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + io.ReaderFrom + }{w, rf} + case !i0 && !i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Flusher + }{w, fl} + case !i0 && !i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Flusher + io.ReaderFrom + }{w, fl, rf} + case !i0 && i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.CloseNotifier + }{w, cn} + case !i0 && i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.CloseNotifier + io.ReaderFrom + }{w, cn, rf} + case !i0 && i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Flusher + }{w, cn, fl} + case !i0 && i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Flusher + io.ReaderFrom + }{w, cn, fl, rf} + case i0 && !i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + }{w, hj} + case i0 && !i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + io.ReaderFrom + }{w, hj, rf} + case i0 && !i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Flusher + }{w, hj, fl} + case i0 && !i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Flusher + io.ReaderFrom + }{w, hj, fl, rf} + case i0 && i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + }{w, hj, cn} + case i0 && i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + io.ReaderFrom + }{w, hj, cn, rf} + case i0 && i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Flusher + }{w, hj, cn, fl} + case i0 && i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Flusher + io.ReaderFrom + }{w, hj, cn, fl, rf} + default: + return struct { + http.ResponseWriter + }{w} + } +} diff --git a/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker.go b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker.go new file mode 100644 index 0000000000..2b2753140b --- /dev/null +++ b/vendor/github.com/opentracing-contrib/go-stdlib/nethttp/status-code-tracker.go @@ -0,0 +1,257 @@ +// +build go1.8 + +package nethttp + +import ( + "io" + "net/http" +) + +type statusCodeTracker struct { + http.ResponseWriter + status int + wroteheader bool +} + +func (w *statusCodeTracker) WriteHeader(status int) { + w.status = status + w.wroteheader = true + w.ResponseWriter.WriteHeader(status) +} + +func (w *statusCodeTracker) Write(b []byte) (int, error) { + if !w.wroteheader { + w.wroteheader = true + w.status = 200 + } + return w.ResponseWriter.Write(b) +} + +// wrappedResponseWriter returns a wrapped version of the original +// ResponseWriter and only implements the same combination of additional +// interfaces as the original. This implementation is based on +// https://github.com/felixge/httpsnoop. +func (w *statusCodeTracker) wrappedResponseWriter() http.ResponseWriter { + var ( + hj, i0 = w.ResponseWriter.(http.Hijacker) + cn, i1 = w.ResponseWriter.(http.CloseNotifier) + pu, i2 = w.ResponseWriter.(http.Pusher) + fl, i3 = w.ResponseWriter.(http.Flusher) + rf, i4 = w.ResponseWriter.(io.ReaderFrom) + ) + + switch { + case !i0 && !i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + }{w} + case !i0 && !i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + io.ReaderFrom + }{w, rf} + case !i0 && !i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Flusher + }{w, fl} + case !i0 && !i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Flusher + io.ReaderFrom + }{w, fl, rf} + case !i0 && !i1 && i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.Pusher + }{w, pu} + case !i0 && !i1 && i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.Pusher + io.ReaderFrom + }{w, pu, rf} + case !i0 && !i1 && i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Pusher + http.Flusher + }{w, pu, fl} + case !i0 && !i1 && i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Pusher + http.Flusher + io.ReaderFrom + }{w, pu, fl, rf} + case !i0 && i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.CloseNotifier + }{w, cn} + case !i0 && i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.CloseNotifier + io.ReaderFrom + }{w, cn, rf} + case !i0 && i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Flusher + }{w, cn, fl} + case !i0 && i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Flusher + io.ReaderFrom + }{w, cn, fl, rf} + case !i0 && i1 && i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Pusher + }{w, cn, pu} + case !i0 && i1 && i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Pusher + io.ReaderFrom + }{w, cn, pu, rf} + case !i0 && i1 && i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Pusher + http.Flusher + }{w, cn, pu, fl} + case !i0 && i1 && i2 && i3 && i4: + return struct { + http.ResponseWriter + http.CloseNotifier + http.Pusher + http.Flusher + io.ReaderFrom + }{w, cn, pu, fl, rf} + case i0 && !i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + }{w, hj} + case i0 && !i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + io.ReaderFrom + }{w, hj, rf} + case i0 && !i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Flusher + }{w, hj, fl} + case i0 && !i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Flusher + io.ReaderFrom + }{w, hj, fl, rf} + case i0 && !i1 && i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Pusher + }{w, hj, pu} + case i0 && !i1 && i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Pusher + io.ReaderFrom + }{w, hj, pu, rf} + case i0 && !i1 && i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Pusher + http.Flusher + }{w, hj, pu, fl} + case i0 && !i1 && i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.Pusher + http.Flusher + io.ReaderFrom + }{w, hj, pu, fl, rf} + case i0 && i1 && !i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + }{w, hj, cn} + case i0 && i1 && !i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + io.ReaderFrom + }{w, hj, cn, rf} + case i0 && i1 && !i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Flusher + }{w, hj, cn, fl} + case i0 && i1 && !i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Flusher + io.ReaderFrom + }{w, hj, cn, fl, rf} + case i0 && i1 && i2 && !i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Pusher + }{w, hj, cn, pu} + case i0 && i1 && i2 && !i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Pusher + io.ReaderFrom + }{w, hj, cn, pu, rf} + case i0 && i1 && i2 && i3 && !i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Pusher + http.Flusher + }{w, hj, cn, pu, fl} + case i0 && i1 && i2 && i3 && i4: + return struct { + http.ResponseWriter + http.Hijacker + http.CloseNotifier + http.Pusher + http.Flusher + io.ReaderFrom + }{w, hj, cn, pu, fl, rf} + default: + return struct { + http.ResponseWriter + }{w} + } +} diff --git a/vendor/modules.txt b/vendor/modules.txt index 3e1a9be45d..fa078bdb91 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -246,7 +246,7 @@ github.com/mwitkow/go-conntrack github.com/oklog/run # github.com/oklog/ulid v1.3.1 github.com/oklog/ulid -# github.com/opentracing-contrib/go-stdlib v0.0.0-20170113013457-1de4cc2120e7 +# github.com/opentracing-contrib/go-stdlib v0.0.0-20190519235532-cf7a6c988dc9 github.com/opentracing-contrib/go-stdlib/nethttp # github.com/opentracing/opentracing-go v1.0.2 github.com/opentracing/opentracing-go