Added a Heartbeat endpoint to the server

[Swiftyos]

PR: Addition of Agent Heartbeat Endpoint

Overview

This PR addresses the proposal outlined in RFC AP-RFC-002 for the addition of a heartbeat endpoint to the agent protocol. The primary purpose is to offer a straightforward mechanism for monitoring the health of agents.

Changes Proposed:

1. Addition of Heartbeat Endpoint:

   • New endpoint URL: /heartbeat
   • Method: GET
   • Response:
     • Status: 200 OK

2. Error Handling Mechanisms:

   • If the endpoint does not return a 200 OK status or there's a timeout, it will be an indication of potential issues with the agent.

Motivation:

With the increasing deployment of agents in varied environments, the necessity to actively monitor their health and uptime has become paramount. This endpoint provides a simple yet effective mechanism for such monitoring, assisting in reducing agent downtimes.

Benefits to Agent Builders:

• Facilitates improved monitoring capabilities.
• Aids in proactively detecting and resolving issues, thereby reducing agent downtime.

Alternatives Considered:

• Using a Websocket Keep-alive: Though it might offer real-time monitoring, the resource consumption could be higher, making it less suitable for just health checks.

Compatibility:

• The changes proposed are backward compatible. Agents already in deployment can function without any alterations.
• There might be a need for updates in monitoring tools or the Client SDK to take full advantage of the new heartbeat endpoint.

Discussion Points:

• Is there a need to include more metadata in the heartbeat response? If so, what should the metadata entail?
  • It's essential to weigh in on the fact that introducing processing in the heartbeat endpoint could make it less reliable. Hence, for more extensive health details, perhaps a separate health endpoint would be more appropriate.

Action Required:

Please review the changes proposed and provide feedback. If there are no concerns, I would appreciate approvals so we can merge and implement the heartbeat endpoint for better health monitoring of our agents.

[jakubno]

Just resolve the conflicts and let's ship it 🚀

[Swiftyos]

RFC added and merge conflicts resolved.