apiserver

Documentation

Index

• Variables
• func Handler(s *Service) http.Handler
• type Service
  • func NewService(cfg *config.Config, stoppedHandler http.Handler, uiAssetFS http.FileSystem, ...) *Service
  • func (s *Service) IsRunning() bool
  • func (s *Service) NewStatusAwareHandler(handler http.Handler, stoppedHandler http.Handler) http.Handler
  • func (s *Service) Start(ctx context.Context) error
  • func (s *Service) Stop(ctx context.Context) error

Variables

var Modules = fx.Options(
	fx.Provide(
		newAPIHandlerEngine,
		newClients,
		dbstore.NewDBStore,
		httpc.NewHTTPClient,
		pd.NewEtcdClient,
		pd.NewPDClient,
		tso.NewTSOClient,
		scheduling.NewSchedulingClient,
		config.NewDynamicConfigManager,
		tidb.NewTiDBClient,
		tikv.NewTiKVClient,
		tiflash.NewTiFlashClient,
		ticdc.NewTiCDCClient,
		tiproxy.NewTiProxyClient,
		utils.ProvideSysSchema,
		apiutils.NewNgmProxy,
		info.NewService,
		clusterinfo.NewService,
		logsearch.NewService,
		diagnose.NewService,
		keyvisual.NewService,
		metrics.NewService,
		queryeditor.NewService,
		configuration.NewService,
	),
	user.Module,
	codeauth.Module,
	sqlauth.Module,
	ssoauth.Module,
	code.Module,
	sso.Module,
	profiling.Module,
	conprof.Module,
	statement.Module,
	slowquery.Module,
	debugapi.Module,
	topsql.Module,
	visualplan.Module,
	deadlock.Module,
	resourcemanager.Module,
)

var StoppedHandler = http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
	w.WriteHeader(http.StatusNotFound)
	_, _ = io.WriteString(w, "Dashboard is not started.\n")
})

Functions

func Handler

func Handler(s *Service) http.Handler

Types

type Service

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

func NewService

func NewService(cfg *config.Config, stoppedHandler http.Handler, uiAssetFS http.FileSystem, customKeyVisualProvider *keyvisualregion.DataProvider) *Service

func (*Service) IsRunning

func (s *Service) IsRunning() bool

func (*Service) NewStatusAwareHandler

func (s *Service) NewStatusAwareHandler(handler http.Handler, stoppedHandler http.Handler) http.Handler

func (*Service) Start

func (s *Service) Start(ctx context.Context) error

func (*Service) Stop

func (s *Service) Stop(ctx context.Context) error