Skip to content

SK-3133 Add unary vs. bulk guidance and concurrency sizing formula to flowvault README - #432

Merged
Devesh-Skyflow merged 1 commit into
mainfrom
devesh/sk-3133-unary-bulk-concurrency-guidelines
Sep 11, 2026
Merged

SK-3133 Add unary vs. bulk guidance and concurrency sizing formula to flowvault README#432
Devesh-Skyflow merged 1 commit into
mainfrom
devesh/sk-3133-unary-bulk-concurrency-guidelines

Conversation

@Devesh-Skyflow

Copy link
Copy Markdown
Contributor

What

Documents two things the flowvault README didn't cover yet:

  1. Choosing between unary and bulk — a practical "when to use which" guide (single-event/interactive/own-concurrency → unary; large datasets/imports/ETL/buffered-streaming → bulk), plus the N < batchSize trap where bulk's concurrency resolves to 1 regardless of ..._CONCURRENCY_LIMIT, so it gets none of the batching benefit but still pays the bulk machinery's overhead.
  2. Sizing a concurrency limit — a starting-point formula (concurrency ≈ N_cpu × U_cpu × (1 + W/C)) with guidance to treat it as a baseline to benchmark from, not a final answer, and to raise ..._CONCURRENCY_LIMIT incrementally while watching latency rather than jumping to the formula's theoretical max.

Both sections summarize findings from an SK-3133 performance investigation into unary/bulk connection-pool and concurrency behavior under load.

Where

  • New ## Sizing a concurrency limit subsection at the end of Batching and concurrency.
  • New ## Choosing between unary and bulk subsection after the existing structural Unary vs. bulk comparison table.
  • Table of Contents updated to match.

No code changes — README only.

🤖 Generated with Claude Code

@github-actions

Copy link
Copy Markdown

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

@codecov

codecov Bot commented Sep 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.99%. Comparing base (e70e792) to head (3e78865).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##               main     #432    +/-   ##
==========================================
  Coverage     90.99%   90.99%            
- Complexity        0      545   +545     
==========================================
  Files           174      174            
  Lines          7350     7350            
  Branches       1013     1013            
==========================================
  Hits           6688     6688            
  Misses          437      437            
  Partials        225      225            
Flag Coverage Δ
common 89.15% <ø> (ø)
flowvault 87.93% <ø> (ø)
skyvault 94.95% <ø> (ø)
unittests-flowvault 89.45% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
Module: common 89.15% <ø> (ø)
Module: skyvault 94.95% <ø> (ø)
Module: flowvault 87.93% <ø> (ø)
Service Account 87.36% <ø> (ø)
Vault Data 90.81% <ø> (ø)
Vault Tokens 99.03% <ø> (ø)
Vault Connection 100.00% <ø> (ø)
Vault Controller 82.75% <ø> (ø)
Detect 100.00% <ø> (ø)
Audit 100.00% <ø> (ø)
BIN Lookup 100.00% <ø> (ø)
Config 96.26% <ø> (ø)
Utils 90.36% <ø> (ø)
Errors 100.00% <ø> (ø)
Enums 100.00% <ø> (ø)
Logs 95.60% <ø> (ø)

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e70e792...3e78865. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Devesh-Skyflow
Devesh-Skyflow force-pushed the devesh/sk-3133-unary-bulk-concurrency-guidelines branch from 9f30e9c to e20ad10 Compare September 11, 2026 07:11
@github-actions

Copy link
Copy Markdown

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

@Devesh-Skyflow
Devesh-Skyflow force-pushed the devesh/sk-3133-unary-bulk-concurrency-guidelines branch from e20ad10 to 360236d Compare September 11, 2026 07:13
@github-actions

Copy link
Copy Markdown

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

@Devesh-Skyflow
Devesh-Skyflow force-pushed the devesh/sk-3133-unary-bulk-concurrency-guidelines branch from 360236d to 5775b56 Compare September 11, 2026 07:15
@github-actions

Copy link
Copy Markdown

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

New top-level section (after VaultController -- Unary operations, before
Bulk Insert) covering:
- Unary vs Bulk: when to use each, mirroring the structural comparison
  table already in the README with practical decision guidance.
- The N < batchSize trap where bulk resolves to concurrency=1 with none
  of the batching benefit.
- Concurrency guidelines: a starting-point sizing formula
  (N_cpu x U_cpu x (1 + W/C)) for ..._CONCURRENCY_LIMIT, with guidance
  to benchmark and raise incrementally rather than jump to the
  formula's theoretical max.

Also renames the existing structural comparison heading from
"Unary vs. bulk" to "Unary vs. bulk Parity" to disambiguate it from
the new guidance section's title.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Devesh-Skyflow
Devesh-Skyflow force-pushed the devesh/sk-3133-unary-bulk-concurrency-guidelines branch from 5775b56 to 3e78865 Compare September 11, 2026 07:18
@github-actions

Copy link
Copy Markdown

Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

@Devesh-Skyflow
Devesh-Skyflow merged commit 24ad863 into main Sep 11, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant