Guide Organization JReport Monitor Server

Transcription

1 Guide Organization JReport Monitor Server

2 Table of Contents User's Guide: Organization of This Part...1 Installing and Launching JReport Monitor Server...2 Installing JReport Monitor Server on Windows 9x/NT/ Launching JReport Monitor Server...3 Accessing JReport Monitor Server services...4 Using JReport Monitor Server...6 Introduction...6 Monitoring the Status of JReport Enterprise Server...6 Show Status of the Servers in the Cluster...7 Drill down the Status of the Reports...7 Drill down the Status of the On line Users...10 Drill down the Status of the Database Connection Pool...10 Monitoring the Performance of JReport Enterprise Server...11 Maintaining JReport Enterprise Server...13 Monitoring the Status of JReport Enterprise Server...13 Creating Profiling Reports...13 Managing and Monitoring Resources Using...17 JMX Monitoring Features...18 Introduction to JMX...18 JMX Monitoring features of JReport Enterprise Server...18 MBeans Building Principle...18 Working Principle...18 Descriptions of MBeans in JReport Enterprise Server...18 HtmlAdaptor...20 Supporting Tips Information in the Web UI(Some auxiliary tools)...21 How to Use JMX Monitoring Feature...21 Integration...22 Notes...22 Integration with a Servlet Enabled Web Server...23 Running with WebLogic (v8.1) on NT...23 Running with Tomcat 4 and above on NT...24 Preparation...24 Configuring Tomcat...24 Launching Tomcat...25 Running with IBM WebSphere 5.0 by a War File...25 Generating the War file...25 Deploying the War file...26 I

3 User's Guide: Organization of This Part User's Guide provides in depth coverage of JReport Monitor Server's features and generally explains how to do different things with the product. Browse to the chapters that are of interest to you for the step by step instructions. The User's Guide is divided into the following chapters, and with new features coming out, there will be more chapters added in the future: Installing and Launching JReport Monitor Server Monitoring the Performance of JReport Enterprise Server] Integration with a Servlet Enabled Web Server For a complete coverage of the features, operations and other information, please refer to the specific book: JReport Designer Getting Started An introduction to JReport. It covers issues associated with installation, setup, and configuration of JReport Designer. It is a combination of informational topics and strategic references to various topics in the Pro User's Guide and Pro User Reference. JReport Designer Tutorial Basic report building instructions. This includes the reporting features that you will find useful. The idea is that after you have walked through this Tutorial, you can easily follow the examples and build your own reports. For in depth feature coverage like building reports on XML, EJB, stored procedure, SQL file, please refer to the User's Guide. JReport Designer User's Guide In depth coverage of JReport Designer's features and generally explains how to do different things with the product. Browse to locate the chapters that are of interest to you for step by step instructions. JReport Designer User Reference Specifications, providing technical, system and other reference information related to the JReport built in objects, built in formula functions and APIs. JREntServer Getting Started An introduction to JReport. It covers issues associated with installation, setup, and configuration of JReport Enterprise Server. It describes most informational topics and references in the server User's Guide. JREntServer Tutorial Basic Server configuration, administration and accessing instructions. After walking though the tutorial, you will be able to use the server for managing the interaction between client and server that enables activities such as scheduling and running reports. JREntViewer Manual Complete coverage of features and instruction of using JREntViewer against JREntServer. The Client API usage is also introduced in this book. 1

4 Installing and Launching JReport Monitor Server Installing JReport Monitor Server on Windows 9x/NT/ Download JReport Monitor Server installation file MoniSvrSetup.exe from our Web site at 2. Execute the installation executable file MoniSvrSetup.exe. Then follow the instructions of the install wizard. 3. Select a Java Virtual Machine so that you can run JReport Monitor Server later. 4. Click Next in the Welcome dialog to continue with the installation. 5. Input the install path of the server. You can use the Browse button to locate the place where you want to install JReport Monitor Server. 6. If the destination location does not exist, you will be prompted. Click Yes to create the folder. 2

5 Installing and Launching JReport Monitor Server 7. Input your User ID and Install Key correctly. 8. The next dialog will show you what kind of license your server will be running. It is essential to know the expiration date, concurrent users, concurrent reports, CPU numbers and other information, which may be the the key for some errors like "too many users" etc.. 9. Read the Software License Agreement, check Accept all terms of the license and click Next to continue. 10. Besides JDK and JReport Monitor Server packages, in the next dialog, you will have the chance to add additional classpaths of external components such as a JDBC driver or user defined functions. Check the Add additional classpaths... option, select to locate the jar, zip or class files, click add. Remove one classpath from the list by selecting the classpath and clicking delete. Finally, click Next to move to the next dialog. Or, skip this dialog by directly clicking Next. Later you can manually edit the batch file or the command line starting JReport Enterprise Server to add additional classpaths. 11. Click Install to start installation. If you are installing to an existing version of JReport Monitor Server, you will be prompted to choose whether to overwrite the old files. 12. Finally, the readme message will pop up when the installation process is completed. Click Finish on the Installation Complete dialog to finalize the installation. Launching JReport Monitor Server After you install JReport Monitor Server, a batch file named MonitorServer.bat is generated automatically under %installroot%\bin. You can start JReport Monitor Server by running the MonitorServer.bat file. Please keep in mind that you must have JReport Enterprise Server started before launching JReport Monitor Server. The monitor server will check the server.properties file under %installroot%\bin every time when it starts to find the admin server host name/ip, admin server port, and other related information. If the server.properties file does not exist, JReport Monitor Server will throw out two warning messages, as shown on the following screenshot, and start to use the default value 'localhost' and '1129' as admin server host name and port to find the running JReport Enterprise Server. 3

6 Installing and Launching JReport Monitor Server Note: The server.properties file is generated when you run the monitor server for the first time after installation. The server.properties file contains the following information: Property Default Value Description admin.server.host localhost The Admin server host name or IP address. JReport Monitor Server will check this property value to find and connect to the Admin server. monitor.rmi.port 1248 The monitor server RMI port number. monitor.max.report.save.time 5 monitor.max.report.save.number 50 admin.server.port 1129 monitor.refresh.interval 2000 service.port 8848 Accessing JReport Monitor Server services The time span that a finished report should be shown on the Finished Reports list. The number of finished reports to be shown on the Finished Reports list. The Admin server port number. JReport Monitor Server will check this property value to connect to the Admin server. The time interval at which the statistics of the current program status is automatically updated.. The service port number of JReport Monitor Server. The users can use this port to access monitor server. You can use the service port number specified in the server.properties file to access the services of JReport Monitor Server. The format of the accessing url is like below: For example: Or, you can access JReport Monitor Server by clicking Monitor on the top banner of the administration JSP interface of JReport Enterprise Server. Note: The Monitor link will not be displayed on JREntServer's home page when the web.monitor.link.enable property in the server.properties file (%JREntServerRoot%\bin) is set to false. 4

7 Installing and Launching JReport Monitor Server Index 5

8 Using JReport Monitor Server Introduction JReport Monitor Server is a stand alone web based application used to monitor the overall performance of JReport Enterprise Server. JReport Monitor Server should be used together with JReport Enterprise Server. JReport Monitor Server has the following main features: 1. Inspects the status of JReport Enterprise Server. 2. Shows the server performance statistics in Graph/Text mode. 3. Maintains JReport Enterprise Server. 4. Creates profiling reports: performance reports and statistic reports. References Notes: Installing JReport Monitor Server on Windows 9x/NT/2000 Launching JReport Monitor Server Accessing JReport Monitor Server services Monitoring the Status of JReport Enterprise Server JReport Monitor Server allows you to inspect the server status. You can list the servers and their status in the cluster. You can also list the reports by drilling down into servers, such as the running reports, reports in queue, completed reports, scheduled/on demand reports, and so on. Tracking further down, you can even view the status of these reports. JReport Monitor Server is not able to monitor the information of a report that is running in DHTML format. 6

9 Using JReport Monitor Server Show Status of the Servers in the Cluster Access the home page JReport Monitor Server. You can see the status of each server in the cluster, including the server name, host IP, port, server type, and its status. The Server Status table includes: Column Heading Value Description Name Host Port Type Status Admin Backup Slave Started Not Started Idle Working Busy Shut down Crashed Drill down the Status of the Reports The name of the server. The host IP of the server. The RMI port number of the server. The type of the server. Can be Admin, Backup, or Slave. The Admin server. You can do maintenance, administration, and configuration on the Admin server. The Backup server. When the Admin server is down, one of the Backup servers will be promoted to run as the Admin server. A Backup server plays the same role as a slave server when the Admin server is running fine. The Slave server. A slave server performs the business tasks, such as running reports, submitting scheduled tasks, and so on. Reference Note: JREntServer User Guide JReport Enterprise Server Cluster The status of the server. Can be Started, Not Started, Idle, Working, Busy, Shut down, and Crashed. The server has been started and ready for service. The server has not been started. The server is idling. The server is working. The server is busy and may not respond to the request. The server has been shut down. The server has been crashed. Expand any server node on the Clustered Server panel, and then click Reports, you can see the status of reports. 7

10 Using JReport Monitor Server You can select to view the status of different reports from the drop down list. There are four types of report status Running Reports, Waiting Reports, Finished Reports, and Failed Reports. Waiting Reports Table & Running Reports Table The Status tables of the waiting reports and the running reports include: Column Heading Report Task ID User ID The full path name of the report. The internal ID for this report. Description The ID of the user who submits the report. The current status of the task. Can be one of the following: Task Status Task Type Start Time Time Elapsed Submit Time Waiting The task has been submitted successfully, it is currently waiting in the queue for being processed. Running The task is currently being processed. Finished The task has been processed successfully, accomplished all the requirements. Failed The task has encountered errors and failed to accomplish all the requirements. The type of the task. Can be Schedule and On demand. The time when the task was started. The elapsed time since the task was started. The time when the task was submitted. 8

11 Using JReport Monitor Server Run Host Run Port Catalog The name of the host on which the task is performed. The port number of the host on which the task is performed. The catalog that the report belongs to. Finished Reports Table The Status table of the finished reports includes: Column Heading Task ID Report User ID The internal ID for this report. The full path name of the report. Description The ID of the user who submits the report. The current status of the task. Can be one of the following: Task Status Task Type Run Host Run Port Catalog Result File(s) Report Pages Reason Submit Time Start Run Time Completed Time Waiting The task has been submitted successfully, it is currently waiting in the queue for being processed. Running The task is currently being processed. Finished The task has been processed successfully, accomplished all the requirements. Failed The task has encountered errors and failed to accomplish all the requirements. The type of the task. Can be Schedule and On demand. The name of the host on which the task is performed. The port number of the host on which the task is performed. The catalog that the report belongs to. The path of the result file(s). The total page number of the report. The reason why the task fails, can be an exception or a meaningful description. The time when the task was submitted. The time when the report was started. The time when the report was completed. Failed Reports Table The Status table of the failed reports includes: Column Heading Task ID Report User ID Task Status The internal ID for this report. The full path name of the report. Description The ID of the user who submits the report. The current status of the task. Can be one of the following: Waiting The task has been submitted successfully, it is currently waiting in 9

12 Using JReport Monitor Server Task Type Run Host Run Port Catalog Result Files Report Pages Reason Failed Info Submit Time Start Run Time Completed Time the queue for being processed. Running The task is currently being processed. Finished The task has been processed successfully, accomplished all the requirements. Failed The task has encountered errors and failed to accomplish all the requirements. The type of the task. Can be Schedule and On demand. The name of the host on which the task is performed. The port number of the host on which the task is performed. The catalog that the report belongs to. The path of the result file(s) The total page number of the report. The reason why the task fails, can be an exception or a meaningful description. The information on the report failure. The time when the task was submitted. The time when the report was started. The time when the report was completed. Drill down the Status of the On line Users Expand any server node on the Clustered Server panel, and then click Users, you can see the status of the on line users. You can also select and remove specific users. The Status table of the on line users includes: Column Heading Session ID User ID Create Time Last Access Time HTTP Session ID Authentication Description The internal ID of the user session. The ID of the user who is logged on to the server. The time when the user session is created. The time when the user access the server for the last time. The session ID in the HTTP service. The authentication type. Can be Internal or External. For more information about the customized authentication, please refer to Drill down the Status of the Database Connection Pool Expand any server node on the Clustered Server panel, and then click Databases, you can see the status of the database connection pool. You can also select and remove specific connections. The Status table of the connection pool includes: # Column Heading Value Description 1 User String. The user who is currently using the connection. 2 URL A URL connecting to a database. It specifies the connections that are based on the URL will be caught in the pool. 10

13 Using JReport Monitor Server 3 Expiring Time (s) 0 (default) or expiring time. The unit is second. If the value is zero then the connection will never expire. It shows the time during which a connection can be alive. If a connection is expired, the connection pool will force to close this connection. 4 Idle Expiring Time (s) 1 (default) or expiring time. The unit is second. Its value must be larger than or equals to 1. It shows the time during which a connection is kept after it starts to be idling. If a connection is not used, it stays open until the idle expiring time is reached. 5 Maximal 0 (default) or a Connection Count positive integer. 6 Maximal Share Count 7 Attempt 8 Interval (ms) 9 Last User Connecting Time (s) Current Idle Time 10 (s) Current Share 11 Count 0 (default) or a positive integer. A positive integer, the default value is 1. 0 (default) or a positive integer. The unit is millisecond (ms). 0 (default) or a positive integer. The unit is second. 0 (default) or a positive integer. The unit is second. 0 (default) or a positive integer. It shows the pool size, which limits the number of connections under a single URL. It shows the number of users who can share a connection simultaneously. It shows whether to recreate a connection when the connection pool fails to create the connection and the attempt times to create the connection. If the user sets this value to a non positive integer, the default value (1) will be used. If property Attempt is larger than 1, then before the connection pool retries to create connection it will wait for an interval time. This property defines the interval time. It shows the time elapsed since the last user who have taken this connection. It shows the time elapsed since the connection started to be idling. It shows the number of users who are currently sharing this connection. Note: The properties from 2 to 8 can be set in the ConnectionPoolConfig.properties file in %JREntServerInstallRoot%\bin (JReport Enterprise Server Installation directory) and the last three properties will be shown according to the real time status. Monitoring the Performance of JReport Enterprise Server JReport Monitor Server can show the performance counters in the graph mode (Line chart and Bar chart) and text mode. To monitor the performance of JReport Enterprise Server, 1. Access the home page of JReport Monitor Server. 2. On the Clustered Server panel on the left hand side, click to select any server node. 3. Click the Performance tab. 4. Click the Add Counters button on the toolbar. 11

14 Using JReport Monitor Server 5. Select a task type from the drop down list, click to select the counters you want to add, and then click Add. 6. The performance chart will be displayed. The available counters for different tasks are: Task Type Performance Counter Description Report Task Waiting Report Number The number of the currently waiting reports. The number of the currently running reports. 12

15 Using JReport Monitor Server User Session Database Connection Running Report Number Finished Report Number The number of the finished reports. Finished Report Pages The number of pages of the finished reports. Report Average Processing Time Report Average Waiting Time Valid User Session Number User Average Submit Rpt Num Database Connection Number The average processing time of each report. The average waiting time of each report. The number of valid user sessions. The average number of reports that a user submits. The number of database connections. Maintaining JReport Enterprise Server You can also perform some maintenance tasks on JReport Monitor Server, such as Stop problematic reports and connections. Shut down the servers in the cluster. Stop problematic reports and connections To stop the a report from running, 1. Expand the server node on the Clustered Server panel, and then click Reports, you can see the status of reports. 2. Click to select different reports from the drop down list. There are three types of reports Running Reports, Waiting Reports, and Finished Reports. 3. You can find a command link Stop in front of each report status row when you choose to view the running reports or waiting reports. Click Stop to terminate the report running process. To disconnect a connection, 1. Expand the server node on the Clustered Server panel, and then click Databases, you can see the status of the database connections. 2. Check the box in front of the connection that you want to disconnect, and then click the Disconnect button on the top. Shut down the servers in the cluster To shut down one or more servers in the cluster, select the servers you want to shut down, and then click the Shut Down button. Monitoring the Status of JReport Enterprise Server Creating Profiling Reports JReport Monitor Server can generate the JREntServer Performance Statistic report for you to inspect the server performance in the certain period of time. 13

16 Using JReport Monitor Server JReport Monitor Server generates the JREntServer Performance Statistic report using the information that JReport Enterprise Server collects and saves to its own database. Whether JReport Enterprise Server collects profiling information is controlled by a property server.profiling.enable=true/false in the %JREntServerHome%\server.properties file. Before JReport Monitor Server can inspect the server performance, you must make sure that JReport Enterprise Server collects its report running information, say, the property server.profiling.enable must be set to true. To create a profiling report, 1. Select the server node on the Clustered Server panel, and then click the Profiling button. 2. Specify the time period for JReport Monitor Server to get related data, and then click Submit. The profiling report may somewhat like below: 14

17 Using JReport Monitor Server To create a profiling report for topn most frequently viewed reports: 15

18 Using JReport Monitor Server 1. Select the server node on the Clustered Server panel, and then click the Profiling button. 2. Specify the time period for JReport Monitor Server to get related data. 3. Specify how many most frequently accessed reports are to be recorded in the Top box and then click Submit. Note: This number specified here must be valid, if not, the latest used number will be applied. Whether you can submit the profiling report is controlled by a property server.profiling.enable=true/false in the %JREntServerHome%\server.properties file. Before the profiling report can be submitted, you must make sure that the property server.profiling.enable is set to true. Index 16

19 Managing and Monitoring Resources Using 17

20 JMX Monitoring Features Introduction to JMX JMX is a Java standard in the aspect of management. It provides a local or remote model to manage Java application system. Its target is to offer the instrumentation, which can be accessed by all kinds of application management system. A JMX compliant Application Server makes all the registered manageable resources possible to be managed, configured, and controlled easily and flexibly. All those managed resources can be dynamically modified and processed by the third party management software or other management component system. JMX Monitoring features of JReport Enterprise Server MBeans Building Principle We adopt Standard MBean specification to build JREntServer s underlying managed beans. In the process of JMX MBean being created and registered, we design and abstract all meta datum of all managed resources and then save them into corresponding persistent entities. In runtime, the program will make all these meta datum into MBeanInfo and add them to the related Managed Bean. After all these MBeans are built, they will be registered into an internal or external MBeanServer Agent. If only top level management software or other integration environment can find the MBeanServer agent, it can manage and control all the underlying Managed Beans registered in the MBeanServer. Working Principle In Monitor Server, all those managed resources objects of Report Server have been initiated and instantiated. Then the Managed MBeans will be registered into the MbeanServer. Now, all those attributes, operations, notifications and constructors of the associated Managed resource object will be exposed to MBeanServer via the corresponded Managed Bean. The MBeanServer will then expose all of these registered Managed Beans to top level management system resorted to the related Protocol Adaptors or Connectors. In our Monitor Server s environment, when to launch the Monitor Server, we initially create ClusterRuntimeMBean, ServerRuntimeMBean for every predefined JREntServer in the cluster, and TaskRuntimeMBean, UserSessionRuntimeMBean, DatabaseRuntimeMBean for every active running JREntServer. Then all these MBeans can be registered into the integrated customized MBeanServer or Standalone MBeanServer agent. At any time, when a JREntServer has been launched, the TaskRuntimeMBean, UserSessionMBean, and DatabaseRuntimeMBean associated with it will be created and registered into the MBeanServer agent too. Now, all JREntServer monitoring features will be exposed to top level management software or other integration environment resorted to the MBeanServer agent. That to say, all those Runtime MBeans of Task, UserSession, and Database related will be dynamically created in real time and registered into a local MBeanServer. Then the MBeanServer can invoke all registered MBean s operation or attributes to implement JMX monitoring function. Descriptions of MBeans in JReport Enterprise Server In our Monitor Server, the following MBeans are created: ClusterRuntimeMBean ServerRuntimeMBean TaskRuntimeMBean UserSessionRuntimeMBean 18

21 JMX Monitoring Features DatabaseRuntimeMBean Description of each MBean is given below: ClusterRuntimeMBean Attributes: ClusterEnable (boolean) ClusterName (java.lang.string) PredefinedServerStatus(jet.server.monitor.api.ServerStatus[]) PredefinedServers(jet.server.api.cluster.Member[]) Operations: ServerStatus getserverstatus(string host, int port); stopserver(string host, int port); ServerRuntimeMBean Attributes: Name (java.lang.string) Host (java.lang.string) Port (int) Status (java.lang.string) Type (java.lang.string) WaitingRptNums (int) RunningRptNums (int) FinishedRptNums (int) FinishedRptPages (int) AvgProcessTimeByRpt (int) AvgWaitTimeByRpt (int) ValidUserSessionNums (int) AvgRptNumsSubmittedByUser (int) CurrentConnectionNums (int) Operations: void stop(); TaskRuntimeMBean Attributes: AllFailedTaskInfos(jet.server.monitor.api.task.TaskInfo[]) AllFinishedTaskInfos(jet.server.monitor.api.task.TaskInfo[]) AllRunningTaskInfos(jet.server.monitor.api.task.TaskInfo[]) AllWaitingTaskInfos(jet.server.monitor.api.task.TaskInfo[]) Operations: TaskInfo[] getrunningtaskinfosbyuser(string username); TaskInfo[] getwaitingtaskinfosbyuser(string username); TaskInfo[] getfinishedtaskinfosbyuser(string username); TaskInfo[] getfailedtaskinfosbyuser(string username); void stoptask(string taskid); UserSessionRuntimeMBean Attributes: AllUserSessions(jet.server.api.UserSession[]) SessionTimeout (int) Operations: 19

22 JMX Monitoring Features UserSession[] getusersessionsbyuser(string username); void removeusersessionbysessionid (String sessionid); void removeusersessionsbyuserid (String userid); void removeallusersessions (); String gethttpsessionid (String usid); DatabaseRuntimeMBean Attributes: ConnectionProperties(java.util.Properties[]) Operations: void disconnect (String conninfoid); HtmlAdaptor We provide an HtmlAdaptor to make all registered JREntServer s MBeans possible to be viewed from web pages. This HtmlAdaptor is based on the default implementation of Sun s JMX tools, which can process user s HTTP request and dispatch it to MBeanServer Agent, then response to client end Web pages according to the MBeanServer s returned information. HtmlAdaptor is also instantiated as an MBean and registered into the MBeanServer Agent. So we can modify its listener port or other properties form MBeanServer just like other MBeans. By default, Our HTMLAdaptor uses the port 8849 to provide web services. Users can modify it and specify a distinct port in the file server.properties file. If users have launched MonitorServer and JMX startup has been set to true, a property item named as monitor.jmx.htmladaptor.port will be appended to the server.properties file. After launching JREntServer, MonitorServer and setting monitor JMX startup property to true, all registered JREntServer s MBeans will be available for view from web page ( by default), as shown below: 20

23 JMX Monitoring Features Supporting Tips Information in the Web UI(Some auxiliary tools) In the default implementation mode, all MBean s information is built by MBeanServer. All the descriptions and names of attributes, operations, parameters displayed in the web UI are adopted as the default contents by the MBeanServer Agent. For friendly supporting the tips information in the Web UI, we have improved all the managed beans with some extended method for supporting customized descriptions and names of attributes, operations and parameters, etc. All these customized descriptions and names are built into the MBeanInfo of all the registered MBeans. The MBeanServer will invoke these methods to obtain our customized descriptions and names of all displayed MBeanInfo s attributes, operations and parameters in the web UI. How to Use JMX Monitoring Feature We create a local MBeanServer to manage all those Runtime MBeans in default mode. The management program within a standalone can directly get the MBeanServer s reference via the default implementation of MBeanServerFinder interface. In addition, Users can also specify their customized MBeanServerFinder s implementation for obtaining an external MBeanServer agent when to launch MonitorServer, then need only to append a java option Djrs.externalMBeanServerProvider= with their fully qualified customized class file name to java command line of launching Monitor Server. 21

24 JMX Monitoring Features When MonitorServer has been launched and JMX feature supporting has been set to true, Monitor Server will get the System property of jrs.externalmbeanserverprovider. If the property has been set, MonitorServer will use it to obtain an external MBeanServer Agent; otherwise, a default standalone MBeanServerFinder implementation will be adopt to get the internal default MBeanServer Agent. Integration In integration environment with top level java enabled management software or other JMX compliant HTTP Application Server, that Server has probably already provided an MBeanServer Agent for managing its manageable beans. When to integrate our JREntServer and MonitorServer with that Server, all our JREntServer s MBeans should be also registered into its existed MBeanServer. we provide an MBeanServerFinder interface to support user s customized implementation for obtaining an external MBeanServer Agent. If users want to integrate our JREntServer, MonitorServer with other JMX enabled Application Server environment, they should provide an MBeanServerFinder s implementation to obtain that Application Server s MBeanServer Agent, and append their implemented fully qualified class file name with the java option Djrs.externalMBeanServerProvider= to corresponding Application Server s launching java command line. Now, after launching that Application Server integrated by our JREntServer and MonitorServer, if user specify jmx startup enable, all JRentServer s MBeans will be built and registered into that application Server s MBeanServer Agent. At the same time, our provided default HtmlAdaptor will also be built and registered into that external MBeanServer Agent. We can now view all registered JREntServer s MBeans and that Application Server s registered managed beans from this HtmlAdaptor or via that Application Server s provided interface. In our default implementation, we have also provided three general integration related MBeanServerFinder implementations as the simple samples: JBossMBeanServerFinderImpl, TomcatMBeanServerFinderImpl and WebLogicMBeanServerFinderImpl. When users integrate JREntServer and MonitorServer with JBoss, Tomcat and WebLogic complied with JMX features, they can provide their implemented external MBeanServerFinder implementation to java command line s option Djrs.externalMBeanServerProvider=, or directly use our offered default implementation and append it to java option. Notes Index In MBeanServerFinder interface, we have now only specified one interface method: public MBeanServer getmbeanserver(); Users need to implement this interface method and provide a public Constructor method without any parameters. When to compile and release our JMX features, it s needed to append two Sun s JMX standard packages jmxri.jar and jmxtools.jar. Otherwise, it requires to use over JDK V1.5 (In J2SE V1.5 and over, Sun Co. have also provided JMX standard API as a part of JDK's standard APIs.) In addition, when to compile our JMX features with that three external integration MBeanServerFinder s implementation, it s needed to append three integration platform related packages to javac classpath: $jboss root$\lib\jboss jmx.jar (for JBoss V3.2.3), $tomcat root$\server\lib\catalina.jar (for Tomcat V4.1.30) and $weblogic root$\server\lib\weblogic.jar (for WebLogic V810). However, these three packages don t need to be appended to our release products. By the way, since our JMX monitoring function is based on currently existed MonitorServer and completely built within MonitorServer, only MonitorServer s release version need append Sun s JMX standard packages to MonitorSever s lib directory. JRentServer needn t append any things for JMX feature. 22

25 Integration with a Servlet Enabled Web Server Running with WebLogic (v8.1) on NT Let's suppose WebLogic 8.1 is installed under D:\bea. JReport Monitor Server is installed under C:\MonitorServer. Please take the following steps to integrate Monitor Server into Weblogic 8.1: 1. Edit the file D:\bea\weblogic81\samples\server\examples\build\examplesWebApp\WEB INF\web.xml: Add getremotefileservlet. Add the following lines to this file. Make sure that these lines are enclosed by <web app> and </web app>. <servlet> <servlet name> getremotefile </servlet name> <servlet class> jet.server.profiling.getremotefileservlet </servlet class> </servlet> <servlet mapping> <servlet name> getremotefile </servlet name> <url pattern> /monitor/getremotefile/* </url pattern> </servlet mapping> 2. Modify the command script D:\bea\weblogic81\samples\domains\examples\startExamplesServer.cmd: Add JRESServlets.zip and JREngine.zip to Weblogic's classpath: set CLASSPATH=d:\bea\weblogic81\server\lib\webservices.jar;%POINTBASE_CLASSPATH%; %CLIENT_CLASSES%;%SERVER_CLASSES%;%COMMON_CLASSES%; %CLIENT_CLASSES%\utils_common.jar;c:\MonitorServer\lib\JREngine.zip;c:\MonitorServer\lib\JRESSe Please note that, step 2 also may be finished by another way: Go to a folder named lib under D:\bea\weblogic81\samples\server\examples\build\examplesWebApp\WEB INF. Then copy JREngine.zip and JRESServlets.zip under C:\MonitorServer\lib to D:\bea\weblogic81\samples\server\examples\build\examplesWebApp\WEB INF\lib and rename JREngine.zip and JRESServlets.zip to JREngine.jar and JRESServlets.jar. 3. Set Monitor Server's monitor.home. Modify the command script D:\bea\weblogic81\samples\domains\examples\startExamplesServer.cmd: Set Monitor Server's monitor.home: 23

26 Integration with a Servlet Enabled Web Server "%JAVA_HOME%\bin\java" %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% Dweblogic.Name=%SERVER_NAME% Dweblogic.management.username=%WLS_USER% Dweblogic.management.password=%WLS_PW% Dweblogic.ProductionModeEnabled=%PRODUCTION_MODE% Djava.security.policy="%WL_HOME%\server\lib\weblogic.policy" Dmonitor.home=C:\MonitorServer weblogic.server 4. Copy the folder monitor under C:\MonitorServer\public_html to D:\bea\weblogic81\samples\server\examples\build\examplesWebApp. Now, you can access monitor server from web browser ( the default port of WebLogic is 7001): Index Running with Tomcat 4 and above on NT Preparation Assume 1. JReport Monitor Server is installed to c:\monitorserver. 2. Tomcat is installed to c:\tomcat. Note: For Tomcat 4.1.x, please make sure that there is no space in the Tomcat installroot, like "c:\tomcat 4.1". Otherwise you will encounter the RemoteException. Configuring Tomcat 1. Create subdirectory servlet in c:\tomcat\webapps. 2. Create subdirectory WEB INF under c:\tomcat\webapps\servlet. Save the following contents as a file with the name web.xml in the directory c:\tomcat\webapps\servlet\web INF: <?xml version="1.0" encoding="iso "?> <!DOCTYPE web app PUBLIC " //Sun Microsystems, Inc.//DTD Web Application 2.3//EN" " app_2_3.dtd"> <web app> <servlet> <servlet name> getremotefile </servlet name> <servlet class> jet.server.profiling.getremotefileservlet </servlet class> </servlet> <servlet mapping> <servlet name> getremotefile </servlet name> <url pattern> /monitor/getremotefile/* 24

27 Integration with a Servlet Enabled Web Server 3. </url pattern> </servlet mapping> </web app> Edit C:\tomcat\bin\catalina.bat. 1). Create the directory "lib" under c:\tomcat\webapps\servlet\web INF. Copy the two zip files JRESServlets.zip and JREngine.zip to c:\tomcat\webapps\servlet\web INF\lib. Rename the two zip files to jar files. 2). Set JAVA_HOME in this file, for example, we use D:\jdk1.2.2 rem $Id: catalina.bat,v /04/01 19:51:31 patrickl Exp $ rem set JAVA_HOME=D:\jdk1.2.2 rem Guess CATALINA_HOME if not defined if not "%CATALINA_HOME%" == "" goto gothome set CATALINA_HOME=. 3). Set the java system variable, like: if not "%SECURITY_POLICY_FILE%" == "" goto dosecurity %_EXECJAVA% %JAVA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% Djava.endorsed.dirs="%JAVA_ENDORSED_DIRS%" classpath "%CLASSPATH%" Dcatalina.base="%CATALINA_BASE%" Dmonitor.home="c:\MonitorServer" 4. Copy the folder monitor under C:\MonitorServer\public_html (with their subfolders) to C:\tomcat\webapps\servlet. Launching Tomcat Index 1. Start Tomcat by c:\tomcat\bin\startup 2. Load default page of Monitor Server by Running with IBM WebSphere 5.0 by a War File Suppose that WebSphere 5.0 is installed under C:\WebSphere. JReport Monitor Server 5.2 is installed under C:\MonitorServer. JReport servlet.war file is located under D:\servlet. Generating the War file 1. Create a new directory in your local disk. e.g. D:\servlet. 2. Create a sub directory "WEB INF" under it: D:\servlet\WEB INF. 3. Generate a web.xml like following and put it under D:\servlet\WEB INF. <?xml version="1.0" encoding="iso "?> <!DOCTYPE web app PUBLIC " //Sun Microsystems, Inc.//DTD Web Application 2.3//EN" " app_2_3.dtd"> <web app> 25

28 Integration with a Servlet Enabled Web Server <servlet> <servlet name> getremotefile </servlet name> <servlet class> jet.server.profiling.getremotefileservlet </servlet class> </servlet> <servlet mapping> <servlet name> getremotefile </servlet name> <url pattern> /monitor/getremotefile/* </url pattern> </servlet mapping> </web app> 4. Create a directory lib under D:\servlet\WEB INF. 5. Copy the class file JREngine.zip and JRESServlets.zip from C:\MonitorServer\lib to D:\servlet\WEB INF\lib. Then change their extension to.jar. 6. Copy folder monitor from C:\MonitorServer\public_html to D:\servlet. 7. Using the following command to create a WAR file which contains all the files under the monitor and WEB INF folders, and name it as "servlet.war": jar cvf servlet.war monitor WEB INF Deploying the War file To integrate JReport Monitor Server with IBM WebSphere 5.0, please take the following steps: 1. Start IBM WebSphere Open Administrative Console. You can open Administrative Console by using the Start Menu, or by using the url: where the hostname is host name or IP address, and 9090 is the port number. The User ID must contain only letters and numbers, you can use any of them as your User ID. 3. After successfully log in, expand the Applications node in the left tree, and then click Install New Application. 4. In the Path section, select Local path, and then click Browse to select your.war file. In the Context Root section, type "/servlet/", and then click Next. 5. Do not check any option on this page, click Next. 6. On the Step1: Provide options to perform the installation dialog, type "MonitorServer" in the Application Name field. You can check the Pre compile JSP option, and then click Next. 7. Do not make any changes to the next two pages. 8. Click Finish on the Summary page. The installing process may take several minutes, please wait until the process is completed. 9. After the installation process successfully completed, click Save to Master Configuration, and then click Save on the Save to Master Configuration dialog. 10. Expand Servers, go through Application Servers Server1 Process Definition (in the Additional Properties table) Java Virtual Machine (in the Additional Properties table), type " Dmonitor.home=c:\MonitorServer" (JReport Monitor Server installation folder) in Generic JVM arguments field on the Configuration tab. Click OK, save the changes, and then restart WebSphere Access JReport Monitor Server using the following url: 26

29 Integration with a Servlet Enabled Web Server 27