debugapi

package

v0.0.0-...-0119d12 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pingcap/tidb-dashboard

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var Module = fx.Options(
	fx.Provide(newService),
	fx.Invoke(registerRouter),
)

Functions ¶

This section is empty.

Types ¶

type Service ¶

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

func (*Service) Download ¶

func (s *Service) Download(c *gin.Context)

@Summary Download a finished request result @Param token query string true "download token" @Success 200 {object} string @Failure 400 {object} rest.ErrorResponse @Failure 500 {object} rest.ErrorResponse @Router /debug_api/download [get]

func (*Service) GetEndpoints ¶

func (s *Service) GetEndpoints(c *gin.Context)

@Summary Get all endpoints @ID debugAPIGetEndpoints @Security JwtAuth @Success 200 {array} endpoint.APIDefinition @Failure 401 {object} rest.ErrorResponse @Router /debug_api/endpoints [get]

func (*Service) RequestEndpoint ¶

func (s *Service) RequestEndpoint(c *gin.Context)

@Summary Send request remote endpoint and return a token for downloading results @Security JwtAuth @ID debugAPIRequestEndpoint @Param req body endpoint.RequestPayload true "request payload" @Success 200 {object} string @Failure 400 {object} rest.ErrorResponse @Failure 401 {object} rest.ErrorResponse @Failure 500 {object} rest.ErrorResponse @Router /debug_api/endpoint [post]

type ServiceParams ¶

type ServiceParams struct {
	fx.In
	PDAPIClient            *pdclient.APIClient
	TiDBStatusClient       *tidbclient.StatusClient
	TiKVStatusClient       *tikvclient.StatusClient
	TiFlashStatusClient    *tiflashclient.StatusClient
	TiCDCStatusClient      *ticdcclient.StatusClient
	TiProxyStatusClient    *tiproxyclient.StatusClient
	EtcdClient             *clientv3.Client
	PDClient               *pd.Client
	TSOStatusClient        *tsoclient.StatusClient
	SchedulingStatusClient *schedulingclient.StatusClient
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
endpoint

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL