modal 0.5.1 → 0.5.3

package/README.md

@@ -50,6 +50,11 @@ We also provide a number of examples:
 - [Mount a cloud bucket to a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-cloud-bucket.ts)
 - [Eagerly build an Image for a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-prewarm.ts)
 - [Building custom Images](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/image-building.ts)
+- [Add telemetry and tracing with custom middleware](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/telemetry.ts)
+
+### Configuration
+
+The config file path can be customized via `MODAL_CONFIG_PATH` (defaults to `~/.modal.toml`).
 
 ### Authenticating with Modal
 
@@ -61,6 +66,10 @@ export MODAL_TOKEN_ID=ak-NOTAREALTOKENSTRINGXYZ
 export MODAL_TOKEN_SECRET=as-FAKESECRETSTRINGABCDEF
 ```
 
+### Telemetry and Observability
+
+The Modal JavaScript SDK supports custom gRPC middleware for telemetry, tracing, and observability. You can add custom middleware to measure API call latency, trace requests, and integrate with observability tools like OpenTelemetry, DataDog, and others. See the [telemetry example](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/telemetry.ts) for more details.
+
 ## Support
 
 For usage questions and other support, please reach out on the [Modal Community Slack](https://modal.com/slack).

package/dist/index.cjs

@@ -46695,7 +46695,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.1" : "0.0.0";
+  return true ? "0.5.3" : "0.0.0";
 }
 
 // src/logger.ts
@@ -46822,6 +46822,7 @@ var ModalClient = class {
   logger;
   ipClients;
   authTokenManager = null;
+  customMiddleware;
   constructor(params) {
     checkForRenamedParams(params, { timeout: "timeoutMs" });
     const baseProfile = getProfile(process.env["MODAL_PROFILE"]);
@@ -46840,6 +46841,7 @@ var ModalClient = class {
       "server_url",
       this.profile.serverUrl
     );
+    this.customMiddleware = params?.grpcMiddleware ?? [];
     this.ipClients = /* @__PURE__ */ new Map();
     this.cpClient = params?.cpClient ?? this.createClient(this.profile);
     this.logger.debug("Modal client initialized successfully");
@@ -46889,7 +46891,11 @@ var ModalClient = class {
       "grpc.max_send_message_length": 100 * 1024 * 1024,
       "grpc-node.flow_control_window": 64 * 1024 * 1024
     });
-    return (0, import_nice_grpc10.createClientFactory)().use(this.authMiddleware(profile)).use(this.retryMiddleware()).use(timeoutMiddleware).create(ModalClientDefinition, channel);
+    let factory = (0, import_nice_grpc10.createClientFactory)().use(this.authMiddleware(profile)).use(this.retryMiddleware()).use(timeoutMiddleware);
+    for (const middleware of this.customMiddleware) {
+      factory = factory.use(middleware);
+    }
+    return factory.create(ModalClientDefinition, channel);
   }
   /** Middleware to retry transient errors and timeouts for unary requests. */
   retryMiddleware() {

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Client, Status } from 'nice-grpc';
+import { Client, Status, ClientMiddleware } from 'nice-grpc';
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 
 /**
@@ -5895,6 +5895,16 @@ interface ModalClientParams {
     maxRetries?: number;
     logger?: Logger;
     logLevel?: LogLevel;
+    /**
+     * Custom gRPC middleware to be applied to all API calls.
+     * These middleware are appended after Modal's built-in middleware
+     * (authentication, retry logic, and timeouts), allowing you to add
+     * telemetry, tracing, or other observability features.
+     *
+     * Note that the Modal gRPC API is not considered a public API, and
+     * can change without warning.
+     */
+    grpcMiddleware?: ClientMiddleware[];
     /** @ignore */
     cpClient?: ModalGrpcClient;
 }
@@ -5934,6 +5944,7 @@ declare class ModalClient {
     readonly logger: Logger;
     private ipClients;
     private authTokenManager;
+    private customMiddleware;
     constructor(params?: ModalClientParams);
     environmentName(environment?: string): string;
     imageBuilderVersion(version?: string): string;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Client, Status } from 'nice-grpc';
+import { Client, Status, ClientMiddleware } from 'nice-grpc';
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 
 /**
@@ -5895,6 +5895,16 @@ interface ModalClientParams {
     maxRetries?: number;
     logger?: Logger;
     logLevel?: LogLevel;
+    /**
+     * Custom gRPC middleware to be applied to all API calls.
+     * These middleware are appended after Modal's built-in middleware
+     * (authentication, retry logic, and timeouts), allowing you to add
+     * telemetry, tracing, or other observability features.
+     *
+     * Note that the Modal gRPC API is not considered a public API, and
+     * can change without warning.
+     */
+    grpcMiddleware?: ClientMiddleware[];
     /** @ignore */
     cpClient?: ModalGrpcClient;
 }
@@ -5934,6 +5944,7 @@ declare class ModalClient {
     readonly logger: Logger;
     private ipClients;
     private authTokenManager;
+    private customMiddleware;
     constructor(params?: ModalClientParams);
     environmentName(environment?: string): string;
     imageBuilderVersion(version?: string): string;

package/dist/index.js

@@ -46628,7 +46628,7 @@ var AuthTokenManager = class {
 
 // src/version.ts
 function getSDKVersion() {
-  return true ? "0.5.1" : "0.0.0";
+  return true ? "0.5.3" : "0.0.0";
 }
 
 // src/logger.ts
@@ -46755,6 +46755,7 @@ var ModalClient = class {
   logger;
   ipClients;
   authTokenManager = null;
+  customMiddleware;
   constructor(params) {
     checkForRenamedParams(params, { timeout: "timeoutMs" });
     const baseProfile = getProfile(process.env["MODAL_PROFILE"]);
@@ -46773,6 +46774,7 @@ var ModalClient = class {
       "server_url",
       this.profile.serverUrl
     );
+    this.customMiddleware = params?.grpcMiddleware ?? [];
     this.ipClients = /* @__PURE__ */ new Map();
     this.cpClient = params?.cpClient ?? this.createClient(this.profile);
     this.logger.debug("Modal client initialized successfully");
@@ -46822,7 +46824,11 @@ var ModalClient = class {
       "grpc.max_send_message_length": 100 * 1024 * 1024,
       "grpc-node.flow_control_window": 64 * 1024 * 1024
     });
-    return createClientFactory().use(this.authMiddleware(profile)).use(this.retryMiddleware()).use(timeoutMiddleware).create(ModalClientDefinition, channel);
+    let factory = createClientFactory().use(this.authMiddleware(profile)).use(this.retryMiddleware()).use(timeoutMiddleware);
+    for (const middleware of this.customMiddleware) {
+      factory = factory.use(middleware);
+    }
+    return factory.create(ModalClientDefinition, channel);
   }
   /** Middleware to retry transient errors and timeouts for unary requests. */
   retryMiddleware() {

package/package.json

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