Explain Error

AI-powered Jenkins plugin that explains pipeline and job failures with human-readable insights.

Tired of digging through long Jenkins logs to understand what went wrong?

Explain Error Plugin leverages AI to automatically interpret job and pipeline failures—saving you time and helping you fix issues faster.

Whether it’s a compilation error, test failure, or deployment hiccup, this plugin turns confusing logs into human-readable insights.

• 🔍 One-click error analysis on any console output
• ⚙️ Pipeline-ready with a simple explainError() step
• 💡 AI-powered explanations using OpenAI GPT models
• 🌐 Rich web UI for viewing AI-generated insights
• 🎯 Customizable: set model, API endpoint, log filters, and more

• Jenkins 2.479.3+
• Java 17+
• OpenAI API Key

1. Install via Jenkins Plugin Manager:

   • Go to Manage Jenkins → Manage Plugins → Available
   • Search for "Explain Error Plugin"
   • Click Install and restart Jenkins

2. Manual Installation:

   • Download the .hpi file from releases
   • Upload via Manage Jenkins → Manage Plugins → Advanced

1. Go to Manage Jenkins → Configure System
2. Find the "Explain Error Plugin Configuration" section
3. Configure the following settings:

4. Click "Test Configuration" to verify your setup
5. Save the configuration

This plugin supports Configuration as Code for automated setup. Use the explainError symbol in your YAML configuration:

unclassified:
  explainError:
    enableExplanation: true
    apiKey: "${AI_API_KEY}"
    apiUrl: "https://api.openai.com/v1/chat/completions"
    model: "gpt-3.5-turbo"

Environment Variable Example:

export AI_API_KEY="your-openai-api-key-here"

This allows you to manage the plugin configuration alongside your other Jenkins settings in version control.

Use explainError() in your pipeline (e.g., in a post block):

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    // Your build steps here
                    sh 'make build'
                }
            }
        }
    }
    post {
        failure {
            // Automatically explain errors when build fails
            explainError()
        }
    }
}

Optional parameters:

explainError(
  maxLines: 500,
  logPattern: '(?i)(error|failed|exception)'
)

Output appears in the sidebar of the failed job.

Works with Freestyle, Declarative, or any job type.

1. Go to the failed build’s console output
2. Click Explain Error button in the top
3. View results directly under the button

Enable debug logs:

Manage Jenkins → System Log → Add logger for io.jenkins.plugins.explain_error

1. Use explainError() in post { failure { ... } } blocks
2. Apply logPattern to focus on relevant errors
3. Monitor your OpenAI usage to control costs
4. Keep plugin updated regularly

• GitHub Issues for bug reports and feature requests
• Contributing Guide if you'd like to help
• Security concerns? Email security@jenkins.io

Licensed under the MIT License.

Built with ❤️ for the Jenkins community. If you find it useful, please ⭐ us on GitHub!