Nimsoft Monitor. wasp Guide. v2.7 series

Transcription

1 Nimsoft Monitor wasp Guide v2.7 series

2 Legal Notices Copyright 2012, Nimsoft Corporation Warranty The material contained in this document is provided "as is," and is subject to being changed, without notice, in future editions. Further, to the maximum extent permitted by applicable law, Nimsoft Corporation disclaims all warranties, either express or implied, with regard to this manual and any information contained herein, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Nimsoft Corporation shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein. Should Nimsoft Corporation and the user have a separate written agreement with warranty terms covering the material in this document that conflict with these terms, the warranty terms in the separate agreement shall control. Technology Licenses The hardware and/or software described in this document are furnished under a license and may be used or copied only in accordance with the terms of such license. No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Nimsoft Corporation as governed by United States and international copyright laws. Restricted Rights Legend If software is for use in the performance of a U.S. Government prime contract or subcontract, Software is delivered and licensed as "Commercial computer software" as defined in DFAR (June 1995), or as a "commercial item" as defined in FAR 2.101(a) or as "Restricted computer software" as defined in FAR (June 1987) or any equivalent agency regulation or contract clause. Use, duplication or disclosure of Software is subject to Nimsoft Corporation s standard commercial license terms, and non-dod Departments and Agencies of the U.S. Government will receive no greater than Restricted Rights as defined in FAR (c)(1-2) (June 1987). U.S. Government users will receive no greater than Limited Rights as defined in FAR (June 1987) or DFAR (b)(2) (November 1995), as applicable in any technical data. Trademarks Adobe, Acrobat, Acrobat Reader, and Acrobat Exchange are registered trademarks of Adobe Systems Incorporated. Intel and Pentium are U.S. registered trademarks of Intel Corporation. Java(TM) is a U.S. trademark of Sun Microsystems, Inc. Microsoft and Windows are U.S. registered trademarks of Microsoft Corporation. Netscape(TM) is a U.S. trademark of Netscape Communications Corporation. Oracle is a U.S. registered trademark of Oracle Corporation, Redwood City, California. UNIX is a registered trademark of the Open Group.

3 Contact Nimsoft For your convenience, Nimsoft provides a single site where you can access information about Nimsoft products. At you can access the following: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads Nimsoft Support policies and guidelines Other helpful resources appropriate for your product Provide Feedback If you have comments or questions about Nimsoft product documentation, you can send a message to support@nimsoft.com.

4

5 Contents Chapter 1: wasp wasp configuration... 8 Setup tab... 9 Webapps tab Raw Configure for wasp Contents 5

6

7 Chapter 1: wasp 2.7 This description applies to wasp probe version 2.7x. WASP (Web Application Service Provider) is an embedded Tomcat server running as a probe. The probe is distributed to the system during the SDP installation, and it will appear as a probe in Infrastructure Manager after the installation. The configuration can be divided in to two main areas, the configuration of WASP itself and the configuration of web applications running under WASP. Database support Currently, the wasp probe supports MS-SQL and MySQL databases. The wasp probe uses the database specified in the data_engine probe. For more details, please refer to the data_engine probe documentation. This section contains the following topics: Documentation Changes (see page 8) wasp configuration (see page 8) Raw Configure for wasp (see page 23) Chapter 1: wasp 2.7 7

8 Documentation Changes This table describes the version history for this document. Version Date What's New? 2.7 June 2010 Updates for version 2.7. Related Documentation Documentation for other versions of the wasp probe (../../wasp.html) Getting Started with Nimsoft Probes Nimsoft Probes Reference wasp configuration The probe is configured by double-clicking the probe in the Infrastructure Manager, which brings up the GUI (configuration tool). The configuration of WASP consists of the configuration of the WASP itself, as well as the configuration for the various web applications running under WASP. Only SDP web application is installed by default during SDP installation. The GUI consists of two different tabs, enabling you to define a number of layout and infrastructure parameters for the SDP. Setup tab Webapps tab 8 wasp Guide

9 Setup tab This section describes the general parameters for the probe. The Setup tab is further divided into two tabs: General and Logging General tab Log-level Set the detail level for messages logged to the log-file. This log level applies only to internal WASP logger. Each web application can have its own logger(s) which in turn can be set to have different log levels. Chapter 1: wasp 2.7 9

10 Log-size Database connection pooling Override NIS credentials Port configuration Java startup parameters Set the size of the probe s log file to which probe-internal log messages are written. The default size is 100 KB. When this size is reached, the contents of the file are cleared. Both the internal WASP logger and all the web application loggers write to same log file, so this should be taken into consideration when setting the log-size. NIS database connection pooling parameters, such as max active connections, max wait and max idle. Max active: The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit. Max idle: The maximum number of connections that can remain idle in the pool, without extra ones being released, or negative for no limit. Max wait: The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely. Option to override username and password credentials for the NIS store. By default the same credentials that Data Engine uses (sa) are used by WASP and for security reasons one may choose to use credentials that give less privileges to web applications. These ports were specified (and verified) during the SDP installation. At least one of the below has to be set. http port The SDP s HTTP/WEB port. aip port The SDP s AJP port against the DMZ Web server. Set the default and maximum heap size for Java Virtual Machine running WASP. Min / Max memory usage, will be converted into Xmn(#)m and Xmx(#)m switches which will be passed to the java virtual machine that will hosting WASP. Number of web applications, number of concurrent users and size of the data set should be taken into consideration when setting these values. 10 wasp Guide

11 Nimpool Probe addresses Extra Java VM arguments The properties of the NimBUS request pool are defined by these parameters. NimBUS request pool is used to maximize the performance when multiple requests are made to the same destination (usually a probe). Note that a web application needs to actively use the Nimpool in order to gain benefit from these settings. Max active: Maximum number of active connections towards the same destination. Max idle: Maximum time in seconds before an idle connection is dropped. Max wait: Maximum time in seconds for which client will wait for a new connection before throwing an exception. Timeout: Maximum time in seconds for which client will wait for a connection to be established before throwing an exception. Data Engine and Dashboard Engine addresses need to be set for WASP in order for the database connection to NIS store to be established. WASP will not run without a valid connection to NIS. These arguments are passed directly to the java command line during WASP startup. Can be used to fine-tune Java Virtual Machine. Logging tab Each web application running under WASP can have several loggers which in turn can be set to different log levels. These can be controlled from this tab. Chapter 1: wasp

12 12 wasp Guide

13 Webapps tab This tab lists the available WEB applications (only SDP is installed by default) controlled by the WASP probe. Right-clicking the Web application and clicking Edit enables you to edit the default web application specific parameters. Chapter 1: wasp

14 webapps properties General tab Startup mode Path Sets the startup-properties for the web application.. Valid options are: Automatic (default), which means that the web application will automatically be started when WASP is started. Manual, which means that the web application will be deactivated when WASP starts up, and must be started manually. The context path which is used in URL when accessing this web application. ( 14 wasp Guide

15 SDP tab Login page logo url Default Language Default skin Defines properties specific to SDP web application. This field points to the default logo being shown to the user on the SDP login page.if not using the default, the value has to be a full URL pointing to the logo file which can either be a picture in a format recognized by the browser or a Flash animation. This field specifies the default language being used on the SDP portal. Default is English. This can be overruled by selecting the option Action > Customize SDP visual Settings in the SDP. This is the default skin being used on the SDP portal. Default is blue sky. This can be overruled by selecting the option Action > Customize SDP visual Settings in the SDP. Chapter 1: wasp

16 Default logo Default homeurl Show no case as clear Report refresh interval Dynamic views nodes per group Dashboard nodes per group Media path Max upload size External Unified Report webapp This field points to the default logo being shown to the user on the SDP itself (not the login page). If not using the default, the value has to be a full URL pointing to the logo image file. This can be overruled by selecting the option Action > Customize SDP visual Settings in the SDP. This is the url to the default SDP homepage. This can be overruled by selecting the option Action > Customize SDP visual Settings in the SDP. This specifies whether a "no state" should be shown as clear (green) or no value (grey) in all places where state is shown in SDP. This is the interval at which the reports under the Dynamic Reports and Reports will be refreshed. Default is 900 seconds. Dynamic views nodes will be grouped (alphabetically) when the number of nodes exceeds the number specified in this field. Dashboard nodes will be grouped (alphabetically) when the number of nodes exceeds the number specified in this field. Path to the media files used by dashboards. Path is relative to WASP root. Maximum size (in MB) for the content to be uploaded in SDP webapp When installing SDP 2.2, you have an option to install Unified Reports. Installing the Unified Reports will create two web applications on the local WASP where the SDP 2.2 is being installed. 16 wasp Guide

17 If SDP and Unified Reports are running on the same wasp, no change needs to be made to the default value of the Unified Reports URL. However, in case you wish to move your Unified reports web-application to a different WASP in order to distribute the load, you can do so by specifying the appropriate link in the Unified Reports URL text field. Select the External Unified Report webapp checkbox and update the Unified Reports URL to the new location of your Unified Reports. Note that this is only a configuration setting for the local SDP web-application and will not automatically move your unified reports to the new wasp. If you deselect the External Unified Report webapp checkbox, the wasp GUI will synchronize the port in the http port in the Setup tab of wasp GUI and the port number in Unified Reports URL. In other words, if you change the value for http port to say 8088, then the wasp GUI will update the URL in Unified Reports URL with If you select the External Unified Report webapp checkbox, the wasp GUI will not synchronize http port with Unified Reports URL since it assumes that the two settings are pointing to different servers. Note that independent of whether External Unified Report webapp checkbox is selected or not (and content of Unified Reports URL is disabled), SDP will still use the setting in Unified Reports URL in order to find the Unified Reports server. It is also possible (but normally not advisable) for the administrator to configure Unified Reports URL to point to an external server, and then deselect External Unified Report webapp. This will result in SDP pointing to an external Unified Reports server, and whenever the http port in the Setup tab of the wasp GUI is changed, the port in the address for the external Unified Reports server will also be updated. Chapter 1: wasp

18 18 wasp Guide

19 Important: If you change the value of http port in the Setup tab of wasp GUI and click Apply, the change will be automatically reflected in Unified Repors URL text field. Chapter 1: wasp

20 SDP offers a hierarchy of customization System customization This is done using the wasp probe configurator for the SDP web application. Group customization Settings may be customized for the group Nimsoft users or for an specific account. This customization will override the system settings for the group in question. Please see SDP UserGuide documentation for details. Individual customization Settings may be customized for a Nimsoft user or an account s contact. This customization will override any group or system customization for the specific user/contact. Please see SDP UserGuide documentation for details. The configuration items "Login page logo url", "Default logo" and "Default homeurl" can all either specify a URL to a web server or make use of a local file in the folder $NIMSOFT/probes/service/wasp/media: /media/myimage2.jpg The configuration item "Login page logo url" can only be specified through the sdp web application s configuration while the two others can be overridden by the group or individual settings in SDP s customization. 20 wasp Guide

21 Probes tab This tab specifies the path to all probes used by the SDP. Dap was installed during the installation of the SDP, others were detected as already installed (during the Nimsoft Server installation) on your system (nas, discovery_server and ace). Chapter 1: wasp

22 Logging tab Each web application running under WASP can have several loggers which in turn can be set to different log levels. These can be controlled from this tab. 22 wasp Guide

23 Raw Configure for wasp Raw Configure for wasp To configure additional settings for the wasp probe, right-click on it while holding down the SHIFT key and select Raw Configure option from the context menu. Raw Configure dialog appears, with a tree view listing various settings for the wasp probe. Select a setting from the tree view and configure its properties from the right side pane. setup loglevel data_engine Sets the level of details written to the log file. By default, the log level slider is set to 1 Sets the address of data_engine, By default is local hub s data_engine Chapter 1: wasp

24 Raw Configure for wasp https_port https_max_threads http_max_threads ajp_max_threads The port for SSL communication. The maximum concurrent https requests that can be handled by wasp Default if not set is 40, default from cfx is 500. The maximum concurrent http requests that can be handled by wasp Default if not set is 40, default from cfx is 500. The maximum concurrent ajp requests that can be handled by wasp Default if not set is 200, default from cfx is 250. webapps sdp load_on_startup path Will cause the webapp to be loaded/started at startup of wasp. By default, this is set to true The path / URL of a web application deployed onto wasp, so /SDP indicates that the SDP web application will be deployed at Portal/SDP 24 wasp Guide

25 Raw Configure for wasp cross_context reloadable login_page_logo_url max_upload_size_in_mb default_skin unpack_war auto_login_acl allow_cleartext_password media_path default_home_url default_logo This controls the behavior of web application container i.e. tomcat. Set to true if you want calls within this application to ServletContext.getContext() to successfully return a request dispatcher for other web applications running on this virtual host. By default, this is set to true This flag controls behavior of web container to decide whether the java class modules are reloadable or should detect any changes to the repository in the runtime. By default, this is set to true Can be set to point to a swf file in $NIMBUS/probes/service/wasp/media as f.ex. /media/mymovie.swf By default, this is set to flashlogo.swf. The maximum size of a media file which can be uploaded to SDP, a value of -1 indicates unlimited (current unlimited is defined as 100MB) while default value is 10MB if this configuration is not defined or is defined with empty. value. Skin to be used. By default, this is set to bluesky Will cause the webapp to be unpacked at first startup. Allows the webapp to customized further than what is possible through wasp configurator. By default, this is set to false Disables all security constraints if set to non-null value. By default, this is set to [ACL] If set to true login will allow usage of clear text passwords and encrypted passwords. By default, this is set to false The path from $NIMBUS/probes/service/wasp to where the media files (images and sounds) for the SDP dashboards are placed. The url for the home page of SDP. You can either specify welcome.html: default setting (blank will give same result) an http url (for example, a local file (for example, /SDP/media/my_own_welcome_page.html) Note that the local file must reside in the folder /media under $NIMBUS/probes/service/wasp. Can be set to point to a file in $NIMBUS/probes/service/wasp/media as f.ex. /media/mymovie.jpg Chapter 1: wasp

26 Raw Configure for wasp report_type (*1) disable_report_engine_requests enable_multi_instance media_update_interval Session_timeout load_on_startup lifecycle_listener nas dap discovery_server ace online_support_url default_language Can be set to the values 0-3, where bit 0 controls original dv reports and bit 1 controls on-demand dv reports. The variable is handled as a bit-pattern giving following 0 no dynamic views reports shown 1 the original (periodically generated) dynamic views reports will be shown 2 the new on-demand dynamic views reports will be shown 3 both 1 and 2 above When set to true disables all communication with report_engine which effectively disables dynamic and custom reports. On-demand dynamic views reports are still available. Setting this value to 1 will start the Media Sync thread. This thread synchronizes the media files of SDP webapps using the same NIS database. By default, this value is set to 0 (zero). Enable this key only if you are running multiple instances of wasp on the same NIS database. Specifies the duration in seconds between each interval of media sync thread. This thread synchronizes the media files of SDP webapps using the same database. By default, this value is set to 60 seconds. This value is used only when enable_multi_instance is set to 1. Specifies the max idle time in minutes before the session is invalidated. Note that SDP does a lot of periodic AJAX/Flex requests, so under normal circumstances the session will never expire. Will cause the webapp to be loaded/started at startup of wasp. By default, this is set to true Fully qualified SDP LifecycleListener class used to load the class in application context. By default, this is set to com.nimsoft.nimbus.webapp.sdp.wasplifecyclelistener Address of nas probe ( /domain/hub/robot/nas) Address of dap probe ( /domain/hub/robot/dap) Address of discovery_server probe (/domain/hub/robot/discovery_server) Address of ace probe ( /domain/hub/robot/ace) URL used when clicked on online support tab.. By default, this is set to Language to be used. By default, this is set to en (English) 26 wasp Guide

27 Raw Configure for wasp show_no_state_as_ report_refresh_interval dynamic_views_nodes_per_group dashboards_nodes_per_group fx_allowplayerfullscreen fx_openlinkeddashboardexternally license_expire_warning_days jasper_is_external use_html_upload log auto_login_acl When true no state for alarm will be considered as clear state. By default, this is set to true Is used by both Unified Reports and "classic" reports. It specifies the interval at which the local list of reports in SDP is refreshed by a web service call to Unified Reports and/or call to report engine. By default, this is set to 900 If dynamic group node name list reaches this number then the nodes will be grouped, and this configured value will be used as size of each group created then onwards. By default, this is set to 50 If dashboards name list reaches this number then the dashboard names will be grouped, and this configured value will be used as size of each group created then onwards. By default, this is set to 50 When true, allows the dashboard to be viewed in full screen in dashboard player. By default, this is set to true When true, the linked dashboard opens in a new browser window. By default, this is set to true Decide when to display the license expiry warning in days, if set to zero, no warning will appear. Used by wasp/sdp GUI to specify that the Unified Reports are running on another wasp. By default, this is set to false Flash player on Mozilla Firefox has limitation working with HTTPS while having self signed certificate, in such scenario the flex based file upload (media upload / dashboard import) do not work. So it is recommended for such scenario to set the value of this configuration parameter to 1. So that file upload is possible using html based uploader instead of uploader in flash player. By default, this is set to 0 (zero) com.nimsoft.nimbus.webapp.sdp loglevel = 1 Loglevel used by sdp webapp. In addition to disabling all security constraints which is done by wasp it fakes the login procedure for the given ACL. By default, this is set to [ACL] Chapter 1: wasp