dd-trace-go.v1: gopkg.in/DataDog/dd-trace-go.v1/contrib/gin-gonic/gin Index | Examples | Files

package gin

import "gopkg.in/DataDog/dd-trace-go.v1/contrib/gin-gonic/gin"

Package gin provides functions to trace the gin-gonic/gin package (https://github.com/gin-gonic/gin).

To start tracing requests, add the trace middleware to your Gin router.

Code:

// Create a gin.Engine
r := gin.New()

// Use the tracer middleware with your desired service name.
r.Use(gintrace.Middleware("my-web-app"))

// Set up some endpoints.
r.GET("/hello", func(c *gin.Context) {
    c.String(200, "hello world!")
})

// And start gathering request traces.
r.Run(":8080")

Code:

r := gin.Default()
r.Use(gintrace.Middleware("image-encoder"))
r.GET("/image/encode", func(c *gin.Context) {
    ctx := c.Request.Context()
    // create a child span to track operation timing.
    encodeSpan, _ := tracer.StartSpanFromContext(ctx, "image.encode")
    // encode a image
    encodeSpan.Finish()

    c.String(200, "ok!")
})

Index

Examples

Package Files

gintrace.go option.go

func HTML Uses

func HTML(c *gin.Context, code int, name string, obj interface{})

HTML will trace the rendering of the template as a child of the span in the given context.

Code:

r := gin.Default()
r.Use(gintrace.Middleware("my-web-app"))
r.LoadHTMLGlob("templates/*")

r.GET("/index", func(c *gin.Context) {
    // render the html and trace the execution time.
    gintrace.HTML(c, 200, "index.tmpl", gin.H{
        "title": "Main website",
    })
})

func Middleware Uses

func Middleware(service string, opts ...Option) gin.HandlerFunc

Middleware returns middleware that will trace incoming requests.

type Option Uses

type Option func(*config)

Option specifies instrumentation configuration options.

func WithAnalytics Uses

func WithAnalytics(on bool) Option

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate Uses

func WithAnalyticsRate(rate float64) Option

WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.

func WithResourceNamer Uses

func WithResourceNamer(namer func(c *gin.Context) string) Option

WithResourceNamer specifies a function which will be used to obtain a resource name for a given gin request, using the request's context.

Package gin imports 10 packages (graph). Updated 2020-08-31. Refresh now. Tools for package owners.