server.go 10 KB

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