Skip to content

Document proxy health check in proxies overview#437

Merged
ehfeng merged 2 commits into
mainfrom
hypeship/proxies-health-check-guidance
Jul 7, 2026
Merged

Document proxy health check in proxies overview#437
ehfeng merged 2 commits into
mainfrom
hypeship/proxies-health-check-guidance

Conversation

@ehfeng

@ehfeng ehfeng commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a "Check proxy health" section to the proxies overview page with guidance on when to run a health check (after creation, after rotating credentials, when a session starts failing) and code samples in TS/Python/Go.

The examples include the optional url parameter to test reachability against a specific target, and an Info callout explains the ISP/datacenter vs residential/mobile nuance and the fact that passing url does not update the proxy's stored health status.

Test plan

  • Preview renders the new section under "Use with browsers" and above "Bypass hosts"
  • Code samples compile against the current SDKs

Note

Low Risk
Documentation-only MDX change with no runtime or API behavior changes.

Overview
Adds a Check proxy health section to proxies/overview.mdx, placed after Use with browsers and before Bypass hosts.

The section documents running proxies.check before attaching a proxy to a session, with optional url to test a specific target instead of Kernel defaults. It includes TypeScript, Python, and Go samples and an Info callout on ISP/datacenter (stable exit IP vs URL reachability) vs residential/mobile (rotating exits), plus that supplying url does not update the proxy's stored health status.

Reviewed by Cursor Bugbot for commit 3ea269b. Bugbot is set up for automated code reviews on this repo. Configure here.

@dprevoznik dprevoznik left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@mintlify

mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Jul 7, 2026, 9:30 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Stale comment

Risk assessment: Very Low

I assessed the actual diff only. This PR adds a short documentation section and examples to proxies/overview.mdx with no production code, configuration, navigation, infrastructure, prompt, auth, billing, permission, or schema changes. I also found no CODEOWNERS file in the workspace, so there wasn't an ownership-review blocker visible from the repository contents.

GitHub already reports this PR as approved, so I’m leaving the risk assessment without adding another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@ehfeng ehfeng marked this pull request as ready for review July 7, 2026 21:48
@ehfeng ehfeng merged commit e0354ea into main Jul 7, 2026
3 checks passed
@ehfeng ehfeng deleted the hypeship/proxies-health-check-guidance branch July 7, 2026 21:48

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk assessment: Very Low

I assessed the actual diff only. This PR adds 24 lines to proxies/overview.mdx: a new documentation section describing proxy health checks, plus TypeScript/JavaScript, Python, and Go examples and an informational note. It doesn't modify production code, shared libraries, navigation/configuration, infrastructure, prompts/model instructions, auth, billing, permissions, or schema behavior.

I found no CODEOWNERS file in the repository checkout, so there wasn't an ownership-review blocker visible from the repo contents. GitHub already reports this PR as approved, and the PR is already merged, so I’m leaving this assessment as a comment without adding another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3ea269b096

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread proxies/overview.mdx
</CodeGroup>

<Info>
For ISP and datacenter proxies the exit IP is stable, so a successful check against a `url` reliably indicates that subsequent sessions will reach the same target from the same IP. For residential and mobile proxies the exit node changes between requests, so the check validates credentials and connectivity but not site-specific reachability. When `url` is provided, the result does not update the proxy's stored health status.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Align datacenter IP rotation guidance

This sentence says datacenter proxies have a stable exit IP and that follow-up sessions will use the same IP, but the existing proxy overview above and proxies/datacenter.mdx both state datacenter proxies rotate per request and recommend ISP/custom for stable IPs. Users checking a target URL for IP allowlists or managed-auth flows will get contradictory guidance and may pick datacenter expecting stability; either update the existing rotation docs if behavior changed or remove datacenter from this claim.

Useful? React with 👍 / 👎.

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.

2 participants