forked from benthosdev/benthos
/
api.go
239 lines (209 loc) · 6.82 KB
/
api.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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// Copyright (c) 2018 Ashley Jeffs
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package api
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/http/pprof"
"runtime"
"sync"
"time"
"github.com/Jeffail/benthos/lib/log"
"github.com/Jeffail/benthos/lib/metrics"
"github.com/gorilla/mux"
yaml "gopkg.in/yaml.v2"
)
//------------------------------------------------------------------------------
// Config contains the configuration fields for the Benthos API.
type Config struct {
Address string `json:"address" yaml:"address"`
ReadTimeoutMS int `json:"read_timeout_ms" yaml:"read_timeout_ms"`
RootPath string `json:"root_path" yaml:"root_path"`
DebugEndpoints bool `json:"debug_endpoints" yaml:"debug_endpoints"`
}
// NewConfig creates a new API config with default values.
func NewConfig() Config {
return Config{
Address: "0.0.0.0:4195",
ReadTimeoutMS: 5000,
RootPath: "/benthos",
DebugEndpoints: false,
}
}
//------------------------------------------------------------------------------
// Type implements the Benthos HTTP API.
type Type struct {
conf Config
endpoints map[string]string
endpointsMut sync.Mutex
handlers map[string]http.HandlerFunc
handlersMut sync.RWMutex
mux *mux.Router
server *http.Server
}
// New creates a new Benthos HTTP API.
func New(
version string,
dateBuilt string,
conf Config,
wholeConf interface{},
log log.Modular,
stats metrics.Type,
) *Type {
handler := mux.NewRouter()
server := &http.Server{
Addr: conf.Address,
Handler: handler,
ReadTimeout: time.Millisecond * time.Duration(conf.ReadTimeoutMS),
}
t := &Type{
conf: conf,
endpoints: map[string]string{},
handlers: map[string]http.HandlerFunc{},
mux: handler,
server: server,
}
handlePing := func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("pong"))
}
handleStackTrace := func(w http.ResponseWriter, r *http.Request) {
stackSlice := make([]byte, 1024*100)
s := runtime.Stack(stackSlice, true)
w.Write(stackSlice[:s])
}
handlePrintJSONConfig := func(w http.ResponseWriter, r *http.Request) {
resBytes, err := json.Marshal(wholeConf)
if err != nil {
w.WriteHeader(http.StatusBadGateway)
return
}
w.Write(resBytes)
}
handlePrintYAMLConfig := func(w http.ResponseWriter, r *http.Request) {
resBytes, err := yaml.Marshal(wholeConf)
if err != nil {
w.WriteHeader(http.StatusBadGateway)
return
}
w.Write(resBytes)
}
handleVersion := func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte(fmt.Sprintf("{\"version\":\"%v\", \"built\":\"%v\"}", version, dateBuilt)))
}
handleEndpoints := func(w http.ResponseWriter, r *http.Request) {
t.endpointsMut.Lock()
defer t.endpointsMut.Unlock()
resBytes, err := json.Marshal(t.endpoints)
if err != nil {
w.WriteHeader(http.StatusBadGateway)
} else {
w.Write(resBytes)
}
}
if t.conf.DebugEndpoints {
t.RegisterEndpoint(
"/debug/config/json", "DEBUG: Returns the loaded config as JSON.",
handlePrintJSONConfig,
)
t.RegisterEndpoint(
"/debug/config/yaml", "DEBUG: Returns the loaded config as YAML.",
handlePrintYAMLConfig,
)
t.RegisterEndpoint(
"/debug/stack", "DEBUG: Returns a snapshot of the current service stack trace.",
handleStackTrace,
)
t.RegisterEndpoint(
"/debug/pprof/profile", "DEBUG: Responds with a pprof-formatted cpu profile.",
pprof.Profile,
)
t.RegisterEndpoint(
"/debug/pprof/heap", "DEBUG: Responds with a pprof-formatted heap profile.",
pprof.Index,
)
t.RegisterEndpoint(
"/debug/pprof/block", "DEBUG: Responds with a pprof-formatted block profile.",
pprof.Index,
)
t.RegisterEndpoint(
"/debug/pprof/mutex", "DEBUG: Responds with a pprof-formatted mutex profile.",
pprof.Index,
)
t.RegisterEndpoint(
"/debug/pprof/symbol", "DEBUG: looks up the program counters listed"+
" in the request, responding with a table mapping program"+
" counters to function names.",
pprof.Symbol,
)
t.RegisterEndpoint(
"/debug/pprof/trace",
"DEBUG: Responds with the execution trace in binary form."+
" Tracing lasts for duration specified in seconds GET"+
" parameter, or for 1 second if not specified.",
pprof.Trace,
)
}
t.RegisterEndpoint("/ping", "Ping me.", handlePing)
t.RegisterEndpoint("/version", "Returns the service version.", handleVersion)
t.RegisterEndpoint("/endpoints", "Returns this map of endpoints.", handleEndpoints)
// If we want to expose a JSON stats endpoint we register the endpoints.
if wHandlerFunc, ok := stats.(metrics.WithHandlerFunc); ok {
t.RegisterEndpoint(
"/stats", "Returns a JSON object of service metrics.",
wHandlerFunc.HandlerFunc(),
)
t.RegisterEndpoint(
"/metrics", "Returns a JSON object of service metrics.",
wHandlerFunc.HandlerFunc(),
)
}
return t
}
// RegisterEndpoint registers a http.HandlerFunc under a path with a
// description that will be displayed under the /endpoints path.
func (t *Type) RegisterEndpoint(path, desc string, handler http.HandlerFunc) {
t.endpointsMut.Lock()
defer t.endpointsMut.Unlock()
t.endpoints[path] = desc
t.handlersMut.Lock()
defer t.handlersMut.Unlock()
if _, exists := t.handlers[path]; !exists {
wrapHandler := func(w http.ResponseWriter, r *http.Request) {
t.handlersMut.RLock()
h := t.handlers[path]
t.handlersMut.RUnlock()
h(w, r)
}
t.mux.HandleFunc(path, wrapHandler)
t.mux.HandleFunc(t.conf.RootPath+path, wrapHandler)
}
t.handlers[path] = handler
}
// ListenAndServe launches the API and blocks until the server closes or fails.
func (t *Type) ListenAndServe() error {
return t.server.ListenAndServe()
}
// Shutdown attempts to close the http server.
func (t *Type) Shutdown(ctx context.Context) error {
return t.server.Shutdown(ctx)
}
//------------------------------------------------------------------------------