fiber/middleware/expvar
leonklingele ac4ce21d9c
🐛 Bug: Fix issues introduced in linting PR (#2319)
* internal: revert linting changes

Changes to the internal package should not have been made in 167a8b5e94.

* middleware/monitor: revert changes to exported field "ChartJSURL"

This is a breaking change introduced in 167a8b5e94.

* middleware/monitor: fix error checking

Fix the errorenous error checking introduced in 167a8b5e94.

* 🐛 Bug: Fix issues introduced in linting PR #2319

* 🐛 Bug: Fix issues introduced in linting PR #2319

* Bug: Fix issues introduced in linting PR #2319

---------

Co-authored-by: René Werner <rene@gofiber.io>
2023-02-02 15:57:40 +01:00
..
README.md feature: add Next to Pprof and Expvar middlewares. (#1737) 2022-01-29 22:24:32 +01:00
config.go 🐛 Bug: Fix issues introduced in linting PR (#2319) 2023-02-02 15:57:40 +01:00
expvar.go 🚀 Feature: Add and apply more stricter golangci-lint linting rules (#2286) 2023-01-27 09:01:37 +01:00
expvar_test.go 🧹 chore: make most tests parallel (#2299) 2023-01-15 23:21:37 +08:00

README.md

Expvar Middleware

Expvar middleware for Fiber that serves via its HTTP server runtime exposed variants in the JSON format. The package is typically only imported for the side effect of registering its HTTP handlers. The handled path is /debug/vars.

Signatures

func New() fiber.Handler

Example

Import the expvar package that is part of the Fiber web framework

package main

import (
	"expvar"
	"fmt"

	"github.com/gofiber/fiber/v2"
	expvarmw "github.com/gofiber/fiber/v2/middleware/expvar"
)

var count = expvar.NewInt("count")

func main() {
	app := fiber.New()
	app.Use(expvarmw.New())
	app.Get("/", func(c *fiber.Ctx) error {
		count.Add(1)

		return c.SendString(fmt.Sprintf("hello expvar count %d", count.Value()))
	})

	fmt.Println(app.Listen(":3000"))
}

Visit path /debug/vars to see all vars and use query r=key to filter exposed variables.

curl 127.0.0.1:3000
hello expvar count 1

curl 127.0.0.1:3000/debug/vars
{
	"cmdline": ["xxx"],
	"count": 1,
	"expvarHandlerCalls": 33,
	"expvarRegexpErrors": 0,
	"memstats": {...}
}

curl 127.0.0.1:3000/debug/vars?r=c
{
	"cmdline": ["xxx"],
	"count": 1
}

Config

// Config defines the config for middleware.
type Config struct {	
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *fiber.Ctx) bool
}

Default Config

var ConfigDefault = Config{
	Next: nil,
}