EMC Ionix IT Automator

Monitoring ServerInstallation and Configuration Guide

Version 5.8 REV A01

December 2009 300-010-288

EMC Corporation Corporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000 www.EMC.com

EMC Ionix IT Automator Monitoring

test

EMC Ionix IT Automator

Monitoring ServerInstallation and Configuration Guide

Date: December 2009Version 5.8

REV A01 Document Number: 300-010-288

EMC CorporationCorporate Headquarters,

Hopkin, MA 01748-9103U.S.A.

Tel. 1-508-435-1000

http://www.EMC.com

iv RELEASE: 5.8 REV A01 300-010-288

Copyright © 2009 EMC Corporation. All rights reserved.Published December, 2009

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABIL-ITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up-to-date regulatory document for your product line, go to the Technical Documentation and Advisories section on EMC Powerlink.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.All other trademarks used herein are the property of their respective owners.

Publication History 1December 2009

A01. This is the initial version of the EMC Ionix IT Automator Monitoring Server for Release 5.8.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE v

vi RELEASE 5.8 REV A01 300-010-288

Table of Contents 1Preface  ixAudience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixOrganization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixFont conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Introduction  1­1Monitoring Server Software Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Event API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3Application Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8Provided Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

System Configuration  2­1Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Software Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Supported Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Event Types  3­1Adapter Event Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Application Monitor Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Software Installation  4­1Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Installing a License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Installing the iWave Automator Software - Windows . . . . . . . . . . . . . . . . . . . . 4-3Running the Monitoring Server as a Windows Service . . . . . . . . . . . . . . . . . 4-26Installing the Monitoring Server Software - UNIX . . . . . . . . . . . . . . . . . . . . . . 4-29Running the Monitoring Server as a UNIX Service . . . . . . . . . . . . . . . . . . . . . . 4-30Manual Installation Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31Configure SSL Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32Starting the Monitoring Server Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34

Monitoring Server Configuration  5­1Establish the Monitoring Server Connection with the Automator and Adapters 5-1

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE vii

Change the Monitoring Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Framework Configuration  6­1Properties Editor Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Configuring Application Monitoring Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Email Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3SNMP Notification Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Health Monitor Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

Monitoring Server MIB  7­1MIB Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Textual Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Index  I­1

viii RELEASE 5.8 REV A01 300-010-288

Preface 2This manual includes instructions on installing, configuring, and troubleshooting the EMC Ionix IT Automator Monitoring Server software.

Audience 2

The intended audience for this document is the IT operations support technical analyst that is responsible for monitoring an organization's IT infrastructure and providing second or third level support.

Organization 2

This publication consists of the following chapters:• Introduction• System Configuration• Event Types• Installation• iMS Configuration• Framework Properties• iMS MIB• Index

Font conventions 2

• Bold format is used to identify dialog boxes and menu choices. For example: Start > Programs > IonixITA > Monitoring Server

• Courier fixed-width font is used for code elements (Java, HTML) as well as filenames and directories. For example:<installroot> refers to the directory where the Monitoring Server software is installed, for example

c:/Program files/IonixITA/Monitoring Server

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE ix

• Web addresses are displayed as hyperlinks. For example: http://www.EMC.com

Related documents 2

For more information on EMC Ionix IT Automator software products, refer to the following manuals:• EMC Ionix IT Automator Installation and Configuration Guide - This

manual provides information on installing the EMC Ionix IT Automator Server and Integrated Development Environment (IDE).

• EMC Ionix IT Automator Getting Started Guide - This manual provides a hands-on tutorial for novice users of the IDE. It provides step-by-step instructions for creating an EMC Ionix IT Automator application and deploying it to the Server.

• EMC Ionix IT Automator Server and Management Console User Guide - This manual explains how to use the Server Console and Management Console to manage the EMC Ionix IT Automator.

• EMC Ionix IT Automator Monitoring Server Console User Guide - This manual explains how to use the Monitoring Server Console to manage events from the EMC Ionix IT Automator and Adapter. The manual includes descriptions of the user interface, charts, and logs available from the Monitoring Server console.

x RELEASE 5.8 REV A01 300-010-288

1Chapter

Introduction 1

The EMC Ionix IT Automator Monitoring Server provides centralized event dispatching for the Automator and the Adapters. The Monitoring Server provides the following features:• Application Monitoring - Externally monitors the health of the

Automator and Adapter applications and generates infrastructure events• Integration Monitoring - Monitors the health of the integration and

generates transaction events indicating:— transaction performance and management— diagnostic and repair information

• Email Notification - Generates notification emails as specific events occur and sends the emails to a configured SMTP host and email address.

• SNMP Notifications - Generates SNMP notifications as specific events occur and sends the notifications to a specified IP address. A Monitoring Server Event MIB is provided for Enterprise Management System (EMS) integration.

• Logging - As events occur, the events are logged and stored on the Monitoring Server. Events logged to the events-console log file are viewed from the Management Server Console.

Figure 1-1 Feature Overview

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 1-1

MONITORING SERVER SOFTWARE ARCHITECTURE

Monitoring Server Software Architecture 1

The Monitoring Server is composed of software components that provide management and event information to all EMC Ionix IT Automator products, which are part of an integration or automation solution. These products include:• Adapters and Agents• Automator• Custom workflow applications built for each customer

The Monitoring Server is composed of the following software components (see Figure 1-2):• Event API - Used for dispatching events:

— Events dispatched by mechanisms: log file, email and SNMP— API Provided as Web Services (WSDL and REST)— Event Data

• Health Monitor - This component monitors the Adapter’s health.— Queue Size— Queue waiting time— Transaction flow (data going in and out of the queue)

• Application Monitor (AppMon) - This component monitors JVM health:— JMX over RMI - Used for Automator on the local network.— Adapters Monitor Probe - Special Web Service the Adapters provide.

Figure 1-2 Monitoring Server Software Architecture

1-2 RELEASE 5.8 REV A01 300-010-288

EVENT API

Event API 1

The Event API component is the core of the Monitoring Server. This component is responsible for providing an API (Web Service) to allow the Automator/Adapter infrastructure to generate events. The role of this component is to provide a common platform for providing information to enterprise management systems or directly to customers.

The Event API provides the following capabilities:• Event Logging - Generated events are logged to a log file. For the information

included in the logs, refer to Log File Event Information.• Email Notification - When a specific event occurs, email notifications are sent

to specific user groups. Filters can be created based on event severity that specify what types of email notifications will be sent to specific user groups.

• SNMP Notification - Notifications are received through an enterprise management system such as Tivoli, SCOM, and NSM, OVO.

Event Logging

The log handler is enabled by default and writes to the log file in the log/events.log file. These events are not written to the main log file.

Figure 1-3 provides an example of how an object would be represented as a String in the log file. • If the object data is not set, it is not shown. This also applies to a request,

transaction, retries and data. • If the serviceId, objectType or objectId is not set, a ‘?’ character is used as a

placeholder. Figure 1-3 Example Log Message

Figure 1-4 identifies a sample log message using test data. Note that the timestamp is the timestamp of the event itself and not when it was logged.

Figure 1-4 Example Log Message

timestamp severity [hostname:eventType] <obj: serviceId/objectType/ob-jectId, req: requestType, tx: transactionId, retries: retryCount> action - reason:\n data

2009-03-13 14:33:48,968 INFO [IMS] 2009-03-13 14:33:48,234 SEV4 [wl-jsmith:adapter.acquisition.enqueue] <obj: sevevent-1.0/Incident/ID3, txretries: 0> Item entered the Acquisition Queue:<?xml version="1.0" encoding="UTF-8" standalone="yes"?>...

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 1-3

EVENT API

Log File Event Information 

The following information is included in the log file for each event:• eventType - Type or name of the event. This can be used to classify and filter

different event types.— For Adapter event types, refer to Chapter 2, “Adapter Event Types”

and Chapter 2, “Application Monitor Events”.— For Automator event types, refer to Chapter 2, “Application Monitor

Events”.• transactionID - Identifier of the transaction. Typically this is correlated to the

Adapters Transaction ID. • hostname - Hostname or server that generated the event.• serviceId - Service ID of the event. Typically correlated to the Adapter

transaction service ID.• objectType - Type of the object that created the event. Typically correlated to

the Adapter transaction Object Type.• requestType - The type of the request. This is used to differentiate between

different processes that could handle the same type of object.• objectId - The identifier of the actual Incident, Event, Change, Problem or

other object.• reason - Message that indicates the reason for the event. Also known as the

message or description of the event.• timestamp - Time at which the event was generated. If no timestamp was

part of the original event, the timestamp will be provided when iMS receives the event.

• severity - Severity of the event. Identifies a number of 1 through 5 where 1 is the highest severity. The following describe how the severities are used for automated adapter events.— SEV1 - For Application Monitor events.— SEV2 - Threshold reached. Indicates that there may be a problem with

the solution that prevents it from operating normally.— SEV3 - An error occurred. This may be recoverable and does not

indicate an adapter problem.— SEV4 - Informational type messages. Useful for gathering statistics.— SEV5 - Occurs for frequent events that are often ignored. The poll

event is an example of this.• retryCount - The number of times particular operation has been performed.

This can be correlated to the Adapters poll count.• data - Large String object that can contain data for the event. Typically this

can be used for the XML of a transaction or any other custom data.

1-4 RELEASE 5.8 REV A01 300-010-288

EVENT API

• action - Action that can be performed. This can be set to 'clear' which means that a previous event should be cleared. For health monitoring type events, this allows problems to be resolved.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 1-5

APPLICATION MONITOR

Application Monitor  1

The Application Monitor (AppMon) is a special component of Monitoring Server that monitors at the Java Virtual Machine level. This component sends alerts if it cannot connect to the service for whatever reason (i.e., appmon.connection event type). The AppMon supports two mechanisms for monitoring applications:• JMX (for the Automator) – Monitoring is performed using JMX over RMI. JMX

provides authentication and SSL for the monitored applications when going across the Internet. JMX is used to monitor:— any Java application including old releases of the Adapters and

Automator — applications running on the same network as the Monitoring Server — the Automator

• Application Monitor Web Service Probe (for the Adapters) – This is a special web service that the Adapters will provide to allow the relevant JMX information to be retrieved over HTTP/HTTPS. This service requires no authentication and performs no operations on the Adapter (read only).

Figure 1-5 iMS Architecture

1-6 RELEASE 5.8 REV A01 300-010-288

APPLICATION MONITOR

Alert Thresholds 

With the Monitoring Server, you can configure thresholds for sending alerts to notify you when specific events have occurred on the Automator application server. The AppMon sends alerts indicating the following events have reached the defined threshold:• CPU usage - An alert is sent when the percentage of CPU used has reached

the configured threshold. The configured default threshold is 95%. (appmon.cpu).

• memory usage - An alert is sent when the percentage of memory (Java Heap) used has reached the configured threshold. The configured default threshold is 95%. (appmon.memory)

• number of threads- - An alert is sent when the number of threads used has reached the configured threshold. The configured default threshold is 500 threads. (appmon.threads).

The Monitoring Server also allows you to configure how often the Application Monitor will poll the applications being monitored. This includes specifying the number of minutes that the Application Monitor will wait between sending alerts of the same type. This configuration prevents 'email spamming' when the server is down.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 1-7

WSDL

WSDL 1

The following is the location of the Monitoring Server WSDL for publishing events: https://localhost:8443/services/ims/iWaveEventService?wsdl

The Monitoring Server services can also be leveraged using the RESTful endpoints. An HTTP POST can be done to one of the following URLs to publish events to the Monitoring Server. Schema for the XML format is attached. Samples of the XML are provided below:

• https://localhost:8443/services/ims/event - for sending a Automator/Adapter Event.

• https://localhost:8443/services/ims/event/list - for sending an Automator/Adapter List of Events.

Provided Methods 1

Methods provided for the service: • fire(iWaveEvent) – Sends a single event to the management service. • fire(List of iWaveEvent) – Sends multiple events to the

management service. This method allows batches of events to be sent in a single request.

1-8 RELEASE 5.8 REV A01 300-010-288

2Chapter

System Configuration 1

This chapter identifies the requirements for configuring the Monitoring Server and discusses the following topics:• Supported Operating Systems• System Requirements• Software Compatibility• Supported Configurations

Supported Operating Systems 1

The Monitoring Server software can be installed on the following operating systems:• Windows - NT4, 2000, XP, 2003 Server, 2008 Server• UNIX- Solaris 10 (Sparc), HP-UX 11 (Itanium), AIX• Linux - x86, x64, Kernel 2.6 (or higher)

Note: The Monitoring Server Console is only supported on the Windows operating system.

System Requirements 1

Before you install the Monitoring Server software, your machine must meet the following system requirements.

Recommended

The following are the recommended system requirements for installing the Monitoring Server software:• CPU: Dual Core Processor running 2GHz or higher • RAM: 2GB • Disk Space: 1GB free disk space

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 2-1

SOFTWARE COMPATIBILITY

• Java Runtime Environment: JRE 6.0 Update 6 is recommended. This is bundled with the Windows installer.

Minimum

The following are the minimum system requirements for installing the Monitoring Server software:• CPU: Pentium Class or Equivalent Processor or higher • RAM: 512MB Free • Disk Space: 500MB free disk space • Java Runtime Environment: JRE 6.0 Update 6 is recommended. This is

bundled with the Windows installer.

Monitoring Server Console Online Help 

To view the context sensitive help on the Monitoring Server Console, a PDF viewer is required.

Software Compatibility 1

The Monitoring Server is compatible with the following EMC Ionix IT Automator products:• EMC Ionix IT Automator Adapters - version 2.2 (or later)• EMC Ionix IT Automator - version 5.8 (or later)

Supported Configurations 1

The Monitoring Server is supported in two different configurations:• Standalone - The Monitoring Server is installed on a standalone server. No

other Automator or Adapter products are installed on the Monitoring Server. This is the recommended configuration.

• With Existing Adapter Framework - The Monitoring Server is installed on a server with an existing Adapter Framework.

Note: Be aware that if the Monitoring Server is installed with an existing Adapter Framework, the Monitoring Server is linked to the Adapter Framework. If the Adapter Framework goes down, the Monitoring Server Framework will go down as well.

2-2 RELEASE 5.8 REV A01 300-010-288

3Chapter

Event Types 2

This chapter identifies the event types for the Adapter and Application Monitor (Adapter and Automator).

Adapter Event Types 2

The following types of events are generated for the Adapter:• Acquisition Queue - events are generated indicating the status of the

Acquisition Queue. Events are generated indicating:— the status of the queue item (i.e., the item is being placed in the queue,

complete)— if the queue item has an error— the status of the queue size — if the queue size has exceeded the defined threshold.— the status of the Automator/Adapter polling

• Operations - events are generated indicating the status of the data modification operations. This includes identifying the status of the modification operation or identifying if an error occurred during the modification operation.

Acquisition Queue Event Types 

This section defines the various events that are built in to the system. • adapter.acquisition.enqueue - An item enters the acquisition

queue: — Severity - SEV4 — Reason - Item entered the Acquisition Queue.

• adapter.acquisition.enqueueError - An error occurs placing an item on the acquisition queue — Severity - SEV3 — Reason - Stacktrace and message of the error. — ServiceId - Used from the acquisition-event or notification servic.e — ObjectType - User supplied type or what is provided on the service.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 3-1

ADAPTER EVENT TYPES

— RequestType - Either 'acquisition-event' or 'notification' depending on the service called.

— The data fields XML is placed in the data field. • adapter.acquisition.ack - item on the queue is acknowledged as

complete. — Severity - SEV4 — Reason - Transaction Marked as Complet.e

• adapter.acquisition.ackError - item on the queue is acknowledged as error. — Severity - SEV3 — Reason - user supplied error message.

• adapter.acquisition.pendingTimeout - A timeout occured on a 'Pending' record. It has been set back to poll. — Severity – SEV3 — Reason – Pending Transaction Timed-out.

• adapter.acquisition.poll - Indicates a poll operation has been performed. This can be used as a heartbeat to verify that the Automator is alive. — Severity - SEV5 — Reason - Poll operation called

• adapter.operations.create - An data modification operation create is attempted — Severity - SEV4 — RequestType - create — ServiceId - Full class name of the service. — Reason - Create operation call succeeded.

• adapter.operations.update - An data modification operation update is attempted — Severity - SEV4 — RequestType - update — ServiceId - Full class name of the service. — Reason - Update operation call succeeded.

• adapter.operations.error - An error occurs during a modification operation — Severity - SEV3 — Reason - Stacktrace of the error. — RequestType - Method name that caused the problem (i.e., create,

update.) — ServiceId - Full class name of the service.

3-2 RELEASE 5.8 REV A01 300-010-288

ADAPTER EVENT TYPES

Acquisition Queue Condition Events

The following events are triggered off of some condition in the Adapters. A service is required to periodically check the health of the Adapters (and Automator) and generate events if a problem is detected. • adapter.acquisition.queuesize - Acquisition queue size exceeds

the configured threshold. If the queue size gets too large that could indicate a problem. This error state is checked every 5 minutes. — Severity - SEV2 — Action - Set to 'clear' if the problem has corrected itself. — Reason - Acquisition Queue exceeded threshold. Queue size: x — Clear Reason - Acquisition Queue threshold cleared. Queue size: x

• adapter.acquisition.queuewait - Item available for poll on the acquisition queue has not been processed in a timely manner (Configurable timeout). This error state is checked every 5 minutes. — Severity - SEV2 — Action - Set to 'clear' if the problem has corrected itself. — Reason - Acquisition Queue wait time for X records — Clear Reason - Acquisition Queue wait time cleared

The following events are generated by the Monitoring Server when Health Monitoring is enabled. For more information on enabling Health Monitoring, refer to “Health Monitor Configuration” on page 3-4.• adapter.acquisition.consumer - Indicates that the poll service on

the Adapters have not been called within the required configurable time period. Automator poll calls are determined using the poll event listed above. This is often used to indicate that the Automator is down since it is not polling the adapter. This error state is checked once per 5 minutes. Since this message could often generate false positives, it is only sent once when the problem is detected. When the condition is cleared, the clear message is sent. — Severity - SEV2 — Action - Set to 'clear' if the problem has corrected itself. — Reason - No consumer is polling the acquisition queue. — Clear Reason - Polling of the acquisition queue restored.

• adapter.acquisition.producer - Indicates that the inbound agent service on the Adapters have not been called within the required configurable time period. This is performed using the adapter.acquisition.enqueue event type. This is often used to indicate that the Agent may be down and it is not calling the Adapter. This could also mean that there is no new data being produced in the endpoint application. This should be treated as indicating that there may be a problem. This error state is checked once per 5 minutes. Since this message

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 3-3

ADAPTER EVENT TYPES

could often generate false positives, it is only sent once when the problem is detected. When the condition is cleared, the clear message is sent. — Severity - SEV2 — Action - Set to 'clear' if the problem has corrected itself. — Reason - No producer is putting items into the acquisition queue. — Clear Reason - Queuing of items has been restored.

3-4 RELEASE 5.8 REV A01 300-010-288

APPLICATION MONITOR EVENTS

Application Monitor Events 2

The Application Monitor (AppMon) events can be for either the Adapters or Automator application. Many of the events are about the integration or the application using the Adapters. They are generated by the Adapter but indicate errors in Automator. The 'no consumer' event means automator is not polling the adapter queue. It indicates an automator problem

The following events are generated by the Application monitor. In the event, NAME identifies the name of the application that caused the problem: • appmon.cpu.NAME – Indicates that an application being monitored by the

AppMon component exceeded the CPU threshold. — Severity – SEV1 — Action – Set to ‘clear’ if the problem has corrected itself. — Reason – CPU Usage Exceeded the threshold, XX% — Clear Reason – CPU Usage is under the threshold

• appmon.memory.NAME – Indicates that an application being monitored by the AppMon component exceeded the memory threshold. — Severity – SEV1 — Action – Set to ‘clear’ if the problem has corrected itself. — Reason – Memory Usage Exceeded the threshold, XX% — Clear Reason – Memory Usage is under the threshold

• appmon.threads.NAME – Indicates that an application being monitored by the AppMon component exceeded the threads threshold. — Severity – SEV1 — Action – Set to ‘clear’ if the problem has corrected itself. — Reason – Thread Usage Exceeded the threshold, XX — Clear Reason – Thread Usage is under the threshold

• appmon.connection.NAME – Indicates that an application being monitored by the AppMon cannot be reached. Either the application is down, the server running the application is down or there is a network connectivity issue. — Severity – SEV1 — Action – Set to ‘clear’ if the problem has corrected itself. — Reason – Unable to establish connection to the application service.

The application may be down. Previous uptime was: xxh — Clear Reason – Connection re-established to the application service. — Data – Stacktrace of the failed connection.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 3-5

APPLICATION MONITOR EVENTS

3-6 RELEASE 5.8 REV A01 300-010-288

4Chapter

Software Installation 1

Overview 1

Based on the type of configuration required, the following components may be installed with the EMC Ionix IT Automator Monitoring Server (see Figure 1-1):• Automator – includes the Automator software and license file. The

installation may also include the IDE software, which also requires a license.• Adapters – includes the Adapter software and license file.• Adapter Agent – includes the Adapter URL Agent software or custom Agent.

(Optional)• License files – are provided by EMC Customer Support and must be installed

in the appropriate directory.The Monitoring Server may be installed in two different modes and may include the Monitoring Server Console:• Standalone - The Monitoring Server is installed on a standalone server. No

other Automator/Adapter products are installed. • With Existing Adapter Framework - The Monitoring Server is installed on a

server with an existing Adapter Framework.Figure 1-1 Installation Components

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-1

INSTALLING A LICENSE FILE

Installing a License File 1

When the Monitoring Server software is purchased, a software license file (in XML format) is provided by EMC Customer Support. The license file identifies the following information for each Monitoring Server included in the Automator software configuration:• the Monitoring Server software version• the expiry date for the Monitoring Server software• the license key

During the Monitoring Server software installation, the user identifies the location of the license file. The installer then copies the license file from the original location to the following Monitoring Server software directory:

<install_directory>/conf

4-2 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

Installing the EMC Ionix IT Automator Software ­ Windows 1

This section identifies the steps required for installing the Monitoring Server software.

Before You Begin

Before you install the Monitoring Server software, complete the following tasks:• Identify the location of theMonitoring Server license file.• Close all Windows applications.• Determine on which mode the Monitoring Server software will be installed.

Start the Installer

To install the Monitoring Server software, complete the following steps:1. Access the location of the Monitoring Server installer executable. Double-click

the setup-MonitoringServer-5.8-winxx.exe file. 2. The Open File Security Window may display. From this screen, give the

application permission to be installed on your computer.3. The InstallAnywhere progress screen displays.Figure 1-2 Installer Progress Screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-3

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

4. The Monitoring Server Installation Starting screen displays.Figure 1-3 Monitoring Server Installation Starting

5. After the InstallAnywhere Wizard finishes loading, the Introduction screen displays. From this screen, click Next to continue.

Figure 1-4 Introduction Screen

4-4 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

6. The Install Options screen displays. From this screen, select the appropriate option and click Next.— Install Monitoring Server - Select this check box to install the Monitoring

Server and then select the appropriate configuration:– Standalone - Select this option to install the Monitoring Server

software on a standalone server. If this option is selected, go to step 7.– Over an existing adapter framework - Select this option if you have

Adapter software previously installed. If this option is selected, go to step 8.

— Install Monitoring Server Console - Select this check box to install the console with the Monitoring Server. If this is the only option selected, go to step 23.

Figure 1-5 Install Options Screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-5

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

7. If the Install Monitoring Server Standalone option is selected, the Choose Install Folder screen displays. The default installation folder is displayed. To change the install folder, click the Choose button and navigate to the appropriate installation directory. Click Next and go to step 9.

Figure 1-6 Choose Install Folder Screen

4-6 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

8. if the Install Monitoring Server over an existing adapter framework option is selected, the Choose the Adapter Install Folder screen displays. The default installation folder is displayed. To change the install folder, click the Choose button and navigate to the appropriate installation directory. Click Next and go to step 14.

Figure 1-7 Choose Install Folder Screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-7

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

9. The Choose Shortcut Folder screen displays. From this screen, specify the areas where the software shortcut icons will be created. Click the Next button to continue.— In a new Program Group – creates a new program group with the

specified name and includes a shortcut in the Windows All Programs list.

— In an existing Program Group – includes a shortcut in an existing program group.

— In the Start Menu – includes the Monitoring Server shortcut in the Start menu.

— On the Desktop – creates a Monitoring Server shortcut on the desktop.

— In the Quick Launch Bar – includes the Monitoring Server shortcut in the Quick Launch menu bar.

— Other – specify a custom directory location by selecting the Choose button.

— Don’t create icons – Select this option if you do not want to create an Monitoring Server shortcut.

— Create Icons for All Users – Select this option to create shortcuts for all users configured on the server. The shortcuts are only added to the Start Menu and Desktop.

Figure 1-8 Choose Shortcut Folder Screen

4-8 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

10. The Choose License File screen displays. From this screen, verify that the license file location identified in the Please Choose License File field, is correct. To change the license file location, select the Choose button and select the appropriate directory. Click Next.

Figure 1-9 Choose License File Screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-9

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

11. The Enable Security screen displays. On this screen, the Use HTTPS (port 8443) check box is selected by default. This option uses SSL for secure Web-based communications. To use standard unsecured HTTP Web-based communications, uncheck this box. Click Next.

Figure 1-10 Enable Security screen

4-10 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

12. If you selected the HTTPS (port 8443) option, the Web Service Authentication screen displays. From this screen, enter the Username and Password you want to use for HTTPS authentication. You must enter the password twice for confirmation purposes. Click Next.

Figure 1-11 Web Services Authentication

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-11

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

13. The Pre-Installation Summary screen displays. Using the scroll bar, review the information before continuing the installation process.— If the information is correct, click Next.— If the information is incorrect, click Previous and change the

configurations on the previous screen. Click Next when done.Figure 1-12 Pre-Installation Summary

4-12 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

14. The Monitoring Server Configuration screen displays. Click Next.Figure 1-13 Monitoring Server Configuration

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-13

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

15. The Monitoring Server Automator Properties screen displays. From this screen, select the Automator Monitoring check box to specify if you want the Monitoring Server to monitor the Automator. Specify the RMI for the Automator monitoring. The default RMI URL is:service:jmx:rmi:///jndi/rmi://HOST:PORT/jmxrmi

Figure 1-14 Monitoring Server Automator Properties screen

4-14 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

16. The Monitoring Server Adapter Properties screen displays. From this screen, complete the following steps and click Next:— If you want the Monitoring Server to monitor the Adapters, select the

Adapters check box. – Select the appropriate radio button to identify the HTTP method

to be used - HTTPS or HTTP.– Specify the appropriate URL for the HTTP method.

— If you do not want theMonitoring Server to monitor the Adapters, ensure that the Adapters check box is not selected.

Figure 1-15 Monitoring Server Adapter Properties screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-15

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

17. The Monitoring Server Acquisition Configuration screen displays. Provide the following information and click Next:— If you want the Monitoring Server to monitor the Automator

Acquisition Service, select the Acquisition Monitoring check box. Specify the following information:– Queue Threshold - Identifies the number of events allowed to be

stored in the Acquisition Queue before an alert is generated. (Default: 300).

– Queue Waiting Time - Identifies the amount of time (in hours) that an item is stored in the Acquisition Queue. (Default: 24 hours).

— If you do not want the Monitoring Server to monitor the Acquisition Service, ensure that the Acquisition Monitoring check box is not selected.

Figure 1-16 Monitoring Server Acquisition Configuration screen

4-16 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

18. The Monitoring Server Alerts Configuration screen displays. Specify the following information and click Next:— URL - identify the URL for the Monitoring Server receiving the alerts.

Leave blank to use the local Monitoring Server.— Username - identify the username used to access the Monitoring

Server.— Password - identify the password associated with the username used

to access the Monitoring ServerFigure 1-17 Monitoring Server Alerts Configuration screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-17

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

19. The Monitoring Server Application Configuration screen displays. From this screen, provide the following information and click Next.— Poll Interval - Identifies the time interval (in milliseconds) the

Application Monitor will poll the applications being monitored. (Default: 45000)

— Alert Threads Threshold - Identifies the number of threads used before an alert is sent. (Default: 500)

— Alert Memory Threshold - Identifies the percentage of memory usage exceeded before an alert is sent. (Default: 95)

— Alert CPU Threshold - Identifies the percentage of CPU usage exceeded before an alert is sent. (Default: 95)

— Minutes Between Alerts - Identifies the number of minutes that the Application Monitor will wait between sending alerts of the same type. (Default: 30)

Figure 1-18 Monitoring Server Application Configuration screen

4-18 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

20. The Monitoring Server Health Configuration screen displays. Select the Enable Health Monitoring check box to enable Health Monitoring. Provide the following information and click Next.— Poll Requirements - Identifies the how often (in minutes) the events

are polled. (Default: 60)— Enqueue Requirements - Identifies how often (in minutes) events

must occur before the event is generated. (Default: 60)Figure 1-19 Monitoring Server Health Configuration screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-19

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

21. The Monitoring Server Email Configuration screen displays. Select the Enable Email Handler check box to enable email notification. Provide the following information and click Next.— Host - The hostname of the email server. — Port - The port of the email server. (Default: 25)— From - The email address where the event is sent from. (Default:

noreply@yourcompany.com)— To - The email address where the event is sent to.

Figure 1-20 Monitoring Server Email Configuration screen

4-20 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

22. TheMonitoring Server SNMP Configuration screen displays. Select the Enable SNMP check box to enable SNMP Authentication. Provide the following information and click Next.— Filter - identify the filter to apply to SNMP notifications. — Address - The IP address of the SNMP host. When entering the

address, a forward slash (/) must separate the IP address and UDP port number. (Default: 127.0.0.1/162)

Figure 1-21 Monitoring Server SNMP Configuration screen

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-21

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

23. The Preparing to Install screen displays. Click Install.Figure 1-22 Preparing to Install

4-22 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

24. The Installing Monitoring Server screen displays. This screen displays the progress of the installation process. During this step, the Windows Service is installed and a keystore file is generated for SSL.

Figure 1-23 Installing Monitoring Server

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-23

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

25. The Start Service screen displays when the installation is complete.If you wish to start the service after the installation is complete, click Start Service After Install. Click Next.

Figure 1-24 Start Service

4-24 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE EMC IONIX IT AUTOMATOR SOFTWARE - WINDOWS

26. The Install Complete screen displays. Click Done to exit the installer.Figure 1-25 Install Complete

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-25

RUNNING THE MONITORING SERVER AS A WINDOWS SERVICE

Running the Monitoring Server as a Windows Service 1

The Monitoring Server Windows Service is automatically installed during the installation process and, if selected, automatically started after the installation is complete. From the Windows Start menu, shortcuts are provided for starting and stopping the Windows Service:• To start theMonitoring Server Service, select Start>All

Programs>Monitoring Server>Start Service.• To stop the Monitoring Server Service, select Start>All

Programs>Monitoring Server>Stop Service.Figure 1-26 Starting the Monitoring Server Service

Executable Location

Two executable files are provided for interacting with the Windows Service:• adapter.exe: The main executable that launches the service (if installed).• adaptersw.exe: The manager application that allows you to configure

options of the service such as turning on debugging. The service can also be started and stopped from this console.

These files are located in the EMC Ionix IT Automator directory:install_root/bin

Manager Application

The manager application that allows you to configure options of the service such as turning on debugging. The service can also be started and stopped from this console.

4-26 RELEASE 5.8 REV A01 300-010-288

RUNNING THE MONITORING SERVER AS A WINDOWS SERVICE

Figure 1-27 Adapters Properties - Services Manager Console

Manual Install or Uninstall

If the Windows Service needs to be re-installed or un-installed, complete the following steps:

Re­installing the Windows Service

To re-install the Windows Service:

1. Access the bin directory:install_root/bin

2. Run the installation script.service.bat install

Uninstalling the Windows Service

To uninstall the Windows Service:

1. Access the bin directory:install_root/bin

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-27

RUNNING THE MONITORING SERVER AS A WINDOWS SERVICE

2. Run the un-install script.service.bat uninstall

Starting and Stopping the Monitoring Server

If the Windows Service has been uninstalled and the Monitoring Server needs to be started, the startAdapters.bat file is included in the following directory:

install_root\bin\startAdapters.bat

This command starts the Monitoring Server framework with a command window. To stop the Monitoring Server framework, close the command window.

4-28 RELEASE 5.8 REV A01 300-010-288

INSTALLING THE MONITORING SERVER SOFTWARE - UNIX

Installing the Monitoring Server Software ­ UNIX  1

Before You Begin

Before installing the Monitoring Server on the UNIX platform, you must complete the following tasks:• For UNIX platform:

— Install the Java Runtime Environment (JRE) 6 Update 11. — Set the JAVA_HOME environment variable to point to the JRE

environment. • For both UNIX and Linux (optional):

— Create an "admin" user for running the framework.

Installing the Software

To install the Monitoring Server software on a UNIX platform, run the appropriate setup application from the Linux or Unix prompt.• Linux Installer: setup-MonitoringServer-5.8-linux.bin• Other Unix Platforms: setup-MonitoringServer-5.8-unix.bin

If your system does not have a graphical user interface, run the installer in console mode. When entering the command, specify the –i console option. For example:/setup-MonitoringServer-5.8-unix.bin –i console

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-29

RUNNING THE MONITORING SERVER AS A UNIX SERVICE

Running the Monitoring Server as a UNIX Service 1

The bin/service.sh script starts and stops the Monitoring Server as a service. A special file service.PID is created when the service is started. This is used to find the PID of the running service. Do not delete this file manually.

• Starting the service: ./service.sh start• Stopping the service: ./service.sh stop• Restarting the service: ./service.sh restart• Service Status: ./service.sh status

If you wish the service to start automatically at boot time, the following is a sample init.d script you can use to call the service.sh script:

#!/bin/shIWAVE_USER=iwaveIWAVE_SERVICE=/usr/<install_root>/MonitoringServer/bin/service.shsu - ${IWAVE_USER} -c "$IWAVE_SERVICE" $1

4-30 RELEASE 5.8 REV A01 300-010-288

MANUAL INSTALLATION PROCEDURES

Manual Installation Procedures 1

If an installation is being performed on an unsupported operating system, the Monitoring Server can be installed manually without the installer.

Prerequisites

Before manually installing the Monitoring Server software, you must complete the following tasks:• Ensure that you are installing on either a Windows or UNIX platform.• Java 6 must be installed and run on the local computer. If multiple Java

platforms are present on the local computer, make sure that %JAVA_HOME% points to Java 6 when running the Monitoring Server.

• A Monitoring Server license file (license.xml) must be copied to the %IWAVE_HOME%\conf directory. If you do not have a license file for your Monitoring Server, contact your EMC Sales Representative.

Install the Files

To install the files manually:1. Request a zipped copy of the Monitoring Server be placed on theEMC FTP site.2. Download and extract the zipped file.3. Place the extracted files in any directory on any machine with network access

to the computer running the endpoint application.

Note: For Windows installations, there are no registry keys to edit. The location of these files is referred to as %IWAVE_HOME%.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-31

CONFIGURE SSL COMMUNICATION

Configure SSL Communication 1

If the Monitoring Server and Adapter software are installed on separate servers, SSL communication must be established between the two servers (see Figure 1-28). During installation, a keystore.jks file and certificate file (with default environment settings) are installed in the Monitoring Server conf directory.

Figure 1-28 SSL Configuration

To establish SSL communications between the Monitoring Server and Adapter, complete the following steps:

1. From the Monitoring Server, copy the hostname.cer certificate to the Adapter server.

2. From the Adapter server, import the certificate into the Java cacerts file. To import the certificate, type the following commands at the Windows prompt:set JAVA_HOME=C:\Program Files\Java\jre1.5.0_14

"%JAVA_HOME%\bin\keytool" -import -alias iwave -v -file hostname.cer -keypass iwave -storepass changeit -keystore "%JAVA_HOME%\lib\security\cacerts"

Creating a New Keystore File

If you need to create a new keystore file due to a file corruption or improper configuration, the original keystore file must be deleted and replaced with a new file that contains the appropriate hostname and JAVA version.

1. From the Monitoring Server. access the <install_directory>\conf directory.

4-32 RELEASE 5.8 REV A01 300-010-288

CONFIGURE SSL COMMUNICATION

2. Delete the file called keystore.jks.3. Set the JAVA_HOME environment variable to the version of Java 6 you are

using to run the Adapter.set JAVA_HOME=C:\Program Files\Java\jre1.6.0_04

4. Generate a new keystore.jks file using the following command:"%JAVA_HOME%\bin\keytool" -genkey -alias iwave -keyalg RSA -keysize 1024 -dname "CN=<your Monitoring Server hostname>, OU=Development, O=EMC Corporation, L=Hopkin, ST=MA, C=U.S.A." -keypass <password> -storepass <password> -keystore "<install_directory>\conf\keystore.jks"

5. The new keystore.jks file is saved in the conf directory.

Export a Certificate from the Keystore File

If you need to export a new certificate from an updated keystore file, complete the following steps.1. Access the Adapter <install_directory>\conf directory.2. Run the following commands from a batch file or command prompt. This

command creates a file called certificate.cer in the conf directory.set JAVA_HOME=C:\Program Files\Java\jre1.6.0_04

"%JAVA_HOME%\bin\keytool" -export -alias iwave -file certificate.cer -keypass iwavepw -storepass iwavepw -keystore "<install_directory>\conf\keystore.jks"

Export the Self­Signed SSL Key to the Adapter Server

If you are using a self-signed SSL key for the framework (like one generated with the description above), complete the following steps.

Note: These steps are not required if you are using a key signed by a certificate authority.

If you need to call the Monitoring Server from the Adapter, you need to add the certificate to the JRE CA certificates that BPI uses. The following steps will add the key to the cacerts of the JRE set by the JAVA_HOME environment variable.

"%JAVA_HOME%\bin\keytool" -export -alias iwave -file certificate.cer -keypass iwavepw -storepass iwavepw -keystore ..\conf\keystore.jks"

"%JAVA_HOME%\bin\keytool" -delete -alias iwave -storepass changeit -keystore "%JAVA_HOME%\lib\security\cacerts"

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 4-33

STARTING THE MONITORING SERVER CONSOLE

"%JAVA_HOME%\bin\keytool" -import -alias iwave -v -file certificate.cer -keypass iwave -storepass changeit -keystore "%JAVA_HOME%\lib\security\cacerts"

Signing Certificates using a Certificate Authority

The following steps explain how to take the generated keys in the Monitoring Server and sign the certificate using a certificate authority (CA).

1. Before the CA can sign your certificate, you must first generate a certificate signing request (CSR). To generate a CSR, use the following command to specify the CSR filename (i.e., certificate.pem), password and keystore filename. "%JAVA_HOME%\bin\keytool" -certreq -alias iwave -file certificate.pem -keypass iwavepw -storepass iwavepw -keystore ..\conf\keystore.jks

2. Send the certificate.pem file to the CA. The CA will sign the certificate.pem file and send you a keychain file (i.e., certificate.chain).

3. Use the following command to import the keychain file (i.e., certificate.chain) into the keystore.jks file. keytool -import -file certificate.chain -keypass iwavepw -storepass iwavepw -keystore ..\conf\keystore.jks

4. The keystore.jks file is now signed by the CA.

Starting the Monitoring Server Console 1

After installation, start the Monitoring Server Console to ensure that it has been installed correctly. To start theMonitoring Server Console, select Start>All Programs>Monitoring Server>MS Console. For more information on the Monitoring Server Console, refer to the Monitoring Server Console User Guide.

Figure 1-29 Starting the Monitoring Server Console

4-34 RELEASE 5.8 REV A01 300-010-288

5Chapter

Monitoring Server Configuration 2

This chapter discusses the procedures that must be completed in order to:• Establish the Monitoring Server Connection with the Automator and

Adapters• Change the Monitoring Server Configuration

Establish the Monitoring Server Connection with the Automator and Adapters 2

After installation, Monitoring Server is configured to communicate with the Adapter and Automator (if monitored). In order for the Adapter or Automator to send events to the Monitoring Server, the following procedures must be completed:• Enable JMX on the EMC Ionix IT Automator• Provide Monitoring Server Information on the Adapter

Enable JMX on the EMC Ionix IT Automator

To configure the Automator to send events to the Monitoring Server, JMX must be enabled on the Automator. To enable JMX, complete the following steps:1. From the Automator server, stop the Server (Stop Schedules, Stop Virtual

Server, Stop Server).2. Access the bin directory.3. Using a text editor, open the file engine.l4j.ini file.4. Add the following environment variables to the file:

{{{— Dcom.sun.management.jmxremote.port=1234

— Dcom.sun.management.jmxremote.authenticate=false

— Dcom.sun.management.jmxremote.ssl=false

}}}

5. Save and Close the file.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 5-1

CHANGE THE MONITORING SERVER CONFIGURATION

Provide Monitoring Server Information on the Adapter

If the Monitoring Server is installed on a different host from an Adapter, the appropriate information must be provided during the Adapter installation to connect to the remote Monitoring Server. • Monitoring Server URL - Identifies the URL for the Event Service. Default:

https://localhost:8443/services/ims/iWaveEventService• Monitoring Server username - The Monitoring Server username for basic

authentication. (Default: admin)• Monitoring Server password - The Monitoring Server password associated

with the username. (Default: password)

Change the Monitoring Server Configuration 2

During installation, the following configuration files are copied to the \EMC Ionix IT Automator \conf and \endpoints\iMS directories. • \endpoints\iMS directory:

— email-ims-handler-spring.xml- Specifies the SMTP email configuration.

• \conf directory:— appmon.properties - Specifies the monitored applications.— framework.properties - Specifies all configurations for the

Monitoring Server features. Refer to Chapter 3, “Framework Configuration”for more information.

These files may need to be modified after installation to complete the following tasks:• Configure SMTP Server Authentication• Add a Monitored Application

Configure SMTP Server Authentication

If the SMTP server requires authentication or SSL, modify the email-ims-handler-spring.xml file to include the following SMTP configurations:• username - the username for the SMTP server.• password - the password associated with the username.

5-2 RELEASE 5.8 REV A01 300-010-288

CHANGE THE MONITORING SERVER CONFIGURATION

Figure 2-1 Modifying the email-ims-handler-spring.xml File

Add a Monitored Application

After installation, if a new or different application needs to be monitored by the Monitoring Server, the appmon.properties file must be modified using the Properties Editor tool (see Figure 2-2). The appmon.properties file contains a list of service names with the URLs to connect in order to monitor the service. When entering the service name and URL, the service name must be unique within this file and contain no spaces. It represents the common name of the service being monitored.

For each of the following examples, replace the HOST and PORT with the host and port configured on that particular service. • To set up monitoring over JMX, enter the following line under the Example

Automator monitoring line:automator=service:jmx:rmi:///jndi/rmi://HOST:PORT/jmxrmi

• To set up monitoring using the Adapters Monitor Probe over HTTPS, enter the following line under the Example Adapter monitoring line:adapters=https://HOST:PORT/services/MonitorProbeService

• To set up monitoring using the Adapters Monitor Probe over HTTP, enter the following line under the Example Adapter monitoring line: adapters=http://HOST:PORT/services/MonitorProbeService

- <!-- SMTP Authentication.--> - <!--

<property name="username" value=""/> <property name="password" value=""/> <property name="javaMailProperties"> <props> <prop key="mail.smtp.auth">true</prop> <prop key="mail.smtp.starttls.enable">true</prop> </props> </property>-->

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 5-3

CHANGE THE MONITORING SERVER CONFIGURATION

Figure 2-2 Example appmon.properties file

Disable SSL

To change the port or disable SSL on the Monitoring Server, the client.url option can be modified in framework.properties file.

## ## Monitoring Server Application Monitor ## ## This file contains a list of service names and the URL to connect to moni-tor ## the service. Format SERVICE_NAME=URL. The SERVICE_NAME must be unique within ## this file and contain no spaces. It represents the common name of the ser-vice ## being monitored. ## ## For each of the following examples, replace the HOST and PORT ## with the host and port configured on that particular service. ## ## To set up monitoring over JMX use: ## ## automator=service:jmx:rmi:///jndi/rmi://HOST:PORT/jmxrmi ## ## To set up monitoring using the Adapters Monitor Probe over HTTPS: ## ## adapters=https://HOST:8443/services/MonitorProbeService ## ## To set up monitoring using the Adapters Monitor Probe over HTTP: ## ## adapters=http://HOST:8080/services/MonitorProbeService ## # Example Automator monitoring automator=service:jmx:rmi:///jndi/rmi://localhost:1234/jmxrmi # Example Adapter monitoring adapters=https://localhost:8443/services/MonitorProbeService

5-4 RELEASE 5.8 REV A01 300-010-288

6Chapter

Framework Configuration 3

During installation, the following parameters are configured for the Monitoring Server:• Application Monitoring Alerts• Event Filtering• Notification Emails• SNMP Notifications• Health Monitoring

If you need to change these configurations after installation, use the PropertiesEditor tool to modify the framework.properties file.

Properties Editor Tool 3

The Properties Editor is a tool used to edit configuration properties in the framework.properties file. This command allows encrypted parameters to be specified.

Starting the Tool

To start the Properties Editor tool, execute the following batch file or shell script from the command line:• For Windows: bin/propertiesEditor.bat • For Unix: bin/propertiesEditor.sh

Using the Command

When entering the PropertiesEditor command, multiple options can be specified in a single invocation of the command.

Usage

PropertiesEditor [options] <target-file>

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 6-1

CONFIGURING APPLICATION MONITORING ALERTS

Options

-p <key>=<value> Sets a property with the key and value specified in plain text.

-e <key>=<value> Sets a property with the key and value specified in encrypted data.

-h <key>=<value> Sets a property with the key and value specified in SHA-1 Hashed format. This is used for framework passwords.

-m <file> Merges multiple properties from the file specified to the target file.

Configuring Application Monitoring Alerts 3

The following framework properties are used to configure the thresholds for alerts being sent from the Application Monitor when monitoring the Java Virtual Machine level. This component sends alerts if it cannot connect to the service for whatever reason (appmon.connection event type). • ims.appmon.poll-interval-milliseconds- Identifies the time

interval (in milliseconds) the Application Monitor will poll the applications being monitored. (Default: 45000)

• ims.appmon.alert-threads-threshold - Identifies the number of threads used before an alert is sent. (Default: 500)

• ims.appmon.alert-memory-threshold - Identifies the percentage of memory usage exceeded before an alert is sent. (Default: 95)

• ims.appmon.alert-cpu-threshold - Identifies the percentage of CPU usage exceeded before an alert is sent. (Default: 95)

• ims.appmon.minutes-between-alerts - Identifies the number of minutes that the Application Monitor will wait between sending alerts of the same type. This prevents 'email spamming' when the server is down. (Default: 30)

6-2 RELEASE 5.8 REV A01 300-010-288

EMAIL CONFIGURATION

Filtering Events Notifications for Logs, Email and SNMP

When sending email notifications, events can be filtered based on any of the event data. Filtering is performed by a Groovy expression that must return a boolean value.

Note: For more information on the capabilities of the Groovy language, consult the Groovy documentation URL:http://groovy.codehaus.org/Documentation

When writing the expression, the filter is written in the following format:ims.filtertype.filter = e.NAME.value operatorwhere:• filtertype = the type of filter. Valid values are SNMP, mail, or log.• e = indicates that an event is being filtered.• NAME = the name of the property.• value = if the property name is “severity”, identifies the severity level of the

event (enumeration value of 1-5).• operator = includes the operator for the filter (equal to, less than, greater

than, etc.)

The following examples identify how filtering can be configured:• No filtering is performed - An empty filter property indicates that no filtering

is performed. In the following example, all events are logged; no filtering is performed:ims.log.filter =

• Restrict to certain event severity or retry count - The following filter sends an email when a severity SEV1 event occurs or a retry count is greater than 5. ims.mail.filter = e.severity.value < 2 || e.retryCount > 5 #

• Restrict to certain event types - This filter restricts to the certain event type. For example:ims.snmp.filter = e.eventType = "alarm"

Email Configuration 3

Email configuration is handled by the email-ims-handler-spring.xml file which is located in the conf directory. The following parameters are used to configure how notification emails will be sent from the Monitoring Server.• ims.mail.smtp.host - The hostname of the email server. • ims.mail.smtp.port - The port of the email server. (Default: 25)• ims.mail.from = The email address where the event is sent from.

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 6-3

SNMP NOTIFICATION CONFIGURATION

• ims.mail.to - The email address where the event is sent to.• ims.mail.filter- Specifies the filter to apply to email notifications.

(Default: e.severity.value < 2 || e.retryCount > 5)• ims.mail.subject-template - The Groovy script that evaluates to the

subject of the email. (Default: \"[IMS] $e.severity [$e.hostname:$e.eventType] $e.reason\")

• ims.mail.body-template - The Groovy script that evaluates to the body of the email. (Default: \"$e\")

SNMP Notification Configuration 3

SNMPv2 configuration is handled by the snmp-ims-handler-spring.xml file which is located in the conf directory. SNMPv2 Notifications can be sent for events that are received.

The following parameters are used to identify the IP address of the SNMP host and specify if a filter will be applied to an SNMP notification. • ims.snmp.address - The IP address of the SNMP host. When entering the

address, a forward slash (/) must separate the IP address and UDP port number. (Default: 127.0.0.1/162)

• ims.snmp.filter - Specifies the filter to apply to SNMP notifications.

Health Monitor Configuration 3

Based on whether the Monitoring Server is receiving events from a producer or a consumer, the adapter.acquisition.producer or adapter.acquisition.consumer event is generated by the Monitoring Server.

The framework.properties file includes options to enable or disable monitoring. You can also identify how often events must occur before the event is generated. • ims.monitor.enabled - Used to enable (true) or disable monitoring

(false). (Default: true) • ims.monitor.poll-requirement-minutes - Identifies the how often

(in minutes) the events are polled. (Default: 60)• ims.monitor.enqueue-requirement-minutes - Identifies how

often (in minutes) events must occur before the event is generated. (Default: 60)

6-4 RELEASE 5.8 REV A01 300-010-288

HEALTH MONITOR CONFIGURATION

Figure 3-1 Example Framework Properties file - Monitoring Server

#### Monitoring Server### Application Monitorims.appmon.poll-interval-milliseconds = 45000ims.appmon.alert-threads-threshold = 500ims.appmon.alert-memory-threshold = 95ims.appmon.alert-cpu-threshold = 95ims.appmon.minutes-between-alerts = 30# Log file handlerims.log.filter = # Email handlerims.mail.smtp.host = ims.mail.smtp.port = 25ims.mail.from = no-reply@mycompany.comims.mail.to = ims.mail.filter = e.severity.value < 2 || e.retryCount > 5ims.mail.subject-template = \"[IMS] $e.severity [$e.hostname:$e.eventType] $e.reason\"ims.mail.body-template = \"$e\"# SNMP handlerims.snmp.filter = ims.snmp.address = 127.0.0.1/162# Enable health monitoring events to be generated.ims.monitor.enabled = trueims.monitor.poll-requirement-minutes = 60ims.monitor.enqueue-requirement-minutes = 60

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 6-5

HEALTH MONITOR CONFIGURATION

6-6 RELEASE 5.8 REV A01 300-010-288

7Chapter

Monitoring Server MIB 4

This MIB describes the format for the Monitoring Server event. These events are generated by the Monitoring Server to provide SNMP notifications that identify the health of the Automator and Adapters.

MIB Location 4

The Monitoring Server MIB file (IWAVE-EVENT-MIB.mib) is installed in the following directory:

<install_root>\endpoints\iMS

Textual Conventions 4

Table 4-1 identifies the Textual Conventions used for the Monitoring Server MIB.

Table 4-1 Monitoring Server MIB Textual Conventions

Name Description Syntax Valid Values

iWaveLongTextTC This object syntax is equivalent to a DisplayString, but with a a 1023 bytes size limits (instead of 255 for a DisplayString). The data may need to be truncated to fit into this type.

OCTET STRING

0..1023

iWaveVeryLongTextTC This object syntax is equivalent to a DisplayString, but with a a 64k bytes size limits (instead of 255 for a DisplayString). The data may need to be truncated to fit into this type.

OCTET STRING

0..65535

—sheet 1 of 2—

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 7-1

OBJECT TYPES

Object Types 4

Table 4-2 identifies the Object Types included in the Monitoring Server MIB.

iWaveTimeMillis64TC An elapsed time, expressed in milli-seconds that have passed since January 1, 1970 00:00:00.000 GMT. This type is based on Counter64, but without its specific semantics

Counter64

Table 4-2 Monitoring Server Object Types

Name Description Syntax Access

iWaveEventType The type of the event that occurred. Consult the documentation for the core event types.

DisplayString Read-only

iWaveSeverity The severity of the event. This is a numerical value between 1 and 5. 1 is the highest severity and 5 is the lowest.

Integer32(1..5) Read-only

iWaveHostname Hostname that generated the event. This is not the iMS host but the originating host that caused the event.

DisplayString Read-only

iWaveReason Reason or message of the event. This field contains the stacktrace if the event was caused by an error.

iWaveLongTextTC

Read-only

iWaveData Large string object that represents the data that caused the event. Typically this is the XML payload of an event.

iWaveVeryLongTextTC

Read-only

iWaveTimestamp Timestamp of when the event was generated. If no timestamp was part of the original event, the timestamp will be provided when iMS receives the event.

iWaveTimeMillis64TC

Read-only

—sheet 1 of 2—

Table 4-1 Monitoring Server MIB Textual Conventions

Name Description Syntax Valid Values

—sheet 2 of 2—

7-2 RELEASE 5.8 REV A01 300-010-288

OBJECT TYPES

iWaveAction Optional field that denotes the action to be performed. This field contains a value of 'clear' when the event is clearing a previous problem.

DisplayString Read-only

iWaveTransactionID Transaction ID for an event generated that relates to an Adapter queue transaction.

DisplayString Read-only

iWaveObjectID Object Identifier of the Incident, Event, Change, Problem or other object that this event relates to.

DisplayString Read-only

iWaveServiceID Service ID of the service that generated the event. This correlates to the service ID field of the adapter queue.

DisplayString Read-only

iWaveObjectType Object Type of the object that caused the event.

DisplayString Read-only

iWaveRequestType Request type. This is used to differentiate between different types of requests against the same object.

DisplayString Read-only

iWaveRetryCount Number of times a particular action has been retried. For adapter queue items, this corresponds to the poll count of a transaction.

Integer32 Read-only

Table 4-2 Monitoring Server Object Types (continued)

Name Description Syntax Access

—sheet 2 of 2—

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE 7-3

NOTIFICATIONS

Notifications 4

Table 4-3 identifies the SNMP Notifications sent by the Monitoring Server MIB.

Table 4-3 iMS MIB Notifications

Name Description Reporting Objects

testMIBMyFirstCoolTrap This event is sent when iMS receives an event that should be dispatched over SNMP.

iWaveEventType,iwaveSeverity,iWaveHostname,iWaveReason,iWaveData,iWaveTimestamp,iWaveAction,iWaveTransactionID,iWaveObjectID,iWaveServiceID,iWaveObjectType,iWaveRequestType,iWaveRetryCount

7-4 RELEASE 5.8 REV A01 300-010-288

Index 1

AAcquisition Queue

condition events 3­3configuration

during installation 4­16event types 3­1

Adapterconnecting to the iMS 5­2enabling monitoring

during installation 4­15event types 3­1monitoring with Web Service 1­6

Adapter Frameworkrunning as a Windows service 4­26starting 4­28

alertthresholds 1­7

configuring  6­2application monitor 1­6

events 3­5appmon.properties 5­2Automator

enabling monitoringduring installation 4­14

monitoring with JMX 1­6

Cconfiguration file

location 5­2console

installation 4­1, 4­5log file 1­1online help requirements 2­2starting 4­34supported operating system 2­1

CPU 2­1CPU usage 1­7

Ddisk space 2­1

Eemail

configuration 4­20email notification 1­3

configuring 6­3email-ims-handler-spring.xml 5­2enqueue requirements 4­19event logging 1­3event notifications

email filtering 6­3log filtering 6­3SNMP filtering 6­3

Fframework.properties 5­2, 6­1

Hhealth monitor

configuration 6­4disable 6­4enable 6­4enabling 4­19

Iinstaller

Linux 4­29starting 4­3Unix 4­29

JJava Runtime Environment 2­2JMX 1­6

EMC IONIX IT AUTOMATOR MONITORING SERVER INSTALLATION AND CONFIGURATION GUIDE I-1

Llicense file

choosing during installation 4­9directory location 4­2installing 4­2

log fileevent information 1­4

Mmemory usage 1­7methods 1­8MIB 7­1

textual conventions 7­1monitored application

adding after installation 5­3Monitoring Server framework

stopping 4­28

Nnotifications

MIB 7­4

Oobject types

MIB 7­2operating systems

supported 2­1

Ppoll requirements 4­19properties editor 6­1

command 6­1starting 6­1

Qqueue

threshold 4­16waiting time 4­16

RRAM 2­1

Sshortcut folder 4­8SNMP

notification configuration 6­4notifications 1­3

SNMP authenticationenable 4­21

software compatibility 2­2software installation 4­1

for Windows 4­3manual 4­31windows 4­3

SSLdisabling 5­4

SSL communication 4­32standalone 2­2, 4­5supported configurations 2­2system configuration 2­1system requirements 2­1

Tthreads 1­7

WWindows service

executable location 4­26manager application 4­26manual install or uninstall 4­27re-installing 4­27running 4­26uninstalling 4­27

WSDL 1­8

I-2 RELEASE 5.8 REV A01 300-010-288

Backcover

EMC CorporationCorporate Headquarters, Hopkin, MA 01748-9103U.S.A.

Tel.:1-508-435-1000

http://www.EMC.com

EMC Ionix IT AutomatorMonitoring ServerInstallation and Configuration Guide

Document number: 300-010-288Version 5.8REV A01Date: December 2009

Printed in the United States of America.Copyright © 2009, EMC Corporation All Rights Reserved