--- id: neoload title: NeoLoad description: Learn about the collection process for the Sumo Logic NeoLoad integration. slug: /help/docs/integrations/webhooks/neoload/ canonical: https://www.sumologic.com/help/docs/integrations/webhooks/neoload/ --- import useBaseUrl from '@docusaurus/useBaseUrl'; Neoload icon The Sumo Logic app for Neoload provides a high-level perspective, enabling monitoring of test execution, completion, termination, and tests in progress. It also tracks targeted projects, tests, scenarios, and workspaces while assessing overall test and quality status. Also the dashboards delve deeper into performance testing, offering insights into test frequency, test organization by workspace and projects, and various trends and tests with execution time and max virtual users (VUs). The app empowers users to make data-driven decisions, optimize testing strategies, and enhance overall performance testing efficiency. NeoLoad is a solution for continuous performance testing software to automate API and application load testing. You can use a webhook in the NeoLoad platform to forward NeoLoad Web events to the Sumo Logic HTTP endpoint. Using these logs, you can monitor the web events in Sumo Logic. For more details, refer to the [NeoLoad Documentation](https://documentation.tricentis.com/nlweb/latest/en/content/overview.htm). ## Event types The Sumo Logic integration for NeoLoad ingests web events into Sumo Logic through an outgoing webhook available in NeoLoad. For more information on supported events that are ingested through the NeoLoad webhook, see the [NeoLoad Documentation](https://documentation.tricentis.com/nlweb/latest/en/content/views_and_features/events_event_types.htm). ### Sample log messages ```json { "fallback": "Required plain-text summary of the attachment.", "author_name": "NeoLoad Web", "author_link": "https://neoload.saas.neotys.com/", "title": "Details of test 'Result #1698264583'", "title_link": "https://neoload.saas.neotys.com/#!result/bb7cb9ff-c322-4b46-80f7-7327c366b399/overview", "Test Name": "Data Generation Test", "Project": "Google Mail Service", "Scenario": "Unauthorize Access", "Author": "NeoLoad", "Start Date": "25/10/2023 08:09 PM (+0000)", "Duration": "00:05:00", "Status": "EXECUTED", "Quality Status": "PASSED", "Max # of VUs": "20", "Workspace ID": "5e3acde2e860a132744ca916", "Workspace Name": "System Workspace ", "footer": "Sent by NeoLoad Web", "footer_icon": "https://www.neotys.com/wp-content/uploads/2018/05/Picto_NL_64.png", "image_url": "https://neoload-api.saas.neotys.com/v1\/graphs\/f568f886-32ae-4f36-b154-dcbd4fe8104d" } ``` ### Sample queries ```sumo _sourceCategory="webhook/neoload" | json "Test Name", "Project", "Scenario", "Status", "Quality Status", "Workspace Name" as testName, project, scenario, status, qualityStatus, workspace nodrop | where testName matches "{{testName}}" and project matches "{{project}}" and scenario matches "{{scenario}}" and status matches "{{status}}" and qualityStatus matches "{{qualityStatus}}" and workspace matches "{{workspace}}" | count ``` ## Setup This section has instructions for collecting logs for the Sumo Logic NeoLoad webhook collection. ### Source configuration Follow the below steps to configure the Hosted Collector to receive NeoLoad events: 1. In the Sumo Logic portal, create a new [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector/) or use an existing one. 2. Then add a [HTTP Logs and Metrics Source](/docs/send-data/hosted-collectors/http-source/logs-metrics/#configure-an-httplogs-and-metrics-source). 3. Configure **Source Category** in the HTTP Source - for example, `webhook/neoload` - for the NeoLoad integration. 4. Expand **Advanced Options for Logs (Optional)** section in the HTTP Source, then uncheck the **Multiline Processing** option and check **One Message Per Request**. 5. Copy and save the endpoint URL of the source. ### Vendor configuration :::note Users must be workspace administrators to access the webhooks. ::: Configure the webhook integration in NeoLoad to send events to the Sumo Logic HTTP source. Once configured, it will be triggered each time the events occur within your NeoLoad account. Follow the steps to configure the NeoLoad webhook. 1. Sign in to the [NeoLoad account](https://neoload.saas.neotys.com/). 2. In the left navigation panel, click **Settings** and select the **Workspaces** tab. 3. Select the **Webhooks** tab. Click **Create a Webhook**. The webhook form appears. 4. Enter webhook form data as follows: - **Event**. Select the **Test started** option to send the payload when a test starts or the **Test ended** option when a test is finished. - **NAME**. Provide a name for your webhook. - **URL**. Enter the Sumo Logic HTTP endpoint URL (source address) created above. - **Payload**. See the sample body payload below. For more details check [NeoLoad Documentation](https://documentation.tricentis.com/nlweb/latest/en/content/reference_guide/settings_manage_workspace_webhooks.htm). ```json { "fallback": "Required plain-text summary of the attachment.", "author_name": "NeoLoad Web", "author_link": "https://neoload.saas.neotys.com/", "title": "Details of test '$(test_result_name)'", "title_link": "$(url_test_result_overview)", "Test Name": "$(test_settings_name)", "Project": "$(test_result_project)", "Scenario": "$(test_result_scenario)", "Author": "$(test_result_author)", "Start Date": "$(test_result_start_date)", "Duration": "$(test_result_duration)", "Status": "$(test_result_status)", "Quality Status": "$(test_result_quality_status)", "Max # of VUs": "$(test_result_max_nb_vus)", "Workspace ID": "$(workspace_id)", "Workspace Name": "$(workspace_name)", "footer": "Sent by NeoLoad Web", "footer_icon": "https://www.neotys.com/wp-content/uploads/2018/05/Picto_NL_64.png", "image_url": "$(url_graph_overview)" } ``` 5. Click **Save**. 6. Verify NeoLoad events are getting ingested in Sumo Logic by executing the following query on Sumo Logic's Log Search panel. ```sumo `_sourceCategory=webhook/neoload` ``` :::info - For detailed information about webhook creation, refer to the [NeoLoad Documentation](https://documentation.tricentis.com/nlweb/latest/en/content/reference_guide/settings_manage_workspace_webhooks.htm). - For support, [contact NeoLoad](https://support-hub.tricentis.com/open). ::: ### Installing the NeoLoad app import AppInstall2 from '../../reuse/apps/app-install-v2.md'; ## Viewing NeoLoad dashboards import ViewDashboards from '../../reuse/apps/view-dashboards.md'; ### Overview The **NeoLoad - Overview** dashboard offers a comprehensive view of your performance testing landscape through an array of informative panels. It provides real-time insights into test execution, showcasing Test Runs, Test Completions, and any Tests that may have been Terminated or are currently In Progress. With a focus on project and scenario management, the dashboard also tracks Targeted Projects, Targeted Tests, Scenarios, and Workspaces. Users can monitor the overall Test Status and Test Quality Status, with detailed breakdowns by Project, Scenarios, and Test Frequency, ensuring that performance testing efforts are meticulously analyzed and optimized. The dashboard further empowers project-specific analysis with Project-wise Test metrics, facilitating informed decision-making and proactive test management. NeoLoad - Overview ### Test Run Details The **Neoload - Test Run Details** dashboard offers a comprehensive overview of performance testing initiatives, providing insights through multiple panels. It allows tracking Test Frequency, categorizing tests by Workspace and Projects, and monitoring trends in Status, Project-wise test trends, Quality status trends, and Test Scenario trends. Additionally, it provides visibility into tests correlated with Execution Time and Max#VUs, enabling in-depth analysis of test performance and informed decision-making for optimizing the testing strategy. Neoload - Test Run Details ## Upgrade/Downgrade the NeoLoad app (Optional) import AppUpdate from '../../reuse/apps/app-update.md'; ## Uninstalling the NeoLoad app (Optional) import AppUninstall from '../../reuse/apps/app-uninstall.md';