Skip to content

Commit

Permalink
Updated Network Logs Documents as per React UI (#360)
Browse files Browse the repository at this point in the history
  • Loading branch information
sangithravichandran authored Feb 22, 2024
1 parent f6ca95c commit a94b0d1
Showing 1 changed file with 20 additions and 23 deletions.
43 changes: 20 additions & 23 deletions src/pages/docs/desired-capabilities/network-logs.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
---
title: "Network Logs"
page_title: "Network Logs in Testsigma: Track and Analyze Application Network Activity"
metadesc: "Use Testsigma's Network Logs feature to track and analyze network activity. You can gain insights into requests, responses, and performance optimization. Start optimizing your application's network behavior today."
page_title: "Network Logs: Analyse Application Network Activity"
metadesc: "Explore comprehensive network log features for insightful test execution analysis. Capture, analyse, and debug network interactions seamlessly."
noindex: false
order: 15.92
page_id: "Network Logs"
page_id: "network-log-management"
search_keyword: ""
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Enable Network Logs in Test Case"
url: "#enable-network-logs-in-test-case"
Expand All @@ -27,45 +30,39 @@ Testsigma allows you to capture and analyse network traffic during test executio

This documentation will guide you on how to enable the network log in Test Case and Test Plan, access, view the status, and download network logs in the ad-hoc run page and the run test case page.

[[info | NOTE:]]
| Network Log will be enabled by default for Web and Mobile Web applications, but you must manually enable it for Android and iOS applications.

---

### **Prerequisites**
## **Prerequisites**

Before starting, understand the concepts of [Projects](https://testsigma.com/docs/projects/overview/), [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), [Test Plans](https://testsigma.com/docs/test-management/test-plans/overview/), [Ad-hoc Runs](https://testsigma.com/docs/runs/adhoc-runs/), and [Test Machines](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/) in Testsigma. Familiarising yourself with these concepts will make working with the Network Log feature easier.

[[info | Note:]]
| By default, Network Log is enabled for Web and Mobile Web applications, but for Android and iOS applications, you need to enable it manually.


---

## **Enable Network Logs in Test Case**

1. Click **Run** in the top right corner of the screen on the **Test Case** page. ![Run in Test Case Page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/run_testcase_nl.png)
2. Select **BrowserStack** as a **Test Lab** on the **Ad-hoc Run** page on the right side of the screen, enable the **Network Log toggle**, and click **Run Now** to start Test Execution. ![BrowserStack as a Test Lab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/bs_togglenl_ts.png)

Here is a quick GIF demonstrating the above workflow: ![Enable Network Logs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/enable_networklog.gif)
1. Click **Run** in the top right corner of the screen on the Test Case details page.
2. Select **BrowserStack** as a Test Lab on the **Ad-hoc Ru**n page on the right side of the screen, enable the **Network Log** toggle, and click **Run Now** to start Test Execution. ![Enable Network Log in Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/networklogs_adhoc.gif)

---

## **Enable Network Logs in Test Plan**

1. Navigate to the **Test Machines & Suites Selection** tab on the **Create** or **Edit Test Plan** page.
2. Click on **Add Machine/Device** to add a test machine, and click on the **Edit** button in Created Test Machines/Device to edit an existing machine. ![Edit Test Machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/addmachines_testplan_nl.png)
3. On the **Add** or **Edit Machine/Device** page, select **Test Lab Type** as **BrowserStack**, enable the **Network Log toggle**, and click **Update**. ![BrowserStack in Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/bs_togglenl_testplan.png)

Here is a quick GIF demonstrating the above workflow: ![Network Logs for Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/networklog_testplan.gif)
1. Navigate to the **Add Test Suites & Link Machine Profiles** tab on the **Create** or **Edit Test Plan** page.
2. Click the **Test Machine Settings** icon, and the **Adding** or **Editing Test Machine/Device Profiles** overlay will appear.
3. On the **Add** or **Edit Machine/Device Profile** overlay, select Test Lab Type as **BrowserStack**, enable the **Network Log** toggle, and click **Create/Update**. ![Enable Network Logs in Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/networklogs_testplan.gif)

---

## **Network Log Management**

To access and analyse the captured network logs in Testsigma, follow the steps outlined below after completing the test execution on the Run Test Case Page.

1. Navigate to the **Logs** tab on the **Run Test Case** page. ![Run Test Case Page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/runttestcase_logs_ts.png)
2. You will find a section dedicated to the **Network Logs** under the **Logs** tab.
3. You can see a summary of the captured network activity in the **Network Logs Preview**. The preview displays key information, such as request URLs, HTTP methods, status codes, and response sizes. You can quickly scan through the logs to identify any anomalies or errors in the network interactions. ![Network Log Preview](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/nlp_runtestcase_ts.png)
4. Click **Download** in the top-right corner of the screen to download the network log file in **har** format if you want to analyse the network logs offline.
After completing the test execution on the Run Test Case Page, you should follow these steps to access and analyse the captured network logs:

Here is a quick GIF demonstrating the above workflow: ![Network Log Management](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/networkmanagement_ts.gif)
1. Click the **Show Logs** button on the Run Results page and locate the section dedicated to **Network Logs** under the **Logs** tab.
2. In the **Network Logs** Previews, you can see a summary of captured network activity, including request URLs, HTTP methods, status codes, and response sizes. Quickly scan through the logs to identify anomalies or errors in the network interactions.
3. Click **Download Log** File at the top-right of the screen to retrieve the network log file in **HAR** format. You can then analyse the network logs offline. ![View Network Logs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/view_networklogs.gif)

---

0 comments on commit a94b0d1

Please sign in to comment.