chi

Documentation

Overview

Package chi provides tracing functions for tracing the go-chi/chi package (https://github.com/go-chi/chi).

Example

package main

import (
	"net/http"

	"github.com/go-chi/chi"

	chitrace "git.proto.group/protoobp/pobp-trace-go/contrib/go-chi/chi"
	"git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func handler(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("Hello World!\n"))
}

func main() {
	// Start the tracer
	tracer.Start()
	defer tracer.Stop()

	// Create a chi Router
	router := chi.NewRouter()

	// Use the tracer middleware with the default service name "chi.router".
	router.Use(chitrace.Middleware())

	// Set up some endpoints.
	router.Get("/", handler)

	// And start gathering request traces
	http.ListenAndServe(":8080", router)
}

Example (WithServiceName)

package main

import (
	"net/http"

	"github.com/go-chi/chi"

	chitrace "git.proto.group/protoobp/pobp-trace-go/contrib/go-chi/chi"
	"git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func handler(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("Hello World!\n"))
}

func main() {
	// Start the tracer
	tracer.Start()
	defer tracer.Stop()

	// Create a chi Router
	router := chi.NewRouter()

	// Use the tracer middleware with your desired service name.
	router.Use(chitrace.Middleware(chitrace.WithServiceName("chi-server")))

	// Set up some endpoints.
	router.Get("/", handler)

	// And start gathering request traces
	http.ListenAndServe(":8080", router)
}

Index

• func Middleware(opts ...Option) func(next http.Handler) http.Handler
• type Option
  • func WithAnalytics(on bool) Option
  • func WithAnalyticsRate(rate float64) Option
  • func WithIgnoreRequest(fn func(r *http.Request) bool) Option
  • func WithServiceName(name string) Option
  • func WithSpanOptions(opts ...pobptrace.StartSpanOption) Option
  • func WithStatusCheck(fn func(statusCode int) bool) Option

Examples

• Package
• Package (WithServiceName)

Functions

func Middleware

func Middleware(opts ...Option) func(next http.Handler) http.Handler

Middleware returns middleware that will trace incoming requests.

Types

type Option

type Option func(*config)

Option represents an option that can be passed to NewRouter.

func WithAnalytics

func WithAnalytics(on bool) Option

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate

func WithAnalyticsRate(rate float64) Option

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

func WithIgnoreRequest

func WithIgnoreRequest(fn func(r *http.Request) bool) Option

WithIgnoreRequest specifies a function to use for determining if the incoming HTTP request tracing should be skipped.

func WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the given service name for the router.

func WithSpanOptions

func WithSpanOptions(opts ...pobptrace.StartSpanOption) Option

WithSpanOptions applies the given set of options to the spans started by the router.

func WithStatusCheck

func WithStatusCheck(fn func(statusCode int) bool) Option

WithStatusCheck specifies a function fn which reports whether the passed statusCode should be considered an error.