pingcap/tidb

plugin: Allow introduce a custom web handler

Open

#10,914 opened on 2019年6月23日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Go (40,090 stars) (6,186 forks)batch import
component/pluginfeature/acceptedhelp wantedtype/feature-request

説明

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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Go programmingTiDB plugin architecturenet/http package
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
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.