plugin: Allow introduce a custom web handler · pingcap/tidb#10914

(2 留言) (0 反應) (0 負責人)Go (40,090 star) (6,186 fork)batch import

component/pluginfeature/acceptedhelp wantedtype/feature-request

描述

Is your feature request related to a problem? Please describe:

TiDB contains an HTTP interface at port :10080. A plugin may want to expose some status and configuration interface through this port.

Describe the feature you'd like:

Allow the plugin to provide an http.Handler from the Manifest.

type Manifest struct {
    ...
    Handler  http.Handler
}

Inside startHTTPServer(), for every plugin which has a non-nil Handler, route /plugins/«Name»/ to that handler (with StripPrefix).

Describe alternatives you've considered:

Do not support it, forcing plugins wanting to provide a web interface to choose a different port.

Teachability, Documentation, Adoption, Migration Strategy:

技術棧: go
領域: backendapi
議題類型: feature
難度: 3
預計時間: 1-2 days
活動狀態: stale
清晰度: clear
前置要求: Go programmingTiDB plugin architecturenet/http package
新手友善度: 50
研究方向: The contributor should locate the `Manifest` struct in the plugin package (likely `plugin/plugin.go`) and add an `http.Handler` field. Then, modify the `startHTTPServer` function (likely in `server/server.go` or similar) to check each plugin's handler and register it with the HTTP mux, using `http.StripPrefix` to route `/plugins/{name}/` to the handler. Ensure nil safety and that the plugin name is used as the URL prefix.