forked from cockroachdb/cockroach
/
admin.go
181 lines (164 loc) · 5.71 KB
/
admin.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
// Copyright 2014 The Cockroach Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License. See the AUTHORS file
// for names of contributors.
//
// Author: Spencer Kimball (spencer.kimball@gmail.com)
// Author: Bram Gruneir (bram+code@cockroachlabs.com)
package server
import (
// This is imported for its side-effect of registering expvar
// endpoints with the http.DefaultServeMux.
_ "expvar"
"fmt"
"io/ioutil"
"net/http"
"time"
// This is imported for its side-effect of registering pprof
// endpoints with the http.DefaultServeMux.
_ "net/http/pprof"
"net/url"
"strings"
"github.com/cockroachdb/cockroach/client"
"github.com/cockroachdb/cockroach/util"
"github.com/cockroachdb/cockroach/util/stop"
)
const (
// adminEndpoint is the prefix for RESTful endpoints used to
// provide an administrative interface to the cockroach cluster.
adminEndpoint = "/_admin/"
// debugEndpoint is the prefix of golang's standard debug functionality
// for access to exported vars and pprof tools.
debugEndpoint = "/debug/"
// healthPath is the health endpoint.
healthPath = adminEndpoint + "health"
// quitPath is the quit endpoint.
quitPath = adminEndpoint + "quit"
)
// An actionHandler is an interface which provides Get, Put & Delete
// to satisfy administrative REST APIs.
type actionHandler interface {
Put(path string, body []byte, r *http.Request) error
Get(path string, r *http.Request) (body []byte, contentType string, err error)
Delete(path string, r *http.Request) error
}
// A adminServer provides a RESTful HTTP API to administration of
// the cockroach cluster.
type adminServer struct {
db *client.DB // Key-value database client
stopper *stop.Stopper // Used to shutdown the server
mux *http.ServeMux
}
// newAdminServer allocates and returns a new REST server for
// administrative APIs.
func newAdminServer(db *client.DB, stopper *stop.Stopper) *adminServer {
server := &adminServer{
db: db,
stopper: stopper,
mux: http.NewServeMux(),
}
server.mux.HandleFunc(debugEndpoint, server.handleDebug)
server.mux.HandleFunc(healthPath, server.handleHealth)
server.mux.HandleFunc(quitPath, server.handleQuit)
return server
}
// ServeHTTP implements http.Handler.
func (s *adminServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
s.mux.ServeHTTP(w, r)
}
// handleHealth responds to health requests from monitoring services.
func (s *adminServer) handleHealth(w http.ResponseWriter, r *http.Request) {
w.Header().Set(util.ContentTypeHeader, util.PlaintextContentType)
fmt.Fprintln(w, "ok")
}
// handleQuit is the shutdown hook. The server is first placed into a
// draining mode, followed by exit.
func (s *adminServer) handleQuit(w http.ResponseWriter, r *http.Request) {
w.Header().Set(util.ContentTypeHeader, util.PlaintextContentType)
fmt.Fprintln(w, "ok")
go func() {
time.Sleep(50 * time.Millisecond)
s.stopper.Stop()
}()
}
// handleDebug passes requests with the debugPathPrefix onto the default
// serve mux, which is preconfigured (by import of expvar and net/http/pprof)
// to serve endpoints which access exported variables and pprof tools.
func (s *adminServer) handleDebug(w http.ResponseWriter, r *http.Request) {
handler, _ := http.DefaultServeMux.Handler(r)
handler.ServeHTTP(w, r)
}
// handleRESTAction handles RESTful admin actions.
func (s *adminServer) handleRESTAction(handler actionHandler, w http.ResponseWriter, r *http.Request, prefix string) {
switch r.Method {
case "GET":
s.handleGetAction(handler, w, r, prefix)
case "PUT", "POST":
s.handlePutAction(handler, w, r, prefix)
case "DELETE":
s.handleDeleteAction(handler, w, r, prefix)
default:
http.Error(w, "Bad Request", http.StatusBadRequest)
}
}
func unescapePath(path, prefix string) (string, error) {
result, err := url.QueryUnescape(strings.TrimPrefix(path, prefix))
if err != nil {
return "", err
}
return result, nil
}
func (s *adminServer) handlePutAction(handler actionHandler, w http.ResponseWriter, r *http.Request, prefix string) {
path, err := unescapePath(r.URL.Path, prefix)
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
b, err := ioutil.ReadAll(r.Body)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
defer r.Body.Close()
if err = handler.Put(path, b, r); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusOK)
}
func (s *adminServer) handleGetAction(handler actionHandler, w http.ResponseWriter, r *http.Request, prefix string) {
path, err := unescapePath(r.URL.Path, prefix)
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
b, contentType, err := handler.Get(path, r)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set(util.ContentTypeHeader, contentType)
fmt.Fprintf(w, "%s", string(b))
}
func (s *adminServer) handleDeleteAction(handler actionHandler, w http.ResponseWriter, r *http.Request, prefix string) {
path, err := unescapePath(r.URL.Path, prefix)
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
if err = handler.Delete(path, r); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusOK)
}