Phase 2: 3-Level Logger System Implementation

Basic Information

Table of Contents

1. Goal
2. Commit List
3. Step-by-Step Detailed Analysis
4. 3.1 Step 1: vars Call Method Test
5. 3.2 Step 2: Logger Initial Implementation and CPS Issue Resolution
6. 3.3 Step 3: Logger Completion and Integration
7. 3-Level Logging Pattern
8. New File
9. Usage Examples
10. Error Handling
11. Architecture Significance
12. Benefits
13. Next Steps

1. Goal

Design and implement a 3-level logger system for consistent logging output during pipeline execution

2. Commit List

3. Step-by-Step Detailed Analysis

3.1 Step 1: vars Call Method Test

3.2 Step 2: Logger Initial Implementation and CPS Issue Resolution

// Before: Using field variables (CPS issue occurred)
private static final String STAGE_MARKER = '===== STAGE'
void stageStart(String stageName) {
    echo "${STAGE_MARKER} Starting: [${stageName}] ${STAGE_MARKER}"
}

// After: Removed field variables (CPS compatible)
void stageStart(String stageName) {
    echo "===== STAGE Starting: [${stageName}] ====="
}

3.3 Step 3: Logger Completion and Integration

// Stage Level
void stageStart(String stageName)
void stageEnd(String stageName)

// Steps Group Level
void stepsGroupStart(String groupName)
void stepsGroupEnd(String groupName)

// Step Level
void stepStart(String description)
void stepSuccess(String description)
void stepFailed(String description)
void stepError(String description)

vars/ File Naming Convention (Final):
- Stage modules: stage{StageName}.groovy
- Helpers: {helperName}Helper.groovy → starts with lowercase
- Logger: logger.groovy

4. 3-Level Logging Pattern

4.1 Level 1: Stage (Highest)

===== STAGE Starting: [ StageName ] =====
===== STAGE Completed: [ StageName ] =====

4.2 Level 2: Steps Group (Middle)

--- STEPS Starting Group: [ GroupName ] ---
--- STEPS Completed Group: [ GroupName ] ---

4.3 Level 3: Step (Lowest)

➡️ Step Starting: [ description ]...
💬 Step Info: [ description ]
🏃 Step Processing: [ description ]
💡 Step Shell Executed Result: [ result ]
✅ Step Completed: [ description ]
⚠️ Step Warning: [ description ]
❌ Step Failed: [ description ]
🔥 Step Error: [ description ]

5. New File: sharedLibraries/vars/logger.groovy (63 lines)

// Stage Level
void stageStart(String stageName)
void stageEnd(String stageName)

// Steps Group Level
void stepsGroupStart(String groupName)
void stepsGroupEnd(String groupName)

// Step Level
void stepStart(String description)
void stepInfo(String description)
void stepProcessing(String description)
void stepShellExecutedResult(String description)
void stepSuccess(String description)
void stepWarning(String description)
void stepFailed(String description)
void stepError(String description, Throwable err)
void stepError(String description)  // Overload: without Throwable

6. Usage Examples

6.1 Usage Within Stage

def call() {
    logger.stageStart(env.STAGE_NAME)

    logger.stepsGroupStart('Git Repository Setup')

    logger.stepStart('Fetching origin branches')
    sh 'git fetch origin'
    logger.stepSuccess('Origin branches fetched')

    logger.stepsGroupEnd('Git Repository Setup')

    logger.stageEnd(env.STAGE_NAME)
}

6.2 Console Output Example

===== STAGE Starting: [ Initialization ] =====
--- STEPS Starting Group: [ Git Repository Setup ] ---
➡️ Step Starting: [ Fetching origin branches ]...
✅ Step Completed: [ Origin branches fetched ]
--- STEPS Completed Group: [ Git Repository Setup ] ---
===== STAGE Completed: [ Initialization ] =====

7. Error Handling

7.1 stepError with Throwable

void stepError(String description, Throwable err) {
    StringWriter sw = new StringWriter()
    PrintWriter pw = new PrintWriter(sw)
    err.printStackTrace(pw)
    String stackTrace = sw.toString()
    println "🔥🔥🔥 Full Stack Trace for Error \n[${description}]\n${stackTrace}"
    error("🔥 Step Error: \n[ ${description} ] - Error: ${err.getMessage()}")
}

7.2 Usage Example

try {
    // Dangerous operation
} catch (Exception e) {
    logger.stepError('Failed to execute critical operation', e)
}

8. Architecture Significance

8.1 Standard Interface Established

Using the same logging pattern across all Stages and Steps → Consistent CI/CD log output

8.2 Ease of Debugging

• Automatic Stack trace output
• Clear indication of start/completion for each step
• Status differentiation with emojis (✅ Success, ⚠️ Warning, ❌ Failed, 🔥 Error)

8.3 Jenkins Blue Ocean Compatible

Step-by-step logging makes progress tracking easier in Blue Ocean UI

9. Benefits

1. Consistency: Same log format across all pipelines
2. Readability: Visual distinction with emojis and separators
3. Debugging: Detailed stack trace on error occurrence
4. Maintainability: Only one place to modify when changing log format

10. Next Steps

→ Phase 3: Bitbucket API & Shell Library Integration

Reference

• logger-system-design-integration.md - Logger System design document (Problem analysis → Solution → Implementation)