server.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. package server
  2. import (
  3. "crypto/tls"
  4. "encoding/json"
  5. "fmt"
  6. "net"
  7. "net/http"
  8. "net/url"
  9. "strings"
  10. "time"
  11. etcdErr "github.com/coreos/etcd/error"
  12. "github.com/coreos/etcd/log"
  13. "github.com/coreos/etcd/server/v1"
  14. "github.com/coreos/etcd/server/v2"
  15. "github.com/coreos/etcd/store"
  16. "github.com/coreos/go-raft"
  17. "github.com/gorilla/mux"
  18. )
  19. // This is the default implementation of the Server interface.
  20. type Server struct {
  21. http.Server
  22. peerServer *PeerServer
  23. registry *Registry
  24. listener net.Listener
  25. store store.Store
  26. name string
  27. url string
  28. tlsConf *TLSConfig
  29. tlsInfo *TLSInfo
  30. corsOrigins map[string]bool
  31. }
  32. // Creates a new Server.
  33. func New(name string, urlStr string, listenHost string, tlsConf *TLSConfig, tlsInfo *TLSInfo, peerServer *PeerServer, registry *Registry, store store.Store) *Server {
  34. s := &Server{
  35. Server: http.Server{
  36. Handler: mux.NewRouter(),
  37. TLSConfig: &tlsConf.Server,
  38. Addr: listenHost,
  39. },
  40. name: name,
  41. store: store,
  42. registry: registry,
  43. url: urlStr,
  44. tlsConf: tlsConf,
  45. tlsInfo: tlsInfo,
  46. peerServer: peerServer,
  47. }
  48. // Install the routes.
  49. s.handleFunc("/version", s.GetVersionHandler).Methods("GET")
  50. s.installV1()
  51. s.installV2()
  52. return s
  53. }
  54. // The current state of the server in the cluster.
  55. func (s *Server) State() string {
  56. return s.peerServer.RaftServer().State()
  57. }
  58. // The node name of the leader in the cluster.
  59. func (s *Server) Leader() string {
  60. return s.peerServer.RaftServer().Leader()
  61. }
  62. // The current Raft committed index.
  63. func (s *Server) CommitIndex() uint64 {
  64. return s.peerServer.RaftServer().CommitIndex()
  65. }
  66. // The current Raft term.
  67. func (s *Server) Term() uint64 {
  68. return s.peerServer.RaftServer().Term()
  69. }
  70. // The server URL.
  71. func (s *Server) URL() string {
  72. return s.url
  73. }
  74. // Retrives the Peer URL for a given node name.
  75. func (s *Server) PeerURL(name string) (string, bool) {
  76. return s.registry.PeerURL(name)
  77. }
  78. // Returns a reference to the Store.
  79. func (s *Server) Store() store.Store {
  80. return s.store
  81. }
  82. func (s *Server) installV1() {
  83. s.handleFuncV1("/v1/keys/{key:.*}", v1.GetKeyHandler).Methods("GET")
  84. s.handleFuncV1("/v1/keys/{key:.*}", v1.SetKeyHandler).Methods("POST", "PUT")
  85. s.handleFuncV1("/v1/keys/{key:.*}", v1.DeleteKeyHandler).Methods("DELETE")
  86. s.handleFuncV1("/v1/watch/{key:.*}", v1.WatchKeyHandler).Methods("GET", "POST")
  87. s.handleFunc("/v1/leader", s.GetLeaderHandler).Methods("GET")
  88. s.handleFunc("/v1/machines", s.GetMachinesHandler).Methods("GET")
  89. s.handleFunc("/v1/stats/self", s.GetStatsHandler).Methods("GET")
  90. s.handleFunc("/v1/stats/leader", s.GetLeaderStatsHandler).Methods("GET")
  91. s.handleFunc("/v1/stats/store", s.GetStoreStatsHandler).Methods("GET")
  92. }
  93. func (s *Server) installV2() {
  94. s.handleFuncV2("/v2/keys/{key:.*}", v2.GetHandler).Methods("GET")
  95. s.handleFuncV2("/v2/keys/{key:.*}", v2.PostHandler).Methods("POST")
  96. s.handleFuncV2("/v2/keys/{key:.*}", v2.PutHandler).Methods("PUT")
  97. s.handleFuncV2("/v2/keys/{key:.*}", v2.DeleteHandler).Methods("DELETE")
  98. s.handleFunc("/v2/leader", s.GetLeaderHandler).Methods("GET")
  99. s.handleFunc("/v2/machines", s.GetMachinesHandler).Methods("GET")
  100. s.handleFunc("/v2/stats/self", s.GetStatsHandler).Methods("GET")
  101. s.handleFunc("/v2/stats/leader", s.GetLeaderStatsHandler).Methods("GET")
  102. s.handleFunc("/v2/stats/store", s.GetStoreStatsHandler).Methods("GET")
  103. }
  104. // Adds a v1 server handler to the router.
  105. func (s *Server) handleFuncV1(path string, f func(http.ResponseWriter, *http.Request, v1.Server) error) *mux.Route {
  106. return s.handleFunc(path, func(w http.ResponseWriter, req *http.Request) error {
  107. return f(w, req, s)
  108. })
  109. }
  110. // Adds a v2 server handler to the router.
  111. func (s *Server) handleFuncV2(path string, f func(http.ResponseWriter, *http.Request, v2.Server) error) *mux.Route {
  112. return s.handleFunc(path, func(w http.ResponseWriter, req *http.Request) error {
  113. return f(w, req, s)
  114. })
  115. }
  116. // Adds a server handler to the router.
  117. func (s *Server) handleFunc(path string, f func(http.ResponseWriter, *http.Request) error) *mux.Route {
  118. r := s.Handler.(*mux.Router)
  119. // Wrap the standard HandleFunc interface to pass in the server reference.
  120. return r.HandleFunc(path, func(w http.ResponseWriter, req *http.Request) {
  121. // Log request.
  122. log.Debugf("[recv] %s %s %s [%s]", req.Method, s.url, req.URL.Path, req.RemoteAddr)
  123. // Write CORS header.
  124. if s.OriginAllowed("*") {
  125. w.Header().Add("Access-Control-Allow-Origin", "*")
  126. } else if origin := req.Header.Get("Origin"); s.OriginAllowed(origin) {
  127. w.Header().Add("Access-Control-Allow-Origin", origin)
  128. }
  129. // Execute handler function and return error if necessary.
  130. if err := f(w, req); err != nil {
  131. if etcdErr, ok := err.(*etcdErr.Error); ok {
  132. log.Debug("Return error: ", (*etcdErr).Error())
  133. etcdErr.Write(w)
  134. } else {
  135. http.Error(w, err.Error(), http.StatusInternalServerError)
  136. }
  137. }
  138. })
  139. }
  140. // Start to listen and response etcd client command
  141. func (s *Server) ListenAndServe() error {
  142. log.Infof("etcd server [name %s, listen on %s, advertised url %s]", s.name, s.Server.Addr, s.url)
  143. if s.tlsConf.Scheme == "http" {
  144. return s.listenAndServe()
  145. } else {
  146. return s.listenAndServeTLS(s.tlsInfo.CertFile, s.tlsInfo.KeyFile)
  147. }
  148. }
  149. // Overridden version of net/http added so we can manage the listener.
  150. func (s *Server) listenAndServe() error {
  151. addr := s.Server.Addr
  152. if addr == "" {
  153. addr = ":http"
  154. }
  155. l, e := net.Listen("tcp", addr)
  156. if e != nil {
  157. return e
  158. }
  159. s.listener = l
  160. return s.Server.Serve(l)
  161. }
  162. // Overridden version of net/http added so we can manage the listener.
  163. func (s *Server) listenAndServeTLS(certFile, keyFile string) error {
  164. addr := s.Server.Addr
  165. if addr == "" {
  166. addr = ":https"
  167. }
  168. config := &tls.Config{}
  169. if s.Server.TLSConfig != nil {
  170. *config = *s.Server.TLSConfig
  171. }
  172. if config.NextProtos == nil {
  173. config.NextProtos = []string{"http/1.1"}
  174. }
  175. var err error
  176. config.Certificates = make([]tls.Certificate, 1)
  177. config.Certificates[0], err = tls.LoadX509KeyPair(certFile, keyFile)
  178. if err != nil {
  179. return err
  180. }
  181. conn, err := net.Listen("tcp", addr)
  182. if err != nil {
  183. return err
  184. }
  185. tlsListener := tls.NewListener(conn, config)
  186. s.listener = tlsListener
  187. return s.Server.Serve(tlsListener)
  188. }
  189. // Stops the server.
  190. func (s *Server) Close() {
  191. if s.listener != nil {
  192. s.listener.Close()
  193. s.listener = nil
  194. }
  195. }
  196. func (s *Server) Dispatch(c raft.Command, w http.ResponseWriter, req *http.Request) error {
  197. ps := s.peerServer
  198. if ps.raftServer.State() == raft.Leader {
  199. result, err := ps.raftServer.Do(c)
  200. if err != nil {
  201. return err
  202. }
  203. if result == nil {
  204. return etcdErr.NewError(300, "Empty result from raft", store.UndefIndex, store.UndefTerm)
  205. }
  206. // response for raft related commands[join/remove]
  207. if b, ok := result.([]byte); ok {
  208. w.WriteHeader(http.StatusOK)
  209. w.Write(b)
  210. return nil
  211. }
  212. var b []byte
  213. if strings.HasPrefix(req.URL.Path, "/v1") {
  214. b, _ = json.Marshal(result.(*store.Event).Response())
  215. w.WriteHeader(http.StatusOK)
  216. } else {
  217. e, _ := result.(*store.Event)
  218. b, _ = json.Marshal(e)
  219. if e.IsCreated() {
  220. w.WriteHeader(http.StatusCreated)
  221. } else {
  222. w.WriteHeader(http.StatusOK)
  223. }
  224. }
  225. w.Write(b)
  226. return nil
  227. } else {
  228. leader := ps.raftServer.Leader()
  229. // No leader available.
  230. if leader == "" {
  231. return etcdErr.NewError(300, "", store.UndefIndex, store.UndefTerm)
  232. }
  233. var url string
  234. switch c.(type) {
  235. case *JoinCommand, *RemoveCommand:
  236. url, _ = ps.registry.PeerURL(leader)
  237. default:
  238. url, _ = ps.registry.ClientURL(leader)
  239. }
  240. redirect(url, w, req)
  241. return nil
  242. }
  243. }
  244. // Sets a comma-delimited list of origins that are allowed.
  245. func (s *Server) AllowOrigins(origins string) error {
  246. // Construct a lookup of all origins.
  247. m := make(map[string]bool)
  248. for _, v := range strings.Split(origins, ",") {
  249. if v != "*" {
  250. if _, err := url.Parse(v); err != nil {
  251. return fmt.Errorf("Invalid CORS origin: %s", err)
  252. }
  253. }
  254. m[v] = true
  255. }
  256. s.corsOrigins = m
  257. return nil
  258. }
  259. // Determines whether the server will allow a given CORS origin.
  260. func (s *Server) OriginAllowed(origin string) bool {
  261. return s.corsOrigins["*"] || s.corsOrigins[origin]
  262. }
  263. // Handler to return the current version of etcd.
  264. func (s *Server) GetVersionHandler(w http.ResponseWriter, req *http.Request) error {
  265. w.WriteHeader(http.StatusOK)
  266. fmt.Fprintf(w, "etcd %s", ReleaseVersion)
  267. return nil
  268. }
  269. // Handler to return the current leader's raft address
  270. func (s *Server) GetLeaderHandler(w http.ResponseWriter, req *http.Request) error {
  271. leader := s.peerServer.RaftServer().Leader()
  272. if leader == "" {
  273. return etcdErr.NewError(etcdErr.EcodeLeaderElect, "", store.UndefIndex, store.UndefTerm)
  274. }
  275. w.WriteHeader(http.StatusOK)
  276. url, _ := s.registry.PeerURL(leader)
  277. w.Write([]byte(url))
  278. return nil
  279. }
  280. // Handler to return all the known machines in the current cluster.
  281. func (s *Server) GetMachinesHandler(w http.ResponseWriter, req *http.Request) error {
  282. machines := s.registry.ClientURLs(s.peerServer.RaftServer().Leader(), s.name)
  283. w.WriteHeader(http.StatusOK)
  284. w.Write([]byte(strings.Join(machines, ", ")))
  285. return nil
  286. }
  287. // Retrieves stats on the Raft server.
  288. func (s *Server) GetStatsHandler(w http.ResponseWriter, req *http.Request) error {
  289. w.Write(s.peerServer.Stats())
  290. return nil
  291. }
  292. // Retrieves stats on the leader.
  293. func (s *Server) GetLeaderStatsHandler(w http.ResponseWriter, req *http.Request) error {
  294. if s.peerServer.RaftServer().State() == raft.Leader {
  295. w.Write(s.peerServer.PeerStats())
  296. return nil
  297. }
  298. leader := s.peerServer.RaftServer().Leader()
  299. if leader == "" {
  300. return etcdErr.NewError(300, "", store.UndefIndex, store.UndefTerm)
  301. }
  302. hostname, _ := s.registry.ClientURL(leader)
  303. redirect(hostname, w, req)
  304. return nil
  305. }
  306. // Retrieves stats on the leader.
  307. func (s *Server) GetStoreStatsHandler(w http.ResponseWriter, req *http.Request) error {
  308. w.Write(s.store.JsonStats())
  309. return nil
  310. }
  311. // Executes a speed test to evaluate the performance of update replication.
  312. func (s *Server) SpeedTestHandler(w http.ResponseWriter, req *http.Request) error {
  313. count := 1000
  314. c := make(chan bool, count)
  315. for i := 0; i < count; i++ {
  316. go func() {
  317. for j := 0; j < 10; j++ {
  318. c := &store.SetCommand{
  319. Key: "foo",
  320. Value: "bar",
  321. ExpireTime: time.Unix(0, 0),
  322. }
  323. s.peerServer.RaftServer().Do(c)
  324. }
  325. c <- true
  326. }()
  327. }
  328. for i := 0; i < count; i++ {
  329. <-c
  330. }
  331. w.WriteHeader(http.StatusOK)
  332. w.Write([]byte("speed test success"))
  333. return nil
  334. }