// Copyright 2020 beego // // 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. package opentracing import ( "context" logKit "github.com/go-kit/kit/log" opentracingKit "github.com/go-kit/kit/tracing/opentracing" "github.com/opentracing/opentracing-go" beego "github.com/astaxie/beego/pkg" beegoCtx "github.com/astaxie/beego/pkg/context" ) // FilterChainBuilder provides an extension point that we can support more configurations if necessary type FilterChainBuilder struct { // CustomSpanFunc makes users to custom the span. CustomSpanFunc func(span opentracing.Span, ctx *beegoCtx.Context) } func (builder *FilterChainBuilder) FilterChain(next beego.FilterFunc) beego.FilterFunc { return func(ctx *beegoCtx.Context) { var ( spanCtx context.Context span opentracing.Span ) operationName := builder.operationName(ctx) if preSpan := opentracing.SpanFromContext(ctx.Request.Context()); preSpan == nil { inject := opentracingKit.HTTPToContext(opentracing.GlobalTracer(), operationName, logKit.NewNopLogger()) spanCtx = inject(ctx.Request.Context(), ctx.Request) span = opentracing.SpanFromContext(spanCtx) } else { span, spanCtx = opentracing.StartSpanFromContext(ctx.Request.Context(), operationName) } defer span.Finish() newReq := ctx.Request.Clone(spanCtx) ctx.Reset(ctx.ResponseWriter.ResponseWriter, newReq) next(ctx) // if you think we need to do more things, feel free to create an issue to tell us span.SetTag("http.status_code", ctx.ResponseWriter.Status) span.SetTag("http.method", ctx.Input.Method()) span.SetTag("peer.hostname", ctx.Request.Host) span.SetTag("http.url", ctx.Request.URL.String()) span.SetTag("http.scheme", ctx.Request.URL.Scheme) span.SetTag("span.kind", "server") span.SetTag("component", "beego") if ctx.Output.IsServerError() || ctx.Output.IsClientError() { span.SetTag("error", true) } span.SetTag("peer.address", ctx.Request.RemoteAddr) span.SetTag("http.proto", ctx.Request.Proto) span.SetTag("beego.route", ctx.Input.GetData("RouterPattern")) if builder.CustomSpanFunc != nil { builder.CustomSpanFunc(span, ctx) } } } func (builder *FilterChainBuilder) operationName(ctx *beegoCtx.Context) string { operationName := ctx.Input.URL() // it means that there is not any span, so we create a span as the root span. // TODO, if we support multiple servers, this need to be changed route, found := beego.BeeApp.Handlers.FindRouter(ctx) if found { operationName = ctx.Input.Method() + "#" + route.GetPattern() } return operationName }