Documentation
¶
Overview ¶
Package http provides functions to trace the net/http package (https://golang.org/pkg/net/http).
Example ¶
package main
import (
"net/http"
httptrace "git.proto.group/protoobp/pobp-trace-go/contrib/net/http"
)
func main() {
mux := httptrace.NewServeMux()
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Hello World!\n"))
})
http.ListenAndServe(":8080", mux)
}
Output:
Example (WithServiceName) ¶
package main
import (
"net/http"
httptrace "git.proto.group/protoobp/pobp-trace-go/contrib/net/http"
)
func main() {
mux := httptrace.NewServeMux(httptrace.WithServiceName("my-service"))
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Hello World!\n"))
})
http.ListenAndServe(":8080", mux)
}
Output:
Index ¶
- func TraceAndServe(h http.Handler, w http.ResponseWriter, r *http.Request, cfg *ServeConfig)
- func WrapClient(c *http.Client, opts ...RoundTripperOption) *http.Client
- func WrapHandler(h http.Handler, service, resource string, opts ...Option) http.Handler
- func WrapRoundTripper(rt http.RoundTripper, opts ...RoundTripperOption) http.RoundTripper
- type MuxOption
- type Option
- type RoundTripperAfterFunc
- type RoundTripperBeforeFunc
- type RoundTripperOption
- func RTWithAnalytics(on bool) RoundTripperOption
- func RTWithAnalyticsRate(rate float64) RoundTripperOption
- func RTWithResourceNamer(namer func(req *http.Request) string) RoundTripperOption
- func RTWithServiceName(name string) RoundTripperOption
- func RTWithSpanOptions(opts ...pobptrace.StartSpanOption) RoundTripperOption
- func WithAfter(f RoundTripperAfterFunc) RoundTripperOption
- func WithBefore(f RoundTripperBeforeFunc) RoundTripperOption
- type ServeConfig
- type ServeMux
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func TraceAndServe ¶
func TraceAndServe(h http.Handler, w http.ResponseWriter, r *http.Request, cfg *ServeConfig)
TraceAndServe serves the handler h using the given ResponseWriter and Request, applying tracing according to the specified config.
Example ¶
package main
import (
"net/http"
httptrace "git.proto.group/protoobp/pobp-trace-go/contrib/net/http"
)
func main() {
mux := http.NewServeMux()
mux.Handle("/", traceMiddleware(mux, http.HandlerFunc(Index)))
http.ListenAndServe(":8080", mux)
}
func Index(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Hello World!\n"))
}
func traceMiddleware(mux *http.ServeMux, next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
_, route := mux.Handler(r)
resource := r.Method + " " + route
httptrace.TraceAndServe(next, w, r, &httptrace.ServeConfig{
Service: "http.router",
Resource: resource,
QueryParams: true,
})
})
}
Output:
func WrapClient ¶
func WrapClient(c *http.Client, opts ...RoundTripperOption) *http.Client
WrapClient modifies the given client's transport to augment it with tracing and returns it.
func WrapHandler ¶
WrapHandler wraps an http.Handler with tracing using the given service and resource. If the WithResourceNamer option is provided as part of opts, it will take precedence over the resource argument.
func WrapRoundTripper ¶
func WrapRoundTripper(rt http.RoundTripper, opts ...RoundTripperOption) http.RoundTripper
WrapRoundTripper returns a new RoundTripper which traces all requests sent over the transport.
Types ¶
type MuxOption ¶
type MuxOption = Option
MuxOption has been deprecated in favor of Option.
func WithAnalytics ¶
WithAnalytics enables Trace Analytics for all started spans.
func WithAnalyticsRate ¶
WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func WithIgnoreRequest ¶
WithIgnoreRequest holds the function to use for determining if the incoming HTTP request tracing should be skipped.
func WithServiceName ¶
WithServiceName sets the given service name for the returned ServeMux.
type Option ¶
type Option func(*config)
Option represents an option that can be passed to NewServeMux or WrapHandler.
func NoDebugStack ¶
func NoDebugStack() Option
NoDebugStack prevents stack traces from being attached to spans finishing with an error. This is useful in situations where errors are frequent and performance is critical.
func WithResourceNamer ¶
WithResourceNamer populates the name of a resource based on a custom function.
func WithSpanOptions ¶
func WithSpanOptions(opts ...pobptrace.StartSpanOption) Option
WithSpanOptions defines a set of additional pobptrace.StartSpanOption to be added to spans started by the integration.
type RoundTripperAfterFunc ¶
A RoundTripperAfterFunc can be used to modify a span after an http RoundTrip is made. It is possible for the http Response to be nil.
type RoundTripperBeforeFunc ¶
A RoundTripperBeforeFunc can be used to modify a span before an http RoundTrip is made.
type RoundTripperOption ¶
type RoundTripperOption func(*roundTripperConfig)
A RoundTripperOption represents an option that can be passed to WrapRoundTripper.
func RTWithAnalytics ¶
func RTWithAnalytics(on bool) RoundTripperOption
RTWithAnalytics enables Trace Analytics for all started spans.
func RTWithAnalyticsRate ¶
func RTWithAnalyticsRate(rate float64) RoundTripperOption
RTWithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func RTWithResourceNamer ¶
func RTWithResourceNamer(namer func(req *http.Request) string) RoundTripperOption
RTWithResourceNamer specifies a function which will be used to obtain the resource name for a given request.
func RTWithServiceName ¶
func RTWithServiceName(name string) RoundTripperOption
RTWithServiceName sets the given service name for the RoundTripper.
func RTWithSpanOptions ¶
func RTWithSpanOptions(opts ...pobptrace.StartSpanOption) RoundTripperOption
RTWithSpanOptions defines a set of additional pobptrace.StartSpanOption to be added to spans started by the integration.
func WithAfter ¶
func WithAfter(f RoundTripperAfterFunc) RoundTripperOption
WithAfter adds a RoundTripperAfterFunc to the RoundTripper config.
func WithBefore ¶
func WithBefore(f RoundTripperBeforeFunc) RoundTripperOption
WithBefore adds a RoundTripperBeforeFunc to the RoundTripper config.
type ServeConfig ¶
type ServeConfig struct {
// Service specifies the service name to use. If left blank, the global service name
// will be inherited.
Service string
// Resource optionally specifies the resource name for this request.
Resource string
// QueryParams should be true in order to append the URL query values to the "http.url" tag.
QueryParams bool
// Route is the request matched route if any, or is empty otherwise
Route string
// RouteParams specifies framework-specific route parameters (e.g. for route /user/:id coming
// in as /user/123 we'll have {"id": "123"}). This field is optional and is used for monitoring
// by AppSec. It is only taken into account when AppSec is enabled.
RouteParams map[string]string
// FinishOpts specifies any options to be used when finishing the request span.
FinishOpts []pobptrace.FinishOption
// SpanOpts specifies any options to be applied to the request starting span.
SpanOpts []pobptrace.StartSpanOption
}
ServeConfig specifies the tracing configuration when using TraceAndServe.
type ServeMux ¶
ServeMux is an HTTP request multiplexer that traces all the incoming requests.
func NewServeMux ¶
NewServeMux allocates and returns an http.ServeMux augmented with the global tracer.
func (*ServeMux) ServeHTTP ¶
func (mux *ServeMux) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP dispatches the request to the handler whose pattern most closely matches the request URL. We only need to rewrite this function to be able to trace all the incoming requests to the underlying multiplexer
Source Files