Documentation
¶
Overview ¶
Package httprouter provides functions to trace the julienschmidt/httprouter package (https://github.com/julienschmidt/httprouter).
Example ¶
package main
import (
"fmt"
"log"
"net/http"
httptrace "github.com/DataDog/dd-trace-go/v2/contrib/julienschmidt/httprouter"
"github.com/julienschmidt/httprouter"
)
func Index(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
fmt.Fprint(w, "Welcome!\n")
}
func Hello(w http.ResponseWriter, _ *http.Request, ps httprouter.Params) {
fmt.Fprintf(w, "hello, %s!\n", ps.ByName("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/julienschmidt/httprouter"
"github.com/julienschmidt/httprouter"
)
func Index(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
fmt.Fprint(w, "Welcome!\n")
}
func Hello(w http.ResponseWriter, _ *http.Request, ps httprouter.Params) {
fmt.Fprintf(w, "hello, %s!\n", ps.ByName("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/julienschmidt/httprouter"
"github.com/DataDog/dd-trace-go/v2/ddtrace/ext"
"github.com/DataDog/dd-trace-go/v2/ddtrace/tracer"
"github.com/julienschmidt/httprouter"
)
func Index(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
fmt.Fprint(w, "Welcome!\n")
}
func Hello(w http.ResponseWriter, _ *http.Request, ps httprouter.Params) {
fmt.Fprintf(w, "hello, %s!\n", ps.ByName("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 Router ¶
type Router struct {
*httprouter.Router
// contains filtered or unexported fields
}
Router is a traced version of httprouter.Router.
type RouterOption ¶
type RouterOption interface {
// contains filtered or unexported methods
}
RouterOption describes options for the HTTPRouter integration.
type RouterOptionFn ¶
type RouterOptionFn func(*routerConfig)
RouterOptionFn represents options applicable to New.
func WithAnalytics ¶
func WithAnalytics(on bool) RouterOptionFn
WithAnalytics enables Trace Analytics for all started spans.
func WithAnalyticsRate ¶
func WithAnalyticsRate(rate float64) RouterOptionFn
WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func WithHeaderTags ¶
func WithHeaderTags(headers []string) RouterOptionFn
WithHeaderTags enables the integration to attach HTTP request headers as span tags. Warning: Using this feature can risk exposing sensitive data such as authorization tokens to Datadog. Special headers can not be sub-selected. E.g., an entire Cookie header would be transmitted, without the ability to choose specific Cookies.
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