instagin

README

Instana instrumentation for gin framework

This module contains middleware to instrument HTTP services written with github.com/gin-gonic/gin.

Compatibility

• Starting at version 1.6.0 of instagin, gin v1.9.0 is used, which requires Go v1.18 or higher

Installation

To add the module to your go.mod file run the following command in your project directory:

$ go get github.com/instana/go-sensor/instrumentation/instagin

Usage

// init gin engine
engine := gin.Default()

// create a sensor
sensor := instana.NewSensor("gin-sensor")

// add middleware to the gin handlers
instagin.AddMiddleware(sensor, engine)

// define API
engine.GET("/api", func(c *gin.Context) {}
...

Full example

Documentation

Index

• Constants
• func AddMiddleware(sensor instana.TracerLogger, engine *gin.Engine)
• func Default(sensor instana.TracerLogger) *gin.Engine
• func New(sensor instana.TracerLogger) *gin.Engine

Constants

const Version = "1.21.0"

Version is the instrumentation module semantic version

Functions

func AddMiddleware

func AddMiddleware(sensor instana.TracerLogger, engine *gin.Engine)

AddMiddleware adds the tracing middleware to the list of Gin handlers. Unlike the gin.Use method, it puts the middleware to the beginning of the list, to allow the tracing of default handlers added by the gin.Default() call.

func Default

func Default(sensor instana.TracerLogger) *gin.Engine

Default is wrapper for gin.Default()

func New

func New(sensor instana.TracerLogger) *gin.Engine

New is wrapper for gin.New()