1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
|
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
// Package nrhttprouter instruments https://github.com/julienschmidt/httprouter
// applications.
//
// Use this package to instrument inbound requests handled by a
// httprouter.Router. Use an *nrhttprouter.Router in place of your
// *httprouter.Router. Example:
//
// package main
//
// import (
// "fmt"
// "net/http"
// "os"
//
// "github.com/julienschmidt/httprouter"
// newrelic "github.com/newrelic/go-agent/v3/newrelic"
// "github.com/newrelic/go-agent/v3/integrations/nrhttprouter"
// )
//
// func main() {
// cfg := newrelic.NewConfig("httprouter App", os.Getenv("NEW_RELIC_LICENSE_KEY"))
// app, _ := newrelic.NewApplication(cfg)
//
// // Create the Router replacement:
// router := nrhttprouter.New(app)
//
// router.GET("/", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
// w.Write([]byte("welcome\n"))
// })
// router.GET("/hello/:name", (w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
// w.Write([]byte(fmt.Sprintf("hello %s\n", ps.ByName("name"))))
// })
// http.ListenAndServe(":8000", router)
// }
//
// Runnable example: https://github.com/newrelic/go-agent/tree/master/v3/integrations/nrhttprouter/example/main.go
package nrhttprouter
import (
"net/http"
"github.com/julienschmidt/httprouter"
"github.com/newrelic/go-agent/v3/internal"
newrelic "github.com/newrelic/go-agent/v3/newrelic"
)
func init() { internal.TrackUsage("integration", "framework", "httprouter") }
// Router should be used in place of httprouter.Router. Create it using
// New().
type Router struct {
*httprouter.Router
application *newrelic.Application
}
// New creates a new Router to be used in place of httprouter.Router.
func New(app *newrelic.Application) *Router {
return &Router{
Router: httprouter.New(),
application: app,
}
}
func txnName(method, path string) string {
return method + " " + path
}
func (r *Router) handle(method string, path string, original httprouter.Handle) {
handle := original
if nil != r.application {
handle = func(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
txn := r.application.StartTransaction(txnName(method, path))
txn.SetWebRequestHTTP(req)
w = txn.SetWebResponse(w)
defer txn.End()
req = newrelic.RequestWithTransactionContext(req, txn)
original(w, req, ps)
}
}
r.Router.Handle(method, path, handle)
}
// DELETE replaces httprouter.Router.DELETE.
func (r *Router) DELETE(path string, h httprouter.Handle) {
r.handle(http.MethodDelete, path, h)
}
// GET replaces httprouter.Router.GET.
func (r *Router) GET(path string, h httprouter.Handle) {
r.handle(http.MethodGet, path, h)
}
// HEAD replaces httprouter.Router.HEAD.
func (r *Router) HEAD(path string, h httprouter.Handle) {
r.handle(http.MethodHead, path, h)
}
// OPTIONS replaces httprouter.Router.OPTIONS.
func (r *Router) OPTIONS(path string, h httprouter.Handle) {
r.handle(http.MethodOptions, path, h)
}
// PATCH replaces httprouter.Router.PATCH.
func (r *Router) PATCH(path string, h httprouter.Handle) {
r.handle(http.MethodPatch, path, h)
}
// POST replaces httprouter.Router.POST.
func (r *Router) POST(path string, h httprouter.Handle) {
r.handle(http.MethodPost, path, h)
}
// PUT replaces httprouter.Router.PUT.
func (r *Router) PUT(path string, h httprouter.Handle) {
r.handle(http.MethodPut, path, h)
}
// Handle replaces httprouter.Router.Handle.
func (r *Router) Handle(method, path string, h httprouter.Handle) {
r.handle(method, path, h)
}
// Handler replaces httprouter.Router.Handler.
func (r *Router) Handler(method, path string, handler http.Handler) {
_, h := newrelic.WrapHandle(r.application, path, handler)
r.Router.Handler(method, path, h)
}
// HandlerFunc replaces httprouter.Router.HandlerFunc.
func (r *Router) HandlerFunc(method, path string, handler http.HandlerFunc) {
r.Handler(method, path, handler)
}
// ServeHTTP replaces httprouter.Router.ServeHTTP.
func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request) {
if nil != r.application {
h, _, _ := r.Router.Lookup(req.Method, req.URL.Path)
if nil == h {
txn := r.application.StartTransaction("NotFound")
defer txn.End()
req = newrelic.RequestWithTransactionContext(req, txn)
txn.SetWebRequestHTTP(req)
w = txn.SetWebResponse(w)
}
}
r.Router.ServeHTTP(w, req)
}
|