Enable and configure network logs for Appium tests

If you use the BrowserStack SDK, set the following capability in the browserstack.yml file:

After you enable network logs, the Network Logs tab on the dashboard shows the captured requests:

Capture response content

By default, network logs record request and response metadata but not response bodies. To capture the response payload shown under the Response tab, set captureContent to true within networkLogsOptions. The following table describes the capability:

Use the following code snippet to set the network log configurations:

Capture logs only for specific hosts

Use networkLogsIncludeHosts to capture network logs only for specific hosts. Traffic for all other hosts bypasses the BrowserStack MITM proxy and isn’t captured in network logs. Pass this capability at the top level, not inside networkLogsOptions.

The following example captures logs only for requests made to google.com:

Instead of a list, you can pass a regex value as a string. The following example captures logs for requests made to example.com and its subdomains:

Set the network logs capability to true based on the protocol your test uses:

DesiredCapabilities capabilities = new DesiredCapabilities();
HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
browserstackOptions.put("networkLogs", "true");
capabilities.setCapability("bstack:options", browserstackOptions);

var capabilities = {
	'bstack:options' : {
		"networkLogs" : "true",
	},
}

AppiumOptions capabilities = new AppiumOptions();
Dictionary<string, object> browserstackOptions = new Dictionary<string, object>();
browserstackOptions.Add("networkLogs", "true");
capabilities.AddAdditionalCapability("bstack:options", browserstackOptions);

$caps = array(
    'bstack:options' => array(
        "networkLogs" => "true",
    ),
);

desired_cap = {
	'bstack:options' : {
		"networkLogs" : "true",
	},
}

capabilities = {
    'bstack:options' => {
        "networkLogs" => "true",
    },
}

DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("browserstack.networkLogs", "true");

var capabilities = {
	'browserstack.networkLogs' : 'true',
}

AppiumOptions capabilities = new AppiumOptions();
capabilities.AddAdditionalCapability("browserstack.networkLogs", "true");

$caps = array(
    "browserstack.networkLogs" => "true"
);

desired_cap = {
	'browserstack.networkLogs' : 'true'
}

caps = Selenium::WebDriver::Remote::Capabilities.new
caps["browserstack.networkLogs"] = "true"

After you enable network logs, the Network Logs tab on the dashboard shows the captured requests:

Capture response content

By default, network logs record request and response metadata but not response bodies. To capture the response payload shown under the Response tab, set captureContent to true within browserstack.networkLogsOptions. The following table describes the capability:

Use the following code snippet to set the network log configurations:

DesiredCapabilities capabilities = new DesiredCapabilities();
HashMap<String, Boolean> networkLogsOptions = new HashMap<>();
networkLogsOptions.put("captureContent", true);
capabilities.setCapability("browserstack.networkLogs", true);
capabilities.setCapability("browserstack.networkLogsOptions", networkLogsOptions);

var capabilities = {
 "browserstack.networkLogs" : "true",
 "browserstack.networkLogsOptions": {
   "captureContent": "true"
 }
}

AppiumOptions capabilities = new AppiumOptions();
Dictionary<string, object> networkLogsOptions = new Dictionary<string, object>();
networkLogsOptions.Add("captureContent", "true");
capabilities.AddAdditionalCapability("browserstack.networkLogs", "true");
capabilities.AddAdditionalCapability("browserstack.networkLogsOptions", networkLogsOptions);

$caps = array(
 "browserstack.networkLogs" => "true",
 "browserstack.networkLogsOptions" => array (
   "captureContent" => "true"
 )
);

desired_cap = { 
"browserstack.networkLogs" : "true",
"browserstack.networkLogsOptions": {
    "captureContent": "true"
  }
}

caps = Selenium::WebDriver::Remote::Capabilities.new
networkLogsOptions = Hash.new
networkLogsOptions["captureContent"] = "true"
caps["browserstack.networkLogs"] = "true"
caps["browserstack.networkLogsOptions"] = networkLogsOptions

Capture logs only for specific hosts

Use the include hosts capability to capture network logs only for specific hosts. Traffic for all other hosts bypasses the BrowserStack MITM proxy and isn’t captured in network logs.

DesiredCapabilities capabilities = new DesiredCapabilities();
HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
browserstackOptions.put("networkLogs", "true");
browserstackOptions.put("networkLogsIncludeHosts", new String[]{"api.example.com", "google.com"});
capabilities.setCapability("bstack:options", browserstackOptions);

var capabilities = {
	'bstack:options' : {
		'networkLogs': 'true',
		'networkLogsIncludeHosts': ['api.example.com', 'google.com'],
	}
}

AppiumOptions capabilities = new AppiumOptions();
Dictionary<string, object> browserstackOptions = new Dictionary<string, object>();
browserstackOptions.Add("networkLogs", "true");
browserstackOptions.Add("networkLogsIncludeHosts", new[] {"api.example.com", "google.com"});
capabilities.AddAdditionalCapability("bstack:options", browserstackOptions);

$caps = array(
	'bstack:options' => array(
		"networkLogs" => "true",
		"networkLogsIncludeHosts" => ["api.example.com", "google.com"],
	),
);

desired_cap = {
	'bstack:options' : {
		'networkLogs': 'true',
		'networkLogsIncludeHosts': ['api.example.com', 'google.com']
	}
}

capabilities = {
    'bstack:options' => {
        'networkLogs' => 'true',
        'networkLogsIncludeHosts' => ['api.example.com', 'google.com']
    }
}

DesiredCapabilities capabilities = new DesiredCapabilities();
HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
browserstackOptions.put("networkLogs", "true");
browserstackOptions.put("networkLogsIncludeHosts", "^(.+\\.)?example.com");
capabilities.setCapability("bstack:options", browserstackOptions);

var capabilities = {
	'bstack:options' : {
		'networkLogs': 'true',
		'networkLogsIncludeHosts': '^(.+\\.)?example.com',
	}
}

AppiumOptions capabilities = new AppiumOptions();
Dictionary<string, object> browserstackOptions = new Dictionary<string, object>();
browserstackOptions.Add("networkLogs", "true");
browserstackOptions.Add("networkLogsIncludeHosts", @"^(.+\.)?example.com");
capabilities.AddAdditionalCapability("bstack:options", browserstackOptions);

$caps = array(
	'bstack:options' => array(
		"networkLogs" => "true",
		"networkLogsIncludeHosts" => '^(.+\.)?example.com',
	),
);

desired_cap = {
	'bstack:options' : {
		'networkLogs': 'true',
		'networkLogsIncludeHosts': r'^(.+\.)?example.com'
	}
}

capabilities = {
    'bstack:options' => {
        'networkLogs' => 'true',
        'networkLogsIncludeHosts' => '^(.+\.)?example.com'
    }
}

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.networkLogs", "true");
desiredCapabilities.setCapability("browserstack.networkLogsIncludeHosts", new String[]{"api.example.com", "google.com"});

var capabilities = {
	'browserstack.networkLogs': 'true',
	'browserstack.networkLogsIncludeHosts': ['api.example.com', 'google.com'],
}

DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.networkLogs", "true");
capability.SetCapability("browserstack.networkLogsIncludeHosts", new[] {"api.example.com", "google.com"});

$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.networkLogs", "true");
$capabilities->setCapability("browserstack.networkLogsIncludeHosts", ["api.example.com", "google.com"]);

desired_cap = {
	'browserstack.networkLogs': 'true',
	'browserstack.networkLogsIncludeHosts': ['api.example.com', 'google.com']
}

desired_caps = {
    'browserstack.networkLogs' => 'true',
    'browserstack.networkLogsIncludeHosts' => ['api.example.com', 'google.com']
}

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.networkLogs", "true");
desiredCapabilities.setCapability("browserstack.networkLogsIncludeHosts", "^(.+\\.)?example.com");

var capabilities = {
	'browserstack.networkLogs': 'true',
	'browserstack.networkLogsIncludeHosts': '^(.+\\.)?example.com',
}

DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.networkLogs", "true");
capability.SetCapability("browserstack.networkLogsIncludeHosts", @"^(.+\.)?example.com");

$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.networkLogs", "true");
$capabilities->setCapability("browserstack.networkLogsIncludeHosts", '^(.+\.)?example.com');

desired_cap = {
	'browserstack.networkLogs': 'true',
	'browserstack.networkLogsIncludeHosts': r'^(.+\.)?example.com'
}

desired_caps = {
    'browserstack.networkLogs' => 'true',
    'browserstack.networkLogsIncludeHosts' => '^(.+\.)?example.com'
}