Skip to content

docs: document LSD_CHECKPOINT_DELETE env var#3682

Open
Connor Braa (cwlbraa) wants to merge 5 commits intomainfrom
cwlbraa/lsd-checkpoint-delete
Open

docs: document LSD_CHECKPOINT_DELETE env var#3682
Connor Braa (cwlbraa) wants to merge 5 commits intomainfrom
cwlbraa/lsd-checkpoint-delete

Conversation

@cwlbraa
Copy link
Copy Markdown
Contributor

@cwlbraa Connor Braa (cwlbraa) commented Apr 22, 2026

Summary

  • Adds an Agent Server env var reference entry for LSD_CHECKPOINT_DELETE, the feature flag that turns on deferred/background checkpoint deletion
  • Documents all five JSON config fields (enabled, enabledWorkerOnly, pollIntervalMs, batchSize, batchSleepMs) with defaults and an example

Test plan

  • make lint_prose FILES="src/langsmith/env-var.mdx" passes clean
  • Visual check of rendered page in preview

🤖 Generated with Claude Code

Adds agent server env var reference for the deferred checkpoint
deletion feature flag, covering all configurable JSON fields
(enabled, enabledWorkerOnly, pollIntervalMs, batchSize, batchSleepMs)
shipped in langgraph-api#3111.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Thanks for opening a docs PR, Connor Braa (@cwlbraa)! When it's ready for review, please add the relevant reviewers:

  • @katmayb or @fjmorris (LangSmith)

@github-actions github-actions Bot added the langsmith For docs changes to LangSmith label Apr 22, 2026
Connor Braa (cwlbraa) and others added 4 commits April 22, 2026 15:07
The feature shipped in 3111 but the queue table migration did not
apply until the renumber fix in 3269, which also bumped the version
to 0.7.103. Direct users to that version to avoid hitting the broken
migration.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Describe the behavior in terms of enqueue/drain instead of the
internal checkpointer-wrapper implementation detail.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
MongoDB checkpointer's DeleteCheckpoints explicitly returns unsupported,
so the deferred-delete worker only works against the postgres backend.
Flag it will become the default later so operators can plan ahead.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Mintlify preview branch generated: preview-cwlbra-1776895976-34c974a

Site preview: https://langchain-5e9cc07a-preview-cwlbra-1776895976-34c974a.mintlify.app

Changed documentation pages (preview deep links):

Comment thread src/langsmith/env-var.mdx

Accepted fields:

- `enabled` (boolean, default `false`): When `true`, thread delete and prune operations enqueue checkpoints into `checkpoint_delete_queue` and return immediately, and the background worker drains the queue.
Copy link
Copy Markdown
Contributor

@longquanzheng Quanzheng Long (longquanzheng) Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it safe to flip back from true to false? if not maybe worth documenting it to avoid mistakes.

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

Labels

internal langsmith For docs changes to LangSmith

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants