When running Sauce Labs tests with Sauce Connect Proxy, there may be situations in which Sauce Connect Proxy doesn't perform as expected. To make sure everything is in working order, you can run Sauce Connect diagnostic tests by appending the
--doctor flag to your command-line.
NOTE: While the
--doctor flag can facilitate debugging, you'll find most valuable troubleshooting information in your verbose logs (which you'd need to enable), as described in Sauce Connect Proxy Troubleshooting.
See the following sections for more information:
Running Tests Using the
--doctor Flag as a Diagnostics Tool
To use the
--doctor flag, you would run the same command for starting the Sauce Connect Proxy, including any additional flags related to your specific tunnel (e.g.,
-x to specify a data center).
NOTE: When adding the
--doctor flag to your code, placement matters. Here's the correct order of flags:
sc -u [Your Sauce Username] -k [Your Sauce Access Key] --doctor
--doctor will run a series of diagnostic operations to verify the following:
- Which DNS servers and SSL certificates can be found in your network when Sauce Connect Proxy boots up
Sauce Connect Proxy outbound connections to:
saucelabs.com on port 443 for the REST API and the primary tunnel connection to the Sauce Labs cloud
gv.symcd.com and g.symd.com on port 443 using the SSL certificates found in your network
- Connectivity to these Sauce Labs REST API calls:
- https://saucelabs.com/rest/v1/[Your Sauce Username]/tunnels
NOTE: Sauce Connect will exit after these checks are performed. A tunnel will not be started.
Identifying and Resolving Common Errors with the
In the table below, you'll find descriptions of the errors that
--doctor will detect and how to resolve them.
failed to fetch PAC file <file>
Indicates the specified PAC file couldn't be downloaded. This may be caused by an incorrect URL, or a network mis-configuration. To troubleshoot this type of issue, try to download the PAC file manually from the machine running Sauce Connect with cURL or another HTTP client.
To debug the PAC file you can create one locally and pass it to Sauce Connect Proxy using the
In Windows, remember to add the drive to the path like this:
failed to fetch or empty PAC file
|Connection to the remote server was successful, but the PAC file was empty or missing.|
both --proxy and --pac are used
|Using both may work, but this is unsupported by Sauce Labs and should only be used if directed by the Sauce Labs support.|
invalid REST URL
|URL specified in the |
failed to find proxy via PAC for <host>
|PAC file was downloaded successfully, but no proxy was found for this host. This may be the result of an incorrect PAC file: make sure a proxy is specified for all the hosts.|
can't resolve 'saucelabs.com'/... tunnel hostname(s) via any DNS server
Please check your firewall and DNS settings.
To troubleshoot this issue, use
your hosts file contains an entry for <host>
If this error occurred, it is likely that your DNS server couldn't resolve saucelabs.com correctly. As a result, Sauce Labs Support might have directed someone at your organization to add the host to /etc/hosts. This is most likely because the DNS system has a special configuration for some hosts.
Please remove this entry from the host file: it's usually
connecting via <proxy> to http://<url>: <error> or connecting to http://<url>: <error>
URL isn't accessible. If you see this error after other errors in the logs, try to fix the previous errors first.
Please refer to the libcurl errors manual to troubleshoot this issue.
SSL connect failed, socket: .<code_number> code: %d
|Secure connection couldn't be established. Please refer to the OpenSSL manual to get more information about the error.|
failed to retrieve certificate chain
|Some X509 certificates couldn't be imported into the SSL library. This may indicate an issue with DNS, or public CAs being unreachable.|
failed to reach https?://google.com
|Sauce Connect client can't reach google.com. This indicates that the client doesn't have full Internet connectivity. It may not be an issue; Sauce Connect only needs access to saucelabs.com and its tunnels.|
If you need more help, please get in touch with our support team at email@example.com.
To better assist you, when creating your support ticket, please include the following information with your request:
- Link to your Sauce Labs test from the Test Results page in Sauce Labs, showing reproduction of the problem
- Your Sauce Connect verbose log, which you can get by adding the
-l sc.logoptions to your Sauce Connect Proxy command line:
sc -u [Your Sauce Username] -k [Your Sauce Access Key] -v -l sc.log
Then, attach the resulting
sc.log file to your support request.