Merge branch 'add-hostname-to-build-logger' into 'main'

Add pod/container name to build logger fields

See merge request https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/5891

Merged-by: Axel von Bertoldi <avonbertoldi@gitlab.com>
Approved-by: Sam Roque-Worcel <sroque-worcel@gitlab.com>
Approved-by: Axel von Bertoldi <avonbertoldi@gitlab.com>
Approved-by: Joe Burnett <jburnett@gitlab.com>
Reviewed-by: Joe Burnett <jburnett@gitlab.com>
Reviewed-by: GitLab Duo <gitlab-duo@gitlab.com>
Co-authored-by: Igor Wiedler <iwiedler@gitlab.com>

Author: Axel von Bertoldi

common/build.go

@@ -227,6 +227,16 @@ func (b *Build) Log() *logrus.Entry {
 		l = l.WithField("gitlab_scoped_user_id", *b.JobInfo.ScopedUserID)
 	}
 
+	// this is only set after the prepare stage has run
+	if b.Hostname != "" {
+		l = l.WithField("name", b.Hostname)
+	}
+
+	// executor-specific log fields
+	for k, v := range GetExecutorLogFields(b.ExecutorData) {
+		l = l.WithField(k, v)
+	}
+
 	return l
 }
 

common/executor.go

@@ -15,6 +15,21 @@ import (
 // executor will use. Meant to be casted, e.g. virtual machine details.
 type ExecutorData interface{}
 
+// ExecutorDataLogger is an optional interface that ExecutorData implementations
+// can implement to provide executor-specific fields for structured logging.
+type ExecutorDataLogger interface {
+	LogFields() map[string]string
+}
+
+// GetExecutorLogFields extracts log fields from ExecutorData if it implements
+// ExecutorDataLogger, otherwise returns nil.
+func GetExecutorLogFields(data ExecutorData) map[string]string {
+	if l, ok := data.(ExecutorDataLogger); ok {
+		return l.LogFields()
+	}
+	return nil
+}
+
 // ExecutorCommand stores the script executor will run on a given stage.
 // If Predefined it will try to use already allocated resources.
 type ExecutorCommand struct {

executors/docker/docker_command.go

@@ -178,6 +178,10 @@ func (s *commandExecutor) requestHelperContainer() (*container.InspectResponse,
 		return nil, err
 	}
 
+	if data, ok := s.Build.ExecutorData.(*executorData); ok {
+		data.ContainerName = s.helperContainer.Name
+	}
+
 	return s.helperContainer, nil
 }
 
@@ -217,6 +221,10 @@ func (s *commandExecutor) requestBuildContainer() (*container.InspectResponse, e
 		return nil, err
 	}
 
+	if data, ok := s.Build.ExecutorData.(*executorData); ok {
+		data.ContainerName = s.buildContainer.Name
+	}
+
 	err = s.changeFilesOwnership()
 	if err != nil {
 		return nil, err
@@ -388,22 +396,26 @@ func init() {
 		features.Variables = true
 	}
 
-	common.RegisterExecutorProvider("docker", executors.DefaultExecutorProvider{
-		Creator:          creator,
-		FeaturesUpdater:  featuresUpdater,
-		ConfigUpdater:    configUpdater,
-		DefaultShellName: options.Shell.Shell,
+	common.RegisterExecutorProvider("docker", executorProvider{
+		DefaultExecutorProvider: executors.DefaultExecutorProvider{
+			Creator:          creator,
+			FeaturesUpdater:  featuresUpdater,
+			ConfigUpdater:    configUpdater,
+			DefaultShellName: options.Shell.Shell,
+		},
 	})
 
 	windowsFeaturesUpdater := func(features *common.FeaturesInfo) {
 		featuresUpdater(features)
 		features.NativeStepsIntegration = false
 	}
 
-	common.RegisterExecutorProvider("docker-windows", executors.DefaultExecutorProvider{
-		Creator:          creator,
-		FeaturesUpdater:  windowsFeaturesUpdater,
-		ConfigUpdater:    configUpdater,
-		DefaultShellName: options.Shell.Shell,
+	common.RegisterExecutorProvider("docker-windows", executorProvider{
+		DefaultExecutorProvider: executors.DefaultExecutorProvider{
+			Creator:          creator,
+			FeaturesUpdater:  windowsFeaturesUpdater,
+			ConfigUpdater:    configUpdater,
+			DefaultShellName: options.Shell.Shell,
+		},
 	})
 }

executors/docker/provider.go

@@ -0,0 +1,27 @@
+package docker
+
+import (
+	"strings"
+
+	"gitlab.com/gitlab-org/gitlab-runner/common"
+	"gitlab.com/gitlab-org/gitlab-runner/executors"
+)
+
+type executorData struct {
+	ContainerName string
+}
+
+func (d *executorData) LogFields() map[string]string {
+	if d.ContainerName == "" {
+		return nil
+	}
+	return map[string]string{"container_name": strings.TrimPrefix(d.ContainerName, "/")}
+}
+
+type executorProvider struct {
+	executors.DefaultExecutorProvider
+}
+
+func (p executorProvider) Acquire(config *common.RunnerConfig) (common.ExecutorData, error) {
+	return &executorData{}, nil
+}

executors/kubernetes/kubernetes.go

@@ -2129,6 +2129,10 @@ func (s *executor) setupBuildPod(ctx context.Context, initContainers []api.Conta
 		return err
 	}
 
+	if data, ok := s.Build.ExecutorData.(*executorData); ok {
+		data.PodName = s.pod.GetName()
+	}
+
 	ownerReferences := s.buildPodReferences()
 	err = s.setOwnerReferencesForResources(ctx, ownerReferences)
 	if err != nil {
@@ -3533,11 +3537,13 @@ func featuresFn(features *common.FeaturesInfo) {
 }
 
 func init() {
-	common.RegisterExecutorProvider(common.ExecutorKubernetes, executors.DefaultExecutorProvider{
-		Creator: func() common.Executor {
-			return newExecutor()
+	common.RegisterExecutorProvider(common.ExecutorKubernetes, executorProvider{
+		DefaultExecutorProvider: executors.DefaultExecutorProvider{
+			Creator: func() common.Executor {
+				return newExecutor()
+			},
+			FeaturesUpdater:  featuresFn,
+			DefaultShellName: executorOptions.Shell.Shell,
 		},
-		FeaturesUpdater:  featuresFn,
-		DefaultShellName: executorOptions.Shell.Shell,
 	})
 }

executors/kubernetes/provider.go

@@ -0,0 +1,25 @@
+package kubernetes
+
+import (
+	"gitlab.com/gitlab-org/gitlab-runner/common"
+	"gitlab.com/gitlab-org/gitlab-runner/executors"
+)
+
+type executorData struct {
+	PodName string
+}
+
+func (d *executorData) LogFields() map[string]string {
+	if d.PodName == "" {
+		return nil
+	}
+	return map[string]string{"pod_name": d.PodName}
+}
+
+type executorProvider struct {
+	executors.DefaultExecutorProvider
+}
+
+func (p executorProvider) Acquire(config *common.RunnerConfig) (common.ExecutorData, error) {
+	return &executorData{}, nil
+}