Skip to content

docs(c-tracker): document flush timeout configuration and bounded shutdown semantics - #1867

Draft
snowplow-claude-review[bot] wants to merge 1 commit into
mainfrom
loop/3a407af295a280b0a498c42a3aea3b6d-documentation
Draft

docs(c-tracker): document flush timeout configuration and bounded shutdown semantics#1867
snowplow-claude-review[bot] wants to merge 1 commit into
mainfrom
loop/3a407af295a280b0a498c42a3aea3b6d-documentation

Conversation

@snowplow-claude-review

Copy link
Copy Markdown
Contributor

Documents the set_flush_timeout_ms option added to EmitterConfiguration and clarifies the bounded-deadline behaviour of flush().

Changes

docs/sources/c-tracker/initialisation/index.md

Added set_flush_timeout_ms to the EmitterConfiguration setter table:

  • Default: 30,000 ms
  • Description covers bounded-deadline semantics, SQLite retention on timeout expiry, and that 0 means indefinite (no timeout).

docs/sources/c-tracker/emitters/index.md

Expanded the Manual flushing section to explain:

  • flush() waits up to the configured flush timeout (default 30 s) for the event queue to drain.
  • If the timeout expires before the queue empties, flush() calls stop() and returns; undelivered events remain in the SQLite event store for the next session.
  • How to configure the timeout via set_flush_timeout_ms().
  • A working code example using set_flush_timeout_ms(5000).

CLAUDE.md conventions followed throughout: sentence-case headings, active voice, US English.

What to review

  • Accuracy of the default value (30,000 ms) and 0-means-indefinite semantics in the initialisation table.
  • Flushing section correctly describes expiry behaviour — events are retained in SQLite, not dropped.
  • Code example uses the API correctly and compiles against the tracker headers.

Draft PR opened for review — please verify and run CI before merging.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
documentation d3cbc67 Commit Preview URL

Branch Preview URL
Jul 22 2026, 11:52 AM

@snowplowcla

Copy link
Copy Markdown

Thanks for your pull request. Is this your first contribution to a Snowplow open source project? Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://docs.snowplowanalytics.com/docs/contributing/contributor-license-agreement/ to learn more and sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant