The highest tagged major version is v2.

debug

package

v1.23.1 Latest Latest Go to latest Published: Aug 12, 2024 License: Apache-2.0 Imports: 24 Imported by: 0

Details

Package debug provides debug facilities.

This section is empty.

This section is empty.

This section is empty.

type Handler struct {
	// contains filtered or unexported fields
}

Handler represents debug handler.

func Listen(opts *ListenOpts) (*Handler, error)

Listen creates a new debug handler and starts listener on the given TCP address.

This function can be called only once because it affects http.DefaultServeMux.

func (h *Handler) Serve(ctx context.Context)

Serve runs debug handler until ctx is canceled.

It exits when handler is stopped and listener closed.

type ListenOpts struct {
	TCPAddr string
	L       *slog.Logger
	R       prometheus.Registerer
	Livez   Probe
	Readyz  Probe
}

ListenOpts represents Listen options.

type Probe func(ctx context.Context) bool

Probe should return true on success and false on failure (or context cancellation). It may log additional information if needed.

It must be thread-safe.