server.go 11 KB

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