package agent import ( "fmt" "net/http" "net/url" "strconv" "strings" "github.com/hashicorp/consul/agent/structs" "github.com/hashicorp/consul/api" ) const ( serviceHealth = "service" connectHealth = "connect" ingressHealth = "ingress" ) func (s *HTTPHandlers) HealthChecksInState(resp http.ResponseWriter, req *http.Request) (interface{}, error) { // Set default DC args := structs.ChecksInStateRequest{} if err := s.parseEntMeta(req, &args.EnterpriseMeta); err != nil { return nil, err } s.parseSource(req, &args.Source) args.NodeMetaFilters = s.parseMetaFilter(req) if done := s.parse(resp, req, &args.Datacenter, &args.QueryOptions); done { return nil, nil } // Pull out the service name args.State = strings.TrimPrefix(req.URL.Path, "/v1/health/state/") if args.State == "" { resp.WriteHeader(http.StatusBadRequest) fmt.Fprint(resp, "Missing check state") return nil, nil } // Make the RPC request var out structs.IndexedHealthChecks defer setMeta(resp, &out.QueryMeta) RETRY_ONCE: if err := s.agent.RPC("Health.ChecksInState", &args, &out); err != nil { return nil, err } if args.QueryOptions.AllowStale && args.MaxStaleDuration > 0 && args.MaxStaleDuration < out.LastContact { args.AllowStale = false args.MaxStaleDuration = 0 goto RETRY_ONCE } out.ConsistencyLevel = args.QueryOptions.ConsistencyLevel() // Use empty list instead of nil if out.HealthChecks == nil { out.HealthChecks = make(structs.HealthChecks, 0) } for i, c := range out.HealthChecks { if c.ServiceTags == nil { clone := *c clone.ServiceTags = make([]string, 0) out.HealthChecks[i] = &clone } } return out.HealthChecks, nil } func (s *HTTPHandlers) HealthNodeChecks(resp http.ResponseWriter, req *http.Request) (interface{}, error) { // Set default DC args := structs.NodeSpecificRequest{} if err := s.parseEntMeta(req, &args.EnterpriseMeta); err != nil { return nil, err } if done := s.parse(resp, req, &args.Datacenter, &args.QueryOptions); done { return nil, nil } // Pull out the service name args.Node = strings.TrimPrefix(req.URL.Path, "/v1/health/node/") if args.Node == "" { resp.WriteHeader(http.StatusBadRequest) fmt.Fprint(resp, "Missing node name") return nil, nil } // Make the RPC request var out structs.IndexedHealthChecks defer setMeta(resp, &out.QueryMeta) RETRY_ONCE: if err := s.agent.RPC("Health.NodeChecks", &args, &out); err != nil { return nil, err } if args.QueryOptions.AllowStale && args.MaxStaleDuration > 0 && args.MaxStaleDuration < out.LastContact { args.AllowStale = false args.MaxStaleDuration = 0 goto RETRY_ONCE } out.ConsistencyLevel = args.QueryOptions.ConsistencyLevel() // Use empty list instead of nil if out.HealthChecks == nil { out.HealthChecks = make(structs.HealthChecks, 0) } for i, c := range out.HealthChecks { if c.ServiceTags == nil { clone := *c clone.ServiceTags = make([]string, 0) out.HealthChecks[i] = &clone } } return out.HealthChecks, nil } func (s *HTTPHandlers) HealthServiceChecks(resp http.ResponseWriter, req *http.Request) (interface{}, error) { // Set default DC args := structs.ServiceSpecificRequest{} if err := s.parseEntMetaNoWildcard(req, &args.EnterpriseMeta); err != nil { return nil, err } s.parseSource(req, &args.Source) args.NodeMetaFilters = s.parseMetaFilter(req) if done := s.parse(resp, req, &args.Datacenter, &args.QueryOptions); done { return nil, nil } // Pull out the service name args.ServiceName = strings.TrimPrefix(req.URL.Path, "/v1/health/checks/") if args.ServiceName == "" { resp.WriteHeader(http.StatusBadRequest) fmt.Fprint(resp, "Missing service name") return nil, nil } // Make the RPC request var out structs.IndexedHealthChecks defer setMeta(resp, &out.QueryMeta) RETRY_ONCE: if err := s.agent.RPC("Health.ServiceChecks", &args, &out); err != nil { return nil, err } if args.QueryOptions.AllowStale && args.MaxStaleDuration > 0 && args.MaxStaleDuration < out.LastContact { args.AllowStale = false args.MaxStaleDuration = 0 goto RETRY_ONCE } out.ConsistencyLevel = args.QueryOptions.ConsistencyLevel() // Use empty list instead of nil if out.HealthChecks == nil { out.HealthChecks = make(structs.HealthChecks, 0) } for i, c := range out.HealthChecks { if c.ServiceTags == nil { clone := *c clone.ServiceTags = make([]string, 0) out.HealthChecks[i] = &clone } } return out.HealthChecks, nil } // HealthIngressServiceNodes should return "all the healthy ingress gateway instances // that I can use to access this connect-enabled service without mTLS". func (s *HTTPHandlers) HealthIngressServiceNodes(resp http.ResponseWriter, req *http.Request) (interface{}, error) { return s.healthServiceNodes(resp, req, ingressHealth) } // HealthConnectServiceNodes should return "all healthy connect-enabled // endpoints (e.g. could be side car proxies or native instances) for this // service so I can connect with mTLS". func (s *HTTPHandlers) HealthConnectServiceNodes(resp http.ResponseWriter, req *http.Request) (interface{}, error) { return s.healthServiceNodes(resp, req, connectHealth) } // HealthServiceNodes should return "all the healthy instances of this service // registered so I can connect directly to them". func (s *HTTPHandlers) HealthServiceNodes(resp http.ResponseWriter, req *http.Request) (interface{}, error) { return s.healthServiceNodes(resp, req, serviceHealth) } func (s *HTTPHandlers) healthServiceNodes(resp http.ResponseWriter, req *http.Request, healthType string) (interface{}, error) { // Set default DC args := structs.ServiceSpecificRequest{} if err := s.parseEntMetaNoWildcard(req, &args.EnterpriseMeta); err != nil { return nil, err } s.parseSource(req, &args.Source) args.NodeMetaFilters = s.parseMetaFilter(req) if done := s.parse(resp, req, &args.Datacenter, &args.QueryOptions); done { return nil, nil } // Check for tags params := req.URL.Query() if _, ok := params["tag"]; ok { args.ServiceTags = params["tag"] args.TagFilter = true } // Determine the prefix var prefix string switch healthType { case connectHealth: prefix = "/v1/health/connect/" args.Connect = true case ingressHealth: prefix = "/v1/health/ingress/" args.Ingress = true default: // serviceHealth is the default type prefix = "/v1/health/service/" } // Pull out the service name args.ServiceName = strings.TrimPrefix(req.URL.Path, prefix) if args.ServiceName == "" { resp.WriteHeader(http.StatusBadRequest) fmt.Fprint(resp, "Missing service name") return nil, nil } // useStreaming when a blocking query is requested, but not when the near // query parameter is set, because that requires data only available to the server // to sort the results. useStreaming := s.agent.config.UseStreamingBackend && args.MinQueryIndex > 0 && args.Source.Node == "" args.QueryOptions.UseCache = s.agent.config.HTTPUseCache && (args.QueryOptions.UseCache || useStreaming) out, md, err := s.agent.rpcClientHealth.ServiceNodes(req.Context(), args) if err != nil { return nil, err } if args.QueryOptions.UseCache { setCacheMeta(resp, &md) } setMeta(resp, &out.QueryMeta) out.ConsistencyLevel = args.QueryOptions.ConsistencyLevel() // FIXME: argument parsing should be done before performing the rpc // Filter to only passing if specified filter, err := getBoolQueryParam(params, api.HealthPassing) if err != nil { resp.WriteHeader(http.StatusBadRequest) fmt.Fprint(resp, "Invalid value for ?passing") return nil, nil } // FIXME: remove filterNonPassing, replace with nodes.Filter, which is used by DNSServer if filter { out.Nodes = filterNonPassing(out.Nodes) } // Translate addresses after filtering so we don't waste effort. s.agent.TranslateAddresses(args.Datacenter, out.Nodes, TranslateAddressAcceptAny) // Use empty list instead of nil if out.Nodes == nil { out.Nodes = make(structs.CheckServiceNodes, 0) } for i := range out.Nodes { if out.Nodes[i].Checks == nil { out.Nodes[i].Checks = make(structs.HealthChecks, 0) } for j, c := range out.Nodes[i].Checks { if c.ServiceTags == nil { clone := *c clone.ServiceTags = make([]string, 0) out.Nodes[i].Checks[j] = &clone } } if out.Nodes[i].Service != nil && out.Nodes[i].Service.Tags == nil { clone := *out.Nodes[i].Service clone.Tags = make([]string, 0) out.Nodes[i].Service = &clone } } return out.Nodes, nil } func getBoolQueryParam(params url.Values, key string) (bool, error) { var param bool if _, ok := params[key]; ok { val := params.Get(key) // Orginally a comment declared this check should be removed after Consul // 0.10, to no longer support using ?passing without a value. However, I // think this is a reasonable experience for a user and so am keeping it // here. if val == "" { param = true } else { var err error param, err = strconv.ParseBool(val) if err != nil { return false, err } } } return param, nil } // filterNonPassing is used to filter out any nodes that have check that are not passing func filterNonPassing(nodes structs.CheckServiceNodes) structs.CheckServiceNodes { n := len(nodes) // Make a copy of the cached nodes rather than operating on the cache directly out := append(nodes[:0:0], nodes...) OUTER: for i := 0; i < n; i++ { node := out[i] for _, check := range node.Checks { if check.Status != api.HealthPassing { out[i], out[n-1] = out[n-1], structs.CheckServiceNode{} n-- i-- continue OUTER } } } return out[:n] }