pingcap/tidb

plugin: Allow introduce a custom web handler

Open

#10,914 opened on Jun 23, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (6,186 forks)batch import
component/pluginfeature/acceptedhelp wantedtype/feature-request

Repository metrics

Stars
 (40,090 stars)
PR merge metrics
 (Avg merge 14d 4h) (346 merged PRs in 30d)

Description

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:

Contributor guide

Research direction
Implement the custom web handler by adding an http.Handler field to the Manifest struct and register it in startHTTPServer with a route prefix like '/plugins/<Name>/'.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoTiDB plugin basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70