Expvar

Documentation Index

Fetch the complete documentation index at: https://docs.go-mizu.dev/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

• Go runtime metrics
• Memory usage monitoring
• Custom variable export

​

Installation

import "github.com/go-mizu/mizu/middlewares/expvar"

​

Quick Start

app := mizu.New()

// Expose expvar endpoint
app.Get("/debug/vars", expvar.Handler())

​

Examples

​

Basic Setup

app.Get("/debug/vars", expvar.Handler())

​

Custom Variables

import "expvar"

// Publish custom variable
var requests = expvar.NewInt("requests")

app.Use(func(next mizu.Handler) mizu.Handler {
    return func(c *mizu.Ctx) error {
        requests.Add(1)
        return next(c)
    }
})

app.Get("/debug/vars", expvar.Handler())

​

With Auth Protection

debug := app.Group("/debug")
debug.Use(basicauth.New(adminCredentials))
debug.Get("/vars", expvar.Handler())

​

Default Variables

​

API Reference

​

Functions

// Handler returns expvar HTTP handler
func Handler() mizu.Handler

​

Response Format

{
    "cmdline": ["./myapp"],
    "memstats": {
        "Alloc": 1234567,
        "TotalAlloc": 9876543,
        "Sys": 12345678,
        ...
    },
    "requests": 42
}

​

Technical Details

​

Standard Library Integration

• Uses expvar.Handler() to serve the variables endpoint
• Exports all published variables as JSON
• Includes built-in cmdline and memstats variables

​

Path Matching

• Only intercepts requests to the configured path (default: /debug/vars)
• All other requests pass through to the next handler
• Efficient path comparison using string equality

​

Helper Functions

• NewInt(name): Creates and publishes an expvar.Int
• NewFloat(name): Creates and publishes an expvar.Float
• NewString(name): Creates and publishes an expvar.String
• NewMap(name): Creates and publishes an expvar.Map

​

Thread Safety

​

Best Practices

• Protect endpoint in production
• Use for debugging and monitoring
• Combine with custom metrics
• Don’t expose sensitive data

​

Testing

​

Related Middlewares

• prometheus - Prometheus metrics
• pprof - Profiling
• healthcheck - Health checks