Skip to content

Conversation

@agents-git-bot
Copy link
Contributor

Summary

Documents the new heartbeat functionality for keepAlive containers introduced in cloudflare/sandbox-sdk#369.

Changes:

  • New API method: Add setKeepAlive() method documentation to lifecycle API for dynamically enabling/disabling keepAlive mode
  • Enhanced keepAlive behavior: Update keepAlive option docs to explain automatic heartbeat pings every 30 seconds
  • Lifecycle management: Update sandbox concepts with keepAlive container management best practices

Technical Details:

The original PR adds automatic heartbeat functionality to prevent container eviction when keepAlive is enabled:

  • Containers with keepAlive now automatically send lightweight ping requests every 30 seconds
  • New setKeepAlive() method allows toggling this behavior after sandbox creation
  • Activity timeout is renewed when keepAlive is active to prevent automatic shutdown

Related PR:

- Add setKeepAlive() method documentation to lifecycle API
- Update keepAlive option docs with heartbeat behavior details
- Enhance sandbox lifecycle concepts with keepAlive management
- Document 30-second heartbeat pings for container eviction prevention
@github-actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/sandbox/ @whoiskatrin, @ghostwriternr, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants