instamux

README

Instana instrumentation for gorilla mux

This module contains middleware to instrument HTTP services written with github.com/gorilla/mux.

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/instamux

Usage

// Create a collector
collector := instana.InitCollector(&instana.Options{
	Service: "my-web-server",
})

// Create router
r := mux.NewRouter()

// Instrument your router by adding a middleware
instamux.AddMiddleware(collector, r)

// Define handlers
r.HandleFunc("/foo", func(writer http.ResponseWriter, request *http.Request) {})
...

Full example

Documentation

Overview

Example

This example shows how to instrument an HTTP server that uses github.com/gorilla/mux with Instana

package main

import (
	"log"
	"net/http"

	"github.com/gorilla/mux"
	instana "github.com/instana/go-sensor"
	"github.com/instana/go-sensor/instrumentation/instamux"
)

func main() {
	// Initialize Instana collector
	c := instana.InitCollector(&instana.Options{
		Service: "my-web-server",
	})

	r := mux.NewRouter()
	// Add an instrumentation middleware to the router. This middleware will be applied to all handlers
	// registered with this instance.
	instamux.AddMiddleware(c, r)

	// Use mux.Router to register request handlers as usual
	r.HandleFunc("/foo", func(w http.ResponseWriter, req *http.Request) {
		// ...
	})

	if err := http.ListenAndServe(":0", nil); err != nil {
		log.Fatalf("failed to start server: %s", err)
	}
}

Index

• Constants
• func AddMiddleware(sensor instana.TracerLogger, router *mux.Router)
• func NewRouter(sensor instana.TracerLogger) *mux.Router

Examples

• Package

Constants

const Version = "1.25.0"

Version is the instrumentation module semantic version

Functions

func AddMiddleware

func AddMiddleware(sensor instana.TracerLogger, router *mux.Router)

AddMiddleware instruments the mux.Router instance with Instana

func NewRouter

func NewRouter(sensor instana.TracerLogger) *mux.Router

NewRouter is wrapper for mux.NewRouter()