Preface

This book describes the new monitoring feature in Sun Java^TM Enterprise System 5 (Java ES). Monitoring is implemented by the Sun Java System Monitoring Framework 2.0 and the Sun Java System Monitoring Console 1.0.

The procedures in this guide show you how to configure and enable the Monitoring Framework for each of your installed components, then how to view all monitored data in the Monitoring Console. This guide does not document log files nor other monitoring mechanisms of individual components outside this framework.

Who Should Use This Book

This book is intended for the following audiences:

Software architects who need to design a maintenance plan for Java ES deployments.
System administrators who perform Java ES installation and configuration.
System administrators and technicians who monitor and maintain Java ES deployments.

Before You Read This Book

You should be familiar with the documents of the Java ES documentation set described in the next section. You should also be familiar with the design and functioning of the Java ES components you wish to monitor.

Furthermore, if you are intending to install and configure the monitoring components, you must first complete the installation of all other components. Before you perform any installation or configuration, you should consult the Sun Java Enterprise System 5 Release Notes for UNIX.

Java ES Documentation Set

The Java ES documentation set describes deployment planning and system installation. The URL for system documentation is http://docs.sun.com/coll/1286.2. For an introduction to Java ES, refer to the books in the order in which they are listed in the following table.

Table P–1 Java Enterprise System Documentation


Document Title	Contents
Sun Java Enterprise System 5 Release Notes for UNIX Sun Java Enterprise System 5 Release Notes for Microsoft Windows	Contains the latest information about Java ES, including known problems. In addition, components have their own release notes listed in the Release Notes Collection (`http://docs.sun.com/coll/1315.2`).
Sun Java Enterprise System 5 Technical Overview	Introduces the technical and conceptual foundations of Java ES. Describes components, the architecture, processes, and features.
Sun Java Enterprise System 2005Q4 Deployment Planning Guide	Provides an introduction to planning and designing enterprise deployment solutions based on Java ES. Presents basic concepts and principles of deployment planning and design, discusses the solution life cycle, and provides high-level examples and strategies to use when planning solutions based on Java ES.
Sun Java Enterprise System 5 Installation Planning Guide	Helps you develop the implementation specifications for the hardware, operating system, and network aspects of your Java ES deployment. Describes issues such as component dependencies to address in your installation and configuration plan.
Sun Java Enterprise System 5 Installation Guide for UNIX Sun Java Enterprise System 5 Installation Guide for Microsoft Windows	Guides you through the process of installing Java ES. Also shows how to configure components after installation, and verify that they function properly.
Sun Java Enterprise System 5 Installation Reference for UNIX	Gives additional information about configuration parameters, provides worksheets to use in your configuration planning, and lists reference material such as default directories and port numbers on the Solaris Operating System and Linux operating environment.
Sun Java Enterprise System 5 Upgrade Guide for UNIX Sun Java Enterprise System 5 Upgrade Guide for Microsoft Windows	Provides instructions for upgrading to Java ES 5 from previously installed versions.
Sun Java Enterprise System 5 Monitoring Guide	Gives instructions for setting up the Monitoring Framework for each product component and using the Monitoring Console to view real-time data and create monitoring rules.
Sun Java Enterprise System Glossary	Defines terms that are used in Java ES documentation.

Default Paths and File Names

The following table describes the default paths and file names of the Java ES components that implement monitoring.

Table P–2 Default Paths and File Names


Placeholder	Description	Default Value
`mfwk-base`	Represents the directory where the Monitoring Framework shared component is automatically installed. This path is also used as part of the configuration directory.	Solaris systems: `/opt/SUNWmfwk` Linux systems: `/opt/sun/mfwk`
`MConsole-base`	Represents the installation directory chosen for the Monitoring Console.	Solaris systems: `/opt/SUNWjesmc` Linux systems: `/opt/sun/jesmc`
`WebConsole-base`	Represents the directory where the Web Console shared component is automatically installed.	Solaris systems: `/etc/webconsole/console` Linux systems: `/etc/opt/webconsole/console`
`AccessMgr-base`	Represents the installation directory chosen for Sun Java System Access Manager.	Solaris systems: `/opt/SUNWam` Linux systems: `/opt/sun/identity`
`AppServer-base`	Represents the installation directory chosen for Sun Java System Application Server.	Solaris systems: `/opt/SUNWappserver/appserver` Linux systems: `/opt/sun/appserver`
`CalServ-base`	Represents the installation directory chosen for Sun Java System Calendar Server.	Solaris systems: `/opt/SUNWics5` Linux systems: `/opt/sun/calendar`
`DirServ-base`	Represents the installation directory chosen forSun Java System Directory Server.	Solaris systems: `/opt/SUNWdsee/ds6` Linux systems: `/opt/sun/ds6`
`IM-base`	Represents the installation directory chosen for Sun Java System Instant Messaging.	Solaris systems: `/opt/SUNWiim` Linux systems: `/opt/sun/im`
`MsgServ-base`	Represents the installation directory chosen for Sun Java System Messaging Server.	Solaris systems: `/opt/SUNWmsgsr` Linux systems: `/opt/sun/messaging`
`Portal-base`	Represents the installation directory chosen for Sun Java System Portal Server.	Solaris systems: `/opt/SUNWportal` Linux systems: `/opt/sun/portal`
`WebServer-base`	Represents the installation directory chosen for Sun Java SystemWeb Server.	Solaris systems: `/opt/SUNWwbsvr7` Linux systems: `/opt/sun/webserver`

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–3 Typographic Conventions


Typeface	Meaning	Example
`AaBbCc123`	The names of commands, files, and directories, and onscreen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with onscreen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	A placeholder to be replaced with a real name or value	The command to remove a file is `rm` `filename`.
AaBbCc123	Book titles, new terms, and terms to be emphasized (note that some emphasized items appear bold online)	Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file.

Shell Prompts in Command Examples

The following table shows default system prompts and superuser prompts.

Table P–4 Shell Prompts


Shell	Prompt
C shell on UNIX and Linux systems	`machine_name%`
C shell superuser on UNIX and Linux systems	`machine_name#`
Bourne shell and Korn shell on UNIX and Linux systems	`$`
Bourne shell and Korn shell superuser on UNIX and Linux systems	`#`
Microsoft Windows command line	`C:\`

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–5 Symbol Conventions


Symbol	Description	Example	Meaning
`[ ]`	Contains optional arguments and command options.	`ls [-l]`	The `-l` option is not required.
`{ \| }`	Contains a set of choices for a required command option.	`-d {y\|n}`	The `-d` option requires that you use either the `y` argument or the `n` argument.
`${ }`	Indicates a variable reference.	`${com.sun.javaRoot}`	References the value of the `com.sun.javaRoot` variable.
-	Joins simultaneous multiple keystrokes.	Control-A	Press the Control key while you press the A key.
+	Joins consecutive multiple keystrokes.	Ctrl+A+N	Press the Control key, release it, and then press the subsequent keys.
->	Indicates menu item selection in a graphical user interface.	File -> New -> Templates	From the File menu, choose New. From the New submenu, choose Templates.

Documentation, Support, and Training

The Sun web site provides information about the following additional resources:

Documentation (http://www.sun.com/documentation/)
Support (http://www.sun.com/support/)
Training (http://www.sun.com/training/)

Searching Sun Product Documentation

Besides searching Sun product documentation from the docs.sun.com^SM web site, you can use a search engine by typing the following syntax in the search field:

search-term site:docs.sun.com

For example, to search for “broker,” type the following:

broker site:docs.sun.com

To include other Sun web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use sun.com in place of docs.sun.com in the search field.

Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.

Note –

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the full document title and part number. The part number is a 7-digit or 9-digit number that can be found on the book's title page or in the document's URL. For example, the part number of this book is 819-5081.