info@yenlo.com
eng
Menu
WSO2 6 min

WSO2 Migration Analyzer: The smart way to plan your WSO2 upgrade

Philip Akyempon
Philip Akyempon
Integration Specialist
WSO2 Migration Analyzer Yenlo

Migrating a WSO2 environment is rarely straightforward. It usually involves a series of decisions, trade-offs, and a fair amount of untangling what already exists. Whether you’re moving from WSO2 Enterprise Service Bus (ESB) or WSO2 Enterprise Integrator (EI) to Micro Integrator (MI), or deciding which MI version fits best long term, the conversation tends to start the same way:

“What do we actually have right now… and how much work is this going to be?”

Answering that manually means digging through configurations, APIs, proxies, and endpoints. It’s time-consuming and easy to get wrong. As a result, estimates are often either too optimistic or far off the mark.

This is exactly the problem the WSO2 Migration Analyzer is designed to solve. Built at Yenlo, it helps speed up and standardize the discovery phase of ESB/EI-to-MI migrations.


TL;DR

  • Automates discovery of WSO2 ESB/EI environments
  • Identifies compatibility issues across all artefacts
  • Generates a migration checklist with risk scoring
  • Detects CVEs and outdated components
  • Lets you compare multiple MI target versions instantly

The problem with manual discovery

Before you can properly scope a migration, you need a clear understanding of the current WSO2 environment.

That typically involves:

  • Identifying the ESB/EI version and applied patches
  • Mapping all artefacts across the 14 supported types (APIs, proxies, sequences, endpoints, etc.)
  • Assessing complexity, simple flows versus heavily customised logic
  • Spotting patterns that won’t survive in a newer runtime

In theory, this sounds manageable. In practice, most WSO2 environments have evolved over years. Quick fixes, undocumented changes, and direct deployments to servers are common. Pipelines get bypassed, and over time, no one has a complete picture anymore.

This is why discovery often takes longer than expected and still ends up incomplete.

The Migration Analyzer addresses this by automating the bulk of that work.

What the Analyzer does

The analyzer scans a WSO2 ESB 5.x or WSO2 EI 6.x environment and produces a structured JSON report. This report can be opened locally in a standalone HTML dashboard. Without a server or cloud required.

The output is organized into ten key sections:

• Overview
A high-level summary including risk score, compatibility breakdown, best-practice issues, and known CVEs
• Migration Checklist
A prioritized list of actions that can be used directly in a Statement of Work
• Artefact Inventory
A complete list of artefacts, each labelled as compatible, deprecated, changed, or breaking
• Best Practices
Flags over 20 common issues, such as missing fault sequences or hardcoded credentials
• Log Analysis
Highlights what is actively used, what is failing, and what may be unused or redundant
• CVE Security Risks
Maps your ESB/EI version and patches to known vulnerabilities, including severity and remediation guidance

Additional sections cover Carbon Applications, custom components, registry usage, and patch status. Giving a complete picture of the environment.

Comparing migration targets

One of the most useful features is the ability to evaluate multiple MI versions from a single scan.
By running the analyzer with the –all-versions flag,
--all-versions flag, the dashboard allows you to switch between target versions (from MI 4.0 up to 4.5). Compatibility results update instantly.
This makes it much easier to answer an important early question:

“How much does the effort change between MI 4.3 and 4.5?”

Instead of relying on assumptions, you get a clear, data-driven comparison.

Running the Analyzer

Getting started is straightforward. Pre-built binaries are available for Windows and Linux, with no need for Python, Docker, or root access. (The Linux version supports RHEL 7, 8, and 9.)

On Linux:

1. Extract the package:
tar xzf wso2-migration-analyzer-v1.1.0-linux.tar.gz

2. Make it executable:
chmod +x wso2-migration-analyzer-v1.1.0-linux/analyze.sh

3. Run the Analyzer:
./wso2-migration-analyzer-v1.1.0-linux/analyze.sh \
--ei-home /opt/wso2ei-6.6.0 \
--all-versions \
--output report.json

Everything is included: the runtime, launcher script, and HTML dashboard. Demo reports are also available if you want to explore the output first.
If Python 3.8+ is already installed, you can run the analyzer directly without the bundled binary. Docker is available as a fallback option.
Importantly, the tool is read-only. It does not modify your ESB or EI environment in any way.

Handling Sensitive Environments

WSO2 environments often contain sensitive information such as hostnames, endpoints, IP addresses, and credentials.
To address this, the analyzer includes anonymization options:

  • --anonymise replaces sensitive values with consistent aliases
  • --anon-full also masks artefact names

You can generate a separate mapping file and keep it securely on your server, allowing you to share reports without exposing internal details.

Transparent compatibility rules

All compatibility logic is defined in a single rules.yaml file. This file acts as a clear source of truth for what has been removed, deprecated, or changed across MI versions.
Adding support for a new MI release is straightforward. Just add a new configuration block. No code changes are required. Because the rules are transparent and human-readable, they can be reviewed and validated easily.

Conclusion

The WSO2 Migration Analyzer doesn’t replace the expertise of an integration consultant. What it does is provide a reliable starting point.

It gives you:

  • A complete artefact inventory
  • Clear, version-specific compatibility insights
  • Best-practice findings based on the actual runtime environment

With that foundation, migration estimates are based on real data rather than assumptions. And that’s critical, because the success of a migration is often determined in the early stages.

If you’re planning a WSO2 ESB or WSO2 EI to MI migration and want to see what this analysis looks like for your environment, get in touch with Yenlo.

WSO2 Migration Analyzer

Ready to assess your migration?

Get the WSO2 Migration Analyzer package and receive the download links directly by email.

Download Analyzer Package

FAQ

What is the WSO2 Migration Analyzer?

The WSO2 Migration Analyzer is a tool developed by Philip Akyempon, consultant at Yenlo, that scans a WSO2 Enterprise Service Bus (ESB) or WSO2 Enterprise Integrator (EI) environment and generates a structured report to assess migration readiness for Micro Integrator (MI). It helps identify compatibility issues, risks, and required changes before starting a migration.

How does the WSO2 Migration Analyzer work?

It scans a WSO2 ESB 5.x or WSO2 EI 6.x environment and produces a JSON report, which can be viewed in a standalone HTML dashboard. The tool analyses artefacts, configurations, logs, and patches to provide compatibility verdicts, best-practice insights, and migration recommendations.

Can the analyzer compare different WSO2 MI versions?

Yes. When run with the –all-versions flag, the analyzer evaluates multiple MI target versions (e.g., MI 4.0 to 4.5) in a single scan. The dashboard lets you switch between versions instantly to compare migration effort and compatibility differences.

Is the WSO2 Migration Analyzer safe for production environments?

Yes. The analyzer runs in read-only mode and does not modify the WSO2 environment. It only reads configuration and deployment data, ensuring there is no impact on running systems.

How does the analyzer handle sensitive data?

The tool includes anonymization features. The –anonymise flag masks sensitive data like hostnames, IPs, and credentials, while –anon-full also anonymises artefact names. A separate mapping file can be generated and kept securely for internal reference.

What kind of output does the analyzer provide?

The analyzer generates a detailed report with sections such as migration risk score, artefact inventory, compatibility status, best-practice findings, log usage insights, and CVE security risks. It also includes a migration checklist for planning and estimation.

Do I need Python or Docker to run the analyzer?

No. Pre-built binaries are available for Windows and Linux, so no additional dependencies are required. However, if Python 3.8+ is available, the tool can run without the bundled binary. Docker is also supported as an optional fallback.

Why is automated discovery important for WSO2 migrations?

Manual discovery is time-consuming and often incomplete due to undocumented changes and complex configurations. Automated discovery ensures a complete, consistent, and data-driven understanding of the environment, leading to more accurate migration planning.

Whitepaper: API Security

API Security
Download Whitepaper
eng
Close