Nimsoft Monitor webservicemon Guide

Nimsoft® Monitor™
webservicemon Guide
v1.2 series
Legal Notices
Copyright © 2013, CA. All rights reserved.
Warranty
The material contained in this document is provided "as is," and is subject to being changed, without notice, in future editions.
Further, to the maximum extent permitted by applicable law, Nimsoft LLC disclaims all warranties, either express or implied,
with regard to this manual and any information contained herein, including but not limited to the implied warranties of
merchantability and fitness for a particular purpose. Nimsoft LLC shall not be liable for errors or for incidental or consequential
damages in connection with the furnishing, use, or performance of this document or of any information contained herein.
Should Nimsoft LLC and the user have a separate written agreement with warranty terms covering the material in this
document that conflict with these terms, the warranty terms in the separate agreement shall control.
Technology Licenses
The hardware and/or software described in this document are furnished under a license and may be used or copied only in
accordance with the terms of such license.
No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation
into a foreign language) without prior agreement and written consent from Nimsoft LLC as governed by United States and
international copyright laws.
Restricted Rights Legend
If software is for use in the performance of a U.S. Government prime contract or subcontract, Software is delivered and
licensed as "Commercial computer software" as defined in DFAR 252.227-7014 (June 1995), or as a "commercial item" as
defined in FAR 2.101(a) or as "Restricted computer software" as defined in FAR 52.227-19 (June 1987) or any equivalent agency
regulation or contract clause. Use, duplication or disclosure of Software is subject to Nimsoft LLC’s standard commercial license
terms, and non-DOD Departments and Agencies of the U.S. Government will receive no greater than Restricted Rights as
defined in FAR 52.227-19(c)(1-2) (June 1987). U.S. Government users will receive no greater than Limited Rights as defined in
FAR 52.227-14 (June 1987) or DFAR 252.227-7015 (b)(2) (November 1995), as applicable in any technical data.
Trademarks
Nimsoft is a trademark of CA.
Adobe®, Acrobat®, Acrobat Reader®, and Acrobat Exchange® are registered trademarks of Adobe Systems Incorporated.
Intel® and Pentium® are U.S. registered trademarks of Intel Corporation.
Java(TM) is a U.S. trademark of Sun Microsystems, Inc.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
Netscape(TM) is a U.S. trademark of Netscape Communications Corporation.
Oracle® is a U.S. registered trademark of Oracle Corporation, Redwood City, California.
UNIX® is a registered trademark of the Open Group.
ITIL® is a Registered Trade Mark of the Office of Government Commerce in the United Kingdom and other countries.
All other trademarks, trade names, service marks and logos referenced herein belong to their respective companies.
For information on licensed and public domain software, see the Nimsoft Monitor Third-Party Licenses and Terms of Use
document at: http://docs.nimsoft.com/prodhelp/en_US/Library/index.htm?toc.htm?1981724.html.
Contact CA Nimsoft
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 http://ca.com/support, 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
Send comments or questions about CA Technologies Nimsoft product documentation to
nimsoft.techpubs@ca.com.
To provide feedback about general CA Technologies product documentation, complete
our short customer survey which is available on the CA Support website at
http://ca.com/docs.
Contents
Chapter 1: webservicemon 1.2
7
webservicemon Overview ............................................................................................................................................ 8
Chapter 2: webservicemon Probe Deployment
11
Prerequisites .............................................................................................................................................................. 11
Supported Platforms .................................................................................................................................................. 11
System Requirements ................................................................................................................................................ 12
Software Requirements ............................................................................................................................................. 12
Monitoring System Requirements ............................................................................................................................. 12
Probe Deployment Information ................................................................................................................................. 12
Chapter 3: webservicemon Configuration
13
Probe Configuration Interface Installation ................................................................................................................. 13
Probe GUI ................................................................................................................................................................... 13
Probe Configuration ................................................................................................................................................... 13
Setup Tab ............................................................................................................................................................ 14
Configure Tab ...................................................................................................................................................... 15
QoS Definitions ................................................................................................................................................... 40
Convert a Certificate to PKCS#12 Format................................................................................................................... 45
Using OpenSSL Command ................................................................................................................................... 45
Chapter 4: User Configuration
47
Chapter 5: QoS Threshold Metrics
49
webservicemon Metrics ............................................................................................................................................. 49
webservicemon Alert Metrics Default Settings .......................................................................................................... 49
Chapter 6: Troubleshooting
51
Contents 5
Chapter 1: webservicemon 1.2
This description applies to the webservicemon probe version 1.2.
This section contains the following topics:
webservicemon Overview (see page 8)
Documentation Changes (see page 9)
Chapter 1: webservicemon 1.2 7
webservicemon Overview
webservicemon Overview
This probe monitors web services for following parameters: response time from
webservice, return status code, state of SSL certificate expiration and validity, and the
content of the response received from webservice after executing a pre-configured
webservice method in a profile.
This probe is used to invoke the specified webservices dynamically and it monitors
Simple Object Access Protocol (SOAP) response. Based on the monitored values, the
probe can calculate the turnaround time, and can raise QoS and alarms. The probe can
test a SOAP transaction when an endpoint URL, Web Services Description List (WSDL)
reference, and a transaction envelope (SOAP envelope) are provided.
Note: The webservicemon probe 1.2 onwards, supports SOAP version 1.1.
This probe monitors the webservice and returns the following parameters:
■
The response time of the webservice.
■
The SSL validity and expiration state.
■
The status code.
■
The content of the webservice response after executing a pre-configured
webservice method in a profile.
You can use these parameters to define the following types of alarms:
■
Response time
■
Response content
■
Response status code
■
Certificate validity
The probe can generate QOS for the following monitored parameters:
8 webservicemon Guide
■
Response time
■
Response status
webservicemon Overview
Documentation Changes
This table describes the version history for webservicemon document.
Version
Date
What's New?
1.2
June 2013
Added a note in the Overview section to add support
for SOAP 1.1.
1.2
November 2012 ■
1.1
1.0
May 2012
Added a default group in the left pane of the
Configure screen.
■
Added a field - Group Name on Step 1
(Configure New Profile) screen.
■
Reorganized the content of this probe
documentation.
■
Changed the screen shots in the documentation
as per GUI changes.
■
Modified the content of the documentation to
reflect the new updates.
■
Added a check box functionality at Step 2 to
bypass Step 3.
■
Server Certificate has been changed to Root
Certificate.
December 2011 Initial Release
Note: Serial releases within a version do not affect
the documentation for the series. For example, v1.0
documentation would apply to release 1.01.
Related Documentation
Documentation for other versions of the webservicemon probe
The Release Notes for the webservicemon probe
Monitor Metrics Reference Information for CA Nimsoft Probes
(http://docs.nimsoft.com/prodhelp/en_US/Probes/ProbeReference/index.htm)
Documentation Changes 9
Chapter 2: webservicemon Probe
Deployment
This section contains prerequisites, system requirements, and deployment information
for the webservicemon probe.
This section contains the following topics:
Prerequisites (see page 11)
Supported Platforms (see page 11)
System Requirements (see page 12)
Software Requirements (see page 12)
Monitoring System Requirements (see page 12)
Probe Deployment Information (see page 12)
Prerequisites
The prerequisites to run the webservicemon probe are stated below:
■
A WSDL (Web Services Definition List) reference
■
End Point URL
■
Infrastructure Manager to deploy the probe
Supported Platforms
The webservicemon probe supports the same set of operating systems and databases as
supported by the Nimsoft Server solution. Please refer to the Nimsoft Compatibility
Support Matrix for the latest information on supported platforms.
See also the Support Matrix for Nimsoft Probes, for additional specific information on
the webservicemon probe.
Chapter 2: webservicemon Probe Deployment 11
System Requirements
System Requirements
The webservicemon probe should be installed on systems with the following minimum
resources:
■
Memory: 2-4 GB of RAM. Probe's OOB configuration requires 256 MB of RAM.
■
CPU: 3GHz dual-core processor, 32-bit or 64-bit.
Software Requirements
The webservicemon probe requires the following software environment:
■
Nimsoft Monitor Server version 3.60 or later
■
Nimsoft Robot update 4.10+
■
Infrastructure Manager v4.02 or later
■
java_jre package
Monitoring System Requirements
The webservicemon probe monitors the following systems:
■
SOAP based web services running on specified web servers. It monitors the SOAP
response based on the monitored values, the probe calculates the turn-around
time, collects QoS metrics, and raises alarms.
Probe Deployment Information
There are two ways to distribute archive packages. You can distribute the package
within Infrastructure Manager or use the standalone Nimsoft Distribution
application.See Probe Deployment for more information on deploying probes.
12 webservicemon Guide
Chapter 3: webservicemon Configuration
This section describes the configuration concepts and procedures for setting up the
webservicemon probe.
This probe is used to invoke the specified webservices dynamically and it monitors
Simple Object Access Protocol (SOAP) response. Based on the monitored values, the
probe can calculate the turnaround time, and can raise QoS and alarms.
This section contains the following topics:
Probe Configuration Interface Installation (see page 13)
Probe GUI (see page 13)
Probe Configuration (see page 13)
Convert a Certificate to PKCS#12 Format (see page 45)
Probe Configuration Interface Installation
The probe configuration interface is automatically downloaded and installed by the
Nimsoft Infrastructure Manager when the probe is deployed on a robot.
Probe GUI
This section contains the basic GUI information for the webservicemon probe. The user
interface for this probe contains three tabs:
■
Setup: This tab allows you to configure log level and proxy settings.
■
Configure: This tab allows you to configure the webservicemon probe. For this, you
need to define a profile. Besides this, you can also re-configure an existing profile.
■
QoS Definition: This tab lists the available pool of QoS definitions. You can add and
delete a QoS definition besides viewing and editing alarm messages.
Probe Configuration
This section contains configuration information for the webservicemon probe.
Chapter 3: webservicemon Configuration 13
Probe Configuration
Setup Tab
This tab allows you to configure:
■
The Log Level
■
The Proxy Settings
To set the log level, click and drag the slider bar to increase or decrease the Log level.
If you are deploying the probe on a proxy network, select Proxy Settings and enter the
proxy server details.
Server name
The name of the proxy server.
Proxy Username
The username for the proxy server.
Proxy Password
The password for the username.
Proxy Server Port
The port number of the proxy server.
14 webservicemon Guide
Probe Configuration
Configure Tab
When you double-click the webservicemon probe in IM, the GUI for webservicemon
probe is displayed, with Configure tab selected by default. This tab contains a left pane
in which a default group is defined, with name Default Group. You can, either, create a
profile in this default group or you can create a new group and further create a profile,
which can be used to configure the webservicemon probe. On the right-pane, you can:
■
Configure a new profile
■
Re-configure an existing profile
A profile defines the webservice and probe specific parameters.
Note: The Group and Profile Names must be unique. If you try to create another group
or profile with the same names, the system will give you an error message.
Chapter 3: webservicemon Configuration 15
Probe Configuration
A profile references a unique webservice method.
You can either:
■
Configure a new profile (see page 16)
■
Re-configure an existing profile (see page 38)
■
Create a profile using Nimsoft webservice (see page 39)
Configure a New Profile
This section will familiarize you how to configure a new profile in the webservicemon
probe.
Follow these steps:
1.
Select the group under which you want to configure the new profile, right-click on
it, and select New Profile.
OR,
Select the required group, in the left pane, under which you want to create the
profile and click Run Wizard.
The system displays the Configure New Profile screen. This screen constitutes the
first step of profile creation. You need to cover 6 steps in order to create a new
profile. All these steps are explained in detail in the subsequent topics.
Note: In profile creation, the total number of steps is reduced to 5 if you check the
check box (Check this box to cut and paste predefined soap request) at Step 2. Both
these scenarios are explained in Scenario 1 (see page 17) and Scenario 2 (see page 34).
16 webservicemon Guide
Probe Configuration
SOAP Request Generated through Probe
If the check box at Step 2 (see page 20) is unchecked, then there will be a total of six
steps in profile creation and the system will generate the SOAP request through probe.
All these six steps are listed below:
■
Step 1: Enter the Profile Parameters (see page 17)
■
Step 2: Enter the Webservice Level Details (see page 20)
■
Step 3: Add a Value to the Variable (see page 23)
■
Step 4: Execute the Webservice (see page 26)
■
Step 5: Specify Alarm and QoS Condition for Response Content Monitoring (see
page 28)
■
Step 6: Specify Alarm and QoS Conditions for Other Alarms (see page 32)
Enter the Profile Parameters
This constitutes the first step of profile creation. You can specify the name of the profile,
the group in which it will be created, the webservice details, the probe execution
parameters, and the probe credentials.
Chapter 3: webservicemon Configuration 17
Probe Configuration
The fields in the above dialog are explained below:
Active
Select to activate the profile.
Note: The profile must be active for the probe to execute.
Profile Name
Enter the unique name of the profile. This field is mandatory.
Note: Profile name can contain alphanumeric characters, "_", and "-". No special
characters are allowed.
Group Name
Displays the name of the group selected in the left pane of the Configure (see
page 15) tab. If you had not created any group, initially, then this field displays
Default Group. The group name, once created, cannot be modified.
Note: You can also change the group of the profile from this field.
WSDL Input Source
Custom Header
This field is checked by default and is used to display the header parameter list
in Step 3 and the SOAP request. If unchecked and the header is present in
WSDL, the system will display an error in SOAP response at Step 4. If checked
and there is no header in the WSDL, then the header in the SOAP request will
be blank.
Content Type
It is a static field, non-editable field. It is used to establish a HTTP connection to
send a SOAP request.
Note: The content type is specified in the CFX file for the webservicemon
probe. It is recommended not to change the content type from CFX file.
User Agent
The default value for this field is Nimsoft. It is a configurable field. The value in
this field determines the entity who is requesting the web services.
Note: The User Agent value is specified in the CFX file for the webservicemon
probe.
WSDL URL / Path
You can specify WSDL by selecting any of the two radio buttons – File System or
URL. You must select one of the two radio buttons.
File System
Click Browse to locate the path of WSDL on your hard disk. The default path
can be specified through the CFX file, of the webservicemon probe, using
defaultFileSystemPath variable. By default, the File System field is selected
and blank.
18 webservicemon Guide
Probe Configuration
URL
Enter the defined WSDL URL. The URL should be prefixed with http:// or
https:// and end with wsdl.
Note: If URL contains http:// or https:// and there are proxy settings for that
URL, it is mandatory to complete the details in Setup tab.
End Point URL
Enter the endpoint URL for the webservice. This field is mandatory. The end point
URL should also be prefixed with http:// or https://.
Note: If WSDL/Schema contains any https:// based references, then it is mandatory
to fill the details in the Setup tab.
Authentication
Specify basic URL authentication for http / https based URLs (WSDL / End point
URL). It is an optional field.
Note: You need to provide correct User Name and Password for URL
authentication. Every time the profile gets executed, the URL will be authenticated
first using this User Name and Password, if they are available.
User Name
Defines the user name used for validation of the WSDL / URL.
Password
Defines the password used for validation of WSDL / URL.
Interval
Enter the time (in sec/min) after which the probe must monitor the webservice. It is
a mandatory field.
Collect Sample
Enter the number of monitor samples that the probe must collect.
Note: This action is available only for the response time. If the number of samples is
greater than 1, the probe uses the average values of the monitored response times
to generate alarms and QoS.
Follow these steps:
1.
Enter the required fields as explained above.
2.
Click Next.
The system will take you to Step 2 (see page 20).
Chapter 3: webservicemon Configuration 19
Probe Configuration
Enter the Webservice Level Details
This constitutes the second step of profile creation. This window allows you to install a
client certificate and configure the webservice parameters.
If the webservice uses a client certificate, you must install the certificate.
Note: The client and root certificates must be in the .P12 format. For more information
about how to convert a certificate to .P12 format, refer Convert a Certificate to PKCS#12
Format (see page 45).
The fields in the above dialog are explained below:
Use Client Certificate
Check this box, if client authentication is required before a client accesses a server.
In this case, the server requires a valid certificate from client before a trusted
connection is established between the two.
Note: The Client Certificate field is mandatory and Root Certificate is optional.
Client Certificate
Click Browse to select the client certificate. It is a mandatory field if the Use Client
Certificate checkbox is checked. A client certificate is an aspect of protecting your
server against unauthorized access. The client certificate contains fields of keys and
values from a security certificate that the client passes to the web server. Any user
with a valid and trusted client certificate can establish a secure connection and
access your resource. To use client certificate effectively, it is required that both the
web server and client must have SSL enabled and request client certificates. After
SSL is enabled, URL of the website will start with https:// instead of http://. You
must configure your web server to request client certificates and the client must be
capable of sending a certificate.
20 webservicemon Guide
Probe Configuration
Client Password
Enter the password for the client certificate. It is a mandatory field if the Use Client
Certificate checkbox is checked.
When a user executes an open SSL command, the system asks for export password
for protecting your private exchange key. This password is known as client
password.
Root Certificate
Click Browse to select the root certificate. It is an optional field. Root certificate
refers to the certificate that the client uses to authenticate the server.
Root Password
Enter the password for the root certificate. It is an optional field.
Install Certificate
Click Install Certificate to install the certificates and passwords in the folder where
the probe is deployed. If the icon turns green, it means that the certificates and
passwords are successfully deployed in the folder and all the requests like List
Methods, SOAP Response generation, etc. will now be made through the certificate.
Note: If the indicator turns to red, the installation is unsuccessful and you need to
select valid certificate/password.
List Methods
Click to list all the webservice methods exposed by this webservice. It is a
mandatory activity. If you do not select a method, clicking Next will not allow you to
proceed.
Notes:
■
List Method supports imported WSDL. By default, when you click this button,
the first webservice method and its soap action are populated in the Select
Webservice Method and Soap Action fields. You can, then, select the desired
method.
■
If you are using https based WSDL, then you need to enable the Use Client
Certificate functionality. If the icon for Install Certificate turns green, then only
you can use the List Methods functionality.
Select Webservice Method
All the methods contained in the selected WSDL (in Step 1) are listed when you click
the List Methods button. Select the desired webservice method.
Chapter 3: webservicemon Configuration 21
Probe Configuration
SOAP Action
This field is populated automatically with the corresponding soap action of the
selected webservice method, as soon as the webservice method is selected.
Notes:
■
This field is editable. If you change the auto-populated soap action and enter
the wrong soap action, for the selected webservice method, the system will
give you an error at Step 4.
■
If there is a change in Custom Header / WSDL at step 1, then you need to again
click on List Methods button to get the latest SOAP request.
Checkbox
If you check this box (Check this box to cut and paste predefined soap request),
then Step 3 (see page 23) (Add a value to the Variable) is bypassed and directly Step
4 (see page 36) (Execute the Webservice) appears, as Step 3, where you need to
paste your pre-defined SOAP request, as the SOAP request will be blank initially. In
other words, the total number of steps is reduced to 5.
If this box is left unchecked, then Step 3 (see page 23) will be there to specify the
value(s) of the parameter(s), that is, there will be a total of 6 steps.
Note: In case the checkbox is checked, the top-left corner of the screen will display
Step 1 of 5, Step 2 of 5, and so on.
Follow these steps:
22 webservicemon Guide
1.
If a client certificate is used, select Use client certificate. When selected, enter the
client certificate authentication credentials and click Install Certificate.
2.
Click the List Methods button. The system will populate all the available web
service methods that are in the selected WSDL. You can select any method from the
drop-down list. The corresponding soap action gets displayed in the Soap Action
field.
Probe Configuration
3.
Leave the checkbox unchecked.
4.
Click Next.
The system will take you to Step 3 (see page 23).
Add a Value to the Variable
This constitutes the third step of profile creation. This window lists the parameters,
along with their parent variables, type, and their mode (String, Boolean, Numeric, and
so on). You can enter or select the values for the parameters depending on their data
types.
The fields in the above dialog are explained below:
Parent Name
The parent element of the parameter.
Parameter Name
Displays the parameter(s) of the selected webservice method.
Parameter Type
Displays the type of parameter – Mandatory, Optional, Attribute, or Multivalued.
Notes:
■
Mandatory parameter value cannot be left blank.
■
Optional parameter value can be left blank.
■
Attribute parameter – displays when the parameter is an attribute of an
element.
■
Multivalued parameter – displays when the element has more than one
occurrence in SOAP request.
Chapter 3: webservicemon Configuration 23
Probe Configuration
Data Type
The type of element or attribute such as string, boolean, numeric, and so on.
Value
The value that you enter / select in the Parameter Value field.
Parameter Name
The parameter for which you need to enter the value. It is displayed depending on
the row that is selected.
Parameter Value
The value that you enter / select for the parameter.
Add
Click to assign the entered / selected value to the parameter. This value gets
displayed in the Value column.
Clear Value
Click if you want to clear the default value for a parameter and assign a new one or
delete an assigned value for a parameter.
Follow these steps:
1.
Select the row for which you want to enter / select the value for the parameter.
The Parameter Name field gets populated with the corresponding parameter.
2.
Enter / Select the value in the Parameter Value field and click the Add button.
The entered value gets assigned to the selected parameter and is now displayed
under the Value column. Similarly, add values to other parameters.
24 webservicemon Guide
Probe Configuration
Note: Select the required row and click Clear Value if you want to delete the
assigned value of the parameter, and assign a new value.
The list below should be considered for this step:
3.
■
If you want to add a new value against a parameter and the parameter is not
blank, then you must select the row (containing that parameter), click Clear
Value, enter / select a new value, and then click Add.
■
If you want to add a new value against a multi-valued parameter and the
parameter is blank, then you must select the row, enter / select the new value,
and then click Add. Again, select that row, enter / select the new value, and
click on Add button. Similarly, you can add other values to this multi-valued
parameter.
■
If you want to add a new value to the multivalued parameter and the
multi-valued parameter is not blank, then you must first select that row, click
Clear Value, enter / select the new value, and then click Add.
■
If Data Type for a parameter is Boolean, then the Parameter Value field will be
a drop-down list, with True and False options.
■
If Data Type for a parameter is String, then Parameter Value field will not
accept numeric values.
■
You should not use the hash tag (#) in a string value as it is used as a separator
for multi-valued parameters.
Similarly, add values for other parameters and then click Next.
The system will take you to Step 4 (see page 26).
Chapter 3: webservicemon Configuration 25
Probe Configuration
Execute the webservice
This constitutes the fourth step of profile creation. This window allows you to test the
profile configuration. You must execute the webservice to view its response. You can
use this response to define alarms, QoS, and regular expressions.
At this step, the system generates the SOAP request which is sent to the web server.
The SOAP request is visible in the Request to Server section of the window. The Request
to Server is an editable text field to define a SOAP request.
Follow these steps:
1.
Click Test Request to test the system generated SOAP request.
The system will generate the response from the server. This response is
non-editable and is displayed in the Response from Server section of the window.
26 webservicemon Guide
Probe Configuration
Notes:
■
By default, the Next button is disabled. It is enabled when you click Test
Request and get a response from the server.
■
SOAP request encloses comments with respect to element / attribute. For
example,
<!-ABC minOccur=0 maxOccur=1 -->
Here,
2.
■
minOccur = minimum occurrences of element / attribute into SOAP
Request.
■
maxOccur = maximum occurrence of element / attribute into SOAP
Request.
■
defaultValue = default value of element / attribute into SOAP Request
(optional).
■
type = data type of element / attribute (optional).
■
Attribute comments are always followed by Element comments.
■
You can also add additional parent tag at this step. For this, you need to copy
the parent tag in the SOAP request and then change the value(s) of the
parameter(s). For future enhancements, in case of multiple occurrences of
parent element, you will be able to provide the values to its parameters at Step
3 only.
Click Next.
The system will take you to Step 5 (see page 28).
Chapter 3: webservicemon Configuration 27
Probe Configuration
Specify Alarm and QoS Condition for Response Content Monitoring
This constitutes the fifth step of profile creation. This window allows you to add, modify,
and delete regular expression (RegEx) to specify the criteria that the probe must use to
match with the monitored value.
A regular expression is a concise and flexible method to match strings of text which can
be particular characters, words, or pattern of characters. It defines a search pattern for
strings. This pattern may match one or several times or not at all for a given string. It is
abbreviated as regex or regexp. Regular expressions are used when you want to search
for specified lines of text containing a particular pattern.
For example, suppose you want to count the number of occurrences of the word TEST in
the server response. For that, you can configure the webservicemon probe by specifying
the regular expression as [TEST] and associate QoS and alarms for it. The probe will
monitor the server response and generate alarms based on the configuration. For more
information on regular expression, refer Regular Expression
After you have selected the regular expression, you must define alarms and QoS
available for the regular expression. Regular expressions filter the output to generate
alarms and QoS based on the configuration.
28 webservicemon Guide
Probe Configuration
Follow these steps to add a regular expression:
1.
Click Add.
The Add Regular Expression window appears.
2.
Enter the regular expression the probe must use to match a SOAP response and
then click OK.
The Regular Expression is now added.
Note: Similarly, to modify or delete a regular expression, click Edit or Delete buttons.
Follow these steps to define an alarm for the regular expression:
1.
In the Alarms section, right-click the blank space and then select Add.
Chapter 3: webservicemon Configuration 29
Probe Configuration
The Add Alarm window appears.
2.
Enter the appropriate values for the fields.
Match Type
Select the appropriate match type. The available options are:
■
Count
The probe counts the number of occurrences of the value provided and
returns the count.
■
Group
The probe compares the Match Value with the very first returned match
(as per the RegEx) of the response.
Notes: You can configure float or string values for a group alarm.
The operators depend upon the category of the Match Value. If the Match
Value is a string, the available operators are = and !=.
Match Value
Enter the value that probe must use to match with the monitored response.
Severity
Select a pre-defined severity level for the alarm.
Operator
Select an operator for the match operation.
Note: The operators depend upon the category of the Match Value. If the
Match Value is a string, the available operators are = and !=.
30 webservicemon Guide
Probe Configuration
Message
Enter a custom message for the alarm. You can also use $variables in the
message.
For the list of available variables with alarms, see Variables Available with
Alarms.
Active
Select to activate the alarm.
3.
Click OK to add the alarm for the regular expression.
Note: Similarly, you can modify or delete an alarm using the Edit or Modify options.
Follow these steps to define a QoS for this regular expression:
1.
In the QoS section, right-click the blank space and then click Add.
The Add QoS window appears.
2.
Select the appropriate Match Type and the required QoS.
3.
Select Active to activate the QoS and then click OK.
The selected details are added in the QoS section.
Note: Similarly, you can modify or delete a QoS using Edit or Delete options.
4.
Click Next.
The system will take you to Step 6 (see page 32).
Chapter 3: webservicemon Configuration 31
Probe Configuration
Specify Alarm and QoS Conditions for Other Alarms
This constitutes the last step (step 6) of profile creation. This window allows you to
configure:
■
Client Certificate Alarm
■
Root Certificate Alarm
■
Response Time Alarm
■
Response Status Alarm
You can also configure the probe to generate a QoS message for the Response time.
Certificate Alarms
■
Select Client Certificate Alarm and enter the number of days left for the client
certificate expiration within which the probe must raise the alarms.
■
Select Root Certificate Alarm and enter the number of days left for the root
certificate expiration within which the probe must raise the alarms.
Note: The alarms are prioritized based on their severity. If the monitored value falls
under multiple alarm conditions, the probe raises the alarm with the maximum
severity.
Response Time Alarm
■
32 webservicemon Guide
Select Response Time Alarm and specify the Unit, Operator, and Threshold for the
alarm.
The probe raises an alarm if the monitored response time exceeds the specified
threshold condition.
Probe Configuration
Note: The default unit of Response Time Alarm is milliseconds (ms). To set a
different default unit, edit the CFX file (see point (i) of Chapter 4 (see page 47)). You
must set the desired default unit for both Alarm and QoS definition in CFX file.
Generate QoS for Response Time
■
Select Generate QoS for Response Time to generate QoS messages for the
specified threshold condition.
Response Status Alarm
■
By default, the Response Status Alarm checkbox is checked. If the probe receives
the response status code other than 2xx (200 - 299), then an alarm is generated
with message: Network is not OK for $profile. Response code is $code.
■
Similarly, if the probe receives a response status code = 2xx, then a clear alarm is
sent with message: Network is OK for $profile. Response code is $code.
■
If this checkbox is unchecked, then no alarm is generated even if the webservice is
running and the status code received is other than 2xx.
Follow these steps:
1.
Configure client and root certificate alarms as well as response status and response
time alarms as desired.
2.
Click Finish on this step.
The new profile gets created as shown below:
3.
Click Apply.
The system gives a message to restart the probe.
Note: It is mandatory to click Apply after you create a profile so that the changes
are saved in the system.
Chapter 3: webservicemon Configuration 33
Probe Configuration
4.
Click Yes in the message dialog to save changes.
The message dialog gets closed.
5.
Click OK on the above screen.
The changes get saved in the system. You have to again click on the webservicemon
probe in IM. The GUI opens up showing the new profile under the selected group.
Predefined SOAP Request is Cut and Pasted
If the checkbox at Step 2 (see page 20) is checked, then there will be a total of five steps,
that is, Step 3 (see page 23) (Add a Value to the Variable in Scenario 1 (see page 17)) is
bypassed and directly Step 4 (see page 36) (Execute the Webservice) appears. In this
case, Step 4 will become Step 3.
In this case the SOAP request will be blank and you need to paste your pre-defined
SOAP request in the Request to Server section.
All these five steps are listed below:
■
Step 1: Enter the Profile Parameters (see page 17)
■
Step 2: Enter the Webservice Level Details (see page 35)
■
Step 3: Execute the Webservice (see page 36)
■
Step 4: Specify Alarm and QoS Condition for Response Content Monitoring (see
page 28)
■
Step 5: Specify Alarm and QoS Conditions for Other Alarms (see page 32)
Note: Steps 1, 4, and 5 (as listed above) will not be shown in this document as they
remain unchanged.
34 webservicemon Guide
Probe Configuration
Enter the Webservice Level Details
Follow these steps:
1.
Click List Methods. The system will populate all the available webservice methods
that are in the selected WSDL.
2.
Select the required webservice method.
The corresponding soap action gets populated automatically.
3.
Select the check box. The total number of steps will reduce to 5 and the top-left
corner of the screen will show Step 2 of 5. Similarly, the previous and next screens
will show Step 1 of 5, Step 3 of 5, and so on.
4.
Click Next.
The system will take you to Step 3 (see page 36) with SOAP request appearing
blank.
Chapter 3: webservicemon Configuration 35
Probe Configuration
Execute the Webservice
At this step, the SOAP request will be blank initially and you need to paste your
predefined SOAP request.
Follow these steps:
1.
36 webservicemon Guide
Paste your SOAP request in the Request to Server section of the window.
Probe Configuration
2.
Click Test Request. The system will generate the SOAP response in the Response
from Server section of the window.
3.
Click Next.
The system will take you to the next step (see page 28).
Chapter 3: webservicemon Configuration 37
Probe Configuration
Re-configure an Existing Profile
This functionality allows you to re-configure a profile that you have created previously.
Follow these steps:
1.
Select a profile to modify.
2.
Select Re-configure Selected Profile and then click Run Wizard.
OR,
Right-click on the profile name and select Edit.
The system begins again from Step 1. You can, then, perform the modifications in
the required steps (Step 1–6) or (Step 1-5). After you save the changes, the probe
needs to be restarted for the changes to be applied.
Notes:
38 webservicemon Guide
■
The profile name cannot be modified.
■
You can also change the group of the profile from the Group Name field. After you
finish the profile creation wizard, the profile will be visible under the new selected
group.
■
If you want to edit a previously created profile and select the check box at Step 2
now, then also the previous / saved SOAP request xml will be visible in the Request
to Server section. You can, then, edit the request or delete and paste a new one
and generate the SOAP response accordingly.
■
You need to click Apply in order to save the modifications.
Probe Configuration
Create a Profile Using Nimsoft Webservice
To create a profile using Nimsoft webservice, you need to start Nimsoft Web Service.
UMP must be installed on your system.
The pre-requisites for UMP installation are as follows:
■
data_engine probe must be running.
■
ace, discovery_agent, discovery_server, fault_correlation_engine, nis_server, and
relationship_services probes must be active.
After these pre-requisites are met, you can proceed with UMP installation. For UMP
installation, click Archive node in Infrastructure Manager --> Nimsoft Internet Archive
link --> Downloads tab --> click Nimsoft Unified Management Portal 2.6.1 GA link and
then install the required package.
After UMP is installed, the wasp probe must be active and running. You should now see
the http port for wasp probe.
Follow these steps:
1.
Right-click on the wasp and then select the Configure option.
2.
Select the Setup tab and then check the Port Configuration box. Write down the
http port as you will need to know the http port in later steps. The default port is
8084.
Note: You need to enter the WSDL URL as: http://localhost (or IP): portname
(8084)/DashboardAPI/services/DashboardAPI?wsdl and End point URL as
http://localhost (or IP): portname (8084)/DashboardAPI/services/DashboardAPI.
Now, you can double-click the webservicemon probe to create a new profile as
explained in Steps 1 - 6 (or Steps 1-5) of Configure a New Profile (see page 16) section.
Chapter 3: webservicemon Configuration 39
Probe Configuration
QoS Definitions
The QoS Definitions tab lists the available pool of QoS definitions.
40 webservicemon Guide
Probe Configuration
Add a QoS Definition
This functionality allows you to add a new QoS in the QoS Definition list.
Follow these steps:
1.
Click Add New.
The QoS Definition window appears.
The fields in the above dialog are explained below:
Name
Enter the name of the new QoS.
Description
Enter the description of the QoS.
Unit Long and Unit Short
Indicate the unit for the new QoS.
QoS Max
Maximum value for the QoS.
Mi
Minimum value for the QoS.
Flag
Indicate whether any flag has to be set for the QoS. If no flag has to be set,
select None. For Boolean flag, select Is Boolean and Has Max if some maximum
flag value is to be assigned to the QoS.
2.
Enter the required information in the fields and click OK.
The new QoS gets added in the QoS Definitions window.
Chapter 3: webservicemon Configuration 41
Probe Configuration
Delete a QoS Definition
This functionality allows you to delete a QoS from the QoS Definitions list.
Follow these steps:
1.
Select the QoS definition you want to delete.
2.
Click Delete QoS Definition.
The selected QoS definition gets deleted from the list.
View and Edit an Alarm Message
This describes how you can view an alarm message and perform modifications in it, if
required.
To view an alarm message, click the Message Pool button. The Message Pool window
appears displaying alarm messages.
42 webservicemon Guide
Probe Configuration
Follow these steps, to edit an alarm message:
1.
From the Message Pool window, select the message that you want to modify.
2.
Click Edit the selected message definition.
The Message Properties window gets displayed.
The fields in the above dialog are explained below:
Identification Name
Indicates the message identification code.
Token
Indicates the token value.
Error Alarm Text
Indicates the alarm text in case error occurs.
Clear Alarm Text (OK)
Indicates the alarm text in case no error occurs.
Error Severity
Select the severity level for the error message.
Subsystem string/id
Indicates the subsystem id.
Custom Values
Select the required option from the drop-down list and provide the custom
value for the selected option.
Chapter 3: webservicemon Configuration 43
Probe Configuration
3.
Update the fields as required.
Note: You can use $variables for the Error Alarm Text and Clear Alarm Text fields.
4.
Click OK to perform the modifications.
Available Alarm Variables
Certificate Alarm variables
$system
Indicates that the alarm is generated for client certificate or root certificate. For
root certificate its value is "root" and for client the certificate value is "client."
$days
Days remaining for certificate expiration.
$profile
Profile name.
Response Content Alarm
$type
Indicates type of alarm whether "count" or "group".
$opr
Operator.
$val
Value returned by RegEx.
$thr
Threshold.
Response Status Alarm
$code
Returns the status code from the webservice.
Response Time Alarm
$val
Time taken by the webservice to send a response.
$thr
Threshold.
$opr
Operator.
44 webservicemon Guide
Convert a Certificate to PKCS#12 Format
Convert a Certificate to PKCS#12 Format
PKCS stands for Public Key Cryptography Standards. The PKCS #12 Standard defines the
Personal Information Exchange Syntax Standard. This defines a file format commonly
used to store private keys with accompanying Public key certificates protected with a
password-based symmetric key. Such files use the extensions PFX or P12.
The root and client certificates must be converted to .P12 format to use in Java key
stores.
The PKCS#12 files combine certificates with its private key. Though the password is
optional when you create a PKCS#12 file, but is required in Java Key Stores.
Using OpenSSL Command
You must have open ssl installed on the computer to convert the certificate package to
.P12 format.
Convert a root certificate to .P12 format
$ openssl pkcs12 -export -in localhost.crt -inkey localhost.key -out localhost.p12
-name root
Enter Export Password
Verifying - Enter Export Password
Convert a client certificate to .P12 format
$ openssl pkcs12 -export -in client.crt -inkey client.key -out client.p12 -name client
Chapter 3: webservicemon Configuration 45
Chapter 4: User Configuration
Below is the list of different scenarios in which the webservicemon probe can be
configured:
■
The default unit for Response Time Alarm can be edited through the CFX file
(<profile> tag --> <response_time_alarm> tag --> unit element).
■
The pool size* and java_mem_max* can be configured as follows:
■
For 1000-2000 profiles, you need to provide minimum pool size = 10 and
default max memory java_mem_max = -Xmx128m.
■
For 3000-5000 profiles, minimum pool size = 10 and default max memory
java_mem_max = -Xmx256m
■
The content type is specified in the CFX file (<setup> tag) for the webservicemon
probe using the ContentType variable.
■
The User Agent value is also specified in the CFX file (<setup> tag) for the
webservicemon probe, using the UserAgent variable.
■
The default path, for the File System field, can be specified through CFX file
(<setup> tag), of the webservicemon probe, using defaultFileSystemPath variable.
*Pool size: It is the number of threads running concurrently to execute the profiles.
Maximum pool size value can be set as 20.
*java_mem_max: It is the maximum memory value for webservicemon probe.
Chapter 4: User Configuration 47
Chapter 5: QoS Threshold Metrics
Many Nimsoft Monitor probes ship with default QoS threshold values set. The default
threshold values provide an idea of the type of values to be entered in the fields and are
not necessarily recommended best practice values. To aid in tuning thresholds and
reducing false-positive alarms, this section describes the QoS metrics and provides the
default QoS thresholds.
This section contains the following topics:
webservicemon Metrics (see page 49)
webservicemon Alert Metrics Default Settings (see page 49)
webservicemon Metrics
This section contains the QoS Metrics for the webservicemon probe.
QoS Monitor
Units
Description
QOS_WEBSERVICEMON_DEFAULT
None
Default values
QOS_WEBSERVICEMON_RESPONSE_TIME
ms
Response time
QOS_WEBSERVICEMON_RESPONSE_CONTENT
None
Response content
QOS_WEBSERVICEMON_RESPONSE_STATUS
None
Response status
webservicemon Alert Metrics Default Settings
This section contains the alert metric default settings for the webservicemon probe.
QoS Metric
Warning
Warning
Threshold Severity
Error
Threshold
Error
Description
Severity
CertificateAlarm
None
None
None
None
Alarm certificate expires
ResponseStatus
None
None
None
Critical
Response code is out of given range
ResponseTime
None
None
None
Critical
Response time is within threshold limit
ResponseContent
None
None
None
Critical
Response type value does not match
threshold limit
Chapter 5: QoS Threshold Metrics 49
Chapter 6: Troubleshooting
This section contains troubleshooting information for the webservicemon probe. The
various scenarios are listed below:
■
In Step 2, if after clicking the List Methods button no methods appear in the Select
Webservice Method list, then you need to go to WSDL and verify whether any
imported WSDL or schema is based on https://. In this case, we need to first do the
proxy settings in the Setup tab.
■
If you change the WSDL path or status of Custom Header field, you always need to
click the List Methods button to get the latest webservice methods.
■
You can check whether the webservice is running or not by copying the end point
URL in a browser. If the web service is running, then the HTML page will show some
message, otherwise it will show Page cannot be displayed type of error message.
Chapter 6: Troubleshooting 51
Download PDF
Similar pages