Merge pull request #270320 from ninallam/ninallam-app-service

Create load test in App Service

Author: JamesJBarnett

articles/load-testing/concept-load-test-app-service.md

@@ -36,17 +36,13 @@ You can create a load test to simulate traffic to your application on Azure App
 
 After you create and run a load test, you can [monitor the resource metrics](#monitor) for the web application and all dependent Azure components to identify performance and scalability issues.
 
-### Create a URL-based quick test
+### Create a URL-based load test
 
-You can use the quick test experience to create a load test for a specific endpoint URL, directly from within the Azure portal. For example, use the App Service web app *default domain* to perform a load test of the web application home page.
-
-When you create a URL-based test, you specify the endpoint and basic load test configuration settings, such as the number of [virtual users](./concept-load-testing-concepts.md#virtual-users), test duration, and [ramp-up time](./concept-load-testing-concepts.md#ramp-up-time).
+You can create a URL-based load test directly from your Azure App Service web app in the Azure portal. When you create the load test, you can select a specific deployment slot and use the prepopulated endpoint URL.
 
 The following screenshot shows how to create a URL-based load test in the Azure portal.
 
-:::image type="content" source="./media/concept-load-test-app-service/create-quick-test-app-service.png" alt-text="Screenshot that shows the Create quick test in the Azure portal." lightbox="./media/concept-load-test-app-service/create-quick-test-app-service.png":::
-
-Get started by [creating a URL-based load test](./quickstart-create-and-run-load-test.md).
+Get started by [creating a URL-based load test for Azure App Service](./how-to-create-load-test-app-service.md).
 
 ### Create a load test by uploading a JMeter script
 
@@ -61,7 +57,7 @@ Azure Load Testing provides high-fidelity support of JMeter. You can create a ne
 
 Get started [create a load test by uploading a JMeter script](./how-to-create-and-run-load-test-with-jmeter-script.md).
 
-If you previously created a [URL-based test](#create-a-url-based-quick-test), Azure Load Testing generates a JMeter test script. You can download this generated test script, modify or extend it, and then reupload the script.
+If you previously created a [URL-based test](#create-a-url-based-load-test), Azure Load Testing generates a JMeter test script. You can download this generated test script, modify or extend it, and then reupload the script.
 
 <a name="monitor"/>
 ## Monitor your apps for bottlenecks and provisioning issues 
@@ -74,13 +70,13 @@ During a load test, Azure Load Testing collects [metrics](./concept-load-testing
 
 Use the Azure Load Testing dashboard to analyze the test run metrics and identify performance bottlenecks in your application, or find out if you over-provisioned some compute resources. For example, you could evaluate if the service plan instances are right-sized for your workload.
 
-:::image type="content" source="media/concept-load-test-app-service/load-test-results-dashboard.png" alt-text="Screenshot that shows the load test results dashboard in the Azure portal." lightbox="media/concept-load-test-app-service/load-test-results-dashboard.png":::
+:::image type="content" source="./media/concept-load-test-app-service/load-test-results-dashboard.png" alt-text="Screenshot that shows the load test results dashboard in the Azure portal." lightbox="./media/concept-load-test-app-service/load-test-results-dashboard.png":::
 
 Learn more about how to [monitor server-side metrics in Azure Load Testing](./how-to-monitor-server-side-metrics.md).
 
 For applications that are hosted on Azure App Service, you can use [App Service diagnostics](/azure/app-service/overview-diagnostics) to get extra insights into the performance and health of the application. When you add an app service application component to your load test configuration, the load testing dashboard provides a direct link to the App Service diagnostics dashboard for your App service resource.
 
-:::image type="content" source="media/concept-load-test-app-service/test-result-app-service-diagnostics.png" alt-text="Screenshot that shows the 'App Service' section on the load testing dashboard in the Azure portal." lightbox="media/concept-load-test-app-service/test-result-app-service-diagnostics.png":::
+:::image type="content" source="./media/concept-load-test-app-service/test-result-app-service-diagnostics.png" alt-text="Screenshot that shows the 'App Service' section on the load testing dashboard in the Azure portal." lightbox="./media/concept-load-test-app-service/test-result-app-service-diagnostics.png":::
 
 ## Customize your load test's failure criteria
 
@@ -100,13 +96,12 @@ One example is using a parameter as an environment variable so you can avoid sto
 
 Another use for parameters is when you want to reuse your test script across multiple [Azure App Service deployment slots](/azure/app-service/deploy-staging-slots). Deployment slots are live apps with their own host names and separate URLs. Use a parameter for the application endpoint and then you can set up staging environments for your application. 
 
-:::image type="content" source="media/concept-load-test-app-service/quick-test-parameters.png" alt-text="Screenshot that shows the Parameters page of a quick test in the Azure portal, highlighting the parameters for the target URL." lightbox="media/concept-load-test-app-service/quick-test-parameters.png":::
+:::image type="content" source="./media/concept-load-test-app-service/quick-test-parameters.png" alt-text="Screenshot that shows the Parameters page of a quick test in the Azure portal, highlighting the parameters for the target URL." lightbox="./media/concept-load-test-app-service/quick-test-parameters.png":::
 
 
 ## Next steps
 
 Learn how to:
-- [Start create a URL-based load test](./quickstart-create-and-run-load-test.md).
-- [Identify performance bottlenecks](./tutorial-identify-bottlenecks-azure-portal.md) for Azure applications.
-- [Configure your test for high-scale load](./how-to-high-scale-load.md).
+- [Create a URL-based load test for Azure App Service](./how-to-create-load-test-app-service.md).
 - [Configure automated performance testing](./quickstart-add-load-test-cicd.md).
+- [Identify performance bottlenecks](./tutorial-identify-bottlenecks-azure-portal.md) for Azure applications.

articles/load-testing/how-to-create-load-test-app-service.md

@@ -0,0 +1,121 @@
+---
+title: Create load tests in App Service
+titleSuffix: Azure Load Testing
+description: Learn how to create a load test for an Azure App Service web app with Azure Load Testing.
+services: load-testing
+ms.service: load-testing
+ms.author: ninallam
+author: ninallam
+ms.date: 02/17/2024
+ms.topic: how-to
+---
+
+# Create a load test for Azure App Service web apps
+
+In this article, you learn how to create a load test for an Azure App Service web app with Azure Load Testing. Directly create a URL-based load test from your app service in the Azure portal, and then use the load testing dashboard to analyze performance issues and identify bottlenecks.
+
+With the integrated load testing experience in Azure App Service, you can:
+
+- Create a [URL-based load test](./quickstart-create-and-run-load-test.md) for the app service endpoint or a deployment slot
+- View the test runs associated with the app service
+- Create a load testing resource
+
+> [!IMPORTANT]
+> This feature is currently supported through Microsoft Developer Community. If you are facing any issues, please report it [here](https://developercommunity.microsoft.com/loadtesting/report).
+
+## Prerequisites
+
+- An Azure account with an active subscription. If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
+- An Azure App Service web app. If you need to create a web app, see the [App Service Getting started documentation](/azure/app-service/getting-started).
+
+## Create a load test for a web app
+
+You can create a URL-based load test directly from your Azure App Service web app in the Azure portal.
+
+To create a load test for a web app:
+
+1. In the [Azure portal](https://portal.azure.com), go to your Azure App Service web app.
+
+1. On the left pane, select **Load Testing (Preview)** under the **Performance** section.
+
+    On this page, you can see the list of tests and the load test runs for this web app.
+   
+:::image type="content" source="./media/how-to-create-load-test-app-service/app-service-load-testing.png" lightbox="./media/how-to-create-load-test-app-service/app-service-load-testing.png" alt-text="Screenshot that shows Load Testing page in App Service.":::
+
+1. Optionally, select **Create load testing resource** if you don't have a load testing resource yet.
+
+1. Select **Create test** to start creating a URL-based load test for the web app.
+
+1. On the **Create test** page, first enter the test details:
+
+    |Field  |Description  |
+    |-|-|
+    | **Load Testing Resource**    | Select your load testing resource. |
+    | **Test name**                | Enter a unique test name. |
+    | **Test description**         | (Optional) Enter a load test description. |
+    | **Run test after creation**  | When selected, the load test starts automatically after creating the test. |
+
+1. If you have multiple deployment slots for the web app, select the **Slot** against which to run the load test.
+
+   :::image type="content" source="./media/how-to-create-load-test-app-service/app-service-create-test-resource-configuration.png" lightbox="./media/how-to-create-load-test-app-service/app-service-create-test-resource-configuration.png" alt-text="Screenshot that shows the resource configuration page for creating a test in App Service.":::
+
+1. Select **Add request** to add HTTP requests to the load test:
+
+    On the **Add request** page, enter the details for the request:
+
+    |Field  |Description  |
+    |-|-|
+    | **Request name** | Unique name within the load test to identify the request. You can use this request name when [defining test criteria](./how-to-define-test-criteria.md). |
+    | **URL**          | Select the base URL for the web endpoint |
+    | **Path**         | (Optional) Enter a URL path name within the web endpoint. The path is appended to the URL to form the endpoint that is load tested.  |
+    | **HTTP method**  | Select an HTTP method from the list. Azure Load Testing supports GET, POST, PUT, DELETE, PATCH, HEAD, and OPTIONS. |
+    | **Query parameters** | (Optional) Enter query string parameters to append to the URL. |
+    | **Headers**          | (Optional) Enter HTTP headers to include in the HTTP request. |
+    | **Body**             | (Optional) Depending on the HTTP method, you can specify the HTTP body content. Azure Load Testing supports the following formats: raw data, JSON view, JavaScript, HTML, and XML. |
+
+    Learn more about [adding HTTP requests to a load test](./how-to-add-requests-to-url-based-test.md).
+
+1. Select the **Load configuration** tab to configure the load parameters for the load test.
+
+
+    |Field  |Description  |
+    |-|-|
+    | **Engine instances**            | Enter the number of load test engine instances. The load test runs in parallel across all the engine instances. |
+    | **Load pattern**                | Select the load pattern (linear, step, spike) for ramping up to the target number of virtual users. |
+    | **Concurrent users per engine** | Enter the number of *virtual users* to simulate on each of the test engines. The total number of virtual users for the load test is: #test engines * #users per engine. |
+    | **Test duration (minutes)** | Enter the duration of the load test in minutes. |
+    | **Ramp-up time (minutes)**  | Enter the ramp-up time of the load test in minutes. The ramp-up time is the time it takes to reach the target number of virtual users. |
+
+1. Optionally, configure the network settings if the web app is not publicly accessible.
+
+    Learn more about [load testing privately hosted endpoints](./how-to-test-private-endpoint.md).
+
+   :::image type="content" source="./media/how-to-create-load-test-app-service/app-service-create-test-load-configuration.png" lightbox="./media/how-to-create-load-test-app-service/app-service-create-test-load-configuration.png" alt-text="Screenshot that shows the load configuration page for creating a test in App Service.":::
+
+
+1. Select **Review + create** to review the test configuration, and then select **Create** to create the load test.
+
+    Azure Load Testing now creates the load test. If you selected **Run test after creation** previously, the load test starts automatically.
+   
+> [!NOTE]
+> If the test was converted from a URL test to a JMX test directly from the Load Testing resource, the test cannot be modified from the App Service.
+
+## View test runs
+
+You can view the list of test runs and a summary overview of the test results directly from within the web app configuration in the Azure portal.
+
+1. In the [Azure portal](https://portal.azure.com), go to your Azure App Service web app.
+
+1. On the left pane, select **Load testing**.
+
+1. In the **Test runs** tab, you can view the list of test runs for your web app.
+
+    For each test run, you can view the test details and a summary of the test outcome, such as average response time, throughput, and error state.
+
+1. Select a test run to go to the Azure Load Testing dashboard and analyze the test run details.
+
+   :::image type="content" source="./media/how-to-create-load-test-app-service/app-service-test-runs-list.png" lightbox="./media/how-to-create-load-test-app-service/app-service-test-runs-list.png" alt-text="Screenshot that shows the test runs list in App Service.":::
+
+## Next steps
+
+- Learn more about [load testing Azure App Service applications](./concept-load-test-app-service.md).

articles/load-testing/index.yml

@@ -90,6 +90,8 @@ landingContent:
             url: quickstart-add-load-test-cicd.md
           - text: Manually add load tests to CI/CD
             url: how-to-configure-load-test-cicd.md
+          - text: Test App Service web apps
+            url: how-to-create-load-test-app-service.md
 
   # Card
   - title: Analyze test results

articles/load-testing/media/how-to-create-load-test-app-service/app-service-create-test-load-configuration.png

@@ -53,6 +53,8 @@ items:
           href: how-to-define-test-criteria.md
         - name: Parameterize load tests
           href: how-to-parameterize-load-tests.md
+        - name: Test App Service web apps
+          href: how-to-create-load-test-app-service.md
         - name: Test private endpoints
           displayName: virtual network, vnet, hybrid, on-premises, onprem, private link, subnet
           href: how-to-test-private-endpoint.md