Add Namespace, Job and Group to envoy stats

.changelog/14311.txt

@@ -0,0 +1,3 @@
+```release-note:improvement
+connect: add namespace, job, and group to Envoy stats
+```

client/allocrunner/alloc_runner_hooks.go

@@ -153,7 +153,7 @@ func (ar *allocRunner) initRunnerHooks(config *clientconfig.Config) error {
 		newNetworkHook(hookLogger, ns, alloc, nm, nc, ar, builtTaskEnv),
 		newGroupServiceHook(groupServiceHookConfig{
 			alloc:             alloc,
-			namespace:         alloc.ServiceProviderNamespace(),
+			providerNamespace: alloc.ServiceProviderNamespace(),
 			serviceRegWrapper: ar.serviceRegWrapper,
 			restarter:         ar,
 			taskEnvBuilder:    envBuilder,

client/allocrunner/group_service_hook.go

@@ -24,15 +24,16 @@ type groupServiceHook struct {
 	allocID          string
 	jobID            string
 	group            string
+	namespace        string
 	restarter        serviceregistration.WorkloadRestarter
 	prerun           bool
 	deregistered     bool
 	networkStatus    structs.NetworkStatus
 	shutdownDelayCtx context.Context
 
-	// namespace is the Nomad or Consul namespace in which service
+	// providerNamespace is the Nomad or Consul namespace in which service
 	// registrations will be made. This field may be updated.
-	namespace string
+	providerNamespace string
 
 	// serviceRegWrapper is the handler wrapper that is used to perform service
 	// and check registration and deregistration.
@@ -61,9 +62,9 @@ type groupServiceHookConfig struct {
 	shutdownDelayCtx context.Context
 	logger           log.Logger
 
-	// namespace is the Nomad or Consul namespace in which service
+	// providerNamespace is the Nomad or Consul namespace in which service
 	// registrations will be made.
-	namespace string
+	providerNamespace string
 
 	// serviceRegWrapper is the handler wrapper that is used to perform service
 	// and check registration and deregistration.
@@ -82,8 +83,9 @@ func newGroupServiceHook(cfg groupServiceHookConfig) *groupServiceHook {
 		allocID:           cfg.alloc.ID,
 		jobID:             cfg.alloc.JobID,
 		group:             cfg.alloc.TaskGroup,
+		namespace:         cfg.alloc.Namespace,
 		restarter:         cfg.restarter,
-		namespace:         cfg.namespace,
+		providerNamespace: cfg.providerNamespace,
 		taskEnvBuilder:    cfg.taskEnvBuilder,
 		delay:             shutdownDelay,
 		networkStatus:     cfg.networkStatus,
@@ -161,7 +163,7 @@ func (h *groupServiceHook) Update(req *interfaces.RunnerUpdateRequest) error {
 
 	// An update may change the service provider, therefore we need to account
 	// for how namespaces work across providers also.
-	h.namespace = req.Alloc.ServiceProviderNamespace()
+	h.providerNamespace = req.Alloc.ServiceProviderNamespace()
 
 	// Create new task services struct with those new values
 	newWorkloadServices := h.getWorkloadServices()
@@ -244,17 +246,22 @@ func (h *groupServiceHook) getWorkloadServices() *serviceregistration.WorkloadSe
 		netStatus = h.networkStatus.NetworkStatus()
 	}
 
+	info := structs.AllocInfo{
+		AllocID:   h.allocID,
+		JobID:     h.jobID,
+		Group:     h.group,
+		Namespace: h.namespace,
+	}
+
 	// Create task services struct with request's driver metadata
 	return &serviceregistration.WorkloadServices{
-		AllocID:       h.allocID,
-		JobID:         h.jobID,
-		Group:         h.group,
-		Namespace:     h.namespace,
-		Restarter:     h.restarter,
-		Services:      interpolatedServices,
-		Networks:      h.networks,
-		NetworkStatus: netStatus,
-		Ports:         h.ports,
-		Canary:        h.canary,
+		AllocInfo:         info,
+		ProviderNamespace: h.providerNamespace,
+		Restarter:         h.restarter,
+		Services:          interpolatedServices,
+		Networks:          h.networks,
+		NetworkStatus:     netStatus,
+		Ports:             h.ports,
+		Canary:            h.canary,
 	}
 }

client/allocrunner/taskrunner/service_hook.go

@@ -31,7 +31,7 @@ type serviceHookConfig struct {
 
 	// namespace is the Nomad or Consul namespace in which service
 	// registrations will be made.
-	namespace string
+	providerNamespace string
 
 	// serviceRegWrapper is the handler wrapper that is used to perform service
 	// and check registration and deregistration.
@@ -48,6 +48,7 @@ type serviceHook struct {
 	jobID     string
 	groupName string
 	taskName  string
+	namespace string
 	restarter serviceregistration.WorkloadRestarter
 	logger    log.Logger
 
@@ -60,9 +61,9 @@ type serviceHook struct {
 	ports      structs.AllocatedPorts
 	taskEnv    *taskenv.TaskEnv
 
-	// namespace is the Nomad or Consul namespace in which service
+	// providerNamespace is the Nomad or Consul namespace in which service
 	// registrations will be made. This field may be updated.
-	namespace string
+	providerNamespace string
 
 	// serviceRegWrapper is the handler wrapper that is used to perform service
 	// and check registration and deregistration.
@@ -87,7 +88,8 @@ func newServiceHook(c serviceHookConfig) *serviceHook {
 		jobID:             c.alloc.JobID,
 		groupName:         c.alloc.TaskGroup,
 		taskName:          c.task.Name,
-		namespace:         c.namespace,
+		namespace:         c.alloc.Namespace,
+		providerNamespace: c.providerNamespace,
 		serviceRegWrapper: c.serviceRegWrapper,
 		services:          c.task.Services,
 		restarter:         c.restarter,
@@ -176,7 +178,7 @@ func (h *serviceHook) updateHookFields(req *interfaces.TaskUpdateRequest) error
 
 	// An update may change the service provider, therefore we need to account
 	// for how namespaces work across providers also.
-	h.namespace = req.Alloc.ServiceProviderNamespace()
+	h.providerNamespace = req.Alloc.ServiceProviderNamespace()
 
 	return nil
 }
@@ -219,19 +221,23 @@ func (h *serviceHook) getWorkloadServices() *serviceregistration.WorkloadService
 	// Interpolate with the task's environment
 	interpolatedServices := taskenv.InterpolateServices(h.taskEnv, h.services)
 
+	info := structs.AllocInfo{
+		AllocID:   h.allocID,
+		JobID:     h.jobID,
+		Task:      h.taskName,
+		Namespace: h.namespace,
+	}
+
 	// Create task services struct with request's driver metadata
 	return &serviceregistration.WorkloadServices{
-		AllocID:       h.allocID,
-		JobID:         h.jobID,
-		Group:         h.groupName,
-		Task:          h.taskName,
-		Namespace:     h.namespace,
-		Restarter:     h.restarter,
-		Services:      interpolatedServices,
-		DriverExec:    h.driverExec,
-		DriverNetwork: h.driverNet,
-		Networks:      h.networks,
-		Canary:        h.canary,
-		Ports:         h.ports,
+		AllocInfo:         info,
+		ProviderNamespace: h.providerNamespace,
+		Restarter:         h.restarter,
+		Services:          interpolatedServices,
+		DriverExec:        h.driverExec,
+		DriverNetwork:     h.driverNet,
+		Networks:          h.networks,
+		Canary:            h.canary,
+		Ports:             h.ports,
 	}
 }

client/allocrunner/taskrunner/service_hook_test.go

@@ -177,7 +177,7 @@ func Test_serviceHook_Nomad(t *testing.T) {
 	h := newServiceHook(serviceHookConfig{
 		alloc:             alloc,
 		task:              alloc.LookupTask("web"),
-		namespace:         "default",
+		providerNamespace: "default",
 		serviceRegWrapper: regWrapper,
 		restarter:         agentconsul.NoopRestarter(),
 		logger:            logger,

client/allocrunner/taskrunner/task_runner_hooks.go

@@ -123,7 +123,7 @@ func (tr *TaskRunner) initHooks() {
 	tr.runnerHooks = append(tr.runnerHooks, newServiceHook(serviceHookConfig{
 		alloc:             tr.Alloc(),
 		task:              tr.Task(),
-		namespace:         serviceProviderNamespace,
+		providerNamespace: serviceProviderNamespace,
 		serviceRegWrapper: tr.serviceRegWrapper,
 		restarter:         tr,
 		logger:            hookLogger,

client/serviceregistration/mock/mock.go

@@ -42,31 +42,31 @@ func (h *ServiceRegistrationHandler) RegisterWorkload(services *serviceregistrat
 	h.mu.Lock()
 	defer h.mu.Unlock()
 
-	h.log.Trace("RegisterWorkload", "alloc_id", services.AllocID,
+	h.log.Trace("RegisterWorkload", "alloc_id", services.AllocInfo.AllocID,
 		"name", services.Name(), "services", len(services.Services))
 
-	h.ops = append(h.ops, newOperation("add", services.AllocID, services.Name()))
+	h.ops = append(h.ops, newOperation("add", services.AllocInfo.AllocID, services.Name()))
 	return nil
 }
 
 func (h *ServiceRegistrationHandler) RemoveWorkload(services *serviceregistration.WorkloadServices) {
 	h.mu.Lock()
 	defer h.mu.Unlock()
 
-	h.log.Trace("RemoveWorkload", "alloc_id", services.AllocID,
+	h.log.Trace("RemoveWorkload", "alloc_id", services.AllocInfo.AllocID,
 		"name", services.Name(), "services", len(services.Services))
 
-	h.ops = append(h.ops, newOperation("remove", services.AllocID, services.Name()))
+	h.ops = append(h.ops, newOperation("remove", services.AllocInfo.AllocID, services.Name()))
 }
 
 func (h *ServiceRegistrationHandler) UpdateWorkload(old, newServices *serviceregistration.WorkloadServices) error {
 	h.mu.Lock()
 	defer h.mu.Unlock()
 
-	h.log.Trace("UpdateWorkload", "alloc_id", newServices.AllocID, "name", newServices.Name(),
+	h.log.Trace("UpdateWorkload", "alloc_id", newServices.AllocInfo.AllocID, "name", newServices.Name(),
 		"old_services", len(old.Services), "new_services", len(newServices.Services))
 
-	h.ops = append(h.ops, newOperation("update", newServices.AllocID, newServices.Name()))
+	h.ops = append(h.ops, newOperation("update", newServices.AllocInfo.AllocID, newServices.Name()))
 	return nil
 }
 

client/serviceregistration/nsd/nsd.go

@@ -153,13 +153,13 @@ func (s *ServiceRegistrationHandler) removeWorkload(
 	}
 
 	// Generate the consistent ID for this service, so we know what to remove.
-	id := serviceregistration.MakeAllocServiceID(workload.AllocID, workload.Name(), serviceSpec)
+	id := serviceregistration.MakeAllocServiceID(workload.AllocInfo.AllocID, workload.Name(), serviceSpec)
 
 	deleteArgs := structs.ServiceRegistrationDeleteByIDRequest{
 		ID: id,
 		WriteRequest: structs.WriteRequest{
 			Region:    s.cfg.Region,
-			Namespace: workload.Namespace,
+			Namespace: workload.ProviderNamespace,
 			AuthToken: s.cfg.NodeSecret,
 		},
 	}
@@ -178,14 +178,14 @@ func (s *ServiceRegistrationHandler) removeWorkload(
 	// while ensuring the operator can see.
 	if strings.Contains(err.Error(), "service registration not found") {
 		s.log.Info("attempted to delete non-existent service registration",
-			"service_id", id, "namespace", workload.Namespace)
+			"service_id", id, "namespace", workload.ProviderNamespace)
 		return
 	}
 
 	// Log the error as there is nothing left to do, so the operator can see it
 	// and identify any problems.
 	s.log.Error("failed to delete service registration",
-		"error", err, "service_id", id, "namespace", workload.Namespace)
+		"error", err, "service_id", id, "namespace", workload.ProviderNamespace)
 }
 
 func (s *ServiceRegistrationHandler) UpdateWorkload(old, new *serviceregistration.WorkloadServices) error {
@@ -231,7 +231,7 @@ func (s *ServiceRegistrationHandler) dedupUpdatedWorkload(
 	newIDs := make(map[string]*structs.Service, len(newWork.Services))
 
 	for _, s := range newWork.Services {
-		newIDs[serviceregistration.MakeAllocServiceID(newWork.AllocID, newWork.Name(), s)] = s
+		newIDs[serviceregistration.MakeAllocServiceID(newWork.AllocInfo.AllocID, newWork.Name(), s)] = s
 	}
 
 	// Iterate through the old services in order to identify whether they can
@@ -240,7 +240,7 @@ func (s *ServiceRegistrationHandler) dedupUpdatedWorkload(
 
 		// Generate the service ID of the old service. If this is not found
 		// within the new mapping then we need to remove it.
-		oldID := serviceregistration.MakeAllocServiceID(oldWork.AllocID, oldWork.Name(), oldService)
+		oldID := serviceregistration.MakeAllocServiceID(oldWork.AllocInfo.AllocID, oldWork.Name(), oldService)
 		newSvc, ok := newIDs[oldID]
 		if !ok {
 			oldCopy.Services = append(oldCopy.Services, oldService)
@@ -319,12 +319,12 @@ func (s *ServiceRegistrationHandler) generateNomadServiceRegistration(
 	}
 
 	return &structs.ServiceRegistration{
-		ID:          serviceregistration.MakeAllocServiceID(workload.AllocID, workload.Name(), serviceSpec),
+		ID:          serviceregistration.MakeAllocServiceID(workload.AllocInfo.AllocID, workload.Name(), serviceSpec),
 		ServiceName: serviceSpec.Name,
 		NodeID:      s.cfg.NodeID,
-		JobID:       workload.JobID,
-		AllocID:     workload.AllocID,
-		Namespace:   workload.Namespace,
+		JobID:       workload.AllocInfo.JobID,
+		AllocID:     workload.AllocInfo.AllocID,
+		Namespace:   workload.ProviderNamespace,
 		Datacenter:  s.cfg.Datacenter,
 		Tags:        tags,
 		Address:     ip,