CA APM Cloud Monitor. Scripting Guide. Release 8.2

Transcription

1 CA APM Cloud Monitor Scripting Guide Release 8.2

2 This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation ) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA. Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

3 Contact CA Technologies Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At you can access the following resources: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Providing Feedback About Product Documentation If you have comments or questions about CA Technologies product documentation, you can send a message to techpubs@ca.com. To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at

4

5 Contents Chapter 1: Working with Scripts 7 Introduction... 7 Using JMeter... 7 Record a Script Using JMeter... 8 Assertions Using Monitor Parameters Inside a JMeter Script Upload the Script to the CA APM Cloud Monitor Web Site Verify the Script Execution Contents 5

6

7 Chapter 1: Working with Scripts CA APM Cloud Monitor offers capabilities for testing the functionality of your web applications and APIs, so you know exactly how customers experience your site. With CA APM Cloud Monitor, you can automatically simulate and measure the performance of complex, multi-step transactions, so you can ensure that vital services are performing optimally. Scripts can be used to identify a wide variety of possible issues, from slow page response times to monitoring the behavior of forms such as login pages and shopping carts. JMeter is also a powerful tool for proper and in-depth API testing. JMeter is not designed to execute client-side code, therefore we advise to construct your scripts to test procedures which do not require JavaScript or any other client-side code to be executed. Introduction This guide describes how to record a custom HTTP session script for use with CA APM Cloud Monitor. The engine we use to run scripts is JMeter, therefore we advise to use the JMeter application for recording your scripts. JMeter is a Java based application and runs on many platforms, including Microsoft Windows, MacOS, and Linux. You can download JMeter from Using JMeter JMeter is a Java-based desktop application that is designed to test the load on the client or server. JMeter can be used to simulate a heavy load on a server, network, or object, to test the strength, or to analyze the overall performance under different load types. For more information on JMeter, see the following web page: JMeter helps you perform a regression test on your application. You can create test scripts with assertions to verify whether your application returns the results you expect. For maximum flexibility, JMeter lets you create these assertions using regular expressions. Chapter 1: Working with Scripts 7

8 Record a Script Using JMeter Record a Script Using JMeter This procedure describes how to record a script using JMeter. In this example, you record a query search in google.com and verify the results. First you create a Thread Group to collect HTTP Request Samplers for your query. Follow these steps: 1. Open the JMeter application. 2. Right-click the Test Plan element in the left pane, and click Add, Threads (Users), Thread Group. The Thread Group element is added under Test Plan. 3. Right-click the Workbench element in the left pane. Click Add, Non-Test Elements, HTTP Proxy Server. The HTTP Proxy Server element is added under Workbench. 4. Open the HTTP Proxy Server element and configure the port. Click Start. 5. Open a web browser. Set the proxy settings to use localhost and the port you specified in your HTTP Proxy Server element configuration. 6. Enter in the address bar of the browser. If the browser complains about an untrusted connection, add an exception and continue with the script recording. 7. Enter the search term CA Technologies and click Search. The search results are displayed. 8. Remove the proxy configuration from your browser settings. 8 Scripting Guide

9 Record a Script Using JMeter Return to the JMeter application to create a response assertion. You create response assertions to test whether a request loaded correctly. Follow these steps: 1. Click the HTTP Proxy Server and stop the proxy server. 2. Open the Thread Group element. HTTP requests are recorded and added as samplers in the Thread group element. The samplers include the embedded elements of the search page, and AJAX calls that were performed during the loading phase. 3. Select all items under Thread Group except "/" and "/search". Right-click one of the selected items and click Remove. You now have the initial load of the Google page sampler ("/"), and the search query sampler ("/search"). You don't need the other samplers for this demo. 4. Right-click the "/search" HTTP request and click Add, Assertions, Response Assertion. 5. Add a relevant text pattern to the Response Assertion element. Example: To verify that the search for CA Technologies was performed correctly, add a response assertion for the text pattern CA Technologies. You use listeners to view the results of your requests. You run the test and verify that it runs correctly. Follow these steps: 1. Right-click the Thread Group element and click Add, Listener, View Result Tree. The View Results Tree Listener is added to the Thread Group. 2. Select the listener and click Run, Start in the main menu. 3. Verify whether all the calls performed by our script appear green. The test runs successfully. 4. Save the verified script. The script is saved as a jmeter (.jmx) file. You can now upload the script to CA APM Cloud Monitor (see page 12). Chapter 1: Working with Scripts 9

10 Assertions Assertions You can define assertions within a script to verify if a specific condition has been met. For example, you can define time assertions to verify that the requested page is loaded within a given time. Content assertions let you verify a particular string or a regular expression in the page body. Assertions can be of the following types: Assertions time size content XML Xpath HTTP response code HTTP response headers JMeter With the JMeter application you can also customize your HTTP requests by fine-graining for example, the HTTP headers or by customizing API test requests. Using Monitor Parameters Inside a JMeter Script You can use standard CA APM Cloud Monitor parameters inside JMeter scripts. Click expert mode in the monitoring settings. You can use the same script multiple times with different parameters in order to monitor different hosts. The available field mappings are as follows: Monitor Parameter Host Port Path User name Password JMeter Property ${ property(wmhost)} ${ property(wmport)} ${ property(wmpath)} ${ property(wmaccount)} ${ property(wmpasswd)} 10 Scripting Guide

11 Using Monitor Parameters Inside a JMeter Script Example You can use the host property as Server name in a JMeter script. 1. Create a script monitor. 2. Define the name and host properties in the script monitor configuration. 3. Use the host property in an HTTP Request by entering the following expression under ServerName or IP: ${ property(wmhost) } Additionally, you can specify user-defined parameters in the Monitor Parameter field as follows: Parameter String foo1=bar1&foo2=bar2&foo3=bar3 JMeter Property ${ property(foo1)} ${ property(foo2)} ${ property(foo3)} You can use user-defined parameters to create generic scripts that can be executed from more than one host. Chapter 1: Working with Scripts 11

12 Upload the Script to the CA APM Cloud Monitor Web Site Upload the Script to the CA APM Cloud Monitor Web Site CA APM Cloud Monitor allows you to access the online service that monitors your sites, servers, and applications, 24 hours a day, 7 days a week. A CUE Monitor web site requires a valid.jmx script file and a spare monitor in the account to upload a script. Follow these steps: 1. Log in to the CA APM Cloud Monitor portal. 2. Click Settings, Monitors. Click Add Monitor. The New Monitor dialog appears displaying a list of monitor types. 3. Select a SCRIPT monitor from the Advanced Synthetic Monitors tab. The Create Script Monitor page appears. 4. Enter the monitor name in the Name field. 5. Click "upload file" and browse to the.jmx script file on your computer. CA APM Cloud Monitor verifies the uploaded script and provides a report. 6. Click OK. Note: A script can only run for one domain using a single thread. The maximum size of the uploaded script is 2MB. 7. Save the monitor. A monitor is created and the selected.jmx file is uploaded. You can check the execution of the script in the log viewer. Verify the Script Execution One of the difficult tasks with self-service scripting is to select the appropriate assertions. The script reports only time-outs for the whole script and standard HTTP errors without any assertions defined. There is no limit to the number of assertions that you can define in a script. However, if an assertion fails, the CA APM Cloud Monitor monitoring station considers it a monitor failure. Follow these steps: 1. Go to 2. Select the monitor that you want to verify from the selection box and click show. The script monitor is executed continuously from different monitoring stations. Default: Every 5 minutes 12 Scripting Guide