Package org.atmosphere.metrics

Class AtmosphereHealth

java.lang.Object

org.atmosphere.metrics.AtmosphereHealth

public class AtmosphereHealth
extends Object

Framework-level health check for Atmosphere.

Provides a snapshot of the framework's health status including active connections, broadcasters, and framework lifecycle state. Can be used by any health check system (Spring Actuator, MicroProfile Health, etc.).

Usage

 AtmosphereHealth health = new AtmosphereHealth(framework);
 Map<String, Object> status = health.check();
 // { "status": "UP", "version": "4.0.0-SNAPSHOT", "connections": 42, ... }
 

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
AtmosphereHealth(AtmosphereFramework framework)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	check()	Perform a health check and return status details.
boolean	isHealthy()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AtmosphereHealth

public AtmosphereHealth(AtmosphereFramework framework)

Method Details

check

public Map<String,Object> check()

Perform a health check and return status details.

Returns:

a map of health details

isHealthy

public boolean isHealthy()

Returns:

true if the framework is running and healthy