Network logs

Network Logs capture performance data such as network traffic, latency, HTTP requests and responses in the HAR (HTTP Archive) format. You can leverage network logs to get a clear picture of all the network requests (e.g. REST API calls) originating from your app, and the time taken for each of these requests. It can help you identify performance bottenecks or debug failed REST API responses. You can visualize HAR files using the HAR Viewer.

Network logs are disabled by default. To enable network logs, use the browserstack.networkLogs capability.

Capability Description Value
browserstack.networkLogs Capture network logs for your test true, false
Default: false

Example :

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.networkLogs", "true");
var capabilities = {
	'browserstack.networkLogs': 'true',
}
DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.networkLogs", "true");
$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.networkLogs", "true");
desired_cap = {
	'browserstack.networkLogs': 'true'
}
desired_caps = {
    'browserstack.networkLogs': 'true'
}
Note: Network logs feature for app testing is only available with a BrowserStack paid plan. View details.

Access network logs from the dashboard:

The network logs can be viewed from the test sessions details page on the App Automate Dashboard. You can download network logs using the Raw Network Logs link.

View network logs in App Automate dashboard

Example network logs:

Sample Network Logs output

Import network logs using REST API:

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" -X GET "https://api-cloud.browserstack.com/app-automate/builds/<build-id>/sessions/<session-id>/networklogs"

Handling certificate pinning issues

App developers may use certificate pinning techniques to prevent man-in-the-middle attacks and thus enhance the app’s security. Using certificate pinning, the app developer can associate (or “pin”) a remote host or service with its certificate / public keys at the time of development. When the app makes a network request to a remote host, it compares the pinned certificate with the remote server’s certificate to verify its identity.

However, on BrowserStack, if you have enabled network logs, your tests could fail if your app uses certificate pinning. This is because BrowserStack uses a MITM proxy to capture the network logs, causing network requests between the app and pinned hosts to fail.

BrowserStack provides you additional capabilities to fix certificate pinning errors. Using these capabilities, you can bypass BrowserStack’s MITM proxy while making requests to certificate-pinned remote hosts.

browserstack.networkLogsExcludeHosts

Capability Description Value
browserstack.networkLogsExcludeHosts Use this capability to specify a list of certificate pinned hosts that should bypass BrowserStack MITM proxy while capturing network logs. By doing so, your tests can execute successfully while still capturing network logs for all other remaining hosts. List of certificate pinned hosts (Array) or regex value (String)

For example, this will exclude capturing of logs for any requests made to api.example.com and google.com:

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.networkLogsExcludeHosts", new String[]{"api.example.com", "google.com"});
var capabilities = {
	'browserstack.networkLogsExcludeHosts': ['api.example.com', 'google.com'],
}
DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.networkLogsExcludeHosts", new[] {'api.example.com', 'google.com'});
$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.networkLogsExcludeHosts", ["api.example.com", "google.com"]);
desired_cap = {
	'browserstack.networkLogsExcludeHosts': ['api.example.com', 'google.com']
}
desired_caps = {
    'browserstack.networkLogsExcludeHosts': ['api.example.com', 'google.com']
}

Instead of using an array, you can also pass a regex value as a string to dynamically match a list of hosts. For example, this will exclude capturing of logs for any requests made to example.com and its subdomains.

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.networkLogsExcludeHosts", "^(.+\.)?example.com");
var capabilities = {
	'browserstack.networkLogsExcludeHosts': '^(.+\.)?example.com',
}
DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.networkLogsExcludeHosts", "^(.+\.)?example.com");
$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.networkLogsExcludeHosts", "^(.+\.)?example.com");
desired_cap = {
	'browserstack.networkLogsExcludeHosts': '^(.+\.)?example.com'
}
desired_caps = {
    'browserstack.networkLogsExcludeHosts': '^(.+\.)?example.com'
}

browserstack.networkLogsIncludeHosts

Capability Description Value
browserstack.networkLogsIncludeHosts Use this capability if you wish to capture network logs only for specific hosts. Traffic for all other remaining hosts will bypass BrowserStack MITM proxy and won’t be captured in network logs. List of hosts (Array) or regex value (String)

For example, this will capture logs only for network requests made to api.example.com and google.com

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.networkLogsIncludeHosts", new String[]{"api.example.com", "google.com"});
var capabilities = {
	'browserstack.networkLogsIncludeHosts': ['api.example.com', 'google.com'],
}
DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.networkLogsIncludeHosts", new[] {'api.example.com', 'google.com'});
$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.networkLogsIncludeHosts", ["api.example.com", "google.com"]);
desired_cap = {
	'browserstack.networkLogsIncludeHosts': ['api.example.com', 'google.com']
}
desired_caps = {
    'browserstack.networkLogsIncludeHosts': ['api.example.com', 'google.com']
}

Instead of using an array, you can also pass a regex value as a string to dynamically match a list of hosts. For example, this will capture logs for any network requests made to example.com and its subdomains.

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.networkLogsIncludeHosts", "^(.+\.)?example.com");
var capabilities = {
	'browserstack.networkLogsIncludeHosts': '^(.+\.)?example.com',
}
DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.networkLogsIncludeHosts", "^(.+\.)?example.com");
$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.networkLogsIncludeHosts", "^(.+\.)?example.com");
desired_cap = {
	'browserstack.networkLogsIncludeHosts': '^(.+\.)?example.com'
}
desired_caps = {
    'browserstack.networkLogsIncludeHosts': '^(.+\.)?example.com'
}
Note:
  1. You may experience minor impact on test execution speed when Network Logs are enabled.

We're sorry to hear that. Please share your feedback so we can do better







Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better







Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Talk to an Expert