lib/service/cmd.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 // Package service provides a cmd.Handler that brings up a system service.
   6 package service
   7
   8 import (
   9         "context"
  10         "flag"
  11         "fmt"
  12         "io"
  13         "net"
  14         "net/http"
  15         "net/http/httptest"
  16         _ "net/http/pprof"
  17         "net/url"
  18         "os"
  19         "strings"
  20         "time"
  21
  22         "git.arvados.org/arvados.git/lib/cmd"
  23         "git.arvados.org/arvados.git/lib/config"
  24         "git.arvados.org/arvados.git/sdk/go/arvados"
  25         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  26         "git.arvados.org/arvados.git/sdk/go/health"
  27         "git.arvados.org/arvados.git/sdk/go/httpserver"
  28         "github.com/coreos/go-systemd/daemon"
  29         "github.com/julienschmidt/httprouter"
  30         "github.com/prometheus/client_golang/prometheus"
  31         "github.com/sirupsen/logrus"
  32 )
  33
  34 type Handler interface {
  35         http.Handler
  36         CheckHealth() error
  37         // Done returns a channel that closes when the handler shuts
  38         // itself down, or nil if this never happens.
  39         Done() <-chan struct{}
  40 }
  41
  42 type NewHandlerFunc func(_ context.Context, _ *arvados.Cluster, token string, registry *prometheus.Registry) Handler
  43
  44 type command struct {
  45         newHandler NewHandlerFunc
  46         svcName    arvados.ServiceName
  47         ctx        context.Context // enables tests to shutdown service; no public API yet
  48 }
  49
  50 var requestQueueDumpCheckInterval = time.Minute
  51
  52 // Command returns a cmd.Handler that loads site config, calls
  53 // newHandler with the current cluster and node configs, and brings up
  54 // an http server with the returned handler.
  55 //
  56 // The handler is wrapped with server middleware (adding X-Request-ID
  57 // headers, logging requests/responses, etc).
  58 func Command(svcName arvados.ServiceName, newHandler NewHandlerFunc) cmd.Handler {
  59         return &command{
  60                 newHandler: newHandler,
  61                 svcName:    svcName,
  62                 ctx:        context.Background(),
  63         }
  64 }
  65
  66 func (c *command) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  67         log := ctxlog.New(stderr, "json", "info")
  68
  69         var err error
  70         defer func() {
  71                 if err != nil {
  72                         log.WithError(err).Error("exiting")
  73                 }
  74         }()
  75
  76         flags := flag.NewFlagSet("", flag.ContinueOnError)
  77         flags.SetOutput(stderr)
  78
  79         loader := config.NewLoader(stdin, log)
  80         loader.SetupFlags(flags)
  81
  82         // prog is [keepstore, keep-web, git-httpd, ...]  but the
  83         // legacy config flags are [-legacy-keepstore-config,
  84         // -legacy-keepweb-config, -legacy-git-httpd-config, ...]
  85         legacyFlag := "-legacy-" + strings.Replace(prog, "keep-", "keep", 1) + "-config"
  86         args = loader.MungeLegacyConfigArgs(log, args, legacyFlag)
  87
  88         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
  89         pprofAddr := flags.String("pprof", "", "Serve Go profile data at `[addr]:port`")
  90         if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
  91                 return code
  92         } else if *versionFlag {
  93                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
  94         }
  95
  96         if *pprofAddr != "" {
  97                 go func() {
  98                         log.Println(http.ListenAndServe(*pprofAddr, nil))
  99                 }()
 100         }
 101
 102         if strings.HasSuffix(prog, "controller") {
 103                 // Some config-loader checks try to make API calls via
 104                 // controller. Those can't be expected to work if this
 105                 // process _is_ the controller: we haven't started an
 106                 // http server yet.
 107                 loader.SkipAPICalls = true
 108         }
 109
 110         cfg, err := loader.Load()
 111         if err != nil {
 112                 return 1
 113         }
 114         cluster, err := cfg.GetCluster("")
 115         if err != nil {
 116                 return 1
 117         }
 118
 119         // Now that we've read the config, replace the bootstrap
 120         // logger with a new one according to the logging config.
 121         log = ctxlog.New(stderr, cluster.SystemLogs.Format, cluster.SystemLogs.LogLevel)
 122         logger := log.WithFields(logrus.Fields{
 123                 "PID":       os.Getpid(),
 124                 "ClusterID": cluster.ClusterID,
 125         })
 126         ctx := ctxlog.Context(c.ctx, logger)
 127
 128         listenURL, internalURL, err := getListenAddr(cluster.Services, c.svcName, log)
 129         if err != nil {
 130                 return 1
 131         }
 132         ctx = context.WithValue(ctx, contextKeyURL{}, internalURL)
 133
 134         reg := prometheus.NewRegistry()
 135         loader.RegisterMetrics(reg)
 136
 137         // arvados_version_running{version="1.2.3~4"} 1.0
 138         mVersion := prometheus.NewGaugeVec(prometheus.GaugeOpts{
 139                 Namespace: "arvados",
 140                 Name:      "version_running",
 141                 Help:      "Indicated version is running.",
 142         }, []string{"version"})
 143         mVersion.WithLabelValues(cmd.Version.String()).Set(1)
 144         reg.MustRegister(mVersion)
 145
 146         handler := c.newHandler(ctx, cluster, cluster.SystemRootToken, reg)
 147         if err = handler.CheckHealth(); err != nil {
 148                 return 1
 149         }
 150
 151         instrumented := httpserver.Instrument(reg, log,
 152                 httpserver.HandlerWithDeadline(cluster.API.RequestTimeout.Duration(),
 153                         httpserver.AddRequestIDs(
 154                                 httpserver.Inspect(reg, cluster.ManagementToken,
 155                                         httpserver.LogRequests(
 156                                                 interceptHealthReqs(cluster.ManagementToken, handler.CheckHealth,
 157                                                         &httpserver.RequestLimiter{
 158                                                                 Handler:       handler,
 159                                                                 MaxConcurrent: cluster.API.MaxConcurrentRequests,
 160                                                                 MaxQueue:      cluster.API.MaxQueuedRequests,
 161                                                                 Registry:      reg}))))))
 162         srv := &httpserver.Server{
 163                 Server: http.Server{
 164                         Handler:     ifCollectionInHost(instrumented, instrumented.ServeAPI(cluster.ManagementToken, instrumented)),
 165                         BaseContext: func(net.Listener) context.Context { return ctx },
 166                 },
 167                 Addr: listenURL.Host,
 168         }
 169         if listenURL.Scheme == "https" || listenURL.Scheme == "wss" {
 170                 tlsconfig, err := makeTLSConfig(cluster, logger)
 171                 if err != nil {
 172                         logger.WithError(err).Errorf("cannot start %s service on %s", c.svcName, listenURL.String())
 173                         return 1
 174                 }
 175                 srv.TLSConfig = tlsconfig
 176         }
 177         err = srv.Start()
 178         if err != nil {
 179                 return 1
 180         }
 181         logger.WithFields(logrus.Fields{
 182                 "URL":     listenURL,
 183                 "Listen":  srv.Addr,
 184                 "Service": c.svcName,
 185                 "Version": cmd.Version.String(),
 186         }).Info("listening")
 187         if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
 188                 logger.WithError(err).Errorf("error notifying init daemon")
 189         }
 190         go func() {
 191                 // Shut down server if caller cancels context
 192                 <-ctx.Done()
 193                 srv.Close()
 194         }()
 195         go func() {
 196                 // Shut down server if handler dies
 197                 <-handler.Done()
 198                 srv.Close()
 199         }()
 200         go c.requestQueueDumpCheck(cluster, prog, reg, &srv.Server, logger)
 201         err = srv.Wait()
 202         if err != nil {
 203                 return 1
 204         }
 205         return 0
 206 }
 207
 208 // If SystemLogs.RequestQueueDumpDirectory is set, monitor the
 209 // server's incoming HTTP request queue size. When it exceeds 90% of
 210 // API.MaxConcurrentRequests, write the /_inspect/requests data to a
 211 // JSON file in the specified directory.
 212 func (c *command) requestQueueDumpCheck(cluster *arvados.Cluster, prog string, reg *prometheus.Registry, srv *http.Server, logger logrus.FieldLogger) {
 213         outdir := cluster.SystemLogs.RequestQueueDumpDirectory
 214         if outdir == "" || cluster.ManagementToken == "" {
 215                 return
 216         }
 217         logger = logger.WithField("worker", "RequestQueueDump")
 218         outfile := outdir + "/" + prog + "-requests.json"
 219         for range time.NewTicker(requestQueueDumpCheckInterval).C {
 220                 mfs, err := reg.Gather()
 221                 if err != nil {
 222                         logger.WithError(err).Warn("error getting metrics")
 223                         continue
 224                 }
 225                 dump := false
 226                 for _, mf := range mfs {
 227                         if mf.Name != nil && *mf.Name == "arvados_concurrent_requests" && len(mf.Metric) == 1 {
 228                                 n := int(mf.Metric[0].GetGauge().GetValue())
 229                                 if n > 0 && n >= cluster.API.MaxConcurrentRequests*9/10 {
 230                                         dump = true
 231                                         break
 232                                 }
 233                         }
 234                 }
 235                 if dump {
 236                         req, err := http.NewRequest("GET", "/_inspect/requests", nil)
 237                         if err != nil {
 238                                 logger.WithError(err).Warn("error in http.NewRequest")
 239                                 continue
 240                         }
 241                         req.Header.Set("Authorization", "Bearer "+cluster.ManagementToken)
 242                         resp := httptest.NewRecorder()
 243                         srv.Handler.ServeHTTP(resp, req)
 244                         if code := resp.Result().StatusCode; code != http.StatusOK {
 245                                 logger.WithField("StatusCode", code).Warn("error getting /_inspect/requests")
 246                                 continue
 247                         }
 248                         err = os.WriteFile(outfile, resp.Body.Bytes(), 0777)
 249                         if err != nil {
 250                                 logger.WithError(err).Warn("error writing file")
 251                                 continue
 252                         }
 253                 }
 254         }
 255 }
 256
 257 // If an incoming request's target vhost has an embedded collection
 258 // UUID or PDH, handle it with hTrue, otherwise handle it with
 259 // hFalse.
 260 //
 261 // Facilitates routing "http://collections.example/metrics" to metrics
 262 // and "http://{uuid}.collections.example/metrics" to a file in a
 263 // collection.
 264 func ifCollectionInHost(hTrue, hFalse http.Handler) http.Handler {
 265         return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 266                 if arvados.CollectionIDFromDNSName(r.Host) != "" {
 267                         hTrue.ServeHTTP(w, r)
 268                 } else {
 269                         hFalse.ServeHTTP(w, r)
 270                 }
 271         })
 272 }
 273
 274 func interceptHealthReqs(mgtToken string, checkHealth func() error, next http.Handler) http.Handler {
 275         mux := httprouter.New()
 276         mux.Handler("GET", "/_health/ping", &health.Handler{
 277                 Token:  mgtToken,
 278                 Prefix: "/_health/",
 279                 Routes: health.Routes{"ping": checkHealth},
 280         })
 281         mux.NotFound = next
 282         return ifCollectionInHost(next, mux)
 283 }
 284
 285 // Determine listenURL (addr:port where server should bind) and
 286 // internalURL (target url that client should connect to) for a
 287 // service.
 288 //
 289 // If the config does not specify ListenURL, we check all of the
 290 // configured InternalURLs. If there is exactly one that matches our
 291 // hostname, or exactly one that matches a local interface address,
 292 // then we use that as listenURL.
 293 //
 294 // Note that listenURL and internalURL may use different protocols
 295 // (e.g., listenURL is http, but the service sits behind a proxy, so
 296 // clients connect using https).
 297 func getListenAddr(svcs arvados.Services, prog arvados.ServiceName, log logrus.FieldLogger) (arvados.URL, arvados.URL, error) {
 298         svc, ok := svcs.Map()[prog]
 299         if !ok {
 300                 return arvados.URL{}, arvados.URL{}, fmt.Errorf("unknown service name %q", prog)
 301         }
 302
 303         if want := os.Getenv("ARVADOS_SERVICE_INTERNAL_URL"); want != "" {
 304                 url, err := url.Parse(want)
 305                 if err != nil {
 306                         return arvados.URL{}, arvados.URL{}, fmt.Errorf("$ARVADOS_SERVICE_INTERNAL_URL (%q): %s", want, err)
 307                 }
 308                 if url.Path == "" {
 309                         url.Path = "/"
 310                 }
 311                 for internalURL, conf := range svc.InternalURLs {
 312                         if internalURL.String() == url.String() {
 313                                 listenURL := conf.ListenURL
 314                                 if listenURL.Host == "" {
 315                                         listenURL = internalURL
 316                                 }
 317                                 return listenURL, internalURL, nil
 318                         }
 319                 }
 320                 log.Warnf("possible configuration error: listening on %s (from $ARVADOS_SERVICE_INTERNAL_URL) even though configuration does not have a matching InternalURLs entry", url)
 321                 internalURL := arvados.URL(*url)
 322                 return internalURL, internalURL, nil
 323         }
 324
 325         errors := []string{}
 326         for internalURL, conf := range svc.InternalURLs {
 327                 listenURL := conf.ListenURL
 328                 if listenURL.Host == "" {
 329                         // If ListenURL is not specified, assume
 330                         // InternalURL is also usable as the listening
 331                         // proto/addr/port (i.e., simple case with no
 332                         // intermediate proxy/routing)
 333                         listenURL = internalURL
 334                 }
 335                 listenAddr := listenURL.Host
 336                 if _, _, err := net.SplitHostPort(listenAddr); err != nil {
 337                         // url "https://foo.example/" (with no
 338                         // explicit port name/number) means listen on
 339                         // the well-known port for the specified
 340                         // protocol, "foo.example:https".
 341                         port := listenURL.Scheme
 342                         if port == "ws" || port == "wss" {
 343                                 port = "http" + port[2:]
 344                         }
 345                         listenAddr = net.JoinHostPort(listenAddr, port)
 346                 }
 347                 listener, err := net.Listen("tcp", listenAddr)
 348                 if err == nil {
 349                         listener.Close()
 350                         return listenURL, internalURL, nil
 351                 } else if strings.Contains(err.Error(), "cannot assign requested address") {
 352                         // If 'Host' specifies a different server than
 353                         // the current one, it'll resolve the hostname
 354                         // to IP address, and then fail because it
 355                         // can't bind an IP address it doesn't own.
 356                         continue
 357                 } else {
 358                         errors = append(errors, fmt.Sprintf("%s: %s", listenURL, err))
 359                 }
 360         }
 361         if len(errors) > 0 {
 362                 return arvados.URL{}, arvados.URL{}, fmt.Errorf("could not enable the %q service on this host: %s", prog, strings.Join(errors, "; "))
 363         }
 364         return arvados.URL{}, arvados.URL{}, fmt.Errorf("configuration does not enable the %q service on this host", prog)
 365 }
 366
 367 type contextKeyURL struct{}
 368
 369 func URLFromContext(ctx context.Context) (arvados.URL, bool) {
 370         u, ok := ctx.Value(contextKeyURL{}).(arvados.URL)
 371         return u, ok
 372 }