admin

Documentation

Overview

Package admin provides simple admin http server API.

Index

• Constants
• func DisableTrace(w http.ResponseWriter, _ *http.Request)
• func EnableTrace(w http.ResponseWriter, _ *http.Request)
• func TraceDisabled() bool
• func TraceStatus(w http.ResponseWriter, _ *http.Request)
• type Option
  • func WithAddr(addr string) Option
  • func WithEnableHotSwitch(enable bool) Option
  • func WithEnablePprof(enable bool) Option
  • func WithEnablePrometheus(enable bool) Option
  • func WithEnableZPage(enable bool) Option
• type Options
• type Server
  • func NewServer(opts ...Option) (*Server, error)
  • func (s *Server) HTTPServer() *http.Server
  • func (s *Server) Serve() error

Constants

const (
	// TraceFilterOn toggle
	TraceFilterOn int32 = 0
	// TraceFilterOff toggle
	TraceFilterOff int32 = 1
)

Functions

func DisableTrace

func DisableTrace(w http.ResponseWriter, _ *http.Request)

DisableTrace ...

func EnableTrace

func EnableTrace(w http.ResponseWriter, _ *http.Request)

EnableTrace ...

func TraceDisabled

func TraceDisabled() bool

TraceDisabled ...

func TraceStatus

func TraceStatus(w http.ResponseWriter, _ *http.Request)

TraceStatus ...

Types

type Option

type Option func(o *Options)

Option is function for applying an option the admin server

func WithAddr

func WithAddr(addr string) Option

WithAddr set server listen addr

func WithEnableHotSwitch

func WithEnableHotSwitch(enable bool) Option

WithEnableHotSwitch set whether to enable hot switch http handler

func WithEnablePprof

func WithEnablePprof(enable bool) Option

WithEnablePprof set whether to enable go pprof http handler

func WithEnablePrometheus

func WithEnablePrometheus(enable bool) Option

WithEnablePrometheus set whether to enable prometheus metrics http handler

func WithEnableZPage

func WithEnableZPage(enable bool) Option

WithEnableZPage set up zPages processor

type Options

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

Options represents config options for open telemetry http admin server

type Server

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

Server is admin server, wrap http.Server

func NewServer

func NewServer(opts ...Option) (*Server, error)

NewServer creates a Server instance

func (*Server) HTTPServer

func (s *Server) HTTPServer() *http.Server

HTTPServer returns http.Server in Server

func (*Server) Serve

func (s *Server) Serve() error

Serve starts a http server and listen to serve