CA Nimsoft Monitor. Probe Guide for Lotus Notes Server Monitoring. notes_server v1.5 series

Transcription

1 CA Nimsoft Monitor Probe Guide for Lotus Notes Server Monitoring notes_server v1.5 series

2 Legal Notices 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 , , and (c)(1) - (2) and DFARS Section (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 (

3 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 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 To provide feedback about general CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at

4

5 Contents Chapter 1: Overview 7 About This Guide... 7 Related Documentation... 7 Preconfiguration Requirements... 8 Supported Platforms... 8 Set up the Lotus Notes Client... 9 Chapter 2: Configuration Details 11 notes_server Node Profile-<Server Name> Node Configure a Node Add Server Profile Delete Server Profile Add log.nsf Monitoring Profile Delete log.nsf Monitoring Profile Chapter 3: notes_server QoS Metrics 19 Contents 5

6 Documentation Changes This table describes the version history for this document. Version Date What's New? 1.5 March 2014 Documentation on the initial web-based GUI version of this probe. (Previous versions of this probe are configured using Infrastructure Manager). 6 Probe Guide for Lotus Notes Server Monitoring

7 Chapter 1: Overview The Lotus Notes Server Monitoring probe monitors the performance of the IBM Lotus Domino server. The probe monitors server latency, server availability, server statistics variable values, and named views of the log.nsf file. This section contains the following topics: About This Guide (see page 7) Related Documentation (see page 7) Preconfiguration Requirements (see page 8) About This Guide This guide is for the CA Nimsoft Monitor Administrator to help understand the configuration of the Lotus Notes Server Monitoring probe and provides the following information: Overview of the Lotus Notes Server Monitoring probe and related documentation for previous probe versions. Configuration details of the probe. Field information and common procedures for configuring the probe. Important! Description for the intuitive GUI fields is not included in the document. Related Documentation Related Documentation Documentation for other versions of the notes_server probe The Release Notes for the notes_server probe User documentation for the Admin Console Monitor Metrics Reference Information for CA Nimsoft Probes ( Chapter 1: Overview 7

8 Preconfiguration Requirements Preconfiguration Requirements The preconfiguration requirements before deploying the Lotus Notes Server Monitoring probe on the target system are as follows: Install the IBM Lotus Domino server or IBM Lotus Notes client. Verify that path of the notes.dll file must be declared in the Path environment value of the system. Add the PATH variable in the Environment Variables section in the Setup node of the controller probe. For example, the notes.dll file is available at the C:\Program Files\IBM\Domino location of the system then the PATH variable value must be &PATH;C:\Program Files\IBM\Domino. Verify that the notes.ini file is also available at same location of the notes.dll file. The notes.ini file contains information about Domino server and Notes client configuration settings. Note: After deploying the probe it generates the notes-nimbus.ini file. Create a Lotus Notes user and generate the Id file for accessing the Lotus Domino server and its associated password. Copy the Id file at same location of the notes.dll file. The given user requires access to server, send and receive , access to Domino Directory, and read-only access to any database. Supported Platforms Refer to the Nimsoft Compatibility Support Matrix for the latest information about supported platforms. See also the Support Matrix for Nimsoft Probes for more information about the notes_server probe. 8 Probe Guide for Lotus Notes Server Monitoring

9 Preconfiguration Requirements Set up the Lotus Notes Client The Lotus Notes client is set up before or after a Robot is installed on the machine. If a Robot is present on the client machine, you can distribute a notes_response or notes_server probe to the machine. However, notes_server probe cannot be configured before the Lotus Notes client is installed. This description covers Lotus Notes client version 5 and 6 on a computer running Windows. The user must be familiar with Lotus Notes and Domino administrative tasks. 1. Create New User Account on Domino Server. An ID file is generated which the notes_server probe uses for accessing the domino server. 2. Extend the user certificate and assign a password. The probe requires only read access to any database, except its own mail file, to configure user rights accordingly. 3. Install the Lotus Notes client on the machine, where the Nimsoft Robot is installed and the notes_server probe is distributed. 4. Copy the Id file to the installation directory of Notes client. For example, if you have installed the notes client under the Programs Files directory of the C: drive, then the complete path must be C:\Program Files\IBM\Lotus\Notes. 5. The installed Notes client must include access mail server, send/receive mail, access to Domino Directory, access to database and server to be monitored. Trust any signer that does not match ECL or check why ECL is not correct. 6. Check location documents for correct name of server. Disable all ports but not the TCP/IP port. Navigate to the File>Preferences>User Preferences and press the Ports button. 7. Search the local file system for the file notes.dll and copy the location details. 8. Add the location of notes.dll (step 7) to the local system PATH variable. Navigate to My Computer Properties > Advance system settings > Advanced > Environment Variables. 9. Check for presence of multiple notes.ini files. Chapter 1: Overview 9

10 Preconfiguration Requirements Finish the Client Installation The following procedure describes the process that must be followed to complete the Lotus Client installation. Follow these steps: 1. Reboot the system for executing the change in the PATH value. 2. Install the Robot if not already done and distribute the notes_response or notes_server probe (or both) to the Robot. 3. Delete a previous version of notes_response or notes_server probe. Delete nextpwd.dll and notes-nimsoft.ini files that were created during a previous installation. 10 Probe Guide for Lotus Notes Server Monitoring

11 Chapter 2: Configuration Details Configure the Lotus Notes Server Monitoring probe for generating alarms on server availability and latency. You can configure the probe for sending QoS messages on server availability. You can also create a monitoring profile to fetch values of the server statistics and comparing them with the threshold values for generating alarms. Note: During the installation on 64-bit Windows, both the notes_server and notes_server64 probes are installed. The notes_server64 probe is a native 64-bit program that monitors only 64-bit Lotus Notes Domino server. This section contains the following topics: notes_server Node (see page 11) Configure a Node (see page 15) Add Server Profile (see page 16) Delete Server Profile (see page 16) Add log.nsf Monitoring Profile (see page 16) Delete log.nsf Monitoring Profile (see page 17) notes_server Node The notes_server node lets you view the server configuration details and configure the general properties of the Lotus Notes Server Monitoring probe. Navigation: notes_server Set or modify the following values as required: notes_server > Probe Information This section provides information about the probe name, probe version, start time of the probe, and the probe vendor. notes_server > Server Configuration This section lets you view the server configuration and define path of the notes initialization file. Client Directory: identifies the Lotus Notes client installation directory path where the notes.ini file exists. Program Directory: identifies the path of the program directory where the notes.ini file exists. Note: The probe fetches the Client Directory and Program Directory path from the controller probe. Chapter 2: Configuration Details 11

12 notes_server Node Notes Initialization File: defines path of the notes-nimbus.ini file, which the probe generates after reading the notes.ini file. Username: identifies the Notes user name. The user name is extracted from the notes-nimbus.ini file. Password: defines the password for the given Notes user. notes_server > General Configuration This section lets you define general configuration properties of the Lotus Notes Server Monitoring probe. Log File: defines the log file name. Log Level: specifies the detail level of the log level. Default: 1 - error Statistics (in seconds): defines the time interval for fetching statistics variable values of the Lotus Notes Server. Default: 60 Log (seconds): defines the time interval for fetching updated text of the log.nsf file for monitoring. Default: 300 Default message level: specifies the default alarm message severity. You can override this default severity in a monitoring profile. Default: warning Skip old log messages on initial run: determines the current log position in the log.nsf file on initial run of the probe. Default: Selected Callback Timeout: specifies the time limit for fetching the availability status of the Lotus Domino server, exceeding which the probe generates an alarm. Profile-<Server Name> Node This node displays the server profiles that are defined for the Lotus Notes Server Monitoring probe. This node contains a section which defines the server profile name and its short description. 12 Probe Guide for Lotus Notes Server Monitoring

13 notes_server Node <Server Name> Node This node lets you configure the profile for monitoring Lotus Domino Server statistics variables. A server profile defines the server statistics variables and their corresponding threshold values for monitoring. You can also define more than one profile for monitoring the log.nsf file. Navigation: notes_server > Profile-server name > server name Set or modify the following values as required: server name > Profile Configuration This section lets you configure the monitoring server profile. Active: activates or deactivates the log monitoring of a profile. Decimal Separator: defines a decimal separator between each statistics variable. The decimal separator, which the Lotus Domino server uses must be specified in this profile. server name > Server Status This section lets you activate alarm and QoS on Lotus Domino server availability. You can also view the alarm message text, the alarm severity, and the subsystem to which the alarm is sent. server name > Server Statistics This section lets you activate monitoring of the server statics variables for send QoS messages and generating alarms. You can add more than server statistics variables in this section. Use the Get Value option of the Actions drop-down list to view the current value of the variable. When value: specifies the comparison operator for comparing the statistic variable values with the threshold value for generating an alarm. Leave this field blank when no alarm message is required. Limit: defines the threshold value of the statistic variable value. Alarm Text: Defines the alarm message text, when the threshold value breaches. Alarm Level: specifies the alarm severity. Chapter 2: Configuration Details 13

14 notes_server Node Log.nsf Monitoring Node Log.nsf Monitoring <Profile Name> Node This node lets you activate monitoring of the log.nsf file and create multiple monitoring profiles. Each monitoring profile is displayed under this node. Note: The configured user must have access to Read public documents in the domino server log.nsf file. Navigation: notes_server > Profile-server name > server name > Log.nsf Monitoring Set or modify the following values as required: Log.nsf Monitoring > Log.nsf Monitoring Configuration This section lets you enable the monitoring of Lotus Notes log files. Active: activates the log file monitoring. Restrict Monitoring to View Named: specifies the named view of the log.nsf for monitoring. If this field is left blank, then the QoS messages and alarms are generated for all the views. Note: If you want to monitor more than one named views but not all, then create a separate server profile for monitoring each named view. This section lets you activate or deactivate a Log.nsf monitoring profile. You can also recognize a block of text in the log file and generate multiple alarms with thee same suppression key. Note: This node is referred to as Log.nsf Monitoring-profile name node in the document and is user-configurable. Navigation: notes_server > profile-server name > server name > Log.nsf Monitoring > Log.nsf Monitoring-profile name Set or modify the following values as required: Log.nsf Monitoring-profile name > Log.nsf Monitoring Configuration This section lets you configure the Log.nsf file monitoring profile properties. Name: defines a name of the log.nsf monitoring profile. Active: activates or deactivates the log.nsf monitoring profile. Description: defines a description of the log.nsf monitoring profile. Look for: specifies a search string for recognizing a text block for generating alarms. Use the regular expression for identifying the text. 14 Probe Guide for Lotus Notes Server Monitoring

15 Configure a Node Log.nsf Monitoring-profile name > Log Options This section lets you configure the log message properties which the profile monitors. Recognizes multiline messages: identifies the content of a longer message. Message Selection: defines the following options: Exclude Matching Messages: excludes the messages from the other monitoring profile when the message text matches the current profile criteria. Skip messages matching other profile: skips the messages for generating alarm that the other profiles recognize. Use Same Suppression Key for all alarms raised by this profile: sends all alarms of this profile with the same suppression key. Log.nsf Monitoring-profile name > Alarm Options This section lets you configure the alarm properties. Publish Alarms: triggers alarm generation. Level: specifies the alarm severity level. Subsystem: specifies the alarm subsystem id that defines the alarm source. Text: defines the alarm message text. Suppression Key: defines the alarm suppression key. Configure a Node This procedure provides the information to configure a section within a node. Each section within the node lets you configure properties of the probe for monitoring the Lotus Notes server. Follow these steps: 1. Navigate to the section within a node that you want to configure. 2. Update the field information and click Save. The specified section of the probe is configured. Chapter 2: Configuration Details 15

16 Add Server Profile Add Server Profile You can configure the Lotus Notes Server Monitoring probe to create a server profile for monitoring the Lotus Notes server. Follow these steps: 1. Click Options next to the notes_server node in the navigation pane. 2. Click the Add server profile option. 3. Update the field information and click Submit. The new profile is saved under the notes_server node in the navigation pane. Delete Server Profile You can delete a Lotus Notes Server Monitoring profile to stop the Lotus Notes logs monitoring. Follow these steps: 1. Click the Options icon next to the Profile-server name node that you want to delete. 2. Select the Delete Profile option. 3. Click Save. The monitoring profile is deleted from the Lotus Notes Server Monitoring probe. Add log.nsf Monitoring Profile You can configure the probe to create a profile for monitoring Lotus Notes logs and statistics. Follow these steps: 1. Click Options next to the Log.nsf Monitoring node in the navigation pane. 2. Click the Add log.nsf monitoring profile option. 3. Update the field information and click Submit. The new profile is saved under the Log.nsf Monitoring node in the navigation pane. 16 Probe Guide for Lotus Notes Server Monitoring

17 Delete log.nsf Monitoring Profile Delete log.nsf Monitoring Profile You can delete a log monitoring profile from the server profile when the Log.nsf file no longer requires monitoring. Follow these steps: 1. Click the Options next to the profile name node that you want to delete. 2. Select the Delete option. 3. Click Save. The monitoring profile is deleted from the server profile. Chapter 2: Configuration Details 17

18

19 Chapter 3: notes_server QoS Metrics The following table describes the checkpoint metrics that can be configured using the notes_server probe. Monitor Name Units Description QOS_NOTES_SERVER_AVAILABLE Available Notes Server Availability QOS_NOTES_STATISTIC Value Notes Statistics Variable Chapter 3: notes_server QoS Metrics 19