modal 0.5.0 → 0.5.2

package/README.md

@@ -27,29 +27,34 @@ Node 22 or later. We bundle both ES Modules and CommonJS formats, so you can loa
 
 ## Documentation
 
-See the main [Modal documentation](https://modal.com/docs/guide) and [user guides](https://modal.com/docs/guide) for high-level overviews. For details, see the [API reference documentation for for JS](https://modal-labs.github.io/libmodal/).
+See the main [Modal documentation](https://modal.com/docs) and [user guides](https://modal.com/docs/guide) for high-level overviews. For details, see the [API reference documentation for for JS](https://modal-labs.github.io/libmodal/).
 
 We also provide a number of examples:
 
-- [Call a deployed Function](./examples/function-call.ts)
-- [Spawn a deployed Function](./examples/function-spawn.ts)
-- [Call a deployed Cls](./examples/cls-call.ts)
-- [Call a deployed Cls, and override its options](./examples/cls-call-with-options.ts)
-- [Create a Sandbox](./examples/sandbox.ts)
-- [Create a named Sandbox](./examples/sandbox-named.ts)
-- [Create a Sandbox with GPU](./examples/sandbox-gpu.ts)
-- [Create a Sandbox using a private image from AWS ECR](./examples/sandbox-private-image.ts)
-- [Take a snapshot of the filesystem of a Sandbox](./examples/sandbox-filesystem-snapshot.ts)
-- [Execute Sandbox commands](./examples/sandbox-exec.ts)
-- [Running a coding agent in a Sandbox](./examples/sandbox-agent.ts)
-- [Check the status and exit code of a Sandbox](./examples/sandbox-poll.ts)
-- [Access Sandbox filesystem](./examples/sandbox-filesystem.ts)
-- [Expose ports on a Sandbox using Tunnels](./examples/sandbox-tunnels.ts)
-- [Include Secrets in Sandbox](./examples/sandbox-secrets.ts)
-- [Mount a Volume to a Sandbox](./examples/sandbox-volume.ts), and same but [with an ephemeral Volume](./examples/sandbox-volume-ephemeral.ts)
-- [Mount a cloud bucket to a Sandbox](./examples/sandbox-cloud-bucket.ts)
-- [Eagerly build an Image for a Sandbox](./examples/sandbox-prewarm.ts)
-- [Building custom Images](./examples/image-building.ts)
+- [Call a deployed Function](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/function-call.ts)
+- [Spawn a deployed Function](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/function-spawn.ts)
+- [Call a deployed Cls](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/cls-call.ts)
+- [Call a deployed Cls, and override its options](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/cls-call-with-options.ts)
+- [Create a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox.ts)
+- [Create a named Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-named.ts)
+- [Create a Sandbox with GPU](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-gpu.ts)
+- [Create a Sandbox using a private image from AWS ECR](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-private-image.ts)
+- [Take a snapshot of the filesystem of a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-filesystem-snapshot.ts)
+- [Execute Sandbox commands](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-exec.ts)
+- [Running a coding agent in a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-agent.ts)
+- [Check the status and exit code of a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-poll.ts)
+- [Access Sandbox filesystem](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-filesystem.ts)
+- [Expose ports on a Sandbox using Tunnels](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-tunnels.ts)
+- [Include Secrets in Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-secrets.ts)
+- [Mount a Volume to a Sandbox](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-volume.ts), and same but [with an ephemeral Volume](https://github.com/modal-labs/libmodal/blob/main/modal-js/examples/sandbox-volume-ephemeral.ts)
+- [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).