Skip to content

feat: Add microcks health command for server connectivity diagnostics #469

Description

@kunal-yelgate

Current Behavior

No dedicated command to check Microcks server health. Users infer status from cryptic errors during import/test commands. Reduce debugging time and enable proactive health monitoring in production environments.

Why we need this?

  • No quick way to verify server health before imports/tests
  • Debugging connection issues wastes developer time
  • No CI/CD pre-flight health check support

How will this help?

  • microcks health gives instant server diagnostics
  • --watch enables continuous monitoring during deployments
  • --json supports CI/CD pipeline integration
  • Exit codes (0/1/2) enable automation

This error could mean:

  • Microcks server is not running
  • Wrong port or hostname
  • Network firewall blocking connection
  • Server is starting up but not ready yet
  • TLS certificate issue

Debugging requires manually using curl or checking Docker logs.

Desired Behavior

Add microcks health command for quick server diagnostics:

$ microcks health
Microcks Server Health Check
============================
Server URL: http://localhost:8585/api

✓ Reachable (HTTP 200, 45ms)
✓ API endpoint responding
✓ Keycloak: enabled and reachable
✓ Async Minion: connected
✓ Database: connected
✓ Version: 1.14.0 (stable)

Overall Status: HEALTHY ✅

Metadata

Metadata

Assignees

No one assigned

    Labels

    staleState due to inactivity

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions