IBM Tivoli Monitoring V6.2 Introduction to IBM Tivoli Monitoring Agent Builder

IBM Tivoli Monitoring V6.2Introduction to IBM Tivoli Monitoring Agent Builder Sara Moggi, Aldo Bucossi

Agenda • Product overview • Components • Installation • Creating a new agent • Trace Files • Agent Builder Output • Agent Log Files • Q&A

Product Overview • What is the Agent Builder • The Agent Builder is a set of tools that perform 4 functions • Create new agents • Create extensions to existing agents • Create an installable image to distribute new agents or extensions • Create the mapping file used by the Migration Toolkit for migrating custom ITM 5x resource models to ITM 6

Product Overview • Provides dialogs and data browsers to allow quick point and click agent development • Provides mechanisms to monitor application availability • Processes • Windows Services • Functionality Tests • Supports data collection via • Windows Event Log • Windows Management Infrastructure (WMI) • Windows Performance Monitoring (PerfMon) • Simple Network Management Protocol (SNMP) • External scripts and executables • Log files

Product Overview Create Extensions To Existing Agents • If you have insight into how a particular agent is used in the field, you can create custom workspaces, situations, queries and tasks for that agent • You can also define workspaces that display information from multiple agents to show how those products interact • For example, WebSphere and DB2 • The TEP is still the mechanism for creating these • The Agent Builder will extract the information from the TEPS and create an installable image so that you can redistribute the content

Product Overview Create an Installable Image • The Agent Builder ships a configurable InstallShield image • Based on InstallShield 5.03 • All of the text is configurable • Allows a custom splash screen • This installer can install TEMS/TEPS support files • The installer can also install an agent locally or install the agent to the Remote Deploy Depot • The installer supports the following platforms • Windows • HP/HP Itanium • Linux (x86, PPC and zLinux) • Solaris/Solaris x86

Create the ITM 5x Mapping File Product Overview • The mapping file used by the Migration Toolkit for migrating custom ITM 5x resource models to ITM 6 • The process involves creating a new agent that mimics the functionality of the custom resource model • The mapping file is the input for the Migration Toolkit that tells it about the agent • See the Migration Toolkit Documentation for more information

Components • The Agent Builder is built on Eclipse technology • The Agent Builder is completely self contained • Bundle Eclipse • Version 3.2.1 – IES • Bundle the IBM SDK • The install does not overwrite the system JRE • Need an SDK to build resource bundles used by the TEP • IBM SDK 1.5 SR5java version "1.5.0“Java(TM) 2 Runtime Environment, Standard Edition (build pwi32dev-20070511 (SR5))

Components Code Structure • The Agent Builder consists of 6 custom plug-ins added to the base Eclipse Runtime • The plug-ins are • JLog (logging and tracing methods used by other plug-ins) • IBM Tivoli Monitoring (common code used by all of the custom plug-ins, in example, code for copying files, etc) • Agent Generator (programmatic model of an agent as well as the code for generating the necessary files to run the agent) • Agent Builder (contains the User Interface code that creates the wizards and dialogs used for defining an agent) • Agent Builder Documentation (contains the online help files) • Solution Installer (contains the code for adding support files to new or existing agents)

Installation • The Agent Builder installer is built on InstallShield MultiPlatform 11.5 • JVM is bundled and installed • The bundled JVM is used only for install, uninstall and running the Agent Builder • The system JRE (if present) is not affected • Supported PlatformsSee the User’s Guide for OS version requirements • Windows • Linux (x86) • AIX

Installation • On Windows, install and run the Agent Builder from an Administrator id • Need admin authority for browsers to work • On Linux/AIX, run the Agent Builder from the same id that you used to install

Installation • Notable files/directories • The JDK is installed under the _jvm directory in the selected install path • agentbuilder.ini specifies properties to pass to the JVM that runs the Agent Builder • On Windows, although the characters !, #, % and ; are valid characters in directory names, Eclipse cannot handle directories that contain these characters. Do not install the Agent Builder into a path that contains these characters.

Installation

Creating a new agent • Several types of agents can be created • Three main categories • Application Availability • Windows Log Events • External Data Sources

Creating a new agent Application Availability • Three Availability Monitor Types: • Monitor Process Availability (provide the Display name, the process name, the platforms and arguments to match, if any) • Monitor Service Availability (Windows Only) (provide the Display name and the Service Name) • Run a command and Analyze the return code (provide the Display Name, the commands and related local return codes,Global Return Codes)

Creating a new agent Windows Logs Events • Provide the Event Log Name • Application • Security • System • Filter by : • Event Type (Error,Warning,Informational, etc) • Event Source (the list content changes depending on Event Log Name) • Event Identifier (The number that identifies the Event itself)

Creating a new agent External Data Sources You can choose from two main options: • New Data Sources • To create a new Data source from scratch • New attributes can be added by the popup menu (right click) option “New attribute” • Data Source can be edited by double clicking on it. • New Navigator Group • To create a group that can be populated with multiple Data Sources • New Data Sources are added to the Navigator group using the popup menu (right click) option “New Data Source”

Creating a new agent External Data Sources : Data Source Location • Windows Management Instrumentation (WMI) Class • Windows Performance Monitor (Perfmon) Objects • Simple Network Management Protocol (SNMP) • By running an external script • A log file

Creating a new agent External Data Sources : WMI Class • You can manually provide Namespace, WMI class name and interested attributes or use the Browse button to automatically select all the requested information

Creating a new agent External Data Sources : Perfmon Objects • You can manually provide Object Name and interested attributes or use the Browse button to automatically select all the requested information

Creating a new agent External Data Sources : SNMP Information • Select the needed SNMP objects (attributes) from the MIB browser.You can import another Management Information Base, if needed.

Creating a new agent External Data Sources : External Scripts • Provide the Display name and then Add the information about the invoked script, including the script file name itself, that will be included in the package.

Creating a new agent External Data Sources : Log Files • Provide the Log File Name and Data Source Information to drive the agent in parsing correctly the monitored log file.

Creating a new agent External Data Sources : Log Files • Once data souce is defined, attributes must be defined.

Trace Files • Eclipse Error Log • This file contains stack trace information for all plugins • workspace_directory/.metadata/.log • Note: This file may not be visible depending on how the file listing is done • Use ls –al on Linux and AIX • On Windows, ensure the folder is configured to show hidden files and folders

Trace Files • Each plug-in has separate tracing controls with 3 exceptions • There is no tracing in the Agent Builder Documentation plug-in • The IBM Tivoli Monitoring plug-in uses the tracing options from the plug-in that calls the common functions • There is no tracing in the LPEX plug-ins • Trace files are stored in the Agent Builder workspace directory • This directory is specified when starting the Agent Builder • The files are put into the .metadata directoryworkspace_directory/.metadata/tivoli/KQZ/logs by default • Note: This directory may not be visible depending on how the file listing is done • Use ls –al on Linux and AIX • On Windows, ensure the folder is configured to show hidden files and folders

Trace Files • Trace file names • JLog plug-in • traceJLogStartup.logThis log file is used until log file configuration options have been readUseful to debug problems with log file configurationOnce configuration is read, this log is no longer written to • traceJlog.logOnce JLog configuration has been read, the trace entries for the JLog plug-in are written to this file • Agent Generator plug-in • traceKQZGen.log • Agent Builder plug-in • traceKQZ.log • Solution Installer plug-in • traceKQZASI.log

Trace Files Setting Trace Options (1/2) • Trace options are set in the Agent Builder UI on a per plug-in basis • Trace settings take effect at runtime (except for the console logging option) • Access the tracing options by selecting Windows -> Preferences and selecting IBM Java Logging Toolkit

Trace Files Setting Trace Options (2/2) • Expand the IBM Java Logging Toolkit section to see the trace settings for each plug-in • Note: For the “Enable logging to console” option, you must stop the Agent Builder and modify agentbuilder.iniModify the lineC:\Program Files\IBM\ITM\AgentBuilder\_jvm\jre\bin\javaw.exeChanging javaw to java • Restart the Agent Builder

Agent Builder Output • Three options for output • Generate the agent files in an ITM installation on this machine • Create a compressed file so that the agent can be installed on another system • Generate a Solution Install package • All invoke the same agent generator, and produce largely the same files, just packaged differently • Set of files and their contents will vary based on: • Platform support chosen for agent • Data provider support chosen for agent • Whether agent is single- or multi-instance • Many of these files are standard ITM files, not different than for any agent built manually

Agent Builder Output Methods of invoking generator • Generate the agent files in an ITM installation on this machine • Create a compressed file so that the agent can be installed on another system • Generate a Solution Install package

Generate the agent files in an ITM installation on this machine Agent Builder Output • Runs the agent generator, producing all standard files in a temporary location • Installs agent with installIraAgent.{sh,bat} as appropriate for platform • Checks for presence of TEMS & TEPS • Installs appropriate support with installIraAgentTEMS.{sh,bat} and installIraAgentTEPS.{sh,bat} • Removes install files from temporary location when complete

Create a compressed file so that the agent can be installed on another system Agent Builder Output • Runs the generator, producing all standard files in a temporary location • Packs up the agent install image in a .zip file for Windows and a .tgz file for UNIX/Linux • To install, carry the files to TEMS, TEPS, agent system and unpack • Invoke the appropriate install scripts, as described previously

Generate a Solution Install package Agent Builder Output • Creates a Solution Install image in the builder • Runs the generator, producing all standard files inside the Eclipse project workspace directory • Creating Solution Install Image from Solution Install plugin in the builder creates a Solution Install CD image on disk

Agent Log Files • First place to look when troubleshooting • Default location: • %CANDLE_HOME%\TMAITM6\logs\<hostname>_<pc>_k<pc>agent_<timestamp>-01.log (Windows) • $CANDLE_HOME/logs/<hostname>_<pc>_<timestamp>-01.log (UNIX/Linux) • Logs will roll– see Setting RAS trace parameters in Appendix G of the User’s Guide.

Agent Log Files Getting more detailed tracing • More detail is available in the logs if tracing is turned up • More info in Appendix G of User’s Guide • Different modules can have their trace level turned up to debug specific problems

Agent Log Files Trace settings for specifing problem areas Problem area KBB_RAS1 setting

Questions?

Thank YOU !!

IBM Tivoli Monitoring V6.2 Introduction to IBM Tivoli Monitoring Agent Builder