Skip to content

docs: clarify tieredProxyUrls behavior for standalone newUrl() calls#3666

Closed
okwn wants to merge 1 commit into
apify:masterfrom
okwn:docs/proxy-configuration-tiered-behavior
Closed

docs: clarify tieredProxyUrls behavior for standalone newUrl() calls#3666
okwn wants to merge 1 commit into
apify:masterfrom
okwn:docs/proxy-configuration-tiered-behavior

Conversation

@okwn
Copy link
Copy Markdown

@okwn okwn commented May 20, 2026

Summary

Expands the warning for tieredProxyUrls in the proxy management docs to explain exactly what happens when newUrl() / newProxyInfo() are called outside a crawler context — and why.

Why this matters

The existing warning was vague: "Using this configuration through the newUrl calls will not yield the expected results." This leaves users confused about what "unexpected" actually means. The expanded warning now explains:

  • What happens: Tier logic is bypassed; behavior falls back to flat round-robin through all provided URLs in all tiers
  • Why: Tier tracking depends on session state and per-domain error tracking that only exist within a running crawler
  • What to use instead: proxyUrls (simple round-robin) or newUrlFunction (custom logic)

Changes

  • docs/guides/proxy_management.mdx: Expanded the warning block in the "Tiered proxies" section (lines 106-114) to explain the technical mechanism and provide actionable alternatives

Validation

  • npx tsc --noEmit on packages/core/ passes (no code changes)
  • Markdown preview: warning renders correctly in Docusaurus
  • No broken links — all internal references (#crawler-integration) are preserved

The existing warning said 'newUrl calls will not yield the expected results'
without explaining why. Now explicitly states:
- Tier logic is bypassed when calling newUrl/newProxyInfo directly
- Behavior falls back to flat round-robin through ALL tier URLs
- Root cause: tier tracking depends on session state and per-domain
  error tracking that only exist within a running crawler
- Provides explicit alternatives: proxyUrls for simple rotation,
  newUrlFunction for custom logic
@janbuchar janbuchar requested a review from barjin May 21, 2026 06:13
@janbuchar
Copy link
Copy Markdown
Contributor

I think @barjin should be able to evaluate this. On the other hand, we removed the feature for v4, so maybe it doesn't deserve much attention.

Copy link
Copy Markdown
Member

@barjin barjin left a comment

Choose a reason for hiding this comment

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

Thank you @okwn for your contribution.

As @janbuchar mentions, the feature is scheduled for removal in the upcoming major, so we imo do not need to expand on the documentation here.

For this reason, I'll close this PR now. Thank you anyway!

@barjin barjin closed this May 22, 2026
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.

4 participants