Frequently Asked Questions
If you're new to Sauce Connect Proxy or troubleshooting, this list of frequently asked questions can help you with what you need to know.
What outbound ports do I need open for Sauce Connect Proxy?
Sauce Connect Proxy can only communicate with Sauce Labs via port 443
. This is not configurable.
Sauce Connect Proxy requires outbound access to several Sauce Labs REST API endpoints (over HTTPS) and the Sauce Connect Server (over TLS1.2-encrypted KGP). For more information, see Data Center Endpoints.
When do I need to use Port 443 and how does it relate to the --proxy flag?
Port 443 is the typical default port for HTTPS traffic. Sauce Connect will use port 443 when sending traffic to your network when trying to reach the site(s) under test.
You can use the --proxy
command-line option to specify the hostname:port
of the proxy for all Sauce Connect Proxy traffic to the site(s) under test.
Some companies have it setup where you MUST pass traffic through a proxy to reach the internet.
See also Sauce Connect Proxy Setup with Additional Proxies.
How can I share a Sauce Connect Proxy tunnel between multiple accounts?
To share a tunnel, start a tunnel with the --shared-tunnel
flag. For most Sauce Labs customers, your access to shared tunnels is determined by the permissions of the user who creates them. Organization admins can create tunnels that any user on any team can use. Team admins can create tunnels that any member of their team can use. Team members cannot share tunnels they create with any other team member.
In order to use a tunnel that an admin or team member shares with you, you'll
need to add tunnelOwner
to your test capabilities and specify that person's username.
How can I use Sauce Connect Proxy to test graceful degradation?
You can use the --fast-fail-regexps
command-line option to drop requests that fit a description altogether. It can be used to simulate non-loading of scripts, styles, or other resources.
This flag can contain a list of regex that will match the domain that wants to be blocked. Example:
Entering this code -- (www.)?google-analytics.com,(www.)?googletagmanager.com,([a-z0 9]+[.])*google.com,([a-z0-9]+[.])+facebook.com
-- will block the following domains:
www.google-analytics.com
google-analytics.com
google.com
and any subdomain ofgoogle.com
- Any subdomain of
facebook.com
, but notfacebook.com
Can I access apps on localhost?
You can access localhost
through Sauce Connect on Virtual Desktop Browser tests. However, you cannot proxy localhost
or 127.0.0.1 connections on any Mobile tests, whether they are Emulators, Simulators, or Real Devices.
When using Sauce Connect Proxy, local websites running on commonly used ports are available to test at localhost
or 127.0.0.1 URLs. The exception is when testing on Real or Virtual Mobile Devices. Real and Virtual Mobile tests require changes to the /etc/hosts
file where Sauce Connect Proxy is hosted. For more information, see Testing Mobile Devices Against localhost.
For all platforms, tests may perform better when using a locally defined domain name (which can be set in your hosts
file) rather than localhost
. Using a locally defined domain name also allows access to apps on any port. If you are using a parent proxy with Sauce Connect, you may need the --proxy-localhost
flag.
See also Supported Browsers and Ports Specification.
How can I improve tunnel performance?
See Improving Sauce Connect Proxy Performance.
Supported Browsers and Ports
See Supported Browsers and Ports Specification.
What are the optimal open file settings?
The open file limit on macOS and other Unix-based systems limits the number of open file descriptors. Since a file descriptor is opened for each network connection, the open file limit also restricts the number of open network connections. Under normal usage, Sauce Connect Proxy can easily reach the default limit (1024 in most cases). This causes each new connection to time out, and results in failed tests. Modern systems allow much higher limits without any visible impact on memory, so we recommend setting the open file limit to 64000 in order to ensure the open file limit is never an issue for tunneled requests.
If we have five users, should we use five instances of Sauce Connect Proxy or set up one shared instance?
Feel free to do either, even if you only have one Sauce account.
If you do decide to use five separate instances, you'll need to create unique identifiers for each. More information: High Availability Sauce Connect Proxy Setup.
Can I split testing traffic across multiple Sauce Connect Proxy tunnels?
Sauce Connect Proxy offers some options for high availability that enable multiple Sauce Connect Proxy tunnels to be grouped into a pool, which is treated like a single tunnel. This has several advantages, including the ability to distribute the load of test traffic. More information: High Availability Sauce Connect Proxy Setup.
Does Sauce Connect Proxy support running XCUITest and Espresso tests?
Yes. More information: Mobile Testing Frameworks.
How many Sauce Connect Proxy tunnels can I keep open simultaneously?
Your options depend on your license type. More information: System and Network Requirements for Sauce Connect Proxy.
How many tests can I run in each Sauce Connect Proxy tunnel?
There are currently no limits on how many tests you can run in each tunnel, though we may eventually implement limitations to maintain service quality. More information: System and Network Requirements for Sauce Connect Proxy.
Are there restrictions on who can use Sauce Connect Proxy tunnels for real device testing?
No, tunnels to the Real Device Cloud are automatically shared with all of your team members. More information: Security Settings for Organizations.
Can I run tests on Virtual Devices and Real Devices using the same Sauce Connect Proxy tunnel?
Yes, you can use the same Sauce Connect Proxy tunnel and/or same machine to test with the Virtual Device Cloud (VDC) and Real Device Cloud (RDC).
Are there any special parameters when using a PAC file in real device tests?
No, though you cannot use the localhost
address with iOS and Android.
Will Sauce Connect Proxy work with dynamic allocation of real devices?
Yes.
Can you allowlist IP addresses instead of using Sauce Connect Proxy?
To create a secure connection, we strongly recommend using Sauce Connect Proxy or Sauce IPSec Proxy instead of allowlisting IP ranges. For more information, see Why Sauce Labs Recommends Sauce Connect Proxy Over Allowlisting IP Addresses.
Where can I get more in-depth information about Sauce Connect Proxy?
Sauce Connect Proxy white paper contains an in-depth overview of the proxy and its security.
What is KGP in Sauce Connect Proxy logs?
See Sauce Connect Tunneling Protocol documentation.