Skip to content

Conversation

@Iduranga-Uwanpriya
Copy link

Purpose

Update the TCPMon docs to explain how to use TCPMon with WSO2 Micro Integrator (MI) for message monitoring. The existing page only covered standalone TCPMon usage via a browser and didn't show MI integration (routing inbound/outbound traffic through TCPMon).

Resolves #1622


Goals

  • ✅ Show how to monitor inbound traffic (Client → TCPMon 8081 → MI 8290)
  • ✅ Show how to monitor outbound traffic (MI → TCPMon 8082 → Backend 9000)
  • ✅ Provide a copy-pasteable Proxy Service XML example
  • ✅ Include an end-to-end flow visualization plus practical use cases (auth headers, SOAP transform, load balancing)
  • ✅ Add troubleshooting tips and references

Approach

Modified Files

  • docs/observe-and-manage/classic-observability-tcp/message-monitoring-with-tcpmon.md
    • New section: Using TCPMon with WSO2 Micro Integrator
    • Step-by-step inbound/outbound setup with port mappings
    • Proxy XML example with correct xmlns, transports, and ports
    • End-to-end flow (table/diagrams)
    • Practical use cases with screenshots
    • Troubleshooting + references

Assets Added

  • docs/assets/img/integrate/tcp/
    • ALL.png - End-to-end monitoring diagram
    • Auth_Debug.png - Authentication header debugging
    • Client_MI.png - Client to MI flow
    • Client_MI2.png - Inbound monitoring diagram
    • Load_Balance.png - Load balancing scenario
    • MI_Backend.png - MI to Backend flow
    • SOAP_Transform.png - SOAP transformation use case

Configuration

  • mkdocs.yml: Updated only for asset references; no nav restructuring

User Stories

👤 As an integration developer, I can observe and debug Client ↔ MI traffic.

👤 As an API/ESB engineer, I can capture MI ↔ Backend calls to validate mediation, headers, and payloads.

👤 As a troubleshooter, I can monitor both directions using two TCPMon listeners.


Release Note

Add a TCPMon + Micro Integrator integration guide, including inbound/outbound routing examples, a Proxy XML sample, end-to-end diagrams, and practical debugging scenarios.


Documentation

  • Updated page: observe-and-manage/classic-observability-tcp/message-monitoring-with-tcpmon/
  • ✅ No other doc impact

Training

N/A

Certification

N/A

Marketing

N/A


Automation Tests

  • Unit: N/A (docs)
  • Integration: N/A (docs)

Security Checks

  • ✅ Followed WSO2 secure coding guidelines: Yes (docs only)
  • ✅ FindSecurityBugs: N/A (docs)
  • ✅ No secrets/keys committed: Yes

Samples

✅ Included Proxy Service XML demonstrating outbound routing via TCPMon (8082)


Related PRs

N/A

Migrations

N/A


Test Environment

Component | Version/Details
-- | --
OS | Windows 11 x64
Python | 3.12 (MkDocs local preview)
Browser | Chrome 141
MI | 4.4.0, HTTP 8290
TCPMon | Apache Axis (listeners: 8081, 8082)

Learning

  • 📚 Verified Mermaid renders and exported PNGs for consistent MkDocs display
  • 📚 Ensured filename case matches repository (Windows vs case-sensitive hosts)
  • 📚 Aligned with existing MI docs style for images, headings, and admonitions

git_tag: v1.2.0.1
site_version: 4.5.0
#base_path: http://localhost:8000/en/latest
base_path: http://localhost:8000/en/latest
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we revert this line back?

<target>
<inSequence>
<log level="full"/>
<send>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use the Call mediator here

### References

- [Apache TCPMon Documentation](https://ws.apache.org/tcpmon/)
- [WSO2 MI Docs – Message Monitoring with TCPMon](https://mi.docs.wso2.com/en/latest/observe-and-manage/classic-observability-tcp/message-monitoring-with-tcpmon/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this since it points to the same page here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Incomplete: Using TCPMon with WSO2 MI Not Covered

3 participants