Class: HermesAgent::Client::Resources::Health

Inherits:

Object

• Object
• HermesAgent::Client::Resources::Health

Defined in:

lib/hermes_agent/client/resources/health.rb

Overview

The health resource. Health endpoints live at the server root, not under the /v1 prefix.

Instance Method Summary

• #check ⇒ Entities::Health

  Check whether the server is healthy.

• #detailed ⇒ Entities::HealthDetails

  Fetch detailed server health, including gateway state, per-platform connection status, and the active-agent count.

Instance Method Details

#check ⇒ Entities::Health

Check whether the server is healthy.

Returns:

• (Entities::Health) —

  The health result; Entities::Health#status is "ok" on a healthy server.

# File 'lib/hermes_agent/client/resources/health.rb', line 33

def check
  Entities::Health.new(@transport.get("/health"))
end

#detailed ⇒ Entities::HealthDetails

Fetch detailed server health, including gateway state, per-platform connection status, and the active-agent count.

Returns:

• (Entities::HealthDetails) —

  The detailed health result.

# File 'lib/hermes_agent/client/resources/health.rb', line 43

def detailed
  Entities::HealthDetails.new(@transport.get("/health/detailed"))
end