Documentation
¶
Overview ¶
Package fiber provides tracing functions for tracing the fiber package (https://github.com/gofiber/fiber).
Example ¶
// Start the tracer
tracer.Start()
defer tracer.Stop()
// Create a fiber v2 Router
router := fiber.New()
// Use the tracer middleware with the default service name "fiber".
router.Use(fibertrace.Middleware())
// Set up some endpoints.
router.Get("/", func(c *fiber.Ctx) error {
return c.SendString("test")
})
// And start gathering request traces
router.Listen(":8080")
Output:
Example (WithServiceName) ¶
// Start the tracer
tracer.Start()
defer tracer.Stop()
// Create a fiber v2 Router
router := fiber.New()
// Use the tracer middleware with your desired service name.
router.Use(fibertrace.Middleware(fibertrace.WithService("fiber")))
// Set up some endpoints.
router.Get("/", func(c *fiber.Ctx) error {
return c.SendString("test")
})
// And start gathering request traces
router.Listen(":8080")
Output:
Index ¶
- func Middleware(opts ...Option) func(c *fiber.Ctx) error
- type Option
- type OptionFn
- func WithAnalytics(on bool) OptionFn
- func WithAnalyticsRate(rate float64) OptionFn
- func WithIgnoreRequest(fn func(*fiber.Ctx) bool) OptionFn
- func WithResourceNamer(fn func(*fiber.Ctx) string) OptionFn
- func WithService(name string) OptionFn
- func WithSpanOptions(opts ...tracer.StartSpanOption) OptionFn
- func WithStatusCheck(fn func(statusCode int) bool) OptionFn
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Middleware ¶
Middleware returns middleware that will trace incoming requests.
Types ¶
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
Option describes options for the Fiber.v2 integration.
type OptionFn ¶
type OptionFn func(*config)
OptionFn represents options applicable to Middleware.
func WithAnalytics ¶
WithAnalytics enables Trace Analytics for all started spans.
func WithAnalyticsRate ¶
WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func WithIgnoreRequest ¶
WithIgnoreRequest specifies a function which will be used to determining if the incoming HTTP request tracing should be skipped.
func WithResourceNamer ¶
WithResourceNamer specifies a function which will be used to obtain the resource name for a given request taking the go-fiber context as input
func WithService ¶
WithService sets the given service name for the router.
func WithSpanOptions ¶
func WithSpanOptions(opts ...tracer.StartSpanOption) OptionFn
WithSpanOptions applies the given set of options to the spans started by the router.
func WithStatusCheck ¶
WithStatusCheck allow setting of a function to tell whether a status code is an error
Source Files