modal 0.11.1-dev.6 → 0.11.1-dev.7

package/dist/index.cjs

@@ -18121,7 +18121,7 @@ var EndpointCreateRequest = {
   }
 };
 function createBaseEndpointCreateResponse() {
-  return { endpointId: "", endpointPageUrl: "", name: "" };
+  return { endpointId: "", endpointPageUrl: "", name: "", modelName: "" };
 }
 var EndpointCreateResponse = {
   encode(message, writer = new BinaryWriter()) {
@@ -18134,6 +18134,9 @@ var EndpointCreateResponse = {
     if (message.name !== "") {
       writer.uint32(26).string(message.name);
     }
+    if (message.modelName !== "") {
+      writer.uint32(34).string(message.modelName);
+    }
     return writer;
   },
   decode(input, length) {
@@ -18164,6 +18167,13 @@ var EndpointCreateResponse = {
           message.name = reader.string();
           continue;
         }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+          message.modelName = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -18176,7 +18186,8 @@ var EndpointCreateResponse = {
     return {
       endpointId: isSet5(object.endpointId) ? globalThis.String(object.endpointId) : "",
       endpointPageUrl: isSet5(object.endpointPageUrl) ? globalThis.String(object.endpointPageUrl) : "",
-      name: isSet5(object.name) ? globalThis.String(object.name) : ""
+      name: isSet5(object.name) ? globalThis.String(object.name) : "",
+      modelName: isSet5(object.modelName) ? globalThis.String(object.modelName) : ""
     };
   },
   toJSON(message) {
@@ -18190,6 +18201,9 @@ var EndpointCreateResponse = {
     if (message.name !== "") {
       obj.name = message.name;
     }
+    if (message.modelName !== "") {
+      obj.modelName = message.modelName;
+    }
     return obj;
   },
   create(base) {
@@ -18200,6 +18214,7 @@ var EndpointCreateResponse = {
     message.endpointId = object.endpointId ?? "";
     message.endpointPageUrl = object.endpointPageUrl ?? "";
     message.name = object.name ?? "";
+    message.modelName = object.modelName ?? "";
     return message;
   }
 };
@@ -18552,7 +18567,8 @@ function createBaseEndpointGetInfoResponse_EndpointInfoSummary() {
     status: 0,
     lifecycle: void 0,
     volumeId: "",
-    modelPath: ""
+    modelPath: "",
+    modelName: ""
   };
 }
 var EndpointGetInfoResponse_EndpointInfoSummary = {
@@ -18587,6 +18603,9 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
     if (message.modelPath !== "") {
       writer.uint32(98).string(message.modelPath);
     }
+    if (message.modelName !== "") {
+      writer.uint32(106).string(message.modelName);
+    }
     return writer;
   },
   decode(input, length) {
@@ -18666,6 +18685,13 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
           message.modelPath = reader.string();
           continue;
         }
+        case 13: {
+          if (tag !== 106) {
+            break;
+          }
+          message.modelName = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -18685,7 +18711,8 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
       status: isSet5(object.status) ? endpointGetInfoResponse_EndpointStatusFromJSON(object.status) : 0,
       lifecycle: isSet5(object.lifecycle) ? EndpointLifecycle.fromJSON(object.lifecycle) : void 0,
       volumeId: isSet5(object.volumeId) ? globalThis.String(object.volumeId) : "",
-      modelPath: isSet5(object.modelPath) ? globalThis.String(object.modelPath) : ""
+      modelPath: isSet5(object.modelPath) ? globalThis.String(object.modelPath) : "",
+      modelName: isSet5(object.modelName) ? globalThis.String(object.modelName) : ""
     };
   },
   toJSON(message) {
@@ -18720,6 +18747,9 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
     if (message.modelPath !== "") {
       obj.modelPath = message.modelPath;
     }
+    if (message.modelName !== "") {
+      obj.modelName = message.modelName;
+    }
     return obj;
   },
   create(base) {
@@ -18737,6 +18767,7 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
     message.lifecycle = object.lifecycle !== void 0 && object.lifecycle !== null ? EndpointLifecycle.fromPartial(object.lifecycle) : void 0;
     message.volumeId = object.volumeId ?? "";
     message.modelPath = object.modelPath ?? "";
+    message.modelName = object.modelName ?? "";
     return message;
   }
 };
@@ -45016,7 +45047,7 @@ var SandboxGetExitSnapshotResponse_Error = {
   }
 };
 function createBaseSandboxGetFromNameRequest() {
-  return { sandboxName: "", environmentName: "", appName: "" };
+  return { sandboxName: "", environmentName: "", appName: "", includeTerminated: false };
 }
 var SandboxGetFromNameRequest = {
   encode(message, writer = new BinaryWriter()) {
@@ -45029,6 +45060,9 @@ var SandboxGetFromNameRequest = {
     if (message.appName !== "") {
       writer.uint32(26).string(message.appName);
     }
+    if (message.includeTerminated !== false) {
+      writer.uint32(32).bool(message.includeTerminated);
+    }
     return writer;
   },
   decode(input, length) {
@@ -45059,6 +45093,13 @@ var SandboxGetFromNameRequest = {
           message.appName = reader.string();
           continue;
         }
+        case 4: {
+          if (tag !== 32) {
+            break;
+          }
+          message.includeTerminated = reader.bool();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -45071,7 +45112,8 @@ var SandboxGetFromNameRequest = {
     return {
       sandboxName: isSet5(object.sandboxName) ? globalThis.String(object.sandboxName) : "",
       environmentName: isSet5(object.environmentName) ? globalThis.String(object.environmentName) : "",
-      appName: isSet5(object.appName) ? globalThis.String(object.appName) : ""
+      appName: isSet5(object.appName) ? globalThis.String(object.appName) : "",
+      includeTerminated: isSet5(object.includeTerminated) ? globalThis.Boolean(object.includeTerminated) : false
     };
   },
   toJSON(message) {
@@ -45085,6 +45127,9 @@ var SandboxGetFromNameRequest = {
     if (message.appName !== "") {
       obj.appName = message.appName;
     }
+    if (message.includeTerminated !== false) {
+      obj.includeTerminated = message.includeTerminated;
+    }
     return obj;
   },
   create(base) {
@@ -45095,6 +45140,7 @@ var SandboxGetFromNameRequest = {
     message.sandboxName = object.sandboxName ?? "";
     message.environmentName = object.environmentName ?? "";
     message.appName = object.appName ?? "";
+    message.includeTerminated = object.includeTerminated ?? false;
     return message;
   }
 };
@@ -74579,7 +74625,7 @@ var AuthTokenManager = class {
 };
 
 // src/version.ts
-var SDK_VERSION = "0.11.1-dev.6";
+var SDK_VERSION = "0.11.1-dev.7";
 function getSDKVersion() {
   return SDK_VERSION;
 }
@@ -76457,6 +76503,20 @@ var FunctionService = class {
     }
   }
 };
+function statsDistributions(stats) {
+  return Object.fromEntries(
+    Object.entries(stats).map(([key, distribution]) => [
+      key,
+      {
+        unit: distribution.unit,
+        percentiles: distribution.percentiles.map((p) => ({
+          percentile: p.percentileBasisPoints / 100,
+          value: p.value
+        }))
+      }
+    ])
+  );
+}
 function mergeServiceOptions(base, diff) {
   const filteredDiff = Object.fromEntries(
     Object.entries(diff).filter(([, value]) => value !== void 0)
@@ -76824,6 +76884,65 @@ var Function_ = class _Function_ {
       this.functionId
     );
   }
+  /**
+   * Return historical statistics. Defaults to the last hour; the maximum range is 7 days.
+   *
+   * @example Read statistics for the last hour.
+   * ```ts
+   * const fn = await modal.functions.fromName("libmodal-test-support", "echo_string");
+   * const stats = await fn.stats();
+   * console.log(stats.inputSuccessCount, stats.inputFailureCount);
+   * ```
+   *
+   * @example Include all variants over the last 24 hours.
+   * ```ts
+   * const until = new Date();
+   * const since = new Date(until.getTime() - 24 * 60 * 60 * 1000);
+   * const variantStats = await fn.stats({ since, until, allVariants: true });
+   * for (const [metric, distribution] of Object.entries(variantStats.inputPercentileStats)) {
+   *   console.log(metric, distribution.unit, distribution.percentiles);
+   * }
+   * ```
+   *
+   * Set `container` to a container ID to restrict statistics to that container.
+   */
+  async stats(params = {}) {
+    const until = params.until ?? /* @__PURE__ */ new Date();
+    const since = params.since ?? new Date(until.getTime() - 60 * 60 * 1e3);
+    if (!Number.isFinite(since.getTime()) || !Number.isFinite(until.getTime())) {
+      throw new InvalidError("`since` and `until` must be valid dates.");
+    }
+    if (since >= until) {
+      throw new InvalidError("`since` must be before `until`.");
+    }
+    const allVariants = params.allVariants ?? false;
+    const resp = await this.#client.cpClient.functionGetTimeRangeStats(
+      FunctionGetTimeRangeStatsRequest.create({
+        functionId: this.functionId,
+        since,
+        until,
+        containerId: params.container || void 0,
+        rollup: allVariants
+      })
+    );
+    return {
+      since: resp.since ?? /* @__PURE__ */ new Date(0),
+      until: resp.until ?? /* @__PURE__ */ new Date(0),
+      inputSuccessCount: resp.inputSuccessCount,
+      inputFailureCount: resp.inputFailureCount,
+      inputTimeoutCount: resp.inputTimeoutCount,
+      inputRunningAtEndCount: resp.inputRunningAtEndCount,
+      containerStartedCount: resp.containerStartedCount,
+      containerErrorCount: resp.containerErrorCount,
+      containerCreatingAtEndCount: resp.containerCreatingAtEndCount,
+      variantCount: resp.variantCount,
+      inputPercentileStats: statsDistributions(resp.inputPercentileStats),
+      containerPercentileStats: statsDistributions(
+        resp.containerPercentileStats
+      ),
+      allVariants
+    };
+  }
   // Returns statistics about the Function.
   async getCurrentStats() {
     const resp = await this.#client.cpClient.functionGetCurrentStats(

package/dist/index.d.cts

@@ -1638,6 +1638,8 @@ interface EndpointCreateResponse {
     endpointId: string;
     endpointPageUrl: string;
     name: string;
+    /** Model name to send in requests to the endpoint. */
+    modelName: string;
 }
 declare const EndpointCreateResponse: MessageFns$1<EndpointCreateResponse>;
 interface EndpointCustomModelSource {
@@ -1677,6 +1679,8 @@ interface EndpointGetInfoResponse_EndpointInfoSummary {
     /** set only when the model is served from a modal volume */
     volumeId: string;
     modelPath: string;
+    /** Model name to send in requests to the endpoint. */
+    modelName: string;
 }
 declare const EndpointGetInfoResponse_EndpointInfoSummary: MessageFns$1<EndpointGetInfoResponse_EndpointInfoSummary>;
 interface EndpointGetInfoResponse_EndpointHandleMetadata {
@@ -2556,7 +2560,7 @@ interface FunctionGetTimeRangeStatsResponse {
      * as requirements evolve
      */
     inputPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Container lifecycle counts. Started and errored containers are counted when
@@ -2571,7 +2575,7 @@ interface FunctionGetTimeRangeStatsResponse {
      * as requirements evolve
      */
     containerPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Number of direct non-version-pinned variants included in the roll-up.
@@ -2782,13 +2786,13 @@ interface FunctionSchema {
     returnType: GenericPayloadType | undefined;
 }
 declare const FunctionSchema: MessageFns$1<FunctionSchema>;
-interface FunctionStats {
+interface FunctionStats$1 {
     backlog: number;
     numTotalTasks: number;
     numRunningInputs: number;
     inputHeadroom: number;
 }
-declare const FunctionStats: MessageFns$1<FunctionStats>;
+declare const FunctionStats$1: MessageFns$1<FunctionStats$1>;
 interface FunctionUpdateSchedulingParamsRequest {
     functionId: string;
     warmPoolSizeOverride: number;
@@ -3865,6 +3869,11 @@ interface SandboxGetFromNameRequest {
     sandboxName: string;
     environmentName: string;
     appName: string;
+    /**
+     * When set, the lookup also considers sandboxes that have already stopped and
+     * returns the most recently created sandbox with the given name.
+     */
+    includeTerminated: boolean;
 }
 declare const SandboxGetFromNameRequest: MessageFns$1<SandboxGetFromNameRequest>;
 interface SandboxGetFromNameResponse {
@@ -4230,14 +4239,14 @@ interface ServerGetTimeRangeStatsResponse {
     requestRatePerSecond: number;
     /** Metrics include request_latency, subject to change as requirements evolve. */
     requestPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Metrics include startup_time, cpu_usage, memory_usage, and
      * gpu_utilization, subject to change as requirements evolve.
      */
     containerPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /** Absent when the image does not contain a supported inference engine. */
     inference: ServerGetTimeRangeStatsResponse_ServerInferenceStats | undefined;
@@ -4261,7 +4270,7 @@ interface ServerGetTimeRangeStatsResponse_ServerInferenceStats {
      * end_to_end_latency, subject to change as requirements evolve.
      */
     percentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Metrics include input_tokens_per_second, cached_input_tokens_per_second,
@@ -4402,18 +4411,18 @@ interface SharedVolumeRemoveFileRequest {
     recursive: boolean;
 }
 declare const SharedVolumeRemoveFileRequest: MessageFns$1<SharedVolumeRemoveFileRequest>;
-interface StatsPercentile {
+interface StatsPercentile$1 {
     /** The percentile expressed in basis points: 5000 is p50 and 9990 is p99.9. */
     percentileBasisPoints: number;
     value: number;
 }
-declare const StatsPercentile: MessageFns$1<StatsPercentile>;
-interface StatsPercentileDistribution {
+declare const StatsPercentile$1: MessageFns$1<StatsPercentile$1>;
+interface StatsPercentileDistribution$1 {
     /** Unit identifier such as "seconds", "cores", "gibibytes", or "fraction". */
     unit: string;
-    percentiles: StatsPercentile[];
+    percentiles: StatsPercentile$1[];
 }
-declare const StatsPercentileDistribution: MessageFns$1<StatsPercentileDistribution>;
+declare const StatsPercentileDistribution$1: MessageFns$1<StatsPercentileDistribution$1>;
 interface StringMap {
     contents: {
         [key: string]: string;
@@ -5987,7 +5996,7 @@ declare const ModalClientDefinition: {
             readonly name: "FunctionGetCurrentStats";
             readonly requestType: MessageFns$1<FunctionGetCurrentStatsRequest>;
             readonly requestStream: false;
-            readonly responseType: MessageFns$1<FunctionStats>;
+            readonly responseType: MessageFns$1<FunctionStats$1>;
             readonly responseStream: false;
             readonly options: {};
         };
@@ -7828,6 +7837,39 @@ interface FunctionCurrentStats {
     backlog: number;
     numTotalRunners: number;
 }
+interface StatsPercentile {
+    percentile: number;
+    value: number;
+}
+interface StatsPercentileDistribution {
+    unit: string;
+    percentiles: StatsPercentile[];
+}
+interface FunctionStats {
+    since: Date;
+    until: Date;
+    inputSuccessCount: number;
+    inputFailureCount: number;
+    inputTimeoutCount: number;
+    inputRunningAtEndCount: number;
+    containerStartedCount: number;
+    containerErrorCount: number;
+    containerCreatingAtEndCount: number;
+    variantCount: number;
+    inputPercentileStats: Record<string, StatsPercentileDistribution>;
+    containerPercentileStats: Record<string, StatsPercentileDistribution>;
+    allVariants: boolean;
+}
+interface FunctionStatsParams {
+    /** Inclusive start; defaults to one hour before until. */
+    since?: Date;
+    /** Exclusive end; defaults to the current time. */
+    until?: Date;
+    /** Restrict statistics to this container ID. */
+    container?: string;
+    /** Aggregate the base Function and its variants. Defaults to false. */
+    allVariants?: boolean;
+}
 /** Optional parameters for {@link Function_#updateAutoscaler Function_.updateAutoscaler()}. */
 interface FunctionUpdateAutoscalerParams {
     minContainers?: number;
@@ -7906,6 +7948,29 @@ declare class Function_ {
     instance(): Promise<Function_>;
     remote(args?: any[], kwargs?: Record<string, any>): Promise<any>;
     spawn(args?: any[], kwargs?: Record<string, any>): Promise<FunctionCall>;
+    /**
+     * Return historical statistics. Defaults to the last hour; the maximum range is 7 days.
+     *
+     * @example Read statistics for the last hour.
+     * ```ts
+     * const fn = await modal.functions.fromName("libmodal-test-support", "echo_string");
+     * const stats = await fn.stats();
+     * console.log(stats.inputSuccessCount, stats.inputFailureCount);
+     * ```
+     *
+     * @example Include all variants over the last 24 hours.
+     * ```ts
+     * const until = new Date();
+     * const since = new Date(until.getTime() - 24 * 60 * 60 * 1000);
+     * const variantStats = await fn.stats({ since, until, allVariants: true });
+     * for (const [metric, distribution] of Object.entries(variantStats.inputPercentileStats)) {
+     *   console.log(metric, distribution.unit, distribution.percentiles);
+     * }
+     * ```
+     *
+     * Set `container` to a container ID to restrict statistics to that container.
+     */
+    stats(params?: FunctionStatsParams): Promise<FunctionStats>;
     getCurrentStats(): Promise<FunctionCurrentStats>;
     updateAutoscaler(params: FunctionUpdateAutoscalerParams): Promise<FunctionAutoscalerSettings>;
     /**
@@ -10208,4 +10273,4 @@ declare class ClientClosedError extends Error {
 
 declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
 
-export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionCurrentStats, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, type FunctionWithBatchingParams, type FunctionWithConcurrencyParams, type FunctionWithOptionsParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, type ImageFromNameParams, type ImagePublishParams, ImageService, InternalFailure, InvalidError, type LogEntry, type FunctionLogFetchParams as LogFetchParams, type LogLevel, type LogSource, type Logger, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, Probe, type ProbeParams, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, ResourceExhaustedError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, type SandboxExperimentalFromNameParams, type SandboxExperimentalFromSnapshotParams, type SandboxExperimentalGetExitSnapshotParams, type SandboxExperimentalListParams, SandboxFilesystem, SandboxFilesystemDirectoryNotEmptyError, SandboxFilesystemError, SandboxFilesystemFileTooLargeError, SandboxFilesystemIsADirectoryError, SandboxFilesystemNotADirectoryError, SandboxFilesystemNotFoundError, SandboxFilesystemPathAlreadyExistsError, SandboxFilesystemPermissionError, type SandboxFromNameParams, type SandboxListParams, type SandboxLogFetchParams, type SandboxLogTailParams, SandboxLogsManager, type SandboxMountImageParams, type SandboxReloadVolumesParams, type SandboxRuntime, SandboxService, SandboxSnapshot, type SandboxSnapshotDirectoryParams, type SandboxSnapshotFilesystemParams, SandboxSnapshotService, type SandboxTerminateParams, SandboxTimeoutError, type SandboxUpdateNetworkPolicyParams, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, SidecarContainer, type SidecarCreateParams, type SidecarExecParams, type SidecarGetParams, type SidecarListParams, type SidecarMountImageParams, SidecarService, type SidecarSnapshotDirectoryParams, type SidecarSnapshotFilesystemParams, type SidecarTerminateParams, type SidecarUnmountImageParams, SnapshotCreationError, type StdioBehavior, type StreamMode, TimeoutError, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, type VolumeMountOptionsParams, VolumeService, checkForRenamedParams };
+export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionCurrentStats, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService, type FunctionStats, type FunctionStatsParams, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, type FunctionWithBatchingParams, type FunctionWithConcurrencyParams, type FunctionWithOptionsParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, type ImageFromNameParams, type ImagePublishParams, ImageService, InternalFailure, InvalidError, type LogEntry, type FunctionLogFetchParams as LogFetchParams, type LogLevel, type LogSource, type Logger, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, Probe, type ProbeParams, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, ResourceExhaustedError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, type SandboxExperimentalFromNameParams, type SandboxExperimentalFromSnapshotParams, type SandboxExperimentalGetExitSnapshotParams, type SandboxExperimentalListParams, SandboxFilesystem, SandboxFilesystemDirectoryNotEmptyError, SandboxFilesystemError, SandboxFilesystemFileTooLargeError, SandboxFilesystemIsADirectoryError, SandboxFilesystemNotADirectoryError, SandboxFilesystemNotFoundError, SandboxFilesystemPathAlreadyExistsError, SandboxFilesystemPermissionError, type SandboxFromNameParams, type SandboxListParams, type SandboxLogFetchParams, type SandboxLogTailParams, SandboxLogsManager, type SandboxMountImageParams, type SandboxReloadVolumesParams, type SandboxRuntime, SandboxService, SandboxSnapshot, type SandboxSnapshotDirectoryParams, type SandboxSnapshotFilesystemParams, SandboxSnapshotService, type SandboxTerminateParams, SandboxTimeoutError, type SandboxUpdateNetworkPolicyParams, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, SidecarContainer, type SidecarCreateParams, type SidecarExecParams, type SidecarGetParams, type SidecarListParams, type SidecarMountImageParams, SidecarService, type SidecarSnapshotDirectoryParams, type SidecarSnapshotFilesystemParams, type SidecarTerminateParams, type SidecarUnmountImageParams, SnapshotCreationError, type StatsPercentile, type StatsPercentileDistribution, type StdioBehavior, type StreamMode, TimeoutError, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, type VolumeMountOptionsParams, VolumeService, checkForRenamedParams };

package/dist/index.d.ts

@@ -1638,6 +1638,8 @@ interface EndpointCreateResponse {
     endpointId: string;
     endpointPageUrl: string;
     name: string;
+    /** Model name to send in requests to the endpoint. */
+    modelName: string;
 }
 declare const EndpointCreateResponse: MessageFns$1<EndpointCreateResponse>;
 interface EndpointCustomModelSource {
@@ -1677,6 +1679,8 @@ interface EndpointGetInfoResponse_EndpointInfoSummary {
     /** set only when the model is served from a modal volume */
     volumeId: string;
     modelPath: string;
+    /** Model name to send in requests to the endpoint. */
+    modelName: string;
 }
 declare const EndpointGetInfoResponse_EndpointInfoSummary: MessageFns$1<EndpointGetInfoResponse_EndpointInfoSummary>;
 interface EndpointGetInfoResponse_EndpointHandleMetadata {
@@ -2556,7 +2560,7 @@ interface FunctionGetTimeRangeStatsResponse {
      * as requirements evolve
      */
     inputPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Container lifecycle counts. Started and errored containers are counted when
@@ -2571,7 +2575,7 @@ interface FunctionGetTimeRangeStatsResponse {
      * as requirements evolve
      */
     containerPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Number of direct non-version-pinned variants included in the roll-up.
@@ -2782,13 +2786,13 @@ interface FunctionSchema {
     returnType: GenericPayloadType | undefined;
 }
 declare const FunctionSchema: MessageFns$1<FunctionSchema>;
-interface FunctionStats {
+interface FunctionStats$1 {
     backlog: number;
     numTotalTasks: number;
     numRunningInputs: number;
     inputHeadroom: number;
 }
-declare const FunctionStats: MessageFns$1<FunctionStats>;
+declare const FunctionStats$1: MessageFns$1<FunctionStats$1>;
 interface FunctionUpdateSchedulingParamsRequest {
     functionId: string;
     warmPoolSizeOverride: number;
@@ -3865,6 +3869,11 @@ interface SandboxGetFromNameRequest {
     sandboxName: string;
     environmentName: string;
     appName: string;
+    /**
+     * When set, the lookup also considers sandboxes that have already stopped and
+     * returns the most recently created sandbox with the given name.
+     */
+    includeTerminated: boolean;
 }
 declare const SandboxGetFromNameRequest: MessageFns$1<SandboxGetFromNameRequest>;
 interface SandboxGetFromNameResponse {
@@ -4230,14 +4239,14 @@ interface ServerGetTimeRangeStatsResponse {
     requestRatePerSecond: number;
     /** Metrics include request_latency, subject to change as requirements evolve. */
     requestPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Metrics include startup_time, cpu_usage, memory_usage, and
      * gpu_utilization, subject to change as requirements evolve.
      */
     containerPercentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /** Absent when the image does not contain a supported inference engine. */
     inference: ServerGetTimeRangeStatsResponse_ServerInferenceStats | undefined;
@@ -4261,7 +4270,7 @@ interface ServerGetTimeRangeStatsResponse_ServerInferenceStats {
      * end_to_end_latency, subject to change as requirements evolve.
      */
     percentileStats: {
-        [key: string]: StatsPercentileDistribution;
+        [key: string]: StatsPercentileDistribution$1;
     };
     /**
      * Metrics include input_tokens_per_second, cached_input_tokens_per_second,
@@ -4402,18 +4411,18 @@ interface SharedVolumeRemoveFileRequest {
     recursive: boolean;
 }
 declare const SharedVolumeRemoveFileRequest: MessageFns$1<SharedVolumeRemoveFileRequest>;
-interface StatsPercentile {
+interface StatsPercentile$1 {
     /** The percentile expressed in basis points: 5000 is p50 and 9990 is p99.9. */
     percentileBasisPoints: number;
     value: number;
 }
-declare const StatsPercentile: MessageFns$1<StatsPercentile>;
-interface StatsPercentileDistribution {
+declare const StatsPercentile$1: MessageFns$1<StatsPercentile$1>;
+interface StatsPercentileDistribution$1 {
     /** Unit identifier such as "seconds", "cores", "gibibytes", or "fraction". */
     unit: string;
-    percentiles: StatsPercentile[];
+    percentiles: StatsPercentile$1[];
 }
-declare const StatsPercentileDistribution: MessageFns$1<StatsPercentileDistribution>;
+declare const StatsPercentileDistribution$1: MessageFns$1<StatsPercentileDistribution$1>;
 interface StringMap {
     contents: {
         [key: string]: string;
@@ -5987,7 +5996,7 @@ declare const ModalClientDefinition: {
             readonly name: "FunctionGetCurrentStats";
             readonly requestType: MessageFns$1<FunctionGetCurrentStatsRequest>;
             readonly requestStream: false;
-            readonly responseType: MessageFns$1<FunctionStats>;
+            readonly responseType: MessageFns$1<FunctionStats$1>;
             readonly responseStream: false;
             readonly options: {};
         };
@@ -7828,6 +7837,39 @@ interface FunctionCurrentStats {
     backlog: number;
     numTotalRunners: number;
 }
+interface StatsPercentile {
+    percentile: number;
+    value: number;
+}
+interface StatsPercentileDistribution {
+    unit: string;
+    percentiles: StatsPercentile[];
+}
+interface FunctionStats {
+    since: Date;
+    until: Date;
+    inputSuccessCount: number;
+    inputFailureCount: number;
+    inputTimeoutCount: number;
+    inputRunningAtEndCount: number;
+    containerStartedCount: number;
+    containerErrorCount: number;
+    containerCreatingAtEndCount: number;
+    variantCount: number;
+    inputPercentileStats: Record<string, StatsPercentileDistribution>;
+    containerPercentileStats: Record<string, StatsPercentileDistribution>;
+    allVariants: boolean;
+}
+interface FunctionStatsParams {
+    /** Inclusive start; defaults to one hour before until. */
+    since?: Date;
+    /** Exclusive end; defaults to the current time. */
+    until?: Date;
+    /** Restrict statistics to this container ID. */
+    container?: string;
+    /** Aggregate the base Function and its variants. Defaults to false. */
+    allVariants?: boolean;
+}
 /** Optional parameters for {@link Function_#updateAutoscaler Function_.updateAutoscaler()}. */
 interface FunctionUpdateAutoscalerParams {
     minContainers?: number;
@@ -7906,6 +7948,29 @@ declare class Function_ {
     instance(): Promise<Function_>;
     remote(args?: any[], kwargs?: Record<string, any>): Promise<any>;
     spawn(args?: any[], kwargs?: Record<string, any>): Promise<FunctionCall>;
+    /**
+     * Return historical statistics. Defaults to the last hour; the maximum range is 7 days.
+     *
+     * @example Read statistics for the last hour.
+     * ```ts
+     * const fn = await modal.functions.fromName("libmodal-test-support", "echo_string");
+     * const stats = await fn.stats();
+     * console.log(stats.inputSuccessCount, stats.inputFailureCount);
+     * ```
+     *
+     * @example Include all variants over the last 24 hours.
+     * ```ts
+     * const until = new Date();
+     * const since = new Date(until.getTime() - 24 * 60 * 60 * 1000);
+     * const variantStats = await fn.stats({ since, until, allVariants: true });
+     * for (const [metric, distribution] of Object.entries(variantStats.inputPercentileStats)) {
+     *   console.log(metric, distribution.unit, distribution.percentiles);
+     * }
+     * ```
+     *
+     * Set `container` to a container ID to restrict statistics to that container.
+     */
+    stats(params?: FunctionStatsParams): Promise<FunctionStats>;
     getCurrentStats(): Promise<FunctionCurrentStats>;
     updateAutoscaler(params: FunctionUpdateAutoscalerParams): Promise<FunctionAutoscalerSettings>;
     /**
@@ -10208,4 +10273,4 @@ declare class ClientClosedError extends Error {
 
 declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
 
-export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionCurrentStats, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, type FunctionWithBatchingParams, type FunctionWithConcurrencyParams, type FunctionWithOptionsParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, type ImageFromNameParams, type ImagePublishParams, ImageService, InternalFailure, InvalidError, type LogEntry, type FunctionLogFetchParams as LogFetchParams, type LogLevel, type LogSource, type Logger, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, Probe, type ProbeParams, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, ResourceExhaustedError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, type SandboxExperimentalFromNameParams, type SandboxExperimentalFromSnapshotParams, type SandboxExperimentalGetExitSnapshotParams, type SandboxExperimentalListParams, SandboxFilesystem, SandboxFilesystemDirectoryNotEmptyError, SandboxFilesystemError, SandboxFilesystemFileTooLargeError, SandboxFilesystemIsADirectoryError, SandboxFilesystemNotADirectoryError, SandboxFilesystemNotFoundError, SandboxFilesystemPathAlreadyExistsError, SandboxFilesystemPermissionError, type SandboxFromNameParams, type SandboxListParams, type SandboxLogFetchParams, type SandboxLogTailParams, SandboxLogsManager, type SandboxMountImageParams, type SandboxReloadVolumesParams, type SandboxRuntime, SandboxService, SandboxSnapshot, type SandboxSnapshotDirectoryParams, type SandboxSnapshotFilesystemParams, SandboxSnapshotService, type SandboxTerminateParams, SandboxTimeoutError, type SandboxUpdateNetworkPolicyParams, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, SidecarContainer, type SidecarCreateParams, type SidecarExecParams, type SidecarGetParams, type SidecarListParams, type SidecarMountImageParams, SidecarService, type SidecarSnapshotDirectoryParams, type SidecarSnapshotFilesystemParams, type SidecarTerminateParams, type SidecarUnmountImageParams, SnapshotCreationError, type StdioBehavior, type StreamMode, TimeoutError, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, type VolumeMountOptionsParams, VolumeService, checkForRenamedParams };
+export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionCurrentStats, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService, type FunctionStats, type FunctionStatsParams, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, type FunctionWithBatchingParams, type FunctionWithConcurrencyParams, type FunctionWithOptionsParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, type ImageFromNameParams, type ImagePublishParams, ImageService, InternalFailure, InvalidError, type LogEntry, type FunctionLogFetchParams as LogFetchParams, type LogLevel, type LogSource, type Logger, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, Probe, type ProbeParams, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, ResourceExhaustedError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, type SandboxExperimentalFromNameParams, type SandboxExperimentalFromSnapshotParams, type SandboxExperimentalGetExitSnapshotParams, type SandboxExperimentalListParams, SandboxFilesystem, SandboxFilesystemDirectoryNotEmptyError, SandboxFilesystemError, SandboxFilesystemFileTooLargeError, SandboxFilesystemIsADirectoryError, SandboxFilesystemNotADirectoryError, SandboxFilesystemNotFoundError, SandboxFilesystemPathAlreadyExistsError, SandboxFilesystemPermissionError, type SandboxFromNameParams, type SandboxListParams, type SandboxLogFetchParams, type SandboxLogTailParams, SandboxLogsManager, type SandboxMountImageParams, type SandboxReloadVolumesParams, type SandboxRuntime, SandboxService, SandboxSnapshot, type SandboxSnapshotDirectoryParams, type SandboxSnapshotFilesystemParams, SandboxSnapshotService, type SandboxTerminateParams, SandboxTimeoutError, type SandboxUpdateNetworkPolicyParams, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, SidecarContainer, type SidecarCreateParams, type SidecarExecParams, type SidecarGetParams, type SidecarListParams, type SidecarMountImageParams, SidecarService, type SidecarSnapshotDirectoryParams, type SidecarSnapshotFilesystemParams, type SidecarTerminateParams, type SidecarUnmountImageParams, SnapshotCreationError, type StatsPercentile, type StatsPercentileDistribution, type StdioBehavior, type StreamMode, TimeoutError, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, type VolumeMountOptionsParams, VolumeService, checkForRenamedParams };

package/dist/index.js

@@ -18026,7 +18026,7 @@ var EndpointCreateRequest = {
   }
 };
 function createBaseEndpointCreateResponse() {
-  return { endpointId: "", endpointPageUrl: "", name: "" };
+  return { endpointId: "", endpointPageUrl: "", name: "", modelName: "" };
 }
 var EndpointCreateResponse = {
   encode(message, writer = new BinaryWriter()) {
@@ -18039,6 +18039,9 @@ var EndpointCreateResponse = {
     if (message.name !== "") {
       writer.uint32(26).string(message.name);
     }
+    if (message.modelName !== "") {
+      writer.uint32(34).string(message.modelName);
+    }
     return writer;
   },
   decode(input, length) {
@@ -18069,6 +18072,13 @@ var EndpointCreateResponse = {
           message.name = reader.string();
           continue;
         }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+          message.modelName = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -18081,7 +18091,8 @@ var EndpointCreateResponse = {
     return {
       endpointId: isSet5(object.endpointId) ? globalThis.String(object.endpointId) : "",
       endpointPageUrl: isSet5(object.endpointPageUrl) ? globalThis.String(object.endpointPageUrl) : "",
-      name: isSet5(object.name) ? globalThis.String(object.name) : ""
+      name: isSet5(object.name) ? globalThis.String(object.name) : "",
+      modelName: isSet5(object.modelName) ? globalThis.String(object.modelName) : ""
     };
   },
   toJSON(message) {
@@ -18095,6 +18106,9 @@ var EndpointCreateResponse = {
     if (message.name !== "") {
       obj.name = message.name;
     }
+    if (message.modelName !== "") {
+      obj.modelName = message.modelName;
+    }
     return obj;
   },
   create(base) {
@@ -18105,6 +18119,7 @@ var EndpointCreateResponse = {
     message.endpointId = object.endpointId ?? "";
     message.endpointPageUrl = object.endpointPageUrl ?? "";
     message.name = object.name ?? "";
+    message.modelName = object.modelName ?? "";
     return message;
   }
 };
@@ -18457,7 +18472,8 @@ function createBaseEndpointGetInfoResponse_EndpointInfoSummary() {
     status: 0,
     lifecycle: void 0,
     volumeId: "",
-    modelPath: ""
+    modelPath: "",
+    modelName: ""
   };
 }
 var EndpointGetInfoResponse_EndpointInfoSummary = {
@@ -18492,6 +18508,9 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
     if (message.modelPath !== "") {
       writer.uint32(98).string(message.modelPath);
     }
+    if (message.modelName !== "") {
+      writer.uint32(106).string(message.modelName);
+    }
     return writer;
   },
   decode(input, length) {
@@ -18571,6 +18590,13 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
           message.modelPath = reader.string();
           continue;
         }
+        case 13: {
+          if (tag !== 106) {
+            break;
+          }
+          message.modelName = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -18590,7 +18616,8 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
       status: isSet5(object.status) ? endpointGetInfoResponse_EndpointStatusFromJSON(object.status) : 0,
       lifecycle: isSet5(object.lifecycle) ? EndpointLifecycle.fromJSON(object.lifecycle) : void 0,
       volumeId: isSet5(object.volumeId) ? globalThis.String(object.volumeId) : "",
-      modelPath: isSet5(object.modelPath) ? globalThis.String(object.modelPath) : ""
+      modelPath: isSet5(object.modelPath) ? globalThis.String(object.modelPath) : "",
+      modelName: isSet5(object.modelName) ? globalThis.String(object.modelName) : ""
     };
   },
   toJSON(message) {
@@ -18625,6 +18652,9 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
     if (message.modelPath !== "") {
       obj.modelPath = message.modelPath;
     }
+    if (message.modelName !== "") {
+      obj.modelName = message.modelName;
+    }
     return obj;
   },
   create(base) {
@@ -18642,6 +18672,7 @@ var EndpointGetInfoResponse_EndpointInfoSummary = {
     message.lifecycle = object.lifecycle !== void 0 && object.lifecycle !== null ? EndpointLifecycle.fromPartial(object.lifecycle) : void 0;
     message.volumeId = object.volumeId ?? "";
     message.modelPath = object.modelPath ?? "";
+    message.modelName = object.modelName ?? "";
     return message;
   }
 };
@@ -44921,7 +44952,7 @@ var SandboxGetExitSnapshotResponse_Error = {
   }
 };
 function createBaseSandboxGetFromNameRequest() {
-  return { sandboxName: "", environmentName: "", appName: "" };
+  return { sandboxName: "", environmentName: "", appName: "", includeTerminated: false };
 }
 var SandboxGetFromNameRequest = {
   encode(message, writer = new BinaryWriter()) {
@@ -44934,6 +44965,9 @@ var SandboxGetFromNameRequest = {
     if (message.appName !== "") {
       writer.uint32(26).string(message.appName);
     }
+    if (message.includeTerminated !== false) {
+      writer.uint32(32).bool(message.includeTerminated);
+    }
     return writer;
   },
   decode(input, length) {
@@ -44964,6 +44998,13 @@ var SandboxGetFromNameRequest = {
           message.appName = reader.string();
           continue;
         }
+        case 4: {
+          if (tag !== 32) {
+            break;
+          }
+          message.includeTerminated = reader.bool();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -44976,7 +45017,8 @@ var SandboxGetFromNameRequest = {
     return {
       sandboxName: isSet5(object.sandboxName) ? globalThis.String(object.sandboxName) : "",
       environmentName: isSet5(object.environmentName) ? globalThis.String(object.environmentName) : "",
-      appName: isSet5(object.appName) ? globalThis.String(object.appName) : ""
+      appName: isSet5(object.appName) ? globalThis.String(object.appName) : "",
+      includeTerminated: isSet5(object.includeTerminated) ? globalThis.Boolean(object.includeTerminated) : false
     };
   },
   toJSON(message) {
@@ -44990,6 +45032,9 @@ var SandboxGetFromNameRequest = {
     if (message.appName !== "") {
       obj.appName = message.appName;
     }
+    if (message.includeTerminated !== false) {
+      obj.includeTerminated = message.includeTerminated;
+    }
     return obj;
   },
   create(base) {
@@ -45000,6 +45045,7 @@ var SandboxGetFromNameRequest = {
     message.sandboxName = object.sandboxName ?? "";
     message.environmentName = object.environmentName ?? "";
     message.appName = object.appName ?? "";
+    message.includeTerminated = object.includeTerminated ?? false;
     return message;
   }
 };
@@ -74497,7 +74543,7 @@ var AuthTokenManager = class {
 };
 
 // src/version.ts
-var SDK_VERSION = "0.11.1-dev.6";
+var SDK_VERSION = "0.11.1-dev.7";
 function getSDKVersion() {
   return SDK_VERSION;
 }
@@ -76380,6 +76426,20 @@ var FunctionService = class {
     }
   }
 };
+function statsDistributions(stats) {
+  return Object.fromEntries(
+    Object.entries(stats).map(([key, distribution]) => [
+      key,
+      {
+        unit: distribution.unit,
+        percentiles: distribution.percentiles.map((p) => ({
+          percentile: p.percentileBasisPoints / 100,
+          value: p.value
+        }))
+      }
+    ])
+  );
+}
 function mergeServiceOptions(base, diff) {
   const filteredDiff = Object.fromEntries(
     Object.entries(diff).filter(([, value]) => value !== void 0)
@@ -76747,6 +76807,65 @@ var Function_ = class _Function_ {
       this.functionId
     );
   }
+  /**
+   * Return historical statistics. Defaults to the last hour; the maximum range is 7 days.
+   *
+   * @example Read statistics for the last hour.
+   * ```ts
+   * const fn = await modal.functions.fromName("libmodal-test-support", "echo_string");
+   * const stats = await fn.stats();
+   * console.log(stats.inputSuccessCount, stats.inputFailureCount);
+   * ```
+   *
+   * @example Include all variants over the last 24 hours.
+   * ```ts
+   * const until = new Date();
+   * const since = new Date(until.getTime() - 24 * 60 * 60 * 1000);
+   * const variantStats = await fn.stats({ since, until, allVariants: true });
+   * for (const [metric, distribution] of Object.entries(variantStats.inputPercentileStats)) {
+   *   console.log(metric, distribution.unit, distribution.percentiles);
+   * }
+   * ```
+   *
+   * Set `container` to a container ID to restrict statistics to that container.
+   */
+  async stats(params = {}) {
+    const until = params.until ?? /* @__PURE__ */ new Date();
+    const since = params.since ?? new Date(until.getTime() - 60 * 60 * 1e3);
+    if (!Number.isFinite(since.getTime()) || !Number.isFinite(until.getTime())) {
+      throw new InvalidError("`since` and `until` must be valid dates.");
+    }
+    if (since >= until) {
+      throw new InvalidError("`since` must be before `until`.");
+    }
+    const allVariants = params.allVariants ?? false;
+    const resp = await this.#client.cpClient.functionGetTimeRangeStats(
+      FunctionGetTimeRangeStatsRequest.create({
+        functionId: this.functionId,
+        since,
+        until,
+        containerId: params.container || void 0,
+        rollup: allVariants
+      })
+    );
+    return {
+      since: resp.since ?? /* @__PURE__ */ new Date(0),
+      until: resp.until ?? /* @__PURE__ */ new Date(0),
+      inputSuccessCount: resp.inputSuccessCount,
+      inputFailureCount: resp.inputFailureCount,
+      inputTimeoutCount: resp.inputTimeoutCount,
+      inputRunningAtEndCount: resp.inputRunningAtEndCount,
+      containerStartedCount: resp.containerStartedCount,
+      containerErrorCount: resp.containerErrorCount,
+      containerCreatingAtEndCount: resp.containerCreatingAtEndCount,
+      variantCount: resp.variantCount,
+      inputPercentileStats: statsDistributions(resp.inputPercentileStats),
+      containerPercentileStats: statsDistributions(
+        resp.containerPercentileStats
+      ),
+      allVariants
+    };
+  }
   // Returns statistics about the Function.
   async getCurrentStats() {
     const resp = await this.#client.cpClient.functionGetCurrentStats(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modal",
-  "version": "0.11.1-dev.6",
+  "version": "0.11.1-dev.7",
   "description": "Modal SDK for JavaScript/TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://modal.com/docs/guide/sdk-javascript-go",