Documentation
¶
Overview ¶
Package httptreemux provides functions to trace the dimfeld/httptreemux/v5 package (https://github.com/dimfeld/httptreemux).
Package httptreemux provides functions to trace the dimfeld/httptreemux/v5 package (https://github.com/dimfeld/httptreemux).
Example ¶
package main
import (
"fmt"
"log"
"net/http"
httptrace "github.com/DataDog/dd-trace-go/v2/contrib/dimfeld/httptreemux.v5"
)
func Index(w http.ResponseWriter, _ *http.Request, _ map[string]string) {
fmt.Fprint(w, "Welcome!\n")
}
func Hello(w http.ResponseWriter, _ *http.Request, params map[string]string) {
fmt.Fprintf(w, "hello, %s!\n", params["name"])
}
func main() {
router := httptrace.New()
router.GET("/", Index)
router.GET("/hello/:name", Hello)
log.Fatal(http.ListenAndServe(":8080", router))
}
Output:
Example (WithServiceName) ¶
package main
import (
"fmt"
"log"
"net/http"
httptrace "github.com/DataDog/dd-trace-go/v2/contrib/dimfeld/httptreemux.v5"
)
func Index(w http.ResponseWriter, _ *http.Request, _ map[string]string) {
fmt.Fprint(w, "Welcome!\n")
}
func Hello(w http.ResponseWriter, _ *http.Request, params map[string]string) {
fmt.Fprintf(w, "hello, %s!\n", params["name"])
}
func main() {
router := httptrace.New(httptrace.WithService("http.router"))
router.GET("/", Index)
router.GET("/hello/:name", Hello)
log.Fatal(http.ListenAndServe(":8080", router))
}
Output:
Example (WithSpanOpts) ¶
package main
import (
"fmt"
"log"
"net/http"
httptrace "github.com/DataDog/dd-trace-go/v2/contrib/dimfeld/httptreemux.v5"
"github.com/DataDog/dd-trace-go/v2/ddtrace/ext"
"github.com/DataDog/dd-trace-go/v2/ddtrace/tracer"
)
func Index(w http.ResponseWriter, _ *http.Request, _ map[string]string) {
fmt.Fprint(w, "Welcome!\n")
}
func Hello(w http.ResponseWriter, _ *http.Request, params map[string]string) {
fmt.Fprintf(w, "hello, %s!\n", params["name"])
}
func main() {
router := httptrace.New(
httptrace.WithService("http.router"),
httptrace.WithSpanOptions(
tracer.Tag(ext.SamplingPriority, ext.PriorityUserKeep),
),
)
router.GET("/", Index)
router.GET("/hello/:name", Hello)
log.Fatal(http.ListenAndServe(":8080", router))
}
Output:
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContextRouter ¶
type ContextRouter struct {
*httptreemux.ContextMux
// contains filtered or unexported fields
}
ContextRouter is a traced version of httptreemux.ContextMux.
func NewWithContext ¶
func NewWithContext(opts ...RouterOption) *ContextRouter
NewWithContext returns a new router augmented with tracing and preconfigured to work with context objects. The matched route and parameters are added to the context.
func (*ContextRouter) ServeHTTP ¶
func (r *ContextRouter) ServeHTTP(w http.ResponseWriter, req *http.Request)
ServeHTTP implements http.Handler.
type Router ¶
type Router struct {
*httptreemux.TreeMux
// contains filtered or unexported fields
}
Router is a traced version of httptreemux.TreeMux.
type RouterOption ¶
type RouterOption interface {
// contains filtered or unexported methods
}
RouterOption describes options for the router.
type RouterOptionFn ¶
type RouterOptionFn func(*routerConfig)
RouterOptionFn represents options applicable to New and NewWithContext.
func WithResourceNamer ¶
func WithResourceNamer(namer func(router *httptreemux.TreeMux, w http.ResponseWriter, req *http.Request) string) RouterOptionFn
WithResourceNamer specifies a function which will be used to obtain the resource name for a given request.
func WithService ¶
func WithService(name string) RouterOptionFn
WithService sets the given service name for the returned router.
func WithSpanOptions ¶
func WithSpanOptions(opts ...tracer.StartSpanOption) RouterOptionFn
WithSpanOptions applies the given set of options to the span started by the router.
Source Files