Skip to content

fix: Document missing HTTP rate-control metrics in deployment guide#1729

Merged
phillipleblanc merged 1 commit into
trunkfrom
fix/http-rate-control-metrics
May 15, 2026
Merged

fix: Document missing HTTP rate-control metrics in deployment guide#1729
phillipleblanc merged 1 commit into
trunkfrom
fix/http-rate-control-metrics

Conversation

@lukekim
Copy link
Copy Markdown
Contributor

@lukekim lukekim commented May 14, 2026

Summary

website/docs/components/data-connectors/https/deployment.md (introduced in #1636) listed only 5 of the 14 rate-control metrics that the HTTP connector actually emits. Operators relying on the deployment guide to set up dashboards would miss the in-flight, permit, wait-duration, and Retry-After cooldown metrics — which are precisely the ones needed to diagnose rate-limit issues.

Changes

Added a Type column and 9 missing metric rows in the Metrics section:

  • inflight_operations
  • rate_control_available_permits
  • rate_control_acquisitions_total
  • rate_control_acquire_errors_total
  • rate_control_wait_duration_ms
  • rate_limit_retry_after_updates_total
  • rate_limit_retry_after_waits_total
  • rate_limit_retry_after_wait_duration_ms
  • rate_limit_retry_after_remaining_ms

Names and descriptions copied verbatim from HTTP_RATE_CONTROL_METRIC_SPECS in source.

Reference

Verified against spiceai/spiceai trunkcrates/runtime/src/dataconnector/http_rate_control.rs lines 311-392 (HTTP_RATE_CONTROL_METRIC_SPECS array).

vNext-only — the https/deployment.md file does not exist in any website/versioned_docs/version-*/ directory.

Test plan

  • cd website && npm run build passes locally
  • All metric names match the literal strings in MetricSpec::new(...) calls
  • No metric name was invented from context — every row corresponds to a verbatim source string

@lukekim lukekim added documentation Improvements or additions to documentation area/docs labels May 14, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://6994adad.spiceai-org-website.pages.dev

@phillipleblanc phillipleblanc merged commit 98d84ff into trunk May 15, 2026
6 of 11 checks passed
@phillipleblanc phillipleblanc deleted the fix/http-rate-control-metrics branch May 15, 2026 01:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants