Add long flag --display-name to display the log of pipelinerun

Author: icloudnote

docs/cmd/tkn_pipelinerun_logs.md

@@ -31,6 +31,7 @@ Show the logs of PipelineRun named 'microservice-1' for all Tasks and steps (inc
 
 ```
   -a, --all                           show all logs including init steps injected by tekton
+      --display-name                  show logs with task display name (display name and step name)
   -E, --exit-with-pipelinerun-error   exit with pipelinerun to the unix shell, 0 if success, 1 if error, 2 on unknown status
   -f, --follow                        stream live logs
   -F, --fzf                           use fzf to select a PipelineRun

docs/man/man1/tkn-pipelinerun-logs.1

@@ -23,6 +23,10 @@ Show the logs of a PipelineRun
 \fB\-a\fP, \fB\-\-all\fP[=false]
     show all logs including init steps injected by tekton
 
+.PP
+\fB\-\-display\-name\fP[=false]
+    show logs with task display name (display name and step name)
+
 .PP
 \fB\-E\fP, \fB\-\-exit\-with\-pipelinerun\-error\fP[=false]
     exit with pipelinerun to the unix shell, 0 if success, 1 if error, 2 on unknown status

pkg/cmd/pipelinerun/logs.go

@@ -84,6 +84,7 @@ Show the logs of PipelineRun named 'microservice-1' for all Tasks and steps (inc
 	c.Flags().BoolVarP(&opts.Follow, "follow", "f", false, "stream live logs")
 	c.Flags().BoolVarP(&opts.Timestamps, "timestamps", "", false, "show logs with timestamp")
 	c.Flags().BoolVarP(&opts.Prefixing, "prefix", "", true, "prefix each log line with the log source (task name and step name)")
+	c.Flags().BoolVarP(&opts.DisplayName, "display-name", "", false, "show logs with task display name (display name and step name)")
 	c.Flags().BoolVarP(&opts.ExitWithPrError, "exit-with-pipelinerun-error", "E", false, "exit with pipelinerun to the unix shell, 0 if success, 1 if error, 2 on unknown status")
 	c.Flags().StringSliceVarP(&opts.Tasks, "task", "t", []string{}, "show logs for mentioned Tasks only")
 	c.Flags().IntVarP(&opts.Limit, "limit", "", defaultLimit, "lists number of PipelineRuns")
@@ -110,7 +111,7 @@ func Run(opts *options.LogOptions) error {
 		return err
 	}
 
-	log.NewWriter(log.LogTypePipeline, opts.Prefixing).Write(opts.Stream, logC, errC)
+	log.NewWriter(log.LogTypePipeline, opts.Prefixing).WithDisplayName(opts.DisplayName).Write(opts.Stream, logC, errC)
 
 	// get pipelinerun status
 	if opts.ExitWithPrError {

pkg/log/log.go

@@ -27,8 +27,9 @@ var pipelineGroupResource = schema.GroupVersionResource{Group: "tekton.dev", Res
 
 // Log represents data to write on log channel
 type Log struct {
-	Pipeline string
-	Task     string
-	Step     string
-	Log      string
+	Pipeline        string
+	Task            string
+	TaskDisplayName string
+	Step            string
+	Log             string
 }

pkg/log/pipeline_reader.go

@@ -192,7 +192,7 @@ func (r *Reader) pipeLogs(logC chan<- Log, errC chan<- error) {
 				tlogC = nil
 				continue
 			}
-			logC <- Log{Task: l.Task, Step: l.Step, Log: l.Log}
+			logC <- Log{Task: l.Task, TaskDisplayName: l.TaskDisplayName, Step: l.Step, Log: l.Log}
 
 		case e, ok := <-terrC:
 			if !ok {
@@ -208,6 +208,7 @@ func (r *Reader) setUpTask(taskNumber int, tr taskrunpkg.Run) {
 	r.setNumber(taskNumber)
 	r.setRun(tr.Name)
 	r.setTask(tr.Task)
+	r.setDisplayName(tr.DisplayName)
 	r.setRetries(tr.Retries)
 }
 

pkg/log/reader.go

@@ -37,6 +37,7 @@ type Reader struct {
 	steps           []string
 	logType         string
 	task            string
+	displayName     string
 	number          int
 	activityTimeout time.Duration
 	retries         int
@@ -108,6 +109,10 @@ func (r *Reader) setTask(task string) {
 	r.task = task
 }
 
+func (r *Reader) setDisplayName(displayName string) {
+	r.displayName = displayName
+}
+
 func (r *Reader) clone() *Reader {
 	c := *r
 	return &c

pkg/log/task_reader.go

@@ -138,10 +138,10 @@ func (r *Reader) readStepsLogs(logC chan<- Log, errC chan<- error, steps []*step
 			case l, ok := <-containerLogC:
 				if !ok {
 					containerLogC = nil
-					logC <- Log{Task: r.task, Step: step.name, Log: "EOFLOG"}
+					logC <- Log{Task: r.task, TaskDisplayName: r.displayName, Step: step.name, Log: "EOFLOG"}
 					continue
 				}
-				logC <- Log{Task: r.task, Step: step.name, Log: l.Log}
+				logC <- Log{Task: r.task, TaskDisplayName: r.displayName, Step: step.name, Log: l.Log}
 
 			case e, ok := <-containerLogErrC:
 				if !ok {

pkg/log/writer.go

@@ -23,9 +23,10 @@ import (
 
 // Writer helps logging pod"s log
 type Writer struct {
-	fmt       *formatted.Color
-	logType   string
-	prefixing bool
+	fmt         *formatted.Color
+	logType     string
+	prefixing   bool
+	displayName bool
 }
 
 // NewWriter returns the new instance of LogWriter
@@ -37,6 +38,12 @@ func NewWriter(logType string, prefixing bool) *Writer {
 	}
 }
 
+// WithDisplayName sets the display name
+func (lw *Writer) WithDisplayName(displayName bool) *Writer {
+	lw.displayName = displayName
+	return lw
+}
+
 // Write formatted pod's logs
 func (lw *Writer) Write(s *cli.Stream, logC <-chan Log, errC <-chan error) {
 	for logC != nil || errC != nil {
@@ -52,6 +59,10 @@ func (lw *Writer) Write(s *cli.Stream, logC <-chan Log, errC <-chan error) {
 				continue
 			}
 
+			if lw.displayName && l.TaskDisplayName != "" {
+				l.Task = l.TaskDisplayName
+			}
+
 			if lw.prefixing {
 				switch lw.logType {
 				case LogTypePipeline:

pkg/options/logs.go

@@ -51,6 +51,7 @@ type LogOptions struct {
 	Tail            int64
 	Timestamps      bool
 	Prefixing       bool
+	DisplayName     bool
 	ExitWithPrError bool
 	// ActivityTimeout is the amount of time to wait for some activity
 	// (e.g. Pod ready) before giving up.

pkg/taskrun/taskrun.go

@@ -23,6 +23,7 @@ import (
 
 type Run struct {
 	Name           string
+	DisplayName    string
 	Task           string
 	Retries        int
 	StartTime      *metav1.Time
@@ -92,6 +93,7 @@ func SortTasksBySpecOrder(pipelineTasks []v1.PipelineTask, pipelinesTaskRuns map
 			trs = append(trs, Run{
 				Task:           ts.Name,
 				Name:           n,
+				DisplayName:    ts.DisplayName,
 				Retries:        ts.Retries,
 				StartTime:      trStatusFields.StartTime,
 				CompletionTime: trStatusFields.CompletionTime,