Pipeline visualization and debugging in Jenkins - Commands & Configuration

Introduction

When you run automated tasks in Jenkins, you want to see what is happening step-by-step. Pipeline visualization helps you watch the progress and find problems quickly. Debugging means fixing errors by checking logs and stages.

When you want to see which step of your build or deployment is running or failed

When you need to find why a Jenkins pipeline did not complete successfully

When you want to understand the flow of your automated tasks visually

When you want to add pauses or checks to your pipeline to test parts separately

When you want to improve your pipeline by seeing detailed logs and stage results

Config File - Jenkinsfile

Jenkinsfile

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        echo 'Building the project'
      }
    }
    stage('Test') {
      steps {
        echo 'Running tests'
      }
    }
    stage('Deploy') {
      steps {
        echo 'Deploying application'
      }
    }
  }
  post {
    failure {
      echo 'Pipeline failed. Check logs for details.'
    }
  }
}

This Jenkinsfile defines a simple pipeline with three stages: Build, Test, and Deploy.

Each stage prints a message to show progress.

The post section runs after the pipeline and prints a message if the pipeline fails.

This setup helps visualize each step and debug by checking stage outputs and failure messages.

Commands

This command starts the Jenkins pipeline named 'my-pipeline' and waits for it to finish. It shows the progress in the terminal so you can watch the pipeline running live.

Terminal

jenkins-cli build my-pipeline -s

Expected Output

Started build #1

[Pipeline] Start of Pipeline

[Pipeline] echo

Building the project

[Pipeline] echo

Running tests

[Pipeline] echo

Deploying application

[Pipeline] End of Pipeline

Finished: SUCCESS

→

-s - Waits for the build to complete and shows live output

This command fetches the full console output of build number 1 of 'my-pipeline'. It helps you see all logs and messages to find errors or understand what happened during the run.

Terminal

jenkins-cli console my-pipeline 1

Expected Output

[Pipeline] Start of Pipeline

[Pipeline] echo

Building the project

[Pipeline] echo

Running tests

[Pipeline] echo

Deploying application

[Pipeline] End of Pipeline

Finished: SUCCESS

This command lists all Jenkins jobs (pipelines) available. It helps you confirm the pipeline name before running or debugging it.

Terminal

jenkins-cli list-jobs

Expected Output

my-pipeline

example-job

build-and-test

This command re-runs build number 1 of 'my-pipeline'. It is useful for debugging by repeating the exact same pipeline run to check if the problem happens again.

Terminal

jenkins-cli replay my-pipeline 1

Expected Output

Replaying build #1 of job my-pipeline

Started build #2

[Pipeline] Start of Pipeline

[Pipeline] echo

Building the project

[Pipeline] echo

Running tests

[Pipeline] echo

Deploying application

[Pipeline] End of Pipeline

Finished: SUCCESS

Key Concept

If you remember nothing else from this pattern, remember: watching your pipeline run step-by-step and checking logs helps you find and fix problems fast.

Common Mistakes

Trying to debug without checking the console output

You miss important error messages and details that explain why the pipeline failed

Always fetch and read the console output after a failed run to understand the problem

Running a pipeline without knowing the exact job name

The command fails because Jenkins cannot find the job

Use 'jenkins-cli list-jobs' to confirm the job name before running commands

Not waiting for the pipeline to finish when starting it

You cannot see the full output or know if it succeeded or failed immediately

Use the '-s' flag with 'jenkins-cli build' to wait and see live output

Summary

Use a Jenkinsfile to define pipeline stages that show progress and help debugging.

Run the pipeline with 'jenkins-cli build -s' to watch it live and confirm success.

Check full logs with 'jenkins-cli console' to find errors and understand pipeline behavior.

Practice

1. What does Jenkins Pipeline visualization primarily help you understand?

easy

A. The sequence and status of each stage and step in the pipeline

B. The exact code syntax errors in the Jenkinsfile

C. The server hardware specifications running Jenkins

D. The network traffic between Jenkins and agents

Solution

1. Step 1: Understand the purpose of pipeline visualization

   Pipeline visualization shows the flow of stages and steps, helping track progress and status.

2. Step 2: Differentiate from other Jenkins information

   Syntax errors and hardware details are not shown in visualization; they appear elsewhere.

3. Final Answer:

   The sequence and status of each stage and step in the pipeline -> Option A

4. Quick Check:

   Pipeline visualization = stage and step flow [OK]

Hint: Visualization = flow and status of pipeline steps [OK]

Common Mistakes:

• Confusing visualization with syntax error display
• Thinking it shows server or network details
• Assuming it shows logs directly

2. Which syntax correctly defines a stage in a Jenkins Declarative Pipeline?

easy

A. stage: 'Build' { steps: { echo 'Building...' } }

B. step('Build') { stage { echo 'Building...' } }

C. buildStage('Build') { steps { echo 'Building...' } }

D. stage('Build') { steps { echo 'Building...' } }

Solution

1. Step 1: Recall Declarative Pipeline stage syntax

   The correct syntax uses stage('name') with a block containing steps.

2. Step 2: Identify incorrect syntax forms

   Options A, B, and D use invalid keywords or formats not recognized by Jenkins.

3. Final Answer:

   stage('Build') { steps { echo 'Building...' } } -> Option D

4. Quick Check:

   Correct stage syntax = stage('Build') { steps { echo 'Building...' } } [OK]

Hint: Stages use stage('name') with steps block [OK]

Common Mistakes:

• Using 'step' instead of 'stage'
• Incorrect colon usage in syntax
• Inventing non-standard keywords like 'buildStage'

3. Given this Jenkins pipeline snippet, what will be the console output?

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        echo 'Start Testing'
        sh 'exit 1'
        echo 'End Testing'
      }
    }
  }
}

medium

A. Start Testing
End Testing
Pipeline succeeds

B. Start Testing
Pipeline fails after shell command

C. Pipeline fails immediately without output

D. Only End Testing is printed

Solution

1. Step 1: Analyze the steps execution order

   First, 'echo' prints 'Start Testing'. Then shell command 'exit 1' runs and fails.

2. Step 2: Understand pipeline behavior on failure

   After 'exit 1' failure, pipeline stops; 'End Testing' is not printed.

3. Final Answer:

   Start Testing Pipeline fails after shell command -> Option B

4. Quick Check:

   Failure stops pipeline after first error [OK]

Hint: Pipeline stops on shell command failure, later steps skipped [OK]

Common Mistakes:

• Assuming all echo commands run despite failure
• Thinking pipeline succeeds after exit 1
• Ignoring shell command exit codes

4. You see a Jenkins pipeline stuck at a stage with no progress. What is the best first step to debug?

medium

A. Check the console output logs for errors or hanging commands

B. Restart the Jenkins server immediately

C. Delete the pipeline and recreate it from scratch

D. Ignore it and rerun the pipeline

Solution

1. Step 1: Use console logs to find pipeline issues

   Console output shows real-time logs and errors, helping identify where it hangs.

2. Step 2: Avoid drastic actions before investigation

   Restarting or deleting without info wastes time and may lose data.

3. Final Answer:

   Check the console output logs for errors or hanging commands -> Option A

4. Quick Check:

   Logs reveal pipeline issues first [OK]

Hint: Always check logs before restarting or deleting [OK]

Common Mistakes:

• Restarting server without checking logs
• Deleting pipeline without diagnosis
• Ignoring logs and rerunning blindly

5. You want to visualize a Jenkins pipeline with parallel stages and debug why one branch fails silently. Which approach helps best?

hard

A. Disable all logging to speed up the pipeline

B. Run the pipeline without parallel stages to avoid complexity

C. Use the Blue Ocean plugin to see parallel stage status and check individual branch logs

D. Only check the final pipeline status without logs

Solution

1. Step 1: Use Blue Ocean for clear parallel visualization

   Blue Ocean shows parallel branches side-by-side with status and logs.

2. Step 2: Check logs of the failing branch to find silent errors

   Individual logs reveal errors missed in overall summary.

3. Final Answer:

   Use the Blue Ocean plugin to see parallel stage status and check individual branch logs -> Option C

4. Quick Check:

   Blue Ocean + logs = best parallel debug [OK]

Hint: Blue Ocean shows parallel stages clearly with logs [OK]

Common Mistakes:

• Avoiding parallel stages instead of debugging
• Disabling logs losing error info
• Ignoring branch-specific logs