Merge pull request #172 from valory-xyz/feat/agent_performance_endpoint

Agent performance endpoint

Author: jmoreira-valory

docs/api.md

@@ -789,6 +789,50 @@ Get service deployment information.
 }
 ```
 
+### `GET /api/v2/service/{service_config_id}/agent_performance`
+
+Get agent performance information.
+
+**Response (Success - 200):**
+
+```json
+{
+  "last_activity": {
+    "title": "Last activity title",
+    "description": "Last activity description",
+  },
+  "last_chat_message": "Agent last chat message",
+  "metrics": [
+    {
+      "description": "Metric description",
+      "is_primary": true,
+      "name": "Metric name",
+      "value": "Metric value"
+    }
+  ],
+  "timestamp": 1234567890
+}
+```
+
+**Response (Success with empty agent performance - 200):**
+
+```json
+{
+  "last_activity": null,
+  "last_chat_message": null,
+  "metrics": [],
+  "timestamp": null
+}
+```
+
+**Response (Service not found - 404):**
+
+```json
+{
+  "error": "Service service_123 not found"
+}
+```
+
 ### `GET /api/v2/service/{service_config_id}/refill_requirements`
 
 Get service refill requirements.
@@ -948,7 +992,7 @@ Create a new service.
 }
 ```
 
-### `PUT /api/v2/service/{service_config_id}` / `PATCH /api/v2/service/{service_config_id}`
+### `PUT /api/v2/service/{service_config_id}` <br /> `PATCH /api/v2/service/{service_config_id}`
 
 Update a service configuration. Use `PUT` for full updates and `PATCH` for partial updates.
 

operate/cli.py

@@ -877,6 +877,21 @@ async def _get_service_deployment(request: Request) -> JSONResponse:
         deployment_json["healthcheck"] = service.get_latest_healthcheck()
         return JSONResponse(content=deployment_json)
 
+    @app.get("/api/v2/service/{service_config_id}/agent_performance")
+    @with_retries
+    async def _get_agent_performance(request: Request) -> JSONResponse:
+        """Get the service refill requirements."""
+        service_config_id = request.path_params["service_config_id"]
+
+        if not operate.service_manager().exists(service_config_id=service_config_id):
+            return service_not_found_error(service_config_id=service_config_id)
+
+        return JSONResponse(
+            content=operate.service_manager()
+            .load(service_config_id=service_config_id)
+            .get_agent_performance()
+        )
+
     @app.get("/api/v2/service/{service_config_id}/refill_requirements")
     @with_retries
     async def _get_refill_requirements(request: Request) -> JSONResponse:

operate/constants.py

@@ -29,6 +29,12 @@
 DEPLOYMENT_DIR = "deployment"
 DEPLOYMENT_JSON = "deployment.json"
 CONFIG_JSON = "config.json"
+
+AGENT_PERSISTENT_STORAGE_DIR = "persistent_data"
+AGENT_PERSISTENT_STORAGE_ENV_VAR = "STORE_PATH"
+AGENT_LOG_DIR = "benchmarks"
+AGENT_LOG_ENV_VAR = "LOG_DIR"
+
 ZERO_ADDRESS = "0x0000000000000000000000000000000000000000"
 
 ON_CHAIN_INTERACT_TIMEOUT = 120.0

operate/services/manage.py

@@ -40,7 +40,14 @@
 from autonomy.chain.metadata import IPFS_URI_PREFIX
 from web3 import Web3
 
-from operate.constants import IPFS_ADDRESS, ZERO_ADDRESS
+from operate.constants import (
+    AGENT_LOG_DIR,
+    AGENT_LOG_ENV_VAR,
+    AGENT_PERSISTENT_STORAGE_DIR,
+    AGENT_PERSISTENT_STORAGE_ENV_VAR,
+    IPFS_ADDRESS,
+    ZERO_ADDRESS,
+)
 from operate.data import DATA_DIR
 from operate.data.contracts.mech_activity.contract import MechActivityContract
 from operate.data.contracts.requester_activity_checker.contract import (
@@ -730,8 +737,8 @@ def _deploy_service_onchain_from_safe(  # pylint: disable=too-many-statements,to
 
         # Set environment variables for the service
         for dir_name, env_var_name in (
-            ("persistent_data", "STORE_PATH"),
-            ("benchmarks", "LOG_DIR"),
+            (AGENT_PERSISTENT_STORAGE_DIR, AGENT_PERSISTENT_STORAGE_ENV_VAR),
+            (AGENT_LOG_DIR, AGENT_LOG_ENV_VAR),
         ):
             dir_path = service.path / dir_name
             dir_path.mkdir(parents=True, exist_ok=True)

operate/services/service.py

@@ -63,7 +63,12 @@
 from autonomy.deploy.generators.kubernetes.base import KubernetesGenerator
 from docker import from_env
 
-from operate.constants import CONFIG_JSON, DEPLOYMENT_DIR, DEPLOYMENT_JSON
+from operate.constants import (
+    AGENT_PERSISTENT_STORAGE_ENV_VAR,
+    CONFIG_JSON,
+    DEPLOYMENT_DIR,
+    DEPLOYMENT_JSON,
+)
 from operate.keys import KeysManager
 from operate.operate_http.exceptions import NotAllowed
 from operate.operate_types import (
@@ -927,6 +932,40 @@ def remove_latest_healthcheck(self) -> None:
             except Exception as e:  # pylint: disable=broad-except
                 print(f"Exception deleting {healthcheck_json_path}: {e}")
 
+    def get_agent_performance(self) -> t.Dict:
+        """Return the agent activity"""
+
+        # Default values
+        agent_performance: t.Dict[str, t.Any] = {
+            "timestamp": None,
+            "metrics": [],
+            "last_activity": None,
+            "last_chat_message": None,
+        }
+
+        agent_performance_json_path = (
+            Path(
+                self.env_variables.get(
+                    AGENT_PERSISTENT_STORAGE_ENV_VAR, {"value": "."}
+                ).get("value", ".")
+            )
+            / "agent_performance.json"
+        )
+
+        if agent_performance_json_path.exists():
+            try:
+                with open(agent_performance_json_path, "r", encoding="utf-8") as f:
+                    data = json.load(f)
+                if isinstance(data, dict):
+                    agent_performance.update(data)
+            except (json.JSONDecodeError, OSError) as e:
+                # Keep default values if file is invalid
+                print(
+                    f"Error reading file 'agent_performance.json': {e}"
+                )  # TODO Use logger
+
+        return dict(sorted(agent_performance.items()))
+
     def update(
         self,
         service_template: ServiceTemplate,