Nimsoft Monitor dns_response Guide v1.6 series
CA Nimsoft Monitor Copyright Notice This online help system (the "System") is for your informational purposes only and is subject to change or withdrawal by CA at any time. This System may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This System is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties. This System may not be disclosed by you or used for any purpose other than as may be permitted in a separate agreement between you and CA governing your use of the CA software to which the System relates (the CA Software ). Such agreement is not modified in any way by the terms of this notice. Notwithstanding the foregoing, if you are a licensed user of the CA Software you may make one copy of the System for internal use by you and your employees, provided that all CA copyright notices and legends are affixed to the reproduced copy. The right to make a copy of the System is limited to the period during which the license for the CA Software remains in full force and effect. Should the license terminate for any reason, it shall be your responsibility to certify in writing to CA that all copies and partial copies of the System have been destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS SYSTEM 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 SYSTEM, 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 manufacturer of this System 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 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors. Copyright 2014 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Legal information on third-party and public domain software used in the Nimsoft Monitor solution is documented in Nimsoft Monitor Third-Party Licenses and Terms of Use (http://docs.nimsoft.com/prodhelp/en_us/library/legal.html).
Contact CA 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: dns_response 1.6 7 dns_response Overview... 7 Chapter 2: dns_response Probe Deployment 9 Supported Platforms... 9 System Requirements... 9 Software Requirements... 9 Monitoring System Requirements... 10 Probe Deployment Information... 10 Chapter 3: dns_response Configuration 11 Probe Defaults... 11 Probe Configuration Interface Installation... 11 Probe GUI... 12 Probe Configuration... 13 Set General Properties... 13 Configure Profiles... 15 Launch Message Pool Manager... 21 Chapter 4: QoS Threshold Metrics 25 dns_response QoS Metrics... 25 dns_response Alert Metrics Default Settings... 25 Contents 5
Chapter 1: dns_response 1.6 This description applies to dns_response probe version 1.6. This section contains the following topics: dns_response Overview (see page 7) Documentation Changes (see page 8) dns_response Overview The Monitor DNS Response Time probe queries your Domain Name Server (DNS) and monitors the response time from the server. The probe can also query the DNS looking for A records (normal hostnames), MX records (mail servers), and NS records (name servers). Chapter 1: dns_response 1.6 7
dns_response Overview Documentation Changes This table describes the version history for this document. Version Date What's New? 1.6 July 2014 Updated the Set General Properties topic for including description of the Logfile size field. Updated default values in the General Tab and Advanced Tab topics. 1.6 February 2013 Added Probe Defaults for the probe. Related Documentation Added Allow source override field for Qos and Alarm on Advanced tab. Fixed SOC issues. Updated to read alarm tokens from.cfg file. Fixed probe crash situation on setup nameserver test. Updated the probe to use c-ares DNS library v1.6.0. The probe no longer uses host utility to perform dns queries. Documentation for other versions of the dns_response probe The Release Notes for the dns_response probe Monitor Metrics Reference Information for CA Nimsoft Probes (http://docs.nimsoft.com/prodhelp/en_us/probes/probereference/index.htm) 8 dns_response Guide
Chapter 2: dns_response Probe Deployment This section contains the system requirements and deployment information for the dns_response probe. This section contains the following topics: Supported Platforms (see page 9) System Requirements (see page 9) Software Requirements (see page 9) Monitoring System Requirements (see page 10) Probe Deployment Information (see page 10) Supported Platforms The dns_response probe is supported on the same set of operating systems and databases as the Nimsoft Monitor Server solution. Please refer to the: Nimsoft Compatibility Support Matrix for the latest information on supported platforms. Support Matrix for Nimsoft Probes for additional information on the dns_response probe. System Requirements The dns_response probe should be installed on systems with the following minimum resources: Memory: 2-4GB of RAM. Probe's OOB configuration requires 256MB of RAM' CPU: 3GHz dual-core processor, 32-bit or 64-bit Software Requirements The dns_response probe requires the following software environment: Nimsoft Monitor Server 5.1.1 or later Nimsoft Robot 5.23 or later Java Virtual Machine 1.6 or later (typically installed with NMS 5.0 and above) Note: For SOC functionality, NM Server 5.6 or later and UMP 2.5.2 or later is required Chapter 2: dns_response Probe Deployment 9
Monitoring System Requirements Monitoring System Requirements The dns_response probe will query your DNS server and measure the time it takes to get a response. Probe Deployment Information There are three ways to distribute archive packages. You can distribute the package within the web-based Admin Console (for supported probes), from within Infrastructure Manager, or use the standalone Nimsoft Distribution application. See Probe Deployment for more information on deploying probes. 10 dns_response Guide
Chapter 3: dns_response Configuration The dns_response probe will query your DNS server and measure the time it takes to get a response. It will send alarms if the query fails, or if the response times are above the defined thresholds. The probe is QoS enabled and will send QoS data on profiles where the QoS option has been enabled. The probe uses the 'host' utility, which is shipped with the probe package. This section contains the following topics: Probe Defaults (see page 11) Probe Configuration Interface Installation (see page 11) Probe GUI (see page 12) Probe Configuration (see page 13) Probe Defaults At the time of deploying a probe for the first time on robot, some default configuration will get deployed automatically. These probe defaults could be Alarms, QoS, Profiles and so on which save time to configure the default settings. These probe defaults will be seen on a fresh install, that is no instance of that probe is already available on that robot in activated or deactivated state. 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. Chapter 3: dns_response Configuration 11
Probe GUI Probe GUI Open the configuration tool for the probe by double-clicking the line representing the probe in the Infrastructure Manager. The application window lists all monitoring profiles defined. The list reflects information extracted from the probe. The active profiles will be displayed, with an icon next to them indicating the current status of that profile. If the icon is green (OK sign), the last check of that profile did not indicate any problems. If the icon turns red (error), the last check failed. The error count is a total over the running time of the probe, so it is common to see a green icon with an error count greater than zero. This indicates that the request has failed at some time in the past, but that it is ok at this time. Right-clicking in the list opens a small menu that allows you to: Add new profiles. The Profile dialog appears allowing you to create a profile. Edit existing profiles. Make a copy of an existing profile. You can create a profile with almost the same properties as the existing profile. Delete profiles that you do not need any more. Refresh the contents of the list to reflect the most updated information. 12 dns_response Guide
Probe Configuration The configuration tool also contains a row of tool buttons: General Setup (see page 13) Create a New Profile (see page 15) Message Pool Manager (see page 21) Probe Configuration This section contains specific configuration for the probe. Set General Properties You can set the general properties of the probe, such as log settings and name of the default name server using this functionality. Follow these steps: 1. Click the General Setup button. Chapter 3: dns_response Configuration 13
Probe Configuration 2. Use the Setup dialog to configure the general elements of the probe, such as log settings and name of the default name server as described below. Log level Indicates how much information should be written to the log file. The higher the log level, the more information is printed. On log level 0 (default) only critical errors are printed. Logfile Size Defines the maximum size of the probe log file in KBs. The probe takes the log file back-up, truncates the log file text, and continues logging when the log file size reaches the maximum limit. Default nameserver Defines the name server that will be used by the profiles if no specific name server is chosen. You can test the connection to the name server by pressing the Test button next to the input field. Note: A value must be assigned to this field. Port and Protocol Defines the port number (default 53) and select protocol for performing reverse lookup along with forward lookup from a single profile. Note: UDP will work on port 53 and TCP will work on any port. 14 dns_response Guide
Probe Configuration Test (button) This button is only available if the probe is running. When pressed the button will execute a test of the name server listed through the probe. Note the different icons: The icon next to the Test button is initially a question mark. If the test is successful, the icon will change into an OK sign. If the icon turns red (error), you should check your name server entry. Run interval (sec) Specifies how often the profiles should be checked. The interval is counted in seconds. Configure Profiles You can create a new profile and configure its properties to define the specific checks that the dns_response probe should run Follow these steps: 1. Click the Create A New Profile button to open the Profile dialog. You may also right-click in the left pane and select New Profile. A "Profile" is a specific check that the dns_response probe should run. Chapter 3: dns_response Configuration 15
Probe Configuration 2. Each profile has the following configurable fields: Profile Defines the name of the profile must be unique. Description Provides a brief description of the profile. This is for information only; the probe does not use the information for any processing. Host/Domain Specifies what is to be checked. Normally it will be a hostname that you wish to look up, but it can also be a domain, if you are checking that a name server or mail server is defined for that domain. Reverse Lookup IP Specifies IP address here. This supports performing reverse lookup along with forward lookup from a single profile. 16 dns_response Guide
Probe Configuration Test button Lets you test your profile to see if the dns_response probe can resolve the information. The icon next to the Test button is initially a question mark. If the test is successful, it will turn green. Otherwise, it will turn red, and you should check your profile configuration. General Tab 3. Enter the details in the following tabs: General tab (see page 17) Advanced tab (see page 19) Messages tab (see page 20) This tab contains the general information for the profile. It allows you to set up alarms and to override the default name server if you wish to use another name server for this lookup. Chapter 3: dns_response Configuration 17
Probe Configuration The fields in the above dialog are explained below: Use default name server The default name server, specified in the Setup Tab, will be used for this lookup. Note: All the details, such as default name server, port, and protocol would be fetched from Setup tab. Use name server Overrides the default name server and use the one specified instead. Port Alarms Protocol Defines the port number (default 1) to use for name server. Defines the protocol (default TCP) to be used for name server. There are two alarm thresholds available each for forward lookup and reverse lookup. You can select to control QoS Alarms for Forward Lookup or Reverse Lookup or both. Refer the Messages tab (see page 20) for alarm messages. The thresholds are specified in milliseconds (ms). To activate a threshold, you must select the check box and set a value for that threshold. Alarm threshold When this threshold is breached, the DNS lookup time alarm message is issued. The default threshold is 20 ms. Warning threshold When this threshold is breached, the DNS lookup time warning message is issued. The default threshold is 10 ms. Note: The sending and forwarding of QoS alarms are controlled separately for the Host and Reverse Lookup IP. 18 dns_response Guide
Probe Configuration Advanced Tab In the Advanced tab, you can set the type of lookup to perform, the number of retries, and the timeout for the command, and turn on Quality of Service messages. The fields in the above dialog are explained below: Server Lookup Type The dns_response probe supports four kinds of lookups: A: Normal IP address lookup MX: Mail server lookup (usually used when looking at a domain) NS: Name server lookup (usually used when looking at a domain) TXT: Text string (usually used in case of Chaos DNS lookup). When the Server lookup class is selected as Chaos (CH) and the Server lookup type as TXT, the user must specify the file name in the Host/Domain text box, for example version.bnd. Server Lookup Class The probe supports the following server lookup classes: Internet (IN) Chaos (CH) Chapter 3: dns_response Configuration 19
Probe Configuration Send Quality of Service Allows you to send Quality of Service messages if this check box is selected. Note: The QoS will be sent separately for the Host and the Reverse Lookup IP. Allow source override Overrides the source of Alarm and QoS by the text specified here. If you do not enter a value in this field, the QoS source will be hostname of system where probe is deployed and alarm source will be IP address of the system where probe is deployed. You can use the following variables in this field: $host: If $host is specified in Allow source override field, then the $host is replaced by host of DNS server in source field of Alarms and QoS. $profile: If $profile is specified in Allow source override field, then $profile is replaced by profile of DNS server in source field of Alarms and QoS. Messages Tab Note: You can also override any text in Allow source override field with or without variables in both QoS and alarm variables. Number of Retries Specifies the number of retries (default 1) that will be made when attempting to resolve the host or domain name and Reverse Lookup IP, specified in the profile. Note: The separate retries are attempted for the Host and the Reverse Lookup IP. Timeout (sec) Specifies the timeout (in seconds) for the request, default is 1. The timeout is on a request basis, so if you have multiple retries. The cumulative timeout is the timeout multiplied by the number of retries. Note: Separate timeouts are applicable for the Host and the Reverse Lookup IP. The Messages tab lets you select an alarm message for the different alarm situations. 20 dns_response Guide
Probe Configuration DNS lookup failure DNS lookup time above alarm threshold DNS lookup time above warning threshold DNS does not respond to request. Unable to read response time Launch Message Pool Manager Click the Message Pool Manager button in the tool bar to open the Message Pool dialog. Chapter 3: dns_response Configuration 21
Probe Configuration The alarm messages for each alarm situation are stored in the Message Pool. Using the Message Pool Manager, you can customize the alarm text as well as create your own messages. You can select one of these messages on the Messages tab in the drop-down menus in the Profile dialog. Note: When upgrading from probe versions prior to v1.23, the alarm messages must be manually cleared before upgrading. The probe may not function properly if the messages are not cleared before upgrade. The fields in the above dialog are explained below: Identification Name Specifies the message a unique name. This identification name is what you will see when selecting the message in the drop-down menus in the profile dialog. Error Alarm Text / Clear Alarm Text Defines the text of the alarm messages issued on error and clear. The variable expansion in the message text is supported. If typing a $ in the Alarm text field, a dialog pops up, offering a set of variables to be chosen. The set of variables available depends on what is selected as "token". Error Severity Specifies the severity of the alarm (clear, information, warning, minor, major, or critical). Message token Refers to the checkpoint. It is preset by the probe and is therefore not modifiable. 22 dns_response Guide
Probe Configuration Message subsystem Specifies the ID of the subsystem being the source of this alarm. This ID is managed by the nas. Chapter 3: dns_response Configuration 23
Chapter 4: QoS Threshold Metrics Many Nimsoft Monitor probes are shipped with the default alarm threshold values. These default values provide an idea about the information to be entered in the fields. These values 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 alarm thresholds. This section contains the following topics: dns_response QoS Metrics (see page 25) dns_response Alert Metrics Default Settings (see page 25) dns_response QoS Metrics The following table describes the QoS metrics that can be configured using the New Probe probe. Monitor Name Units Description QOS_DNS_RESPONSE Milliseconds DNS response QOS_DNS_RESPONSE_REVERSE Milliseconds DNS response dns_response Alert Metrics Default Settings The following table describes the default settings for the New Probe probe metrics. Alert Metric Error Threshold Error Severity Description LookupFailu re - Major Alarms to be issued when DNS lookup of target failed on nameserver for profile. TimeAlarm - Major Alarms to be issued when DNS lookup time of the target server is breaching the alarm threshold. TimeWarn - Warning Alarms to be issued when DNS lookup time of the target server is breaching the warning threshold. DNSFailure - Major Alarms to be issued when DNS server for profile does not respond to requests. Chapter 4: QoS Threshold Metrics 25
dns_response Alert Metrics Default Settings Alert Metric Error Threshold Error Severity Description ParseError - Major Alarms to be issued when unable to read response time from nameserver for profile. 26 dns_response Guide