@serve.zone/interfaces 7.22.0 → 7.23.0

package/changelog.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 2026-06-12 - 7.23.0
+
+### Features
+
+- add live node resource usage request contracts (node)
+  - getNodeResourceUsage lets the admin UI fetch live per-deployment CPU/memory for one node via Cloudly; coreflowGetNodeResourceUsage is the relayed coreflow request.
+  - INodeDeploymentResourceUsage is keyed by the swarm task id (= IDeployment.id) and reports CPU as percent of the whole node (0-100).
+
+## 2026-06-12 - 7.22.1
+
+### Fixes
+
+- document the unit of deployment CPU usage (deployment)
+  - resourceUsage.cpuUsagePercent is percent of the whole node's CPU capacity (0-100), not the per-core docker stats convention; pins the scale that node-level metrics already use so producers and views stay consistent.
+
 ## 2026-06-11 - 7.22.0
 
 ### Features

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@serve.zone/interfaces',
-    version: '7.22.0',
+    version: '7.23.0',
     description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLHVGQUF1RjtDQUNyRyxDQUFBIn0=

package/dist_ts/data/deployment.d.ts

@@ -58,6 +58,12 @@ export interface IDeployment {
      * Resource usage for this deployment
      */
     resourceUsage?: {
+        /**
+         * Percent of the whole node's CPU capacity (0-100), NOT per-core:
+         * a deployment saturating one core of an 8-core node reports 12.5.
+         * Matches the scale of node-level metrics (IClusterNodeMetrics,
+         * INodeMetricsSample), not the docker stats CLI convention.
+         */
         cpuUsagePercent: number;
         memoryUsedMB: number;
         lastUpdated: number;

package/dist_ts/requests/node.d.ts

@@ -144,6 +144,43 @@ export interface IReq_Any_Cloudly_GetNodeTrafficStats extends plugins.typedreque
         timestamp: number;
     };
 }
+/**
+ * Live resource usage of one deployment on a node. deploymentId is the swarm
+ * task id, which is also IDeployment.id — the join key for UI rows.
+ * cpuUsagePercent is percent of the whole node's CPU capacity (0-100).
+ */
+export interface INodeDeploymentResourceUsage {
+    deploymentId: string;
+    cpuUsagePercent: number;
+    memoryUsedMB: number;
+}
+/**
+ * Admin UI asks Cloudly for a node's live per-deployment resource usage;
+ * Cloudly relays to the node's coreflow which samples docker stats.
+ * Polled only while a node detail view is open; not persisted.
+ */
+export interface IReq_Any_Cloudly_GetNodeResourceUsage extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_GetNodeResourceUsage> {
+    method: 'getNodeResourceUsage';
+    request: {
+        identity: IIdentity;
+        nodeId: string;
+    };
+    response: {
+        deployments: INodeDeploymentResourceUsage[];
+        timestamp: number;
+    };
+}
+/**
+ * Cloudly asks a node's coreflow for live per-deployment resource usage.
+ */
+export interface IReq_Cloudly_Coreflow_GetNodeResourceUsage extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Coreflow_GetNodeResourceUsage> {
+    method: 'coreflowGetNodeResourceUsage';
+    request: {};
+    response: {
+        deployments: INodeDeploymentResourceUsage[];
+        timestamp: number;
+    };
+}
 /**
  * Cloudly -> admin UIs: live node metrics relay (1s cadence, not persisted).
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/interfaces",
-  "version": "7.22.0",
+  "version": "7.23.0",
   "private": false,
   "description": "Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.",
   "exports": {

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@serve.zone/interfaces',
-  version: '7.22.0',
+  version: '7.23.0',
   description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
 }

package/ts/data/deployment.ts

@@ -77,6 +77,12 @@ export interface IDeployment {
    * Resource usage for this deployment
    */
   resourceUsage?: {
+    /**
+     * Percent of the whole node's CPU capacity (0-100), NOT per-core:
+     * a deployment saturating one core of an 8-core node reports 12.5.
+     * Matches the scale of node-level metrics (IClusterNodeMetrics,
+     * INodeMetricsSample), not the docker stats CLI convention.
+     */
     cpuUsagePercent: number;
     memoryUsedMB: number;
     lastUpdated: number;

package/ts/requests/node.ts

@@ -184,6 +184,52 @@ export interface IReq_Any_Cloudly_GetNodeTrafficStats extends plugins.typedreque
   };
 }
 
+/**
+ * Live resource usage of one deployment on a node. deploymentId is the swarm
+ * task id, which is also IDeployment.id — the join key for UI rows.
+ * cpuUsagePercent is percent of the whole node's CPU capacity (0-100).
+ */
+export interface INodeDeploymentResourceUsage {
+  deploymentId: string;
+  cpuUsagePercent: number;
+  memoryUsedMB: number;
+}
+
+/**
+ * Admin UI asks Cloudly for a node's live per-deployment resource usage;
+ * Cloudly relays to the node's coreflow which samples docker stats.
+ * Polled only while a node detail view is open; not persisted.
+ */
+export interface IReq_Any_Cloudly_GetNodeResourceUsage extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetNodeResourceUsage
+> {
+  method: 'getNodeResourceUsage';
+  request: {
+    identity: IIdentity;
+    nodeId: string;
+  };
+  response: {
+    deployments: INodeDeploymentResourceUsage[];
+    timestamp: number;
+  };
+}
+
+/**
+ * Cloudly asks a node's coreflow for live per-deployment resource usage.
+ */
+export interface IReq_Cloudly_Coreflow_GetNodeResourceUsage extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_GetNodeResourceUsage
+> {
+  method: 'coreflowGetNodeResourceUsage';
+  request: {};
+  response: {
+    deployments: INodeDeploymentResourceUsage[];
+    timestamp: number;
+  };
+}
+
 /**
  * Cloudly -> admin UIs: live node metrics relay (1s cadence, not persisted).
  */