Manageengine Application Manager

.bin -i console For example, if the name of the file is ''ManageEngine_ApplicationsManager.bin'', then the command should be as follows: ./ManageEngine_ApplicationsManager.bin -i console Execution of the above command would take you through the installation process. However, to execute .bin type of files, users should require Execute permission. When installing Applications Manager in a Linux machine, make sure that the installation is done using a non-root user account with admin privileges. Troubleshooting an Installation process In case of problems during installation in a Linux system, follow the steps given below to produce the logs files: Create a text with the same name as that of the installer and with extension as ".sp". i.e, For .bin, create a text file named .sp. For example, if the file name is ManageEngine_ApplicationsManager.bin, create a text file named ManageEngine_ApplicationsManager.sp Open the ".sp" text file in an editor, add is.debug=1 as the content. Save the ".sp" text file in the same directory where the binary file resides. Change to the directory where the binary file is present by executing cd command Invoke the installer as ./ .bin -is:javaconsole -is:log log.txt The above command will create the log file named log.txt. Mail the log file to appmanager- support@manageengine.com. Note If the execution of the installation command throws an error such as "there may not be enough temporary space available in the temp folder", then execute the file with the argument as For Windows: .exe -is:tempdir $DIRNAME For Linux: ./ .bin -is:tempdir $DIRNAME where $DIRNAME is the absolute path of any existing directory.   Troubleshoot: For more Installation Troubleshooting, refer Troubleshooting page on our website.Uninstalling Applications Manager Windows Shut Down Applications Manager (Make sure that the ManageEngine ApplicationsManager service is stopped if installed as a Windows service) Open a command prompt as an administrator [ Command Prompt → right click → Run as administrator], go to Applications Manager Home directory and execute the following commands: shutdownApplicationsManager.bat shutdownApplicationsManager.bat -force Exit out of the command prompt and close all files, folders opened in the directory Click Start → Programs → ManageEngine Applications Manager → Uninstall Applications Manager Also from Control Panel → Add/Remove Programs. Linux From the command line, go to Applications Manager Home directory ( by default it is /opt/ManageEngine/AppManager ) and execute the below commands: sh shutdownApplicationsManager.sh sh shutdownApplicationsManager.sh -force Exit out of the command prompt and close all files, folders opened in the Applications Manager Home directory Execute the command ./uninstaller.bin from the AppManager/_uninst directory. Note You can uninstall Applications Manager via Command Line also. Type the following command in the command prompt: ./uninstaller.bin -console Execution of this command would take you through the uninstallation process. Here''s how you can manually uninstall Applications Manager   Frequently Asked Questions (FAQs) Question: How can perform a "Silent Installation" of Applications Manager? Solution: To perform silent installation of Applications Manager, refer to the following links: For Windows OS, refer here. For Linux OS, refer here.   Question: I downloaded the .bin file to install Applications Manager in my Linux machine. When I tried to execute the file I got a dialog box displaying "Could not display the file. File is of an unknown format". Solution: You must change the permission for the downloaded file. To do so, execute the following command to provide the permission for executing the downloaded file: chmod +x .bin Example: chmod +x ManageEngine_ApplicationsManager_64bit.bin After executing the above command, you will be able to install Applications Manager in Linux machine. Note: By default, Applications Manager will not store installation logs. To enable installation logs, do the following: Create a file named APMBinFileName.sp (ManageEngineApplicationsManager.sp) in the location where the .bin folder of Application Manager is downloaded.Inside the file, type (is.debug=1) and save it. Then start the installation using below options: ./bin -is:log log.txt along with the options that are given in the solution. Troubleshooting For troubleshooting tips on installation and setup, go to our support portal. Licensing Applications Manager When you have purchased the registered license file, you need to apply the license file over the existing version. This section explains the procedure to apply the new license file. Applying the New License File from the Web Client A quick way to apply the new license file is from the web client. In the web client, click on the Settings tab link provided at the top right-hand corner. Click Product License link in the menu A Register Applications Manager pop-up is displayed. Click Browse button and locate the file (License.xml) in your local machine. Click Register. Your existing version is now changed to Professional Edition - Registered. Note: For Enterprise Edition, it is sufficient that you apply the license in Admin Server alone, the managed servers will be taken care automatically. The Product License link on top will disappear once you have applied the registered license. If the registered customers, want to upgrade their license  further, they can use the Product License link under Applications Manager Server Settings in the Admin tab. Applying the New License File using License Manager The license manager comes handy when your license has already expired and you are not able to access the web client. Invoke the updateLicense.bat/.sh file located in the /bin directory (For Windows use ''Run as Administrator'' option). The License Manager UI is displayed. Click Browse button and locate the file (License.xml) in your local machine. Click Next and then Click Finish. Re-start the Applications Manager server. Note: To invoke License Manager via Command Line, use the following command Applying a license in a plugin build Users must apply the OpManager license in the OpManager console to register the Applications Manager plugin (you need not apply the OpManager license file on APM plugin license tool). Please contact us at appmanager-support@manageengine.com for any technical query. Using Update Manager Overview Update Manager is a tool which is used for installing the service packs (.ppm file) over Applications Manager. The service pack may contain certain bug fixes and new feature additions. This document explains about how to use the Update manager to install service packs over Applications Manager. Note: The Update Manager also has some useful validation incorporated. This validation includes compatibility checks. You cannot use update manager to install an incompatible service pack. For example,you cannot install a service pack of another product in Applications Manager or a service pack of one version of Applications Manager in another version. Installing Service Pack using Update Manager Execute the updateManager.bat/sh file located in the /bin directory or invoke through Start → Programs → ManageEngine Applications Manager 15 → Update Manager in Windows (For Windows, use ''Run as Administrator'' option). The Update Manager tool is displayed. Click Update. Provide the service pack (.ppm) file by clicking the Browse button. Only compatible service pack file will be opened. Once the file is specified,  other buttons such as Readme and Install are enabled. Click the Readme button and the Readme file related to the service pack is displayed in a separate window. Click Install. This opens a new panel where the installation process is displayed. On completion, a message "Service Pack installed successfully" is displayed and the service pack is listed in the Installed Patches section To uninstall the service pack, click the Uninstall button. To know the service pack details, click the Details button in Update Manager. Installing Service Pack using Update Manager (Command Line Option) To invoke Update Manager, navigate to /bin directory and execute the following command: For Windows: updateManager.bat -c For Linux: sh updateManager.sh -c To force quit Applications Manager, execute the following command: For Windows: shutdownApplicationsManager -force For Linux: shutdownApplicationsManager.sh -force Using this command line option, you can install or uninstall a service pack or view its details. Press ''i'' to install and specify the absolute path of the service pack file in your machine. Troubleshooting For troubleshooting steps, go to our Support Portal. Starting and Shutting Down Applications Manager Starting Applications Manager Once installation is successful, you can start the Applications Manager by following the instructions provided for different operating systems. To start Applications Manager In Windows Click Start → Programs → ManageEngine Applications Manager XX → Applications Manager Start (or) Invoke the batch file startApplicationsManager.bat located in the directory. Once the server is initialized, a tray icon is placed in the Windows system tray  . After the server is started completely the icon changes to   and a message "Server Ready for Monitoring!" is displayed over the icon. Right- click on the Applications Manager tray icon to connect to the web client or stop Applications Manager. Starting Applications Manager as a Windows Service: In Windows, you can start Applications Manager as a service. With this feature you can start the Applications Manager server automatically when the Windows system starts.By default, during product installation, you can choose to install it as a service (More on Installation). If you have not enabled it then, use the following option to setup Applications Manager as a service. Go to /bin directory, execute the installservice.bat file. On executing this file, ''ManageEngine Applications Manager'' service is added in Windows Services and the startup type is set as ''Automatic'', by default. (To ensure if it is installed as a service, check for the ''Services'' under ''Windows Administrative Tools''). Note: For installing Applications Manager as service, you need to have administrative privileges in that system. Now, when you start Windows system, Applications Manager is automatically started. You can swap between Automatic and Manual modes. To uninstall this service, go to /bin directory and execute the uninstallservice.bat file. In Linux: From the command line, go to directory (by default, it is /opt/ManageEngine/AppManager) and execute the below command to start the product: nohup sh startApplicationsManager.sh & To start Applications Manager as a service in Linux, refer here. Troubleshoot: Having trouble starting Applications Manager? Refer to the online troubleshooting section. Shutting Down Applications Manager To shutdown Applications Manager In Windows Click Start → Programs → ManageEngine Applications Manager XX → Applications Manager Shutdown (or) In Applications Manager''s Settings tab, under Tools, click on Shut Down Applications Manager icon (or) Invoke shutdownApplicationsManager.bat file located in the directory (or) Right-click on the Applications Manager tray icon and click Stop Applications Manager (or) Go to Start → Run → services.msc → opens up Services console → stop ManageEngine Applications Manager. [If Applications Manager is running as service] In Linux Use shutdownApplicationsManager.sh script located in the directory to shutdown Applications Manager. You can also use the Shut Down Applications Manager tool under Settings tab in Applications Manager. Compare our Editions Meet your specific monitoring and business objectives by choosing the right edition of ManageEngine Applications Manager. Applications Manager is available in these editions - Free, Professional and Enterprise. Features Free Professional Enterprise Supports integrated Supports monitoring up to Supports large performance monitoring 5 apps or servers. There is deployments with its Out-of-the-box support for for a heterogeneous set of no time limit on the free distributed monitoring 80+ applications applications. Ideal for edition - you can use it capability. Ideal for large small to medium forever. enterprises. enterprises. Server Monitoring Monitor open source apps & servers Monitor commercial apps & servers (For Five Monitors)Features Free Professional Enterprise Application Server Monitoring MySQL, Oracle, MS SQL, PostgreSQL, Memcached, Database Monitoring Cassandra, MongoDB and Redis. Website / Web Services Monitoring SLA Management Exchange Server Monitoring Virtualization monitoring VMware Monitoring Only Cloud monitoring WebSphere MQ Series monitoring MS Office SharePoint monitoring AS400 monitoring ERP monitor Web transactions monitoring for J2EE and .Net (APM Insight) Web transactions monitoring for Ruby on Rails(APM Insight) Integration with Site 24x7 End user monitoring (EUM) URL monitoring/multi- step URL sequence monitoring User administration, network discovery, custom dashboards ManageEngine OpManager Connector ServiceDesk Plus Integration Anomaly detection Admin tools: Downtime scheduler, Trap Listener, Scheduling, enabling, disabling reports. Updates and patches Technical support E-mail Support (30 days) Failover support High scalability Distributed architecture Supported Operating Windows, Linux Windows, Linux Windows, Linux Systems for Installation Starts @ $395 for 10 Starts @ $9,595 for 250 Price Free monitors monitors Verifying build integritySHA256 checksum verification helps verify integrity of files you download. It helps identify if the downloaded file has been corrupted. After you have downloaded Applications Manager binaries, you should ensure that its SHA256 checksum matches the one provided in the Applications Manager download pages. Steps to verify SHA256 Checksum: Open command prompt with administrator privileges. Navigate to the directory in which the downloaded file exists. Based on the OS you are using, execute the command mentioned. (The sample output is mentioned below each command) Windows: C:\Users\Downloads> CertUtil -hashfile ManageEngine_ApplicationsManager_64bit.exe SHA256 SHA256 hash of ManageEngine_ApplicationsManager_64bit.exe: 3a4a903b80f75618698c6ba66aca0b298ab861f75ae0b2322a661a593cae2a51 CertUtil: -hashfile command completed successfully. Linux: $> sha256sum ManageEngine_ApplicationsManager_64bit.bin $> fc8881646e23053ad42548782243af1ef8ae675d0386d5a8753041a7dbdf2e95 ManageEngine_ApplicationsManager_64bit.bin MAC: $> shasum -a 256 ManageEngine_ApplicationsManager_64bit.exe $> 3a4a903b80f75618698c6ba66aca0b298ab861f75ae0b2322a661a593cae2a51 ManageEngine_ApplicationsManager_64bit.exe After executing the command, verify that the returned checksum value matches the SHA-256 value mentioned in the Applications Manager''s download page. If the values do not match, download the file again and repeat this procedure. Security Best Practices With the digital era evolving and expanding rapidly, the frequency of cyber attacks is also increasing at an alarming rate. Hence, it is critical to follow guidelines and best practices as a first line of defense against potential threats. Below is a list of recommended guidelines that will help us achieve our common goal of enhancing security and preventing possible intrusions. Disable HTTP By default, Applications Manager can be accessed via both HTTP and HTTPS ports. To ensure a secure connection between Applications Manager server and the browser/client, it is recommended to disable HTTP access. Show me how. Use Third Party SSL Certificate Applications Manager comes with a self-signed SSL certificate for HTTPS to work. However, to enhance security it is recommended that you apply your own CA signed SSL certificate. Show me how. Disable TLSv1 and TLSv1.1 protocols for HTTPS port Applications Manager supports TLSv1, TLSv1.1 and TLS v1.2 by default. It is recommended that you disable old TLS v1/1.1 protocols. Show me how. Enable Security response headers Security response headers act as an added layer of security that helps browsers to detect and mitigate certain types of attacks. It is recommended that you enable these headers to prevent click-jacking, cross-site scripting, and MIME type sniffing attacks. To enable security response headers, navigate to Settings -> Security Settings -> Enable Security response Headers To learn more about this, click here. Setup complex passwords and enforce account locks By default, Applications Manager''s password policy enforces password encryption by default. It mandates you to set complex passwords to enhance security and make it less vulnerable to cyber attacks. It is alsorecommended that you change the Super admin''s password after installation of the product. To defend against password-guessing attacks, it is recommended that you enforce account locks in case of consecutive failed login attempts. Show me how. Implement role-based access control (RBAC) Applications Manager provides you the ability to manage users and roles for your enterprise, with roles assigned to users and different permissions associated to each role. This enforces controlled access to the product thereby ensuring effective authorization. It is recommended that you add users and associate them with the required roles to prevent unwanted access and changes. Show me how. Enable LDAPS when configuring domain Applications Manager provides domain configuration options and also lets you import users from those domains. It is recommended that you enable LDAPS while configuring domains to ensure secure communication with domain controllers. Show me how. Enable Data Protection To ensure that report data is accessed more securely, it is recommended that you enable data protection in security settings. Applications Manager enforces password protection for reports in all formats (PDFs, HTML files, and CSVs). To enable Data Protection, go to Settings -> Security Settings -> Data Protection. Disable file upload The Applications Manager UI has an option that allows admins to upload files into the Applications Manager directory. As a measure to avoid harmful files from being uploaded accidentally, it is recommended to disable this option. You can enable it whenever required. To disable file upload, navigate to Settings -> Security Settings -> Disable file upload. Enable read-only database user connection for Query Tool Applications Manager has a query tool that lets the super admin obtain data from the database by executing custom queries. To prevent accidental change in the database that might likely impact the functioning of the entire application, it is recommended to enable read-only database user connection for Query tool. To enable read-only database user connection for Query Tool, go to Settings -> Security Settings -> Enable read-only database connection for query tool. Upgrade to the latest version of Applications Manager Ensure that you frequently upgrade to the latest version of Applications Manager to experience the latest features and to ward off possible vulnerabilities. Also, periodically back up application data and database. Refer this link to upgrade to the latest version. Other options: IP Whitelist/Blacklist: Grant access to specific IP addresses to access Applications Manager. Server Information Headers (Banner): Disable information about the underlying hosting environment. Session Timeouts: Configure browser session idle time for inactivity. Common Best Practices Subscribe to the Applications Manager security advisory mailing list. (Navigate to Admin -> Privacy settings - > Breach notification) Ensure that you always have the latest host operating system, browser, and network security update installed. Ensure that you do not expose Applications Manager on the public Internet. If you must enable outbound internet access from Applications Manager servers, create a strict allow list and block all other traffic. Disable unnecessary ports, protocols, and services on your host operating system. See Security/Firewall Requirements of Applications Manager. Only authorized users should have access to the machine where you install Applications Manager server. Ensure that the credentials you provide in Applications Manager for monitoring/integration purpose must follow the principle of least privilege. Getting StartedWhen Applications Manager is started in Windows, the default browser as configured in your system is invoked and the login screen is displayed. Login by specifying the authentication details. The default user name and password are "admin" and "admin" respectively. To know more about the different types of user access to the product, refer to the User Administration section of Performing Admin Activities. In Windows, if you do not want the client to open by default, follow the steps given below to disable it. Edit AMServer.properties file located in the /conf directory. Set the value of am.browser.startup as false (by default, it is true). After this configuration, when you restart the server the next time, the web client will not be invoked automatically. In Linux, by itself, the client will not open by default.. To login to Web Client, when it is not opened by default Connect to the Applications Manager through any browser with the host name and port number, say http://localhost:9090, where 9090 is the default port number. In Windows, go to Program Files → ManageEngine Applications Manager → Applications Manager Web Console. Right-click the Applications Manager tray icon and click Start Web Client. Then log in to the Applications Manager by filling in the User Authentication details. In case you forgot the password for your user account, you can reset the password from the login page using the Reset Password option. To do so, follow the steps given below: Click over the Reset Password link available in the login page. Enter the username and the email ID configured for the user and click Reset Password. An email containing the link for password reset will be sent if the given user details are correct. Click over the Reset Password link mentioned in the mail. On clicking the link, you will be redirected to the Password Reset page. Enter the new password to be configured for the user account and submit. Once password reset is successful, you can login using the new password configured from the login page. Note: Reset Password option is not supported for Plugin and SSO-enabled Enterprise Edition setup. You can also use the startWebConsole.bat or sh file available at the directory that opens a default browser of the localhost and connect to the Applications Manager at http://localhost:9090. Ensure that the Applications Manager is started before executing this file. Browse through the following topics which would help you understand Applications Manager better and work with it easily. Understanding Applications Manager Prerequisites for Applications Manager Working with Applications Manager You can also refer our Best Practices Guide for more help on getting started with Applications Manager. Note User management is not supported for the Applications Manager plugin build over OpManager. At present, there are only two types of roles available for plugin users - Administrator and Read-Only User. Operator, Delegated Admin and Manager role is not supported. Applications Manager Plugin users cannot assign monitors to the any specific users in the Apps tab. They can view all the default monitors only. Prerequisites for Applications Manager Discussed below are the prerequisites for managing the various monitors: Application Servers GlassFish JBoss Oracle Application ServerTomcat WebLogic WebSphere Java Runtime Monitor Resin Server Jetty Server Apache Geronimo Database Servers IBM Informix Server MS SQL DB Servers MongoDB Servers MySQL DB Servers Oracle Database Servers Oracle Pluggable Database (PDB) PostgreSQL SAP ASE / Sybase SQL Server / Sybase ASE SAP HANA SAP MaxDB SQL Anywhere IBM DB2 Cloud Apps Microsoft Azure Azure Virtual Machines Azure SQL Database Azure Kubernetes Service (AKS) Microsoft 365 AWS Monitoring Amazon EC2 Instances Amazon RDS Instances Amazon DynamoDB Amazon Billing Amazon Elastic Load Balancer Amazon SNS AWS Lambda AWS Elastic Beanstalk Amazon SQS AWS ECS AWS EKS Google Cloud Platform Oracle Cloud Infrastructure Oracle Autonomous Database OpenStack ERP Oracle EBS SAP Server, SAP CCMS Microsoft Dynamics CRM / 365 (On-Premise) Microsoft Dynamics AX SAP Business OneServers Windows Linux IBM i Services JMX Applications Ceph Monitor Hadoop Monitor Apache Zookeeper Active Directory Istio Network Policy Server (Radius Server) Mail Servers Exchange Server Java / Transactions APM Insight Middleware / Portal IBM WebSphere MQ IBM Websphere Message Broker WebLogic Integration Server Microsoft Office SharePoint Server Microsoft Message Queue (MSMQ) Microsoft BizTalk Monitoring Azure Service Bus Apache ActiveMQ Virtualization VMware Horizon View Connection Broker Docker Web Server / Services IIS Server PHP Apache Nginx HAProxy Real Browser Monitoring Webpage Analyzer Real User Monitor ManageEngine ADManager Plus ManageEngine ServiceDesk Plus ManageEngine OpManager Converged Infrastructure Cisco UCS Application Servers GlassfishWhile monitoring Glassfish application servers, make the following changes in the domain.xml file and then restart it: Change the "accept-all" property to "true" for the "jmx-connector" node : JBoss The prerequisites for managing the various versions of JBoss server are: JBoss Version 3.x and 4.x JBoss Version 5.x JBoss Version 6.x JBoss Version 7.x and above (EAP version 6 and above) JBoss Wildfly (WildFly 8 and above) JBoss Version 3.x and 4.x To monitor JBoss, the http-invoker.sar should be deployed in the JBoss Server. The application (http-invoker.sar) is by default deployed in the JBoss server. If the http port of the JBoss server is changed then the port number in the attribute InvokerURLSuffix should also be modified in /server/default/deploy/http-invoker.sar/META-INF/jboss-service.xml file. JBoss Version 5x To monitor JBoss 5.x version, jbossagent.sar should be deployed in JBoss server. To deploy, follow the steps below: Copy jbossagent.sar from location /working/resources and paste under  /server/default/deploy If you are running JBoss in different domain like all, then deployment target folder would be  /server/all/deploy. JBoss Version 6.x Note: JBOSS 6 EAP should be added as JBoss 7 To monitor JBoss 6.x version, jbossagent.sar should be deployed in JBoss server. To deploy, follow the steps below: Copy jbossagent.sar from location /working/resources and paste under  /server/default/deploy If you are running JBoss in different domain like all, then deployment target folder would be  /server/all/deploy. Provide the rmiRegistryPort which is available in  /server/ /conf/bindingservice.beans/META-INF/bindings-jboss- beans.xml file. The default port is 1090. Example: jboss.remoting:service=JMXConnectorServer,protocol=rmi 1090 RMI/JRMP socket for connecting to the JMX MBeanServer JBoss Version 7.x and above To add a new monitor for JBoss Version 7.x and above you must provide a management port. The default port is 9990. JBoss WildflyChange the Management port binding to use the network accessible interface: In the JBoss config file (i.e. \standalone\configuration\standalone-full.xml) change jboss.bind.address.management:127.0.0.1 to jboss.bind.address.management 0.0.0.0 Restart the service Add a JBoss administration user for monitoring: /bin/add-user.bat ManagementRealm -silent Oracle Application Server Applications Manager uses the Dynamic Monitoring Service (DMS) provided by Oracle Application Server to monitor the same. For this reason, the DMS Servlet has to be made accessible to the system where the Applications Manager is running. To enable the access, please follow the instructions provided below [The instructions are referred from the Oracle website: http://docs.oracle.com/cd/B14099_19/core.1012/b14001/monitor.htm] By default, the dms0/AggreSpy URL is redirected and the redirect location is protected, allowing only the localhost (127.0.0.1) to access the AggreSpy Servlet. To view metrics from a system other than the localhost you need to change the DMS configuration for the system that is running the Oracle Application Server that you want to monitor by modifying the file $ORACLE_HOME/Apache/Apache/conf/dms.conf on UNIX, or%ORACLE_HOME%\Apache\Apache\conf\dms.conf on Windows systems. The following example shows a sample default configuration from dms.conf. This configuration limits AggreSpy to access metrics on the localhost (127.0.0.1). The port shown, 7200, may differ on your installation. Example: Sample dms.conf File for localhost Access for DMS Metrics # proxy to DMS AggreSpy Redirect /dms0/AggreSpy http://localhost:7200/dmsoc4j/AggreSpy #DMS VirtualHost for access and logging control Listen 127.0.0.1:7200 OpmnHostPort http://localhost:7200 ServerName 127.0.0.1 By changing the dms.conf configuration to specify the host that provides, or serves DMS metrics, you can allow users on systems other than the localhost to access the DMS metrics from the location http://host:port/dms0/AggreSpy. Caution: Modifying dms.conf has security implications. Only modify this file if you understand the security implications for your site. By exposing metrics to systems other than the localhost, you allow other sites to potentially view critical Oracle Application Server internal status and runtime information. To view metrics from a system other than the localhost (127.0.0.1), do the following: Modify dms.conf by changing the entries with the value for localhost "127.0.0.1" shown in Example to the name of the server providing the metrics (obtain the server name from the ServerName directive in the httpd.conf file, for example tv.us.oracle.com). Find below a sample updated dms.conf that allows access from a system other than the localhost (127.0.0.1) Example: Sample dms.conf File for Remote Host Access for DMS Metrics: # proxy to DMS AggreSpy Redirect /dms0/AggreSpy http://tv.us.oracle.com:7200/dmsoc4j/AggreSpy #DMS VirtualHost for access and logging control Listen tv.us.oracle.com:7200 OpmnHostPort http://tv.us.oracle.com:7200 ServerName tv.us.oracle.com Restart, or stop and start the Oracle HTTP Server using Application Server Control Console or using the Oracle Process Manager and Notification Server opmnctl command. For example, %opmnctl restartproc process-type=HTTP_Server or%opmnctl stopproc process-type=HTTP_Server %opmnctl startproc process-type=HTTP_Server After performing the above steps, please ensure that you are able to access the URL http:// :7200/dmsoc4j/AggreSpy from the Applications Manager system. To check if a user has select privilege: We suggest you to execute the below query directly in your Oracle machine and check if a connected user has select privilege or not : select TABLE_NAME,PRIVILEGE from user_tab_privs_recd where table_name in (''ALL_SCHEDULER_JOB_RUN_DETAILS'',''V_$RMAN_BACKUP_JOB_DETAILS'',''ALL_SCHEDULER_JOBS'',''ALL_SC HEDULER_RUNNING_JOBS''); If there is no row selected or privilege column does not have select value for the above table_name columns, then the user doesn''t have privilege to access the table. To grant Privilege: Use the following query: grant select on to ; Example: grant select on V_$RMAN_BACKUP_JOB_DETAILS to monitoruser; Note: As above, you have to give grant permission on all the tables mentioned in the above query. Tomcat Applications Manager agent has to be deployed in Tomcat Servers 3.x and 4.x. More Tomcat 3.x and 4.x needs no user name and password. In case of Tomcat 5.x and above, an application named Manager must be running in it for Applications Manager to monitor the Tomcat server. By default, this application will be running in the server.If you have customized the manager application (Eg., \qamanager), then you can use the option "Tomcat Manager Application URI" in the client, for Applications Manager to monitor the Tomcat server. For Tomcat Versions 5.x & 6.x and 7.x: The user role to access the server must be manager (versions 5.x & 6.x) / manager-jmx (version 7.x). To add a role as "manager" (versions 5.x & 6.x) / "manager-jmx" (version 7.x) for any of the users such as tomcat, role1, or both, you need make changes in tomcat-users.xml file located in the /conf directory. Example: Default configurations in tomcat-users.xml in Tomcat Server: After adding the roles for the "tomcat" user, the modified entries will be as follows: On making the configuration, restart the Tomcat Server. Now, when adding a new Tomcat (5.x and above) monitor, specify the username/password as tomcat/tomcat when discovering the Tomcat Server. [Click the link to view an example tomcat-users.xml for versions 5.x / 6.x and tomcat-users.xml for versions 7.x] For Tomcat 7 and above: Remote access to Applications Manager is restricted, by default. Include the IP address of Applications Manager-installed host machine in CATALINA_HOME/webapps/manager/META-INF/context.xml file (under ''allow ='' ). Note: 1) After adding the Manager role in tomcat-users.xml, you should be able to access the manager application - : /manager/status (Provide manager user credentials). 2) If the application is not accessible, add the following entry in server.xml, under ''Engine'' context: 3) Restart the server and try to access manager application. 4) By default, GZip compression is disabled for Tomcat. To learn how to enable GZip in Tomcat, refer here. WebLogic Server For monitoring your WebLogic server, the user must have ''Administrator'' privileges. For more information, refer here. Webserver port of Applications Manager-installed machine should be accessible from Weblogic server and the HTTP Port of Weblogic server should be accessible from Applications Manager-installed machine. If listen address is configured in WebLogic server, the same should be provided while adding the monitor. The hostname of WebLogic machine should be resolvable from Applications Manager-installed machine. Add the host details in hosts file of Applications Manager-installed machine. Click on the following topics to know more about the prerequisites for various versions of WebLogic server. To monitor WebLogic 6.1 To monitor WebLogic 7.x To monitor WebLogic 8.x To monitor WebLogic 9.x To monitor WebLogic 10.x, 11g To monitor WebLogic 12.x and above For SSL support over WebLogic To monitor WebLogic 6.1: Follow the steps given below: Provide only Admin user name. In the remote WebLogic server, navigate to /weblogic61/server/lib directory. From there, copy Weblogic.jar to \working\classes\weblogic\version6 directory in the machine where Applications Manager is running. To monitor WebLogic 7.x: You should set the weblogic.disableMBeanAuthorization and weblogic.management.anonymousAdminLookupEnabled variables to true for enabling data collection. Follow the steps given below: Edit startWLS.cmdsh present in the /server/bin directory and add the following arguments -Dweblogic.disableMBeanAuthorization=true -Dweblogic.management.anonymousAdminLookupEnabled=true Click here for Sample startWLS.cmd/shRestart the WebLogic Server for the changes to take effect In the remote WebLogic server, navigate to  /weblogic70/server/lib directory. From there, copy Weblogic.jar to  \working\classes\weblogic\version7 directory in the machine where Applications Manager is running. To monitor WebLogic 8.x: You should set the weblogic.disableMBeanAuthorization and weblogic.management.anonymousAdminLookupEnabled variables to true for enabling data collection. Follow the steps given below: Edit startWLS.cmdsh present in the /server/bin directory and add the following arguments -Dweblogic.disableMBeanAuthorization=true -Dweblogic.management.anonymousAdminLookupEnabled=true Click here for Sample startWLS.cmd/sh Restart the WebLogic Server for the changes to take effect In the remote WebLogic server, navigate to  /weblogic81/server/lib directory. From there, copy Weblogic.jar to  \working\classes\weblogic\version8 directory in the machine where Applications Manager is running. To monitor WebLogic 9.x: In the remote WebLogic server, navigate to  /weblogic92/server/lib directory. From there, copy Weblogic.jar to  \working\classes\weblogic\version9 directory in the machine where Applications Manager is running. To monitor WebLogic 10.x , 11g: In the remote WebLogic server, navigate to  /wlserver/server/lib directory. From there, copy Weblogic.jar, wlclient.jar, wljmsclient.jar, wlthint3client.jar to  \working\classes\weblogic\version10 directory in the machine where Applications Manager is running. To monitor WebLogic 12.x and above: In the remote WebLogic server, navigate to  /wlserver/server/lib directory. From there, copy wlclient.jar and wljmxclient.jar to \working\classes\weblogic\version12 directory in the machine where Applications Manager is running.  Note:  refers to the WebLogic installation directory. After replacing the jar files, Applications Manager has to be restarted. For SSL support over WebLogic: WebLogic certificate has to be imported to /working/jre/lib/security/cacerts file. This certificate can be imported through /bin/WeblogicCertificate.bat/sh files. Syntax: WeblogicCertificate.bat [import] [Full path of weblogic server certificate] [alias name] Example: C:\Program Files\ManageEngine\AppManager\bin> WeblogicCertificate.bat import "C:\Oracle\Middleware\Oracle_Home\user_projects\domains\MyDomain\root.cer" mykey Note: * If customer is monitoring all three versions of weblogic (10.x, 11g, 12C), then get the jars from latest version of WebLogic (Version 12c). * SSL option is enabled in the UI only for version 9 and above. The ports that need to be opened when the Weblogic Monitor is behind the firewall: Two-way communication between WebLogic listening port (default : 7001) and Applications Manager web server port (default : 9090). Sample commands for WebLogic 7.x, 8.x:"%JAVA_HOME%\bin\java" %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% -classpath "%CLASSPATH%" - Dweblogic.Name=%SERVER_NAME% -Dbea.home="C:\WebLogic\WL7.0" - Dweblogic.disableMBeanAuthorization=true - Dweblogic.management.anonymousAdminLookupEnabled=true - Dweblogic.management.username=%WLS_USER% -Dweblogic.management.password=%WLS_PW% - Dweblogic.management.server=%ADMIN_URL% -Dweblogic.ProductionModeEnabled=%STARTMODE% - Djava.security.policy="%WL_HOME%\server\lib\weblogic.policy" weblogic.Server goto finish :runAdmin @echo on "%JAVA_HOME%\bin\java" %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% -classpath "%CLASSPATH%" - Dweblogic.Name=%SERVER_NAME% -Dbea.home="C:\WebLogic\WL7.0" - Dweblogic.disableMBeanAuthorization=true - Dweblogic.management.anonymousAdminLookupEnabled=true - Dweblogic.management.username=%WLS_USER% -Dweblogic.management.password=%WLS_PW% - Dweblogic.ProductionModeEnabled=%STARTMODE% - Djava.security.policy="%WL_HOME%\server\lib\weblogic.policy" weblogic.Server WebSphere Application Server Prerequisites for WebSphere Versions 8.x and below Prerequisites for WebSphere Version 9.x Prerequisites for WebSphere Versions 8.x and below For base deployment: You have to modify the Performance Monitor Interface (PMI) Specification Level from "None" to "Standard". Then deploy the perfServletApp.ear file, which uses the PMI infrastructure to retrieve the performance information from WebSphere Application Server, in the WebSphere. Restart WebSphere Application Server. For Network deployment: You have to modify the PMI Sepcifictaion Level from "None"to "Standard" in all the WebSphere Servers in Network Deployment. Then deploy theperfServletApp.ear file, which uses the PMI infrastructure to retrieve the performance information from WebSphere Application Server, in any one of the WebSphere Servers in the Network Deployment. Restart WebSphere Application Server. Note: Steps to check whether WebSphere monitor has been correctly set To modify PMI specification level: Connect to the Admin console - http:// : /admin/ On the left-side tree, expand the Servers node. Click on Application Servers link. This will display the list of servers running in the node. Click on the server for which data collection has to be enabled. In the Additional Properties table, click on Performance Monitoring Service. Change the Initial specification level to "Standard" and then apply the changes. Also enable (select) Startup. To deploy perfServletApp.ear: Open the Admin console Go to Applications then Application Types, then WebSphere Enterprise Applications. Click Install and select local system. Browse the perf servlet application then click ok. The Default Path is / /installableApps/PerfServletApp.ear Accept all default options and select Next until finish then click Save. After successfully installed this application, restart the node server once in order to work the perf servlet work correctly. Make sure that a WebSphere Admin User is added to the monitor group of the perfservletApp, if global security is enabled in Websphere. To do so, go to WebSphere Admin console → Applications → Installed Applications →Choose perfservletapp → Security role to user group mapping → Choose Monitor Role → Associate the admin user → Save directly to the master configuration. To check the perf servlet output, open the following url from your browser: http://localhost: /wasPerfTool/servlet/perfservlet?connector=SOAP&port=8880 - 9080 (Default) Steps to Check whether Websphere monitor has been correctly set For Base Deployment: To ensure whether the PMI & perfServletApp are configured properly in WebSphere, invoke the below URL & check whether the data is returned in XML format. http://WebSphereHost:Port/wasPerfTool/servlet/perfservlet?connector=SOAP&port=SOAP-PORT where WebSphere Host - Host in which WebSphere Application Server is running WebSphere Port - HTTP Transport port of the WebSphere Application server [How to locate HTTP Port] SOAP Port - SOAP Port of WebSphere [How to locate SOAP Port] For Network Deployment: To ensure whether the PMI & perfServletApp are configured properly in WebSphere, invoke the below URL & check whether the data is returned in XML format. http://WebSphereHost:Port/wasPerfTool/servlet/perfservlet?connector=SOAP&port=NetworkDeployerSOAP- PORT&HOST=NetworkDeployerHost where WebSphere Host - The host of the websphere application server in which the perf servlet application is installed Websphere Port - HTTP Transport port of the Websphere server in which the perf servlet application is installed [How to locate HTTP Port] NetworkDeployer SOAP PORT - The SOAP port of the Deployment manager (DMGR) [How to locate SOAP Port] Network Deployer Host - The host in which the Deployment manager is running. Note: Also check whether WebSphere admin user is added to the monitor group of the perfservletApp. How to locate SOAP Port? 1. Login to Admin console 2. Expand the server link on left side tree. Click on Application Servers 3. In Base mode, various WebSpheres will be listed down. Click on the WebSphere''s name- > Under Additional Properties, click on End Points link -> click on SOAP connector address. You can get the SOAP port from there. 4. In Network Deployment mode, Click DMGR - > Under Additional Properties, click on End Points link -> click on SOAP connector address - You can get the SOAP port from there. How to find the HTTP Transport port? 1. Login to Admin console 2. Expand the Server link on left side tree, Click on Application Servers 3. Various WebSpheres will be listed down. Click on the WebSphere''s name- > Under Additional Properties, click on Web Container link -> click on HTTP Transports link. You can get the HTTP port from there. Prerequisites for WebSphere Versions 9: Enable Performance Monitoring Infrastructure (PMI) in application server (for base mode), and in all application servers and the node agents ( in ND mode ) which you want to monitor. Go to Websphere Console, then Servers and All servers. Click on the server name, then "Performance Monitoring Infrastructure (PMI)" under "Performance" tab. Check the box "Enable Performance Monitoring Infrastructure". Click Apply, Save and Restart the server. If global security is enabled, provide username and password of user with adminitrative role. Go to the Websphere Console, System Administration then Node agents Click on the node agent, then "Performance Monitoring Infrastructure (PMI)". Check the box "Enable Performance Monitoring Infrastructure".Click Apply, Save and Restart the server. For Network deployment mode, enable Global security Go to the Websphere Console, go to Security then Global Security. Under "Administrative security", check "Enable administrative security". Click Apply, Save and Restart the server. SSL certificates has to be added to APM incase SSL is enabled or Global security is enabled. Steps: https://pitstop.manageengine.com/portal/kb/articles/how-to-import-certificates-for-monitoring- websphere-application-server-with-ssl-authentication Resin Server JMX MBeans are used to monitor Resin Application server''s activity. To enable JMX, open Resin.XML and add the below JVM arguments or start Resin.exe with the below JVM arguments -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false Replace 1099 with the actual port number of the JMX agent Jetty Server JMX MBeans are used to monitor Jetty server''s performance. To enable JMX, Add the below JVM arguments on Jetty start up: -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote Replace 9999 with the actual port number of the JMX agent Add the following line in start.ini file --module=jmx Apache Geronimo To monitor Apache Geronimo Server, add the following java runtime options to the startup file of your application: -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1999 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false Replace 1999 with the any free port available. You can find the startup file here : /bin Database Servers IBM Informix ServerJDBC Driver: To monitor IBM Informix DB, make sure that the ifxjdbc.jar file is present in the location: \working\classes directory. The jar file can be copied from the IBM Informix installation location, \jdbc\lib\jar. Restart Applications Manager after copying the file. User Privileges: To add an Informix DB monitor, a user requires Connect database-level privileges and he should be able to access sysmaster database. Microsoft SQL Database Server For monitoring a Microsoft SQL database server, the SQL user account used for monitoring should have access to MASTER, MSDB and DISTRIBUTION databases. User should have the following roles: sysadmin server role : Go to SQL Server Management Studio → Go to Logins → Choose the respective user and open properties → Go to ''Server roles'' and select sysadmin role → Save the option and proceed with adding the SQL monitor in Applications Manager. (OR) 1. Provide VIEW SERVER STATE permission on the server to the respective SQL user. To grant VIEW SERVER STATE, you can use any of the following methods : i) Execute the following query: GRANT VIEW SERVER STATE TO username; ii) In SQL Management Studio for user Choose Properties → Securables → Click Add ( under Securables ) → Choose ''All objects of the Types...'' → Choose Servers → Choose Grant for ''View server state'' permission. 2. Provide the following DB roles: DB Role required for all databases: public, db_datareader (To see key metrics in all databases) DB Role required for msdb database: public, db_datareader, SQLAgentReaderRole, SQLAgentOperatorRole (For SQL Jobs monitoring/Log Shipping monitoring/Replication monitoring) DB Role required for distribution database: public, db_datareader (For SQL Replication monitoring) DB role required for monitoring DBCC CHECKDB & DBCC DBREINDEX/INDEXDEFRAG commands: db_writer To monitor AlwaysOn Availability Groups in Applications Manager, the admin must provide view any definition permission on the server to the respective SQL user. To do so, you can use any of the following methods: (i) Execute the following query: GRANT VIEW ANY DEFINITION TO username; (ii) In SQL Management Studio, for user, choose Properties → Securables → click Add ( under Securables ) → choose ''All objects of the Types...'' → Choose Servers → Choose Grant for ''view any definition'' permission. MongoDB Servers Supported Versions: MongoDB 4.2 and older versions. We support mongod services and mongos services If the MongoDB instance is authenticated, the User should have ''clusterMonitor'' role to fetch performance metrics of MongoDB. To monitor OpLog details, add the Mongo client (mongo.exe/mongo) file under /working/classes directory. For Linux installation, execute the command : sudo apt install mongodb- clients and grant executable permission to the Mongo client using CHMOD command. To download the mongo client, click on any of the following links for respective operating systems: Older versions of Windows from 2008 to 8 Windows 10 Ubuntu 16.04 Ubuntu 18.04 For other operating systems, refer here. Note: MongoDB of versions 3.4 & above is not supported in 32-bit Windows and Linux OS.MySQL Database Servers MySQL monitor requires MySQL Java Connector to be present in the Applications Manager classpath. You can verify this by following these steps: Check /working/mysql/MMMySQLDriver/ directory for the file mysql_connector.jar If the .jar file is not present, you can download it from here (for MYSQL versions older than 5.6) or here(for MYSQL version 5.6 and newer). If you are using multiple MySQL servers with various versions, then you must download the new jar file. Note: If any MySQL server is enabled with ''SSL Configuration'' or MySQL server is hosted on any cloud platform, then please use the latest mysql_connector jar file. Extract the downloaded zip file. Find mysql-connector-java-3.0.10-stable-bin.jar or mysql-connector-java-5.1.46.jar file and rename the file as mysql_connector.jar In the machine, where Applications Manager is running, copy the downloaded mysql_connector.jar to /working/mysql/MMMySQLDriver/ directory. Restart Applications Manager. Privileges Required : While monitoring a MySQL database server, ensure that you assign a username that has permission to access the MySQL database from the host where Applications Manager is running. An alternate way is to add a relevant user who has the privileges to do the same. The user should have privileges to execute SELECT, SHOW DATABASES, REPLICATION commands in the MySQL server. For enabling these privileges, execute the following commands in the remote MySQL Server: If MySQL version is below 5.7: To create a new user in mysql database: USE mysql; INSERT INTO user (Host,User) VALUES('' '','' ''); Granting privileges required for DB-user to monitor MySQL DB-sever: GRANT SELECT,SHOW DATABASES,REPLICATION CLIENT,REPLICATION SLAVE ON *.* TO '' ''@'' ''; FLUSH PRIVILEGES; (Use the host name - Applications Manager machine). If MySQL version is 5.7: To create a new user in mysql database: USE mysql; CREATE USER @''%'' IDENTIFIED BY ''password''; Granting privileges required for DB-user to monitor MySQL DB-sever: GRANT SELECT,SHOW DATABASES,REPLICATION CLIENT,REPLICATION SLAVE ON *.* TO '' ''@'' ''; FLUSH PRIVILEGES; (Use the host name - Applications Manager machine). If MySQL version is 8.0 and above: To create a new user in mysql database: USE mysql; CREATE USER '' ''@'' '' IDENTIFIED WITH mysql_native_password BY ''password''; Granting privileges required for DB-user to monitor MySQL DB-sever:GRANT SELECT,SHOW DATABASES,REPLICATION CLIENT,REPLICATION SLAVE ON *.* TO '' ''@'' ''; FLUSH PRIVILEGES; (Use the host name - Applications Manager machine). For MariaDB: GRANT SELECT,SHOW DATABASES,REPLICATION SLAVE ADMIN,REPLICATION MASTER ADMIN ON *.* TO '' ''@'' ''; FLUSH PRIVILEGES; (Use the host name - Applications Manager machine) Prerequisites for MySQL SSL sever monitoring: User account requires tls_option. ALTER USER '' ''@'' '' REQUIRE ; [ tls_option: { SSL | X509 | CIPHER ''cipher'' | ISSUER ''issuer'' | SUBJECT ''subject'' } ] Add the client certificates and its root certificates in apm.keytore file under /working/cert/ directory. Add the monitor by enabling ''SSL'' option in Add New Monitor page. If the monitor is already added, update the ''SSL'' option in Edit Monitor page. Oracle Database Servers A user with CONNECT and SELECT_CATALOG_ROLE roles are required for Oracle monitoring in Applications Manager. Configure a user with these permissions and use the credentials in Applications Manager Prerequisites for monitoring Oracle Alert Log metrics Login as SYS user and run the following queries: Create or replace view v_$appman_alertlog_ext as select * from x$dbgalertext Create or replace public synonym v$appman_alertlog_ext for sys.v_$appman_alertlog_ext Grant select on v$appman_alertlog_ext to [USERUSEDFORORACLEDBSERVERMONITOR] For Oracle versions 12c & above: Create or replace view appman_alertlog_vw as select * from x$dbgalertext Create or replace public synonym appman_alertlog_view for sys.appman_alertlog_vw Grant select on appman_alertlog_view to [USERUSEDFORORACLEDBSERVERMONITOR] Note: Oracle DB Alert Log monitoring is supported for version Oracle 11g and above only. Prerequisites for monitoring Oracle Redo Log metrics Login as SYS user and run the following queries: Create or replace view v_$appman_redolog_cp_ext as select * from x$kcccp Create or replace public synonym v$appman_redolog_cp_ext for sys.v_$appman_redolog_cp_ext Grant select on v$appman_redolog_cp_ext to [USERUSEDFORORACLEDBSERVERMONITOR] Create or replace view v_$appman_redolog_le_ext as select * from x$kccle Create or replace public synonym v$appman_redolog_le_ext for sys.v_$appman_redolog_le_ext Grant select on v$appman_redolog_le_ext to [USERUSEDFORORACLEDBSERVERMONITOR] For Oracle versions 12c & above: Create or replace view appman_redolog_cp_vw as select * from x$kcccp Create or replace public synonym appman_redolog_cp_view for sys.appman_redolog_cp_vw Grant select on appman_redolog_cp_view to [USERUSEDFORORACLEDBSERVERMONITOR] Create or replace view appman_redolog_le_vw as select * from x$kccle Create or replace public synonym appman_redolog_le_view for sys.appman_redolog_le_vw Grant select on appman_redolog_le_view to [USERUSEDFORORACLEDBSERVERMONITOR]Prerequisites for monitoring Oracle Data Guard metrics Following are the prerequisites to monitor Oracle Data Guard metrics under RPO tab: Database Role should be either PRIMARY or PHYSICAL STANDBY or LOGICAL STANDBY. For PRIMARY database role, the Switch Over Status should not be as NOT ALLOWED. The Database Role and Switch Over Status can be found by executing the following query: SELECT database_role,switchover_status FROM v$database Prerequisites for monitoring Oracle Pluggable Database (PDB) metrics SYS or SYSTEM or Common user with CONNECT and SELECT_CATALOG_ROLE roles is required to monitor Oracle PDBs. If Common user is chosen for monitoring, then the below privilege has to be provided by connecting to the CDB container with SYS user: alter user set container_data=all container = current; For example, alter user C##APM set container_data=all container = current; The C##APM user has now been given the SELECT role privilege to access all the objects. PostgreSQL If PostgreSQL is in remote server, it should allow connections from Applications Manager server. For this follow the steps given below: Allowing remote connection from Applications Manager in PostgreSQL Open postgresql.conf file under /data Check value of configuration parameter listen_addresses.If it is using the default value localhost, it must be changed to TCP/IP address(es) on which the PostgreSQL has to listen for connections from Applications Manager. You can change it to *(corresponds to all available IP interfaces) like below: listen_addresses = ''*'' Click here for more details on configuring postgresql.conf file. Open pg_hba.conf file under /data Add the following new line to allow all PostgreSQL user remote connections from Applications Manager server: host all all 0.0.0.0/0 md5 host all all ::0/0 md5 Click here for more details on configuring pg_hba.conf file. User privileges required Applications Manager uses PostgreSQL''s subsystem statistics collector & some built-in views such as pg_class, pg_database, pg_indexes, pg_locks, pg_namespace, pg_proc, pg_replication_slots, pg_stat_statements, pg_tables, pg_trigger, pg_user to monitor PostgreSQL server activity. The user provided for monitoring should have at least read-only access to statistics collector and above mentioned views. For PostgreSQL versions below 10: Create a user with following privileges: CREATE USER WITH PASSWORD '' ''; GRANT SELECT ON pg_stat_database TO To monitor replication metrics, the database user is required to have Replication privilege (if replication is configured). Execute the below query to update the DB user with Replicationprivilege: ALTER USER WITH Replication; To list out configuration-related metrics & WAL file count, the database user is required to have Superuser privilege. Execute the below query to update the DB user with Superuserprivilege: (optional) ALTER USER WITH Superuser; For PostgreSQL versions 10 and above: To monitor all the metrics, execute the following query:CREATE ROLE WITH LOGIN NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT REPLICATION CONNECTION LIMIT -1 PASSWORD ''xxxxxx''; GRANT pg_monitor TO ; GRANT EXECUTE ON FUNCTION pg_ls_dir(text) TO ; Extensions to be enabled in PostgreSQL server: To monitor top queries by CPU, include the below lines in postgresql.conf file: shared_preload_libraries = ''pg_stat_statements'' pg_stat_statements.track = all Then execute the below query in PostgreSQL: CREATE EXTENSION pg_stat_statements; After implementing the above steps, restart the PostgreSQL server. Note: After implementing the above steps, a restart of the PostgreSQL server is required for the changes to take effect. Limitations in PostgreSQL Replication monitoring: Replication is not monitored for PostgreSQL server version 9.0 & 9.1. Master server and slave server should be on different machines. More than one slave shouldn''t run on same machine. Connections to any server (i.e either master or slave) via Unix socket cannot be monitored. SAP ASE / Sybase SQL Server / Sybase ASE Supported Versions: Applications Manager supports monitoring of Sybase ASE 12.5.3 and above. To monitor a Sybase ASE database monitor, the minimum privileges required by the user are as follows: There are select privileges for few tables in master database. They are: master.dbo.systransactions master.dbo.spt_values master.dbo.sysprocesses master.dbo.sysdatabases master.dbo.syslogins master.dbo.monProcessStatement master.dbo.monProcessSQLText master.dbo.monOpenDatabases User with mon_role, to execute a system procedure named as "sp_monitorconfig" To provide the privileges mentioned above, use the following commands in Sybase ASE database: exec sp_role ''grant'', ''mon_role'', ; (login-name assigned to the user) grant select on master.dbo.systransactions to ; grant select on master.dbo.spt_values to ; grant select on master.dbo.sysprocesses to ; grant select on master.dbo.sysdatabases to ; grant select on master.dbo.syslogins to ; exec sp_configure ''enable monitoring'', 1 exec sp_configure ''statement statistics active'', 1 exec sp_configure ''per object statistics active'', 1 Note: Execute the above commands in the Sybase SQL shell.SAP HANA Copy the ngdbc.jar file into the location /working/classes. ngdbc.jar can be copied from installed SAP HANA Client folder. Click here to download SAP HANA Client If HANA is running On-demand, in addition to the above, SAP Cloud Platform SDK is needed. However, this is not needed for HANA On-premise. Click here to download SAP Cloud Platform SDK. The downloaded zip should be extracted under /working/hanacloud folder. After extracting, verify whether /working/hanacloud/tools folder is available. Restart Applications Manager after performing the above steps. Provide the below privileges for SAP HANA DB User. System privilege CATALOG READ. Object privilege SELECT on the schema _SYS_STATISTICS. To grant the above privileges, execute the below statements in SAP HANA SQL console.(Replace USER_NAME with actual HANA DB Username) GRANT MONITORING to < USER_NAME > CALL GRANT_ACTIVATED_ROLE (''sap.hana.admin.roles:Monitoring'',''< USER_NAME >'') SAP MaxDB Following are the prerequisites to be implemented to monitor SAP MaxDB in Applications Manager: X-Server should be running. sapdbc.jar file should be copied to \working\classes folder. By default, this jar will be available in SAP MaxDB installation folder under \runtime\jar\ directory. SQL Anywhere Applications Manager supports the monitoring of SQL Anywhere from version 17. We use system procedures for monitoring the SQL Anywhere server. To monitor SQL Anywhere server, the DB user must have the following privileges: Privilege to manage any DBspace. Any one of the following roles: Monitor or Server Operator or Drop connection To know more about system privileges, click here. Note: Only databases that can be accessed with the given user credentials will be monitored. IBM DB2 A DB2 user with SYSMON instance level authority is required for monitoring DB2 server. Long Running Queries (Available from version 9.7 & above): To monitor ''Long Running Queries'', the user must have the following authorization: SELECT privilege on the MON_CURRENT_SQL administrative view Session details (Available from version 9.7 & above): To monitor ''Session details'', the user must have any one of the following authorizations: Execute privilege on the routine ''SYSPROC.MON_GET_CONNECTION'' Minimum User Privileges: For monitoring IBM DB2 v.8 and v.9, the user should be able to access the SYSPROC procedures. For monitoring IBM DB2 v.10 & above, the user should be able to access the SYSIBMADM functions and SYSPROC procedures. Granting a privilege to user: Login to DB2 command line processor and execute below statement:GRANT ON DATABASE TO USER where, can be any one of the following: CONNECT, LOAD To learn how to grant a privilege to a user, refer here. CLOUD APPS Microsoft Azure Microsoft Azure Monitor can be added using 3 methods, AD Application & Service Principal – Mode 1 Azure Organizational Account (Powershell) – Mode 2 OAuth mode – Mode 3 Discovery using AD Application & Service Principal – Mode 1 For Microsoft documentation, refer https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource- group-create-service-principal-portal 1. Create Active Directory Application: Log in to Azure Portal (https://portal.azure.com) using the credentials of Microsoft account (@outlook.com or @live.com) using which the subscription was created. Select Azure Active Directory. Select App registrations. Select New registration. After entering relevant details, click Register. 2. Getting Tenant ID, Client ID and Client Secret(Application Key): Tenant ID: Select Azure Active Directory. From App registrations in Azure AD, select your application. Copy the value given as Directory (tenant) ID. This is your Tenant ID. Client ID: Select Azure Active Directory. From App registrations in Azure AD, select your application. Copy the value given as Application (client) ID. This is your Client ID. Client Secret(Application Key): Select Azure Active Directory. From App registrations in Azure AD, select your application. Select Certificates & secrets. Select Client secrets -> New client secret. Provide a description of the secret, and a duration. (Preferrably 24 months) select Add. Credential will be updated for the same AD Application and copy the new Client Secret Value and this is the Client Secret(Application Key). To know more about creating the Client Secret, refer here. 3. Assign a role to the application: Select Subscriptions from he home page. Select the particular subscription to assign the application to.Select Access control (IAM). Select Add > Add role assignment to open the Add role assignment page. Select the role you wish to assign to the application. Select the role as Owner or Contributor and click Next. Select User, group, or service principal in Assign access to option. In Members option, click on Select Members and search for the name of your application and select it. Select Review + Assign to finish assigning the role. To know more about assigning a role to the application, refer here. 4. Provide the Client ID, Tenant ID and Application Key(Client Secret) in the Azure new monitor page of Applications Manager. Discovery using Azure Organizational Account (Powershell) – Mode 2 1. Installing the Powershell module on Applications Manager server: For Applications Manager versions 15170 onwards, you must install the Az Powershell module. To install the Az Powershell module, follow the below steps: Open Powershell prompt with Administrator privileges. Run the following commands: # Install the Az module from the PowerShell Gallery Install-Module -Name Az -RequiredVersion 6.2.1 To check if the modules are installed successfully: Open Powershell prompt with Administrator privileges. Run the following command, Connect-AzAccount If this opens a pop-up asking for Azure credentials, this means the required modules are installed successfully. For further troubleshooting regarding installing the module, refer https://docs.microsoft.com/en- us/powershell/azure/install-az-ps?view=azps-6.2.1 Note: If you already have the AzureRM Powershell installed, you will have to uninstall it before you install the Az Powershell module using the below command: Uninstall-AzureRm If you face any problems, kindly refer this link. For Applications Manager versions till 15160, you must install the AzureRM Powershell module. To install the AzureRM Powershell module, follow the below steps: Open Powershell prompt with Administrator privileges. Run the following commands: # Install the Azure Resource Manager modules from the PowerShell Gallery Install-Module AzureRM In case if you get the following error upon executing the above command, then install the downloader from http://aka.ms/webpi-azps Install-Module: The term ‘Install-Module’ is not recognized as the name of a cmdlet, function, script file or operable program To check if the modules are installed successfully: Open Powershell prompt with Administrator privileges. Run the following command, Login-AzureRmAccount If this opens a pop-up asking for Azure credentials, this means the required modules are installed successfully. 2. Create an Organizational account using Microsoft Azure administrator permissionsLog in to Azure Portal (https://portal.azure.com/) using the credentials of Microsoft account (@outlook.com or @live.com) using which the subscription was created. Select Active Directory. Select the default directory Select Users, and then select New user. On the User page, enter required information for this user - Username, First name, Last name, Groups, and Role. Note down the Email ID and the password of your user (Autogenerated in the Password box after entering the above details). Select Create. 3. Assign the Global administrator role to your organizational account Log in to Azure Portal (https://portal.azure.com/). Search for and select Active Directory. Select Users. Select the user for which Global administrator role needs to be assigned. On the User Profile page, select Assigned Roles and then click on Add assignment. Search for and select the role Global administrator. After selecting the role, click on Add button. The Global administrator role will be assigned to the required user. After performing all the above steps, Sign out of the current account. Sign in using the newly created Email address and temporary password You will be prompted to change the password, when logging in for the first time Change and note down the new password Provide this Email ID to ‘User Email’ field and Password to ‘Password’ field in the New monitor page, while using the mode ‘Azure Organizational Account (Powershell) of Applications Manager. OAuth mode – Mode 3 For Microsoft documentation, refer https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource- group-create-service-principal-portal1. Create Active Directory Application: Log in to Azure Portal (https://portal.azure.com) using the credentials of Microsoft account (@outlook.com or @live.com) using which the subscription was created. Select Azure Active Directory. Select App registrations. Select New registration. After entering relevant details, click Register. 2. Getting Tenant ID, Client ID and Client Secret: Tenant ID: Select Azure Active Directory. From App registrations in Azure AD, select your application. Copy the value given as Directory (tenant) ID. This is your Tenant ID. Client ID: Select Azure Active Directory. From App registrations in Azure AD, select your application. Copy the value given as Application (client) ID. This is your Client ID. Client Secret: Select Azure Active Directory. From App registrations in Azure AD, select your application. Select Certificates & secrets. Select Client secrets -> New client secret. Provide a description of the secret, and a duration. (Preferrably 24 months) select Add. Credential will be updated for the same AD Application and copy the new Client Secret Value and this is the Client Secret. To know more about creating the Client Secret, refer here. 3. Assign a role to the application: Select Subscriptions from he home page. Select the particular subscription to assign the application to. Select Access control (IAM). Select Add > Add role assignment to open the Add role assignment page. Select the role you wish to assign to the application. Select the role as Owner or Contributor and click Next. Select User, group, or service principal in Assign access to option. In Members option, click on Select Members and search for the name of your application and select it. Select Review + Assign to finish assigning the role. To know more about assigning a role to the application, refer here. 4. Provide the Client ID, Tenant ID and Client Secret in the Azure new monitor page of Applications Manager. 4. App Registration Permissions Select your created application under Azure Active Directory → App Registration. In the application''s Overview page, click on ''API Permissions'' available on the left pane. Click on ''Add a Permission'' option, select ''Azure Service Management'' and choose ''Delegated Permissions''. Select the ''user_impersonation'' permission and then click on ''Add Permissions''. Finally, click on ''Grant admin consent for APM'' button.Steps to create an OAuth Provider for Azure monitor: In Applications Manager, go to Settings → OAuth Provider and select Add OAuth Provider. (Make sure you are logged in from a fully qualified domain name as in the help card) Copy the Redirect URL from the Add OAuth Provider window. In the Microsoft Azure console, go to Azure Active Directory from the left pane, select App Registrations and click on the required application. In the application''s Overview page, click on the link available under Redirect URIs and paste the Redirect URL copied from the Add OAuth Provider window. Click Save. Now copy the App ID, Client Secret and Tenant ID obtained in the above steps and fill in the Add OAuth Provider window. Fill the required details as mentioned below: Grant Type - Authorization Code Authorization Endpoint URL - https://login.microsoftonline.com/ /oauth2/authorize Token endpoint URL - https://login.microsoftonline.com/ /oauth2/token Token request method - Post request body Request body:     Name - resource     Value - https://management.azure.com/ Authenticated request method - Basic Authentication Note: Remaining fields should remain as default. Click Authorize button and authorize using the account to login to Azure. Once created, verify whether both Access token and Refresh token are generated. Use this OAuth Provider in the Microsoft Azure''s New Monitor page. Azure Virtual Machines Enabling Diagnostic Extension for Windows and Linux VMs Enabling Guest OS monitoring Enabling Diagnostics Extension for Windows & Linux VMs Steps to Enable Diagnostics Extension for Windows VMs: Log in to Azure Portal (https://portal.azure.com) using the credentials of ''Administrator'' Navigate to your virtual machine. Click on ''Diagnostics settings'' on the vertical pane. Select ''Agent'' tab and click on ''Remove'' at the bottom, as shown in the below image. Under ''Overview'' tab, click on ''Enable guest level monitoring'' and click Save as shown in the image below.In Performance counters tab, all the Basic metrics are chosen by default, and the metrics monitored in Applications Manager are included in it. If the user wants to enable diagnostics only for the monitored metrics, select Custom and select the below-listed metrics and click Save. Metric Name in Azure Portal Metric Name in Applications Manager \\Processor Information(_Total)\\% User Time User Time \\Processor Information(_Total)\\% Privileged Time Privileged Time \\Processor Information(_Total)\\Processor Frequency Processor Frequency \\System\\Processes Process Count \\System\\Context Switches/sec Context Switches/sec \\Process(_Total)\\Thread Count Thread Count \\Process(_Total)\\Handle Count Handle Count \\Memory\\Committed Bytes Committed Bytes \\Memory\\Available Bytes Available Bytes \\Memory\\% Committed Bytes In Use Committed Bytes In Use \\Memory\\Page Faults/sec Page Faults/sec \\Memory\\Pool Paged Bytes Pool Paged Bytes \\Memory\\Pool Nonpaged Bytes Pool Nonpaged Bytes Restart the VM Steps to Enable Diagnostics Extension for Linux VMs: Log in to Azure Portal(https://portal.azure.com) using the credentials of ''Administrator'' Navigate to your virtual machine. Click on ''Diagnostics settings'' on the vertical pane under ''Monitoring''. To uninstall the old diagnostic agent and reinstall again, go to ''Agent'' and click ''Remove'' to remove the current diagnostic agent. On the same page, now choose a storage account from the dropdown and then click ''Enable guest-level monitoring'' to enable the VM diagnostic. To reduce the amount of data stored in Storage Account tables, configure only the required diagnostics instead of all. Once the diagnostic settings are updated successfully, in the same pane, click ''Metrics'' and then click ''Custom'' and remove the unwanted metrics. Refer to the below image to view the required metrics and their configuration.Also, set the aggregation intervals to 1 minute (Choose only ''PT1M'' and remove other intervals like ''PT1H'', ''PT5M'', etc.) and finally click ''Save'' to save the configuration. Note: In Applications Manager, we retrieve the VM diagnostics only from the PT1M tables. Configuring only the required metrics and setting the aggregation to 1 minute is mainly to reduce your Azure Storage cost by avoiding unwanted storage. In addition, it removes the old tables from the configured Storage Account to minimize the Storage cost.   Metric Name in Azure Portal Metric Name in Applications Manager /builtin/disk/averagereadtime Average Read Time /builtin/disk/averagewritetime Average Write Time /builtin/memory/availablememory Available Memory (MB) /builtin/memory/percentusedswap Used Swap memory (%) /builtin/memory/usedmemory Used Memory (MB) /builtin/memory/percentavailablememory Available Memory (%) /builtin/processor/percentidletime Idle Time /builtin/processor/percentiowaittime IO Wait Time /builtin/processor/percentprocessortime Processor Time(Linux) To check whether the diagnostic agent is working properly by storing the diagnostic metrics in the configured Storage Account: In the Azure portal, go to Virtual Machine and click ''Metrics'' under ''Monitoring'' in the left pane. Make sure the ''Scope'' is pointing to the respective Virtual Machine and choose ''Guest (Classic)'' in ''Metric Namespace'' dropdown. Choose any one metric, let us check by choosing ''CPU idle time'' in ''Metric'' dropdown and check the data points for the current timestamp as below:   GENERAL BEHAVIOUR Under the tab ‘Disk’, below ‘Disk spacing’ section, the disk size will be shown as 0, if disk size is not configured for the virtual machine in portal. To set disk size in portal, refer https://blogs.msdn.microsoft.com/madan/2016/09/28/resize-azure-resource- manager-arm-vm-os-data-disk-using-azure-portal/ Note: In case if you change the resource group of any Virtual machine in Azure portal, then provide the updated details (Virtual Machine ResourceID and Resource Group Name) in the Edit monitor page of that Virtual machine in Applications Manager for data collection to happen. Enabling Guest OS monitoring: Metrics monitored when Guest OS monitoring is enabled Disk UtilizationDisk IO Statistics Network Interface Service Monitoring Note: Guest OS metrics will be available only in Windows installations of Applications Manager for Windows VMs alone. 1. Perform the below steps in Azure Portal. Log in to Azure Portal. Open Azure Cloud Shell. Execute the following command Enable-AzVMPSRemoting -Name ''vm-hostname'' -ResourceGroupName ''vm-resourcegroupname'' -Protocol https -OsType Windows Where you need to replace ''vm-hostname'' and ''vm-resourcegroupname'' with the Name and Resource group name of the VM for which the Guest OS metrics need to be monitored. This enables PowerShell remoting for the respective VM with HTTPS protocol. To know more, click here. 2. Run Applications Manager with administrator privilege. 3. Perform the below steps in Applications Manager Server to enable Powershell Remoting (To collect metrics by remoting into Azure VMs). Open Powershell prompt with Administrator privileges. Execute the following commands: Set-ExecutionPolicy Unrestricted If the above cmdlet produces an Error as below, you can configure Powershell Script Execution via Group Policy Editor: #To configure Windows PowerShell for remoting, type the following command: Enable-PSRemoting -force #To configure the TrustedHosts setting to ensure that appmanager can trust the connections from other servers : Set-Item wsman:\localhost\client\trustedhosts * #To increase the maximum number of concurrent shells that a user can remotely open: Set-Item WSMan:\localhost\Shell\MaxShellsPerUser -value 25 -WarningAction SilentlyContinue #To set idle timeout value for sessions : Determines how long the session stays open if the remote computer does not receive any communication from the local computer, including the heartbeat signal. When the interval expires, the session closes: Set-Item WSMan:\localhost\Shell\IdleTimeout -value 60000 -WarningAction SilentlyContinue #Restart the WinRM service for changes to take effect: Restart-Service WinRM Configure Powershell Script Execution via Group Policy Editor Open the Group Policy Editor from Control Panel→ Edit Group Policy (or) run gpedit.msc from Start menu. To configure, navigate under Computer Configuration to Policies\Administrative Templates\Windows Components\Windows PowerShell. You should see a setting called Turn on Script Execution like in the following image:Double-click the setting. You will want to enable it and select an option from the drop down. Set it to “Allow All Scripts”. Click Apply and OK. Microsoft Azure SQL Database Following are the prerequisites to monitor Database Query Statistics in Azure SQL Database monitor: Firewall rule configuration in portal: In Azure portal, navigate to the Azure SQL database to be monitored -> Click on Overview -> Select Set Server Firewall -> Add your Client IPs to the list. Client should add all his public IPs under the firewall settings in SQL server. Refer link for setting server firewallAllowing outgoing access on port 1433: For Applications manager to access and monitor the Azure SQL database, ensure that the firewall on your network and Applications Manager installed server allows outgoing communication on TCP port 1433. Azure Kubernetes Service (AKS) Install AzureCLI: Install the Azure CLI on any Applications Manager-installed machine (Windows or Linux) to configure cluster with kubectl for monitoring. Learn more Install Kubectl: Install the latest Kubectl utility executable (kubectl.exe) file by executing the following command in command prompt: az aks install-cli --client-version [client-version] where, [client-version] refers to the compatible client-version to be installed. If kubectl is already installed, make sure to find out the version of the kubcetl using the command kubectl version --short --clientin command prompt. If the version is incompatible, then install the latest version as stated above in Step 2. Note: Choose the supported kubectl version for your AKS cluster by using one minor version older or newer of kubectl relative to your cluster''s Kubernetes version (kube-apiserver), consistent with the Kubernetes support policy for kubectl. The cluster''s Kubernetes version can be found in the Azure portal itself. Alternatively, you can add kubectl to the system environment path by adding the kubectl installed directory in system path under Environment Variables → System → Path. However, you can ignore this step either if you have already specified your kubectl installed directory in system path of environment variable or have installed kubectl under \workingdirectory in Windows. Note: Make sure to restart Applications Manager after configuring the environmental variable to run kubectl commands. Configure Container Insights: To fetch metrics from Container Insights, you can do so using the az aks addoncommands. Execute the following command to enable/disable Container Insights: To enable Container Insights: az aks addon enable To disable Container Insights: az aks addon disable Enable Cluster Autoscaler: To fetch Cluster Autoscaler metrics, you need to enable and configure the cluster autoscaler on the node pool of the AKS cluster. You can enable the cluster autoscaler either while creating acluster or for an existing cluster via Azure CLI. Learn more Microsoft 365 Prerequisites for adding the monitor Prerequisites for enabling Service Health monitoring Prerequisites for adding the monitor: The Microsoft 365 work or school account that you use for these procedures needs to be a member of an Microsoft 365 admin role. For more information, see About Microsoft 365 admin roles. The Microsoft 365 admin account used for monitoring must be assigned the below roles: Exchange administrator, SharePoint administrator, or Microsoft Teams administrator. Limitation: Accounts with multi factor authentication are not supported. You can use the following 64-bit versions of Windows: Windows 10 Windows 8.1 or Windows 8 Windows Server 2019 Windows Server 2016 Windows Server 2012 R2 or Windows Server 2012 Windows Server 2008 R2 SP1* * You need to have the Microsoft .NET Framework 4.5 or higher version installed and Windows Management Framework 5.1 installed. For more information, see Installing the .NET Framework and download the latest version of Windows Management Framework. You need to use a 64-bit version of Windows because of the requirements for the Microsoft 365 modules. PowerShell version 4 or above. To check the PowerShell version installed, open up a PowerShell prompt and execute the below command: >$PSVersionTable Check for the PSVersion attribute from the output to find out the version. You need to install the following modules to monitor Microsoft 365: Microsoft Online Service Sign-in Assistant for IT Professionals RTW (Needed for Windows Server 2012 & below) Learn more Windows Azure Active Directory Module for Windows PowerShell SharePoint Online Powershell Module Exchange Online PowerShell V2 module (EXO V2 module)(Optional) Note: For huge mailbox data, we prefer the optimized EXO module to connect and fetch data. In that case, enable ''Use Exchange Online Powershell V2 Module'' check-box in Exchange Online Edit Monitor page and install the EXO module for collecting Exchange Online Mailbox statistics. Microsoft Teams PowerShell module: (for Applications Manager versions 15110 & above) Open PowerShell window in Admin mode and execute the below command: Install-Module MicrosoftTeams -RequiredVersion 2.3.1 If error occurs and asks to use -AllowClobber, then execute the below command: Install-Module MicrosoftTeams -RequiredVersion 2.3.1 -AllowClobber Once done, execute the below command to install the Preview version: Install-Module PowerShellGet -Force -AllowClobber Once done, close the PowerShell window. Then open a new window and execute the below command: Install-Module MicrosoftTeams -AllowPrerelease -RequiredVersion "1.1.9-preview"Windows PowerShell needs to be configured to run scripts for data collection. To do this, execute the following command in an elevated Windows PowerShell session (a Windows PowerShell window you open by selecting Run as administrator). To configure Windows PowerShell for remoting, type the following command: Enable-PSRemoting -force Configure the TrustedHosts setting on Applications Manager machine, so that remote computers can trust it: Set-Item wsman:\localhost\client\trustedhosts * Set Execution Policy: Set-ExecutionPolicy Unrestricted Restart the Windows Remote Management (WinRM) so the new settings will take effect: Restart-Service WinRM. Enable TLS 1.2: Using TLS 1.2 with Office Online Server requires strong cryptography in .NET Framework 4.5 or higher. To enable strong cryptography in .NET Framework 4.5 or higher, add the following registry keys: [HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\.NETFramework\\v4.0.30319] "SchUseStrongCrypto"=dword:00000001 [HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\Microsoft\\.NETFramework\\v4.0.30319] "SchUseStrongCrypto"=dword:00000001 To add the above registry keys via cmd prompt: Open command prompt -> Run as administrator : Enter the below : REG ADD HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319 /v SchUseStrongCrypto /t REG_DWORD /d 1 REG ADD HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\v4.0.30319 /v SchUseStrongCrypto /t REG_DWORD /d 1 Prerequisites for enabling Service Health Monitoring Go to https://portal.azure.com/ and login with the Microsoft 365 admin credentials. Go to App Registrations and choose New Registration Enter a name and click Register. In the Overview page of the application, copy the Directory (Tenant) ID and Application (Client) ID Go to API Permissions → choose Add a permission Select Microsoft Graph → Application permissions → ServiceHealth → ServiceHealth.Read.All and click Add permission. Choose Add a permission and select Microsoft Graph → Application permissions → Reports → Reports.Read.All and click Add permission. Now grant Admin access for the tenant. Go to Certificates & Secrets → New Client secret Add a name in Description, select Expires as Never and click Add. Copy the value of that Client Secret. Now paste all the copied values into their respective textboxes in the Add Monitor page and proceed. AWS Monitoring In Applications Manager, we require AWS Access keys [Access key & Secret Access key] to authenticate and retrieve key performance metrics from AWS portal. Click here to know more about access keys. In addition to secret keys, we also require ''List'' and ''Read'' action type Amazon APIs permissions. Furthermore, we require ''Write'' action type APIs permissions for Amazon EC2 actions [Start, Stop, Reboot] actions alone. By default, AWS users with administrator privileges have access to all the AWS Services APIs. If the user wishes to grant admin access privileges, he can provide the admin user access keys to configure AWS monitor. If the user however, wishes to provide limited permissions access keys, then he needs to create a separate policy with the required APIs and attach this policy to an IAM user. This can be done directly or can be attached to the ''Group'' in which the IAM user is associated. Click here to know the steps involved in creating a policy and attaching it to the IAM user. There are two ways to create a policy.In "Create Policy" page: If you choose "Visual Editor" tab, you can refer the columns "Service Name in AWS Portal" and "List of APIs" in the below table, to identify the respective APIs for each AWS Service. In "Create Policy" page: If you choose "JSON" tab, then you can copy & paste the policy content given below to create the policy. List of APIs required for each AWS Service supported in Applications Manager: APM Service List of APIs monitor/Category Name in Name AWS Portal STS AWS monitor (Security GetCallerIdentity authentication/addition Token Service) To collect performance metrics from CloudWatch GetMetricData, GetMetricStatistics CloudWatch Cost Billing statistics Explorer GetCostAndUsage, GetCostForecast Service DynamoDB DynamoDB ListTables, DescribeTable, DescribeLimits, DescribeStream EC2 (Elastic Compute DescribeVolumes, DescribeInstances, DescribeRegions, EC2 Cloud) DescribeInstanceAttribute EC2 Actions (start, stop EC2 StartInstances , StopInstances, RebootInstances & reboot instances) Elastic DescribeEnvironments, DescribeEnvironmentResources, Elastic Beanstalk Beanstalk DescribeEvents EC2 Auto Elastic Beanstalk DescribeAutoScalingGroups Scaling Elastic DescribeClusters, DescribeContainerInstances, DescribeServices, ECS (Elastic Container Container DescribeTasks, ListClusters, ListContainerInstances, ListServices, Service) Service ListTasks ELB (Elastic Load DescribeLoadBalancers, DescribeTargetGroups, ELB v2 Balancing) DescribeTargetHealth Lambda Lambda ListFunctions, GetFunction RDS (Relational RDS DescribeDBInstances, DescribeDBClusters Database Service) S3 (Simple Storage S3 ListAllMyBuckets, ListBucket, GetBucketLocation Service) SQS (Simple Queue SQS ListQueues, GetQueueAttributes Service) SNS (Simple SNS ListTopics, ListSubscriptionsByTopic Notification Service) Elastic EKS (Elastic Kubernetes ListFargateProfiles, DescribeNodegroup, ListNodegroups, Kubernetes Service) DescribeFargateProfile, DescribeCluster, ListClusters Service Policy content in JSON Format: { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "eks:DescribeFargateProfile", "ec2:DescribeInstances", "cloudwatch:GetMetricData", "dynamodb:ListTables", "ec2:DescribeRegions", "sns:ListTopics", "ce:GetCostAndUsage", "s3:ListBucket", "ecs:ListServices", "elasticbeanstalk:DescribeEnvironmentResources", "elasticloadbalancing:DescribeLoadBalancers", "eks:DescribeNodegroup", "elasticbeanstalk:DescribeEnvironments", "ec2:StartInstances", "dynamodb:DescribeTable", "ecs:ListTasks", "autoscaling:DescribeAutoScalingGroups", "ec2:DescribeVolumes", "rds:DescribeDBInstances", "ecs:DescribeServices", "ecs:DescribeContainerInstances", "ecs:DescribeTasks","dynamodb:DescribeLimits", "ecs:ListClusters", "ec2:RebootInstances", "sqs:ListQueues", "eks:ListNodegroups", "sns:ListSubscriptionsByTopic", "lambda:ListFunctions", "lambda:GetFunction", "sqs:GetQueueAttributes", "dynamodb:DescribeStream", "cloudwatch:GetMetricStatistics", "ec2:StopInstances", "ecs:DescribeClusters", "ce:GetCostForecast", "eks:ListFargateProfiles", "s3:ListAllMyBuckets", "elasticbeanstalk:DescribeEvents", "elasticloadbalancing:DescribeTargetHealth", "elasticloadbalancing:DescribeTargetGroups", "eks:DescribeCluster", "ecs:ListContainerInstances", "eks:ListClusters", "sts:GetCallerIdentity", "s3:GetBucketLocation", "rds:DescribeDBClusters", "ec2:DescribeInstanceAttribute " ], "Resource": "*" }]} Note: You can refer to the screenshots below for your reference. Using the Visual Editor to add a policy: Using JSON format to add a policy: Amazon EC2 Instances To collect operating system-level metrics like Memory and Disk, you must deploy the Cloud-Watch Agent inside EC2 instance. The agent will send your data to Cloud-Watch from where Applications Manager fetches and displays it in the console. Click here to know more about how you can collect metrics from Amazon ec2 instances and on-premises servers with the Cloud-Watch Agent. AWS account users are required to use their AWS Access Key and Secret Access Key to add an AWS monitor in Applications Manager. By default, AWS users have administrator privileges and can access AWS Service APIs. However, if your AWS user account has limited permission, here is the list of APIs used to collect metrics from the respective AWS services and performance metrics from CloudWatch: EC2 - DescribeVolumes, DescribeInstances, DescribeRegions, DescribeInstanceAttributeEC2 actions - StartInstances , StopInstances, RebootInstances The common API call - ''GetMetricStatistics'' is used for all the metrics that we collect from Cloudwatch. Amazon RDS Instances AWS account users are required to use their AWS Access Key and Secret Access Key to add an AWS monitor in Applications Manager. By default, AWS users have administrator privileges and can access AWS Service APIs. However, if your AWS user account has limited permission, here is the list of APIs used to collect metrics from the respective AWS services and performance metrics from CloudWatch: DescribeDBInstances DescribeDBClusters The common API call - ''GetMetricData'' is used for all the metrics that we collect from Cloudwatch. Amazon S3 Buckets Following are the list of APIs used to collect metrics from CloudWatch: ListAllMyBuckets ListBucket GetBucketLocation The common API call - ''GetMetricData'' is used for all the metrics that we collect from Cloudwatch. Amazon DynamoDB Monitoring AWS account users are required to use their AWS Access Key and Secret Access Key to add an AWS monitor in Applications Manager. By default, AWS users have administrator privileges and can access AWS Service APIs. However, if your AWS user account has limited permission, here is the list of APIs used to collect metrics from the respective AWS services and performance metrics from CloudWatch: ListTables DescribeTable DescribeLimits DescribeStream The common API call -  ''GetMetricStatistics'' is used for all the metrics that we collect from Cloudwatch. Amazon Billing AWS account users are required to use their AWS Access Key and Secret Access Key to add an AWS monitor in Applications Manager. By default, AWS users have administrator privileges and can access AWS Service APIs. However, if your AWS user account has limited permission, here is the list of APIs used to collect metrics from the respective AWS services and performance metrics from CloudWatch: GetCostAndUsage - To retrieve cost and usage metrics for your Global Account GetCostForecast - To retrieve a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs. Amazon Elastic Load Balancer (ELB) Application Load Balancers APIs: DescribeLoadBalancers DescribeTargetGroups DescribeTargetHealth The common API call - ''GetMetricData'' is used for all the metrics that we collect from Cloudwatch. Amazon SNSAmazon Simple Notification Service APIs: ListTopics - API to retrieve the list of SNS topics in an account ListSubscriptionsByTopic - API to retrieve the list of subscriptions in a SNS topic The common API call - ''GetMetricStatistics'' is used for all the metrics that we collect from Cloudwatch. AWS Lambda AWS Lambda Service APIs: ListFunctions - API to fetch list of Lambda functions. Click here for more info. GetFunction - API to fetch the configuration and information about the Lambda function. Click here for more info. The common API call - ''GetMetricData'' is used for all the metrics that we collect from Cloudwatch. AWS Elastic Beanstalk AWS Elastic Beanstalk APIs: DescribeEnvironments - API to fetch environments and its meta-data. Click here for more info. DescribeEnvironmentResources - API to fetch resources used by the environment. Click here for more info. DescribeAutoScalingGroups - API to fetch meta-data of the AutoScaling Group. Click here for more info. DescribeEvents - API to fetch events occurred in the environment. Click here for more info. The common API call - ''GetMetricData'' is used for all the metrics that we collect from Cloudwatch. To enable enhanced monitoring for Beanstalk environment, follow the steps mentioned below. Learn more In the AWS console, select ElasticBeanstalk under Services. Select the environment that needs the metrics to be enabled. Click Configuration on the left side menu. Choose Monitoring → click Edit → select Enhanced → select all the metrics for environment and instance. Click Apply. Amazon SQS Amazon SQS Service APIs: ListQueues - API to list the queues in AWS. Click here for more info. GetQueueAttributes - API to get the metrics of the specified SQS Queue. Click here for more info. The common API call - ''GetMetricData'' is used for all the metrics that we collect from Cloudwatch. AWS Elastic Container Service (ECS) Amazon Elastic Container Service (ECS) APIs: ListClusters - API to list the existing clusters in AWS. Click here for more info. DescribeClusters - API to fetch meta-data of clusters in AWS. Click here for more info. ListContainerInstances - API to list ECS container instances in the cluster. Click here for more info. DescribeContainerInstances - API to fetch meta-data of ECS container instances in the cluster. Click here for more info. ListServices - API to list the services that are running in the cluster. Click here for more info. DescribeServices - API to fetch meta-data of specified services running in the cluster. Click here for more info. ListTasks - API to list the tasks in the cluster. Click here for more info. DescribeTasks - API to fetch meta-data of tasks in the cluster. Click here for more info. The common API call - ''GetMetricData'' is used for all the metrics that we collect from Cloudwatch.To enable Container Insights on an existing Amazon ECS cluster, enter the following command. You must be running version 1.16.200 or later of the AWS CLI for the following command to work. Learn more aws ecs update-cluster-settings --cluster --settings name=containerInsights,value=disabled To deploy the CloudWatch agent to collect instance-level metrics from Amazon ECS clusters hosted on EC2 instance, download the JSON file, save it and then execute the following command in CLI. Learn more aws cloudformation create-stack --stack-name CWAgentECS- - --template- body file:// .json --parameters ParameterKey=ClusterName,ParameterValue= ParameterKey=CreateIAMRoles,ParameterValue=True --capabilities --region AWS Elastic Kubernetes Service (EKS) Check if you have given access for the following APIs to the IAM user whose credentials are being used for monitoring EKS: ListFargateProfiles DescribeNodegroup ListNodegroups DescribeFargateProfile DescribeCluster ListClusters GetMetricData GetMetricStatistics Download and install the AWS CLI (Windows or Linux) to configure cluster with kubectl for monitoring. Learn more Windows: Execute the downloaded file to open the Installation wizard and complete the installation. Linux: Execute the below commands to unzip the downloaded file, execute the program and complete the installation. Learn more unzip awscliv2.zip sudo ./aws/install Note: AWS CLI is used only for AWS EKS monitoring. Uninstall AWS CLI if no longer needed. Download the latest Kubectl utility executable file (Windows or Linux). Learn more Windows: Place the downloaded executable file under \working\ directory (or) add kubectl to the system environment path. Linux: Execute the following commands (or) add kubectl to the system path. chmod +x ./kubectl mkdir -p $HOME/bin && cp ./kubectl $HOME/bin/kubectl && export PATH=$PATH:$HOME/bin To fetch metrics from Container Insights, implement the prerequisites for container insights. However, to execute the commands specified in the prerequisites, AWS CLI and kubectl should be configured. To configure AWS CLI, execute the below command and provide the necessary credentials: aws configure To configure kubectl, execute the below command: aws eks --region {region} update-kubeconfig --name {cluster_name} --kubeconfig . Nodes (EC2 instances) should have the policy CloudWatchAgentServerPolicy to send container insights metrics to CloudWatch. Google Cloud PlatformPrerequisites: Login to the GCP console with Owner access to the Project to be monitored. Go to GCP Console → APIs & Services → Library, to enable the following APIs : Cloud Resource Manager API Cloud Asset API Compute Engine API Stackdriver API Stackdriver Monitoring API Cloud Storage Google Cloud Storage JSON API Cloud Filestore API Kubernetes Engine API Follow the below mentioned steps to create an OAuth provider to monitor a GCP project. Once an OAuth provider is created, verify if it has an Access Token and Refresh Token. You can use OAuth provider to add multiple projects under the same account, but ensure that the APIs are enabled in each project before adding a monitor in AppManager. Steps to create an OAuth Provider for GCP: In Applications Manager, go to Settings → OAuth Provider and select Add OAuth Provider. (Make sure you are logged in from a fully qualified domain name as in the help card) Copy the Redirect URL from the Add OAuth Provider window. Go to GCP Console → APIs & Services → OAuth consent screen. Select User Type as External and click Create to register an app. Provide the desired App Information and under Authorised domain, enter the domain name from the Redirect URL and press the enter key. If the app is already present then click the Edit App option and under Authorised domain, enter the domain name from the Redirect URL and press the enter key. Now click Save and Continue. Go to GCP Console → APIs & Services → Credentials. Select Create Credentials → OAuth Client ID. Select Web Application and enter the copied Redirect URI in the Authorised redirect URIs section and press the Enter key. Now click Create button. The generated Client ID and Client secret will be displayed. Copy it and fill in the Add OAuth Provider window. Fill the following as below: Grant Type - Authorization Code Authorization Endpoint URL - https://accounts.google.com/o/oauth2/auth Scope - https://www.googleapis.com/auth/cloud-platform Query parameters:     Name - access_type     Value - offline Token endpoint URI - https://oauth2.googleapis.com/token Token request method - Post request body Authenticated request method - Basic Authentication Note : Remaining fields should remain as default. Click Authorize button and authorize using the account to login to GCP. Once created, verify whether both Access token and Refresh token are generated. Use this OAuth Provider in the Google Cloud Platform''s New Monitor page. Oracle Cloud Infrastructure To obtain data into Applications Manager, the user must have appropriate policies/permissions assigned by the administrator. To do so, follow the steps given below: Login as administrator into the Oracle Cloud Infrastructure console. Under Governance and Administration section, go to Identity → Groups option and click on Create Group button. Create a new group with the required group name (say ''AppManager'') and add the required user to this newly- created group.Under Identity → Policy option, click on Create Policy button and create a new policy with the following policy statement: ALLOW GROUP to use all-resources IN TENANCY Example: ALLOW GROUP AppManager to use all-resources IN TENANCY Make sure that you are in the ''root'' compartment while creating the above policy. Note : Using this policy, the user can only read and cannot perform create and delete operations. (Refer here for more info.) Oracle Autonomous Database To obtain data for TableSpace, Sessions, Processes and Jobs in Applications Manager, you must configure the Oracle Wallet credentials in the Oracle Autonomous DB monitor. To do so, follow the steps given below: Go to Monitor Actions → Edit Monitor available on right-side of the Oracle Autonomous DB monitor dashboard page. Download the Oracle Wallet credentials. (Click here to learn how to download the Oracle Wallet credentials) After downloading, unzip the Wallet_databasename.zip file to a secured location. Copy the location path of that file and provide as input in the Wallet File Path field. Now open the tnsnames.ora file (obtained after unziping Wallet_databasename.zip file) in any text editor. This file contains the predefined services identifiable as high, medium, and low. Each service has its own TNS alias and connection string. Copy any one of the alias names (based on severity) and provide the same as input in the TNS Alias Name field. (Refer here to learn more) Enter the username and password details of the autonomous database. Click Update. OpenStack Prerequisites: Policy defaults enable only users with the administrative role to perform below operations (Access to below APIs). User can provide the required permissions through the policy.json file. Hypervisors: /os-hypervisors Cinder Services: /v3/{project_id}/os-services Nova/Compute Services: /os-services Neutron Agents: /v2.0/agents Authentication API: /v3/auth/tokens Computes: /servers/detail Images: /v2/images ERP Oracle EBS Applications Manager uses the Dynamic Monitoring Service (DMS) to monitor performance and availability of Oracle E-Business Suite. You can access performance metrics using servlets from the following URLs for different versions of EBS from Applications Managers: EBS R11 - http:// : /dms0/AggreSpy EBS R12.0 - http:// : /dms0/Spy EBS R12.2.0 - http:// : /dms/Spy For Oracle E-Business Suite Version R11i, the DMS Servlet has to be made accessible to the system where Applications Manager is running. For Versions R12.0 and R12.2.0, the DMS Servlet should be accessible by default. It is recommended that you test to ensure that the Servlet is accessible to the Applications Manager system. [The instructions given below are referred from the Oracle website.]For Oracle E-Business Suite R11i: By default, the dms0/AggreSpy URL is protected, allowing only the localhost (127.0.0.1) to access the AggreSpy Servlet. To view metrics from a system other than the localhost, you need to change the DMS configuration for the system running the Oracle EBS that you want to monitor by modifying the trusted.conf file. This can be done as follows: Open the trusted.conf file under $ORACLE_HOME/Apache/Apache/conf on a UNIX system, or%ORACLE_HOME%\Apache\Apache\conf\ on a Windows system. Add the Applications Manager Hostname and IPaddress in the Allow from list as shown in the following example: Order deny,allow Deny from all Allow from localhost Allow from Now open the httpd.conf and httpd_pls.conf files and check if the trusted.conf file is included. The Files are present under$ORACLE_HOME/Apache/Apache/conf on a UNIX system, or %ORACLE_HOME%\Apache\Apache\conf\ on a Windows system. If the trusted.conf file is not included, add the following lines in both the files and save: # Include the trusted.conf file include $ORACLE_HOME/Apache/Apache/conf/trusted.conf Restart Oracle E-Business Suite and ensure that you are able to access the URL http:// : /dms0/AggreSpy from the Applications Manager system. For Oracle E-Business Suite R12.0: Ensure that you are able to access the URL http:// : /dms0/Spy (Hostname = Hostname with domain name, Port number = OAS listening port) from the Applications Manager system. For Oracle E-Business Suite R12.2.0: Ensure that you are able to access the URL http:// : /dms/Spy (Hostname = Hostname with domain name, Port number = Weblogic Admin Server listening port) from the Applications Manager system. Users must enter the credentials of their Weblogic Admin server in their Oracle E-Business Suite to access the URL. Caution: Modifying trusted.conf has security implications. Modify this file only if you understand the security implications for your site. By exposing metrics to systems other than the localhost, you allow other sites to potentially view critical Oracle EBS Server internal status and runtime information. SAP Server, SAP CCMS SAP Server Monitoring and SAP CCMS Monitoring requires SAP JavaConnector ( JCo) to be present in Applications Manager''s classpath. Note: The user name provided while adding SAP monitor should have sufficient privileges to access CCMS and Background job metrics. To check this, the user can execute RZ20 transaction in the SAP GUI and see if the CCMS monitor sets can be displayed. Applications Manager build 14270 and above For Windows: Download and unzip the SAP JavaConnector [SAP JCo 3.1.x] from here. Depending on the hardware architecture of host machine where Applications Manager is running, make sure you download the respective zip file. In the machine, where Applications Manager is running, copy sapjco3.jar and sapjco3.dll and sapjco3.pdb under AppManager_home/working/lib directory. If Applications Manager is installed on Windows, as mentioned in SAP Note 2786882 on Windows platforms, JCo 3.1 requires the Visual Studio 2013 C/C++ runtime libraries to be installed on the system. To verify, check for the presence of the "Microsoft Visual C++ 2013 Redistributable" package in ControlPanel -> Program and Features. If not present, download and install the "Visual C++ 2013 Redistributable Package" from the Microsoft knowledge base article https://support.microsoft.com/en-us/help/4032938 and choose the package, which corresponds to the used Locale and JVM bit-width (x64 for 64-bit or x86 for 32-bit). Restart Applications Manager.Note: Do not copy the sapjco3.dll neither into the {windows-dir}/system32 nor into the {windows- dir}/SysWOW64 directory. This will break the operability of other JCo versions that are already installed on the same system. Furthermore you would risk that the current installation also would not work anymore, if the sapjco3.dll gets replaced in the respective Windows system directory in the future. For Linux: Download and unzip SAP JavaConnector[SAP JCo 3.1.x] from here. Depending on the hardware processor of the host machine where Applications Manager is installed. make sure you download the respective zip file. In the machine, where Applications Manager is running, copy sapjco3.jar and libsapjco3.so under AppManager_home/working/lib directory. Restart Applications Manager. Applications Manager build below 14270 For Windows: Download and unzip the SAP JavaConnector [SAP JCo 3.0.x] from here. Depending on the hardware architecture of host machine where Applications Manager is running, make sure you download the respective zip file. In the machine, where Applications Manager is running, copy sapjco3.jar and sapjco3.dll and sapjco3.pdb under AppManager_home/working/lib directory. If Applications Manager is installed on Windows, as mentioned in SAP Note 1077727 JCo 3.0 requires the Microsoft Visual Studio 2005 C/C++ runtime libraries (version 8.0.50727.6195) to be installed on the system. To verify, check for the presence of the "Microsoft redistributable runtime DLLs VS2005 SP1" in ControlPanel -> Program and Features. If not present, download and install the "Visual C++ 2005 SP1 Redistributable Package" from the Microsoft website https://www.microsoft.com/en-us/download/details.aspx?id=26347 and choose the package, which corresponds to the used JVM bit-width and processor architecture (x64 for 64-bit, x86 for 32-bit and ia64 for Itanium processors). Restart Applications Manager. Note: Do not copy the sapjco3.dll neither into the {windows-dir}/system32 nor into the {windows- dir}/SysWOW64 directory. This will break the operability of other JCo versions that are already installed on the same system. Furthermore you would risk that the current installation also would not work anymore, if the sapjco3.dll gets replaced in the respective Windows system directory in the future. For Linux: Download and unzip SAP JavaConnector[SAP JCo 3.0.x] from here. Depending on the hardware processor of the host machine where Applications Manager is installed. make sure you download the respective zip file. In the machine, where Applications Manager is running, copy sapjco3.jar and libsapjco3.so under AppManager_home/working/lib directory. Restart Applications Manager. Microsoft Dynamics CRM / 365 (On-Premise) To monitor a Microsoft Dynamics CRM / 365 application, use an Administrator user account with permission to execute WMI queries on ''root\CIMV2'' namespace of the Dynamics CRM / 365 Server. The following software must be installed and running on your computer before you try to execute WMI queries: Microsoft .Net framework 3.5 Microsoft .Net framework 4.7 Firewall access for monitoring: Ports required for monitoring via WMI. Windows Management Instrumentation (WMI) (default : TCP 445) Remote Procedure Call (RPC) (default :TCP 135) Target server uses random port above 1024 by default to respond back for remote communication (DCOM) (default : TCP 1025 to 1030)Powershell – Enable Script Execution: Powershell script execution must be enabled on Applications manager server for data collection. Here is how you can do it: Execute the below cmdlet from an administrator powershell window: Set-ExecutionPolicy Unrestricted If the above cmdlet produces an Error as below, you can configure Powershell Script Execution via Group Policy Editor: Configure Powershell Script Execution via Group Policy Editor Open the Group Policy Editor from Control Panel→ Edit Group Policy (or) run gpedit.msc from Start menu. To configure, navigate under Computer Configuration to Policies\Administrative Templates\Windows Components\Windows PowerShell. You should see a setting called Turn on Script Execution like in the following image: Double-click the setting. You will want to enable it and select an option from the drop down.Set it to “Allow All Scripts”. Click Apply and OK. Microsoft Dynamics AX Supported versions of Microsoft Dynamics AX: Microsoft Dynamics AX 2012, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 R3 The following software must be installed and running on your computer before you try to execute WMI queries: Microsoft .Net framework 3.5 Microsoft .Net framework 4.7 To monitor a Microsoft Dynamics AX application, use an Administrator user account which has the permission to execute WMI queries on ''root\CIMV2'' namespace of the AX Server. Firewall access for monitoring- Ports required for monitoring via WMI: Windows Management Instrumentation (WMI) (default : TCP 445) Remote Procedure Call (RPC) (default : TCP 135) Target server uses random port above 1024 by default to respond back for remote communication (DCOM) (default : TCP 1025 to 1030) SAP Business One Integration Framework should be launched for SAP Business One. Servers Windows Currently windows hardware performance monitoring is supported in SNMP and WMI monitoring mode: SNMP Mode of monitoring: Monitoring Dell hardware status: Dell OpenManage Server Administrator and make sure SNMP agent is enabled. Installation steps http://www.dell.com/downloads/global/power/ps2q06-20050112-Lou-OE.pdf. Monitoring HP hardware status: HP System Insight Manager (SIM v6.2 or higher is recommended) and make sure SNMP agent is enabled Installation steps http://h20000.www2.hp.com/bc/docs/support/SupportManual/c00293378/c00293378.pdf Determine if SNMP responds for the OID properly. Below are the correct OID''S for each vendor: For HP: 1.3.6.1.4.1.232.2.2.2.1.0 For Dell: 1.3.6.1.4.1.674.10892.1.300.10.1.8.1 WMI mode of monitoring: The following conditions must be met before you can proceed troubleshooting WMI nodes: The node has successfully been added via WMI. WMI is working properly on the remote server. HP System Insight Manager (SIM v6.2 or higher is recommended) is installed on the remote server and running. Dell OpenManage Server Administrator is installed on the remote server and running. If WMI, execute the below cmdlet from Powershell prompt with Administrator privileges: Set-ExecutionPolicy UnrestrictedThis is to allow execution of powershell scripts, which handle proper process termination during Datacollection For WMI Mode of Monitoring: In Windows Server 2008 and later versions, and in Windows Vista and later versions, use the following dynamic port range: Start port: 49152 End port: 65535 If your computer network environment uses only Windows Server 2012, Windows Server 2008 R2, Windows Server 2008, Windows 8, Windows 7, or Windows Vista, you must enable connectivity over the high port range of 49152 through 65535. For Windows 2000, Windows XP, and Windows Server 2003 use the following dynamic port range: Start port: 1025 End port: 5000 If your computer network environment uses Windows Server 2012, Windows Server 2008 R2, Windows Server 2008, Windows 8, Windows 7, or Windows Vista together with versions of Windows earlier than Windows Server 2008 and Windows Vista, you must enable connectivity over both the following port ranges: High port range: 49152 through 65535 Low port range: 1025 through 5000 Linux Prerequisites for monitoring Cron jobs: Curl must be installed in the remote Linux machine. Script linked to the cron job must have executable permission. The machine where Applications Manager is installed should be reachable from the remote Linux machine via SSL port without any proxy server. The remote machine where the cron job is running must be synced with the correct time zone. Cron job interval should be a minimum of five minutes. Cron job uses HTTPs protocol to send responses to the machine where Applications Manager is installed and is validated using the admin user''s Rest API key. If the admin user''s API key is regenerated, then update the latest API key for all the cron job(s) on the remote Linux machine using the crontab -e command. Linux cron is supported only in SSH and TELNET mode of monitoring. IBM i To connect to IBM i server from Applications Manager, ensure that the ports mentioned under "Port Non-SSL" column in the link are not blocked in firewall. Also check out: https://www.ibm.com/support/pages/ports- must-be-open-make-odbc-data-transfer-ole-db-adonet-or-jdbc-connection-through-firewall It is recommended to use an account having a *QSECOFR permission on the server. If using the *QSECOFR user profile is not possible, then use an account of user class *USER with additional permissions as follows: The user should be permitted to access QMPGDATA/QPFRDATA(used to collect disk details) and QGPL(used to collect problem details) libraries and permitted to execute the command CRTPFRDTA and DSPPRB. Consider the following special authorities when you use an account of user class *USER such as *ALLOBJ, *SAVSYS , *JOBCTL, *SPLCTL to retrieve all data and perform IBM i admin actions from Applications Manager. Services JMX Applications To monitor a JMX Applications, the following java runtime options are to be added to your applicationDcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1099 Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false Replace 1099 with the actual port number of the agent Example: To enable JMX Applications in JBoss: Edit the run.sh/bat under JBoss home/bin. Append the following command to JAVA_OPTS, JAVA_OPTS =-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1099 - Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false %JAVA_OPTS% To enable JMX Applications in JBoss 7 and above: Copy the jboss-client.jar from /bin/client/ and place it under /working/classes/jboss/as7 directory. To enable JMX Applications in Tomcat: JAVA_OPTS =-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1099 - Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false %JAVA_OPTS% To enable SSL for JMX applications -Dcom.sun.management.jmxremote.ssl=true To enable authentication, use of authentication is recommended. If you do not want to use authentication, you should change the value to false. -Dcom.sun.management.jmxremote.authenticate=true If you are using authentication, specify the location of the password file -Dcom.sun.management.jmxremote.password.file=c:\jmxremote.password If you are using authentication, specify the location of the access file -Dcom.sun.management.jmxremote.access.file=c:\jmxremote.access Refer Oracle documentation in this regard: http://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote Note: To know more about monitoring a JMX Application if your application is behind a firewall, check out this blog post. Also please note that the ping/telnet/nslookup should be working for the remote JMX: telnet hostname port ping hostname ping IPAddress nslookup hostname nslookup IPAddress Ceph Storage Monitor Ceph status command is used to collect performance stats of Ceph Storage Monitor. The user given, should have read privileage to ceph.keyring file. Ensure the ceph.keyring file has appropriate permissions set (e.g., chmod 644) on your client machine. Hadoop Monitor 1. To monitor Hadoop via REST API: No Authentication: URL http:// : /jmx should be able to accessed from the Applications Manager machine for both Namenode and Jobtracker/ResourceManager Simple Authentication:URL http:// : /jmx?user.name= should be able to access from the Applications Manager machine for both Namenode and Jobtracker/ResourceManager 2. To monitor Hadoop via JMX: Add the following java runtime options to ''HADOOP_NAMENODE_OPTS''; ''HADOOP_JOBTRACKER_OPTS'' in Hadoop-env.sh with unique port. -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false - Dcom.sun.management.jmxremote.port=8004 Apache Zookeeper Prerequisites for monitoring Apache Zookeeper: Remote JMX should be enabled. To ensure that please open the ZKServer file under bin folder and check the below following: JMXPORT = ZOOMAIN="-Djava.rmi.server.hostname= -Dcom.sun.management.jmxremote - Dcom.sun.management.jmxremote.port=$JMXPORT - Dcom.sun.management.jmxremote.authenticate=$JMXAUTH - Dcom.sun.management.jmxremote.ssl=$JMXSSL -Dzookeeper.jmx.log4j.disable=$JMXLOG4J org.apache.zookeeper.server.quorum.QuorumPeerMain" Note: Replace with JMXPORT and with IP address of the machine. Java/Transactions APM Insight APM Insight includes a remote monitoring agent which has to be deployed in your application instances. Know more about APM Insight Agent. Java Runtime Monitor To monitor a JDK1.5 JVM and above, add the following JVM arguments to your application: -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1099 - Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false To monitor IBM JDK1.5 JVM and above, add the following JVM arguments to your application: -Djavax.management.builder.initial= -Dcom.sun.management.jmxremote - Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false - Dcom.sun.management.jmxremote.authenticate=false Note: Port number ''1099'' can be replaced with the actual port number of the JMX agent. To enable Java Runtime Monitor in JBoss: Edit the run.sh/bat under JBoss home/bin. Append the following command to JAVA_OPTS JAVA_OPTS =-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1099 - Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false %JAVA_OPTS% To enable Java Runtime Monitor in JBoss 7 and above: Copy the jboss-client.jar from /bin/client/ and place it under /working/classes/jboss/as7 directory. To enable Java Runtime Monitor in Tomcat do the following: Edit the catalina.sh/bat under Tomcat home/bin. Append the following command to JAVA_OPTS JAVA_OPTS =-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1099 - Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false %JAVA_OPTS%To enable SSL over JMX, use the following JMX parameters in addition to the above, and restart the server. JMX Parameters: -Dcom.sun.management.jmxremote.ssl=true -Djavax.net.ssl.keyStore="E:/APMBuilds/certificates/jmx.keystore" -Djavax.net.ssl.keyStorePassword=password -Djavax.net.ssl.trustStore="E:/APMBuilds/certificates/jmx.truststore" -Djavax.net.ssl.trustStorePassword=password Additionally, import the server certificate to " \working\jre\lib\security\cacerts" file and restart the server. Syntax: keytool -import -alias -file - keystore " \working\jre\lib\security\cacerts" -storepass changeit -noprompt Example: keytool -import -alias jmxcert -file "E:\APMBuilds\certificates\ssloverjmx.cer" -keystore "C:\Program Files (x86)\AppManager14\working\jre\lib\security\cacerts" -storepass changeit - noprompt In the Tomcat Environment: Make sure the catalina-jmx-remote.jar file is present in the $TOMCAT_HOME/lib location. This jar file can be downloaded for your version of Tomcat from the Apache website from the extras section (sample link: http://archive.apache.org/dist/tomcat/tomcat-7/v7.0.55/bin/extras/catalina-jmx-remote.jar). Enable JMX in WebLogic Open the startWebLogic.bat file in a text editor. Find the JAVA_OPTS line and add the following: -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=8888 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false Restart WebLogic. Active Directory To monitor an Active Directory Service, the user must have "Administrator" privileges. To add an Active Directory Service, follow the below given steps: Install the latest .NET Framework on your Applications Manager machine. Enable .NET Framework 3.5: To know how to enable .NET 3.5 in Windows Server 2008, click here. To know how you can enable .NET 3.5  other Windows Servers, click here. Firewall access for monitoring:Following are the list of ports required for monitoring: Windows Management Instrumentation (WMI) (Default : TCP 445) Remote Procedure Call (RPC) (Default :TCP 135) Target server uses random port above 1024 by default to respond back for remote communication (DCOM) (Default : TCP 1025 to 1030) PowerShell Remoting (Default: TCP 5985 and 5986) Install the latest Windows Management Framework in both Applications Manager machine and AD Server. Check whether both machines have PowerShell version 5.0 or above. Click here for Powershell prerequisites Using CredSSP Authentication Enable the Use CredSSP Authentication option only when the monitored AD Server is a non-primary Domain Controller and is present in a different domain other than that of the Applications Manager server domain. Learnmore about the prerequisites for using CredSSP authentication Istio Istio metrics are collected via kubectl, istioctl, curl, grep commands, so all the CLI tools mentioned should be installed on that machine where Istio is installed. Mesh traffic metrics collected by prometheus as running with ClusterIP, so prometheus should be deployed with Istio. Network Policy Server (Radius Server) To monitor Network Policy Server (Radius Server), the user must have "Administrator" privileges. To add an Network Policy Server (Radius Server), follow the below given steps: Install the latest .NET Framework on your Applications Manager machine. Enable .NET Framework 3.5: To know how to enable .NET 3.5 in Windows Server 2008, click here. To know how you can enable .NET 3.5  other Windows Servers, click here. Firewall access for monitoring:Following are the list of ports required for monitoring: Windows Management Instrumentation (WMI) (Default : TCP 445) Remote Procedure Call (RPC) (Default :TCP 135) Target server uses random port above 1024 by default to respond back for remote communication (DCOM) (Default : TCP 1025 to 1030) To use a non-admin user for monitoring, follow the steps mentioned in this link. Mail Servers Exchange Server Monitoring of Exchange Server is possible only if Applications Manager is running in a Windows System. Exchange Monitoring supports two Modes of Monitoring. Using WMI - If WMI is enabled in the remote machine in which Exchange Server is running. Using Windows PowerShell technology - To use Powershell for data collection, make sure the proper steps have been followed to enable and use remote commands in Windows PowerShell both in the Applications Manager server and the remote server. Ports required for monitoring: Windows Management Instrumentation (WMI) (default : 445) Remote Procedure Call (RPC) (default : 135) PowerShell remoting - TCP 5985 and 5986 Exchange PowerShell session - TCP 80 and 443 Creating User Accounts, adding users and assigning roles User Account Used for Monitoring: The User Account used to add the monitor should be a member of View-Only Organization Management group. Make sure that the group has the following Roles assigned - Mailbox Search & Monitoring. For Exchange View-Only Administrators: This role allows read access only to Exchange organization container and containers with Exchange recipients in AD. They can verify settings, but can not change or add any settings. Only Powershell "Get- " can be executed. Adding Users and Assigning Roles Adding Users to the View-Only Organization Management group and assigning roles in: Exchange 2010/2013/2016Open Exchange Mangement Console in the Exchange Server. To check if the user is already under View-Only Organization Management role group: Get- RoleGroupMember "View-Only Organization Management" | where-object {$_.Name -eq " "} If the user is not under the specified role group,execute the below cmdlet to add the user: Add- RoleGroupMember "View-Only Organization Management" -Member Next Add the two roles for View-Only Organization Management role group New-ManagementRoleAssignment -SecurityGroup "View-Only Organization Management" -Role "Monitoring" New-ManagementRoleAssignment -SecurityGroup "View-Only Organization Management" -Role "Mailbox Search" Exchange 2007: Open Exchange Management Shell. Execute the following cmdlet: Add-ExchangeAdministrator –Identity –Role ViewOnlyAdmin Enabling CredSSP authentication Enable the Use CredSSP Authentication option only if you want to fetch Exchange Queues metrics for non- mailbox roles in versions 2010 and above where the Applications Manager and Exchange server are in different domains. Check the prerequisites for using CredSSP authentication here Configuring ConnectionURI for Powershell Remoting The ConnectionURI is used to establish a connection to a remote computer using the URI address of the related HTTP or HTTPS endpoint.These connections are made over TCP port 80 for HTTP and TCP port 443 for HTTPS. By default,the connection URI is of the form http:// /powershell and uses Kerberos authentication. With Kerberos Authentication: When the machine running Exchange Server is joined to the same domain as the machine running Applications Manager, either HTTP or HTTPS can be used with Kerberos Authentication. If Kerberos Authentication is not supported , or the machine is in another domain, the other option is to configure Basic Authentication for powershell virtual directory. To configure basic authentication in Exchange 2013, 2010 or 2007 using IIS Manager: Open IIS Manager. In the Connections pane, expand Default Web Site, and then click PowerShell. Click Authentication in the results pane and enable Basic Authentication. Note: If you decide to use Basic Authentication, HTTPS should be used as mode of connection for connectionURI. If the connectionURI should be customized it can be done so by clicking the "Customize ConnectionURI" option in new monitor page. To provide a different port for the connectionUri provide it in the following format: /Powershell: (or) /Powershell: For Example: http://win-exchange13/Powershell:4444 Middleware/Portal IBM WebSphere MQ Monitor To monitor IBM Websphere MQ Series, the following jar files must be added to the respective locations: For IBM Websphere Location in Jar files to be added Location in Applications Manager MQ Series Websphere MQ version Version Download the Copy the jar files to com.ibm.mq.jar 5.x/6.x supportpac MS0B \working\jre\lib\ext com.ibm.mq.pcf-6.x.jar WebSphere MQ directory. connector.jar Java classes for PCF, the com.ibm.mq.pcf- 6.1.jarfile for version 6 and older versions.The jar files can be found under \Java\lib directory. connector.jar All the jar files can com.ibm.mq.jar be found under Copy the jar files to com.ibm.mq.pcf.jar \working\jre\lib\ext com.ibm.mq.jmqi.jar Home directory. com.ibm.mq.headers.jar Directory>\Java\lib com.ibm.mq.commonservices.jar directory. com.ibm.mq.jar com.ibm.mq.pcf.jar All the jar files can com.ibm.mq.jmqi.jar be found under com.ibm.mq.headers.jar and Copy the jar files to Version 8 \working\jre\lib\ext and above Home directory. (OR) Directory>\Java\lib directory. com.ibm.mq.allclient.jar and com.ibm.mq.pcf.jar Note: The username & password length should be less than or equal to 12. To monitor Queue statistics, make sure MONQ value is set to MEDIUM or HIGH for all queues. You can check the current MONQ status using DISPLAY QSTATUS(Q1) To modify, ALTER QL(Q1) MONQ(MEDIUM) where Q1 is the queue. To monitor Channel statistics, make sure MONCHL value is set to MEDIUM or HIGH for all channels. You can check the current MONCHL status using DISPLAY CHANNEL(QM1.TO.QM2) To modify, ALTER CHL(QM1.TO.QM2) CHLTYPE(SDR) MONCHL(MEDIUM) where QM1.TO.QM2 is the channel name and SDR is its type. IBM WebSphere Message Broker To discover Message Broker, the following jars are required: ConfigManagerProxy.jar located at \classes directory. ibmjsseprovider2.jar located at \jre\lib directory. Copy the two jar files to \working\jre\lib\ext directory. Note: Copy these jar files to \jre\lib\ext directory if external JDK is configured for AppManager. Restart Applications Manager and try adding the monitor. For IBM Integration Bus(MessageBroker 10.x): The following jars are required to monitor IIB: IntegrationAPI.jar jetty-io.jar jetty-util.jar websocket-api.jar websocket-client.jar websocket-common.jar IntegrationAPI.jar located at \common\classes directory. jetty-io.jar, jetty-util.jar, websocket-api.jar, websocket-client.jar, websocket-common.jar located at \common\jetty\lib directory.Copy the jar files to \working\jre\lib\ext directory. Note: Copy these jar files to \jre\lib\ext directory if external JDK is configured for AppManager. Restart Applications Manager and try adding the monitor. WebLogic Integration Server Note: WebLogic Integration Server needs some additional configuration and conditions to be followed for monitoring. For monitoring WebLogic Integration Server 8.x, you should set the weblogic.disableMBeanAuthorization andweblogic.management.anonymousAdminLookup system variable to true for enabling data collection. Follow the steps given below: Edit startWLS.cmd\sh present in the /server/bin directory and add the following argument -Dweblogic.disableMBeanAuthorization=true and - Dweblogic.management.anonymousAdminLookupEnabled=true (click on the link to view the sample startWLS.cmd\sh file) Restart the WebLogic Integration Server for the changes to take effect. Copy weblogic.jar from folder /weblogic81/server/lib in Remote WebLogic server version 8 and place it under \working\classes\weblogic\version8 folder in the machine where Applications Manager is running. Microsoft Office SharePoint Server For SharePoint Standalone Server: WMI Mode: WMI access to remote server is required. PowerShell Mode: PowerShell remoting should be enabled. For more information, check enable and use remote commands in Windows PowerShell. For SharePoint Farm Server: Enable PowerShell remoting on both, AppManager and Remote Server. Perform the following steps on the SharePoint server(s): In the Server Manager, add the user account used for adding the Sharepoint to the following Groups: Remote Desktop Users WinRMRemoteWMIUsers__ WSS_ADMIN_WPG Open the Sharepoint Management shell as an administrator and execute the below commands one by one: Enable-PSRemoting -Force Enable-WSManCredSSP –Role Server winrm set winrm/config/winrs ''@{MaxShellsPerUser="25"}'' [This is Optional]. winrm set winrm/config/winrs ''@{MaxMemoryPerShellMB="600"}'' [This is Optional]. Get-SPShellAdmin [This command will return all the users who have the SharePoint_Shell_Access role]. Get-SPDatabase | Add-SPShellAdmin DOMAIN\UserName [Replace Domain\Username with the user used to add the SharePoint Server]. Get-SPShellAdmin [The added user should be listed.]Set-PSSessionConfiguration -Name Microsoft.PowerShell32 –ShowSecurityDescriptorUI [This command will open up a dialog box. Add the user(s) with Read and Execute permissions then click OK]. Run the above command again to ensure the permissions were applied correctly. Using CredSSP Authentication To monitor the SharePoint Farm server, CredSSP authentication should be used. To do so, enable the Use CredSSP Authentication and refer the prerequisites for using CredSSP authentication. Then, perform the following steps on the Applications Manager Server: Open Windows PowerShell as Administrator. Execute the below commands in the Administrator PowerShell: $cred=get-Credential $s=new-PSsession “SharePointServerName” -authentication credssp -credential $cred [Replace SharePointServerName with the FQDN of the SharePoint server]. Invoke-Command -Session $s -ScriptBlock {Add-PSSnapin Microsoft.SharePoint.PowerShell;} Invoke-Command -Session $s -ScriptBlock {get-SPContentDatabase} [This will return all the content databases in your SharePoint farm and ensure you have access]. Invoke-Command -Session $s -ScriptBlock {get-spserviceinstance} [This will return the SharePoint service instances and ensure you have access]. Enter-PSSession -session $s [You will now see the servers name in [ ] PS: c:\users\\documents]. Exit-PSSession If there are any errors related to permissions issue while executing the above commands, resolve the same. For any issues related to Add-SPShellAdmin, check the following link: https://technet.microsoft.com/en- us/library/ff607596.aspx Microsoft Message Queue (MSMQ) Server Below are the prerequisites for monitoring MSMQ server in Applications Manager: WMI Mode: WMI access to remote server is required. PowerShell Mode: PowerShell remoting should be enabled. For more information, check enable and use remote commands in Windows PowerShell. Microsoft BizTalk Monitoring To monitor a Microsoft BizTalk Server, the user must have Administrator privileges. To use Powershell for data collection, make sure the proper steps have been followed to enable powershell remoting. Azure Service Bus To add an Azure Service Bus Namespace in Applications Manager, a .pfx file (which contains the cryptographic information of private keys) of the certificate uploaded in Azure Management certificates is required. In the console, execute the script /bin/exportCertificateToAppManager.sh/bat file to export the managed certificate of your account to Applications Manager. To know more about creating certificates and uploading in Windows Azure portal, Click here. Example: /bin/exportCertificateToAppManager.bat [testCertificate.pfx] [password] Apache ActiveMQ Using JMX to monitor Apache ActiveMQ Apache ActiveMQ has extensive support for JMX to allow you to monitor and control the behavior of the broker via the JMX MBeans. You can enable/disable Remote JMX support as follows: For WindowsIn Service Mode: Add the following entries in wrapper.conf file. /bin/win64/wrapper.conf (if 64-bit) /bin/win32/wrapper.conf (if 32-bit) wrapper.java.additional.13=-Dcom.sun.management.jmxremote wrapper.java.additional.14=-Dcom.sun.management.jmxremote.port=1099 wrapper.java.additional.15=-Dcom.sun.management.jmxremote.authenticate=false wrapper.java.additional.16=-Dcom.sun.management.jmxremote.ssl=false wrapper.java.additional.17=-Djava.rmi.server.hostname= In Non-Service Mode: Add the following lines in apachemq.bat file (located under /bin/ directory) before ACTIVEMQ_CLASSPATHis set. set ACTIVEMQ_SUNJMX_START=-Dcom.sun.management.jmxremote - Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false - Dcom.sun.management.jmxremote.authenticate=false -Djava.rmi.server.hostname= Replace with hostname/IP of ActiveMQ-installed machine. For Linux Add the following lines in apachemq.sh file (located under /bin/ directory) under invoke_start() function: ACTIVEMQ_SUNJMX_START="-Dcom.sun.management.jmxremote - Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false - Dcom.sun.management.jmxremote.authenticate=false -Djava.rmi.server.hostname= " Replace with hostname/IP of ActiveMQ-installed machine. Virtualization VMware Horizon View Connection Broker Prerequisite for adding the Connection Broker monitor in the Applications Manager host: VMware Horizon View Connection Broker monitor uses Windows PowerShell technology. Follow these steps to enable Windows PowerShell Remoting in the Applications Manager server and the remotely monitored Horizon View server: Enable and Use Remote Commands in Windows PowerShell Horizon View''s Domain Server and its components should be accessible (able to ping ) from the Applications Manager server. Docker Docker and Docker Container metrics are collected via their REST API, so Docker''s REST API should be enabled to add a Docker Monitor. To enable remote API: Open etc\default\docker file Add the below option DOCKER OPTS=''-H tcp://0.0.0.0:4243-H=unix:///var/run/docker.sock'' Save the file. Restart Docker. Web Server / Services IIS Server To add an IIS monitor URL for IIS server (http(s)://[Host/IP]:[PORT]) should be accessible from Applications Manager-installed server as we check for the Server header in the response. Monitoring IIS Website and Application Pool statistics:For Applications Manager versions till 15110, we use the relevant server monitor credential to fetch data from the remote server. So adding Server monitor is mandatory to fetch IIS Website and Application Pool statistics. From Applications Manager versions 15120 onwards, IIS server credential should be provided while adding/editing the IIS monitor itself. This is mandatory to monitor Website and Application Pool statistics. Mode of Monitoring:WMI access to remote server is required. Following are the list of ports that are required for monitoring through WMI: Windows Management Instrumentation (WMI) (Default : TCP 445) Remote Procedure Call (RPC) (Default : TCP 135) For remote communication (DCOM), target server uses random port above 1024 by default to respond. (Default : TCP 1025 to 1030) To collect IIS Website Statistics User must have the permission to execute WMI queries on ''root\CIMV2'' namespace of the IIS Server. To collect IIS Application Pools Statistics For Applications Manager versions till 15110, user must have the permission to access ''root\MicrosoftIISv2'' and ''root\WebAdministration'' WMI namespaces. From Applications Manager versions 15120 onwards, user must have permission to access ''root\WebAdministration'' WMI namespace alone. For ''root\WebAdministration'' namespace: Install the IIS WMI provider by selecting the IIS Management Scripts and Tools component under Management Tools (or Web Management Tools). For ''root\MicrosoftIISv2'' namespace: To enable IIS v6 Management Compatibility tools, follow steps 3 & 4 as mentioned in this link. Troubleshooting: In case you encounter with issues in IIS server monitoring, refer here. PHP Place the phpstats.php file in the webserver''s document root. The phpstats.php can be found in /working/resourcesdirectory. Apache Enabling the Server status and the Extended-status will give additional information for the Apache server. To enable the Server Status, follow the steps given below: In Apache''s httpd.conf file, locate "Location /server-status" tag. Remove the comment in the Location/Server-status tag, to Enable SetHandler server-status. Change the attribute "deny from all" to "Allow from all". Remove the comment in "LoadModule status_module modules/mod_status.so". Save the conf file and restart the Apache Server. To enable the Extended-status, follow the steps given below: Locate "ExtendedStatus" Attribute in httpd.conf file. Remove the comment to enable the status. Save the conf file and restart the Apache Server. HAProxy To monitor a HAProxy instance: Open the ''stats'' port for collecting the metrics. To enable metrics collection, add the following content at the bottom of the file /etc/haproxy/haproxy.cfg: listen stats :9000 mode httpstats enable stats hide-version stats realm Haproxy\ Statistics stats uri / stats auth Username:Password Restart the HAProxy instance. This will open up the stats in the port ''9000'' (we have specified 9000 as the port in this configuration). You can further add the same HAProxy for monitoring using the hostname and port. Note: * You can change the port (9000 by default) to any free port that you wish to use. * The line number 7 is for setting up basic authentication for this stats url. A user can provide his own username and password. * We use the following URL to collect metrics: http://[HOSTNAME]:[PORT]/;csv (Replace [HOSTNAME] and [PORT] with the respective hostname of the HAProxy instance and port which is mentioned in the above configuration). Nginx To Enable the Nginx Server Status, follow the steps given below: Configure the location /server_status method in /conf/nginx.conf file, to enable server_status. The value of stub_status attribute should be "on". Change the attribute "deny all" to "Allow all". Save the conf file and restart the Nginx Server. Real Browser Monitoring (RBM) RBM requires network connectivity between the EUM agent and the Applications Manager server. This network connectivity can be ensured with the help of the VPN or NAT or by assigning an direct IP Address to the Applications Manager server. In the case where an agent is deployed within the local network and another one in a remote site, a dual NIC or any one of the above means would be required to ensure this connectivity. Note: Playback using Microsoft Edge WebDriver is supported only in the End User Monitoring (EUM) Agent installed on Windows Server with Microsoft Edge (versions 17 & above) support. Playback using Google Chrome WebDriver is supported only in the End User Monitoring (EUM) Agent installed on Server with Google Chrome (versions 65 & above) support. For any further support please contact appmanager-support@manageengine.com. You can visit Troubleshooting details. Webpage Analyzer Following the steps to be done for setting up Webpage Analyzer monitor : Download the add-on for Webpage Analyzer. After downloading, extract the zip file contents into /working directory.Following are the components that can be found in the ZIP file of the add-on, which are required for data collection in Webpage Analyzer: Mozilla Firefox v81: Used as the browser in which the webpage is loaded. Gecko Driver: Used as a proxy that is used to communicate with Firefox. PageSpeed Insights: Used to retrieve PageSpeed results. Extension: Used to capture various performance metric data. Note: Without the add-on, Webpage Analyzer monitors webpage similar to that of the HTTP URL monitor, with the exception that only the main URL will be monitored and not the underlying page components. To install PageSpeed Insights in Linux, open the terminal from /working/wpaAddons/PageSpeedInsights directory and execute the following command: chmod a+x pagespeed_bin Real User Monitor To learn how to set up Real User Monitoring in Applications Manager, refer here. ManageEngine ADManager Plus Mode of Monitoring: Remote JMX Prerequisites for monitoring ManageEngine ADManager Plus: 1. Add below entries in wrapper.conf (D:\ManageEngine Products\ADManager Plus\conf\wrapper.conf) or run.bat (D:\ManageEngine Products\ADManager Plus\bin\run.bat) file: #Enable Remote JMX wrapper.java.additional.16=-Dcom.sun.management.jmxremote wrapper.java.additional.17=-Dcom.sun.management.jmxremote.port=1999 wrapper.java.additional.18=-Dcom.sun.management.jmxremote.ssl=false wrapper.java.additional.19=-Dcom.sun.management.jmxremote.authenticate=false 2. To monitor PGSQL DB, implement the following changes: D:\ManageEngine Products\ADManager Plus \pgsql\data\postgresql.conf Uncomment and update ip address: listen_addresses = ''172.22.168.171'' D:\ManageEngine Products\ADManager Plus \pgsql\data\pg_hba.conf # IPv4 local connections: #host all all 127.0.0.1/32 trust host all all 0.0.0.0/0 trust D:\ManageEngine Products\ADManager Plus\conf\database_params.conf Update the hostname/ipaddress instead of localhost . For PGSQL/MSSQL database, Statistics will be collected by connecting to the database. ManageEngine ServiceDesk Plus Prerequisites: To monitor PGSQL DB, implement the following changes: C:\ManageEngine\ServiceDesk\pgsql\data\postgresql.conf Uncomment and update ip address: listen_addresses = ''172.22.168.171'' C:\ManageEngine\ServiceDesk\pgsql\data\pg_hba.conf # IPv4 local connections: #host all all 127.0.0.1/32 trust host all all 0.0.0.0/0 trust Update the hostname/ipaddress instead of localhost  in \ServiceDesk\server\default\deploy\postgres-ds.xml file.ManageEngine OpManager Mode of Monitoring: Remote JMX For PostgreSQL DB, statistics will be collected by connecting to the database. Prerequisites for monitoring ManageEngine OpManager: For Windows: In Service Mode: 1. Add below entries in wrapper.conf file. C:\ManageEngine\OpManager\conf\wrapper.conf # Enable Remote JMX wrapper.java.additional.16=-Dcom.sun.management.jmxremote  wrapper.java.additional.17=-Dcom.sun.management.jmxremote.port=1999  wrapper.java.additional.18=-Dcom.sun.management.jmxremote.ssl=false  wrapper.java.additional.19=-Dcom.sun.management.jmxremote.authenticate=false  wrapper.java.additional.20=-Dcom.sun.management.jmxremote.rmi.port=1999  wrapper.java.additional.21=-Djava.rmi.server.hostname= In Non-Service Mode: Append the following parameters to JAVA_OPTS: set JAVA_OPTS= %JAVA_OPTS% -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1999 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.rmi.port=1999 -Djava.rmi.server.hostname= For Linux: Add the following entry in run.sh: JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=1999 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.rmi.port=1999 -Djava.rmi.server.hostname= " 2. To monitor PostgreSQL DB, do the following changes: Open postgresql.conf file under /data directory. Check the value of the configuration parameter listen address. It should be "*". Click here for more details on configuring postgresql.conf Open pg_hba.conf under /data Add a new line ''host all all 0.0.0.0/0 trust'' to allow all the machines with proper password authentication to acces PostgreSQL database server. Click here for more details on configuring pg_hba.conf file. Open C:\ManageEngine\OpManager\conf\database_params.conf file. Update the hostname/ipaddress instead of localhost. Converged Infrastructure Cisco UCS Cisco UCS Manager should be installed and running while adding a Cisco UCS monitor.Configuring Cisco UCS Manager: Refer to the following links to learn more about configuring Cisco UCS Manager. https://www.cisco.com/c/en/us/products/servers-unified-computing/ucs-manager/index.html https://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/ucs-manager/GUI-User- Guides/Getting-Started/4- 1/b_UCSM_Getting_Started_Guide_4_1/b_UCSM_Getting_Started_Guide_4_1_chapter_0100.html https://www.cisco.com/c/en/us/products/collateral/servers-unified-computing/ucs- manager/whitepaper_c11-697337.html aks Understanding Applications Manager Applications Manager is a web-based monitoring tool that manages the performance of applications, servers, databases, systems, services, websites, and JMX/SNMP-based custom applications in a complex IT infrastructure. You can find seven module tabs at the top which are explained as follows: Intro Introduction Page of Applications Manager. It gives an overview of the working of Applications Manager. Home Has four views: Summary, Business View, Availability and Performance Summary: Has a dashboard that shows the health and availability of all the Monitor Groups in a snapshot . Lists all the Monitor Groups created and their details and graphical representation of the Monitor Group with most critical alarms. Recent 5 alarms can be also be viewed.Business View: The business view provides you a graphical snapshot of the entire business infrastructure which is being monitored. This view displays the various Monitors associated to Monitor Groups along with its health and availability.Availability: Gives the Availability history of the Monitors/ Monitor Groups in a snapshot. You can get the data for either the last 24 hours or the last 30 days.Performance: Gives the Health history and events of Monitor/Monitor Groups in a dashboard. You can get the data for either the last 24 hours or the last 30 days (excluding today).Custom Dashboards: Apart from the already available dashboards, you can create your own custom dashboards by using different widgets. Monitors Lists all the Monitor Typessupported and provides the number of Monitor being discovered in the network. You can also click on the Monitor Types to view information of their Monitors. On clicking the Monitor Types, you can view the Availability Dashboard, Performance Dashboard and the List View that shows the performance attributes of the Monitor in detail. Alarms Lists the alarms generated by the Monitor and their attributes, based on predefined thresholds. The view is customizable such that you can view alarms for all or for particular application or Monitor Type, list 10/25/50/75/100/125 entries in a single view, etc. Reports Lists the Monitor Groups and the different Monitor Types for which the reports are generated. Reports can be viewed based on attributes listed for the corresponding Monitor Type. Support Provides information on getting assistance from the Applications Manager Technical center. It also provides monitoring information on Applications Manager which monitors itself. Admin Lists the admin operations such as creating new application, new Monitor, etc. to be performed for monitoring. The left frame consists of links for easy navigation and the top frame consists of links such as Talk back, Help, Personalize etc. common in all the screens. To know more details on these links and icon representation, refer to the Web Clientsection. The various tables in the web client can be dragged and arranged as per your requirement Note: Have a look at Getting Started - How to Demosfrom Website. Monitor Views Under Monitor tab, you can see all the monitors listed down in the Select View drop-down menu in the right-hand corner. There are eight different views: Bulk Configuration View Category View Plasma View Monitor Group ViewWorld Map View Icon View Table View Business View Bulk Lists all the details of the monitors that are monitored. From this view you can carry out bulk Configuration admin operations like updating user name and passwords across monitors. Refer Bulk View Configurationfor further details. Category View Lists the monitors according to the various categories like Applications Servers, Database Servers etc. Business View In this view, the Monitors will be arranged in an default order.You can re-arrange the Monitors and click on the floppy disk icon to save the view. You can also zoom in and out of the view, and save the zoom level which is optimal for your viewing. Business View has the following properties.You can edit the view by clicking on Settings icon and selecting the Edit View from the menu to open a Customizable Business View page: View Properties Update Monitor - This setting allows you to refresh the status of the Monitors and Monitor Groups automatically by fixing some limited time (in minutes). Reload Interval - This setting is similar to Update Monitor except that it will reload the entire view after the given time. The recommended interval would be 15 minutes. Check the Show Label for Monitors checkbox to show the labels for various monitors. Associated Monitor Groups - This setting allows you to add various Monitor Groups to your view. This is only available for the "Customizable Business View". Under View Properties, by selecting Show only Monitor Groups and Sub Groups allows you to include the Monitor Groups and Sub Groups in the selected view. By selecting Show only Critical Monitors you can show only critical Sub Groups and Monitors inside the selected view. By selecting Show only Monitor Groups Status you can show the status of  top level Monitor Groups (that are selected via Associated Monitor Groups) in the selected view. You can create multiple views for a Monitor Group. Click on the Settings icon in the business view and select Create New View. By providing various details like Update Monitor time interval, Reload interval, opting to select Monitor and Monitor Groups and Sub Groups you can create a custom view. In addition, you can also edit its apperance of the view . Go to the Display Properties tab and provide the following details: Background color Line Color Label Color Line Thickness Line Transperancy Publishing the View: Applications Manager allows you to embed these Business View in intranet/internet portals by selecting the menu option ''Publish The View'' from Settings and copy the iframe details and pasting it in the webpages. World Map View Applications Manager, integrated with online map services, provides network traffic information at a geographical dimension. By using online map API features, Applications manager provides different levels of abstraction in the network data visualization.Refer to World Map View for further details. Icon View Lists all the monitors using icons, shows the host and the monitors assosciated with it symbolically Table View Lists the monitors within the host in a tabular format. Plasma View The plasma view enables you to have a snapshot of what is happening with the monitors, at one glance. The view can be put up on a plasma screen, and you can have a look even when you are not in front of the monitor.The ''Customize View'' option available in the top right hand corner, gives you the option to customize the layout. By checking the option “Play sound alarm for critical events”, you can get notified/ warned of the critical events by sound alarms. Monitor Group Lists all Monitor Groups and the Sub-Groups available. You can associate Monitors, Copy View Paste Monitor, configure alarms through this Monitor Group View itself. (as like Bulk Config view). In addition, you can enable or disable actions via this view itself, i.e, even if you have already configured actions like sending EMail, through ''disable action'' you can prevent EMail action.  Working with Applications Manager The following are the steps involved in monitoring: Create a new Monitor Group: Create a new Monitor Group by grouping one or more Monitors. Create new Monitor: Discover Monitors in the network and start collecting data (performance metrics, availability etc) for the same. Create new Monitor Type: Create new monitor type for monitoring custom applications. Associate Monitor with Monitor Group: Add the discovered monitors to the Monitor Group. Create threshold profile: Create thresholds to identify the status of a specific attribute. Create actions: Specify what action needs to be taken in the event of an alarm. Associate threshold and action with the attributes: Associate the thresholds and action to generate alarms and perform action based on the threshold definition. Configuring dependencies: Dependencies specify the rule based on which the severity of health and availability is determined. For example, Health of a Tomcat Server may depend on the overall response time of the server or on the response time of each of the web applications deployed on the server etc. By configuring dependencies, you can determine the attribute, based on which the severity of health changes. Note: Have a look at Working with Applications Manager - How to Demos from the website. Please go through Working with Monitor Group and Configuring Alarms for detailed information on the above. See Also Best Practices Guide     Working with Monitor Groups Monitor Groups are a logical group of one or more monitors that provides a holistic view of your business environment. For example, the health of an online Web application depends on various factors, such as the health of the application server hosting the Web application, the availability of the Web server for accessing the Web applications, the database server for storing or getting the required information, etc. These web applications and services can be grouped together and monitored as a single Monitor Group. Troubleshoot: For any monitoring-related troubleshooting, refer to the online Troubleshooting section. Browse through the following topics to work with Monitor Groups: Creating Monitor Groups Creating Web Application Groups Creating New Monitor Associating Monitors to Monitor Groups Deleting Monitor from Monitor Groups Editing and Deleting a Monitor Group VMware Virtual Infrastructure Groups Associating Monitors to Monitor Groups To associate a Monitor/Process/Service/Database to a Monitor Group, follow the steps given below:Click on the Monitor Group (from Home tab). Under Monitor Group Information, click Associate Monitors link. A list of discovered Monitors/Processes/Services/Databases that are available for associating and those that have already been associated with that Monitor Group is displayed. Note : The status of Monitor Group would remain unknown, until you associate at least one monitor to it. Select the check box of the corresponding monitor from Monitors not present in this Monitor Group list and click Add. You can also remove a monitor which has already been associated with the Monitor Group by selecting the check box of Monitor(s) under Monitors present in this Monitor Group and clicking Remove. Note : In order to add Processes, Services and Databases to Monitor Groups, go to Admin → Server Settings → Monitor Group Settings tab and enable appropriate monitor options (Process/Service/Database) prior to performing the action. On disabling these options, the Processes/Services/Databases associated previously can only be removed manually from the Monitor Group. When a Process, Service or Database is down, the RCA for the Monitor Group will display the Process/Service/Database name along with the Server Display name. Creating Monitor Groups This section explains how you can create a new Monitor Group. A monitor Group is particularly useful for grouping the resources of a location say the resources available in sales office or for grouping the resources used by a business application. Applications Manager provides two types of monitor groups - Monitor Group and Web Application Group. The steps to create a Monitor group are explained below. To create a web application group, refer this link. To create a new Monitor Group, follow the steps given below: Click New Monitor Group. Provide a Monitor Group Name. This is mandatory and only alphanumeric characters, dashes (-), underscores (_), periods (.), and spaces ( ) are allowed. Provide any Description, if required. Under Advanced Options, Select the Owner from the list of users created. Refer User Administration topic for more information on the different roles of users. Note: Operator if associated as an owner will have Read Only Access to that particular Monitor Group alone. Admin user is a super user and will be able to see all Monitor Groups. Manager if associated will be able to view this Monitor Group in Manager Console. Using this option, Restricted Monitor Groups alone can be shown in Manager Console. [By default, if the Manager is not explicitly associated to a Monitor Group, the Manager will be able to access all the Monitor Groups in the Manager Console] Select the location for associating the monitor group to World Map Business View. Clicking on Add Location will open up the world map wherein you can select and add custom locations. You can also delete or edit the added locations, if required. Note: Delete and edit location options are applicable only for Admin users. Click Finish to create the Monitor Group and to add Monitors later. How To Demos: Have a look at our demo on creating Monitor Group in our website. Creating a Sub-Group within a Monitor Group By using this option, you can create a Monitor Sub-Group within a Monitor Group (a Monitor Group within a Monitor Group). Sub-Groups help better organization of your resources. With Sub-Groups, you can capture advanced dependencies in your infrastructure. You can group clustered databases or servers and create complex groups. For eg., A huge banking application Monitor Group may contain 100 monitors (application servers, systems, databases, URLs, etc.,). All the database monitors can be grouped under a Sub-Group for effective monitoring. To create a sub group, follow the steps given below: Inside the Monitor Group Details page, click on the Monitor Group Actions button in the top right-hand corner. Click the New Sub-Group option under Monitor Group Actions. Give the Sub-Group name and the description.Set a group type and the location of the group. (optional) Click on Create Sub-Group. Then you can associate the desired monitors to the Sub-Group. Note: You can create up to six levels of sub-groups in a Monitor Group, by default. Creating New Web Application Group Once you create a web application group, you can view the health of the sub groups and know how each individual sub group is performing. If there is a problem in the web application group, you can drill down and identify which component is having a problem.The details page shows the health of all the tiers as components giving you a better perspective of the Application''s Performance and Availability. You can also configure dependencies and powerful alarm rules for intelligent alert correlation. To create a new web application group, follow the steps given below: Click New Monitor Group and select Web Application Group from the drop-down menu. Provide a Name for the Monitor Group. This is mandatory and only alphanumeric characters, dashes (-), underscores (_), periods (.), and spaces ( ) are allowed. Provide a Description, if required. Select the Owner from the list of users displayed. Refer User Administration topic for more information on the different roles of users. Note: Operator if associated as an owner will have Read Only Access to that particular Monitor Group alone. Admin user is a super user and will be able to see all Monitor Groups. Manager if associated will be able to view this Monitor Group in Manager Console. Using this option, Restricted Monitor Groups alone can be shown in Manager Console. [By default, if the Manager is not explicitly associated to a Monitor Group, the Manager will be able to access all the Monitor Groups in the Manager Console] Select Web Application Group as the group type. Select the Application Components from the options displayed. The components available are End User Transaction (URL) group, Network devices group, Edge Devices group, Web Server Group, Application Server Group, Database Group and Server Group. The components that you select will be automatically added as sub groups within the web application group. Select the Location for associating the monitor group to World Map Business View under Advanced section. Otherwise, click the ''Add Location'' link and select custom locations from the google map that opens up. Click Create Monitor Group button to create the Web Application Group. You can add monitors any time using the Associate Monitors option. Note: You can convert a web application group to a monitor group or vice versa by changing the Group Type. Click Monitor Group Options link from the web application group page and select the Edit option. This will take you to the Modify Monitor Group section. You can modify the Group Type values from this screen. Creating a Sub-Group within a Web Application Group If you have selected ''Application Components'' while creating the web application group, the sub groups will be automatically created based on the options you have selected. You can also add sub groups later on by following the steps given below. Click the Monitor Group Actions->New Sub-Group option inside the Web Application Group Details page. Provide the Sub-Group Name, Description and select the Owner from the list of users. Select the Group Type from the dropdown box. Select the Location for associating the sub group to from the drop-down box. You can also use the ''Add Location'' option to specify custom locations from google map. Click the Create Sub-Group button to create the sub group. You can then associate the desired monitors to the Sub-Group. Note: You can create up to six levels of sub groups for a web application group, by default. Deleting Monitor from Monitor Groups To delete a monitor from a Monitor Group,Click on the Home tab to display the list of Monitor Groups created. Click over the Monitor Group from which the Monitor has to be deleted. Data of all Monitors in that Monitor Group is displayed graphically. Click Remove from Group. This deletes the monitor only from the Monitor Group but its monitoring will not stop. Deleting monitor from Applications Manager To delete a monitor from getting monitored by Applications Manager itself, follow the below given steps: Click over the Monitors tab. From Select View combo box, select Bulk configuration view. All the Monitor Types are listed. Select the check box of the monitor to be deleted and click Delete. Editing and Deleting a Monitor Group To edit a Monitor Group, Click the Home module tab to display the list of Monitor Groups created. Click the Monitor Group to be edited. On the Left-side Monitor Group Links, click Edit. By editing the monitor group, you can change the Name, Description, Owners and the Country (location) associated. To delete a Monitor Group, Click the Home module tab to display the list of Monitor Groups created. Click the Monitor Group to be deleted. On the Left-side Monitor Group Links, click Delete. Note: In simple layout, the left side links will not be persent. In this case, move to Monitors tab, under Select View drop down box, select Monitor Group view. Select the Monitor Groups you want to delete, then select the Delete action from the dropdown. However, the Monitor pertaining to the corresponding Monitor Group will not be deleted. You will still be able to view the details of the Monitor that was associated with the Monitor Group. To delete the Monitor, refer to the Deleting Monitor from Applications Manager section. VMware Virtual Infrastructure Groups Applications Manager can discover your entire VMware virtual infrastructure through the vCenter server and provide dependency mapping of its components. The ‘VMware Virtual Infrastructure Group’ allows you to quickly discover all your virtual resources and model them the same way they are configured in the vCenter server. The VMware infrastructure will be automatically categorized into components such as Datacenter, Cluster, ESX/ESXi hosts, VMs, etc. Once you discover the virtual infrastructure, you can easily track the availability, health and performance metrics of its various components. The VMware virtual infrastructure group is different from monitor groups due to the fact that you have to manually map all the resources to a monitor group. In the VMware virtual infrastructure group, the virtual resources in your network are automatically discovered through the vCenter server and the components mapped accordingly. When combined with the out-of-the-box support for 50+ applications, servers, databases, and transactions spanning physical, virtual and cloud infrastructures along with auto-provisioning of virtual systems, the VMware virtual infrastructure group becomes even more powerful. Creating a New VMware Virtual Infrastructure Group Follow the steps given below to create a VMware Virtual Infrastructure group: Click New Monitor Group and select VMware Virtual Infrastructure from the drop-down menu. The ‘Discover Virtual Infrastructure through vCenter’ screen will be displayed. Provide a Display Name for the monitor group. Specify vCenter Hostname/IP Address. Specify the Port at which vCenter is running. Enter the authentication credentials of the vCenter server such as User Name and Password.Specify the Polling Interval in minutes. Select the VM Discovery option based on which the virtual machines present under the vCenter Virtual Infrastructure should be discovered and monitored. The available options are Do not discover, Discover VM but do not monitor metrics, and Discover and Monitor VM metrics. For Discover VM but do not monitor metrics and Discover and Monitor VM metrics options, you can also specify the Discovery Filter Regex based on which the virtual machines are to be discovered and monitored. Learn more If you are adding a new monitor from an Admin Server, select a Managed Server. Click Fetch ESX Hosts button to start the virtual infrastructure discovery. For more information on the performance metrics provided by the VMware virtual infrastructure group, refer this topic. Performance Metrics Browse through the below topics to learn about monitoring performance metrics in Applications Manager: Creating a new monitor Viewing Performance Metrics Creating a New Monitor Once a new Monitor Group is created, the Monitors such as WebLogic Server, JBoss Server, Tomcat Server, WebSphere Server, MySQL DB Server, Oracle DB Server, Mail Server, etc. must be created. This discovers the Monitor from the network and starts collecting data for monitoring. You have to create a Monitor to discover it from the network and monitor it. This can be done by following any of the options given below: All Monitors in a host. A specific Monitor in a host. All Monitors in a network Note: The displayname of the monitor can have any alphanumeric characters except for the following: The following reserved characters: < (less than) > (greater than) : (colon) " (double quote) '' (single quote) / (forward slash) \ (backslash) ? (question mark) % (percentage) * (asterisk) ` (backtick) Integer value zero, sometimes referred to as the ASCII NUL character. If there is a problem while creating new monitors, click on Diagnose link to troubleshoot the problem. All Monitors in a Host To discover all Monitors running on a host, create them using the All Monitors option. Follow the given steps for discovering the Monitor: Select New Monitor. Choose All Services.Provide the hostname, where all the monitors running on this host will be discovered. You can also discover monitors in multiple hosts by providing the hostname, separated by commas. (Note: This will start discovering in the default port of the Monitor.) Enter the Subnet Mask of the network. Click Add Monitor(s). Note: Adding any service will also automatically add that server and other applications in the default port in that server. How To Demos: Have a look at our demo on creating Monitors in our website. Viewing Performance Metrics Applications Manager is used to monitor different types of applications and services of Monitor running in your system/ network. Monitoring is an activity that checks the performance of your monitors by collecting and analyzing the data at regular intervals. These monitoring capabilities are performed by different types of Monitor Types. This chapter lists the different types of Monitor Types supported by Applications Manager and the parameters monitored by them. Monitor Types Applications Manager supports the following Monitor Types: Application Servers Microsoft .NET JBoss Servers Jetty Servers GlassFish Servers Oracle Application Servers Resin Application Server SilverStream Tomcat Servers VMware vFabric tc Servers WebLogic Servers WebSphere Servers Apache Geronimo Cloud Apps Amazon Amazon Elastic Compute Cloud (Amazon EC2) Amazon Relational Database Service (Amazon RDS) Amazon Simple Notification Service (Amazon SNS) Amazon DynamoDB Windows Azure Open Stack Microsoft 365 Oracle Cloud Infrastructure (OCI) Google Cloud Platform (GCP) Database Servers Cassandra Servers CouchBase Servers IBM DB2 ServersIBM Informix Servers Memcached Servers MongoDB Servers MS SQL Servers MySQL/MariaDB Servers Oracle Servers PostgreSQL Servers Redis Servers Sybase ASE/SAP ASE/Sybase SQL Server Oracle NoSQL SAP HANA DB Servers Middleware / Portal Microsoft BizTalk Microsoft Message Queue (MSMQ) Microsoft Office SharePoint Oracle Tuxedo VMware vFabric RabbitMQ WebLogic Integration Servers IBM Websphere Message Broker IBM WebSphere MQ Microsoft Skype for Business Server Azure Service Bus Apache Kafka Apache ActiveMQ Servers Windows Linux Solaris IBM AIX IBM i HP Unix Tru64 Unix Free BSD Mac OS Novell Windows Cluster Services JMX Applications Ping Monitor Service Monitoring SNMP / Network Device Telnet Hadoop Monitor Active Directory DNS Monitor FTP / SFTP MonitorLDAP Monitor Ceph Storage Apache Zookeeper Oracle Coherence Servers Mail Servers Exchange Server Mail Server Web Server / Services Apache Server IIS Server Nginx Real Browser Monitor PHP Web Services Web Server HTTP(s) URL Monitors and HTTP(s) URL Sequence (Record & Playback) Elasticsearch ServiceDesk Plus ManageEngine OpManager ERP SAP SAP CCMS Oracle E-Business Suite Microsoft Dynamics CRM / 365 (On-Premise) Virtualization Microsoft Hyper-V Servers VMware ESX/ESXi servers VMware Horizon View Connection Broker Citrix XenApp Citrix Xenserver Docker Custom Monitors JMX / SNMP Dashboard File System Monitor Windows Performance Counters Script Monitor Database Query Monitor Web Transactions Monitors JavaRuby on Rails .NET Others Java Runtime Monitor Monitor Types Applications Manager supports monitoring for the following monitor types: Application Servers Cloud Apps Custom Monitors Database Servers | NoSQL Database Servers ERP Mail Servers Middleware/Portal Servers Virtualization Converged Infrastructure Web Server/Services Services Application Servers Application Servers are designed to develop web services and applications, and in real time, the productivity and performance of such servers get affected due to failure of diagnosing any problem in the services/application running in the server. Applications Manager enables high performance business process management by detecting and diagnosing problems of application servers and their services faster. The following are the application servers supported:  Microsoft .NET GlassFish Servers JBoss Servers Jetty Servers Resin Servers Oracle Application Servers SilverStream Tomcat Servers VMware vFabric tc Server WebLogic Servers WebSphere Servers Apache Geronimo Servers Please browse through the different application servers that provide the server information and their parameters being monitoring. Java Runtime Monitors Java Runtime Monitoring - Overview Java Runtime Monitor provides out-of-the-box remote monitoring and management on the Java platform and of applications that run on it. It monitors performance metrics like Memory (JVM), Garbage Collection (GC) andThread Statistics. Thresholds can be associated and alarms generated. Further, operations such as Automated Thread dump, Heap dump and PerformGC for management are also supported. The different JVM vendors supported by Applications Manager are Sun JVM, IBM JVM and Oracle JRockit JVM. In this help document, you will learn how to get started with Java monitoring along with the list of parameters that are monitored using Applications Manager. Creating a new Java Runtime monitor Prerequisites for Java Runtime Monitor: Know more about the JVM arguments to add to your application for Java Runtime Monitoring Using the REST API to add a new Java Runtine monitor: Click here Click New Monitor. Choose Java Runtime. Enter the IP Address or hostname of the host in which the Monitor is running. Enter the SubNetMask of the network. Provide the port number in which JDK is running (default: 1099). Also, you can provide multiple ports separated by commas. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. If you wish to enter your own credentials, specify username and password details for this monitor. Enter the JNDI name. For example, /jmxrmi. To enable customized JMX URL, check the Enable JMX URL checkbox and enter the JMX URL. (The URL should be of the format service:jmx:rmi:///jndi/rmi://HOST:PORT/jmxrmi. For example, a jboss customized jmx URL can be - service:jmx:remoting-jmx://HOST:PORT/ and a websphere customized jmx URL - service:jmx:wsrmi://HOST:PORT/) If Authentication is enabled, enter the username and password. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group, to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitors from the network and starts monitoring them. Note: Support is available for JRE1.5 and above for Java Runtime. Support for Heap dump operation is available if HotSpotDiagnostic MBean is present in the JVM. Support given for JDK 1.8 : When monitoring with JDK 1.8 MetaSpace, Applications Manager monitors and displays new memory space called MetaSpace and Compressed Class Space instead of the former Permanent Generation (Non-Heap). In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Monitored Parameters Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Java Runtime Monitor checks the availability, response time, connection time (time taken by the Applications Manager to look up the JMX agent on the remote JVM) of the monitor, along with many other parameters listed below. Overview Garbage Collection Threads Configuration Overview Parameter Description Monitor Information Name Name of the JavaRuntime monitor. Health Specifies the health (Clear, Warning, Critical) of the JavaRuntime monitorType Specifies the type you are monitoring. Host Name Specifies the host at which the Java virtual machine is running. Port Specifies the port number at which the Java virtual machine is running. Host OS Specifies the OS of the host where the JavaRuntime monitor is running. JVM Specifies the Java virtual machine name and version. Vendor Specifies the Java virtual machine Vendor Name. Processor Count Specifies the number of processors available to the Java virtual machine. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the JavaRuntime monitor - available or not available. Connection Time Time taken to connect to the Java virtual machine. Memory Pool Eden Space (Heap Memory) The pool from which memory is initially allocated for most objects. Survivor Space (Heap Pool containing objects that have survived GC of eden space. Memory) Tenured Generation (Heap Pool containing objects that have existed for some time in the survivor space. Memory) Java Heap Space where the JVM stores the objects. Permanent Generation Holds all the reflective data of the virtual machine itself, such as class and method (Non-Heap) (for versions objects. With JVMs that use class data sharing, this generation is divided into read- older than JDK 1.8) only and read-write areas. The Native memory space for the representation of class metadata is called MetaSpace (for JDK 1.8) Metaspace. MetaSpace use native memory to store meta-data and that grows automatically. Compressed Class Compressed Class Space contains only class metadata. Space (for JDK 1.8) Code Cache (Non-Heap) Memory used for compilation and storage of native code. JIT Code Cache Memory that is converted to assembler and stored for running at higher speed. Nursery Separate space for newly allocated objects. Class Loading Classes loaded Number of classes loaded Classes Unloaded Number of classes unloaded JVM Statistics Specifies the percentage of load on the machine caused by the JVM. CPU Load 0 indicates no load is created and 100 indicates all load is created by the JVM CPU Usage This indicates the CPU usage of the JVM on the server. Max file descriptor Maximum permissible open file descriptor. Available only for UNIX. Host Memory Total Physical Memory Total amount of physical memory in Megabytes. Free Physical Memory The amount of free physical memory in Megabytes. Total Swap Space Total amount of swap space in Megabytes. The amount of virtual memory that is guaranteed to be available to the running Committed Virtual Memory process in Megabytes. Garbage Collection Parameter Description Garbage Collector Time Spent/Min Approximate collection elapsed time in milliseconds. Collections/Min Total number of collections that have occurred. Thread Count Number of threads used for Garbage Collector.Last Start Time Start time of this GC. Last End Time End time of this GC. Memory usage before GC Memory usage of all memory pools at the beginning of this GC. Memory usage after GC Memory usage of all memory pools at the end of this GC. GC time Time taken to perform garbage collection. Compile time Time spent in just-in-time (JIT) compilation. Threads Parameter Description Thread Parameters Total threads Total number of threads created and also started since the Java virtual machine started. started Peak Threads Peak live thread count since the Java virtual machine started or peak was reset. Live Threads Number of live threads currently running. Daemon Threads Number of daemon threads currently running. Runnable Threads A thread executing in the Java virtual machine is in this state. Blocked Threads A thread that is blocked waiting for a monitor lock is in this state. A thread that is waiting indefinitely for another thread to perform a particular action is in this Waiting Threads state. Timed waiting A thread that is waiting for another thread to perform an action, for up to a specified waiting Threads time is in this state. Deadlocked Number of threads that are in deadlock waiting to acquire object monitors. Configuration Parameter Description Configuration Information Uptime The uptime of the Java virtual machine. Java Virtual Machine The Java virtual machine implementation name. Vendor The Java virtual machine implementation vendor. The process identifier is a number used by some operating system kernels to uniquely Process ID identify a process. Name The name representing the running Java virtual machine. The input arguments passed to the Java virtual machine which does not include the VM arguments arguments to the main method. Class path The Java class path that is used by the system class loader to search for class files. Library path The Java library path. Boot class path The boot class path that is used by the bootstrap class loader to search for class files. JIT compiler The name of the Just-in-time (JIT) compiler Objects Pending for The approximate number of objects for which finalization is pending. finalization Operating System The name of the operating system. Architecture The operating system architecture. Processors The number of processors available to the Java virtual machine. The maximum metaspace containing all other large class metadata including methods, Max Metaspace bytecode ,constant pool etc. Max Non Heap = Commit Non Heap + free Physical Memory. Max non-heap Note: In case of Virtual Memory also, we consider only Free Physical Memory to calculate Max Metaspace value.The table below lists the different JVM vendors supported by Applications Manager and the major parameters monitored by them. Parameters Monitored Sun JVM IBM JVM JRockit JVM Connection Time Memory Usage CPU Usage   CPU Load     System Memory Process Memory Heap Memory Non Heap Memory VM Statistics Total Physical Memory   Free Physical Memory   Total Swap Space     Free Swap Space     Committed Virtual Memory     Garbage Collector- Summary Garbage Collector - View impact for specific collector     Total Threads Started Peak Threads Live Threads Runnable Threads Blocked Threads Waiting Threads Timed Waiting Threads Daemon Threads Deadlocked Configuration Details JVM Actions View Thread Dump There is an option to view the thread dump history under ''Threads'' tab. Click the ''View Thread Dump'' link in the threads tab. The Thread Dump screen will open up in a new window and you will be able to view the current thread dump details. Once you close this window, the thread dump details will be moved under the Thread Historysection. You can view this information any time you want from this section. Reports We provide the option to view both realtime and historical data of any of the attributes present in the ''Configuration Information'' section in the Configuration tab. Click on any attribute under the Configuration tab. This will open up a new window named ''History Data'' that provides more information about these attributes. There are two tabs in the History Data window - History Report and Global View History Report: This tab provides historical reports of the attribute selected based on time period chosen. You can also use the Select Attribute drop-down box and view reports for other attributes. Global View: This tab displays the current values of the attribute selected, across multiple monitors. To view information about other attributes present in the monitor, use the Select Attribute drop-down box and change the attribute. If you want to view data of multiple attributes, click the Customize Columns link present at the top left corner of the window. This will take you to the Edit Global Viewscreen. In this screen, you can change the monitor type using the Filter by Monitor Type drop-down box, select the metrics to be displayed, and show monitors on a monitor basis or a monitor group basis. After you select your options, click the Show Report button to view those information in the Global View tab.Note: If jmx connection is not being established in the machine where Applications Manager is installed, use this key and restart your application: -Djava.rmi.server.hostname=YOUR_IP Help Links for Reference Tuning Garbage Collection with the JVM FAQ About the Java HotSpot VM FAQ about Garbage Collection in the Hotspot JVM Java Performance Documentation Microsoft .NET Monitoring Creating a new .NET monitor To create Microsoft .NET Monitor Click on New Monitor link. Select Microsoft .NET Monitor. Enter the IP Address or hostname of the host where .NET runs. Enter the SubNetMask of the network. Set the Polling Interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Enter the User Name / Domain Name  and Password  of the system. Choose the Monitor Group from the combo box with which you want to associate .NET Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers .NET from the network and starts monitoring them. Monitored Parameters Microsoft .NET is monitored based on the attributes such as Heap Size, Threads etc. Data collection happens through WMI. The monitoring details of Microsoft .Net are represented graphically and that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored by the .Net, based on these details. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Parameter Description Availability Shows the current status of the .NET - available or not available. Threads Shows the number of native OS threads created and owned by the CLR Physical Threads to act as underlying threads for .NET thread objects. Logical Threads Shows the number of current .NET thread objects in the application. Memory Heap Size Shows the current memory allocated(MB) Shows the percentage of elapsed time that was spent in performing a garbage collection (GC) since the last GC cycle. This counter is usually an indicator of the work % Time in GC done by the Garbage Collector on behalf of the application to collect and compact memory Locks Queue Length Refers to the total number of threads currently waiting. Refers to the rate at which threads in the runtime attempt to acquire a managed lock Contentions/Min unsuccessfully. Exceptions Exceptions/Min Refers to the number of exceptions per Minute SecurityTotalRuntimeChecks/Min Refers the total number of runtime Code Access Security (CAS) checks performed per minute. JIT Refers to the percentage of elapsed time spent in JIT compilation since the last JIT % Time In JIT compilation phase. .NET Applications Details Name Name of the .NET Application. Active Sessions Refers to number of sessions that are active currently Requests/Min Refers to number of Requests executed per minute .NET Applications Details Clicking on the Names of the .NET applications, you can see their performance based on their parameters. The various .NET application''s parameters that are monitored are: Parameter Description Request Statistics Requests/Min Refers to number of Requests executed per minute Errors/Min Refers to rate of errors occured Requests Timeout/Min Refers to number of Requests Timeout per minute Queued Requests Refers to number of Queued Requests Transactions Transactions/Min Refers to number of Transactions started per minute Abandoned Refers to number of Transactions aborted per minute Transactions/Min Pending Transactions Refers to number of Transactions in progress Sessions Active Sessions Refers to number of sessions that are active currently Network Traffic Bytes Sent/Min Bytes Received/Min Refers to the number of Refers to the number of Bytes received per minute Bytes sent per minute GlassFish Servers Creating a new GlassFish monitor Prerequisites for monitoring GlassFish metrics: Click here Using the REST API to add a new GlassFish monitor: Click here Follow the steps given below to create a new GlassFish application server monitor: Click on New Monitor link. Select GlassFish. Enter the Display name. Enter the HostName of the host where GlassFish runs. Enter the Port Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Enter the JNDI path. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate GlassFish Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers GlassFish Servers from the network and starts monitoring them. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP]Monitored Parameters Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configuration. GlassFish servers are monitored based on the attributes such as memory, thread, etc. The monitoring details of GlassFish server are represented graphically that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored by the server based on these details. Click on the individual monitors listed to view the following information: Monitor Information Performance Overview Monitor Information Parameter Description Name Name of the Server Availability Shows the current status of the server - available or not available. Last Polled at Specifies the time when the monitoring of the server was recently done Next Poll at Specifies the next polling time for monitoring the server Performance Overview Parameter Description RESPONSE TIME: Response Time Refers to time required for the Glass Fish server to respond while monitoring MEMORY DETAILS: Used Memory Refers to JVM heap used in KB Total Memory Refers to the JVM total heap size THREAD DETAILS: Thread Count Total number of Threads in JVM in which GlassFish is running Running Refers to the state of totals thread that are in runnable state in the JVM Waiting Refers to the total no. of threads that are waiting for a monitor lock in the JVM Blocking Refers to no. of total threads that are blocked waiting for a monitor lock Deadlocked Refers to the no. of total threads that are blocked forever in the JVM Refers the total threads that are waiting for another thread to perform Timed Waiting an action for up to a specified waiting time Webapp Monitoring: WebAppName Name of the Web Application Session High Count Maximum number of concurrently active sessions Session Current Count List of currently active sessions in the Web Application Total Sessions Rejected Total number of rejected sessions JDBC Pool Monitoring: Jdbc Pool Name Name of the JDBC pool Max Pool Size Maximum size of pool Connections Currently in Use Number of connections that are currently in use Connections Used % Number of connections used (in percentage). Free Connections Number of free connections Potential Leaked Connections Number of unauthenticated connections Wait Queue Length Size of wait queueConnections Timed Out Number of connections which were timed out JBoss Server Monitoring Creating a new JBoss monitor Supported versions of JBoss Server: 3.2.x, 4.x, 4.0.x, 5, 5.1, 6.0, 7.x, Wildfly_8.x Prerequisites for monitoring JBoss server metrics: Click here Using the REST API to add a new JBoss monitor: Click here To create a JBoss server monitor, follow the steps given below: Click on New Monitor link. Select JBoss. Enter the IP Address or hostname of the host where JBoss runs. Choose the JBoss version. Enter the port number for eg., 8080. Check the Is Domain option if the JBoss operating mode is in managed domain. For managed domain, provide the HOST and PORT of domain controller. All the servers in the managed domain is identified and automatically added as monitors. This option is available for version 7.x and above. Enable Filter: Choose this option to filter the addition of monitors for servers in the managed domain. Filter Condition: Select the option include/exclude and provide the filters in the following format: HostController1:server1,server2,server3 ; HostController2:server1,server2,server3;... Choose SSL option , if SSL is enabled in JBoss server. Enter the User Name and Password , if JBoss has authentication information. Set the Polling Interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate JBoss Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers JBoss server from the network and starts monitoring them. For Applications Manager to monitor JBoss, it should be able to access the host where JBoss server runs and vice versa. For more information, refer to online Troubleshooting section. Monitored Parameters Performance data is collected by deploying an agent automatically from Applications Manager to the JBoss server that needs to be monitored. JBoss servers are monitored based on the attributes such as JVM heap usage, JDBC pool usage, JMS Queue, the different web applications and EJB deployed in the server. The monitoring details of JBoss server are represented graphically that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored by the server based on these details. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configuration. Click on the individual monitors listed, to view the following information: Overview JVM Deployments Statistics JDBC Web Transactions JMS Configuration Custom attributes OverviewParameter Description SERVER RESPONSE TIME Response time Response time of JBoss server (in ms). JVM Usage This metric gives the current amount of free, used and committed memory in the JVM heap in megabytes as well as in percentage. Parameter Description Memory Usage Type of the memory pool i.e, (Heap memory , Non-Heap Memory, Code cache Type etc.) Used Memory in MB The amount of memory used by the Java Virtual Machine (in MB). Free Memory in MB The amount of memory free for the Java Virtual Machine (in MB). The amount of memory guaranteed to be available for use by the Java Virtual Committed Memory in MB Machine (in MB). Total Memory in MB The total amount of memory allocated for the Java Virtual Machine (in MB). Used Memory % The amount of memory used by the Java Virtual Machine (in percentage). Free Memory % The amount of memory free for the Java Virtual Machine (in percentage). JVM USAGE JVM Heap Size JVM heap size of JBoss server (in bytes). Maximum Free Memory (MB) Maximum amount of free memory available (in MB). Maximum Free Memory Maximum amount of free memory available (in percentage). THREAD USAGE Live Threads Number of threads that are currently in use. Daemon Threads Number of daemon threads available. Peak Thread Count The maximum number of threads in use at any point of time. Total Threads Started Total number of threads started. CLASS LOADING Class Loaded The number of classes currently loaded in the Java virtual machine. The total number of classes loaded since the Java virtual machine has started Total Class Loaded execution. Class Unloaded The number of classes unloaded since the Java virtual machine has started. Object Pending Finalization The approximate number of objects for which finalization is pending. Deployments Parameter Description Deployments Name Name of the deployment/war file. Context Context name of the web application. Enabled Indicates whether the deployment is enabled or not. (true or false) Runtime Name Runtime name of the deployment. Status The status of the deployment. Sub-Deployments The number of sub-deployments. Servlets The number of servlets present for the deployment. Web Applications Name Name of the web application. Context Context name of the web application. Active Sessions Number of sessions currently open/active.Created Sessions Number of sessions created. Expired Sessions Number of sessions expired. Rejected Sessions Number of sessions rejected. Duplicated Sessions Number of sessions duplicated. Session Alive Time (Avg) The average alive time of sessions (in ms). Statistics This tab contains the EJB statistics and Servlet details of the JBoss server. The name, type and module of the EJB along with the number of instance created and removed, instances in passivated state, pooled state, ready state are being captured. The servlet details specify the number of times the servlet was invoked and the execution time for the servlet. Parameter Description EJB Statistics Name Name of the EJB appended with the web module name. EJB Name of the EJB. Web Module Name of the web module. Type of EJB. (Any one of the following - "Stateless Session Bean", "Stateful Type Session Bean", "Entity Bean", "Message Driven Bean") Create count Number of EJB bean created. Removed count Number of EJB bean removed. Passive count Total number of beans that have been passivated. Ready count The number of bean instances in ready state. Method ready count The number of bean methods in ready state. Pooled count Number of EJBs available in the pool. Servlet Details Name Name of the servlet appended with web module name. Servlet Name of the servlet. Web module Name of the web module. The total number of times the servlet has been invoked since Jboss server was Invocation count started. The average amount of time (in ms) all invocations of the servlet have Exec. Time (Total) executed since it was most recently deployed. The average amount of time (in ms) the single longest invocation of the servlet Exec. Time (High) has executed since it was most recently deployed. The average amount of time (in ms) the single shortest invocation of the Exec. Time (Low) servlet has executed since it was most recently deployed. The average amount of time (in milliseconds) it took to execute all invocations Exec. Time (Avg) of the servlet since it was most recently deployed. Connections Name Name of the session/connection. Sessions Opened The global number of sessions opened since last poll. Sessions Closed The global number of sessions closed since last poll. Connections Requested The global number of connections asked by the sessions since last poll. Percentage Closed Percentage of session closed. Statistics Enabled Indicates whether statistics are enabled or not. (true or false) Transactions Name Name of the transaction. The global number of transactions known to have completed since the Completed statistics were reset. The global number of transactions known to have been successful since the Successful statistics were reset.Successful Transactions Percentage of successful transactions. Queries Name Name of the query. Query Put Count The global number of cacheable queries put in cache since last poll. The global number of cached queries successfully retrieved from cache since Query Hit Count last poll. Query Miss Count The global number of cached queries not found in cache since last poll. Query Hit Ratio The percentage of queries cache hit. Query Execution Count The global number of queries executed since last poll. Max-time taken to execute The amount of time taken by the slowest recorded query since last poll. Slow Query The query that is the slowest. Second level Cache Name Name of the cache. The global number of cacheable entities/collections put in the cache since Put Count last poll. The global number of cacheable entities/collections successfully retrieved Hit Count from cache since last poll. The global number of cacheable entities/collections not found in the cache Miss Count and loaded from the database since last poll. Hit Ratio The percentage of second level cache hit. JDBC JDBC Connection Pool details are displayed through this metric. The number of connections that are available, active, created, timed out and destroyed are listed. Also available are the metrics pertaining to the prepared statement cache of the database connection in the pools. Parameter Description Pool Usage Name Name of the JDBC pool. Available The number of available connections in the pool. The number of active connections. Each of the connections is either in use by Active an application or available in the pool. Created The number of connections created. Destroyed The number of connections destroyed. Wait The number of requests that had to wait for a connection. Maximum Used The maximum number of connections used. Total Blocking Time(ms) The total time spent waiting for an exclusive lock on the pool (in milliseconds). Total Creation Time(ms) The total time spent creating connections (in milliseconds). Timed Out The number of timed out connections. Idle Time Out in Mins Amount of time (in minutes) after which unused connections are closed. The percentage of active connections. Active Connections(%) Active Connections (%) = (Active / Pool Size) * 100 The percentage of maximum used connections. Maximum Connections Used(%) Maximum Connections Used(%) = (Max Used / Pool size ) * 100 Prepared Statement Cache Name Name of the cache. The number of prepared and callable statements currently cached in the Current Size statement cache. Hit Count The number of times that statements from the cache were used. Miss Count The number of times that a statement request could not be satisfied with a statement from the cache.Hit Ratio The percentage of prepared statement cache hit. Web Parameter Description Web Metrics Name Connector name of the global request processor. Request Count Number of requests served by this global request processor since last poll. Error Count Number of error request received since last poll. Maximum time taken by the global request processor to process a request (in Maximum Time ms). Time taken by this global request processor to process the requests since last Processing Time poll (in ms). Bytes Sent Per Second Average number of bytes sent per second. Bytes Received Per Second Average number of bytes received per second. Requests Failed Percentage of failed requests. Transactions Parameter Description TRANSACTIONS Total The total number of transactions created, including nested since last poll. Committed The number of committed transaction since last poll. Aborted The number of aborted transactions since last poll. The number of transactions that have rolled back due to timeout since last TimedOut poll. Nested The total number of nested transactions created since last poll. Heuristics The number of transactions in a heuristic state since last poll. The number of transactions which have begun but not yet terminated since Inflight last poll. The number of failed transactions, including timeouts, whose failure origin Application rollbacks was an application since last poll. The number of failed transactions whose failure origin was a resource since Resources rollback last poll. Percentage of successful commits. Successful commits Successful commits = (Committed / Total) * 100 Percentage of aborted transactions. Aborted transactions Aborted transactions = (Aborted / Total) * 100 Percentage of timedout transactions. TimedOut transactions Timeout transactions = (Timeout / Total) * 100 JMS The JMS tab provides an overview of the metrics related to the JMS Queues and Topics. Queues details include metrics like messages in queue, messages added, scheduled, paused along with current delivery percentage. Metrics with respect to topics tracked are message count, messages added, durable and non-durable message count,etc. Parameter Description QUEUES Name Name of the queue. Is paused Indicates whether the JMS Queue is paused or not.Messages in Queue The number of messages currently in this queue. The number of messages that this queue is currently delivering to its In Delivery consumers. Messages Added The number of messages added to this queue since it was created. Messages Scheduled The number of scheduled messages in this queue. Number of Consumer The number of consumers consuming messages from this queue. Percentage of message currently delivering. Currently Delivering Currently Delivering = (In Delivery / Messages in Queue) * 100. TOPICS Name Name of the topic. Messages in Topic The number of messages currently in this topic. No of Durable Messages The number of messages for all durable subscribers for this topic. No of Non-Durable Messages The number of messages for all non-durable subscribers for this topic. Subscriptions The number of durable and non-durable subscribers for this topic. No of Durable Subscribers The number of durable subscribers for this topic. No of Non-Durable Subscribers The number of non durable subscribers for this topic. Percentage of durable messages. Durable Messages Durable Messages = (No of Durable Messages / Messages in Topic) * 100 Percentage of non-durable messages. Non-Durable Messages Non-Durable Messages = (No of non Durable Messages / Messages in Topic) * 100 Configuration Parameter Description SERVER CONFIGURATION Launch Type Launch type of the JBoss server. Host Name / IP Address Hostname/IP address on which the JBoss server is running. Process Type The process type of JBoss server. JBoss Version Version of JBoss running. Release Codename Release codename of the JBoss server. Server State Current state of the server. Running Mode The mode in which the JBoss server is currently running. Available Processors Number of processors available for the JBoss server. Operating System Operating system on which the JBoss server is running. Product Name Name of the JBoss product. Server Name Name of the server hosting the JBoss application. Is Master Indicates whether the JBoss server is the master or not. Host Controller Name Name of the host controller. Server Group Name of the server group. Custom attributes You can view the custom attributes of the JBoss Server here. Click Add Attributes to add custom MBean attributes and associate MBean actions. For information on adding Custom Monitors, refer to Custom Monitors topic. Below is the detailed list of parameters monitored and the various versions of the server supported: Monitored Parameters JBoss 3.2.x JBoss 4.0.x, JBoss 5,5.1 JBoss 6.0 JBoss 7.0 4.2.2 GA Memory Usage[Used (MB), Free(MB), Commited(MB), Maximum(MB), Used(%), Free(%)] * Metrics for non-heap memory is supported in JBoss 6&7 only Thread Usage [Live Thread count, Daemon       Thread count, Peak Thread Count, Total Thread Started] Class Loading [Class loaded, Class Unloaded, Total Loaded,       Object Pending Finalization count] Deployments [Name, Context, Enabled, [sub- [sub- [sub- [sub- [servlets Runtime Name, Status, Sub- deployment deployment deployment deployment count not Deployments, Servlets count not count not count not count not available] Count] available] available] available] available] Web Applications [Active Sessions, Sessions Created, Expired, Rejected, Duplicated and Session Alive Time] [instances in EJB Statistics passive state, ready [WebModule,Type,Instances state, pooled Created, Removed, state, Instances in Passive State, message Ready State, Pooled State, count, Message Count, Method method Ready Count] ready count not available] Servlet Details [Invocation Count, Execution Time Total, Execution Time High,Execution Time Low,Execution Time Average] Persistence Units [Connections, Transactions,         Queries, Second Level Cache] Connection Pool Usage [Connections - Available, Active , Created, Destroyed, Maximum used, Timed out, Active Connections(%), Max Connections Used (%)]Prepared Statement Cache         [Current size, Hit count, Miss count, HitRatio] Web Metrics [Request Count, Error Count, Processing time(ms), Maximum time(ms), Bytes Sent, Bytes Received , Request Failed(%)]     [transactions Transactions aborted, [transactions [transactions [Total Transacations, timedout, aborted, aborted, Commited, Aborted, nested, timedout, timedout, TimedOut, Nested, heuristics, nested, nested, Heuristics, Inflight, inflight, heuristics, heuristics, Applications Rollbacks, applications inflight, inflight, Resource Rollbacks, rollbacks, applications applications Successful Commits] resource rollbacks, rollbacks, rollbacks not resource resource available] rollbacks not rollbacks not available] available] JMS-Queues [Name, Message Count, In Delivery, Messages Added,   Messages Scheduled, Consumer Count, Is Paused, Delivering Percentage] JMS-Topics [Name, Message Count, In Delivery, Messages Added, Durable Message Count, Non- Durable Message Count, Subscriptions, Durable Subscribers Count, Non-Durable Subscribers Count,Current Delivering (%), Durable Message(%), Non- Durable Message(%)] Custom Attributes and Server Configuration Details Jetty Server Monitoring Overview Jetty, the lightweight open-source project hosted by the Eclipse foundation, is a full-fledged HTTP server and Servlet container that can be easily configured to serve static and dynamic content. Unlike most Web Servers, Jetty is often used for machine to machine communications, usually within larger software frameworks. Applications Manager allows you to monitor your Java applications running on the Jetty HTTP server and Servlet container, track critical performance indicators of Jetty App server like CPU usage and be notified of thread pool exhaustion. Applications Manager also provides an in-depth view of the memory usage - heap and garbage collection information, real-time memory utilization and even object instance information within the JVM and Jetty server. Creating a new Jetty server monitor Supported versions of Jetty Server: Jetty 3.1 and above.Prerequisites for monitoring Jetty Server: Click to know about the user previleges and other necessary prerequisites to monitor Jetty Server. To create a Jetty monitor, follow the steps given below: Click on New Monitor link. Select Jetty Server under Application Servers. Give the Display name. Enter the Hostname of the server where Jetty Server is running. Enter the JMX Port. For default installations of Jetty, the JMX port number is 9999. You can enter your own credential details or select preconfigured credentials from details in Credentials Manager. If you wish to enter your own credentials, specify enter the JMX User Name and Password of Jetty Server. If no authentication is required, then leave the fields blank. Enter the JNDI path. For example:- JNDIPATH for default installations of Jetty is /jmxrmi. Set the Polling interval. Choose the Monitor Group from the combo box with which, you want to associate Jetty Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers your Jetty Server from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Jetty Server under the Applications Servers Table. Displayed is the Jetty Server bulk configuration view distributed under three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations Click on the monitor name to see all the server details listed under the following tabs: Performance Overview Thread WebApps Configuration Performance Overview Parameter Description CPU Details Available Processors The number of processors available to the JVM. CPU Usage Percentage The percentage of CPU usage of the JVM on the server. Uptime The uptime of the Java virtual machine. Class Loading Details Loaded Class Count The number of classes currently loaded in the JVM. Unloaded Class Count The number of classes unloaded since the JVM started execution. Heap Memory The pool containing objects that have survived the garbage collection of the PS Survivor Space Eden space. PS Eden Space The pool from which memory is initially allocated for most objects. This pool contains tenured and virtual (reserved) space and will be holding PS Old Gen those objects which survived after garbage collection from young generation space. Non Heap Memory The Permanent Generation holds all the reflective data of the virtual machine PS Perm Gen itself, such as class and method objects. With JVMs that use class data sharing, this generation is divided into read-only and read-write areas. The Code cache is the memory used for compilation and storage of native Code Cache code. Heap Memory DetailsTotal Memory The total memory is the memory that is currently allocated to the JVM. It is the combination of used memory currently occupied by objects and free memory available for new objects. It varies over time. Free Memory (MB) The total free memory available to the JVM for new objects. Used Memory (MB) The space that is currently occupied by Java objects. Max Allocated Memory (MB) The currently allocated memory in MB. Committed Memory (MB) The currently used memory in MB. Non Heap Memory Details The total memory is the memory that is currently allocated to the JVM. It is the Total Memory combination of used memory currently occupied by objects and free memory available for new objects. It varies over time. Free Memory (MB) The total free memory available to the JVM for new objects. Used Memory (MB) The space that is currently occupied by Java objects. Max Allocated Memory (MB) The currently allocated memory in MB. Committed Memory (MB) The currently used memory in MB. Garbage Collector Details Name The Garbage Collector Name. Valid The Garbage Collector Status. Live JVM statistics about garbage collector activity like the time spend Collection Time (MS) collecting objects. The Live JVM statistics about garbage collector activity like the number of Collection Count collected objects.   Note:  Java8 Update: When monitoring with JDK 1.8 MetaSpace, Applications Manager monitors and displays new memory space called MetaSpace instead of the former Permanent Generation (Heap and Non-Heap memory). The main difference is that Metaspace re-sizes dynamically i.e., It can expand at runtime. Java Metaspace space: unbounded (default) Thread Parameter Description JVM Threads Live Threads The current live thread count. Daemon Total number of Daemon Threads. A daemon thread is one that does not prevent the JVM from Threads exiting when the program finishes but the thread is still running. Peak Thread The peak live thread count since the Java virtual machine started or peak was reset. Count Threads started per The number of threads started per sec. sec Thread Pool Details Name The name of the thread pool. Thread Count The total number of threads currently in the pool. Busy Threads The number of currently busy threads in the thread pool. Idle Threads The number of currently idle threads in the thread pool. The maximum number of threads in the thread pool simultaneously tasked with some work to Max Threads process. Thread The percentage of threads used by the java process. Utilization Queue size The size of the job queue State The lifecycle state for this instance. Low on This value is true if the pools is at maxThreads and there are not idle threads than queued jobs.Threads Webapps Parameter Description Webapps Name The name of the Session. Id The session Id. Active Sessions The number of currently active sessions. State The current lifecycle state. Configuration Parameter Description Server Info VM Name The Java virtual machine implementation name. VM Vendor The Java virtual machine implementation vendor VM Version The Java virtual machine Version Name The name representing the running Java virtual machine. Version The operating system version OS Name    The operating system name. Start Time The timestamp at which the Java virtual machine was started. Jetty Version The Version of Jetty server. Resin Application Server Monitoring Creating a new Resin server monitor To create a new Resin server monitor, follow the steps given below: Click on New Monitor link. Select Resin Server under Application Servers. Give the Display name. Enter the Hostname of the server where Resin Application Server is running. Enter the JMX Port. For default installations of Resin, the JMX port number is 9999. You can enter your own credential details or select preconfigured credentials from details in Credentials Manager. If you wish to enter your own credentials, specify enter the JMX User Name and Password of Resin Server. If no authentication is required, then leave the fields blank. Enter the JNDI path. For example, JNDIPATH for default installations of Resin is /jmxrmi. Set the Polling interval. Choose the Monitor Group from the combo box with which, you want to associate Resin Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers your Resin Server from the network and starts monitoring it. Resin is a fast and reliable Java EE integrated high-performance application server that features load balancing for increased reliability. Built-in Resin features include clustering for high scalability, distributed caching to reduce reliance on traditional databases and adaptive health monitoring. Applications Manager increases the reliability of your Resin Application Server by monitoring all of the key performance indicators like thread details, connection pool usage, session details and memory resources. Resin Server - Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Resin Server under the Application Servers Table. Displayed is the Resin Server bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations.Click on the monitor name to see all the server details listed under the following tabs: Performance Overview Threads Memory Web Applications Connection Pools Configuration Performance Overview Parameter Description JVM Statistics JVM Memory The current total amount of memory available for the JVM, in MB. Free JVM Memory The current free amount of memory available for the JVM, in MB. JVM Memory Used The current used amount of JVM memory, in MB. State The current lifecycle state. Sever Request Throughput Request Serviced/Sec The total number of requests serviced by the server per sec. Bytes Read/Sec The total number of bytes that requests serviced by this server have read. Bytes Written/Sec The total number of bytes that requests serviced by this server have written. Transcation Manager Commited Transactions/Sec The total number of committed transactions/Sec. Failed Commited Transactions/Sec The total number of failed committed transactions/Sec. Rollback Transactions/Sec The total number of rolledback transactions/Sec. In-Progress Transactions The count of in-progress transactions. CPU Details Available Processors Number of processors available to the JVM. CPU Usage Percentage The CPU usage of the JVM on the server in Percentage. Uptime The uptime of the Java virtual machine. Class Loading Details Loaded Class Count The Number of classes loaded. Unloaded Class Count The Number of classes unloaded. Garbage Collector Details Name Garbage Collector Name. Valid Garbage Collector Status. Collection Time Time taken to perform garbage collection in ms. Collection Count Total number of collections that have occurred. Threads Parameter Description Total Threads Total Thread count. Total Threads Started Total number of threads started. Active Resin Threads The current number of active resin threads. Idle Resin Threads The current number of idle resin threads. Resin Threads waiting The current number of wait threads. Max Resin Threads The configured maximum number of threads. Total Resin Threads The current number of managed threads.Memory Both Heap memory and Non-Heap memory details can be viewed in this tab along with their sub-memory types. Heap memory types include Eden, Survivor and Tenured memories, and Non-Heap memory types include CodeCache and PermGen memories respectively. Parameter Description Total Memory Total memory of various storage arrays with used memory and free memory split-up. Free Memory Free memory in MB. Used Memory Used memory in MB. Max allocated Memory Max allocated Memory in MB. Committed Memory Committed memory in MB. Used Memory % The percentage of used memory. Web Applications Parameter Description Name Name of the Web Application. Active Sessions The current number of active sessions. Invalidated Sessions The total number of sessions that have been invalidated. Session Max The configured maximum number of sessions in memory. Session Utilization Percentage of session''s used by the webapp. Requests/Sec The number of requests served by the web-app per sec. Bytes Received/Sec The total number of bytes received in client requests. Bytes Sent/Sec The total number of bytes sent to clients. 500 Errors The total number of 500 status errors. State The current lifecycle state. Connection Pools Parameter Description Name The Name of the Connection Pool. Active Connections The current number of active connections. Idle Connections The current number of idle connections. Total Connections The current number of idle and active connections. Failed Connections The current number of failed connections. Max Connections The configured maximum number of connections. Pool Utilization Percentage of connection pool used. Configuration Parameter Description VM Name The Java virtual machine implementation name. VM Vendor The Java virtual machine implementation vendor. VM Version The Java virtual machine Version. Name The name representing the running Java virtual machine. Boot Classpath    The boot class path that is used by the bootstrap class loader to search for class files. ClassPath The Java class path that is used by the system class loader to search for class files. Library Classpath The Java library path.    Version The operating system version. OS Name    The operating system name. Start Time The start time of the Java virtual machine in milliseconds.Oracle Application Servers Creating a new Oracle monitor Supported Versions: Applications Manager supports monitoring of Oracle Application Servers 10g. Prerequisites: Applications Manager uses the Dynamic Monitoring Service (DMS) provided by Oracle Application Server to monitor the same. For this reason, the DMS Servlet has to be made accessible to the system where the Applications Manager is running. Refer Prerequisites section. To create a Oracle Application server monitor, follow the steps given below: Click on New Monitor link. Select Oracle AS. Enter the IP Address or hostname of the host where Oracle Application Server runs. Enter the SubNetMask of the network. Enter the Port number for eg., 7200. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which, you want to associate Oracle Application Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Oracle Application Server from the network and starts monitoring them. Monitored Parameters Oracle Application servers are monitored based on the attributes listed below. The monitoring details of Oracle Application server are represented graphically that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored by the server based on these details. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information: Parameter Description Monitor Information Port The port at which the Oracle Application server listens. Last Polled at Specifies the time when the monitoring of the server was started. Availability Shows the current status of the server - available or not available. Request Throughput Throughput Number of requests processed per unit of time in the server. Current Active Connection Shows the current active connections Average Connection Process Time Gives the average processing time of the connections Current Active Request Shows the number of requests that are active currently Server Response Time Response Time Refers to the time required for the server to respond while monitoring. Data Throughput Refers to how much data is transferred per unit time Data Processed Refers to how much data is processed per request Servlets Total number of servlets OPMN Process Memory Stats (Memory statistics of the OPMN processes like dcm-daemon, WebCache, WebCache Admin, HTTP_Server, home) Used Memory Gives the total physical memory used by the process Status Gives the availability status of the process oc4j JVM Statistics Active Thread Groups Shows the number of Active Thread groups in the JVM Active Threads Shows the number of Active Threads in the JVM Heap Usage Shows current heap memory usage of the processJDBC Connections Gives the total number of JDBC Connections Transactions Gives the total number of open, committed and aborted JDBC transactions Web Applications Servlets Total number of servlets in the web application Throughput Number of requests processed per unit of time in the web application Process Request Time taken to process the request Active Request Current number of active requests for the web application Active Session Number of active sessions of the web application Session time Total time for which the sessions have been active JMS Attributes Deque Avg Average time to deque messages Enque Avg Average time to enque messages Pending Message Total number of message waiting to be processed Message Dequeued Total number of messages dequeued Message Enqueued Total number of messages enqueued Message Count Number of messages in the JMS Destination EJB Statistics EAR Name Name of the Enterprise Application Resource Process Name of the oc4j process to which the EJB belongs to Type Gives the type of the EJB Create Count Number of EJBs created Active Count Number of active EJBs Passive Count Number of passive EJBs Pooled Count Number of pooled EJBs Response Summary Gives the count for the various HTTP responses Tomcat Servers Supported Versions The supported versions of Tomcat Servers are 3.x, 4.x, 5.x, 6.x, 7.x and above. For Tomcat Server 3.x and 4.x, agent has to be deployed for Tomcat monitoring. Note: You can check whether the Agent is deployed, by connecting to the following URL in Tomcat Server. http:// : /adventnet/DataServlet To deploy the agent for Tomcat Server 3.x Download the Tomcat3Agent.Zip from  /working/classes directory. Unzip it in the directory of the host in which the Tomcat server is running. Restart the Tomcat Server. To deploy the agent for Tomcat Server 4.x  Download the Tomcat4Agent.Zip from the /working/classes directory Unzip it in the directory of the host in which the Tomcat server is running. Add the following tag in server.xml file located in the  /conf directory (below the Engine tag). [Click the link to view an example server.xml] Restart the Tomcat Server. To deploy the agent for Tomcat Server 4.x and Apache server combined Download the Tomcat4Agent.Zip from the /working/classes directory Unzip it in the directory of the host in which the Tomcat server is running.Add the following tag in server.xml file located in the  /conf directory (below the Engine tag). [Click the link to view an example server.xml] Restart the Tomcat Server. Apache:In Apache mod_jk.conf file of Apache Server , add the following entry  JkMount /adventnet/* ajp13, Where ajp13 is the worker name .It has be the name given in worker.properties file. Restart Apache server To create a Tomcat Server Monitor Click on New Monitor link. Select Tomcat Server. Enter the IP Address or hostname of the host. [Note: Also refer to Configurations based on Tomcat Deployments section] Enter the SubNetMask of the network. Enter the port number in which the monitor is running. [Default port number is 8080] Choose SSL option , if SSL is enabled in Tomcat server. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the monitor-specific authentication information, such as user name and password. Note: Applications Manager agent has to be deployed in Tomcat Servers 3.x and 4.x. Tomcat 3.x and 4.x needs no user name and password. In case of Tomcat 5.x and above, an application named Manager must be running in it for Applications Manager to monitor the Tomcat server. By default, this application will be running in the server.If you have customized the manager application (Eg., \qamanager), then you can use the option "Tomcat Manager Application URI" in the client, for Applications Manager to monitor the Tomcat server. For Tomcat Versions 5.x & 6.x and 7.x: The user role to access the server must be manager (versions 5.x & 6.x) / manager-jmx (version 7.x). To add a role as "manager" (versions 5.x & 6.x) / "manager-jmx" (version 7.x) for any of the users such as tomcat, role1, or both, you need make changes in tomcat-users.xml file located in the /conf directory. For Tomcat 8: Remote access to Application Manager is restricted, by default. Add the IP address of APM in CATALINA_HOME/webapps/manager/META-INF/context.xml (under ''allow ='' ) Example: Default configurations in tomcat-users.xml in Tomcat Server.   After adding the roles for the "tomcat" user, the modified entries will be as follows:           On making the configuration, restart the Tomcat Server. Now, when adding a new Tomcat (5.x and above) monitor, specify the username/password as tomcat/tomcat when discovering the Tomcat Server. [Click the link to view an example tomcat-users.xml for versions 5.x / 6.x and tomcat-users.xml for versions 7.x] Note: After adding the Manager role in tomcat-users.xml, you should be able to access the manager application - : /manager/status (Provide manager user credentials). If the application is not accessible, add the following entry in server.xml, under ''Engine'' context: Restart the server and try to access manager application. Choose the Monitor Group from the combo box with which you want to associate Tomcat Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Tomcat server from the network and starts monitoring them.   Troubleshoot: Having trouble in monitoring Tomcat server? Refer to the online Troubleshooting section. Note : Steps to configure Tomcat Monitor for JBoss 3.2.5 Append the following in the web.xml present in \deploy\jbossweb- tomcat50.sar\ROOT.war\WEB-INF folder " Status Servlet /manager/status   Status Servlet /manager/     Status Servlet /manager/status/   " Restart the JBoss server. Configure a tomcat monitor by clicking New Monitor --> Select Tomcat Server in the combo box. Select the version as 5.x and create the monitor. This will create a monitor for the Tomcat webserver running in JBoss3.2.5. Configurations based on Tomcat Server Deployment Monitoring of Tomcat Server depends on its deployment. This section explains the possible deployment scenarios of Tomcat. Your configuration of host name and the port depends on these scenarios.   1. Standalone Tomcat Server This is a general scenario wherein you have a Tomcat server which has the HTTP (apache) within its deployment. In this case, when configuring a tomcat monitor, specify the host name of the Tomcat server and the port of the HTTP. 2. One Tomcat Server (with HTTP) and one external instance of Apache There is one Tomcat server with HTTP (apache) instance running in it and another external Apache running outside. Example: Tomcat server name: Tomcat A; HTTP (in Tomcat server) port: 8080; External Apache server port: 80In this case, while configuring for a Tomcat monitor, specify the host name as ''Tomcat A'' and specify the port of the HTTP that runs with the Tomcat and not the external Apache, i.e., specify the port as 8080 and not 80. 3. One Tomcat Server (without HTTP) and one external instance of Apache There is one Tomcat server without HTTP in it and another external Apache running. Example: Tomcat server name: Tomcat A; HTTP (in Tomcat server) port: Not available; External Apache server port: 80 In this case, while configuring for a Tomcat monitor, specify the host name as ''Tomcat A'' and specify the port of the external Apache, i.e., 80. 4. Multiple Tomcat Server (with HTTP instances in each of these servers) and one external instance of Apache There are multiple Tomcat servers, say 3, with HTTP instances in each of them and another external Apache running. Example: Tomcat Server names: Tomcat A, Tomcat B, Tomcat C; HTTP (in Tomcat servers) port: 8070, 8080, 8090 respectively; External Apache server port: 80 In this case, you need to create tomcat server monitor individually for Tomcat A, Tomcat B, and Tomcat C and specify their ports as 8070, 8080, and 8090 respectively. 5. Multiple Tomcat Server (without HTTP instances in these servers) and one external instance of Apache There are multiple Tomcat servers, say 3, without HTTP instances in them and another external Apache running. Example: Tomcat Server names: Tomcat A, Tomcat B, Tomcat C; HTTP (in Tomcat servers) port: Not available; External Apache server port: 80 You can monitor only one of the instances in this case. Please contact appmanager- support@manageengine.com if you would like to have it added. Monitored Parameters Tomcat Servers are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the Monitors of Tomcat server. You can also configure thresholds to the numerical attributes monitored by the server based on these details. Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information. Overview Memory Thread JDBC Web Web Applications Servlets Overview Parameters Description Availability Shows the current status of the server - available or not available. The time taken for the tomcat server to respond while monitoring in Response Time milliseconds Average Processing Time The average processing time taken to process a request in milliseconds Requests Per Minute The average number of requests received by the server in one minute Average Bytes Per Minute The average bytes send per minute Successful Requests The number of requests served successfully Errors The number of error request received Requests Failed percentage Percentage of requests failed. Class Loaded The number of classes currently loaded in the java virtual machine.Class Unloaded The number of classes unloaded since the java virtual machine has started The total number of classes loaded since the java virtual machine has Total Class Loaded started execution. Daemon Threads The number of live daemon threads Live Threads Current number of live threads  The total number of threads started since the java virtual machine Total Threads Started started. Memory Parameters Description Name The memory pool name Type Memory pool type. i.e, (Heap memory , Non-Heap Memory) Used Memory in MB Used memory in MB Free Memory in MB Free memory in MB Committed Memory in MB Committed memory in MB Maximum Memory in MB Maximum memory allocated in MB Used memory in % Percentage of memory used Free memory in % Percentage of memory free Name Garbage collector name Number of collections per Minute Number of garbage collections occurred per minute Collection Time per Minute Collection time in milliseconds. Thread Parameters Description Connector Name The thread pool connector name Busy Threads Number of threads currently busy Current Threads Number of threads currently created Maximum Threads The maximum number of active threads can present in this pool Percentage Used Percentage of threads used  Percentage Free Percentage of threads free  JDBC Parameters Description JNDI Name The JNDI name of the datasource Context The web application context name Active Number of active connections to the data source Connections Idle Connections Number of idle connections to the data source Active Percentage of active connections (not applicable if maximum active connection is Connections in % unlimited i.e. configured as -1) Idle Connections Percentage of idle connections  (not applicable if maximum idle connection is unlimited in % i.e. configured as -1) Web Parameters Description Connector Name Connector name of the global request processor Request Count Number of requests served by this global request processor Error Count Number of error request receivedProcessing Time Time taken by this global request processor to process the requests in milliseconds Bytes Send Per Second Average bytes send per second Bytes Received Per Second Average bytes received per second Successful Request (%) Percentage of successful requests Failed Request (%) Percentage of failed requests Web Applications Parameters Description Context Web application''s context name Status Status of the web application such as STARTED, STOPPED Processing Time (ms) The processing time taken to process the requests in milliseconds Successful Requests Number of successful request served for this web application Failed Requests Number of error request for this web application Average Response Time (ms) Average response of this web application in milliseconds Average Request Per Minute Average requests for this web application per minute Average Bytes Per Second Average bytes send per second No.of Open Sessions Number of sessions currently open / active No.of Expired Sessions Number of sessions expired No.of Rejected Sessions Number of sessions rejected Servlets Parameters Description URL The name of the servlet Context Web application''s context name Processing Time (ms) The processing time in milliseconds Successful Requests Number of successful request Failed Requests Number of error request Average Response Time (ms) Average response time in milliseconds Average Requests Per Minute Average requests served per minute SilverStream Servers To create a SilverStream Server Monitor Click on New Monitor link. Select SilverStream. Give the Display name. Enter the Hostname of the host where SilverStream Server runs. Enter the Port number. Set the Polling interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which, you want to associate SilverStream Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers SilverStream Server from the network and starts monitoring them. Monitored ParametersSilverStream servers are monitored based on the attributes such as memory, thread, etc. The monitoring details of SilverStream server are represented graphically that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored by the server based on these details. Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information. Parameter Description Monitor Information Name The name of the server Health The health of the server Availability The availability status of the server Last Polled at The time at which last poll happened Next Poll at The time at which next poll has been scheduled Memory Details Free Memory Available Memory in MB for the JVM Total Memory Total Memory used by JVM GC Count No. of time Garbage Collection happened Request Details Minimum Response Time The least time taken to process a request Average Response Time Average time taken to process a request Maximum Response Time The maximum time taken to process a request Thread Details Free Threads No. of free threads Idle Threads No. of threads that are waiting for a task Total Threads Total number of threads available Load Details Requests No.of requests processed by the server Current Load Load on the SilverStream Server Bytes No. of bytes transferred by the server Session Details Idle Sessions No.of sessions in idle state Total Sessions Total number of sessions License Details Used Licenses Total number of licenses used Total Licenses Total number of licenses available VMware vFabric TC Server Monitoring Overview Applications Manager monitors the VMware vFabric tc Server and the Spring applications deployed on the server to detect any performance problems. This monitoring is carried out by tracking critical components of the vFabric tc Server such as memory, thread, throughput, garbage collector, etc. Creating a new VMware vFabric tc server monitor Supported Versions: The supported versions of VMware vFabric tc Server are 2.6 to 2.9 To create a new VMware vFabric tc Server monitor, follow the steps given below: Click on New Monitor link. Select VMware vFabric tc Server. Provide the Display name of the monitor. Enter the Host Name in which the vFabric tc Server is running.Enter the Port number in which the JMX Agent is running (6969 by default). The port in which JMX agent is running; is defined in the ''catalina.properties'' file. Enter the User Name and Password of the vFabric tc Server. Specify the JNDIPath. For example, JNDIPath for default installations of vFabric tc Server is /jmxrmi. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate vFabric tc Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the vFabric tc Server from the network and starts monitoring it. Note: To enable JMX in the tc Server, you have to define a JMX port in the ''catalina.properties'' file and then give an entry in ''server.xml'' file. For more information on setting values for JMX variables, refer here. Monitored Parameters The Availability tab shows the availability history of the vFabric tc Server for the past 24 hours or 30 days. The Performance tab shows some key performance indicators of the vFabric tc Server such as CPU utilization, throughput and garbage collection rate. This tab also shows the health status and events for the past 24 hours or 30 days. The List view lists all the vFabric tc Servers monitored by Applications Manager along with their overall availability and health status. It enables you to perform bulk admin configurations. Click on the individual monitors listed to view detailed performance metrics. To view detailed performance metrics of a vFabric tc Server, click on the monitor name listed in the Availability or List View tabs. The performance metrics have been categorized into 6 different tabs: Overview Web Applications Throughput Cache Transaction Threads Configuration Details Overview This tab provides a high-level overview of the health and performance of the vFabric tc Server along with information pertaining to the throughput, thread and garbage collection. Parameters Description Memory Details Memory Used The amount of memory used by the JVM Memory available The amount of physical memory available. Used Heap The percentage of heap memory space used. Total Memory Total amount of physical memory available to the operating system. CPU Usage CPU Usage The CPU utilization of the VM. Throughput> Bytes Received Per The average bytes received per second. Second Bytes Sent Per Second The average bytes sent per second. Error Count The number of error request received. Processing Time The processing time taken to process the requests in milliseconds. Request Count The number of requests served by this global request processor. Thread Details Total number of threads created and also started since the Java virtual machine Thread Count started.Threads in Running Total number of threads executing in the Java virtual machine in running state. State Threads in Waiting Total number of threads in the Java virtual machine in waiting state. State Blocked Threads A thread that is blocked waiting for a monitor lock is in this state. A thread that is waiting for another thread to perform an action, for up to a specified Timed Waiting Threads waiting time is in this state. Deadlock Threads Number of threads that are in deadlock waiting to acquire object monitors. Heap Memory Eden Space The pool from which memory is initially allocated for most objects. Tenured Gen The pool containing objects that have existed for some time in the survivor space. Survivor Space The pool containing objects that have survived GC of eden space. Non Heap Memory Perm Gen, Perm Gen Holds all the reflective data of the virtual machine itself, such as class and method [shared-rw], Perm Gen objects. With JVMs that use class data sharing, this generation is divided into read- [shared-ro] only and read-write areas. Code Cache Memory used for compilation and storage of native code. Garbage Collector GC Rate The rate of garbage collection. Average GC Time (ms) Time taken to perform garbage collection. You can use the Custom Fields option in the ''Monitor Information'' section to configure additional fields for the monitor. Support given for JDK 1.8: When monitoring with JDK 1.8 MetaSpace, Applications Manager monitors and displays new memory space called MetaSpace and Compressed Class Space instead of the former Permanent Generation (Non-Heap). Web Applications This tab provides the details of the various applications running in the vFabric tc Server. Parameters Description Context The various applications running. Active Sessions The number of sessions currently in active state. Session Creation Rate The number of sessions created per second. Average Response Time The average response time taken for a particular application. You can also disable, enable or delete a particular application by using the Actions option and also compare performance reports of different applications using theCompare Reports option. Throughput This tab displays information pertaining to the number of requests received and sent per second in the server. Parameter Description Global Request Processor Name The name of the instances. Bytes Received Per Second The number of requests received per second in the server. Bytes Sent Per Second The number of requests sent per second from the server. Error Count The number of requests, not processed. Processing Time ms The time taken for a request to be processed in milliseconds. Request Count The total count of requests. Cache This tab contains metrics related to cache memoryParameters Description Cache The applications running in the server. Access Count The number of times the application is accessed. Hits Count The number of times the application is accessed from the cache. Cache Hit Ratio % The ratio of Hits Count to Access Count. Transactions This tab shows information pertaining to the database. Parameters Description Transaction Manager- Commits The commit rate transactions per second and failed commits transactions. Transaction Manager- Resumes The resume rate transactions per second and failed resumes transactions. Transaction Manager- Rollbacks The rollback rate transactions per second and failed rollbacks transactions. Transaction Manager- Suspends The suspend rate transactions per second and failed suspends transactions. Threads Parameters Description Thread Details Total Threads The total number of threads started since the java virtual machine started. Busy Threads The number of threads currently busy. Executor Details Active Threads The number of Active Threads in the JVM. Max Threads The maximum number of Threads in the JVM. Pool Size The number of objects in the pool (entity and stateless). Requests Queue Size The number of requests in the Request Queue. Configuration Details Parameters Description Name The Java virtual machine implementation name. Version The Java virtual machine Version. JVM Vendor The Java virtual machine implementation vendor. Classpath The Java class path that is used by the system class loader to search for class files. Library The Java library path. Classpath Boot The boot class path that is used by the bootstrap class loader to search for class files. Classpath OS Name The operating system name. Total Memory The amount of memory used by this VM. (MB) Maximum The maximum Native memory space for the representation of class metadata is called Metaspace Metaspace.MetaSpace use native memory  to store meta-data and that grows automatically. (MB) WebLogic Servers Creating a new WebLogic server monitor Supported Versions: Following versions of WebLogic Servers can be monitored by Applications Manager: WebLogic 6.1 WebLogic 7.xWebLogic 8.x WebLogic 9.x WebLogic 10.x (WebLogic 11g) WebLogic 12.x WebLogic 14.x and above Prerequisites for setting up WebLogic server monitoring: Click here Using the REST API to add a new WebLogic monitor: Click here To create a new WebLogic monitor, follow the steps given below: Click on New Monitor link. Select WebLogic Server. Enter a Display Name for the monitor. Enter the IP Address/ hostname of the host. Select the version of your Weblogic Server from drop-down menu. From the box, select whether SSL is enabled or not. Enter the port number in which WebLogic is running. You can enter your own credential details or select preconfigured credentials from details in Credentials Manager. If you wish to enter your own credentials, specify WebLogic version, username and password details for this monitor. Select the action you want to perform on deleted resources using the Action on Deleted Resources field. Choose one of the following from Discover Clusters and Servers option: Do not discover: Clusters and managed servers will not be discovered. Discover but do not monitor metrics: Clusters and managed servers will be discovered and added as separate monitors, but will be in unmanaged state. Discover and monitor metrics: Clusters and managed servers will be discovered, added as separate monitors and metric data will be collected. Note: Clusters are added as Cluster Monitor type. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the monitor-specific authentication information, such as user name and password. Choose the Monitor Group from the combo box with which you want to associate WebLogic Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers WebLogic server from the network and starts monitoring them. Note: The ports that need to be opened when the Weblogic Monitor is behind the firewall: Two-way communication between WebLogic listening port (Default : 7001) and Applications Manager web server port (default : 9090). Having trouble in monitoring WebLogic server? Refer to the online Troubleshooting section. Monitored Parameters WebLogic servers are monitored based on a few parameters or the attributes. These attributes provide information about the functioning of the Monitors of WebLogic server and you can also receive alarms based on the thresholds configured on the numerical attributes of the server. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information. Click on the monitor name to see all the server details listed: JVM Heap Usage JDBC Thread pool Web Applications Java Message ServiceSAF Custom Attributes JVM Heap Usage Parameters Description Minimum The minimum amount of heap memory that was used by the WebLogic server. (KB) Heap Size Maximum The maximum amount of heap memory that was used by the WebLogic server. (KB) Heap Size Average The average amount of heap memory that was used by the WebLogic server. (KB) Heap Size Total Heap The total amount of heap memory allocated to the WebLogic server. (KB) Size Current The amount of heap memory currently available in the WebLogic server. (KB) Heap Size Current Heap Size The percentage of the amount of heap memory currently available in the WebLogic server. (%) (%) Server Response Time Server Response Time is the time the server takes to respond to a user request. Here, it is Server calculated as the time that the Weblogic Server takes to establish a connection with and respond Response to a request from Applications Manager. You can also track the minumum, maximum, average and Time current response time of your Weblogic Servers. JDBC Parameters Description Name of the database connection pools that enables caching of database connection in the Name monitor easier through pools. Threads waiting Mentions the number of threads waiting for the connection. for connection JDBC Active Mentions the number of active connections made to the monitor. Connections Total Specifies the number of database connection pool. Connections Pool State Specifies the state of the pool Running/Suspended JDBC There can be some problems in connections that are checked out from the connection pool but Connection are not returned back to the pool and they are specified using the parameter. Leak Count JDBC Active Amount of active connections in % Connection in % Thread Pool Parameters Description Idle Threads Count Specifies the threads that are idle or not used. Total Threads Refers to the total count of threads assigned in this thread queue. Pending Request Total Count Specifies the number of requests that are pending in the queue. Threads In Use Specifies the threads that are currently in use. Web Applications Parameters Description Name Name of the Web Application. Session Opened Total Refers to the total number of sessions that were opened since deployment of anApplication. Number of Active Sessions Specifies the number of sessions that are currently active in the Application. Maximum Number of Refers to the highest number of sessions that were open for an Application. Sessions Number of Servlets Refers to the total number of servlets of a web application Java Message Service Parameters Description Name The name of JMS server. Current The current number of messages stored on this JMS server. The current number of messages pending (unacknowledged or uncommitted) stored on this JMS Pending server. Received/Min The number of messages received on this destination since the last reset per minute. SAF Details (Conversations & Remote End Points) Parameters Description Name Name of SAF Agent in Weblogic. Current The current number of conversations. Conversations Conversations/Minute The total number of conversations per minute since the last reset. Current Remote The current number of remote endpoints to which this SAF agent has been storing and EndPoints forwarding messages. EndPoints/Minute The rate at which this SAF agent has been storing and forwarding messages per minute. Custom Attributes You can also view the custom attributes of the WebLogic Server in the same page. Click Add Attributes to add custom WebLogic attributes. For information on adding Custom Monitors, refer to Custom Monitors topic. WebSphere Server Monitoring Create a New Monitor The supported versions of WebSphere Servers are 5.x, 6.x, 7.x, 8.x and 9.x Prerequisites for Websphere Monitoring: For Applications Manager to collect data from WebSphere Application Server, configurations are required at the Performance Monitoring Infrastructure (PMI) specification level. Refer Prerequisites Section for configuration details. To create a WebSphere Server Monitor Click on New Monitor link. Select WebSphere Server. Select the Deployment Mode as Base or Network Deployment. For Base Mode, Enter the Host name/IP Address of the host in which websphere application server is running. For Network Deployment, enter the Host name/IP Address of the websphere application server in which the perf servlet is installed. This will automatically discover all the WebSphere servers in Network Deployment. Enter the SubNetMask of the network. Enter the HTTP Transport Port (9080 by default). Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Select the version of the WebSphere to be monitored - 5.x, 6.x, 7.x, 8.x and 9.x Enter the port number of the SOAP Connector (8880 by default). If you want to monitor WebSphere through SSL mode, select the SSL is enabled checkbox. Enter the User Name and Password, if Global Security is enabled. In Network Deployment Mode, Enter the Network Deployer''s Host and SOAP Port (Default : 8879).Choose the Monitor Group from the combo box with which you want to associate WebSphere Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers WebSphere server from the network and starts monitoring them. Note: Applications Manager has been tested for WebSphere versions of English, German, Japanese and Chinese languages. In the Network Deployment mode, the child monitors which are automatically discovered cannot be deleted from the list view. If a user tries to delete a child monitor, it will get added again in next poll of the Parent monitor. Child monitors will be deleted only if the parent monitor is deleted. If they want to stop data collection(don''t want to monitor) for child monitors, they need to mention those child monitors in Exclude list of the parent monitor in edit monitor page. If they mentioned it in exclude list of parent monitor page, then those child monitors will be unmanaged and data collection stops for those monitors. Monitored Parameters The Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information WebSphere servers are monitored based on the attributes listed under the following tabs: Monitor Information Overview Web EJB JDBC JMS - Queues, Topics Thread The monitoring details of the server are represented graphically that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored by the server based on these details. Monitor Details Parameters Description The deployment mode of the WebSphere server. You can choose either Base or Network Deployment.If you select: Base Mode, enter the Host Name/IP Address of the host in which the WebSphere Deployment application server is running. Mode Network Deployment, enter the Host name/IP Address of the WebSphere Application server in which the perf servlet is installed. This will automatically discover all the WebSphere servers in Network Deployment. WebSphere Denotes the version of the WebSphere server monitor. Version Port Refers to HTTP Transport port. Subnet Mask The subNetMask of the WebSphere server. Do not resolve If you have multiple system IP addresses configured with a single DNS name, select the ‘Do DNS name not resolve DNS name’ option under‘Advanced’ section. Network Deployer Host, If you have chosen the ‘Network Deployment’ mode, specify the Network Deployer Host and Network Network Deployer SOAP Port values. The default SOAP port is 8879. Deployer SOAP Port SSL is enabled If you want to monitor WebSphere through SSL mode, select the ‘SSL is enabled’ checkbox. If you want to monitor selected app servers running in the WebSphere server, select the App Servers to ‘Advanced Options’ checkbox and specify the app servers in the ‘App Servers to Monitor’ field. Monitor If you want to monitor all the app servers in the WebSphere server, leave this field empty. OverviewParameters Description State Refers to different states of the Websphere server such as running and down. HTTP Port Refers to HTTP Transport port. Transaction Specifies Global Commit Duration, Committed Transactions, Transactions Rolled Back and Details Transactions Optimized. Server Response Specifies Minimum, Maximum, Average and Current Response Time. Time Availability Specifies the status of the WebSphere server - available or not available. JVM Memory Specifies the total memory in JVM run time. Usage Specifies the average system CPU utilization taken over the time interval since the last CPU Utilization reading. Free Memory Specifies the amount of real free memory available on the system. Average CPU Specifies the average percent CPU Usage that is busy after the server is started Utilization Session Details of Web Applications Parameters Description Invalidated Specifies the total number of sessions that were invalidated. Sessions Session Creation The rate per minute at which session objects were created by the server. Rate/Min Affinity The total number of requests received for sessions that were last accessed from other Web Breaks/Min applications. This value can indicate failover processing or a corrupt plug-in configuration. Live Sessions The number of local sessions that are currently cached in memory Total The total number of requests that a web application processed Requests/Min Error Total number of errors in a servlets or JavaServer Page (JSP). Count/Min Concurrent The number of requests that are concurrently processed. Requests EJB Details Parameters Description Mentions the names of the different EJB present in the WebSphere server with JAR and EAR Name name. Move the mouse pointer over the EJB name to view the JAR and EAR name. Denotes the different types of the bean such as entity, stateless session, stateful session, and Type message driven. Concurrent Lives Specifies the number of concurrent live beans. Total Method Specifies the total number of method calls. Calls Average Method Specifies the average time required to respond to the method calls. Response Time Pool Size Specifies the number of objects in the pool (entity and stateless). Specifies the average time in milliseconds that the total bean is activated for that particular Activation Time Bean container, including the time at the database, if any. Specifies the average time in milliseconds that the total bean is passivated for that particular Passivation Time Bean container, including the time at the database, if any. Current JDBC Connection Pool Details Parameters Description Name The name of the current JDBC Connection pool.Pool Type The type of the connection pool. Create Count The total number of connections created. Pool Size The size of the connection pool. Concurrent Waiters The number of threads that are currently waiting for a connection. Faults The total number of faults in the connection pool such as timeouts. Average Wait Time The average waiting time, in milliseconds, until a connection is granted. Percent Maxed The average percent of the time that all connections are in use. JMS Queues Parameters Description Queue Depth The number of messages available for a queue''s consumption Uncommitted The number of messages locked or uncommitted. This means messages that have been added Transactions or removed but the transaction has not yet been committed. Produced The total number of messages produced per second to this queue. Count/Sec Consumed The total number of messages consumed per second from this queue Count/Sec Number of The number of currently attached local producers. Producers Number of The number of currently attached local consumers. Consumers Message Wait Maximum time spent by messages on this queue at consumption in seconds. Time(sec) Oldest Message The longest time any message has spent on this queue in seconds. Age(sec) Jms Topics Parameters Description Durable The number of subscriptions that can be used to preserve messages published on a topic Subscriptions while the subscriber is not active. Non-durable The number of non-durable subscriptions. Subscriptions Incomplete The number of publications not yet received by all current subscribers. Publications Oldest Publication The longest time any publication has spent on this topic space. Age Number of The number of local publishers to topics in this topic space. Publishers Number of The number of local subscriptions to topics in this topic space. Subscriptions Number of The total number of publications to this topic space. Publications Thread Pool Details Parameters Description Name Mentions the name of the thread pool. Thread Creates Specifies the total number of threads created. Thread Destroys Specifies the total number of threads destroyed. Active Threads Specifies the number of concurrently active threads. Pool Size Specifies the average number of threads in pool.Percent Used The average percentage of the pool in use. Free Pool Size The number of free connections in the pool. Percent Maxed Specifies the average percent of the time that all threads are in use. Note: In Network Deployment mode, Network Deployer will be listed in the WebSphere Monitors list. Clicking on it, will give server information and the custom attributes. Further, the individual WebSpheres within the Network Deployment would also be listed. Clicking on those servers would bring up each of those server''s details. Monitoring Apache Geronimo Apache Geronimo - An Overview Monitoring Apache Geronimo - What we do Adding a new Apache Geronimo Monitor & Demo Monitored Parameters Apache Geronimo - An Overview Apache Geronimo is an open source J2EE/Java EE 5 web application server that integrates open source projects to create Java/OSGi server runtimes that meet the needs of enterprise developers and system administrators. Geronimo can host a variety of server applications and boasts a large base of users. It comes equipped with a relational database server and message broker, enabling you to immediately deploy your enterprise applications. With all this potential, monitoring Apache Geronimo can be a daunting task. Monitoring Apache Geronimo - What we do Applications Manager aims to help administrators implement performance management of their Apache Geronimo application servers and the business-critical applications running on them. Let’s take a look at what you need to see to optimize your Apache Geronimo servers and the performance metrics that you can gather with Applications Manager: Resource utilization details - Discover Apache Geronimo servers, monitor memory and CPU utilization and get alerted of changes in resource consumption. JVM and Thread Details - Track thread usage with metrics like Daemon, Peak and Live Thread Count. Ensure started threads don’t overload the server''s memory. Web and Data Source details - Get an overview of sessions where you can see all session details  for each web application – active, expired, duplicate, rejected and more. Collect information on the number of requests, concurrent connections, requests duration etc. EJB and ActiveMQ data -  Automatically collect and visualize ActiveMQ queue data like memory usage, average message size, average enqueue time and broker metrics all in one place. Analyze topic details including memory consumed by each topic, average message size, blocked sends, health of each topic etc. and make informed decisions. Correlate subscriber metrics with their respective topic metrics to diagnose issues. Juddi Stats and Cache details  - Track Failed and Successful API Queries stats of the UDDI Registry. Monitor the cache size of an Apache Geronimo Environment and the number of access count. Fix Performance Problems Faster - Maintain configurations for high availability and scalability, and be alerted automatically of potential issues with the components of your Apache Geronimo server. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Adding a new Apache Geronimo monitor Supported Versions of Apache Geronimo: Version 2.1.3 to 3.0.1 Prerequisites to monitor Apache Geronimo metrics: Click here Using the REST API to add a new Apache Geronimo monitor: Click here To create an Apache Geronimo Monitor, follow the steps given below:  Click on New Monitor link. Choose Apache Geronimo. Specify the Display Name of the Apache Geronimo monitor. Enter the HostName or IP Address of the host where Apache Geronimo runs. Enter the JMX Port of the Apache Geronimo. By default, it will be 1191.Enter the credential details like JMX user name and password  of Apache Geronimo server or select credentials from a Credential Manager list. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Spark server. Choose the Monitor Group from the combo box with which you want to associate Spark Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Spark from the network and starts monitoring Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Demo How to add Apache Geronimo monitor? Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Apache Geronimo Server monitors under the Application Servers Table. Displayed is the Apache Geronimo Server bulk configuration view distributed into three tabs: Availability tab  displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Monitor Information Overview JVM Web Data Sources EJB ActiveMQ JUDDI Cache Configuration Monitor Information Field Description Display Name The display name of Apache Geronimo monitor. Host Name / IP Address* The name or Ip address of the host where Apache Geronimo is running. Port The Port in which Apache Geronimo server is running. JMX Port The JMX port of the server. Username The  Username of Apache Geronimo instance. Password The  password of Apache Geronimo instance.Field Description JNDI Path The JNDI Path of the server Overview Parameter Description Server Response Time The response time of the Geronimo server. Used heap memory percentage The percentage of heap memory used. Free heap memory percentage The percentage of heap memory free. Used non-heap memory percentage The percentage of non heap memory used. Free non-heap memory percentage The percentage of non heap memory free. THREAD USAGE Daemon Thread Count The number of live daemon threads. Peak Thread Count The peak count of active threads in the system. Live Thread Count The current number of live threads. The total number of threads started since the java Total Thread Started virtual machine started. TRANSACTIONS Active Count The number of active transactions. Total Commits The total number of transaction commits. Total Rollbacks The total number of transaction rollbacks. JVM Parameter Description Class Loading  Loaded class count The number of classes currently loaded in the java virtual machine. Unloaded class count The number of classes unloaded since the java virtual machine has started. The total number of classes loaded since the java virtual machine has started Total Class count execution. Garbage Collector PC Scavenge Collection count The number of garbage collections carried out by the PC Scavenge rate PC Scavenge Collection time The time taken to collect garbage by PC Scavenge rate PC MarkSweep Collection time No. of garbage collected by MarkSweep rate PC MarkSweep Collection time Time taken to collect garbage by MarkSweep rate Memory Details  Name Heap Memory/ Non- Heap Memory usage in MB. Committed Current allocated memory in MB. Max Max allocated memory in MB. Used Current used memory in MB. Free Current free memory in MB. Free% The percentage of currently free memory. Used%  The percentage of currently used memory. Buffer Pool Direct Buffer Connection Count The total connections to Direct Buffer pool. Direct Buffer Space Used The total space used in the Direct Buffer pool. Direct Buffer Total Space  The total space in the Direct Buffer pool.Parameter Description Mapped Buffer Connection The total connections to Mapped Buffer pool. Count Mapped Buffer Space Used The total space used in the Mapped Buffer pool. Mapped Buffer Total Space The total space in the Mapped Buffer pool. Buffer Pool: A direct buffer is a chunk of memory typically used to interface Java to the OS I/O subsystems, for example as a place where the OS writes data as it receives it from a socket or disk, and from which Java can read directly. The mapped buffer pool is all the memory used by Java for its FileChannel instances. Web Parameter Description Web apps Context Web application''s context name Active Sessions Number of active sessions at this moment Duplicate Sessions Number of duplicated session ids generated Expired Sessions Number of sessions that expired. Rejected Sessions Number of sessions we rejected due to maxActive being reached Session Average Alive Time Average time an expired session had been alive. Session Max Alive Time Longest time an expired session had been alive. Session Create Rate Session creation rate in sessions per minute. Session Expire Rate Session expiration rate in sessions per minute. Global Request Processor Connector Name Connector name of the global request processor. Request Count Number of requests served by this global request processor. Error Count Number of error request received. Time taken by this global request processor to process the requests in Processing Time milliseconds. Bytes Sent Per Second Average bytes sent per second. Bytes Received Per Second Average bytes received per second. Successful Request (%) Percentage of successful requests. Failed Request (%) Percentage of failed requests. Data Sources Parameter Description Name Name of the data source. Active Connections Number of active connections to the data source. Idle Connections Number of idle connections to the data source. EJB Parameter Description EJP Pool Name Name of the EJB Pool Active Instances The no. of active instances Idle Instances The no. of idle instances. Initializing Instances The no. of initializing instances. Pooled Instances The no. of pooled instances. Access Timeouts The no. of times, access timeouts occurred. Aged The no. of aged instances.Parameter Description Flushed The no. of times, the pool is flushed. Garbage Collected The no. of times, the garbage collection occurred. ActiveMQ Parameter Description Apache ActiveMQ Broker Name Name of the Active MQ Broker. Memory Usage Percentage The percentage of the memory limit . Dequeue Count Number of messages that have been acknowledged on the broker. Enqueue Count Number of messages that have been sent to the broker. Consumer Count Number of message consumers subscribed to destinations on the broker. Message Count Number of unacknowledged messages on the broker. Temp Usage Percentage Percent of temp limit used. Store Usage Percentage Percent of store limit used. Apache ActiveMQ Topic Name Name of the Active MQ queue. Number of messages in the destination which are yet to be consumed. Queue Size  Potentially dispatched but unacknowledged. Number of messages that have been acknowledged (and removed from) from Dequeue Count the destination. Enqueue Count Number of messages that have been sent to the destination. Number of messages that have been delivered (but potentially not Dispatch Count acknowledged) to consumers. Expired Count Number of messages that have been expired. Number of messages that have been dispatched to, but not acknowledged by, InFlight Count consumers. Consumer Count Number of consumers subscribed to this destination. Producer Count Number of producers publishing to this destination. Max Enqueue Time The longest time a message has been held this destination. Min Enqueue Time The shortest time a message has been held this destination. Avg Enqueue Time Average time a message has been held this destination. Memory Usage Percentage The percentage of the memory limit used JUDDI The Universal Description, Discovery and Integration (UDDI) protocol is one of the major building blocks required for successful Web services. UDDI creates a standard interoperable platform that enables companies and applications to quickly, easily, and dynamically find and use Web services over the Internet (or Intranet). Parameter Description Name Name of the JUDDI implementation. Failed API Queries Count of API queries failed. Successful API Queries Count of successful API queries. Total API Queries Total number of API queries performed. Cache Parameter Description Name Name of the cache. Cache Max Size Max size of the cache.Parameter Description Cache Size Current cache size. Access Count Number of times the cache is accessed. Hit Count Number of cache hits. Note: Geronimo provides built-in caches for Active MQ, juddi, open-ejb server and system-database. Configuration Parameter Description HostName/IP Address Host name or IP address of the server. Port The port geronimo is running Geronimo Installation Directory The file directory where geronimo installed. Geronimo Version The version of the geronimo server. Host OS The operating system where the server is running. JVM Vendor Vendor of the virtual machine. JVM version Version of the virtual machine. Cloud Application Monitoring Cloud computing services help organizations to improve the flexibility and scalability of IT services delivered to their end users. Many IT organizations are moving a portion of their IT infrastructure to the cloud in order to improve flexibility and scalability of IT services delivered to end users. Public cloud service providers make it easy for companies to rent virtual computers on which to run their own applications and services. Nevertheless, it is important to continuously monitor these cloud hosted applications in order to ensure they perform at expected levels at all times, and also to ensure cloud resources are being effectively utilized. Cloud monitoring solutions from Applications Manager''s Cloud performance monitor enables you to ensure that your public cloud computing services perform their best at all times and that cloud resources are being effectively utilized. Cloud monitoring services from Applications Manager''s Cloud monitoring software enables high performance business process management by detecting and diagnosing problems of cloud applications faster. Following are the list of cloud monitoring services that are supported by Applications Manager''s Cloud performance monitor: Amazon Web Services (AWS) Microsoft Azure Microsoft 365 Oracle Cloud Google Cloud OpenStack Google Cloud Platform Monitoring Google Cloud Platform - An Overview Google Cloud Platform Monitoring - What we do Creating a new Google Cloud Platform monitor Monitored Parameters Troubleshooting Google Cloud Platform - An Overview Google Cloud is Google''s in-built cloud platform that provides a series of cloud services including computing, data storage, data analytics, and machine learning. Google Cloud Platform provides infrastructure as a service, platform as a service, and serverless computing environments. Google Cloud Platform Monitoring - What we doApplications Manager''s Google cloud platform monitoring tool will give you complete visibility into every component of your Google cloud environment thereby allowing you to optimize the performance of business critical Google cloud services. With our root cause analysis capabilities, you can easily identify the root cause of performance issues and troubleshoot them quickly. Our Google cloud monitoring capabilities will allow you to: Effortlessly monitor compute elements of your Google Cloud Platform. Collect and monitor key metrics like CPU usage, disk I/O, memory utilization, etc. View network status and understand performance trends. Creating a new Google Cloud Platform monitor Prerequisites for monitoring Google Cloud metrics: Click here Using the REST API to add a new Google Cloud Platform monitor: Click here Follow the steps given below to create a new Google Cloud Platform monitor: Click on New Monitor link. Select Google Cloud Platform under Cloud Apps category. Specify the Display Name of the Google cloud application. Enter the GCP Services you want to monitor. Specify the Project ID to be monitored. Specify OAuth Provider name. If you choose the Advanced Settings option, input the action you want to perform on deleted resources. Enable Stop discovery if you want to stop discovering resources under a particular service. Specify the Polling interval in minutes. If you are adding a new monitor from Admin server, select a Managed server. Choose the Monitor Group with which you want to associate the Google Cloud Platform monitor with, from the combo box. You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Google Cloud and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Google Cloud Platform under the Cloud Apps section. Displayed is the Google Cloud bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configuration. On clicking a monitor from the list, you''ll be taken to the Google Cloud dashboard. It has 3 tabs — Overview Compute Storage Overview INVENTORY Parameter Description Compute Engine Instances Total number of Compute Engine instances available. Cloud Storage Buckets Total number of Storage buckets available. Cloud Filestore Instances Total number of Filestore instances available. Kubernetes Engine Clusters Total number of Kubernetes Engine clusters available. App Engine Applications Total number of App Engine applications available. Cloud Functions Total number of Cloud Functions  available. Cloud Pub/Sub Topics Total number of Cloud Pub/Sub topics available. Cloud Dataflow Jobs Total number of Cloud Dataflow jobs available.Bigtable Instances Total number of Bigtable instances available. BigQuery Instances Total number of BigQuery instances available. Cloud SQL Instances Total number of Cloud SQL instances available. Quotas Parameter Description Metric name Name of the resource. Limit Total quotas allocated. Used Number of quotas used. Available Number of quotas available.   Note: Quota metrics are mapped under performance polling. To change the polling interval, go to Admin → Performance polling → Optimize data collection and choose ''Google Cloud Platform'' for ''Monitor Type'' and ''Quotas'' for the ''Metric name'' and change the ''Default Polling Status''. Compute Kubernetes Engine Parameter Description Name Name of the Kubernetes cluster. Location Name Location of the Kubernetes cluster. Status Current status of the cluster. Endpoint IP address of this cluster''s master endpoint. Current Node Count Total number of nodes currently present in the cluster. User Pods Count Total number of pods currently present in the cluster. By clicking over the cluster name, you will be redirected to the Google Kubernetes Engine monitoring dashboard. Compute Engine Parameter Description Name Name of the Compute Engine Instance. Instance ID ID of the Compute Engine Instance. Status Status of the Compute Engine Instance. Zone Zone in which the instance is available. External IP Address External IP Address of the instance. OS Platform Operating System of the Compute Engine Instance. By clicking over the instance name, you will be redirected to the Google Compute Engine monitoring dashboard. Storage Cloud Storage Parameter Description Name The name of the bucket in the Google Cloud instance. Location The location of the bucket. Location Type The type of location that the bucket resides in. Storage Class The storage type of the bucket. Bucket Size The size of the bucket (in GB). Number of Objects Total number of objects available in the bucket. By clicking over the bucket name, you will be redirected to the Google Cloud Storage monitoring dashboard. Cloud FilestoreParameter Description Name The name of the Filestore in the Google Cloud instance. Location Name The name of the region where the instance is created. Fileshare Name The name of the file share. Instance Tire The service tier of the instance. Total Storage Total storage capacity of the Filestore instance (in TB). Storage Utilization The amount of storage utilized in the Filestore instance (in percentage). Current IP Address Current IP address of the Filestore. By clicking over the Filestore name, you will be redirected to the Google Cloud Filestore monitoring dashboard. Troubleshooting 1. Authentication Failed. Request has invalid authentication credentials. In AppManager, go to Admin → OAuth Provider and check if the provider used in the GCP monitor has Valid Access Token and Refresh Token. Verify if the provider is created for the project being monitored. Verify if the prerequisites are fulfilled. 2. Access denied. Cloud resource manager API disabled. Go to GCP Console → APIs & Services → Library. Check if the Cloud Resource Manager API is enabled. If you enabled this API recently, wait a few minutes for the action to propagate and retry. 3. Authentication failed while connecting to Stackdriver API. Go to GCP Console → APIs & Services → Library and ensure Stackdriver API and Stackdriver Monitoring API are enabled. Check if the arguments of the selected OAuth Provider are valid. 4. Unable to fetch instances (or) Error fetching instances. Go to GCP console → APIs & Services → Library, and check if Compute Engine API is enabled. Note: Make sure you have a working internet connection to add or fetch data from the cloud services. If your environment requires the use of a proxy server to excess external websites, you can configure the proxy settings under the ''Admin'' tab.   Google Compute Engine Overview Monitored Parameters Troubleshooting Overview Google Cloud Compute Engine is an Infrastructure as a Service (IaaS) offering that provides a scalable number of virtual machines (VMs) to serve as large compute clusters. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Google Cloud under the Cloud Apps section. Displayed is the Google cloud bulk configuration view distributed into three tabs:Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Google Cloud dashboard. Under the parent monitor, you have 3 tabs. The child monitor has 4 tabs - Performance Network Disk Configuration Performance Parameter Description CPU: CPU Utilization Activity level from CPU. Expressed as percentage. Total CPUs Nmber of CPUs in usage CPU Usage CPU Usage for all cores, in seconds Memory: Memory Utilization Space currently in use. Expressed as a percentage. Total Memory Overall memory available Used Memory Amount of memory used Free Memory Amount of memory free Network Parameter Description Input Traffic Bytes received from the network expressed in KBps. Output Traffic Bytes sent over the network expressed in KBps. Input Traffic - Packets Count of packets received from the network Output Traffic - Packets Count of packets sent over the network Firewall dropped - Bytes Incoming bytes dropped by firewall expressed in KBps. Firewall dropped - Packets Count of incoming packets dropped by firewall Disk Parameter Description Disk Utilization: Disk Label Name of the disk allocated Used Amount of disk used Free Amount of disk available Disk Performance: Disk Name Name of the disk Disk Status Status of the disk Disk Size Size of the disk expressed in GB Disk Reads Bytes read from disk expressed in KB/sec Disk Writes Bytes written to disk expressed in KB/sec IO Read Operations Count of disk read IO Operations IO Write Operations Count of disk write IO Operations Disk Throttling:Parameter Description Disk Name Name of the disk Bytes in throttled read operations expressed in KB/sec (Throttle reason: Per Throttled Disk Reads Per GB GB limit) Bytes in throttled write operations expressed in KB/sec (Throttle reason: Per Throttled Disk Writer Per GB GB limit) Throttled IO Read Operations Per Count of throttled disk read operations (Throttle reason: Per GB limit) GB Throttled IO Write Operations Per Count of throttled disk write operations (Throttle reason: Per GB limit) GB Bytes in throttled read operations expressed in KB/sec. (Throttle reason: Per Throttled Disk Reads Per VM VM limit) Bytes in throttled write operations expressed in KB/sec. (Throttle reason: Per Throttled Disk Writes Per VM VM limit) Throttled IO Read Operations Per Count of throttled read operations (Throttle reason: Per VM limit) VM Throttled IO Write Operations Per Count of throttled write operations (Throttle reason: Per VM limit) VM Configuration Parameter Description Instance name Name of the instance Instance ID Unique ID of the instance Project ID Unique ID of the project Zone Zone in which the instance is created Status Current status of the instance (Running, terminated,...) Machine Type Virtualized hardware resources available to the instance External IP IP Address of the instance CPU Platform Base platform of the instance OS Platform Operating system running in the instance Start Restricted Restriction on the instance to perform start operation (True/False) Deletion Protection Restriction on the instance to perform delete operation (True/False) Troubleshooting 1. Data unavailable for performance metrics When an instance is started and polled immediately, data might not be collected for some of the performance metrics. Wait for some time and then poll the monitor to get the data. If the data is still not populated, go to Stackdrive Console and check if data is available. If data is available in Stackdriver and is not getting populated in AppManager, reach out to our support with the latest SIF generated with print all logs enabled. 2. Data unavailable for memory and disk utilization metrics Install Stackdriver Monitoring Agent in the instance, to get memory and disk utilization metrics. Click here for information on installing the Stackdriver agent. When an instance is started and polled immediately, data might not be collected for some of the performance metrics. Wait for some time and then poll the monitor to get the data. Google Cloud StorageGoogle Cloud Storage - Overview Google Cloud Storage is a storage platform that provides high-performance object storage services and offers excellent scalability, data availability, durability, and security. It allows you to store objects and access any amount of data instantly from any storage classes, integrate storage into your applications with a single unified API, and optimize price and performance easily. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Storage instance available under Google Cloud in the Cloud Apps section. Displayed is the Google Cloud Storage bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the Google Cloud Storage dashboard. It has 5 tabs: Overview Requests Network Objects Configuration Overview Parameter Description NUMBER OF OBJECTS: Number of Objects Total number of objects present in the Google Storage instance. BUCKET SIZE: Bucket Size The size of the bucket (in GB). REQUESTS: Total Requests/Min The total number of requests processed by the bucket per minute. NETWORK TRAFFIC: Total Incoming Traffic Total amount of data received over the network between two polls (in KB/sec). Total Outgoing Traffic Total amount of data sent over the network between two polls (in KB/sec). Requests Parameter Description READ REQUESTS: Get Object Requests/Min The total number of Get object requests made in a bucket per minute. Get Bucket Requests/Min The total number of Get Bucket requests made in a bucket per minute. Read Object Requests/Min The total number of Read object requests made in a bucket per minute. List Objects Requests/Min The total number of List object requests made in a bucket per minute. WRITE REQUESTS: Write Object Requests/Min The total number of Write object requests made in a bucket per minute. Delete Object Requests/Min The total number of Delete object requests made in a bucket per minute. Update Object Requests/Min The total number of Update object requests made in a bucket per minute. Clone Object Requests/Min The total number of Clone object requests made in a bucket per minute. Rewrite Object Requests/Min The total number of Rewrite object requests made in a bucket per minute. NetworkParameter Description READ INCOMING TRAFFIC: Get Object Incoming Traffic Amount of data received over the network for the Get Object method (in KB/sec). Get Bucket Incoming Traffic Amount of data received over the network for the Get Bucket method (in KB/sec). Amount of data received over the network for the Read Object method (in Read Object Incoming Traffic KB/sec). List Object Incoming Traffic Amount of data received over the network for the List Object method (in KB/sec). READ OUTGOING TRAFFIC: Get Object Outgoing Traffic Amount of data sent over the network for the Get Object method (in KB/sec). Get Bucket Outgoing Traffic Amount of data sent over the network for the Get Bucket method (in KB/sec). Read Object Outgoing Traffic Amount of data sent over the network for the Read Object method (in KB/sec). List Object Outgoing Traffic Amount of data sent over the network for the List Object method (in KB/sec). WRITE INCOMING TRAFFIC: Amount of data received over the network for the Write Object method (in Write Object Incoming Traffic KB/sec). Delete Object Incoming Amount of data received over the network for the Delete Object method (in Traffic KB/sec). Update Object Incoming Amount of data received over the network for the Update Object method (in Traffic KB/sec). Amount of data received over the network for the Clone Object method (in Clone Object Incoming Traffic KB/sec). Rewrite Object Incoming Amount of data received over the network for the Rewrite Object method (in Traffic KB/sec). WRITE OUTGOING TRAFFIC: Write Object Outgoing Traffic Amount of data sent over the network for the Write Object method (in KB/sec). Delete Object Outgoing Amount of data sent over the network for the Delete Object method (in KB/sec). Traffic Update Object Outgoing Amount of data sent over the network for the Update Object method (in KB/sec). Traffic Clone Object Outgoing Traffic Amount of data sent over the network for the Clone Object method (in KB/sec). Rewrite Object Outgoing Amount of data sent over the network for the Rewrite Object method (in KB/sec). Traffic Objects Parameter Description Top Objects by Size: Object Name (Top) Name of the object that is of higher size. Top Object Size Size of the object that is of higher size (in MB). Created Time (Top) Time at which the object of higher size was created. Recently Uploaded Objects: Object Name (Recent) Name of the object that was recently uploaded. Recently Uploaded Object Size Size of the object that was recently uploaded (in MB). Created Time (Recent) Time at which the recently-uploaded object was created. Category Wise Details: Category Category of the object. Count by Category Number of objects available in that category. Size by Category Total size of objects available in that category (in MB). Configuration Parameter DescriptionParameter Description BUCKET INFORMATION: Project ID Unique identifier of the project in which the bucket was created. Location The location of the bucket. Location Type The type of location that the bucket resides in. Storage Class The storage type of the bucket. Creation Time The creation time of the bucket. Last Updated Time Time at which the bucket was last updated. Bucket Policy Enabled Indicates whether Bucket level Policy is enabled for the bucket. Uniform Bucket Level Access Enabled Indicates whether Uniform Bucket level Access is enabled for the bucket. Google Cloud Filestore Google Cloud Filestore - Overview Google Cloud Filestore is a managed file storage service from Google that provides high-performance file storage for applications requiring a file system interface and a shared file system for data. It facilitates users in setting up their managed Network Attached Storage (NAS) systems with their Google Compute Engine and Kubernetes Engine instances, leading to predictably faster performance for file-based workloads. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Filestore instance available under Google Cloud in the Cloud Apps section. Displayed is the Google Cloud Filestore bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the Google Cloud Filestore dashboard. It has 3 tabs: Overview Disk Configuration Overview Parameter Description USAGE: Total Storage Total storage capacity of the Filestore instance (in TB). Used Storage Amount of storage utilized in the Filestore instance (in TB). Reserved Storage Amount of storage reserved in the Filestore instance (in TB). Free Storage Remaining amount of storage available in the Filestore instance (in TB). Storage Utilization Amount of storage capacity utilized in the Filestore instance (in percentage). Procedure Call Counts: Procedure Name Name of the procedure call. Count Number of procedure calls occurred. Disk Parameter Description I/O THROUGHPUT: Read Throughput Rate at which data is read from the disk (in MB/sec).Parameter Description Write Throughput Rate at which data is written to the disk (in MB/sec). I/O OPERATIONS: Read Ops Number of read operations occurred on the disk (in Ops/sec). Write Ops Number of write operations occurred on the disk (in Ops/sec). I/O LATENCY: Read Latency Amount of time taken to perform disk read operations (in millisecond). Write Latency Amount of time taken to perform disk write operations (in millisecond). Configuration Parameter Description BUCKET INFORMATION: Location Name The name of the region where the instance is created. Project ID Unique identifier of the project in which the bucket was created. State Indicates the state of the instance. (CREATING, READY, REPAIRING, DELETING, ERROR) Creation Time Time at which the bucket was created. Fileshare Name The name of the file share. Instance Tire The service tier of the instance. Authorized Network The name of the Google Compute Engine VPC network to which the instance is connected. Reserved IP Range The range of IP addresses reserved for this instance. Current IP Address Current IP address of the instance. Google Kubernetes Engine Google Kubernetes Engine - Overview Google Kubernetes Engine is an enterprise-grade platform for containerized applications, including stateful and stateless, AI and ML, Linux and Windows, complex and simple web apps, API, and backend services. It aids you in providing automatic application deployment, scaling and management of Nodes, Pods and Containers. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Kubernetes Engine instance available under Google Cloud in the Cloud Apps section. Displayed is the Google Kubernetes Engine bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the Google Kubernetes Engine dashboard. It has 4 tabs: Overview Nodes Pods Configuration Overview Parameter Description CLUSTER USAGE DETAILS Average Cluster CPU Utilization Average amount of CPU used by all nodes in the cluster (in percentage). Average Cluster Memory Utilization Average amount of memory used by all nodes in the cluster (in percentage).PODS Pod Utilization Amount of pods used by the cluster (in percentage). Maximum Pods Count Maximum number of pods that can be created. Used Pods Count Number of pods that are currently being used. NODE Cluster Node Count Total number of nodes that are currently present in the cluster. Nodes Parameter Description Node Pool Details Pool Name Name of the node pool. Version Kubernetes version of the node pool. Machine Type Name of the Google Compute Engine machine type used for the nodes. Status Status of the nodes in this pool instance. Disk Size Size of the disk attached to each node (in GB). Image Type The image type to use for this node. Disk Type Type of the disk attached to each node. Max Pods Per The constraint on the maximum number of pods that can be run simultaneously on a node in Node the node pool. Auto Scaling Indicates whether Auto Scaler configuration is enabled for this node pool. Enabled Node Pool On clicking the required node pool, you can view detailed information about the performance of nodes available under that node pool. Parameter Description Node Details Node Name Name of the node. Pool Name The name of the pool to which the node belongs. CPU Total Cores Total number of CPU cores on the node. CPU Allocatable Cores Number of allocatable CPU cores on the node. CPU Usage Time Cumulative CPU usage time of all cores used on the node (in milliseconds). CPU Utilization Amount of CPU ulitized by the node (in percentage). Total Memory Total memory allocated on the node (in GB). Memory Usage Amount of memory used by the node. Memory Utilization Amount of memory utilized by the node (in percentage). Input Traffic Amount of data received by the node over the network (in KB/Sec). Output Traffic Amount of data transmitted by the node over the network (in KB/Sec). Top 5 Nodes by CPU Utilization - Provides a graphical representation of the CPU utilization of top 5 nodes (in percentage). Top 5 Nodes by Memory Utilization - Provides a graphical representation of the Memory utilization of top 5 nodes (in percentage). Pods Parameter Description Pod CPU Details Pod Name Name of the pod. Number of Containers Total number of containers present in the pod. Namespace Name of the namespace.Parameter Description CPU Limit Cores Number of CPU cores limited by the pod. CPU Request Cores Number of CPU cores requested by the pod. Pod CPU Usage Time Cumulative CPU usage of the pod (in milliseconds). CPU Limit Utilization Amount of CPU limit that is currently in use (in percentage). CPU Request Utilization Amount of CPU request that is currently in use (in percentage). Top 5 Pods by CPU Details - Provides a graphical representation of the CPU utilization of top 5 pods with respect to CPU Request and CPU Limit (in percentage). Top 5 Pods by Memory Details - Provides a graphical representation of the Memory utilization of top 5 pods with respect to Memory Request and Memory Limit (in percentage). Pod Memory and Network Details Pod Name Name of the pod. Pod Input Traffic Amount of data received by the pod over the network (in KB/Sec). Pod Output Traffic Amount of data transmitted by the pod over the network (in KB/Sec). Memory Limit Total memory limit of all the containers in this pod (in MB). Memory Request Total memory request of all the containers in this pod (in MB). Pod Used Memory Total memory used by all the containers in this pod (in MB). Memory Limit Utilization Amount of memory limit that is currently in use (in percentage). Memory Request Utilization Amount of memory request that is currently in use (in percentage). Pod Volume and Ephemeral Storage Details Pod Name Name of the pod. Total Volume Total amount of disk volume allocated to the pod (in MB). Used Volume Amount of disk volume used by the pod (in MB). Volume Utilization Amount of disk volume that is currently being used by the pod (in percentage). Ephemeral Storage Limit Local ephemeral storage limit (in MB). Ephemeral Storage Request Local ephemeral storage request (in MB). Ephemeral Storage Used Local ephemeral storage usage (in MB). Container Details Container Name Name of the container. Pod Name Name of the pod in which the container is present. Restart Count Number of times the container has restarted. Namespace Name of the namespace. Configuration Parameter Description CONFIGURATION DETAILS Project ID Unique identifier of the project in which the cluster was created. Location Name Location of the cluster. Creation Time Creation time of the cluster. Status Current status of the cluster. Endpoint IP address of the cluster''s master endpoint. Subnetwork Name of the Google Compute Engine subnetwork to which the cluster is connected. Cluster IPv4 CIDR Range IP address range of the container pods in the cluster expressed in CIDR notation. Services IPv4 CIDR IP address range of the Kubernetes services in this cluster expressed in CIDR Range notation. Oracle Cloud Infrastructure MonitoringOracle Cloud - An Overview Oracle Cloud Monitoring - What we do Creating a new Oracle Cloud Monitor Monitored Parameters Oracle Cloud - An Overview Oracle Cloud is Oracle''s in-built cloud platform that helps you build and run a wide range of applications and services in a highly available hosted environment. Oracle cloud services such as IaaS, PaaS, SaaS, and DaaS are used to build, deploy, integrate, and extend applications in cloud. Oracle Cloud Monitoring - What we do Applications Manager''s Oracle Cloud Infrastructure monitoring tool will give you complete visibility into every component of your Oracle Cloud environment thereby allowing you to optimize the performance of business critical Oracle cloud services. With our root cause analysis capabilities, you can easily identify the root cause of performance issues and troubleshoot them quickly. Our Oracle cloud monitoring capabilities will allow you to: Effortlessly monitor compute elements of your Oracle cloud infrastructure. Collect and monitor key metrics like CPU usage, disk I/O, memory utilization, etc. Keep tabs on critical parameters like boot volume, block volume, etc. View network status and understand performance trends. Creating a new Oracle Cloud monitor Prerequisites for setting up Oracle Cloud monitoring : Click here Rest API for adding a new monitor : Click here Follow the steps given below to create a new Oracle Cloud monitor: Click on New Monitor link.Select Oracle Cloud under Cloud Apps category. Specify the Display Name of the Oracle cloud application. Enter the Services you want to monitor. Specify the Regions you have subscribed to. Specify the Tenancy OCID and User OCID. Provide the PEM file path. Follow these instructions to generate API signing key. Enter the Fingerprint of the public key. If you choose the Advanced Settings option, input the number of compartments you want to monitor. Enable Stop discovery if you want to stop discovering resources under a particular service. Select the Action you want to perform on the terminated resources. Specify the Polling interval in minutes. Click Add Monitor(s). This discovers the Oracle cloud and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Oracle Cloud under the Cloud Apps section. Displayed is the Oracle cloud bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. By clicking a monitor from the list, you will be taken to the Oracle Cloud dashboard. It has 4 tabs - Overview Compute Storage Database OverviewParameter Description TENANCY DETAILS: Total number of compartments Total number of compartments present in the tenancy. Total Number of Subscribed Regions Total number of regions that are subscribed by the tenancy. INSTANCE: Total Oracle Cloud Instances Number of Oracle Cloud instances present. Total Oracle Cloud Instances Running Number of Oracle Cloud instances that are running. STORAGE: Total Number of Buckets Total number of buckets present in Oracle Cloud Storage. Total Number of File Systems Total number of file systems present in Oracle Cloud Storage. Total Number of Mount Targets Total number of mount targets present in Oracle Cloud Storage. DATABASE: Total Number of Autonomous Databases Total number of databases present in Oracle Autonomous Database. Compute Parameter Description Instances: Name Name of the Oracle Cloud Instance. Status Status of the Oracle Cloud Instance. Compartment name Name of the compartment. Public IP Address Public IP Address of the instance. Operating System Operating System of the Oracle Cloud Monitor. Region Region where the Oracle Cloud Instance is running. You can perform the following admin actions on the required Compute instance(s): Delete: Deletes the selected Compute monitor instance(s) from the Applications Manager console alone. Start Instances: Starts the selected Compute instance(s) from Applications Manager. Stop Instances: Stops the selected Compute instance(s) from Applications Manager. By clicking over the instance name, you will be redirected to the Oracle Cloud Compute monitoring dashboard. Storage Parameter Description Buckets: Bucket Name The name of the bucket in the Oracle Cloud instance. Storage Tier The storage tier of the bucket in the Oracle Cloud instance. Compartment Name Name of the compartment. Region Region where the bucket is located. Number of Objects The number of objects available in the bucket. Bucket Size The size of the bucket (in GB). Visibility Denotes the visibility assigned to the bucket. File Systems: File System Name Name of the file system in the Oracle Cloud instance. Region Region where the file system is located. Compartment Name Name of the compartment. Utilization The amount of memory utilized by the file system (in GB). Life Cycle State The current state of the file system. Created Time The date and time at which the file system was created.Parameter Description Availability Domain The availability domain of the file system. Last Snapshot Name Name of the snapshot that was last taken. Backup Age The number of days that have elapsed since the last backup. Mount Targets: Mount Target Name Name of the mount target in the Oracle Cloud Instance. Life Cycle State The current state of the file system. Compartment Name Name of the compartment. Region Region where the mount target is located. IP Address The IP address of the mount target. Availability Domain The availability domain of the mount target. By clicking over the bucket name, you will be redirected to the Oracle Cloud Storage monitoring dashboard. Databases Parameter Description Autonomous Databases: Autonomous DB Name User-friendly name of the autonomous database. Life Cycle State The current state of the autonomous database. Compartment Name Name of the compartment. Region Region where the autonomous database instance is running. Database Name Actual name of the autonomous database. Workload Type The workload type of the autonomous database. CPU Core Count The number of CPU cores to be made available for the autonomous database. Dedicated Deployment Indicates whether the autonomous database uses the dedicated deployment type. You can perform the following admin actions on the required Autonomous Database(s): Delete: Deletes the selected Autonomous database(s) monitor instance from Applications Manager console alone. Start Databases: Starts the selected Autonomous database(s) from Applications Manager. Stop Databases: Stops the selected Autonomous database(s) from Applications Manager. By clicking over the DB name, you will be redirected to the Oracle Autonomous Database monitoring dashboard. Oracle Cloud Compute Overview Oracle Cloud Infrastructure Compute offers significant price-performance and control improvements compared to on-premises data centers, while providing elasticity and cost savings of the public cloud. It lets you provision and manage compute hosts, known as instances. It offers both bare metal and virtual machine instances. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Oracle Cloud under the Cloud Apps section. Displayed is the Oracle Cloud bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Oracle Cloud dashboard. Under the parent monitor, you have 3 tabs. The child monitor has 6 tabs:Performance Boot Volume Block Volume Network Configuration Performance Parameter Description CPU: CPU Utilization Activity level from CPU. Expressed as percentage of total time. Memory: Memory Utilization Space currently in use. Expressed as a percentage of used pages. Disk: Disk Read Read throughput expressed as bytes read per interval. Disk Write Write throughput expressed as bytes written per interval Disk Read IOPS Activity levels from I/O reads expressed as bytes read per interval. Disk Write IOPS Activity levels from I/O writes expressed as bytes written per interval. Network: NetworksBytesIn Network recieved throughputs expressed in bytes. NetworkBytesOut Network transmitted throughput expressed in bytes. Boot Volume Parameter Description Boot Volume Read throughput Read throughput expressed in bytes Boot Volume Write throughput Write throughput expressed in bytes Boot Volume Read operations Activity level from I/O reads expressed in bytes Boot Volume Write operations Activity level from I/O writes expressed in bytes Block Volumes Oracle Block volumes add storage capacity to an instance and enables you to dynamically provision and manage data. Parameter Description Block Volume Details: Volume OCID Oracle Cloud ID for the block volume. Block Volume A user-friendly name for the volume. Name Size In GB The size of the volume in GBs. Life Cycle State The current state of a volume. Specifies whether the cloned volume''s data has finished copying from the source volume Is Hydrated or backup. Block Volume I/O Statistics: Volume OCID Oracle Cloud ID of the block volume. Read The average number of bytes read from the block volume per second. Throughput(MB) Write The average number of bytes written to the block volume per second. Throughput(MB) Read Operations Number of read operations occurring in this block volume. Write Operations Number of write operations occurring in this block volume.Network Track the Virtual Network Interface Cards (VNICs) to determine how an instance connects with endpoints inside and outside a Virtual Cloud Network (VCN). Parameter Description Attached VNICs: VNIC OCID Oracle Cloud ID for the VNIC. VNIC Name A user-friendly name for the VNIC. Public IP Address The public IP address of the VNIC. Private IP Address The private IP address of the primary VNIC. Primary Indicates whether the VNIC is primary or not. Life Cycle State The current state of the VNIC. MAC Address The MAC address of the VNIC. Skip Source Destination Check Indicates Whether the source/destination check is disabled or not. VNIC Performance Metrics: VNIC OCID Oracle Cloud ID for the VNIC. Egress Packets Dropped by Security Number of packets sent from the VNIC dropped due to security List violations. Ingress Packets Dropped by Security Number of packets received from network dropped due to security List violations. Packets from Network Number of packets received by the VNIC after drops. Packets to Network Number of packets sent from the VNIC before drops. Input Traffic Rate at which data is received by the VNIC after drops (in KBps). Output Traffic Rate at which data is sent from the VNIC before drops (in KBps). Configuration Parameter Description INSTANCE INFORMATION: Instance Name Name of the instance Instance OCID Oracle Cloud ID of the instance. Status State of the instance. Compartment OCID Oracle Cloud ID for the compartment. Shape Shape of the instance. Region Localized geographic region of the instance. Public IP Address Public IP Address of the instance. Private IP Address Private IP Address of the instance. Availability Domain Availability domain of the instance. Fault Domain Fault domain of the instance. Launch Mode Specifies the configuration mode for launching virtual machine (VM) instances. Time Created The date and time during which the instance was created. Time Maintenance Reboot The date and time during which the instance is expected to reboot. Due OS INFORMATION: Operating System Name of the operating system used by the image. Operating System Version Version of the operating system used by the image. Boot Volume Size The boot volume size for an instance launched from this image. (MB) Image Name A user-friendly name for the image. Base Image ID The OCID of the image originally used to launch the instance.Parameter Description Determines whether instances launched with this image can be used to create new Create Image Allowed images. Image ID The Oracle Cloud ID of the image. Launch Mode Specifies the configuration mode for launching virtual machine (VM) instances. Life Cycle State State of the image. Boot Volume OCID Oracle Cloud ID of the boot volume. Oracle Cloud Storage Oracle Cloud Storage - Overview Oracle Cloud Storage is a storage platform that provides high-performance object and file storage services and offers excellent scalability, data availability, durability, and security. It allows you to store objects and access any amount of data instantly from anywhere and is ideal for storing unlimited amount of unstructured data such as images, media files, logs, backups, etc. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Storage instance available under Oracle Cloud in the Cloud Apps section. Displayed is the Oracle Cloud Storage bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the Oracle Cloud Storage dashboard. It has 4 tabs: Overview Requests Objects Configuration Overview Parameter Description NUMBER OF OBJECTS: Number of Objects The number of objects present in the Oracle Storage instance. BUCKET SIZE: Bucket Size The size of the bucket (in GB). TOTAL REQUESTS: Total Requests The total number of requests processed by the bucket. LATENCY: First Byte Latency The per-request time measured from the time Object Storage receives the complete Time request to when Object Storage returns the first byte of the response. Overall Latency The per-request time from the first byte received by Object Storage to the last byte sent Time from Object Storage. ERRORS: Client Side Error The total number of client-side errors made in the bucket. Count INCOMPLETE MULTIPART UPLOAD SIZE: Incomplete The size of any multipart upload parts that have not been discarded (aborted) or Multipart Upload committed. SizeRequests Parameter Description READ REQUESTS: GetObject Request The total number of Get object requests made in a bucket. Count HeadObject The total number of Head object requests made in a bucket. Request Count ListObjects Request The total number of List object requests made in a bucket. Count WRITE REQUESTS: DeleteObject The total number of Delete object requests made in a bucket. Request Count PutObject Request The total number of Put object requests made in a bucket. Count RenameObject The total number of Rename object requests made in a bucket. Request Count PostObject Request The total number of Post object requests made in a bucket. Count CopyObject Request The total number of Copy object requests made in a bucket. Count ArchiveObject The total number of Archive object requests made in a bucket. To archive objects, you Request Count must configure an Object Lifecycle policy.  REQUESTS THROUGHPUT: Get Requests/Min The number of Get request made per minute. Put Requests/Min The number of Put request made per minute. Objects Parameter Description Top Objects by Size: Object Name (Top) Name of the object that is of higher size. Top Object Size Size of the object that is of higher size (in MB). Created Time (Top) Time at which the object of higher size was created. Recently Uploaded Objects: Object Name (Recent) Name of the object that was recently uploaded. Recently Uploaded Object Size Size of the object that was recently uploaded (in MB). Created Time (Recent) Time at which the recently-uploaded object was created. Category Wise Details: Category Category of the object. Objects Count Number of objects available in that category. Category Size Total size of objects available in that category (in MB). Configuration Parameter Description BUCKET INFORMATION: Compartment Name Name of the compartment. Region Region where the bucket is located. Storage Tier The storage tier of the bucket. Created Time The date and time at which the bucket was created. Visibility Denotes the visibility assigned to the bucket.Parameter Description Object Level Audit Mode Specifies whether the audit logs are enabled for the objects in the bucket. Entity Tag The Entity Tag (or ETag) header value assigned to the bucket. Oracle Autonomous Database Oracle Autonomous Database - Overview An autonomous database is a fully managed, pre-configured cloud database environment that uses machine learning and Internet of Things (IoT) to perform tasks without any human intervention. It automates tasks associated with database tuning, security, backups, updates, etc. that are traditionally performed by database administrators (DBAs) and helps you in creating the database and performs maintenance tasks such as backing up, patching, upgrading and tuning the database with ease. Monitored Parameters Prerequisites for monitoring Oracle Autonomous DB metrics: Click here Go to the Monitors Category View by clicking the Monitors tab. Click on the Autonomous Database instance available under Oracle Cloud in the Cloud Apps section. Displayed is the Oracle Autonomous Database bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Oracle Autonomous Database dashboard. It has 6 tabs: Overview Tablespace Session Process Scheduled Jobs Configuration Overview Parameter Description UTILIZATION: CPU Utilization Amount of CPU utilized by the autonomous database (in percentage). Storage Utilization Amount of storage capacity utilized by the autonomous database (in percentage). CONNECTION STATISTICS: DB Connection Time taken to connect to the database (in seconds). Time SESSION DETAILS: Sessions The number of sessions running in the autonomous database. Current Logons The number of successful logons occurred during the selected time interval. The combined number of logons, parses, and execute calls during the selected time User Calls interval. QUEUED STATEMENTS THROUGHPUT: Running The number of running SQL statements aggregated across all consumer groups. Statements Queued The number of queued SQL statements aggregated across all consumer groups. Statements TRANSACTIONS: Execute Count The number of user and recursive calls that executed SQL statements.Parameter Description Total Parse Count The number of hard and soft parses occurred. Transaction Count The combined number of user commits and user rollbacks. FAILED LOGONS & CONNECTIONS THROUGHPUT: Failed Connections The number of failed database connections occurred. Failed Logons The number of failed logons occurred. Tablespace Parameter Description Tablespace Details: Tablespace Name Name of the tablespace. Allocated Bytes Allocated size of the tablespace (in GB). Total Allocated Bytes The total allocated size of the tablespace (in GB). Used Bytes The amount of storage that have been used in the tablespace (in GB). Free Bytes The remaining amount of storage that is free in the tablespace (in GB). Used Bytes (%) The amount of storage that have been used in the tablespace (in percentage). Free Bytes (%) The remaining amount of storage that is free in the tablespace (in percentage). Allocated Blocks The number of data blocks allocated to the tablespace. Free Blocks The number of free data blocks available in the tablespace. Tablespace Status: Tablespace Name Name of the tablespace. Tablespace Status The status of the tablespace. (ONLINE, OFFLINE or INVALID) Data Files The number of data files available in the tablespace. Read Rate Number of read operations that have occurred in the tablespace per minute. Write Rate Number of write operations that have occurred in the tablespace per minute. Read Time Time taken for a single read from the tablespace (in seconds). Write Time Time taken for a single write to the tablespace (in seconds). Performance of DataFiles: DataFile Name Name of the data file along with its location. Tablespace Name Name of the tablespace. Status The status of the data file. AutoExtend Denotes whether AutoExtend is enabled for this data file or not. Created Bytes The size of the data file (in MB). Reads Number of reads occurred from the data file. Writes Number of writes occurred to the data file. Average Read Time The average time taken for read operations to occur. (in millisecond) Average Write Time The average time taken for write operations to occur. (in millisecond) Objects Approaching MAX Extents: Owner Owner name of the table space. Tablespace Name Name of the tablespace. Segment Name Name of the segment approaching maximum extents. Segment Type The type of segment approaching maximum extents. Extents Number of extents allocated to the segment. Max Extents Maximum allowed extents that can be filled in a segment. Next Extents Size of the next extent (in megabytes). SessionParameter Description Session Details: ID Session Identifier for the connected session. Status Current status of the session. (ONLINE, OFFLINE or INVALID) Machine Name of the operating system. User Name Name of the Oracle process user. Amount of time elapsed after the user has logged into the Oracle server (in Elapsed Time seconds). CPU Time Amount of time the CPU was in use by the session. Memory Sorts Number of memory sorts used by the session. Table Scans Number of table scans performed. Physical Reads Number of physical reads occurred for the session. Logical Reads Number of physical reads occurred for the session. Commits Number of commits made by the user in a second. Cursor Number of cursors that are currently in use. Denotes the amount of session logical reads taking place from the buffer (in Buffer Cache Hit Ratio percentage). Sessions Summary: Machine Name Name of the machine hosting the session. Program Name of the program which is causing the session. Session Status Current status of the session. (ACTIVE or INACTIVE) Session Count Denotes the number of sessions that are running. Session Waits: Session ID Session Identifier for the connected session. User Name of the Oracle process user. Event Resource or event for which the session is waiting. State The state of the session. The wait time for the session. If the value is 0, it means the session is currently Wait Time waiting. Seconds in Wait Denotes the amount of time spent for the current wait condition (in seconds). Number of Event The number of events occurred during that session. Occurrence Users: Username The username assigned to the user. Expiry Date The date at which the user account expires. Days to Expiry The number of days remaining for the user account to expire. Account Status The current status of the user account. User Profile The profile name of the user. Process Parameter Description PGA Stats Per Process: Provides a graphical representation of the PGA used by processes. Oracle Process: Process ID Identifier for the Oracle process. PGA Allocated Amount of PGA memory allocated for the process (in megabytes). PGA Used Amount of PGA memory consumed by the process (in megabytes). Amount of allocated PGA memory that can be freed back to the operating system (in Freeable PGA megabytes). Max PGA Used Maximum amount of PGA memory consumed by the process.Parameter Description Program Name of the program in progress. Name Scheduled Jobs Parameter Description Schedule Jobs Details: Job Name Name of the job. Current State The current state of the job. Last Run Status Status of the job that was running during the last run. Last Run Date The date on which the job started running during the last run. Last Run Duration Amount of time the job took to complete during the last run (in seconds). Next Run Date The date on which the job is scheduled to run. Run Count Number of times the job has run. Failure Count Number of times the job has failed to run. Retry Count Number of times the job has retried to run. Elapsed Time Denotes the time elapsed since the job was started (in seconds). Is Enabled Denotes whether the job is enabled or not. Configuration Parameter Description CONFIGURATION DETAILS: Autonomous Database Name Name of the autonomous database. Compartment Name Name of the compartment. Region Region where the autonomous database instance is running. Compartment OCID Oracle Cloud ID for the compartment. CPU Core Count The number of CPU cores to be made available for the autonomous database. Auto Scaling Enabled Indicates if auto scaling is enabled for the Autonomous Database. Created Time The date and time on which the database was created. Dedicated Deployment Indicates if the database uses the dedicated deployment option. License Model The license model that applies to the Oracle Autonomous Database. DATABASE INFORMATION: Database Name Name of the Oracle database. Database Version Version of the valid Oracle Database for Autonomous Database. Data Storage Size The amount of storage available in the database (in terrabytes). Used Storage Size The amount of storage that has been used (in terabytes). The workload type of the autonomous database. Possible values are: Workload Type OLTP - Autonomous Transaction Processing DW - Autonomous Data Warehouse Always Free Resource Indicates if this the resource is ''Always Free''. The default value is false. Preview Version Indicates if the Autonomous Database is a preview version or not. Life Cycle State The current life cycle state of the autonomous database. Life Cycle Details Information about the current life cycle state of the autonomous database. The client IP access control list (ACL) for the database. (Available for server less White listed IPs deployments only) CONNECTION INFORMATION:Parameter Description Oracle Application Express URL of the Oracle Application Express (APEX). (APEX) URL Oracle SQL Developer Web URL of the Oracle SQL Developer. URL Service Console URL The URL of the Service Console for the Autonomous Database. Denotes the database service tpurgent used for autonomous transaction TPurgent processing operations. Denotes the database service tp used for autonomous transaction processing TP operations. Denotes the database service high used for autonomous transaction processing High operations. Denotes the database service medium used for autonomous transaction Medium processing operations. Denotes the database service low used for autonomous transaction processing Low operations. Amazon Web Services Monitoring Amazon Web Services (AWS) - Overview Creating a new Amazon Monitor, Settings and Demo Monitored Parameters Supported Regions Troubleshooting Amazon Web Services (AWS) - Overview Amazon Web Services (AWS) is a comprehensive cloud computing platform from Amazon. AWS offers an array of cloud computing services to build on from data centers spread across availability zones in regions across the world. However, you would still need a proper AWS monitoring software to be able to monitor and understand what is going on when you deploy and consume such a wide-ranging set of services. From your infrastructure and applications to your end-user experience, Applications Manager''s AWS monitoring provides robust monitoring of several core Amazon Web Services under your Amazon account. With all-in-one AWS cloud monitoring tools like Applications Manager in place, users can obtain a single pane view over various AWS services like: Amazon Elastic Compute Cloud (Amazon EC2) Amazon Elastic Load Balancing (Amazon ELB) Amazon Relational Database Service (Amazon RDS) Amazon Simple Storage Service (Amazon S3) Amazon Simple Notification Service (Amazon SNS) Amazon DynamoDB Amazon Simple Queue Service (Amazon SQS) Amazon Lambda Service (AWS Lambda) Amazon Elastic Beanstalk Service (AWS Elastic Beanstalk) Amazon Elastic Container Service (AWS ECS) Amazon Elastic Kubernetes Service (AWS EKS) In this help document, you will learn how to get started with AWS performance monitoring, along with the list of parameters that are monitored using Applications Manager. Supported Regions You can collect metrics, visualize resource usage and alert on operational behavior for all supported services across your AWS cloud environment for the following regions:Global Regions China Regions GovCloud (US) Regions Creating a new Amazon monitor Prerequisites for setting up Amazon performance monitoring: Click here. Using the REST API to add a new Amazon monitor: Click here To create a new Amazon monitor, follow the steps given below: Click on New Monitor link. Select Amazon under Cloud Apps category. Specify the Display Name of the Amazon server Select the Amazon Services you wish to discover and monitor from the drop-down menu. Enter the Access Key Id of the AWS for accessing the AWS through the API. The access key has 20 alpha- numeric characters. Enter the Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. Choose the Account Type. The default account type when adding a new Amazon monitor is AWS Global. Choose AWS China as the Account Type to monitor services in the AWS China regions, or choose AWS Gov Cloud to monitor services in the AWS GovCloud regions. Based on the ''Account Type'' chosen, select the regions to monitor from either Global Regions, China Regions, or Gov Cloud Regions drop-down menu.* Select a Child Discovery option.* If you choose the Advanced Settings option: * Select the action you want to perform on deleted resources using the Action on Deleted Resources field. Specify input for Regex to filter EC2 instances name option to filter our EC2 Instances based on the name. Enable Stop discovery if you want to stop discovering resources under a particular service. Specify the Polling interval in minutes. If you are adding a new monitor from Admin server, select a Managed server. Choose the Monitor Group with which you want to associate the Amazon monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Amazon server from the network and starts monitoring it. Note: Parameters marked with a * have been added from Applications Manager version 15180 onwards. How to add Amazon Web Services (AWS) Monitor? Amazon Data Collection Settings You can configure data collection settings for your Amazon monitor by going to the Admin tab, selecting Performance Polling under Discovery and then the Amazon tab. Here are the settings that you can customize for AWS performance monitoring in Applications Manager: You can set the Unique Identifier for EC2 instances to be either the instance ID or a tag name. Caution: Once set, changing the Unique Identifier will result in the existing monitors being deleted. If a new instance with Tag name of an already terminated instance is launched, it will be merged with the former instance. Enabling the Collect S3 Storage Statistics via CloudWatch API option allows you to fetch S3 Storage metrics using CloudWatch APIs.For Applications Manager versions till 15170: Option Description Alert for Terminated EC2 Option to receive notification when an EC2 instance is stopped. Instance Remove terminated EC2 Option to completely remove terminated EC2 Instances and Lambda functions Instances & Lambda from the Applications Manager console in the consecutiv next poll. Functions Remove deleted DynamoDB Option to completely remove deleted DynamoDB tables from the Applications tables Manager console in the next poll. Remove deleted Elastic Option to completely remove terminated Elastic Beanstalk Environments from the Load Balancers Applications Manager console in the next poll if the environment is terminated. Remove inactive ECS Option to completely remove terminated/deleted ECS clusters from the clusters Applications Manager console in the next poll if the cluster is terminated/deleted. Note: Make sure you have a working internet connecion to add or fetch data from the cloud services. If your environment requires the use of a proxy server to access external Websites, you can configure the proxy settings under the ''Admin'' tab. For Applications Manager versions 15180 onwards: Enable Auto Scaling alerts for EC2 instances: Option to receive alerts whenever an EC2 Instance is created/deleted. Set health severity as: Option to set Amazon monitor''s health severity as Critical or Warning whenever a new EC2 Instance is created or deleted. Raise autoscaling alerts when EC2 instances are: Option to configure when an alert has to be recieved (When an EC2 Instance is created/deleted/both) Monitored Parameters Amazon accounts are monitored based on the parameters or the attributes listed below. These attributes provide detailed information about the functioning of the Amazon account. You can also configure thresholds to the numerical attributes based on these details and get notified when the thresholds are violated. Go to the Monitors Category View by clicking the Monitors tab. Click on the Amazon monitor under the Cloud Apps Table. Displayed is the Amazon bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days along with key performance indicators of the Amazon account such as Total EC2 Instances running and Total RDS Instances along with heat charts for these attributes. List view tab enables you to perform bulk admin configurations and displays all the Amazon instances along with an overall idea of their availability and health status. AWS monitoring software like Applications Manager provide complete visibility into your Amazon cloud environments altogether in a single window based on the following tabs: Overview Compute (EC2, Lambda, Elastic Beanstalk) Containers (ECS, EKS) Database (RDS, DynamoDB) Amazon ELB S3 Buckets SNS Service Amazon SQS Billing Note: Each Amazon monitor instance is considered a basic monitor.Each service instances (except S3, SNS and Billing information) running in your Amazon monitor is considered a basic monitor. For more information, refer here. Overview Parameter Description COMPUTE RESOURCES Total EC2 Instances Running The number of EC2 instances running in the account. The total number of Application Load Balancers present in the Number of Application Load Balancers account. Number of Network Load Balancers The total number of Network Load Balancers present in the account. Number of Lambda Functions The total number of Lambda functions present in the account. Number of Elastic Beanstalk The total number of Elastic Beanstalk environments present in the Environments account. STORAGE RESOURCES Total EBS Volumes in use The number of EBS storage volumes currently in use. Total S3 Buckets The total number of S3 buckets present in the account. DATABASE RESOURCES Total RDS Instances The total number of RDS instances present in the account. Total DynamoDB tables The total number of DynamoDB tables present in the account. APPLICATION INTEGRATION Number of SQS Queues The total number of SQS Queues present in the account. Number of SNS Topics The total number of SNS topics present in the account. CONTAINERS Number of ECS Clusters The total number of ECS clusters present in the account. Number of EKS Clusters The total number of EKS clusters present in the account. Compute Following are the list of services that are shown in the ''Compute'' tab: EC2 Instances Lambda Elastic Beanstalk Environments EC2 Instances This table provides details about the EC2 instances present in the Amazon account. Know more about EC2 Monitoring Parameter Description EC2 Instances Instance ID The unique identifier of the EC2 instance The region where this EC2 instance is running. To know the list of regions supported, refer Region Name here. The current state of the instance. The values include running, stopped, shutdown and State terminated Platform The OS on which the instance is running Monitoring Indicates whether monitoring is enabled for the instance. Public DNS The DNS name associated with the instance. Name System Log Displays the system log of the instance.You can perform the following admin actions on the EC2 instances: Delete: Delete the EC2 instance from Applications Manager. Assign Platform: Assign platforms such as Windows, Mac OS, etc. to instances. Start Instances: Option to start the EC2 instance from Applications Manager. Stop Instances: Option to stop EC2 instances from Applications Manager. Reboot Instances: Option to reboot the EC2 instances from within Applications Manager. Lambda This table provides details about the Lambda functions present in the Amazon account. Know more about Lambda functions Parameter Description LAMBDA Function Name of the Lambda function. The region where this Lambda function is running. To know the list of regions supported, Region Name refer here. Version Version of the Lambda function. Runtime The runtime environment for the Lambda function. Deployed Code Size Size of deployment package of the function (in MB). (MB) Timeout The amount of time that Lambda allows a function to run before stopping it (in seconds). Last Modified Time Date and time at which the function was last modified. Elastic Beanstalk Environments This table provides details about the Elastic Beanstalk environments present in the Amazon account. Know more about Elastic Beanstalk Environments Parameter Description Elastic Beanstalk Environments Environment Name Name of the Elastic Beanstalk environment. The region where the Elastic Beanstalk environment is running. To know the list of regions Region Code supported, refer here. Tier Name Name of the tier. Indicates whether it is a WebServer or a Worker environment. Environment Status Status of the environment. (Ready, Launching, Updating, Terminating, or Terminated) Environment Health Shows the health status of the environment. (OK, Info, Unknown, No data, Warning, Status Degraded, or Severe) Containers ECS Clusters This tab provides details about the ECS clusters present in the Amazon account. Know more about ECS clusters Parameter Description ECS Clusters ClusterName Name of the ECS cluster. The status of the Cluster. (ACTIVE, PROVISIONING, DEPROVISIONING, FAILED, Status INACTIVE) Registered Container The number of containers instances registered to the cluster. Instances Active Services The number of active services running in the cluster. Running Tasks The number of tasks that are in RUNNING state. EKS Clusters This tab provides details about the EKS clusters present in the Amazon account. Know more about EKS clustersParameter Description EKS Clusters ClusterName Name of the EKS cluster. Status The status of the cluster. (CREATING, ACTIVE, DELETING, FAILED, UPDATING) Database Following are the list of services that are shown in the ''Database'' tab: RDS Instances DynamoDB RDS Instances This tab provides details about the RDS Instances present in the Amazon account. Know more about RDS Instances Parameter Description Instance ID The unique identifier of the instance. The region in which the RDS instance is running. To know the list of regions supported, refer Region Name here. The current state of this instance. The possible values for this field are available, creating, State failed, rebooting, etc. DB Engine Name The name of the database engine associated with this instance Allocated The storage space allocated to this instance in Giga Bytes Storage Aurora Cluster The name of the Aurora DB cluster. Name Cluster Instance The role that is associated with the Aurora DB instance. Role Cluster Group The current state of this DB cluster group. status DynamoDB In this table, you can gather data for performance metrics of you Amazon DynamoDB like latency, request throughput and throttling errors. Optimize resource usage and improve application performance of your Amazon Dynamodb database. Know more about DynamoDB monitoring Parameter Description Tables Name Name of the DynamoDB table. Name of the AWS region where the current DynamoDB table resides. To know the list of Region regions supported, refer here. Total Provisioned Total number of provisioned read capacity units for a table. Read CU Total Provisioned Total number of provisioned write capacity units for a table. Write CU Storage Size (GB) Total size of the specified table (in GB). Table Status Current status of the table. Creation Date The date and time at which the table was created. DynamoDB Account Limits Region The ID of AWS region where the current DynamoDB account resides. Region Name Name of the region at which the DynamoDB account is located. Read Limit Region wise maximum read capacity unit limit. Provisioned Read Number of provisioned read capacity units. Write Limit Region wise maximum write capacity unit limit. Provisioned Write Number of provisioned write capacity units.Parameter Description Table Read Limit Table-wise maximum read capacity units that can be provisioned. Table Write Limit Table-wise maximum write capacity units that can be provisioned. Amazon Elastic Load Balancing Applications Manager''s AWS ELB monitoring gives you the ability to monitor your Load Balancers, analyze traffic patterns and troubleshoot issues with your load balancers and targets for optimized performance. Know more about AWS ELB monitoring Application Load Balancers Parameter Description Name The name of the Application Load Balancer The AWS region in which the load balancer is configured. To know the list of regions supported, Region refer here. State The state of the load balancer - active | provisioning | active_impaired | failed. Availability The Availability Zones for the load balancer. zones VPC ID The ID of the VPC for the load balancer. Creation time The date and time the load balancer was created. Network Load Balancers Parameter Description Name The name of the Network Load Balancer The AWS region in which the load balancer is configured. To know the list of regions supported, Region refer here. State The state of the load balancer - active | provisioning | active_impaired | failed. Availability The Availability Zones for the load balancer. zones VPC ID The ID of the VPC for the load balancer. Creation time The date and time the load balancer was created. S3 Buckets This tab provides details about the S3 buckets present in the Amazon account. Parameter Description S3 Buckets Storage Statistics Bucket Name The unique name of the S3 bucket. Bucket Size The size of the S3 bucket in megabytes. Bucket The geographical region where Amazon has stored this bucket. To know the list of regions Location supported, refer here. Creation Time The time when the bucket was created. Virtual The number of folders present in this S3 bucket. Folders Number of The number of objects stored in this S3 bucket. Objects S3 Buckets Request Statistics Bucket Name The unique name of the S3 bucket. Total The total number of HTTP requests made to the bucket. Requests Requests/min Number of requests made per minute to the bucket. Get Requests The number of HTTP GET requests made for objects in the bucket. Put Requests The number of HTTP PUT requests made for objects in the bucket.Parameter Description First Byte The per-request time (in milliseconds) from the complete request being received by the bucket Latency to when the response starts to be returned. The elapsed per-request time (in milliseconds) from the first byte received to the last byte sent to Total Request the bucket. This includes the time taken to receive the request body and send the response body, Latency which is not included in First Byte Latency. Bytes The number of bytes downloaded (in MB) for requests made to the bucket, where the response Downloaded includes a body. Bytes The number of bytes uploaded (in MB) that contain a request body, made to the bucket. Uploaded Client Errors The number of HTTP 4xx client error status code requests made to the bucket. Server Errors The number of HTTP 5xx server error status code requests made to the bucket. You can perform the following admin actions on the S3 buckets from within Applications Manager. Disable: Disables the monitoring of S3 bucket. Enable: Enables the monitoring of S3 bucket. Delete: Deletes the S3 bucket from Applications Manager console. Please note that the required S3 bucket instance should first be deleted from your AWS account before performing this action. Otherwise, Applications Manager will rediscover that S3 bucket and start monitoring again. You can also view comparison reports based on attributes such as bucket size, virtual folders and number of object Note: ''Virtual Folder'' metric is not supported upon using CloudWatch API to fetch Storage metrics. To monitor S3 Bucket Request metrics, the same should be enabled in AWS console. We recommend using the name EntireBucket for a filter that applies to all objects. For more information, refer here. SNS Services In this tab you can monitor region and topic-wise metrics like notification status (delivery and failure), SMS deliveries, messages throughput - sent and failed counts, subscription count and more. Know more about SNS Service monitoring Parameter Description Total Messages The total number of messages published throughout all the AWS supported regions. Published Total Notifications The total number of messages delivered throughout all the AWS supported regions. Delivered Total Notifications The total number of messages failed throughout all the AWS supported regions. Failed Total Published The total size of messages published throughout all the AWS supported regions. Size (KB) Notifications The percentage of total delivered notifications. Delivered (%) Notifications The percentage of total failed notifications. Failed (%) SMS Month-To- The total charges accrued since the start of the current calendar month for sending SMS Date charges messages in AWS supported regions. Unit - USD SQS Services In this tab, you can monitor all the available queues that are running within the SQS service. Know more about SQS service monitoring Parameter Description Queue Name Name of the queue. Queue Type Type of the queue. (Standard/FIF0) Region Shows the region where the queue was created. To know the list of regions supported, referhere. Arrival Rate The rate at which the messages are arrived in the queue per minute. Completion The rate at which the messages are processed and deleted in the queue per minute. Rate Created Time Displays the time when the queue was first created. Billing Parameters Description Total Expenditure And Forecast Month-to- Date The total expenditure in the current month for an AWS account. Expenditure Current Month The cost forecast for the current month. Forecast Services And Tax Month-to- Date Services The total cost in USD incurred by all the services [Excluding tax]. Cost Month-to- The total cost in USD by tax. Date Tax Month-to-Date Top Services by Spend Month-to- The Month-to-Date Spend by Service graph shows the top services that you use most and the Date Costs proportion of your costs(USD) that that service contributed to [excluding forecasting and *tax*]. (USD) Month-to-Date Spend by Service AWS Service The AWS services that you use. Costs (USD) The cost in USD incurred for the month to date by the services. Note: The Billing data will be available only for AWS Global accounts. The polling interval for the AWS Billing Statistics can be changed by going to the Admin tab, clicking Performance Polling under Discovery and Data Collection, and navigateing to the Optimize Data Collection tab. Choose Amazon for the Monitor Type & AWS Billing Dashboards for the Metric Name and change the Default Polling Status.(Default and preferred time interval is 24 hours). Supported Regions AWS Global Regions From version 13600 onwards, we support the following global AWS regions: US East (N. Virginia) US East (Ohio) US West (N. California) US West (Oregon) Canada (Central) South America (Sao Paulo) EU (Frankfurt) EU (Ireland) EU (London) EU (Paris) EU (Stockholm) Asia Pacific (Tokyo) Asia Pacific (Seoul) Asia Pacific (Mumbai) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Hong Kong) Asia Pacific (Osaka-Local) Middle East (Bahrain)Africa (Cape Town) Europe (Milan) In case you want to monitor AWS in all the above-mentioned regions, choose the All Regions option under Global Regions in the Add/Edit monitor page. By default, this option will be selected. Note: Do not specify other regions when All Regions option is selected. If other regions are chosen along with All regions, only the chosen regions will be considered while adding/updating the monitor. AWS China Regions The China regions are isolated from all other AWS (Global) regions and operated by AWS''s Chinese partners separately from all other AWS regions. However, the cloud services offered in both AWS China regions are the same as those available in other AWS (Global) regions. From Version 13620, we support monitoring of Amazon Web Services in AWS China regions. Here is a list of regions available in the AWS China account: China (Beijing) China (Ningxia) The default Account Type when adding a new Amazon monitor is AWS Global. Choose AWS China as the Account Type to monitor services in the AWS China regions. AWS Gov Cloud Regions AWS Gov Cloud (US) gives government customers and their partners the flexibility to architect secure cloud solutions. This is designed to host sensitive data, regulated workloads, and address the most stringent US government security and compliance requirements. AWS Gov Cloud regions are operated by employees who are US citizens on US soil, and are accessible only to US entities and root account holders who pass a screening process. From version 15390 onwards, we support monitoring of Amazon Web Services in AWS Gov Cloud regions. Following are the list of regions available in the AWS Gov Cloud account: US East (US-Gov-East) US West (US-Gov-West) The default Account Type when adding a new Amazon monitor is AWS Global. Choose AWS Gov Cloud as the Account Type to monitor services in the AWS Gov Cloud (US) regions. Troubleshooting 1. Some instances of EC2, RDS, S3, SNS are not being discovered for data collection There are two ways of authenticating information in the requests made to AWS to collect data: Signature version 2 (S2) and Signature version 4 (S4) In the following regions, AWS supports only signature version 4 signing process: [US East (Ohio), Canada (Central), Asia Pacific (Mumbai), Asia Pacific (Seoul), EU (Frankfurt), EU (London)]. If you are using AWS services from the regions which supports only S4, Applications Manager will not discover them as they require S4 signing process. Solution: Upgrade to Applications Manager Version 13600 (or newer). We have upgraded to the latest aws jar and support both signing processes in AWS. From Version 13600, we also support all 15 regions available currently. (Know more) Note: Make sure you have a working internet connecion to add or fetch data from the cloud services. If your environment requires the use of a proxy server to access external Websites, you can configure the proxy settings under the ''Admin'' tab. 2. When child monitors are not discovered or when no data in AWS and its child monitors. Check the list of APIs mentioned in this page and make sure the IAM user has all the required API permissions. Check the region in which the user has created the resources in AWS and make sure the same region is supported/discovered in Applications Manager. Know more3. No data in EC2 Instance in OS level metrics. Most of the times, the issues occurs due to the wrong configuration in agent configuration file, using which the Cloudwatch agent fetches the data from the EC2 instances. Applications Manager can fetch the data from CloudWatch based on the following: Namespace - AWS allows the user to have any namespace, but only ''CWAgent'' as namespace is supported in Applications Manager Dimensions - Only ''InstanceId'' as dimension is supported in Applications Manager. If any additional dimensions are configured in agent configuration file, then it is not supported. It looks for only the ''instanceid'' dimension. In every data collection of EC2 instance monitor, first we look for ''Memory'' metrics in Windows/Linux instances, and then we check for ''Disk'' metrics. Make sure users are configured similar to the metrics mentioned in this page sample configuration files. Amazon Elastic Load Balancing Amazon Elastic Load Balancing - An Overview Monitoring Amazon Elastic Load Balancing- What We do Adding a new Amazon ELB monitor Monitored Parameters Application Load Balancer Metrics Network Load Balancer Metrics Amazon Elastic Load Balancing - An Overview Elastic Load Balancing (ELB) is a load-balancing service from Amazon Web Services (AWS). AWS ELB automatically distributes incoming application traffic across multiple targets, such as EC2 instances, and scales resources to meet traffic demands.  Elastic Load Balancing helps IT teams adjust capacity according to incoming application and network traffic. AWS ELB supports three types of load balancers: Application Load Balancers, Network Load Balancers and Classic Load Balancers. The Application Load Balancer handles advanced traffic routing from other services or containers at the application level. The Network Load Balancer is ideal for load balancing of TCP traffic and capable of handling millions of requests per second while maintaining low latencies. Monitoring Amazon Elastic Load Balancing - What We do This page discusses how Applications Manager''s AWS ELB monitoring gives you the ability to monitor your Load Balancers, analyze traffic patterns and troubleshoot issues with your load balancers and targets for optimized performance. Gather real-time performance data - Get basic data about the number of healthy hosts, latency, requests, error rates and more. Analyze connection count statistics - Monitor the number of rejected connections to follow your Load Balancer’s ability to properly connect to a target and route a request.  Measure the number of rules and bytes processed by the Application ELB. Track healthy and unhealthy host count - Monitor the number of healthy targets registered with the Application Elastic Load Balancer. Maintain a Healthy Host Count by tracking healthy instances Troubleshoot and monitor target HTTP error response codes - Gather statistics on the number of Client and Server errors generated by the load balancer. Measure the number of TLS connections that could not successfully establish a session between your load balancer and its registered instances. Get an aggregate of HTTP 4XX and 5XX error codes generated by the targets in your group. Detect real-time performance issues and fix them faster - Understand the scalability of your ELB system and get a jumpstart on monitoring the Load Balancers in your environment. Applications Manager provides the ability to monitor your ELB configuration with detailed metrics about the requests made to your load balancers.Get instant notifications of performance issues and bottlenecks. Take quick remedial action before your end- users experience issues. Creating a new Amazon ALB/NLB monitor Mode of Monitoring: CloudWatch & AWS API using SDK. Prerequisites for setting up Amazon ELB monitoring: Click here To create a new Amazon monitor, follow the steps given below: Click on New Monitor link. Select Amazon under Cloud Apps category. Specify the Display Name of the Amazon server Choose ALB or NLB as the Amazon Service you wish to monitor. Enter the Amazon Access Key Id of the AWS for accessing the AWS through the API. The access key has 20 alpha-numeric characters. Enter the Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. Choose the Account Type. The default Account Type when adding a new Amazon monitor is AWS Global. Choose AWS China as the Account Type to monitor services in the AWS China regions. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Amazon monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Amazon server from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on ALB or NLB in the Amazon Instances under the Cloud Apps Table. Displayed is the bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the Amazon ALB metrics listed under the following tabs: Overview Errors Target Groups Targets Configuration Click on the monitor name to see all the Amazon NLB metrics listed under the following tabs: Overview Errors Target Groups Targets Configuration Applications Load Balancer (ALB) Metrics Applications Load Balancer - Overview Parameter Description AVERAGE LATENCY Average The time elapsed, in seconds, after the request leaves the load balancer until a response from Target Latency the target is received. This is equivalent to the target_processing_time field in the access logs. REQUESTSParameter Description The number of requests processed over IPv4 and IPv6. This count includes only the requests Total Requests with a response generated by a target of the load balancer.  Requests / Min The requests processed per minute over IPv4 and IPv6. CONNECTIONS Active The total number of concurrent TCP connections active from clients to the load balancer and Connections from the load balancer to targets.  New The total number of new TCP connections established from clients to the load balancer and Connections from the load balancer to targets. Rejected The number of connections that were rejected because the load balancer had reached its Connections maximum number of connections.  PROCESSED BYTES Total Data The total number of bytes processed by the load balancer over IPv4 and IPv6. Processed Data The bytes processed per minute by the load balancer over IPv4 and IPv6. Processed/Min RULE EVALUATIONS Rule The number of rules processed by the load balancer given a request rate averaged over an hour. Evaluations CONSUMED LB CAPACITY UNITS Consumed The number of load balancer capacity units (LCU) used by your load balancer.  Capacity Units Applications Load Balancer - Errors Parameter Description CONNECTION ERRORS Client TLS Negotiation The number of TLS connections initiated by the client that did not establish a session Errors with the load balancer.  Target TLS Negotiation The number of TLS connections initiated by the load balancer that did not establish a Errors session with the target.  Target Connection The number of connections that were not successfully established with the target. Errors LOAD BALANCER ERRORS ELB Client Errors The number of client errors that originate from the load balancer.  ELB Server Errors The number of server errors that originate from the load balancer.  Applications Load Balancer - Target Groups Parameter Description CONFIGURATION INFO Target Group The name of the target group. Port The port to use to connect with the target. Protocol The protocol to use to connect with the target. Target type The type of target that you must specify when registering targets with this target group. Timeout(Seconds) The amount of time, in seconds, during which there was no response from the target. Interval(Seconds) The approximate amount of time, in seconds, between health checks of an individual target.  HEALTHY AND UNHEALTHY HOST Healthy Host The number of targets that are considered healthy after health checks. Count Unhealthy Host The number of targets that are considered unhealthy after health checks. Count TARGET GROUP REQUESTSParameter Description Request Count The number of requests processed over IPv4 and IPv6. PERFORMANCE METRICS Target Group The name of the target group. Healthy Hosts The number of targets that are considered healthy after health checks. Unhealthy Hosts The number of targets that are considered unhealthy after health checks. The time elapsed, in seconds, after the request leaves the load balancer until a response Average Target from the target is received. This is equivalent to the target_processing_time field in the Latency(Seconds) access logs. The number of requests processed over IPv4 and IPv6. This count includes only the requests Total Requests with a response generated by the targets in a specific target group. The average number of requests received by each target in a target group. You must specify Requests Per the target group using the TargetGroup dimension. This metric does not apply if the target is Target a Lambda function. ERRORS Target Group The name of the target group. Target The number of connections that were not successfully established with the target. Connection Errors Target TLS The number of TLS connections initiated by the load balancer that did not establish a Negotiation Errors session with the target.  Target HTTP 5XX The number of HTTP 5XX server error codes that originate from the load balancer. Errors Target HTTP 4XX The number of HTTP 4XX client error codes that originate from the load balancer.  Errors Target HTTP 3XX The number of HTTP 3XX redirection codes that originate from the load balancer. Errors Target HTTP 2XX The number of HTTP response codes generated by the targets.  Errors Applications Load Balancer - Targets  Parameter Description TARGET DETAILS Target ID The ID of the target. If the target type of the target group is instance, specify an instance ID. Target The name of the Target Group. Group Port The port on which the target is listening. Status The state of the target - initial | healthy | unhealthy | unused | draining | unavailableParameter Description Heatlty: If the target state is healthy, a reason code is not provided. Initial: If the target state is initial, the reason code can be one of the following values: Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer. Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status. Unhealthy: If the target state is unhealthy, the reason code can be one of the following values: Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Target.Timeout - The health check requests timed out. Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason. Elb.InternalError - The health checks failed due to an internal error. Reason Unused: If the target state is unused, the reason code can be one of the following values: Target.NotRegistered - The target is not registered with the target group. Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. Target.IpUnusable - The target IP address is reserved for use by a load balancer. Target.InvalidState - The target is in the stopped or terminated state. Draining: If the target state is draining, the reason code can be the following value: Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired. Unavailable: If the target state is unavailable, the reason code can be the following value: Target.HealthCheckDisabled - Health checks are disabled for the target group. Applications Load Balancer - Configuration Parameter Description CONFIGURATION DETAILS Load Balancer The ID of the load balancer. ID Region The AWS region in which the load balancer is configured. State The state of the load balancer - active | provisioning | active_impaired | failed. Type The type of load balancer -  application or  network. DNS name The public DNS name of the load balancer. Internet-facing OR internal. Internet-facing load balancers can route requests from clients over the Scheme internet. Internal load balancers can only route requests from clients with access to the VPC for the load balancer.  IP address The type of IP addresses used by the subnets for your load balancer.  type VPC ID The ID of the VPC for the load balancer. Availability The Availability Zones for the load balancer. zones Security The IDs of the security groups for the load balancer. groups Creation The date and time the load balancer was created. timeNetwork Load Balancer Metrics Network Load Balancer - OVERVIEW Parameter Description TCP CONNECTIONS Active The total number of concurrent TCP connections active from clients to the load balancer and Connections from the load balancer to targets.  The total number of new TCP connections established from clients to the load balancer and New Connections from the load balancer to targets. TLS CONNECTIONS Active TLS The total number of concurrent TLS  connections from clients to targets. Connections New TLS The total number of new TLS  connections established from clients to targets in the time Connections period.  DATA PROCESSED (TCP) Data processed The total number of bytes processed by the load balancer. (TCP) Data processing The rate of bytes processed  per minute by the load balancer. rate (TCP) CONSUMED LB CAPACITY UNITS Consumed The number of load balancer capacity units (LCU) used by your load balancer. You pay for Capacity Units the number of LCUs that you use per hour. Network Load Balancer - ERRORS Parameter Description CONNECTION ERRORS Client TLS Negotiation The total number of TLS handshakes that failed during negotiation between a client Errors and a TLS listener.  Target TLS Negotiation The total number of TLS handshakes that failed during negotiation between a TLS Errors listener and a target.  RESET PACKETS COUNTERS Client Reset Packets The total number of reset (RST) packets sent from a client to a target. Load Balancer Reset The total number of reset (RST) packets generated by the load balancer. Packets Target Reset Packets The total number of reset (RST) packets sent from a target to a client.  Network Load Balancer - TARGET GROUPS Parameter Description TARGET GROUPS DATA Target Group The name of the target group. Port The port to use to connect with the target. Protocol The protocol to use to connect with the target. Target type The type of target that you must specify when registering targets with this target group. Timeout (seconds) The amount of time, in seconds, during which there was no response from the target. Interval (seconds) The approximate amount of time, in seconds, between health checks of an individual target.  Healthy Hosts The number of targets that are considered healthy.  Unhealthy Hosts The number of targets that are considered Unhealthy. Network Load Balancer - TARGETS Parameter DescriptionParameter Description TARGET DETAILS Target ID The ID of the target. If the target type of the target group is instance, specify an instance ID. Target The name of the Target Group to which the target is mapped. Group Port The port on which the target is listening. Status The state of the target - initial | healthy | unhealthy | unused | draining | unavailable Healthy: If the target state is healthy, a reason code is not provided. Initial: If the target state is initial, the reason code can be one of the following values: Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer. Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status. Unhealthy: If the target state is unhealthy, the reason code can be one of the following values: Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Target.Timeout - The health check requests timed out. Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason. Elb.InternalError - The health checks failed due to an internal error. Reason Unused: If the target state is unused, the reason code can be one of the following values: Target.NotRegistered - The target is not registered with the target group. Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. Target.IpUnusable - The target IP address is reserved for use by a load balancer. Target.InvalidState - The target is in the stopped or terminated state. Draining: If the target state is draining, the reason code can be the following value: Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired. Unavailable: If the target state is unavailable, the reason code can be the following value: Target.HealthCheckDisabled - Health checks are disabled for the target group. Network Load Balancer - CONFIGURATION Parameter Description CONFIGURATION DETAILS Load Balancer The ID of the load balancer. ID Region The AWS region in which the load balancer is configured. State The state of the load balancer - active | provisioning | active_impaired | failed. Type The type of load balancer -  application or  network. DNS name The public DNS name of the load balancer. Internet-facing OR internal. Internet-facing load balancers can route requests from clients over the Scheme internet. Internal load balancers can only route requests from clients with access to the VPC for the load balancer. IP address The type of IP addresses used by the subnets for your load balancer. type VPC ID The ID of the VPC for the load balancer.Parameter Description Availability The Availability Zones for the load balancer. zones Creation The date and time the load balancer was created. time Amazon SQS Monitoring Amazon SQS - Overview Amazon Simple Queue Service (SQS) is distributed message queuing service introduced by Amazon in 2004. SQS lets us to integrate and decouple distributed software systems and components. It offers to send, receive and delete messages programmatically via web service applications. Unlike other message queuing services, it is serverless. Monitored Parameters Prerequisites for monitoring Amazon SQS metrics: Click here Go to the Monitors Category View by clicking the Monitors tab. Click on the SQS instance available under Amazon in the Cloud Apps section. Displayed is the Amazon SQS bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the AWS SQS dashboard. It has 2 tabs: Overview Configuration Overview Parameter Description PERFORMANCE RATE Arrival Rate The rate at which the messages are arrived in the queue per minute. Completion Rate The rate at which the messages are processed and deleted in the queue per minute. BREAKDOWN OF STANDARD/FIFO MESSAGES Visible Messages Number of messages that are available for retrieval. Not Visible Messages Number of messages that are not available for retrieval. Delayed Messages Number of messages that are in delayed state. (Applicable only for Standard queue) PROCESSED MESSAGES Messages Received Number of messages returned by requests to the ReceiveMessage API action. Empty Receives Number of ReceiveMessage API calls that did not yield a message. AGE OF OLDEST MESSAGE Age of Oldest Message Measures the approximate age of the oldest non-deleted message. SIZE OF SENT MESSAGES Sent Message Size Measures the size of the messages added to the queue (in KB). Rate of Sent Message Size Measures the rate of size of the messages added to the queue (in KB/sec). Configuration Parameter Description FIFO/STANDARD QUEUE DETAILS Queue URL Shows the URL of the Amazon SQS queue.Parameter Description Created Time Displays the time when the queue was first created. Last Modified Time Displays the time when the queue was last modified. Region Name Shows the region where the queue was created. Queue Type Shows the type of queue. (Standard/FIFO) Content-based Shows whether the content based deduplication is enabled for the queue. (Applicable Deduplication only for FIFO queue) STANDARD/FIFO QUEUE CONFIGURATIONS Amount of time for which the message will be in delayed state (in seconds). (Applicable Delayed Time only for Standard queue) Received Message The time a ReceiveMessage API action waits for the message to arrive (in seconds). Wait Time Maximum Message The maximum limit of size a message can contain before Amazon SQS rejects it. Size Message Retention Time for which Amazon SQS retains a message (in seconds). Period Time during which Amazon SQS prevents other consumers from receiving and Visibility Timeout processing the message (in seconds). Dead Letter Target ARN of the Dead letter queue where Amazon SQS moves the message after maximum ARN receives value is exceeded. Maximum number of times a message is delivered to the queue before being moved to a Maximum Receives dead letter queue. Customer Master Key ID of the AWS managed Customer master key (CMK) for the Amazon queue. Key Reuse Period Time for which a data key can be reused to encrypt or decrypt messages (in seconds). Amazon EC2 Instance Monitoring Monitored Parameters The Amazon EC2 instances are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the EC2 instances. You can also configure thresholds to the numerical attributes based on these details and get notified when the thresholds are violated. Go to the Monitors Category View by clicking the Monitors tab. Click on the EC2 Instance of Amazon monitors under the Cloud Apps Table. Displayed is the Amazon EC2 bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and key performance indicators of an EC2 instance such as CPU Utilization, Volume Idle Time, Network In and Network Out along with the heat charts for these attributes for the past 24 hours or 30 days. List view displays all the EC2 instances present in the Amazon account along with an overall idea of their availability and health status. In this tab, you can also perform bulk admin configurations. Below is an explanation of the metrics shown in the following tabs: Overview OS Level Metrics Linux Windows Attached Volumes Configuration Note: The metrics marked with an * are collected using Amazon''s Cloudwatch OverviewThis tab provides a high-level overview of the EC2 instance as well as its performance indicators. Parameter Description Monitor Information Name The name of the EC2 instance Type Denotes the type you are monitoring. Health Denotes the health (Clear, Warning, Critical) status of the EC2 instance. Region Name Name of the region where the instance is running Instance Type Indicates the type of the EC2 instance The current state of the instance. Valid values include running, stopped, State shutdown and terminated Public IP Address The IP address of the instance. Platform Indicates the platform of the instance (eg: Windows) Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Shows the overall availability status of the instance for the day. You can also Today''s Availability view 7/30 reports and the current availability status of the instance. CPU Utilization * The CPU utilization of the instance Network Traffic Network IN * Incoming traffic in bytes per minute Network Out * Outgoing traffic in bytes per minute Disk I/O Disk Read Ops * The average number of disk read operations per second. Disk Write Ops * The average number of disk write operations per second. OS-level Metrics To collect operating system-level metrics like Memory and Disk, you must deploy the Cloud-Watch Agent inside EC2 instance. The agent will send your data to Cloud-Watch from where Applications Manager fetches and displays it in the console. Click here to know more about how you can collect metrics from Amazon ec2 instances and on-premises servers with the Cloud-Watch Agent. Note: Fetching OS-level metrics via the Cloudwatch agent is supported from build 13740 of Applications Manager. Linux Parameter Description MEMORY STATISTICS Available Memory The memory available for use of the EC2 instance (in GB). Used Memory The memory currently in use (in GB). MEMORY UTILIZATION Memory Utilization The memory used on an instance in percentage. Swap Utilization The disk swap utilization in percentages DISK UTILIZATION Disk Utilization The disk space used on an instance. DISK SPACE DETAILS DiskName Name of the disk. Total Disk Space The total amount of disk space available on an instance. Total Size (GB) Total size of the disk (in GB). Disk Utilization (%) The percentage of disk space used on an instance. Disk Available (GB) The total amount of disk space available on an instance (in GB). Disk Used (GB) The total amount of disk space used by an instance (in GB).Windows Parameter Description AVAILABLE MEMORY Available Memory The memory available for use of the EC2 instance (in GB). The percentage of memory in use for which space has been reserved in the % Committed Bytes In Use paging file, should it need to be written to disk. DISK UTILIZATION DiskName Name of the disk. Total Size (GB) Total size of the disk (in GB). Disk Utilization (%) The percentage of disk space used on an instance. Disk Available (GB) The total amount of disk space available on an instance in GB. Disk Used (GB) The total amount of disk space used by an instance in GB Attached Volumes This tab provides metrics about the EBS volumes attached to the EC2 instance. Parameter Description Configuration The ID of the Amazon EBS volume. The volume and instance must be within the Volume ID same Availability Zone and the instance must be running. Size The size of the volume in Giga Bytes. Snapshot ID Snapshot from which the volume was created. Created Time Time stamp when volume creation was initiated. Attached Time Time stamp when the attachment was initiated. Delete on Termination Specifies whether the Amazon EBS volume is deleted on instance termination. Health Denotes the health of the volume (clear, warning, critical) Latency The time period when no read or write operations were waiting to be Idle Time * completed in percentage(%) The average of the total number of seconds spent by all Write operations that Write Latency * completed in the period The average of the total number of seconds spent by all Read operations that Read Latency * completed in the period Volume Traffic Read Bandwidth * The sum of total number of Read operations in the period in bytes per second Write Bandwidth * The sum of total number of write operations in the period in bytes per second Volume IO Read Throughput * The sum of read operations in the period in seconds Write Throughput * The sum of write operations in the period in seconds The average number of read and write operation requests waiting to be Queue Length * completed over the period. Configuration This tab provides the configuration details of the EC2 instance. Parameter Description Instance ID The unique key that identifies the EC2 instance. Instance Type Indicates the type of the instance. Instance Launch Time The time at which the instance was launched The current state of the instance. The values include running, stopped, State shutdown and terminatedParameter Description Image ID Image ID of the AMI used to launch the instance. The AMI launch index, which can be used to find this instance within the AMILaunch Index launch group. The public DNS name assigned to the instance. This DNS name is contactable Public DNS Name from outside the Amazon EC2 network. The private DNS name assigned to the instance. This DNS name can only be Private DNS Name used inside the Amazon EC2 network. Public IP Address The IP address of the instance. Private IP Address The private IP address assigned to the instance. The name of the key pair, if this instance was launched with an associated key KeyPair Name pair. Platform Indicates the platform of the instance (eg: Windows) Availability Zone The instance''s availability zone. Architecture The architecture of the image. RamDisk Id RAM disk associated with this instance. Kernel Id Kernel associated with this instance. The root device type used by the AMI. The AMI can use an Amazon EBS or RootDevice Type instance store root device. RootDevice Name The name of the root device used by the AMI. Monitoring Indicates whether monitoring is enabled for the instance. Indicates whether the instance can be terminated through the Amazon EC2 Termination Protection console, CLI, or API. If enabled, the instance cannot be terminated. Configuring Cloud-Watch Agent in an EC2 instance To collect operating system-level metrics like Memory and Disk, you must deploy the Cloud-Watch Agent inside EC2 instance. The agent will send your data to Cloud-Watch from where Applications Manager fetches and displays it in the console. Click here to know more about how you can collect metrics from amazon ec2 instances and on-premises servers with the Cloud-Watch Agent. Prerequisites to configuring the Cloud-Watch Agent in an EC2 instance: Supported Operating Systems: The Cloud-Watch agent is supported on the following operating systems: Amazon Linux version 2014.03.02 or later Ubuntu Server version 16.04 and 14.04 CentOS version 7.0 and 6.5 Red Hat Enterprise Linux (RHEL) version 7.4, 7.0, and 6.5 Debian 8.0 64-bit versions of Windows Server 2016, Windows Server 2012, and Windows Server 2008.  Steps to configure the Cloud-Watch agent: Create the IAM role that you need to attach to each Amazon EC2 instance that runs the CloudWatch agent. This role provides permissions for reading information from the instance and writing it to CloudWatch. Click here to know how you can create IAM roles to use with the CloudWatch Agent on Amazon EC2 Instances. Attach the created IAM role to an EC2 instance. Click here to know how. Install the Cloud-Watch Agent. There are two ways to install the Cloud-Watch Agent: Using SYSTEMS MANAGER in ec2 console (You do not need to log in to the EC2 instance) or Via direct download link. (You must log in to the EC2 instance)Note: The metrics_collection_interval parameter indicates how often all metrics specified in this configuration file are to be collected. Make sure the value of this metric should be less than the EC2 instance polling interval. A good practice would be to set it to 5 minutes (300 seconds). Create a Cloud-Watch agent configuration file (click here to know how) using Parameter Store feature in EC2 console. (More help here) Start the Cloud-Watch Agent using the Run Command feature available in EC2 console. Refer here. Creating a Cloud-Watch agent configuration file in the EC2 console. Open the AWS EC2 console - https://console.aws.amazon.com/ec2 In the navigation pane, choose Parameter Store under SYSTEMS MANAGER SHARED RESOURCES Click Create Parameter Enter a name (Enter a name based on the OS type - ex: CwAgent Windows Config file Or CwAgent Linux Config file) and description for your parameter and choose ''Type'' as ''String'' Copy the following configuration file content for Cloud-Watch Agent to fetch OS level metrics from EC2 instances. Note : To modify/include/exclude the disk partitions to be monitored, see the "resources": tag in below configuration files content. Change the "resources" tag if you want to monitor different partitions other than the mentioned ones below ("resources": [ "*" ]  - means it will fetch all partitions available). Refer here for further info. Make sure the dimensions in ''append_dimensions'' tag has only ''InstanceId'' as mentioned below in the sample agent configuration file. Windows OS: { "metrics": { "append_dimensions": { "InstanceId": "${aws:InstanceId}" }, "metrics_collected": { "LogicalDisk": { "measurement": [ "% Free Space", "Free Megabytes" ], "metrics_collection_interval": 300, "resources": [ "*" ] }, "Memory": { "measurement": [ "% Committed Bytes In Use", "Available MBytes", "Committed Bytes" ], "metrics_collection_interval": 300 } } } } Linux OS: { "metrics": { "append_dimensions": { "InstanceId": "${aws:InstanceId}" }, "metrics_collected": { "mem": { "measurement": [ "mem_total", "mem_used" ], "metrics_collection_interval": 300 }, "disk": { "resources": [ "/", "/run" ], "measurement": [ "disk_total", "disk_used" ], "metrics_collection_interval": 300 }, "swap": { "measurement": [ "swap_used_percent" ], "metrics_collection_interval": 300 } } } } Paste it in the Value* text box in the Create Parameter page and Click ''Create Parameter'' to create one. Note : Create two different configuration files. One for windows instances and another for Linux instances. Amazon RDS Monitoring Amazon RDS - An Overview Creating a new Amazon Aurora DB monitor Monitored Parameters Amazon RDS - An Overview Amazon Relational Database Service (or Amazon RDS) is a distributed relational database service by Amazon Web Services (AWS). It is a web service running "in the cloud" designed to simplify the setup, operation, and scaling of a relational database for use in applications. Amazon RDS supports an array of database engines to store and organize data and helps with database management tasks, such as migration, backup, recovery and patching. Amazon RDS is available on several database instance types - optimized for memory, performance or I/O - and provides you with six familiar database engines to choose from, including Amazon Aurora, PostgreSQL, MySQL, MariaDB, Oracle Database, and SQL Server.In this help document, you will learn how to get started with Amazon RDS Monitoring, along with the list of parameters that are monitored using Applications Manager. Creating a new Amazon RDS monitor Prerequisites for setting up Amazon monitoring: Click here Using the REST API to add a new Amazon RDS monitor: Click here To create a new Amazon RDS monitor, follow the steps given below: Click on New Monitor link. Select Amazon under Cloud Apps category. Specify the Display Name of the Amazon server Select RDS from the Amazon Services drop-down menu. Enter the Access Key Id of the AWS for accessing the AWS through the API. The access key has 20 alpha- numeric characters. Enter the Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. Choose the Account Type. The default Account Type when adding a new Amazon monitor is AWS Global. Choose AWS China as the Account Type to monitor services in the AWS China regions. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Amazon monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Amazon server from the network and starts monitoring it. Applications Manager automatically discovers all the EC2 and RDS instances, and S3 buckets under your Amazon account. You can then enable monitoring for those instances and buckets as per your requirement. Monitored Parameters Amazon RDS Instances are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the RDS instance. You can also configure thresholds to the numerical attributes based on these details and get notified when the thresholds are violated. Go to the Monitors Category View by clicking the Monitors tab. Click on the RDS Instance of Amazon monitors under the Cloud Apps table. Displayed is the Amazon RDS bulk configuration view distributed into three tabs: Availability tab displays the Availability history of the RDS instances for the past 24 hours or 30 days. Performance tab displays the Health Status and key performance indicators of an RDS instance such as CPU Utilization, Free Storage Space, Database Connections and Write Throughput along with the heat charts for these attributes for the past 24 hours or 30 days. List view displays all the RDS instances present in the Amazon account along with an overall idea of their availability and health status. The list view also enables you to perform bulk admin configurations. The metrics monitored are categorized into 2 tabs for easy understanding. Below is an explanation of the metrics displayed in the differnet tabs: Monitor Information Overview Disk I/O Network Aurora DB DB Operations Replication Configuration Note: The metrics marked with an * are collected using Amazon''s Cloudwatch Monitor Information Parameter Description Monitor Information Name The name of the RDS instance.Parameter Description Region The ID of AWS region where the current RDS instance is running. Region Name The name of the region where the RDS instance is running. Instance Type Indicates the type of instance Created Time The time when the instance was created. The current state of the instance. The values include: running State stopped shutdown terminated DB Engine Name The name of the database engine associated with this instance Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Associated Groups The groups to which the monitor is associated. Overview This tab provides a high-level overview of the RDS Instance as well as its resource utilization. Metric Description Supported Engines Aurora PgSQL Aurora Other engine MySQL types CPU Utilization(%) The percentage of CPU utilization. * Database The number of database connections in Connections * use. Free Memory(GB)   Free Storage The amount of available storage space. Space(%) * Free Local The amount of local storage that is free Storage(GB) on an Aurora instance. The amount of swap space used on the Swap Usage(MB) DB Instance. Disk I/O Metric Description Supported Engines Aurora Aurora Other PgSQL MySQL engine types The average amount of time taken Read Latency(Seconds) * per disk read I/O operation in seconds. The average number of disk read Read Ops(Ops/Sec) * I/O operations per second. Read Throughput(Bytes/Sec) The average number of bytes read * from disk per second. The average amount of time taken Write Latency(Seconds) * per disk write I/O operation. The average number of disk write Write Ops(Ops/Sec) * I/O operations per second. Write Throughput(Bytes/Sec) The average number of bytes * written to disk per second. The amount of storage in bytes Used Volume(GB) used by the Aurora database.Metric Description Supported Engines Aurora Aurora Other PgSQL MySQL engine types The number of billed read I/O Volume Read IOPs(Ops/Sec) operations from a cluster volume, reported at 5-minute intervals. The average number of write disk I/O operations to the cluster Volume Write IOPs(Ops/Sec) volume reported at 5-minute intervals. Network Metric Description Supported Engines Aurora PgSQL Aurora Other engine MySQL types The incoming (Receive) network Incoming traffic(kB/s) traffic on the DB instance. The outgoing (Transmit) network Outgoing traffic(kB/s) traffic on the DB instance. Aurora DB Amazon Aurora is a relational database engine from Amazon Web Services, available as part of the Amazon Relational Database Service (RDS). Being MySQL and PostgreSQL - compatible and built for the cloud, Amazon Aurora provides security, availability, and reliability with the simplicity of open source databases. Metric Description Supported Engines Aurora Aurora Other engine PgSQL MySQL types The average rate of current transactions Active Transactions executing on a DB instance. The average rate of transactions in the Blocked Transactions database that are blocked. Bin Logs Disk The amount of disk space occupied by Usage(MB) binary logs on the master. Transaction Logs Disk The amount of disk space occupied by Usage(MB) transaction logs. Buffer Cache Hit The percentage of requests that are Ratio(%) served by the Buffer cache. ResultSet Cache Hit The percentage of requests that are Ratio(%) served by the Resultset cache. The average number of deadlocks in the Deadlocks database per second. The average lag when replicating updates from the primary instance. This metric will be populated only for Aurora Aurora ReplicaLag(ms) cluster ''Reader'' and similarly ''ReplicaLag Minimum and Maximum'' will be populated only for Aurora Cluster ''Writer'' role instances. The maximum amount of lag between ReplicaLag the primary instance and each Aurora Maximum(ms) instance in the DB cluster. The minimum amount of lag between ReplicaLag the primary instance and each Aurora Minimum(ms) instance in the DB cluster. Note: The Aurora Replica Lag metric will be populated only for Aurora cluster ''Reader''. The ReplicaLag Minimum/Maximum will be populated only for Aurora Cluster ''Writer'' role instances.DB Operations Metric Description Supported Engines Aurora Aurora Other PgSQL MySQL engine types The amount of latency for committed Commit Latency(ms) transactions. Commit The average rate of committed Throughput(Ops/Sec) transactions. The amount of latency for DDL DDL Latency(ms) requests (create/alter/drop). The average rate of DDL requests per DDL Throughput(Ops/Sec) second. The average latency for delete Delete Latency(ms) queries. Delete The average rate of delete queries. Throughput(Ops/Sec) The amount of latency for insert Insert Latency(ms) queries. Insert The average rate of insert queries. Throughput(Ops/Sec) Number of The average rate of queries executed Queries(Queries/sec) per second. Select Latency(ms) The average latency for select queries. Select The average rate of select queries. Throughput(Ops/Sec) The average latency for update Update Latency(ms) queries. Update The average rate of update queries. Throughput(Ops/Sec) Replication This tab will be shown only if a RDS Instance has a source DB Instance identifier in the configuration details. Metric Description Supported Engines Aurora PgSQL Aurora Other engine MySQL types The amount of time a Read Replica DB instance lags behind the source Replication lag DB instance. Applies to MySQL, MariaDB, and PostgreSQL Read Replicas. Replication Source The source DB instance. The AWS Region that the encrypted Source Region Read Replica is created in. The Amazon Resource Name of the Source ARN source. Replication Status Type   Replication Status   Configuration This tab provides the configuration details of the RDS instance. Metric Description Supported EnginesMetric Description AuSrourpapoArtuerdo rEangiOnethser PgSQL MySQL engine types Aurora Aurora Other PgSQL MySQL engine types CONFIGURATION DETAILS Instance ID The unique key that identifies the instance. DBInstance ARN The Amazon Resource Name for the source DB instance. DB Engine Name The name of the database engine used for this instance. Engine Version The database engine version. Created Time The time when the instance was created. The name of the initial database created when the instance DB Name was created. Master User Name The master username for the instance. License Model The license model information for the DB instance. INSTANCE DETAILS Instance Type The type of instance. Storage Type The storage type to be associated with the DB instance. Allocated Storage The storage space initially allocated to this instance in GB. (GB) Storage Encrypted Specifies the encryption status of the DB instance. The current status of the instance. Valid values include State available, backing-up, creating, deleted, deleting, failed, modifying, rebooting and resetting-master-credentials. Multi(A-Z) Indicates if this is a Multi-AZ DB Instance. Deployment The name of AWS region where the current DynamoDB table Region Name resides. SECURITY AND NETWORK Availability Zone The instance''s availability zone. Publicly Accessible Specifies if the DB instance is marked as publicly accessible. Endpoint Address The DNS Address of the DB instance. Endpoint Port The port used to connect to the DB instance. MAINTENANCE DETAILS Preferred The period during which patching and instance modifications Maintenance will be performed. Window Latest Restorable The latest time to which a database can be restored using Time point-in-time restore. Backup Retention The number of days that automated backups are retained Period before deletion. Preferred Backup The daily period during which automated backups are Window created. CLUSTER CONFIGURATION The name of the Aurora cluster to which the RDS instance Aurora Cluster Name belongs to. Cluster ARN The Amazon Resource Name (ARN) for the DB cluster. The endpoint for an Aurora DB cluster that connects to the Cluster Endpoint current primary DB instance for that DB cluster. Cluster Reader The endpoint for an Aurora DB cluster that connects to one of Endpoint the available Aurora Replicas for that DB cluster. Cluster Created The time when the DB cluster was created TimeMetric Description Supported Engines Aurora Aurora Other PgSQL MySQL engine types Cluster Instance The role that is associated with the DB instance. [Reader/ Role Writer] Cluster Group status The current state of this DB cluster group. Amazon Aurora DB Monitoring Amazon Aurora DB - An Overview Adding a new Amazon Aurora DB monitor Monitored Parameters Amazon Aurora DB - An Overview Amazon Aurora is a relational database engine from Amazon Web Services, available as part of the Amazon Relational Database Service (RDS). Being MySQL and PostgreSQL - compatible and built for the cloud, Amazon Aurora provides security, availability, and reliability with the simplicity of open source databases. Adding a new Amazon Aurora DB monitor Mode of Monitoring: CloudWatch & Amazon API using SDK. Using the REST API to add a new Amazon monitor: Click here To create a new Amazon Aurora DB monitor, follow the steps given below: Click on New Monitor link. Select Amazon under Cloud Apps category. Specify the Display Name of the Amazon server. Select RDS from the Amazon Services drop-down menu. Enter the Amazon Access Key Id of the AWS for accessing the AWS through the API. The access key has 20 alpha-numeric characters. Enter the Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. Choose the Account Type. The default Account Type when adding a new Amazon monitor is AWS Global. Choose AWS China as the Account Type to monitor services in the AWS China regions. Specify the Polling Interval in minutes. (Default polling interval is set to 60 minutes.) If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Amazon monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Amazon server from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on RDS in the Amazon Instances under the Cloud Apps Table. Displayed is the bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the Amazon Aurora Database metrics listed under the following tabs: Overview Disk I/O Network Aurora DB DB Operations ConfigurationOverview Supported Engines Metric Description Aurora PgSQL Aurora Other engine MySQL types CPU Utilization(%) The percentage of CPU utilization. Database The number of database connections in Connections use. Free Memory(GB)   Free Storage The amount of available storage space. Space(%) Free Local The amount of local storage that is free Storage(GB) on an Aurora instance. The amount of swap space used on the Swap Usage(MB) DB Instance. Disk I/O Supported Engines Metric Description Aurora Aurora Other PgSQL MySQL engine types The average amount of time taken Read Latency(Seconds) per disk read I/O operation in seconds. The average number of disk read Read Ops(Ops/Sec) I/O operations per second. The average number of bytes read Read Throughput(Bytes/Sec) from disk per second. The average amount of time taken Write Latency(Seconds) per disk write I/O operation. The average number of disk write Write Ops(Ops/Sec) I/O operations per second. The average number of bytes Write Throughput(Bytes/Sec) written to disk per second. The amount of storage in bytes Used Volume(GB) used by the Aurora database. The number of billed read I/O Volume Read IOPs(Ops/Sec) operations from a cluster volume, reported at 5-minute intervals. The average number of write disk I/O operations to the cluster Volume Write IOPs(Ops/Sec) volume reported at 5-minute intervals. Network Supported Engines Metric Description Aurora PgSQL Aurora Other engine MySQL types The incoming (Receive) network Incoming traffic(kB/s) traffic on the DB instance. The outgoing (Transmit) network Outgoing traffic(kB/s) traffic on the DB instance. Aurora DB Supported Engines Metric DescriptionAurora SuppAourtreodra EngineOsther engine Metric Description PgSQL MySQL types Aurora Aurora Other engine PgSQL MySQL types The average rate of current transactions Active Transactions executing on a DB instance. The average rate of transactions in the Blocked Transactions database that are blocked. Bin Logs Disk The amount of disk space occupied by Usage(MB) binary logs on the master. Transaction Logs Disk The amount of disk space occupied by Usage(MB) transaction logs. Buffer Cache Hit The percentage of requests that are Ratio(%) served by the Buffer cache. ResultSet Cache Hit The percentage of requests that are Ratio(%) served by the Resultset cache. The average number of deadlocks in the Deadlocks database per second. The average lag when replicating updates from the primary instance. This metric will be populated only for Aurora Aurora ReplicaLag(ms) cluster ''Reader'' and similarly ''ReplicaLag Minimum and Maximum'' will be populated only for Aurora Cluster '' Writer'' role instances. The maximum amount of lag between ReplicaLag the primary instance and each Aurora Maximum(ms) instance in the DB cluster. The minimum amount of lag between ReplicaLag the primary instance and each Aurora Minimum(ms) instance in the DB cluster. Note: The Aurora Replica Lag metric will be populated only for Aurora cluster ''Reader''. The ReplicaLag Minimum/Maximum will be populated only for Aurora Cluster ''Writer'' role instances. DB Operations Supported Engines Metric Description Aurora Aurora Other PgSQL MySQL engine types The amount of latency for committed Commit Latency(ms) transactions. Commit The average rate of committed Throughput(Ops/Sec) transactions. The amount of latency for DDL DDL Latency(ms) requests (create/alter/drop). The average rate of DDL requests per DDL Throughput(Ops/Sec) second. The average latency for delete Delete Latency(ms) queries. Delete The average rate of delete queries. Throughput(Ops/Sec) The amount of latency for insert Insert Latency(ms) queries. Insert The average rate of insert queries. Throughput(Ops/Sec) Number of The average rate of queries executed Queries(Queries/sec) per second.Supported Engines Metric Description Aurora Aurora Other PgSQL MySQL engine types Select Latency(ms) The average latency for select queries. Select The average rate of select queries. Throughput(Ops/Sec) The average latency for update Update Latency(ms) queries. Update The average rate of update queries. Throughput(Ops/Sec) Configuration Metric Description CONFIGURATION DETAILS Instance ID The unique key that identifies the instance. DBInstance ARN The Amazon Resource Name for the source DB instance. DB Engine Name The name of the database engine used for this instance. Engine Version The database engine version. Created Time The time when the instance was created. DB Name The name of the initial database created when the instance was created. Master User Name The master username for the instance. License Model The license model information for the DB instance. INSTANCE DETAILS Instance Type The type of instance. Storage Type The storage type to be associated with the DB instance. Allocated Storage (GB) The storage space initially allocated to this instance in GB. Storage Encrypted Specifies the encryption status of the DB instance. The current status of the instance. Valid values include available, backing-up, State creating, deleted, deleting, failed, modifying, rebooting and resetting-master- credentials. Multi(A-Z) Deployment Indicates if this is a Multi-AZ DB Instance. Region Name The name of AWS region where the current DynamoDB table resides. SECURITY AND NETWORK Availability Zone The instance''s availability zone. Publicly Accessible Specifies if the DB instance is marked as publicly accessible. Endpoint Address The DNS Address of the DB instance. Endpoint Port The port used to connect to the DB instance. MAINTENANCE DETAILS Preferred Maintenance The period during which patching and instance modifications will be performed. Window Latest Restorable Time The latest time to which a database can be restored using point-in-time restore. Backup Retention Period The number of days that automated backups are retained before deletion. Preferred Backup The daily period during which automated backups are created. Window CLUSTER CONFIGURATION Aurora Cluster Name The name of the Aurora cluster to which the RDS instance belongs to. Cluster ARN The Amazon Resource Name (ARN) for the DB cluster. The endpoint for an Aurora DB cluster that connects to the current primary DB Cluster Endpoint instance for that DB cluster.Metric Description The endpoint for an Aurora DB cluster that connects to one of the available Aurora Cluster Reader Endpoint Replicas for that DB cluster. Cluster Created Time The time when the DB cluster was created Cluster Instance Role The role that is associated with the DB instance. [Reader/ Writer] Cluster Group status The current state of this DB cluster group. Amazon Simple Notification Service Monitoring (Amazon SNS) Amazon Simple Notification Service (SNS) - An Overview Monitoring Amazon Simple Notification Service (SNS) - What we do Adding a new Amazon SNS monitor / Using AddMonitor API Monitored Parameters Amazon Simple Notification Service (SNS) - An Overview Simple Notification Service (SNS) is a cloud messaging service from the host of Amazon web services. SNS is a flexible, fully managed pub/sub messaging and mobile notifications service for coordinating the delivery of messages to subscribing endpoints and clients. With SNS you can fan-out messages to a large number of subscribers, including distributed systems and services, and mobile devices. Monitoring Amazon SNS - What we do Applications Manager provides you with insight into the performance of your Amazon SNS service. Monitor region and topic-wise metrics like notification status (delivery and failure),SMS deliveries, messages throughput - sent and failed counts, subscription count and more. Create a new Amazon monitor Mode of Monitoring: CloudWatch & Amazon API using SDK. Prerequisites for setting up Amazon SNS monitoring: To create a new Amazon monitor, follow the steps given below: Click on New Monitor link. Select Amazon under Cloud Apps category. Specify the Display Name of the Amazon server Enter the Amazon Access Key Id of the AWS for accessing the AWS through the API. The access key has 20 alpha-numeric characters. Enter the Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. Choose the Account Type. The default Account Type when adding a new Amazon monitor is AWS Global. Choose AWS China as the Account Type to monitor services in the AWS China regions. Specify the Polling Interval in minutes. (Default polling interval is set to 60 minutes.) If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Amazon monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Amazon server from the network and starts monitoring it. Changing the Polling Interval for SNS Monitor: The polling interval for the SNS monitor is set to 60 minutes by default. To change it: Go to the Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select Amazon from the Monitor Type drop-down menu.Select SNS Service from the Metric Name drop-down menu. Select how you wish to configure the mertics: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. You can use the options Collect data in every polling or Collect data at customized time interval to change the polling interval. By Monitors - Use this option to change the polling status of any particular monitor(s). Click Save. How to add Amazon Web Services (AWS) Monitor? Note 1. Before creating a new Amazon monitor, you have to configure proxy settings under ''Admin'' tab. 2. Click here to know more about AWS credentials. 3. It is not advisable to change the polling interval to less than 60 minutes as it may increase the number of request to amazon services.   Use the AddMonitor API to add an Amazon SNS Monitor Syntax of Rest API for adding the monitor: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&accessKey=[ACCESSKEY]&SecretAccessKey= [SECRETACCESSKEY]&displayname=[DISPLAYNAME]&AccountType=[account type] Request Parameters: The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the monitor you want to add. Value should be Amazon. accesskey The Amazon Access Key Id of the AWS for accessing the AWS. secretaccesskey The Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. displayname The display name of the Amazon server monitor. The account type. Possible Values are: AccountType AwsGlobal AwsChina Monitored Parameters SNS Usage Message Throughput Notification Delivery Rate Notification Failure RateRegion-Wise Metrics Topic-Wise Metrics SNS USAGE Metric Description Total Messages The total number of messages published throughout all the AWS supported regions. Published Total Notifications The total number of messages delivered throughout all the AWS supported regions. Delivered Total Notifications Failed The total number of messages failed throughout all the AWS supported regions. Total Published Size (KB) The total size of messages published throughout all the AWS supported regions. Notifications Delivered The percentage of total delivered notifications. (%) Notifications Failed (%) The percentage of total failed notifications. SMS Month-To-Date The total charges accrued since the start of the current calendar month for sending charges SMS messages in AWS supported regions. Unit - USD MESSAGE THROUGHPUT Metric Description Publish Size / Hour The published message size per hour in KB NOTIFICATION DELIVERY RATE Metric Description Notifications Delivered / The number of notifications delivered per hour. Hour NOTIFICATION FAILURE RATE Metric Description Notifications Failed / The number of notifications failed per hour. Hour REGION-WISE METRICS Metric Description Region The name of the AWS SNS supported region. Topic Count The number of topics available in a region. Message Published The number of message published in a region. Notifications Delivered The number of notifications delivered in a region. Notifications Failed The number of notifications failed in a region. Published Size (KB) The total Published size in a region. (KB) SMS Month-To-Date The total SMS spent charges in a region. charge (USD) TOPIC-WISE METRICS Metric Description Topic Name The user-specified name of a SNS topic. Region The name of the AWS SNS supported region. Messages Published The number of message published in a topic. Notifications Delivered The number of notifications delivered in a topic. Notifications Failed The number of notifications failed in a topic. Published Size (KB) The total published size in a topic. (KB) Subscription Count The total number of subscriptions in a topic. ⓘ We have restricted topic count to 200 per regionAmazon DynamoDB Monitoring Amazon DynamoDB - An Overview Monitoring Amazon DynamoDB - What we do Creating a new Amazon DynamoDB monitor Monitored Parameters Amazon DynamoDB - An Overview Amazon DynamoDB, a part of the Amazon Web Services portfolio, is a non-relational database that delivers reliable performance at any scale. It is a fully managed, proprietary NoSQL database service that supports key- value and document data structures, offers built-in security, backup and restore, and in-memory caching. Monitoring Amazon DynamoDB - What We do With Applications Manager, you can auto-discover your DynamoDB tables, gather data for performance metrics like latency, request throughput and throttling errors. Optimize resource usage and improve application performance of your Amazon Dynamodb database. Analyze database performance - Track Request Latency, get Successful request latency reports for various read/write operations like GET, PUT, Scan, etc. Gather key usage stats like the count of returned records and bytes from GetRecords operations (Amazon DynamoDB Streams) during specified periods. Optimize Resource usage - Make informed decisions about setting up DynamoDB Provisioned Throughput capacity. Monitor the consumed read/write capacity units to prevent throttling errors to and be up-to-date on request rates, application throughput pattern and table activity. Troubleshoot request throttling - Monitor Throttled requests and Throttled read/write events. Reserve capacity so the provisioned throughput does not get exhausted and you can handle sudden increases in traffic, without returning throttling errors. Handle DB errors and exceptions - Identify performance anomalies by getting a dashboard view of the break-down of System Errors and User Errors. Gain insight into DB operations performed - Track the number of conditional write attempts to a table that failed. Monitor the number of items returned by database scan and query operations. Get instant notifications of performance issues and bottlenecks. Take quick remedial action before your end- users experience issues. Creating a new Amazon DynamoDB monitor Mode of Monitoring: CloudWatch & Amazon API using SDK. Prerequisites for setting up Amazon DynamoDB monitoring: Click here Using the REST API to add a new Amazon DynamoDB monitor: Click here To create a new Amazon DynamoDB monitor, follow the steps given below: Click on New Monitor link. Select Amazon under Cloud Apps category. Specify the Display Name of the Amazon server Choose DynamoDB as the Amazon Service you wish to monitor. Enter the Amazon Access Key Id of the AWS for accessing the AWS through the API. The access key has 20 alpha-numeric characters. Enter the Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. Choose the Account Type. The default Account Type when adding a new Amazon monitor is AWS GlobaL. Choose AWS China as the Account Type to monitor services in the AWS China regions. Specify the Polling Interval in minutes. (Default polling interval is set to 60 minutes.) If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Amazon monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Amazon server from the network and starts monitoring it. Enabling Data collection for DynamoDB Account metricsData collection for DynamoDB Account metrics is disabled by default. To enable them, follow the below given steps: Go to the Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select DynamoDB from the Monitor Type drop-down menu. Select the required metrics from the Metric Name drop-down menu. Enable data collection at every poll or configure custom time intervals. (24 hours is the preferred time interval for AWS DynamoDB Account metrics as to reduce the API count). Select how you wish to configure the mertics: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. You can use the options Collect data in every polling or Collect data at customized time interval to change the polling interval. By Monitors - Use this option to change the polling status of any particular monitor(s). Click Save. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on DynamoDB from Amazon Instances category under the Cloud Apps section. Displayed is the DynamoDB bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the Amazon DynamoDB database metrics listed under the following tabs: Overview Read Operations Write Operations Table Errors Global Secondary Index Streams Configuration Overview Parameter Description READ CAPACITY UNITS The number of provisioned read capacity units for a table or a global Provisioned Read secondary index between the poll interval time. Provisioned Read - Average The average provisioned read capacity. Provisioned Read - Minimum The lowest setting for provisioned read capacity. Provisioned Read - Maximum The highest setting for provisioned read capacity. The number of read capacity units consumed over the poll interval time. This Consumed Read will help you track how much of your provisioned throughput is used. The maximum number of read capacity units consumed by any individual Consumed Read - Average request to the table or index. The minimum number of read capacity units consumed by any individual Consumed Read - Minimum request to the table or index. Consumed Read - Maximum The average per-request read capacity consumed.Parameter Description WRITE CAPACITY UNITS Provisioned Write The number of provisioned write capacity units for a table. Provisioned Write - Average The average provisioned read capacity. Provisioned Write - Minimum The lowest setting for provisioned read capacity. Provisioned Write - Maximum The highest setting for provisioned read capacity. The number of write capacity units consumed for the global secondary index Consumed Write between the poll interval time. Consumed Write - Average The average per-request write capacity consumed. The minimum number of write capacity units consumed by any individual Consumed Write - Minimum request to the table or index. The maximum number of write capacity units consumed by any individual Consumed Write - Maximum request to the table or index. READ THROTTLED REQUESTS If your read or write requests exceed the throughput settings for a table and tries to consume more than the provisioned capacity units or exceeds for an Throttled Read Requests index, DynamoDB can throttle that request. Based on the type of operation (Get, Scan, Query, BatchGet) performed on the table, throttled request data can be populated. The Get operation returns a set of attributes for the request with the given Get Throttled Requests primary key. The Scan operation returns one or more requests and request attributes by Scan Throttled Requests accessing every request in a table or a secondary index. The Query operation finds requests based on primary key values. You can Query Throttled Requests query any table or secondary index that has a composite primary key (a partition key and a sort key). The BatchGet operation returns the attributes of one or more requests from BatchGet Throttled Requests one or more tables. WRITE THROTTLED REQUESTS The Put operation creates a new request, or replaces an old request with a new Put Throttled Requests one. The Update operation edits an existing request''s attributes, or adds a new Update Throttled Requests request to the table if it does not already exist. You can put, delete, or add attribute values. Delete Throttled Requests The Delete operation deletes a single request in a table by primary key. The BatchWrite operation puts or deletes multiple requests in one or more BatchWrite Throttled Requests tables. READ THROTTLED EVENTS The number of throttled write events during the time period. Throttled events Table Read Throttled Events occurs when any particular event or any single event in any batch operation fails. WRITE THROTTLED EVENTS The number of throttled read events during the time period. Throttled events Table Write Throttled Events occurs when any particular event or any single event in any batch operation fails. Read Operations Parameter Description READ LATENCY Average "Successful request latency" reports for Get operations during the Get Latency - Average specified time period (in ms). Average "Successful request latency" reports for BatchGet operations during BatchGet Latency - Average the specified time period (in ms).Parameter Description Average "Successful request latency" reports for Scan operations during the Scan Latency - Average specified time period (in ms). Average "Successful request latency" reports for Query operations during the Query Latency - Average specified time period (in ms). GET LATENCY Get Latency - (Average/ The elapsed time for successful requests to DynamoDB for Get operations Minimum/ Maximum) during the specified time period (in ms). (Minimum, Maximum or Average). BATCHGET LATENCY The elapsed time for successful requests to DynamoDB for BatchGet BatchGet Latency - (Average/ operations during the specified time period (in ms). (Minimum, Maximum or Minimum/ Maximum) Average). SCAN LATENCY Scan Latency - (Average/ The elapsed time for successful requests to DynamoDB for Scan operations Minimum/ Maximum) during the specified time period (in ms). (Minimum, Maximum or Average). QUERY LATENCY Query Latency - (Average/ The elapsed time for successful requests to DynamoDB for Query operations Minimum/ Maximum) during the specified time period (in ms). (Minimum, Maximum or Average). RETURNED ITEM COUNT The number of items returned by Scan operations during the specified time Scan Returned Item Count period. The number of items returned by Query operations during the specified time Query Returned Item Count period. Write Operations Parameter Description WRITE LATENCY Average "Successful request latency" reports for Put operations during the Put Latency - Average specified time period (in ms). Average "Successful request latency" reports for BatchWrite operations during BatchWrite Latency - Average the specified time period (in ms). Average "Successful request latency" reports for Update operations during the Update Latency - Average specified time period (in ms). Average "Successful request latency" reports for Delete operations during the Delete Latency - Average specified time period (in ms). PUT LATENCY Put Latency - (Average/ The elapsed time for successful requests to DynamoDB for Put operations Minimum/ Maximum) during the specified time period (in ms). (Minimum, Maximum or Average). BATCHWRITE LATENCY The elapsed time for successful requests to DynamoDB for BatchWrite BatchWrite Latency - (Average/ operations during the specified time period (in ms). (Minimum, Maximum or Minimum/ Maximum) Average). UPDATE LATENCY Update Latency - (Average/ The elapsed time for successful requests to DynamoDB for Update operations Minimum/ Maximum) during the specified time period (in ms). (Minimum, Maximum or Average). DETELE LATENCY Delete Latency - (Average/ The elapsed time for successful requests to DynamoDB for Delete operations Minimum/ Maximum) during the specified time period (in ms). (Minimum, Maximum or Average). Table Errors Parameter Description USER ERRORSParameter Description Requests to DynamoDB or Amazon DynamoDB Streams that generate an HTTP User Errors 400 status code during the specified time period. SYSTEM ERRORS Requests to DynamoDB or Amazon DynamoDB Streams that generate an HTTP System Errors 500 status code during the specified time period. CONDITIONAL CHECK FAILED REQUESTS Conditional Check Failed The number of failed attempts to perform conditional writes. Requests TIME TO LIVE DELETED ITEM COUNT The number of items deleted by Time To Live (TTL) during the specified time Time To Live Deleted Item Count period. Global Secondary Index Parameter Description GSI READ CAPACITY UNITS The provisioned read CU for the global secondary index between the poll GSI Provisioned read CU interval time. GSI WRITE CAPACITY UNITS The provisioned write CU for the global secondary index between the poll GSI Provisioned Write CU interval time. GSI CAPACITY UNITS GSI Name   Provisioned Read   Consumed read CU for the global secondary index between the poll interval Consumed Read time. Provisioned Write   The consumed write CU for the global secondary index between the poll Consumed Write interval time. GSI READ THROTTLED EVENTS Read Throttled Events   GSI WRITE THROTTLED EVENTS Write Throttled Events   GSI THROTTLED EVENTS GSI Name   GSI Read Throttled Events The requests to DynamoDB that exceed the provisioned read CU for a GSI. GSI Write Throttled Events The requests to DynamoDB that exceed the provisioned write CU for a GSI. GSI INDEX CREATION GSI Name   Online Index Consumed Write The number of write capacity units consumed when adding a new global Capacity secondary index to a table. Online Index Percentage The percentage of completion when a new global secondary index is being Progress added to a table. The number of write throttle events that occur when adding a new global Online Index Throttle Events secondary index to a table CONFIGURATION Index Name The name of the Global Secondary Index. Status The status of the index. Item Count The total count of items in the index. Size (MB) The Storage Size in MB. Partition key The hash attribute of an index.Parameter Description Sort key The range attribute of an Index. Projection Type The set of attributes that are projected into the index. Streams Parameter Description REQUEST LATENCY Successful request latency for GetRecords operations during the specified GetRecords Request Latency time period. Unit - Milliseconds. RETURNED BYTES The number of bytes returned by GetRecords operations during the specified Average Returned Bytes time period. Unit - Megabytes. Total Returned Bytes The average of bytes returned per minute. Unit - [MB/Min] RETURNED RECORDS COUNT The number of stream records returned by GetRecords operations during the Returned Records Count specified time period. STREAM CONFIGURATION Stream Label A timestamp when the stream is enabled, in ISO 8601 format. Specifies if DynamoDB Streams is enabled (true) or disabled (false) on the Stream Status table. Stream View Type Specifies what information is written to the stream for this table. The Amazon Resource Name (ARN) that uniquely identifies the latest stream Stream ARN for this table. Configuration Parameter Description CONFIGURATION Table Name The DynamoDB Table Name. Region The ID of AWS region where the current DynamoDB table resides. Region Name The name of AWS region where the current DynamoDB table resides. The total provisioned read capacity units (Both table and all GSI''s Total Provisioned Read CU provisioned). The total provisioned write capacity units (Both table and all GSI''s Total Provisioned Write CU provisioned). Storage Size The total size of the specified table, in GB. Item Count The number of items in the specified table. Table Status The current state of the table. Partition key The partition key of an item is also known as its hash attribute. Sort key The sort key of an item is also known as its range attribute. Creation date The date and time when the table was created. Amazon Resource Name (ARN) The Amazon Resource Name (ARN) that uniquely identifies the table. Last Decrease time The date and time of the last provisioned throughput increase for this table. Last Increase time The date and time of the last provisioned throughput decrease for this table. The number of provisioned throughput decreases for this table during this Number Of Decreases Today UTC calendar day. Number of Global Secondary The total number of Global Secondary Indexes Index Stream The Stream status [Enabled/Disabled]. AWS Lambda MonitoringAWS Lambda - Overview AWS Lambda is a server-less compute service that runs your code in response to events and automatically manages the underlying compute resources for you. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Lambda instance available under Amazon in the Cloud Apps section. Displayed is the Amazon Lambda bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the AWS Lambda dashboard. It has 2 tabs: Overview Configuration Overview Parameter Description INVOCATIONS Actual The number of times your function code is executed, including successful executions and Invocations executions that result in a function error. Failed The number of invocations that result in a function error. Function errors include exceptions Invocations thrown by your code and exceptions thrown by the Lambda runtime. (Errors) The number of invocation requests that are throttled. When all function instances are Throttled processing requests and no concurrency is available to scale up, Lambda rejects additional Invocations requests. INVOCATIONS RATE Success Rate Number of successful invocations among the total invocations (in percentage). Error Rate Number of failed invocations among the total invocations (in percentage). Invocations/min Number of actual invocations obtained per minute. CONCURRENT EXECUTIONS Reserved The number of concurrent executions that are reserved for this function. Available only when Concurrent function concurrency execution is configured. Executions The number of function instances that are processing events. If this number reaches your Concurrent concurrent executions limit for the Region, or the reserved concurrency limit that you Executions configured on the function, additional invocation requests are throttled. Provisioned Concurrent The number of function instances that are processing events on provisioned concurrency. Executions PROVISIONED CONCURRENCY Provisioned Concurrency The number of times your function code is executed on provisioned concurrency. Invocations Provisioned Concurrency The number of times your function code is executed on standard concurrency when all Spillover provisioned concurrency is in use. Invocations DURATION The maximum time taken for a function to process an event between the poll interval (in Max. Duration milliseconds). Avg. Duration The average time taken for a function to process all the events between the poll interval (inmilliseconds). The minimum time taken for a function to process an event between the poll interval (in Min. Duration milliseconds). ITERATOR AGE The age of the last record in the event (in seconds). The age is the amount of time between Avg. Iterator Age when the stream receives the record and when the event source mapping sends the event to the function. ASYNC DELIVERY FAILURES For asynchronous invocation, the number of times Lambda attempts to send an event to a Dead Letter dead-letter queue but fails. Dead-letter errors can occur due to permissions errors, Queue Errors misconfigured resources, or size limits. For asynchronous invocation, the number of times Lambda attempts to send an event to a Destination destination but fails. Delivery errors can occur due to permissions errors, misconfigured Delivery Failures resources, or size limits. Configuration Parameter Description CONFIGURATION DETAILS Function ARN Amazon Resource Name (ARN) of the function. Region Name Name of the AWS Region. Description Description of the function. Role Execution role of the function. Concurrent Execution Indicates whether function concurrency execution is configured or not. Settings (Enabled/Disabled) Dead Letter Queue ARN Dead Letter Queue of the function. X-Ray Tracing Mode AWS X-Ray tracing configuration of the function. Code Repository Type The service hosting the file which holds the deployment package of the function. RESOURCE DETAILS Memory Size Amount of memory allocated to the function (in MB). Deployed Code Size Size of deployment package of the function (in MB). The amount of time that Lambda allows a function to run before stopping it (in Timeout seconds). FUNCTION DETAILS Runtime The runtime environment for the Lambda function. Handler The function that Lambda calls to begin executing your function. Version The version of the Lambda function. Last Modified Time The date and time at which the function was last modified. SECURITY AND NETWORK DETAILS VPC ID ID of the VPC configured.. Security Groups List of VPC security groups IDs. Subnets List of VPC subnet IDs. AWS Elastic Beanstalk Monitoring AWS Elastic Beanstalk - Overview AWS Elastic Beanstalk is an orchestration service from Amazon which is used for deploying and scaling applications that orchestrates various AWS services like EC2, S3, Simple Notification Service (SNS), CloudWatch, AutoScaling, and Elastic Load Balancers (ELB). With Elastic Beanstalk, you can deploy and manage applications in the AWS cloud without having to learn about the infrastructure that is needed for those applications. Monitored ParametersGo to the Monitors Category View by clicking the Monitors tab. Click on the Elastic Beanstalk instance available under Amazon in the Cloud Apps section. Displayed is the Amazon Elastic Beanstalk bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you will be taken to the AWS Elastic Beanstalk dashboard. It has 7 tabs: Overview Performance Requests Latency Instances Configuration Events Overview Parameter Description ENVIRONMENT DETAILS Status of the environment. (Aborting, Launching, Updating, LinkingFrom,LinkingTo, Environment Status Ready, Terminating, or Terminated) Environment Health Shows the health status of the environment. (Ok, Info, Unknown, No data, Warning, Status Degraded, Severe, Pending, or Suspended) INSTANCE STATUS Instances OK Number of instances with ''OK'' health status. Instances Degraded Number of instances with ''Degraded'' health status. Instances Severe Number of instances with ''Severe'' health status. Instances Unknown Number of instances with ''Unknown'' health status. Instances Info Number of instances with ''Info'' health status. Instances Pending Number of instances with ''Pending'' health status. Instances Warning Number of instances with ''Warning'' health status. Instances No Data Number of instances with ''No Data'' health status. INVENTORY Number of EC2 Number of EC2 instances present in the environment. Instances Number of Number of AutoScaling Groups present in the environment. AutoScaling Groups Number of SQS Number of SQS Queues present in the environment. Queues Number of Launch Number of Launch Configurations present in the environment. Configurations Number of Templates Number of Templates present in the environment. Number of Load Number of Load Balancers present in the environment. Balancers Performance Parameter Description CPU UTILIZATION CPU Utilization Amount of CPU utilized by the AutoScaling Group (in percentage). DISK I/OParameter Description Disk Read Rate Rate at which data is read from the disk in the environment (in MB/s). Disk Write Rate Rate at which data is written to the disk in the environment (in MB/s). DISK I/O OPERATIONS Disk Read Ops. Number of I/O read operations performed on the disk per second in the environment. Disk Write Ops. Number of I/O written operations performed on the disk per second in the environment. NETWORK TRAFFIC Incoming Traffic Rate at which the network receives data in the environment (in MB/s). Outgoing Traffic Rate at which the network sends data in the environment (in MB/s). NETWORK PACKETS Packets Received Number of packets received by the AutoScaling Group per second. Packets Transmitted Number of packets transmitted from the AutoScaling Group per second. Requests Parameter Description TOTAL REQUESTS Requests per minute Number of requests processed per minute in the environment. Total Requests Total number of requests completed in the environment. RESPONSE SUMMARY 2xx Responses Number of requests completed with a 2xx code in the environment. 3xx Responses Number of requests completed with a 3xx code in the environment. 4xx Responses Number of requests completed with a 4xx code in the environment. 5xx Responses Number of requests completed with a 5xx code in the environment. Top 5 Instances with Max Requests: Provides a graphical representation of the request details of top 5 instances with respect to maximum number of total requests in the environment. Top 5 Instances with Error Requests: Provides a graphical representation of the request details of top 5 instances with respect to number of requests completed for various error response codes in the environment. Instance Request Details Instance ID Instance ID of the AWS Beanstalk instance. Total Requests Total number of requests completed by the instance or environment. 2xx Responses Number of requests completed with a 2xx code. 3xx Responses Number of requests completed with a 3xx code. 4xx Responses Number of requests completed with a 4xx code. 5xx Responses Number of requests completed with a 5xx code. Latency Parameter Description APPLICATION LATENCY Application Latency Average time taken by the application to complete 99% of requests in the environment (in P99 milliseconds). Application Latency Average time taken by the application to complete 90% of requests in the environment (in P90 milliseconds). Application Latency Average time taken by the application to complete 75% of requests in the environment (in P75 milliseconds). Application Latency Average time taken by the application to complete 50% of requests in the environment (in P50 milliseconds). Application Latency Average time taken by the application to complete 10% of requests in the environment (in P10 milliseconds).Parameter Description Top 5 Instance Latency: Provides a graphical representation of the latency details of top 5 instances with respect to various latency requests in the environment (in milliseconds). Instance Latency Details Instance ID Instance ID of the AWS Beanstalk instance. Instance Latency Average time taken by the instance to complete 99% of requests (in milliseconds). P99 Instance Latency Average time taken by the instance to complete 90% of requests (in milliseconds). P90 Instance Latency Average time taken by the instance to complete 75% of requests (in milliseconds). P75 Instance Latency Average time taken by the instance to complete 50% of requests (in milliseconds). P50 Instance Latency Average time taken by the instance to complete 10% of requests (in milliseconds). P10 Instances Parameter Description CPU Usage of Instances: Provides a graphical representation of the CPU Usage of Instances with respect to various time details such as User Time and Idle Time in the environment (in percentage). High Disk Usage of Instances: Provides a graphical representation of the Disk Usage of Instances with maximum Used Storage in the environment (in percentage). High Avg. Load of Instances (1 min): Provides a graphical representation of the Avg. Load of Instances with maximum CPU load over the last 1 minute in the environment. High Avg. Load of Instances (5 min): Provides a graphical representation of the Avg. Load of Instances with maximum CPU load over the last 5 minutes in the environment. Linux Instance Performance Details Instance ID Instance ID of the Linux EC2 instance in the environment. Health status of the Linux EC2 instance in the environment. Possible values are: 0 - OK 1 - Info Instance 5 - Unknown Health 10 - No data 15 - Warning 20 - Degraded 25 - Severe Average Load Average CPU load over the last one minute in the instance. (1 min) Average Load Average CPU load over the last five minutes in the instance. (5 min) Disk Usage Amount of disk space utilized by the instance in the instance (in percentage). Amount of time spent by the CPU to execute user level processes in the instance (in User Time percentage). Amount of time spent by the CPU to execute system (Kernel) level processes in the instance (in System Time percentage). Amount of time for which the CPU is waiting for a process to complete in the instance (in I/O Wait Time percentage). Idle Time Amount of time for which the CPU is in idle state in the instance (in percentage). Windows Instance Performance Details Instance ID Instance ID of the Windows EC2 instance in the environment.Parameter Description Health status of the Windows EC2 instance in the environment. Possible values are: 0 - OK 1 - Info Instance 5 - Unknown Health 10 - No data 15 - Warning 20 - Degraded 25 - Severe Amount of time spent by the CPU to execute user level processes in the instance (in User Time percentage). Idle Time Amount of time for which the CPU is in idle state in the instance (in percentage). Amount of time (Privileged Time) for which the CPU has spent in Kernel mode over the last System Time minute in the instance (in percentage). Configuration Parameter Description ENVIRONMENT DETAILS Environment ID of the current environment. ID Region Code The AWS region where the environment is running. Tier Name Name of the tier. Indicates whether it is a WebServer or a Worker environment. LoadBalancer Name of the Load Balancer. Name Abortable Indicates whether there is an in-progress configuration update or application version Option In deployment. Progress Application Name of the application where the environment is deployed. Name Version Name Version of the application that is deployed in the environment. Solution Stack Name of the web server, operating system and architecture. Name Description Description of the environment. Indicates the Endpoint URL of the environment. For load-balanced environment, it is the URL of Endpoint URL the load-balancer. For Single instance environment, it is the IP address of the instance. Environment Amazon Resource Name (ARN) of the environment. ARN Platform ARN Amazon Resource Name (ARN) of the platform. Template Name of the configuration template used to launch the environment, if any. Name Environment Date and Time at which the environment was created. Created Time Environment Date and Time at which the environment was modified. Updated Time AUTOSCALING GROUP DETAILS Autoscaling Name of the AutoScaling Group. Group Name Autoscaling Amazon Resource Name (ARN) of the AutoScaling Group. Group ARN Health Check Service used for the health checks. Possible values are EC2 and ELB. TypeParameter Description Launch Configuration Name of the associated Launch Configuration. Name VPC Zone List of VPC subnet IDs separated by commas. Identifier Service Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call Linked Role other AWS services. ARN Availability List of availability zones for the group. Zones Autoscaling Date and time at which AutoScaling Group was created. Created Time Default Duration of the default cooldown period (in seconds). Cooldown Desired The desired size of the group. Capacity HealthCheck The amount of time (in seconds) that Amazon EC2 Auto Scaling waits before checking the health Grace Period status of an EC2 instance that has come into service. Maximum The maximum number of instances available in the group. Instances Minimum The minimum number of instances available in the group. Instances Events This tab displays the list of the most recent events that have occurred in the environment and its resources. Parameter Description Event Details Generated Time Date and time at which the event was generated. Status Severity status of the event. (TRACE, DEBUG, INFO, WARN, ERROR, or FATAL) Message Indicates the message shown for the event.   Note: Metrics under ''Events'' tab are mapped under Admin → Performance Polling. By default, number of events fetched in the table after every poll interval is 20. However, it can be modified by specifying the value in ''Number of events to fetch'' textbox found under Admin → Performance Polling → Optimize Data Collection. AWS ECS Monitoring AWS ECS - Overview Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features. Creating a new monitor To learn how to create a new ECS monitor, refer here. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the ECS available under Amazon in the Cloud Apps section. Displayed is the Amazon ECS bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days.Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the AWS ECS dashboard. It has 5 tabs: Overview Cluster Performance Tasks Services Container Instances Overview Parameter Description CLUSTER INFORMATION Name Name of the cluster. The status of the cluster. (ACTIVE, PROVISIONING, DEPROVISIONING, FAILED, Status INACTIVE) Cluster ARN The Amazon Resource Name (ARN) that identifies the cluster. Registered Container The number of containers instances registered to the cluster. Instances CLUSTER TASKS Running Tasks The number of tasks that are in RUNNING state. Pending Tasks The number of tasks that are in PENDING state. Running EC2 Tasks The number of EC2 tasks that are in RUNNING state. Pending EC2 Tasks The number of EC2 tasks that are in PENDING state. Running Fargate Tasks The number of Fargate tasks that are in RUNNING state. Pending Fargate Tasks The number of Fargate tasks that are in PENDING state. CLUSTER SERVICES Active Services The number of active services running in the cluster. Active EC2 Services The number of EC2 services that are running on the cluster in an ACTIVE state. Draining EC2 Services The number of EC2 services that are in DRAINING state. Active Fargate Services The number of Fargate services that are running on the cluster in an ACTIVE state. Draining Fargate Services The number of Fargate services that are in DRAINING state. Cluster Performance Parameter Description CPU CPU Amount of CPU units that are reserved by running tasks in the cluster (in percentage). Reservation CPU Amount of CPU units that are used in the cluster (in percentage). Utilization MEMORY Memory Amount of memory that is reserved by running tasks in the cluster (in percentage). Reservation Memory Amount of memory that is used in the cluster (in percentage). Utilization CPU USAGE CPU The CPU units reserved by tasks in the cluster. This metric is collected only for tasks that have a Reserved defined CPU reservation in their task definition. The CPU units used by tasks in the cluster. This metric is collected only for tasks that have a CPU Utilized defined CPU reservation in their container definition.Parameter Description MEMORY USAGE Memory Amount of memory that is reserved by tasks in the cluster (in GB). Reserved Memory Amount of memory being used by tasks in the cluster (in GB). Utilized DISK I/O THROUGHPUT Storage Rate at which data is read from storage in the cluster (in kB/s). Read Rate Storage Rate at which data is written from storage in the cluster (in kB/s). Write Rate CLUSTER NETWORK I/O Data Transmit Rate at which data is transmitted by the cluster (in kB/s). Rate Data Receive Rate at which data is received by the cluster (in kB/s). Rate Tasks Parameter Description Task Details Task ID The unique identifier for the task. The health status for the task, which is determined by the health of the essential containers in the Health Status task. (HEALTHY, UNHEALTHY, UNKNOWN) The last known status of the task. (PROVISIONING, PENDING, ACTIVATING, RUNNING, Last Status DEACTIVATING, DEPROVISIONING, STOPPED) Desired Status Displays the desired status of the task. Launch Type The launch type on which you task is running. (EC2 or Fargate) Connectivity The connectivity status of a task. (CONNECTED or DISCONNECTED) Connectivity Shows the time stamp for when the task went to CONNECTED state. At Configured Shows the number of CPU units used by the task. CPU Units Configured Displays the amount of memory used by the task (in MB). Memory Number of Number of containers in which the task is running. Containers Task Info Task ID The unique identifier for the task. Container The unique identifier for the container instance. Instance ID Task Group The name of the task group associated with your task. Task The full description of the task definition. Definition Created At Shows the time stamp for when the task was created. Started At Shows the time stamp for when the task was started. Started By Shows the tag specified when a task is started. Services Parameter Description Service StatusParameter Description Service The name of the service. Name Status The status of the service. (ACTIVE, DRAINING, INACTIVE) CPU The percentage of CPU units that are used in the service. Utilization Memory The percentage of memory that are used in the service. Utilization Pending The number of tasks in the service that are in the PENDING state. Tasks Running The number of tasks in the service that are in the RUNNING state. Tasks Desired The desired number of instantiations of the task definition to keep running on the service. Tasks Launch Type The launch type on which your service is running. (EC2 or FARGATE) Scheduling The scheduling strategy to use for the service. (REPLICA or DAEMON) Strategy Service Insights Service The name of the service. Name CPU The CPU units reserved by tasks in the service. This metric is collected only for tasks that have a Reserved defined CPU reservation in their task definition. The CPU units used by tasks in the service. This metric is collected only for tasks that have a CPU Utilized defined CPU reservation in their container definition. Memory The memory that is reserved by tasks in the service (in GB). Reserved Memory The memory being used by tasks in the service (in GB). Utilized Storage Rate at which data is read from storage in the service (in kB/s). Read Rate Storage Rate at which data is written from storage in the service (in kB/s). Write Rate Data Transmit Rate at which data is transmitted by the service (in kB/s). Rate Data Receive Rate at which data is received by the service (in kB/s). Rate TaskSet The number of task sets in the service. Count Service Details Service The name of the service. Name Task The task definition to use for tasks in the service. Definition Platform The platform version on which to run your service. Version Created At The timestamp for when the service was created. Created By The principal that created the service. Service Events Event ID Indicates the ID for the event. Service Name of the service. Name Generated Date and time at which the event was generated. Time Message The message shown for the event.Container Instances Parameter Description CPU Instance CPU The percentage of CPU currently being reserved on a single EC2 instance in the cluster. Reserved Capacity Instance CPU The total percentage of CPU units being used on a single EC2 instance in the cluster. Utilization MEMORY Instance Memory The percentage of memory currently being reserved on a single EC2 instance in the cluster. Reserved Capacity Instance Memory The total percentage of memory being used on a single EC2 instance in the cluster. Utilization CPU USAGE Instance CPU Used Amount of CPU units being used on a single EC2 instance in the cluster. Instance CPU Amount of CPU units remaining after use on a single EC2 instance in the cluster. Remaining Instance CPU Limit Maximum amount of CPU units that can be assigned to a single EC2 instance in the cluster. MEMORY Instance Memory Amount of memory being used on a single EC2 instance in the cluster (in GB). Used Instance Memory Amount of memory remaining after use on a single EC2 instance in the cluster (in GB). Remaining Instance Memory Maximum amount of memory that can be assigned to a single EC2 instance in the cluster (in Limit GB). FILESYSTEM UTILIZATION Instance Total amount of file system capacity being used on a single EC2 instance in the cluster (in FileSystem percentage). Utilization NETWORK USAGE Instance Network Rate at which data is sent and received over the network on a single EC2 instance in the Traffic Rate cluster (in kB/s). Container Instances Container Instance The ID of the container instance. ID The status of the container instance. (REGISTERING, REGISTRATION_FAILED, ACTIVE, Status INACTIVE, DEREGISTERING, DRAINING) Running Tasks Number of tasks that are in RUNNING state per container instance. Pending Tasks Number of tasks that are in PENDING state per container instance. The version counter for the container instance. Every time a container instance experiences Version a change that triggers a CloudWatch event, the version counter is incremented. Agent Version The version number of the Amazon ECS container agent. Agent Connected Indicates whether the agent is connected to Amazon ECS. (True or False) Instance ID The EC2 instance ID of the container instance. Registered At The timestamp for when the container instance was registered. Container Instances Insights Container Instance The ID of the container instance. ID Memory Reserved Amount of memory currently being reserved on the instance (in percentage). Capacity Memory Utilization Amount of memory currently being used on the instance (in percentage). CPU Reserved Amount of CPU currently being reserved on the instance (in percentage). CapacityParameter Description CPU Utilization Amount of CPU currently being used on the instance (in percentage). FileSystem Amount of file system capacity being used on the instance (in percentage). Utilization Network Traffic Rate at which data is sent and received over the network on the instance (in kB/s). Rate Instances Resource Details Container Instance The unique identifier for the container instance. ID Available CPU Amount of CPU units available to allocate tasks. Available Memory Amount of memory available to allocate tasks (in MB). Reserved Ports The ports that were reserved by the Amazon ECS container agent. Amazon EKS Monitoring Overview Amazon Elastic Kubernetes Service (EKS) is a managed Kubernetes service that facilitates smooth running of Kubernetes on both AWS and on-premises. EKS is integrated with many AWS services to provide scalability and security and helps guarantee high availability of your clusters and its resources across numerous availability zones. There is no need to install, operate and maintain our own Kubernetes control plane or node. Creating a new monitor Prerequisites for monitoring Amazon EKS metrics: Click here To learn how to create a new EKS monitor, refer here. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the EKS instance available under Amazon in the Cloud Apps section. Displayed is the Amazon EKS bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the Amazon EKS monitor dashboard. It has 6 tabs: Overview Node Pods Services Persistent Volumes Service Map Note: Metrics marked with * are collected from Container Insights. If a node is not in the ''Ready'' state, the availability of the monitor will be automatically affected. Also, the health of the node in the monitor is dependent on the following parameters by default and alerts can be configured for the same under Admin → Performance Polling → Optimize Data Collection → Elastic Kubernetes Service: Memory Pressure Disk Pressure PID pressure Out of Disk Network UnavailableOverview Parameter Description CLUSTER INFORMATION Status Current status of the cluster. (CREATING, ACTIVE, DELETING, FAILED, UPDATING) Cluster ARN The Amazon Resource Name (ARN) of the cluster. Cluster The endpoint for your Kubernetes API server. Endpoint NAMESPACE DETAILS Namespace Name of the namespace Name Running pods in namespace Number of running pods under the namespace. * Resource The version number of the namespace. Version Namespace Availability of the Namespace Availability Namespace Timestamp at which the Namespace was created Created Time PODS Used Pods % Percentage of the number of pods used. Used Pods Number of pods used. Maximum Maximum number of pods available. Pods Top 5 Nodes by Used Pods - Displays a graphical representation of top 5 nodes with respect to the number of pods used. CLUSTER USAGE DETAILS Average Cluster CPU Average amount of CPU used by the cluster (in percentage). Usage Average Cluster Average amount of memory used by the cluster (in percentage). Memory Usage NODE DETAILS Master Nodes Number of master nodes available. Worker Number of worker nodes available. Nodess Failed Nodes Number of nodes that have failed. * CLUSTER DETAILS Git Version Git version of the cluster. Build Date Build date of the cluster. Compiler Name of the compiler used. Platform OS Platform of the cluster. COMPONENT DETAILS Component Name of the component. Name Availability Availability status of the component. NODE GROUP DETAILS Node group The name associated with an Amazon EKS managed node group. NameParameter Description Node group The current status of the managed node group. (CREATING, ACTIVE, UPDATING, DELETING, Status CREATE_FAILED, DELETE_FAILED, DEGRADED) Kubernetes The Kubernetes version of the managed node group. Version Release AMI ID in launch template (OR) EKS version of the optimized AMI. Version Minimum The minimum number of nodes that the managed node group can scale into. Node Size Maximum The maximum number of nodes that the managed node group can scale out to. Node Size Desired Node The desired number of nodes that the managed node group should maintain. Size If the node group wasn''t deployed with a launch template, then this is the instance type that is Instance associated with the node group. If the node group was deployed with a launch template, then Types this is null. Created At The timestamp when the node group was created. FARGATE PROFILE DETAILS Fargate The name of the Fargate profile. Profile Name Fargate The current status of the Fargate profile. (CREATING, ACTIVE, DELETING, CREATE_FAILED, Profile Status DELETE_FAILED) Created At The timestamp when fargate profile was created. Subnets The IDs of subnets to launch pods into. Node Parameter Description Top 5 Nodes by Memory Details - Displays a graphical representation of top 5 nodes with respect to their corresponding memory details (in percentage). Top 5 Nodes by CPU Details - Displays a graphical representation of top 5 nodes with respect to their corresponding CPU details (in percentage). Node Usage Details Node Name Name of the node Allocatable Memory The CPU resources of a node that are available for scheduling (in GiB). Memory Limit The maximum limit of memory resource which can be used (in percentage). Memory Request Number of memory requests (in percentage). Allocatable CPU The number of CPU processes that are available. CPU Limit The maximum limit of CPU resource which can be used (in percentage). CPU Request Number of CPU requests (in percentage). The total number of data transmitted and received over the network per node in a Network Total Usage * cluster (in kB/s). The total amount of file system capacity being used on nodes in the cluster (in File System Usage * percentage). Running containers in The number of running containers per node in a cluster. node * Node Pod Details Node Name Name of the pod Displays a graphical representation of the total number of pods available with used Pod Usage and free pods split-up. Kube-system Pod Count Number of Kube state pods. Non-Kube-system Pod Number of non-Kube state pods. Count Image Number of images present in the node.Parameter Description Used Pods Total num of pods present in Kubernetes. Allocatable Pods Number of pods that are available. NODE DETAILS Node Name Name of the node Instance ID EC2 Instance ID of the node. OS Image OS Image name of the node. OS Name of the OS in which the container is deployed. Architecture Architecture details of the node. Type Type of node used. Kubelet Version The version of Kubelet used. Allocatable Ephemeral Size of temporary memory available (in GiB). Storage Created Time Timestamp at which the node was created. Pods Parameter Description POD DETAILS Pod UUID Universal unique ID of the pod. Pod Name Name of the pod Pod Namespace Namespace in which the pod resides. Pod Node Name Name of the pod-node. Pod Application Name of the pod application. Pod Type Type of pod used. Pod created Medium by which the pod was created. Pod Status Status of the pod. (Pending, Running, Succeeded, Failed, or Unknown) Pod Start Time Timestamp at which the pod was started. Pod Created Time Timestamp at which the pod was created. Top 10 Pods by Memory Details - Displays a graphical representation of top 10 pods with respect to their corresponding memory details (in percentage). Top 10 Pods by CPU Details - Displays a graphical representation of top 10 pods with respect to their corresponding CPU details (in percentage). POD USAGE DETAILS Pod UUID Universal unique ID of the pod. Pod Name Name of the pod. Number of Containers The number of containers run by the pod. Pod CPU Limit The maximum limit of CPU resource which can be used (in percentage). Pod CPU Request The number of CPU requests by pod (in percentage). Pod Memory Limit The maximum limit of memory resource that can be used (in percentage). Pod Memory Request The number of memory requested (in percentage). Pod created Medium by which the pod was created. Network Transmitted Amount of data being transmitted over the network by the pod (in kB/s). Bytes * Network Received Bytes * Amount of data being received over the network by the pod (in kB/s). Pod Persistent Volumes Name of the Claim through which a pod can access the persistent volume. Claim CONTAINER DETAILS Container ID ID of the container. Container Name Name of the container.Parameter Description Container Image Name of the container image. Container Pod Name Name of the container pod. Container Restarts The number of times the container has restarted. Status of the container. Following are the list of possible values that are shown for each status: Status Value Running Running ContainerCreating CrashLoopBackOff ErrImagePull Waiting ImagePullBackOff Container Status CreateContainerConfigError InvalidImageName CreateContainerError OOMKilled Error Terminated Completed ContainerCannotRun DeadlineExceeded Container Start Time Timestamp at which the container was started. Services Parameter Description SERVICE DETAILS Service UUID Universal unique ID of the service. Service Name Name of the service. Service Namespace Name of the Namespace in which the service resides. Application Name of the service application. Service Type Type of the service. Service Protocol Name of the service protocol. Host IP Address IP address of the service host. Service Target Port Name of the port that connects with the service. Running pods in service * The number of pods running the service or services in the cluster. Created Time Timestamp at which the service was created. DEPLOYMENT DETAILS Deployment UUID Universal unique ID of the deployment. Deployment Name Name of the deployment. Deployment Namespace Namespace where the deployment exists. Deployment Replicas The number of replicas in a deployment. Deployment Available Replicas Number of available replicas in a deployment. Deployment Availability Availability of the deployment. Persistent Volumes Parameter Description PERSISTENT VOLUMES (PV) DETAILSParameter Description PV Name Name of the Persistent Volume. PV Status Status of the Persistent Volume. (Available, Bound, Released, Failed, or Pending) PV Claim Name of the Persistent Volume Claim. PV Access Mode The mode through which you can access the Persistent Volume. PV Storage Class Name of the Persistent Volume storage class. PV Capacity The capacity of the Persistent Volume (in GiB). PV Created Time Timestamp at which the Persistent Volume was created. PERSISTENT VOLUMES CLAIM (PVC) DETAILS PVC UUID Universal unique ID of the persistent volume. PVC Name Name of the Persistent Volume Claim. PVC Namespace Name of the Namespace in which the Claim exists. PVC Status Status of the Persistent Volume Claim. (Available, Bound, Released, Failed, or Pending) PV Name Name of the Persistent Volume. PVC Access Mode The mode through which you can access the Persistent Volume Claim. PVC Storage Class Name of the Persistent Volume storage class. PVC Requests Number of Persistent Volume Claim requests (in GiB). PVC Created Time Timestamp at which the Persistent Volume Claim was created. Service Map Displays a graphical map view containing namespace and service details. All the namespace with its status and running pods count will be seen inside cluster circle. Green color indicates that the namespace is UP and red color indicates it is DOWN. Under the cluster services under a namespace can be seen as tree. Each service contains, its host IP, port and number of running pods. Microsoft Azure Monitoring Microsoft Azure - An Overview Monitoring Microsoft Azure - What we do Creating a new Azure Monitor Monitored Parameters FAQs and Troubleshooting Microsoft Azure - An OverviewMicrosoft Azure, formerly known as Windows Azure, is Microsoft''s public cloud computing platform. It provides a range of cloud services, including those for compute, analytics, storage and networking. Users can pick and choose from these services to develop and scale new applications, or run existing applications, in the public cloud.  Monitoring Microsoft Azure - What we do Applications Manager''s Microsoft Azure monitor enables users to discover Virtual machines under an Azure subscription and monitors them. With Azure Storage Monitoring, you can monitor the health and performance of your Storage accounts for better managing and utilizing our Azure hosted storage resources, Azure SQL DB monitoring for keeping track of Azure SQL DB performance metrics and query statistics, Azure Service Bus monitoring to monitor the performance of the service bus, and Azure Kubernetes Service Monitoring for tracking the health and performance of the Kubernetes clusters and their underlying components, thereby ensuring smooth operation of your Microsoft Azure business applications overall. Applications Manager connects with Microsoft Azure through Azure APIs to determine the health status and other performance counters. With Microsoft Azure monitoring, you can: Discover and monitor Azure services such as virtual machines, SQL DBs, Storage Accounts, Service Buses, and Kubernetes services that are associated under an Azure subscription. Find the number of VMs that are provisioned and running. View the status and configuration information of all the discovered resources. Collect and monitor performance metrics (CPU, Memory, Disk, Network, Thread&Process count). Collect and monitor Disk Utilization, Disk IO statistics, Network interface details by enabling Guest OS configuration. In this help document, you will learn how to get started with Azure Monitoring, along with the list of parameters that are monitored using Applications Manager. Creating a new Microsoft Azure Monitor  Prerequisites for monitoring Azure metrics: Click here Using the REST API to add a new Azure monitor: Click here To create a new Microsoft Azure monitor, follow the steps given below: Click on the New Monitor link in the Applications Manager web client. Select ''Microsoft Azure'' under Cloud Apps category Specify the Display Name of Microsoft Azure monitor Enter the Subscription ID for your Microsoft Azure subscription. Select the Azure Services you wish to discover and monitor from the drop-down menu. Choose the Discovery mode. Following are the 3 discovery modes available: Discovery using AD Application & Service Principal: Provide the Client ID, Tenant ID & Application key that were obtained in the above mentioned prerequisite step in the New monitor page. Refer Prerequisites section. Discovery using Azure Organizational Account (Powershell): Provide the User email & Password fields in New monitor page with the Username & Password of the created Organizational account. Refer Prerequisites section. Discovery using OAuth: Use the OAuth Provider that was obtained in the prerequisite step in the New monitor page. Refer Prerequisites section. Specify the polling interval in minutes and timeout in seconds Choose the Monitor Group from the combo box with which you want to associate Microsoft Azure monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Microsoft Azure from the network and starts monitoring them. Note: Azure resources deployed using ''Azure Resource Manager (ARM)'' model will be monitored by Applications Manager. Azure Resources deployed using Classic model are not supported. Make sure you have a working internet connection to add or fetch data from the cloud services. If your environment requires the use of a proxy server to access external Websites, you can configure the proxy settings under the ''Admin'' tab. Monitored ParametersGo to the Monitors Category View by clicking the Monitors tab. Click on Microsoft Azure under the Cloud Apps table. Displayed is the Microsoft Azure bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Microsoft Azure monitor provides a brief detail of the Azure virtual machines under the given subscription. Click on the monitor name to see all the server details listed under the following tabs: Monitor Information Overview Virtual Machines Storage Accounts Azure SQL Databases Azure Service Buses Kubernetes Service Monitor Information Parameter  Description Name Name of the Microsoft Azure monitor Subscription ID Subscription ID of the Azure subscription Azure Services The services that are monitored under this subscription Discovery Mode The discovery mode chosen while creating the monitor User Email The organizational account used to access Azure resources Client ID Client ID of the Active Directory Application Tenant ID Tenant ID of the Active Directory OAuth Provider Name of the OAuth provider. Timeout Timeout Duration (seconds) Associated Groups The monitor groups to which this monitor is associated Last Polled at Specifies the time at which the last poll was performed Next Poll at Specifies the time at which the next poll is schedule Overview Parameter Description Total Azure Virtual Machines Provisioned Total number of virtual machines under this subscription. Total Azure Virtual Machines Running Total number of virtual machines in running state. Azure Standard Storage Accounts Number of standard storage accounts available. Azure Premium Storage Accounts Number of premium storage accounts available. Azure SQL Databases Number of Azure SQL database available. Azure Service Bus Namespace Count Number of Azure Service Bus Namespaces available. Azure Kubernetes Service Cluster count Number of Azure Kubernetes Service clusters available. Virtual Machines Parameter Description Virtual Machine Name Name of the Virtual machine Status Virtual machine''s state Resource group name The Resource Group which has this Virtual Machine OS Type The Operating System of the Virtual MachineParameter Description Location The Location where the Virtual Machine is located Public IP Address IP address of the Virtual Machine You can perform the following admin actions on the Azure virtual machines (VMs): Delete: Deletes the Azure VMs from Applications Manager. Start Virtual Machines: Option to start the Azure VMs from Applications Manager. Stop Virtual Machines: Option to stop Azure VMs from Applications Manager. Restart Virtual Machines: Option to restart Azure VMs from within Applications Manager. By clicking over the Virtual Machine name, you will be redirected to the Azure Virtual Machine monitoring dashboard. Storage Accounts Parameter Description Azure Standard Storage Accounts Storage Account The Azure Storage Account Name. Name Provisioning state of Storage Account. Possible values : Invalid Creating Provisioning State Deleting Succeeded Failed Cancelled Resource Group Resource Group where the Storage Account is allocated in. Location Region where the storage account is provisioned Status of Storage Account. Possible Values: Primary Status Available Unavailable The replication type used by the Storage account. Possible values: Standard_LRS Standard_GRS Replication Type Standard_RAGRS Standard_ZRS Premium_LRS Azure Premium Storage Accounts Premium Storage The Azure Premium Storage Account Name. Account Name Provisioning state of Premium Storage Account. Possible values : Invalid, Creating, Provisioning State Deleting, Succeeded, Failed, Cancelled. Resource Group Resource Group where the Premium Storage Account is allocated in. Location Region where the Premium Storage Account is provisioned. Status Status of Premium Storage Account. Possible Values: Available, Unavailable. By clicking over the Azure Standard Storage Account name, you will be redirected to the Azure Storage monitoring dashboard. Azure SQL Databases Parameter DescriptionParameter Description Azure SQL Databases Database Name Name of the Azure SQL Database. Database Status Status of the Azure SQL database. Database Server Name of the SQL server. Resource Group Name Name of the resource group to which the SQL database is associated. Database Usage Amount of space currently used in the database (in GB). Database Location Location of the SQL database Total Database Size Total amount of space allocated to the SQL database (in GB). By clicking over the database name, you will be redirected to the Azure SQL database monitoring dashboard. Azure Service Buses Parameter Description Azure Service Buses Namespace Name of the Service Bus Namespace. Status Status of the Service Bus Namespace. Tier Indicates the tier used by the Service Bus Namespace. Location Indicates the location/region of the Service Bus Namespace. Resource Group Specifies the Resource Group of the Service Bus Namespace. By clicking over the database name, you will be redirected to the Azure Service Bus monitoring dashboard. Kubernetes Service Parameter Description Kubernetes Clusters Cluster Name Name of the Kubernetes cluster. Cluster Status Status of the Kubernetes cluster. (Running or Stopped) Cluster Location Indicates the location/region of the Kubernetes cluster. Resource Group Name Specifies the Resource Group of the Kubernetes cluster. By clicking over the cluster name, you will be redirected to the Azure Kubernetes Service monitoring dashboard. FAQs and Troubleshooting Error Messages and how to troubleshoot them: 1. Error: "Authentication Failed. Access is denied for the provided Azure Organizational Account Credentials" This error message is displayed upon adding a New Azure monitor using Azure Organizational Account mode. For troubleshooting steps, refer this link. 2. Error: "Azure Services discovery failed for subscription . Invalid Application key" This error message is displayed upon editing a new Azure monitor using Azure Organizational Account/AD Application & Service Principal mode. For troubleshooting steps, refer to the below link for respective modes: Azure Organizational Account mode AD Application & Service Principal mode 3. Error: "Connection to the database failed with error: Cannot open server requested by the login. Client with IP address is not allowed to access the server.  To enable access, use the Windows Azure Management Portal or run sp_set_firewall_rule on the master database to create a firewall rule for this IP address or address range" This error message is displayed in the monitor details page/Edit monitor page of Azure SQL Database monitor. For troubleshooting steps, refer this link.4. Error: "Connection to the database failed with error: The TCP/IP connection to the host , port 1433 has failed. [OR] Error: "Connection timed out: no further information. Verify the connection properties. Make sure that an instance of SQL Server is running on the host and accepting TCP/IP connections at the port. Make sure that TCP connections to the port are not blocked by a firewall." This error message is displayed in the monitor details page/Edit monitor page of Azure SQL Database monitor. For troubleshooting steps, refer this link. For more troubleshooting steps on Microsoft Azure monitoring, refer our FAQs. Azure Virtual Machines Azure virtual machines are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of Azure Virtual machines. You can also configure thresholds to the numerical attributes based on these details and get notified when the thresholds are violated. Monitored Parameters Prerequisites for monitoring Azure VM metrics: Click here Go to the Monitors Category View by clicking the Monitors tab. Click on  Azure Virtual Machines under the Cloud Apps section. Displayed is the  Azure Virtual Machine bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Note: Data collection for the following metrics is done via the following methods: Metrics to be Data collection method Required Privileges monitored Azure monitor Via Azure APIs --- Diagnostic Extension should be enabled Diagnostic Via Storage Table APIs for the virtual machine. (Windows and Extension Linux) Guest OS Via PowerShell scripts PowerShell remoting should be enabled. Guest OS metrics will be available only for Windows installations of Applications Manager for Windows VMs alone. Windows Virtual Machines - Monitored Metrics Monitor Information Overview CPU Memory Disk Network Threads & Processes Services Configuration Linux Virtual Machines - Monitored Metrics Overview CPUMemory Disk Configuration Windows Virtual Machines - Monitored Metrics Monitor Information Parameter Description Name Display name of the Virtual machine Subscription ID Subscription ID of the Azure subscription which contains this VM Virtual Machine name Name of the Virtual machine Virtual Machine Resource ID Resource ID of the Virtual machine Enable Guest OS monitoring Indicates whether Guest OS monitoring is enabled for the monitor. Username VM''s username Timeout Timeout Duration (seconds) Associated groups The monitor groups to which this monitor is associated Last polled at Specifies the time at which the last poll was performed Next poll at Specifies the time at which the next poll is scheduled Overview Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS CPU UTILIZATION Amount of CPU CPU utilized by the     Utilization virtual machine (in %). MEMORY UTILIZATION Amount of memory Memory utilized by the     Utilization virtual machine (in %). CPU CREDITS (Applicable only for B-series virtual machines) Number of CPU credits Credits consumed by     Consumed the virtual machine Remaining number of CPU credits Credits     available for Remaining the virtual machine. CPU Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS PROCESSOR METRICSParameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS Amount of time for which the Privileged processor was running in     Time privileged mode (in %). Amount of time for which the User Time processor was running in user     mode (in %). Processor Number of times the processor     Frequency is in running state. Memory Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS MEMORY (COMMITTED vs AVAILABLE) Committed Amount of commited Virtual     Bytes Memory (in MB). Available Amount of available Physical     Bytes Memory (in MB). Committed Ratio of Committed Bytes to Bytes In the Commit Limit (in     Use percentage). POOL (PAGED vs NONPAGED) Pool Paged Size of the paged pool (in MB).     Bytes Pool Size of physical memory that Nonpaged cannot be written to disk     Bytes though it is not in use (in MB). MEMORY FAULTS Page Number of page faults per     Faults/sec second. Disk Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS READ THROUGHPUT Amount of data read from OS Disk Read OS disk during monitoring     Throughput period (in kB/s). Data Disk Amount of data read from Read data disk during monitoring     Throughput period (in kB/s). WRITE THROUGHPUT Amount of data written to OS Disk Write OS disk during monitoring     Throughput period (in kB/s). Data Disk Amount of data written to Write data disk during monitoring     Throughput period (in kB/s). DISK I/O OPS Disk Read Number of disk read IOPS     Ops (in Ops/sec). Disk Write Number of disk write IOPS     Ops (in Ops/sec).Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS DISK UTILIZATION Disk Disk Partition     Disk Free space & Used Disk Usage     space Total Size Total disk size     (MB) Used disk space as Used (%)     percentage Used (MB) Used disk space     Free disk space as Free (%)     percentage Free (MB) Free disk space     DISK IO STATISTICS Disk Disk partition     The number of read/write Transfers/Sec operations on the disk that     occur each second The percentage of elapsed time that the disk drive was Writes/sec     busy servicing write requests The percentage of elapsed time that the disk drive was Reads/Sec     busy servicing read requests The percentage of time the % Busy Time     disk was busy The average number of both Average read and write requests that     queue length were queued for the disk during the sample interval DISK SPACING Disk Name Name of the hard disk Disk Size Total size of the disk Network Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS NETWORK TRAFFIC Amount of data received on all network Incoming interfaces by     Traffic the virtual machine (in kB/min). Amount of data transmitted from all Outgoing network     Traffic interfaces by the virtual machine (in kB/min).Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS NETWORK INTERFACE The name of Network the network     Interface interface The estimate of Speed the current     (MB/s) bandwidth in MB/s The rate at which packets Input are received on traffic     the interface, in (kB/s) kilo bytes per second. Input Input traffic Utilization     percentage (%) The rate at which packets Output are sent on the traffic     interface, in (kB/s) kilo bytes per second. Output Output traffic Utilization     percentage (%) Number of Inbound packets that     Errors could not be received Number of Outbound packets that     Errors could not be sent Threads & Processes Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS THREAD STATS Thread The total number of threads.     Count Context The total number of context     switches/sec switches per second. PROCESS STATS Process The total number of     count processes. HANDLES Handle count The total number of handles     Services Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS Service DetailsParameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS Service Name of the service.     Name Display Display name of the service set     Name by the user. Status of the service. (Running, Paused, Stopped, Status StartPending, PausePending,     ContinuePending, or StopPending) Indicates the mode with which Start the service was started. (Auto     Mode or Manual) You can also add a new service by clicking over the ''Add New Service'' link. Configuration Parameter Description SYSTEM INFORMATION Resource Name Complete resource name of the virtual machine. Resource ID Virtual machine resource ID Status State of the VM Resource Group Name The resource group which has this VM VM Size Size of the VM Location Location at which the VM is set up Computer Name Name of the virtual machine. Public IP Address Public IP of the VM Private IP Address Private IP of the VM OS INFORMATION OS Type VM''s Operating system VM Image VM server configuration NETWORK INTERFACE Network Interface Name The name of the network interface Network Interface ID The ID of the network interface MAC Address MAC address of the network Network security group ID Network security group of the network interface Linux Virtual Machines - Monitored Metrics The below mentioned metrics are monitored for Linux VM: Overview Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS CPU UTILIZATION Amount of CPU CPU utilized by the     Utilization virtual machine (in %). CPU CREDITS (Applicable only for B-series virtual machines)Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS Number of CPU credits Credits consumed by     Consumed the virtual machine Remaining number of CPU credits Credits     available for Remaining the virtual machine. CPU Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS CPU METRICS Percentage of time that the processor is waiting (i.e. is in IO Wait an idle state and does     Time (%) nothing), during which there in fact was outstanding disk I/O requests. Idle Time Percentage of time that the     (%) processor was idle Percentage of time that the Processor processor was used for Time(Linux) processing instructions of a     (%) computer program or operating system Memory Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS MEMORY DETAILS Available The amount of memory     Memory available (in GB). Used The amount of memory used     Memory (in GB). Available Percentage of memory     Memory % available to the total memory Used Percentage of used swap Swap memory to the total swap     Memory % memory Disk Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS READ THROUGHPUT Amount of data read from OS Disk OS disk during Read     monitoring Throughput period (in kB/s).Parameter Description Data Collection Method Azure Monitor Diagnostic Agent Guest OS Amount of data read from Data Disk data disk Read during     Throughput monitoring period (in kB/s). WRITE THROUGHPUT Amount of data written to OS Disk OS disk during Write     monitoring Throughput period (in kB/s). Amount of data written to Data Disk data disk Write during     Throughput monitoring period (in kB/s). DISK I/O OPS Number of Disk Read disk read IOPS     Ops (in Ops/sec). Number of Disk Write disk write     Ops IOPS (in Ops/sec). DISK IO LATENCY Average time Average taken for a     Read Time read operation Average time Average taken for a     Write time write operation DISK SPACING Disk Name Name of the hard disk Disk Size Total size of the disk Configuration Configuration Table lists Virtual machine details like Status, Location, IP, Network interface, MAC address and Network Security Group. Parameter Description SYSTEM INFORMATION Resource Name Complete resource name of the virtual machine. Resource ID Virtual machine resource ID Status State of the VM Resource Group Name The resource group which has this VM VM Size Size of the VM Location Location at which the VM is set up Computer Name Name of the virtual machine. Public IP Address Public IP of the VMParameter Description Private IP Address Private IP of the VM OS INFORMATION OS Type VM''s Operating system VM Image VM server configuration NETWORK INTERFACE Network Interface Name The name of the network interface Network Interface ID The ID of the network interface MAC Address MAC address of the network Network security group ID Network security group of the network interface Microsoft Azure Storage Monitoring Microsoft Azure Storage - An Overview Creating a new Azure Storage Monitor Monitored Parameters Microsoft Azure Storage - An Overview Azure Storage is a group of highly scalable cloud-based storage services available for applications running in Azure cloud. Azure Storage provides facilities for storing files (File storage), files and media (Blob storage), messages (Queue storage) and non-relational schema-less data (Table storage). This help document enables you to understand how to get started with Azure Storage monitoring and to keep a close watch on the numerous Azure Storage performance metric using Applications Manager''s Azure monitoring. Creating a new Microsoft Azure Monitor  To create a new Azure Storage monitor, follow the steps given below: Click on the New Monitor link in the Applications Manager web client. Select ''Microsoft Azure'' under Cloud Apps category. Specify the Display Name of Microsoft Azure monitor. Enter the Subscription ID for your Microsoft Azure subscription. Click the Azure Services textbox and choose Storage Accounts from the drop-down menu. Choose the Discovery mode: Discovery using AD Application & Service Principal: Refer Prerequisites link and provide the Client ID, Tenant ID & Application key that were obtained in the above mentioned prerequisite step in the New monitor page. Discovery using Azure Organizational Account (Powershell): Refer Prerequisites link and provide the User email & Password fields in New monitor page with the Username & Password of the created Organizational account. Discovery using OAuth: Use the OAuth Provider that was obtained in the prerequisite step in the New monitor page. Refer Prerequisites section. Specify the polling interval in minutes and timeout in seconds Note: Azure Storage Account Monitoring supports ZRS Storage Accounts from v15310 onwards. Azure Premium Accounts are not supported in this monitor. However, you can view basic information for the same in the Azure parent monitor. Capacity metrics data is collected once in an hour and is mapped under Admin → Performance Polling. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Microsoft Azure Storage under the Cloud Apps table. Displayed is the Microsoft Azure Storage bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days.Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Microsoft Azure monitor provides a brief detail of the Azure Storage Accounts under the given subscription. Following are the list of metrics monitored in Azure Storage Monitoring in their corresponding tabs: Overview Blobs Tables Files Queues Overview Parameter Description Storage Services Availability The percentage of availability for the Blob storage service. Availability is calculated by taking the TotalBillableRequest value and dividing it by the number Blob Availability of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation. The percentage of availability for the Table storage service.Availability is calculated by taking the TotalBillableRequests value and dividing it by the Table Availability number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation. The percentage of availability for the Queue storage service . Availability is calculated by taking the TotalBillableRequests value and dividing it by the Queue Availability number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation. The percentage of availability for the File storage service .Availability is calculated by taking the TotalBillableRequests value and dividing it by the File Availability number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation. CONFIGURATION Storage Account Name The Azure Storage Account Name Status of Storage Account.Possible Values: Primary Status Available Unavailable Status of the Replica of Storage Account.Possible Values: Available Secondary Status Unavailable This attribute is available only if the Replication Type is Standard_RAGRS or Standard_GRS. Resource Group Resource Group where the Storage Account is allocated in. Location Region where the storage account is provisioned Provisioning state of Storage AccountPossible values : Invalid Creating Provisioning State Deleting Succeeded Failed CancelledParameter Description The replication type used by the Storage account:Possible values: Standard_LRS Standard_GRS Replication Type Standard_RAGRS Standard_ZRS Premium_LRS Blobs Parameter Description Capacity Blobs User Data Size The amount of storage used by the storage account’s Blob service, in GB. Container Count The number of blob containers in the storage account’s Blob service. Blob Object Count The number of blob containers in the storage account’s Blob service. Throughput The amount of ingress data, in MB. This number includes ingress from an external Blobs Total Ingress client into Azure Storage as well as ingress within Azure. The amount of egress data, in MB. This number includes egress to an external Blobs Total Egress client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress. The number of requests made to Blobs storage service or the specified API Blobs Total Requests operation. This number includes successful and failed requests, as well as requests which produced errors. Blobs Total Billable The number of billable requests to Blobs Requests Latency The average end-to-end latency of successful requests made to Blobs or the Blobs Average End-To-End specified API operation, in milliseconds. This value includes the required Latency processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response. The average latency used by Azure Storage to process a successful request, in Blobs Average Server milliseconds. This value does not include the network latency specified in Latency AverageE2ELatency. Requests Failed- Throttling Errors The number of authenticated requests to Blob storage service or the specified API Blobs Throttling Errors operation that returned a ThrottlingError. Blobs Anonymous Throttling The number of anonymous requests to Blob storage service or the specified API Errors operation that returned an AnonymousThrottlingError. The number of SAS requests to Blob storage service or the specified API operation Blobs SAS Throttling Errors that returned a SASThrottlingError. Blobs Throttling Error The percentage of requests that failed with a throttling error. Percentage Requests Failed – Timeout Errors The number of authenticated requests to Blob storage service or the specified API Blobs Client Timeout Errors operation that returned a ClientTimeoutError. Blobs Anonymous Client The number of anonymous requests to Blob storage service or the specified API Timeout Errors operation that returned an AnonymousClientTimeoutError. Blobs SAS Client Timeout The number of SAS requests to Blob storage service or the specified API operation Errors that returned an SASClientTimeoutError. The number of authenticated requests to Blob storage service or the specified API Blobs Server Timeout Errors operation that returned a ServerTimeoutError. Blobs Anonymous Server The number of anonymous requests to Blob storage service or the specified API Timeout Errors operation that returned an AnonymousServerTimeoutError.Parameter Description Blobs SAS Server Timeout The number of SAS requests to Blob storage service or the specified API operation Errors that returned an SASServerTimeoutError. Blobs Percent Timeout The percentage of requests that failed with a timeout error. This number includes Errors both client and server timeouts. Requests Failed – Other Client Errors The number of authenticated requests to a storage service or the specified API Blobs Client Other Errors operation that returned a ClientOtherError. Blobs SAS Client Other The number of SAS requests to a storage service or the specified API operation Errors that returned an SASClientOtherError. Blobs Anonymous Client The number of anonymous requests to a storage service or the specified API Other Errors operation that returned an AnonymousClientOtherError. Blobs Client Other Error The percentage of requests that failed with a ClientOtherError. Percentage Requests Failed – Other Server Errors The number of authenticated requests to Blob storage service or the specified API Blobs Server Other Errors operation that returned a ServerOtherError. Blobs Anonymous Server The number of anonymous requests to Blob storage service or the specified API Other Errors operation that returned an AnonymousServerOtherError. Blobs SAS Server Other The number of SAS requests to Blob storage service or the specified API operation Errors that returned an SASServerOtherError. Blobs Server Other Error The percentage of requests that failed with a ServerOtherError. Percentage Requests Failed – Authorization Errors The number of authenticated requests to Blob storage service or the specified API Blobs Authorization Errors operation that returned an AuthorizationError. Blobs Anonymous The number of anonymous requests to Blob storage service or the specified API Authorization Errors operation that returned an AnonymousAuthorizationError. Blobs SAS Authorization The number of SAS requests to Blob storage service or the specified API operation Errors that returned an SASAuthorizationError. Blobs Authorization Errors The percentage of requests that failed with an AuthorizationError. Percentage Requests Failed – Network Errors The number of authenticated requests to Blob storage service or the specified API Blobs Network Errors operation that returned a NetworkError. Blobs Anonymous Network The number of anonymous requests to Blob storage service or the specified API Errors operation that returned an AnonymousNetworkError . The number of SAS requests to Blob storage service or the specified API operation Blobs SAS Network Errors that returned a SASNetworkError. Blobs Network Errors The percentage of requests that failed with a NetworkError. Percentage Successful Requests Successful Requests to The number of successful requests made to a storage service or the specified API Blobs operation. Blobs Anonymous The number of successful anonymous requests made to a storage service or the Successful Requests specified API operation. Blobs SAS Successful The number of successful Shared Access Signature (SAS) requests made to a Requests storage service or the specified API operation. The percentage of successful requests. Note: that if there are no requests made against storage, the value of the Blobs Successful Requests PercentSuccess metric will be zero. If you are monitoring PercentSuccess, you Percentage will also want to ensure that the value of the TotalRequests metric is greater than zero. TablesParameter Description CAPACITY Table User Data Size (GB) The amount of storage used by the storage account’s Table service, in GB. Table Count Total number of tables present in the storage account''s Table service. Table Entity Count The total number of table entities in the storage account''s Table service. THROUGHPUT The amount of ingress data, in MB. This number includes ingress from an external Tables Total Ingress client into Azure Storage as well as ingress within Azure. The amount of egress data, in MB. This number includes egress to an external Tables Total Egress client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress. The number of requests made to Table storage service or the specified API Tables Total Requests operation. This number includes successful and failed requests, as well as requests which produced errors. Tables Total Billable The number of billable requests to Tables Requests Latency The average end-to-end latency of successful requests made to Tables or the Tables Average End-To-End specified API operation, in milliseconds. This value includes the required Latency processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response. The average latency used by Azure Storage to process a successful request, in Tables Average Server milliseconds. This value does not include the network latency specified in Latency AverageE2ELatency. Requests Failed- Throttling Errors The number of authenticated requests to Table storage service or the specified Tables Throttling Errors API operation that returned a ThrottlingError. Tables Anonymous The number of anonymous requests to Table storage service or the specified API Throttling Errors operation that returned an AnonymousThrottlingError. The number of SAS requests to Table storage service or the specified API Tables SAS Throttling Errors operation that returned a SASThrottlingError. Tables Throttling Error The percentage of requests that failed with a throttling error. Percentage Requests Failed – Timeout   Errors The number of authenticated requests to Table storage service or the specified Tables Client Timeout Errors API operation that returned a ClientTimeoutError. Tables Anonymous Client The number of anonymous requests to Table storage service or the specified API Timeout Errors operation that returned an AnonymousClientTimeoutError. Tables SAS Client Timeout The number of SAS requests to Table storage service or the specified API Errors operation that returned an SASClientTimeoutError. Tables Server Timeout The number of authenticated requests to Table storage service or the specified Errors API operation that returned a ServerTimeoutError. Tables Anonymous Server The number of anonymous requests to Table storage service or the specified API Timeout Errors operation that returned an AnonymousServerTimeoutError. Tables SAS Server Timeout The number of SAS requests to Table storage service or the specified API Errors operation that returned an SASServerTimeoutError. Tables Percent Timeout The percentage of requests that failed with a timeout error. This number includes Errors both client and server timeouts. Requests Failed – Other Client Errors The number of authenticated requests to Table storage service or the specified Tables Client Other Errors API operation that returned a ClientOtherError. Tables SAS Client Other The number of SAS requests to Table storage service or the specified API Errors operation that returned an SASClientOtherError. Tables Anonymous Client The number of anonymous requests to Table storage service or the specified API Other Errors operation that returned an AnonymousClientOtherError.Parameter Description Tables Client Other Error The percentage of requests that failed with a ClientOtherError. Percentage Requests Failed – Other Server Errors The number of authenticated requests to Table storage service or the specified Tables Server Other Errors API operation that returned a ServerOtherError. Tables Anonymous Server The number of anonymous requests to Table storage service or the specified API Other Errors operation that returned an AnonymousServerOtherError. Tables SAS Server Other The number of SAS requests to Table storage service or the specified API Errors operation that returned an SASServerOtherError. Tables Server Other Error The percentage of requests that failed with a ServerOtherError. Percentage Requests Failed – Authorization Errors The number of authenticated requests to Table storage service or the specified Tables Authorization Errors API operation that returned an AuthorizationError. Tables Anonymous The number of anonymous requests to Table storage service or the specified API Authorization Errors operation that returned an AnonymousAuthorizationError. Tables SAS Authorization The number of SAS requests to Table storage service or the specified API Errors operation that returned an SASAuthorizationError. Tables Authorization Errors The percentage of requests that failed with an AuthorizationError. Percentage Requests Failed – Network Errors The number of authenticated requests to Table storage service or the specified Tables Network Errors API operation that returned a NetworkError. Tables Anonymous Network The number of anonymous requests to Table storage service or the specified API Errors operation that returned an AnonymousNetworkError . The number of SAS requests to Table storage service or the specified API Tables SAS Network Errors operation that returned a SASNetworkError. Tables Network Errors The percentage of requests that failed with a NetworkError. Percentage Successful Requests The number of successful requests made to Table storage service or the specified Tables Requests to Blobs API operation. Tables Anonymous The number of successful anonymous requests made to Table storage service or Successful Requests the specified API operation. Tables SAS Successful The number of successful Shared Access Signature (SAS) requests made to Table Requests storage service or the specified API operation. The percentage of successful requests. Note that if there are no requests made against storage, the value of the Tables Successful Requests PercentSuccess metric will be zero. If you are monitoring PercentSuccess, you Percentage will also want to ensure that the value of the TotalRequests metric is greater than zero. Files Parameter Description CAPACITY File User Data Size (GB) The average amount of storage used by the storage account’s File service, in GB. File Count The total number of files present in the storage account''s File service. File Share Count The total number of file shares present in the storage account''s File service. File Share Quota (GB) The total amount of storage that can be used by File service, in GB. The total number of snapshots present on the share in storage account''s File File Share Snapshot Count service. File Share Snapshot Size The total amount of storage used by the snapshots in storage account''s File (GB) service, in GB.Parameter Description THROUGHPUT The amount of ingress data, in MB. This number includes ingress from an external Files Total Ingress client into Azure Storage as well as ingress within Azure. The amount of egress data, in MB. This number includes egress to an external Files Total Egress client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress. The number of requests made to File storage service or the specified API Files Total Requests operation. This number includes successful and failed requests, as well as requests which produced errors. Files Total Billable Requests The number of billable requests to Files Latency The average end-to-end latency of successful requests made to File Storage Files Average End-To-End Service or the specified API operation, in milliseconds. This value includes the Latency required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response. The average latency used by Azure Storage to process a successful request, in Files Average Server milliseconds. This value does not include the network latency specified in Latency AverageE2ELatency. Requests Failed- Throttling Errors The number of authenticated requests to File storage service or the specified API Files Throttling Errors operation that returned a ThrottlingError. Files Anonymous Throttling The number of anonymous requests to File storage service or the specified API Errors operation that returned an AnonymousThrottlingError. The number of SAS requests to File storage service or the specified API operation Files SAS Throttling Errors that returned a SASThrottlingError. Files Throttling Error The percentage of requests that failed with a throttling error. Percentage Requests Failed – Timeout Errors The number of authenticated requests to File storage service or the specified API Files Client Timeout Errors operation that returned a ClientTimeoutError. Files Anonymous Client The number of anonymous requests to File storage service or the specified API Timeout Errors operation that returned an AnonymousClientTimeoutError. Files SAS Client Timeout The number of SAS requests to File storage service or the specified API operation Errors that returned an SASClientTimeoutError. The number of authenticated requests to File storage service or the specified API Files Server Timeout Errors operation that returned a ServerTimeoutError. Files Anonymous Server The number of anonymous requests to File storage service or the specified API Timeout Errors operation that returned an AnonymousServerTimeoutError. Files SAS Server Timeout The number of SAS requests to File storage service or the specified API operation Errors that returned an SASServerTimeoutError. The percentage of requests that failed with a timeout error. This number includes Files Percent Timeout Errors both client and server timeouts. Requests Failed – Other Client Errors The number of authenticated requests to File storage service or the specified API Files Client Other Errors operation that returned a ClientOtherError. The number of SAS requests to File storage service or the specified API operation Files SAS Client Other Errors that returned an SASClientOtherError. Files Anonymous Client The number of anonymous requests to File storage service or the specified API Other Errors operation that returned an AnonymousClientOtherError. Files Client Other Error The percentage of requests that failed with a ClientOtherError. Percentage Requests Failed – Other Server Errors The number of authenticated requests to File storage service or the specified API Files Server Other Errors operation that returned a ServerOtherError.Parameter Description Files Anonymous Server The number of anonymous requests to File storage service or the specified API Other Errors operation that returned an AnonymousServerOtherError. Files SAS Server Other The number of SAS requests to File storage service or the specified API operation Errors that returned an SASServerOtherError. Files Server Other Error The percentage of requests that failed with a ServerOtherError. Percentage Requests Failed – Authorization Errors The number of authenticated requests to File storage service or the specified API Files Authorization Errors operation that returned an AuthorizationError. Files Anonymous The number of anonymous requests to File storage service or the specified API Authorization Errors operation that returned an AnonymousAuthorizationError. Files SAS Authorization The number of SAS requests to File storage service or the specified API operation Errors that returned an SASAuthorizationError. Files Authorization Errors The percentage of requests that failed with an AuthorizationError. Percentage Requests Failed – Network Errors The number of authenticated requests to File storage service or the specified API Files Network Errors operation that returned a NetworkError. Files Anonymous Network The number of anonymous requests to File storage service or the specified API Errors operation that returned an AnonymousNetworkError . The number of SAS requests to File storage service or the specified API operation Files SAS Network Errors that returned a SASNetworkError. Files Network Errors The percentage of requests that failed with a NetworkError. Percentage Successful Requests The number of successful requests made to File storage service or the specified Files Requests to Blobs API operation. Files Anonymous Successful The number of successful anonymous requests made to File storage service or the Requests specified API operation. Files SAS Successful The number of successful Shared Access Signature (SAS) requests made to File Requests storage service or the specified API operation. The percentage of successful requests. Note that if there are no requests made against storage, the value of the Files Successful Requests PercentSuccess metric will be zero. If you are monitoring PercentSuccess, you Percentage will also want to ensure that the value of the TotalRequests metric is greater than zero. Queues Parameter Description CAPACITY The average amount of storage used by the storage account’s Queue service, in Queue User Data Size (GB) GB. Queue Count The total number of queue in the storage account''s Queue service. The approximate number of queue messages in the storage account''s Queue Queue Message Count service. THROUGHPUT The amount of ingress data, in MB. This number includes ingress from an external Queues Total Ingress client into Azure Storage as well as ingress within Azure. The amount of egress data, in MB. This number includes egress to an external Queues Total Egress client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress. The number of requests made to Queue storage service or the specified API Queues Total Requests operation. This number includes successful and failed requests, as well as requests which produced errors.Parameter Description Queues Total Billable The number of billable requests to Queues Requests Latency The average end-to-end latency of successful requests made to Queue or the Queues Average End-To-End specified API operation, in milliseconds. This value includes the required Latency processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response. The average latency used by Azure Storage to process a successful request, in Queues Average Server milliseconds. This value does not include the network latency specified in Latency AverageE2ELatency. Requests Failed- Throttling Errors The number of authenticated requests to Queue storage service or the specified Queues Throttling Errors API operation that returned a ThrottlingError. Queues Anonymous The number of anonymous requests to Queue storage service or the specified API Throttling Errors operation that returned an AnonymousThrottlingError. Queues SAS Throttling The number of SAS requests to Queue storage service or the specified API Errors operation that returned a SASThrottlingError. Queues Throttling Error The percentage of requests that failed with a throttling error. Percentage Requests Failed – Timeout Errors Queues Client Timeout The number of authenticated requests to Queue storage service or the specified Errors API operation that returned a ClientTimeoutError. Queues Anonymous Client The number of anonymous requests to Queue storage service or the specified API Timeout Errors operation that returned an AnonymousClientTimeoutError. Queues SAS Client Timeout The number of SAS requests to Queue storage service or the specified API Errors operation that returned an SASClientTimeoutError. Queues Server Timeout The number of authenticated requests to Queue storage service or the specified Errors API operation that returned a ServerTimeoutError. Queues Anonymous Server The number of anonymous requests to Queue storage service or the specified API Timeout Errors operation that returned an AnonymousServerTimeoutError. Queues SAS Server Timeout The number of SAS requests to Queue storage service or the specified API Errors operation that returned an SASServerTimeoutError. Queues Percent Timeout The percentage of requests that failed with a timeout error. This number includes Errors both client and server timeouts. Requests Failed – Other Client Errors The number of authenticated requests to Queue storage service or the specified Queues Client Other Errors API operation that returned a ClientOtherError. Queues SAS Client Other The number of SAS requests to Queue storage service or the specified API Errors operation that returned an SASClientOtherError. Queues Anonymous Client The number of anonymous requests to Queue storage service or the specified API Other Errors operation that returned an AnonymousClientOtherError. Queues Client Other Error The percentage of requests that failed with a ClientOtherError. Percentage Requests Failed – Other Server Errors The number of authenticated requests to Queue storage service or the specified Queues Server Other Errors API operation that returned a ServerOtherError. Queues Anonymous Server The number of anonymous requests to Queue storage service or the specified API Other Errors operation that returned an AnonymousServerOtherError. Queues SAS Server Other The number of SAS requests to Queue storage service or the specified API Errors operation that returned an SASServerOtherError. Queues Server Other Error The percentage of requests that failed with a ServerOtherError. Percentage Requests Failed – Authorization Errors The number of authenticated requests to Queue storage service or the specified Queues Authorization Errors API operation that returned an AuthorizationError.Parameter Description Queues Anonymous The number of anonymous requests to Queue storage service or the specified API Authorization Errors operation that returned an AnonymousAuthorizationError. Queues SAS Authorization The number of SAS requests to Queue storage service or the specified API Errors operation that returned an SASAuthorizationError. Queues Authorization Errors The percentage of requests that failed with an AuthorizationError. Percentage Requests Failed – Network Errors The number of authenticated requests to Queue storage service or the specified Queues Network Errors API operation that returned a NetworkError. Queues Anonymous The number of anonymous requests to Queue storage service or the specified API Network Errors operation that returned an AnonymousNetworkError . The number of SAS requests to Queue storage service or the specified API Queues SAS Network Errors operation that returned a SASNetworkError. Queues Network Errors The percentage of requests that failed with a NetworkError. Percentage Successful Requests The number of successful requests made to Queue storage service or the Queues Requests to Blobs specified API operation. Queues Anonymous The number of successful anonymous requests made to Queue storage service or Successful Requests the specified API operation. Queues SAS Successful The number of successful Shared Access Signature (SAS) requests made to Queue Requests storage service or the specified API operation. The percentage of successful requests. Note that if there are no requests made against storage, the value of the Queues Successful PercentSuccess metric will be zero. If you are monitoring PercentSuccess, you Requests Percentage will also want to ensure that the value of the TotalRequests metric is greater than zero. Windows Azure Cloud Service Monitoring (Classic) (Deprecated) Windows Azure - Overview Creating a new Windows Azure Monitor Monitored Parameters Windows Azure - Overview Applications Manager''s Windows Azure monitor enables users to collect diagnostic data for the applications deployed in Windows Azure platform. Windows Azure is monitored using REST API to discover the list of deployed applications and get the performance counters based on the Role instances of the service. With Windows Azure monitoring capabilities in ManageEngine Applications Manager, you can: Discover Windows Azure applications and all its roles instances. Collect and monitor performance information based on role instances. Collect and monitor Windows Azure Event Logs, Trace Logs and Diagnostic Infrastructure Logs Adding a Windows Azure application will include all the Hosted Services, deployments and its roles instance based on the Storage account. The hosted services and deployments will be created as a group. Creating a new Windows Azure monitor in Applications Manager Prerequisites: To add Windows Azure in Applications Manager, you must first export your Windows Azure Managed Certificates file (eg., testcertificate.pfx) and the password of the pfx file. To export your Windows Azure Managed Certificates file , invoke the batch script exportCertificateToAppManager.bat in the bin directory.To create a new Windows Azure monitor, follow the steps given below: Click on the New Monitor link in the Applications Manager web client. Enter the Subscription ID for your Windows Azure account. (Note: Subscription ID can be obtained by signing into windows.azure.com using your windows live id. Then click Hosted Service and navigate to Storage & CDN, then to Storage Accounts) Enter the Account Name and Account key of your Windows Azure Storage account. Check the checkbox if your service is https-enabled. Specify a Timeout interval in seconds Specify the Polling Interval in minutes If you are adding a new monitor from an Admin Server, select a Managed Server. Note: Before creating a new Windows Azure monitor, you have to configure proxy settings under ''Admin'' tab. Creating and deploying Management Certificates in Azure Login to the machine where you have installed Windows Azure SDK and IIS 7. To load the IIS 7 Management console, go to the Control Panel, select Administrative Tools and then IIS Manager. In the IIS section of the center pane, double-click Server Certificates. Click Create Self-Signed Certificate in the Actions panel. Enter a name for the file. Close the IIS Manager and open the Certificate Manager. Under Trusted Root Certification Authorities, open Certificates. Right-click your certificate, choose All Tasks and Export. The Certificate Export Wizard appears. Click Next. You can export the certificate with or without a private key. First, export the certificate without a private key to be uploaded to Windows Azure Portal. Then export the certificate again with a private key to be used in Service Management API. Exporting the certificate without a private key: When the Certificate Export Wizard appears, Click Next. On the Export Private Key page, click No. Select the CER file format and click Next. Enter a name and click Next. Click Finish to start the export process. Exporting the certificate with a private key: When the Certificate Export Wizard appears, Click Next. On the Export Private Key page, click Yes, export the private key. Keep the default value, then click Next. Specify a password for protecting your private key and click Next. Specify a name for the PFX file and click Next. Click Finish to start the export process. The .cer file can be uploaded in the Windows Azure portal and the .pfx file which has the private key can be used in Applications Manager. Monitored Parameters Windows Azure platforms are monitored based on the parameters or the attributes listed below. You can also configure thresholds to the numerical attributes based on these details and get notified when the thresholds are violated. The Availability tab shows the availability history for Azure Role instances for the past 24 hours or 30 days. The Performance tab shows some key performance indicators such as CPU, Memory Utilization, Exceptions thrown andHealth History along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. The List view displays all the Azure role instances along with an overall idea of their availability and health status. The list view also enables you to perform bulk admin configurations. You can click on the individual role instances to view detailed performance metrics. Click on the monitor listed in the Availability tab to view detailed performance metrics of the Azure role instances. These metrics are categorized into 4 different tabs for easy understanding: Overview Event Logs Trace Logs Diagnostic Infrastructure Logs Overview This tab provides a high-level overview of your Azure account as well as information about the Role instances present in this account. Parameter Description Monitor Information Name The name of the Windows Azure account. Type Denotes the type you are monitoring. Denotes the health (Clear, Warning, Critical) status of the Windows Azure Health account. Denotes the monitor groups associated with the Windows Windows Azure Associated Groups monitor. Last Polled at Specifies the time at which the last poll was performed Next Poll at Specifies the time at which the next poll will be performed CPU Utilization Usage of CPU resources or the amount of work handled by CPU Memory Utilization Memory Available Memory Usage Time Spend in Garbage Collection Exceptions Thrown Number of exceptions thrown per second Number of times Application Restarted Request Execution Time Number of Requests Disconnected Number of times Worker Process Restarted ASP .NET System Performance Total Number of Requests Counters Number of Requests executed per second Current Requests Recent Request Waited Time Number of Queued Request waiting for service Number of Requests Rejected Number of TCP Connections failed TCP Connections Number of TCP Connections Established Number of TCP Connections Reset TCP Segment Connections TCP segments sent per sec Total number of Bytes received per second for all interfaces Network Traffic Total number of Bytes sent per second for all interfaces Network Traffic VM Bus Adapter Total number of bytes send and received per sec for VM Bus Network Adapter Total number of bytes received per second for VM Bus Network AdapterTotal number of bytes sent per second for VM Bus Network Adapter Monitoring Logs in Applications Manager Event Logs, Trace logs and Diagnostic infrastructure logs of the Windows Azure Role Instances can be monitored by defining rules. On clicking Windows Azure Log rule configuration, you can create rules for Diagnostic Infrastructure and Trace logs. When the Azure Role Instance starts it data collection, all the logs associated to the role instance will be matched the rule. On matching the rule, an event will be generated and the log entry will be persisted in the database. The log information will be available in the GUI of the Azure role instance Event Logs On clicking Event Log Rules configuration tab, you can create rules on various category such as Application, System, Application, Security, DNS Server, File replication service and Directory service. You can view Windows Azure Event Log Details like: Parameter Description Rule Name Specify the name of the rule. Provider Guid Globally unique identifier of the provider Provider Name Provider name of the event. Event ID The identifier of the event. Level This field provides the severity of the event. Process ID The process ID of the event. Thread ID The thread ID of the event. Channel You can get notified by the events from channels like Applications, Security, System, etc. Generated Time The time at which the event is generated. Trace logs In the trace logs tab, you can view Windows Azure Event Log Details like: Parameter Description Rule Name Specify the name of the rule. Event ID The identifier of the events Level This field provides the severity of the log event. Process ID The process ID of the log. Thread ID The thread ID of the log. Generated Time The time at which the event is generated. Diagnostic infrastructure logs In the Diagnostic infrastructure logs tab, you can view Windows Azure Diagnostic Infrastructure Log Details like : Parameter Description Rule Name Specify the name of the rule. Error Code Specify the error code of the log. Level This field provides the severity of the log event. Process ID The process ID of the log. Thread ID The thread ID of the log. Function Specify the function of the log event. Line Specify the line containing the function. MD Result Specify the MDetect result of the log. Event Generated Time The time at which the event is generated. Microsoft Azure SQL Database MonitoringMicrosoft Azure SQL Database- An Overview Adding a new Microsoft Azure SQL Database monitor Monitored Parameters Microsoft Azure SQL Database Monitoring Tool - An Overview Azure SQL DB is a relational database-as-a-service (DBaaS) hosted in the Azure cloud. Data is hosted, managed and provisioned in Microsoft data centers. Since organizations constantly deal with large amounts of data at a global scale, it goes without saying that a proper Microsoft Azure SQL database management tool is highly recommended to monitor and understand what is going on while storing and retrieving huge amounts of data constantly on cloud. Applications Manager''s Azure SQL database performance monitoring provides monitoring of Azure SQL performance metrics and query statistics so that users can be informed of any performance issues happening in their Azure SQL database. It eases your Azure monitoring needs by keeping a close watch on Azure SQL database monitoring metrics along with proactive Azure SQL database query monitoring, providing deep insights into the performance of your Azure SQL environments. In this help document, you will learn how to get started with Azure SQL database performance monitoring by keeping a close watch on various Azure SQL performance metrics with the help of Applications Manager. Creating a new Microsoft Azure SQL Database monitor Prerequisites for setting up Microsoft SQL Azure database monitoring: Click here Using the REST API to add a new Microsoft Azure SQL Database monitor: Click here Follow the steps given below to create a new monitor: Click on the New Monitor link in the Applications Manager web client. Select ''Microsoft Azure'' under Cloud Apps category. Specify the Display Name of Microsoft Azure monitor. Enter the Subscription ID for your Microsoft Azure subscription. Click the Azure Services textbox and choose ''Azure SQL Databases'' from the drop-down menu. Choose the Discovery mode: Discovery using AD Application & Service Principal: Refer Prerequisites link and provide the Client ID, Tenant ID & Application key that were obtained in the above mentioned prerequisite step in the New monitor page. Discovery using Azure Organizational Account (Powershell): Refer Prerequisites link and provide the User email & Password fields in New monitor page with the Username & Password of the created Organizational account. Discovery using OAuth: Use the OAuth Provider that was obtained in the prerequisite step in the New monitor page. Refer Prerequisites section. Specify the polling interval in minutes and timeout in seconds. Choose the Monitor Group from the combo box with which you want to associate Microsoft Azure SQL server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Microsoft Azure SQL database server from the network and starts monitoring them. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Azure SQL Database under the Cloud Apps table. Displayed is the Azure SQL database bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Azure SQL Database Monitoring Metrics SQL Azure database monitoring tool like Applications Manager eases out your Microsoft Azure SQL database management needs by providing visibility into your Azure SQL cloud environments along with Azure SQL database query monitoring altogether in a single window, providing all the vital Azure SQL database monitoring metrics in the following tabs:Monitor Information Overview Top Queries by CPU Top Queries by IO Top CLR Queries and Waits Top Slow Running Queries Frequently Executed Queries Most Blocked Queries Configuration Note: To monitor Query Statistics, the username and password of the SQL database should be provided in the ''Edit Monitor'' page. Monitor Information Parameter Description Database Name Name of the Azure SQL Database Database Username Username of the SQL Server of this particular database  Database Server Name of the SQL server Resource Group Name Resource group to which the SQL database is associated Timeout Timeout Duration(seconds) Associated Groups The monitor groups to which this monitor is associated Last Polled At Specifies the time at which the last poll was performed Next Poll At Specifies the time at which the next poll is scheduled Overview Parameter Description RESOURCE UTILIZATION CPU Utilization Average percentage of CPU utilized between the poll interval. Average percentage of Data Transaction Unit (DTU) consumed between the DTU Utilization * poll interval. IO Utilization Average percentage of Data IO utilized between the poll interval. DTU UTILIZATION DTU Limit * Average limit of Data Transaction Unit between the poll interval. DTU Used * Average Data Transaction Unit used between the poll interval. DATABASE SIZE Storage Utilization Amount of storage space utilized in the database (in percentage). Allocated Database Amount of storage space allocated for the database (in MB). Used Database Amount of storage space used in the database (in MB). Total Database Maximum amount of storage space available in the database (in GB). CONNECTIONS Successful connections Total number of successful connections between the poll interval. Failed connections Total number of failed connections between the poll interval. Total number of connections that are blocked by firewall between the poll Connections Blocked by firewall interval. PERFORMANCE STATISTICS Deadlocks Total number of deadlocks occurred between the poll interval. Log IO Percentage Average percentage of log IO between the poll interval. In-memory OLTP storage used Average percentage of In-Memory Online Transaction Processing storage percentage used between the poll interval.Parameter Description Workers(concurrent requests) Average percentage of Workers used between the poll interval. used percentage Sessions used percentage Average percentage of sessions between the poll interval. Note: Metrics marked with * can be monitored only in DTU-based Azure SQL Database servers. Top Queries by CPU Parameter Description Average CPU time(ms) Average CPU time taken to execute this query Total CPU time(ms) Total CPU time taken to execute this query Average Execution time(ms) Average time taken to execute this query Query Indicates the query executed. Last Execution time The time when this query was last executed Top Queries by IO Parameter Description Average IO Average IO operations for this query Total IO Total IO operations for this query Average Execution time(ms) Average time taken to execute this query Query Indicates the query executed. Last Execution time The time when this query was last executed Top CLR Queries and Waits Parameter Description Top CLR queries Average CLR time(ms) Average CLR time taken to execute this query Total CLR time(ms) Total CLR time taken to execute this query Average Execution time(ms) Average time taken to execute this query Query Indicates the query executed. Last Execution time The time when this query was last executed Top Waits by waiting tasks Waiting tasks Number of waiting tasks Wait time(ms) Total wait time Average Wait time(ms) Average wait time by the waiting tasks Signal time(ms) Signal time by the waiting task Wait type Type of the waiting tasks Top Slow Running Queries Parameter Description Average Execution Time(ms) Average execution time for this query Maximum Execution Time(ms) Maximum execution time for this query Minimum Execution time(ms) Minimum execution time for this query Number of Executions Number of times this query was executed Query Indicates the query executed. Last Execution time The time when this query was last executedFrequently Executed Queries Parameter Description Execution count Number of times this query was executed Average Execution time(ms) Average execution for this query Query Indicates the query executed. Last Execution time The time when this query was last executed Most Blocked Queries Parameter Description Average time blocked(ms) Average time this query was blocked Total time blocked(ms) Total time this query was blocked Average Execution time(ms) Average time taken to execute this query Query Indicates the query executed. Last Execution time The time when this query was last executed Configuration Parameter Description Database name Name of the Azure SQL Database Database status Status of the SQL database Database Location Location of the SQL database Database Server Name of the SQL Server Resource Group Name Resource group to which the SQL database is associated Database Edition Edition/Pricing tier of this database Database Creation Date Date on when this database was created Database Earliest Restore Date Oldest restore point Elastic Pool The Elastic pool to this this database is associated if any Azure Service Bus Monitoring (ARM) Azure Service Bus - Overview Microsoft Azure Service Bus is a fully managed enterprise integration message broker. Service Bus can decouple applications and services. Service Bus offers a reliable and secure platform for asynchronous transfer of data and state. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Service Bus instance available under Microsoft Azure in the Cloud Apps section. Displayed is the Azure Service Bus bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the Azure Service Bus dashboard. It has 4 tabs: Overview Queues Topics ConfigurationOverview Parameter Description NAMESPACE DETAILS Number of Queues The number of queues present in a namespace. Number of Topics The number of topics present in a namespace. Namespace Used Size Amount of space utilized by the namespace (in MB). Status Status of the namespace. REQUEST STATISTICS Incoming Requests The number of requests made to the Service Bus service over a specified poll interval. Incoming The number of requests made per minute to the Service Bus. Requests/min The number of successful requests made to the Service Bus service over a specified Successful Requests poll interval. Throttled Requests The number of requests that were throttled because the usage was exceeded. REQUEST ERRORS User Errors The number of requests not processed due to user errors over a specified period. The number of requests not processed due to an error in the Service Bus service over a Server Errors specified period. MESSAGE STATISTICS Incoming Messages The number of events or messages sent to Service Bus over a specified period. Incoming The number of events or messages sent per minute to Service Bus. Messages/min Outgoing Messages The number of events or messages received from Service Bus over a specified period. Outgoing The number of events or messages received per minute from Service Bus. Messages/min MESSAGE DETAILS Total Messages Total number of messages available on an entity. Active Messages Number of active messages on an entity. Dead Letter Messages Number of dead-lettered messages on an entity. Scheduled Messages Number of scheduled messages on an entity. CONNECTIONS STATISTICS Active Connections The number of active connections on a namespace as well as on an entity. Connections Opened Number of connections that were opened. Connections Closed Number of connections that were closed. RESOURCE USAGE * Namespace CPU The percentage of the amount of CPU used by the namespace. Usage Namespace Memory The percentage of the amount of memory used by the namespace. Usage Note: The server details marked with an * symbol is applicable only for ''Premium'' tier namespaces and not for Basic and Standard tiers. Queues Parameter Description Queue Details Queue Name of the queue. Status Status of the queue. Possible values are Active, Activating, or Removed. Total Size Total amount of space allocated for the queue. Used Size(%) Amount of space utilized by the queue (in percentage).Parameter Description Free Size(%) Remaining amount of space available for use by the queue (in percentage). Used Size(MB) Amount of space utilized by the queue (in MB). Free Size(MB) Remaining amount of space available for use by the queue (in MB). Messages Total number of messages available in a queue. Active Messages Number of active messages in a queue. Dead Letter Messages Number of dead-lettered messages in a queue. Transfer Messages Number of transfer messages in a queue. Transfer Dead Letter Number of transfer dead-lettered messages in a queue. Messages Active Queues based on Incoming Requests: Provides a graphical representation of the request details of Active Queues with respect to number of incoming requests in the namespace. Active Queues based on Messages: Provides a graphical representation of the message details of Active Queues with respect to number of incoming and outgoing messages in the namespace. Queue Metrics Queue Name of the queue. Incoming Requests The number of requests made to the queue over a specified poll interval. Successful Requests The number of successful requests made to the queue over a specified poll interval. Throttled Requests The number of throttled requests made to the queue over a specified poll interval. Incoming Messages The number of events or messages sent to the queue over a specified poll interval. The number of events or messages received from the queue over a specified poll Outgoing Messages interval. Scheduled Messages Number of scheduled messages in a queue. The number of requests not processed due to user errors in the queue over a User Errors specified period. The number of requests not processed due to server errors in the queue over a Server Errors specified period. Topics Parameter Description Topic Details Topic Name of the topic. Status Status of the topic. Possible values are Active, Activating, or Removed. Total Size Total amount of space allocated for the topic. Used Size(%) Amount of space utilized by the topic (in percentage). Free Size(%) Remaining amount of space available for use by the topic (in percentage). Used Size(MB) Amount of space utilized by the topic (in MB). Free Size(MB) Remaining amount of space available for use by the topic (in MB). Subscription Count Total number of subscriptions available in a topic. Active Messages Number of active messages in a topic. Dead Letter Messages Number of dead-lettered messages in a topic. Transfer Messages Number of transfer messages in a topic. Transfer Dead Letter Number of transfer dead-lettered messages in a topic. Messages Active Topics based on Incoming Requests: Provides a graphical representation of the request details of Active Topics with respect to number of incoming requests in the namespace. Active Topics based on Messages: Provides a graphical representation of the message details of Active Topics with respect to number of incoming and outgoing messages in the namespace. Topic Metrics Topic Name of the topic.Parameter Description Incoming Requests The number of requests made to the topic over a specified period. Successful Requests The number of successful requests made to the topic over a specified period. Throttled Requests The number of throttled requests made to the topic over a specified period. Incoming Messages The number of events or messages sent to the topic over a specified period. Outgoing Messages The number of events or messages received from the topic over a specified period. Scheduled Messages Number of scheduled messages in a topic. The number of requests not processed due to user errors in the topic over a User Errors specified period. The number of requests not processed due to server errors in the topic over a Server Errors specified period. Configuration Parameter Description NAMESPACE DETAILS Resource Group Specifies the Resource Group of the Service Bus Namespace. Location The location/region of the Service Bus Namespace. Indicates the tier used in the Service Bus Namespace. Possible values are Basic, Standard Tier or Premium. Service Bus End Indicates the endpoint URL of the Service Bus Namespace. point Created Time Date and time at which the Service Bus Namespace was created. Last Updated Time Date and time at which the Service Bus Namespace was last updated. Resource ID Indicates the resource ID of the Service Bus Namespace. Microsoft Azure Kubernetes Service (AKS) Monitoring Overview Azure Kubernetes Service (AKS) offers server-less Kubernetes, an integrated continuous integration and continuous delivery (CI/CD) experience and enterprise-grade security and governance. Azure Kubernetes Service (AKS) simplifies deploying a managed Kubernetes cluster in Azure by offloading the operational overhead to Azure. As a hosted Kubernetes service, Azure handles critical tasks, like health monitoring and maintenance. Since Kubernetes masters are managed by Azure, you only manage and maintain the agent nodes. Thus, AKS is free; you only pay for the agent nodes within your clusters, not for the masters. It allows you to rapidly build, deliver and scale applications. Creating a new monitor Prerequisites for monitoring Microsoft AKS metrics: Click here To learn how to create a new AKS monitor, refer here. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Kubernetes Service instance available under Microsoft Azure in the Cloud Apps section. Displayed is the Microsoft AKS bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. By clicking a monitor from the list, you''ll be taken to the Microsoft AKS monitor dashboard. It has 6 tabs: OverviewNode Pool Node Pods Services Persistent Volumes Service Map Overview Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights CLUSTER INFORMATION Current status of the Status cluster. (Running,     Stopped) The Azure Resource Name Cluster FQDN     (ARN) of the cluster. Cluster Location where the cluster     Location resides. Cluster Kubernetes version of the Kubernetes     cluster server. Version CLUSTER DETAILS Git Version Git version of the cluster.     Build Date Build date of the cluster.     Name of the compiler Compiler     used. Platform OS Platform of the cluster.     CLUSTER AUTOSCALER DETAILS (Applicable only when cluster autoscaler is enabled) Determines if the scale Cluster down is in cooldown. No Scaledown nodes will be removed     Cooldown during this timeframe at the time of polling. Cluster autoscaler marks Cluster those nodes as candidates UnNeeded for deletion and are     Nodes eventually deleted at the time of polling Number of pods that are Cluster currently unschedulable in UnSchedulable     the cluster at the time of Pods polling. Determines the health of Cluster Health the autoscaler at the time     of polling. NAMESPACE DETAILS Namespace UUID of the namespace.     UUID Namespace Name of the namespace     Name Number of pods count in Pods Count the namespace at the time     of polling.Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Number of running pods Running pods under the namespace at     in namespace the time of polling. Number of pending pods Pending Pods under the namespace at     the time of polling. Number of succeeded Succeeded pods under the     Pods namespace at the time of polling. Number of failed pods Failed Pods under the namespace at     the time of polling. Number of succeeded pods under the Unknown Pods     namespace at the time of polling. Number of containers Restarting restarted count in the Container     namespace at the time of Count polling. Number of OOM killed OOMKilled containers count in the Container     namespace at the time of Count polling. Percentage of the number of pods that are in ready Pods Ready     stage at the time of polling. Namespace Timestamp at which the Resource     Namespace was created Version Namespace Timestamp at which the     Availability Namespace was created Namespace Timestamp at which the     Created Time Namespace was created CLUSTER CPU & MEMORY DETAILS Available Total number of available Cluster CPU CPU cores in the cluster at     Cores the time of poll interval. Available Total number of available Cluster Memory in the cluster at     Memory the time of poll interval. NODE DETAILS Number of master nodes Master Nodes     available in the cluster. Number of worker nodes Worker Nodes     available in the cluster. CLUSTER USAGE DETAILS Average amount of CPU Avg. CPU used by the cluster (in     Usage percentage). Average amount of Avg. Memory memory used by the     Usage cluster (in percentage). NODE COUNT DETAILSParameter Description Data Collection Method Kubectl Azure Monitor Container Insights Number of nodes that are Nodes Ready in ready stage at the time     of polling. Number of nodes that are Nodes Not not in ready stage at the     Ready time of polling. Top 5 Nodes by Used Pods - Displays a graphical representation of top 5 nodes with respect to the number of pods used. PODS Used pods in Percentage of the number     cluster % of pods used. Used pods in Number of pods used in     cluster the cluster. Maximum pods Maximum number of pods     in cluster available in the cluster. PODS PHASE Total number of pods Total Failed failed in the cluster at the     Pods time of polling. Total number of pods Total Pending pending in the cluster at     Pods the time of polling. Total number of pods Total Running running in the cluster at     Pods the time of polling. Total number of pods Total Unknown unknown in the cluster at     Pods the time of polling. Total Total number of pods Succeeded succeeded in the cluster     Pods at the time of polling. COMPONENT DETAILS Component Name of the component.     Name Availability status of the Availability     component. Node Pool Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Node Pool Details * Name Name of the node pool.     The current status of the Status managed node pool. (Running     or Stopped) The size of the agent pool VM Size VMs. VM size availability     varies by region. Kubernetes The version of Kubernetes     Version running on the agent pool. Image The version of node pool     Version image.Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Minimum Node Size The minimum number of     (Auto- nodes for auto-scaling. Scaling) Maximum Node Size The maximum number of     (Auto- nodes for auto-scaling. Scaling) Maximum The maximum number of pods     Pods Count that can run on a node. Node Pool Utilization * Name Name of the node pool.     The operating system type. OS Type     Default value is Linux. Specifies an OS SKU. This OS SKU value must not be specified if     OS type is Windows. The OS disk type to be used OS Disk for machines in the agent     Type pool. Size of the OS Disk to be used OS Disk to specify the disk size for     Size every machine in the master/agent pool (in GB). Average CPU utilization measured across the node CPU Usage     pool between the poll interval (in percentage). Disk space used for node pool Disk Usage between the poll interval (in     percentage). Container RSS memory used Memory for node pool between the poll     RSS Usage interval (in percentage). Container working set memory Memory used for node pool between     WS Usage the poll interval (in percentage). * Note: Azure Monitor metrics are not available for Windows node pool. Node Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Top 5 Nodes by Memory Details - Displays a graphical representation of top 5 nodes with respect to their corresponding memory details (in percentage). Top 5 Nodes by CPU Details - Displays a graphical representation of top 5 nodes with respect to their corresponding CPU details (in percentage). Node Usage Details * Node Name Name of the node.     Average CPU utilization in CPU Usage millicores across the node   Millicores between the poll interval.Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Average CPU utilization CPU Usage measured across the node   (%) between the poll interval (in percentage). Disk space used for node Disk Usage between the poll interval (in   (GB) GB). Disk space used for node Disk Usage between the poll interval (in   (%) percentage). Memory Container RSS memory used RSS Usage for node between the poll   (GB) interval (in GB). Memory Container RSS memory used RSS Usage for node between the poll   (%) interval (in percentage). Container working set Memory WS memory used for node   Usage (GB) between the poll interval (in GB). Container working set Memory WS memory used for node   Usage (%) between the poll interval (in percentage). Amount of data received by Network In the network for the node     Usage between the poll interval (in MB). Amount of data transmitted Network Out by the network for the node     Usage between the poll interval (in MB). Node Pod Details Node Name Name of the node.     Number of pods available for Pod Usage usage with used and free     pods split-up. Number of pods that are used Used Pods     in the node. Number of pods that are free Free Pods     in the node. Allocatable Number of pods that are     Pods allocatable in the node. Kube- Number of Kube state pods in system Pod     the node. Count Non-Kube- Number of non-Kube state system Pod     pods in the node. Count Number of images present in Images     the node. NODE DETAILS Node Name Name of the node.     OS Image OS Image name of the node.     Name of the OS in which the OS     container is deployed.Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Architecture details of the Architecture     node. Type Type of node used.     Kubelet The version of Kubelet used.     Version Allocatable Size of temporary memory Ephemeral     available (in GiB). Storage Created Timestamp at which the node     Time was created. * Note: Azure Monitor metrics are not available for Windows node. Pods Parameter Description Data Collection Method Kubectl Azure Container Monitor Insights Pod Details Pod UUID Universal unique ID of the pod.     Pod Name Name of the pod.     Pod Namespace in which the pod resides.     Namespace Pod Node Name of the pod-node.     Name Pod Name of the pod application.     Application Pod Type Type of pod used.     Pod created Medium by which the pod was created.     Status of the pod. (Pending, Running, Pod Status     Succeeded, Failed, or Unknown) Amount of time elapsed since the pod was Pod Age     created (in days). Pod Start Timestamp at which the pod was started.     Time Pod Created Timestamp at which the pod was created.     Time Top 10 Pods by Memory Details - Displays a graphical representation of top 10 pods with respect to their corresponding memory details (in percentage). Top 10 Pods by CPU Details - Displays a graphical representation of top 10 pods with respect to their corresponding CPU details (in percentage). Pod Usage Details Pod UUID Universal unique ID of the pod.     Pod Name Name of the pod.     Pod Name of the pod.     Namespace Pod Containers The number of containers run by the pod.     Count Pod CPU The maximum limit of CPU resource which can     Limit be used (in percentage).Parameter Description Data Collection Method Kubectl Azure Container Monitor Insights Pod CPU The number of CPU requests by pod (in     Request percentage). Pod The maximum limit of memory resource that Memory     can be used (in percentage). Limit Pod The number of memory requested (in Memory     percentage). Request Pod created Medium by which the pod was created.     Pod Persistent Name of the Claim through which a pod can     Volumes access the persistent volume. Claim Container Details Container ID of the container.     ID Container Name of the container.     Name Container Name of the container image.     Image Container Name of the container pod.     Pod Name Container The number of times the container has     Restarts restarted. Status of the container. Following are the list of possible values that are shown for each status: Status Value Running Running ContainerCreating CrashLoopBackOff ErrImagePull Waiting ImagePullBackOff Container CreateContainerConfigError     Status InvalidImageName CreateContainerError OOMKilled Error Terminated Completed ContainerCannotRun DeadlineExceeded Container Amount of time elapsed since the container was     Age started (in days). Container Timestamp at which the container was started.     Start Time Services Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Service DetailsParameter Description Data Collection Method Kubectl Azure Monitor Container Insights Universal unique ID of the Service UUID     service. Service Name Name of the service.     Name of the Namespace Service in which the service     Namespace resides. Name of the service Application     application. Service Type Type of the service.     Service Name of the service     Protocol protocol. Host IP IP address of the service     Address host. Service Target Name of the port that     Port connects with the service. Timestamp at which the Created Time     service was created. Deployment Details Deployment Universal unique ID of the     UUID deployment. Deployment Name of the deployment.     Name Deployment Namespace where the     Namespace deployment exists. Deployment The number of replicas in     Replicas a deployment. Deployment Number of available Available     replicas in a deployment. Replicas Deployment Availability of the     Availability deployment. Persistent Volumes Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights PERSISTENT VOLUMES (PV) DETAILS Universal unique ID of the PV UUID     Persistent Volume. Name of the Persistent PV Name     Volume. Status of the Persistent PV Status Volume. (Available, Bound,     Released, Failed, or Pending) Name of the Persistent PV Claim     Volume Claim. The mode through which you PV Access can access the Persistent     Mode Volume. PV Storage Name of the Persistent     Class Volume storage class. The capacity of the Persistent PV Capacity     Volume (in GiB).Parameter Description Data Collection Method Kubectl Azure Monitor Container Insights Timestamp at which the PV Created Persistent Volume was     Time created. PERSISTENT VOLUMES CLAIM (PVC) DETAILS Universal unique ID of the PVC UUID     persistent volume. Name of the Persistent PVC Name     Volume Claim. PVC Name of the Namespace in     Namespace which the Claim exists. Status of the Persistent Volume Claim. (Available, PVC Status     Bound, Released, Failed, or Pending) Name of the Persistent PV Name     Volume. The mode through which you PVC Access can access the Persistent     Mode Volume Claim. PVC Name of the Persistent Storage     Volume storage class. Class PVC Number of Persistent Volume     Requests Claim requests (in GiB). PVC Timestamp at which the Created Persistent Volume Claim was     Time created. Service Map Displays a graphical map view containing namespace and service details. All the namespace with its status and pods count for each phase will be seen inside cluster circle. Green color indicates that the namespace is UP and red color indicates it is DOWN. The cluster services under a namespace can be seen branching as a tree. Each service contains its host IP address and port details. Note: For metrics available in both Container insights and Azure Monitor, Applications Manager give preference to Container Insight metrics if Container Insights is enabled. OpenStack MonitoringOpenStack – An Overview Creating a new OpenStack monitor Monitored Parameters OpenStack – An Overview OpenStack is a cloud operating system that controls large pools of compute, storage, and networking resources, providing a framework to create and manage both public cloud and private cloud infrastructures. Creating a new OpenStack monitor Prerequisites for adding a new OpenStack monitor: Click here Using the REST API to add a new OpenStack monitor: Click here To create a new OpenStack monitor, follow the steps given below: Click on New Monitor link. Select OpenStack under Cloud Apps category. Specify the Display Name of the OpenStack server Enter the Base Authentication URL of the OpenStack for accessing the OpenStack. The sample URL is: http://openstack:5000/ Enter the Tenant Name. Tenant Name is the project name of the OpenStack Choose the Credential Details either use below credentials or select from credential list Enter the Username and Password of the OpenStack.  Select Need Proxy, if you require to give proxy server details Select ProjectScopeToken, if the authorization scope is set to Project/Tenant. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the OpenStack monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the OpenStack server from the network and starts monitoring it. Note: If you require proxy server, you have to configure proxy settings under ''Admin'' tab. Applications Manager automatically discovers all the OpenStack instances under your OpenStack account. You can then enable monitoring for those instances and images as per your requirement. Monitored Parameters  Go to the Monitors Category View by clicking the Monitors tab. Click on the OpenStack monitor under the Cloud Apps Table. Displayed is the OpenStack bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days along with key performance indicators like Response Time. List view enables you to perform bulk admin configurations and displays all the OpenStack instances along with an overall idea of their availability and health status. Openstack monitoring software like Applications Manager provides complete visibility into your OpenStack environments altogether in a single window based on the following tabs: Overview Compute Storage Network Overview This tab provides a high-level overview of your OpenStack account as well as information about the OpenStack instances present in this account. Parameter Description InstancesParameter Description ID The unique ID of the server. Name The name of the monitored instance. The current status of the instance. The possible values are: ACTIVE, BUILDING, DELETED, ERROR, Status PAUSED, RESCUED, RESIZED, SHELVED, SHELVED_OFFLOADED, SOFT_DELETED, STOPPED, SUSPENDED. A virtual machine image is a single file which contains a virtual disk that has a bootable operating Image system installed on it Images ID The unique ID of the image. Name The name of the image uploaded to the image service. The current status of the image. Images in Glance can be in one the following statuses: queued - The image identifier has been reserved for an image in the Glance registry. No image data has been uploaded to Glance and the image size was not explicitly set to zero on creation. saving - Denotes that an image’s raw data is currently being uploaded to Glance. When an image is registered with a call to POST /images and there is an x-image-meta-location header present, that image will never be in the saving status (as the image data is already available in some other location). active - Denotes an image that is fully available in Glance. This occurs when the image data is uploaded, or the image size is explicitly set to zero on creation. Status deactivated - Denotes that access to image data is not allowed to any non-admin user. Prohibiting downloads of an image also prohibits operations like image export and image cloning that may require image data. killed - Denotes that an error occurred during the uploading of an image’s data, and that the image is not readable. deleted - Glance has retained the information about the image, but it is no longer available to use. An image in this state will be removed automatically at a later date. pending_delete - This is similar to deleted, however, Glance has not yet removed the image data. An image in this state is not recoverable. Visibility The scope of image accessibility. Possible values are ''public'', ''private'', ''shared'', ''community''. The disk format of a virtual machine image is the format of the underlying disk image. Possible values are: aki - An Amazon kernel image. ami - An Amazon machine image. ari - An Amazon ramdisk image. iso - An archive format for the data contents of an optical disc, such as CD-ROM. qcow2 - Supported by the QEMU emulator that can expand dynamically and supports Copy on Disk Write. Format raw - An unstructured disk image format; if you have a file without an extension it is possibly a raw format. vdi - Supported by VirtualBox virtual machine monitor and the QEMU emulator. vhd - The VHD disk format, a common disk format used by virtual machine monitors from VMware, Xen, Microsoft, VirtualBox, and others. vhdx - The VHDX disk format, an enhanced version of the VHD format, which supports larger disk sizes among other features. vmdk - Common disk format supported by many common virtual machine monitors.  Size The Size of the image to be uploaded. Services ID The unique ID of the service. Name The name of the OpenStack service. An endpoint is just a URL that can be used to access a service within OpenStack. An endpoint is just Endpoint like a point of contact for YOU (the user) to use an OpenStack service. Response The Service endpoint HTTP response status code. CodeCompute This tab provides information about the OpenStack Hypervisors and Compute Services present in this account. Parameter Description Hypervisors The unique ID of the hypervisor. The format of the Hypervisor ID is a combination of ID and ID Hostname. Hostname The hypervisor host name. State The state of the hypervisor. Possible values are up,down. Status The status of the hypervisor. Possible values are enabled, disabled. Compute Services The unique ID of the Compute Service. The format of the Compute Service ID is a ID combination of ID and Hostname. Name The binary name of the service. Hostname The name of the host. Zone The availability zone name. Compute Service The state of the Compute service. Possible values are up, down. State Compute Service The status of the Compute service. Possible values are enabled, disabled. Status Storage This tab provides information about the OpenStack Cinder Services present in this account. Parameter Description Cinder Services The unique ID of the Cinder Service. The format of the Cinder Service ID is a combination of ID name and hostname. Name The binary name of the service. Hostname The name of the host. Zone The availability zone name. Cinder Service The state of the Cinder service. Possible values are up, down. State Cinder Service The status of the Cinder service. Possible values are enabled, disabled. Status Network This tab provides information about the OpenStack Neutron Agents present in this account. Parameter Description Neutron Agents ID The unique ID of the resource. Type The type of agent such as Open vSwitch agent or DHCP agent. Hostname The hostname of the system the agent is running on. Neutron Agent State The administrative state of the resource, which is up (true) or down (false). Neutron Agent The status of the network agent (true/false). True indicates that the agent is alive and Status running. Microsoft 365 Monitoring Microsoft 365 - An Overview Monitoring Microsoft 365 - What we doCreating a new Microsoft 365 monitor (Video) Monitored Parameters Microsoft 365 - An Overview Microsoft 365 (formerly Office 365) refers to a group of subscription plans that provide productivity software like access to Office applications plus and related services. This includes server that are enabled over the internet (cloud services), such as Lync web conferencing and Exchange Online hosted email for business and additional online storage with OneDrive and Skype world minutes for home. There are different tiers to Microsoft 365, such as personal, home and business. In its most basic form, you get access to full Office desktop apps, mobile apps for Android and iOS, OneDrive storage, Skype minutes and more. For business users, Microsoft 365 also offers service subscriptions for e-mail and social networking services through hosted versions of Exchange Server, Skype for Business Server, SharePoint Office Online, Microsoft Teams, and integration with Yammer.  Monitoring Microsoft 365 - What we do Applications Manager''s Microsoft 365 monitoring provides operational intelligence into Microsoft 365 applications, including Exchange Online, SharePoint Online, Skype for Business, and Microsoft Teams. You can view a holistic picture of the health and performance of Microsoft 365 deployments and associated services using custom, interactive dashboards. Exchange Online - Gather long-term data and present detailed reports for Exchange Online, such as mailbox statistics, Exchange Online service health, endpoint connectivity and dozens of other details. SharePoint Online - Get detailed metrics into the health and affected tenant count of SharePoint Online services, including Access Services, Office Web Apps, Yammer components, etc. Applications Manager also keeps track of the TCP connectivity of various SharePoint Online endpoints as well as the performance of SharePoint applications and sites. Skype For Business Online - Monitor key metrics of Skype for Business Online, including the health status of services such as audio and video, federation, sign-in, etc. Checks for the connectivity status and response time of various endpoints as well as the top sessions by duration. Microsoft Teams - Track the key performance metrics such as the health status of services, connectivity status and response time of various endpoints. Obtain useful insights about the number of members and channels of all the teams in your organization, and get complete information on the usage statistics based on various devices and activity types. Note: Microsoft 365 Services are supported only on Windows installations of Applications Manager. Applications Manager offers comprehensive performance monitoring for Microsoft 365, enabling admins to minimize downtime and performance degradation as well as take corrective actions before any problems arise. The latest monitoring capabilities in Applications Manager also include: Microsoft 365 License Reporting and Management - Stay on top of the provisioning of licenses; manage user licenses in bulk and know the actual Assigned License Count under each service type. Get organization license information like Consumed Licenses, Locked out units, Suspended Units, Unassigned Licenses, Total User Count, License and Tenant Name. Microsoft 365 Service Health - You can view the health of Microsoft 365, and associated services  on the Service health page. If you are experiencing problems with a cloud service, you can check the service health to see its Affected Tenant Count and Last Updated Time to determine if a resolution in progress before you call support or spend time troubleshooting. Endpoints Connectivity - Keep track of the TCP connectivity of various SharePoint Online endpoints as well as the performance of SharePoint applications and sites. Fix Performance Problems Faster - Get instant notifications of common performance issues with a cloud service; check the service health to diagnose service incidents, drill down to their root cause and resolve them quickly to ensure smooth and uninterrupted service delivery. Ensure Microsoft 365 applications are consistently delivering a high-quality experience for end users In this help document, you will learn how to get started with Microsoft 365 monitoring using Applications Manager. Creating a new Microsoft 365 monitor Mode of Monitoring: PowerShell Prerequisites for monitoring Microsoft 365 metrics: Click hereUsing the REST API to add a new Microsoft 365 monitor: Click here Follow the steps given below to create a new Microsoft 365 monitor: Click on New Monitor link. Choose Microsoft 365. Specify the Display Name of the Microsoft 365 monitor. Enter the Domain Name/Tenant Name used to sign up for Microsoft 365. Example: The tenant name for apm@apmtest.onmicrosoft.com is apmtest Enter the Microsoft 365 admin account User Email. Enter the Password for the Microsoft 365 admin email. Choose Microsoft 365 Services: Exchange Online, Skype For Business Online, Sharepoint Online or Microsoft Teams Enable the Service Health Monitoring option to monitor the Service Health information. After enabling, specify the following details: Tenant ID: Enter the Tenant ID of the tenant in which the applicaton is created to monitor the service health. Client ID: Enter the Client ID/Application ID of the applicaton created to monitor the service health. Client Secret: Enter the Client Secret created in the applicaton created to monitor the service health. Note: Service Health monitoring is mandatory to monitor Microsoft Teams in Applications Manager. Specify the polling interval in minutes and timeout in seconds. Choose the Monitor Group from the combo box with which you want to associate Microsoft 365 monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Microsoft 365 from the network and starts monitoring them. Create a new Microsoft 365 Monitor video How to add Oce 365 Monitor? Note: The Microsoft 365 admin account used for monitoring must be assigned the below roles: Exchange administrator, SharePoint administrator or Skype For Business administrator Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Microsoft 365 monitors under the Cloud Apps table. Displayed is the Microsoft 365 bulk configuration view distributed into three tabs: Availability tab displays the availability history for the past 24 hours or 30 days. Performance tab displays the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configuration. Click on the monitor name to see all the server details listed under the following tabs: Overview Exchange Online Sharepoint Online Skype For Business Online Microsoft Teams OverviewParameter Description USER DETAILS Total User The total number of users for the Microsoft 365 subscription Count Licensed The number of user accounts with license. User Count Unlicensed The number of user accounts without license. User Count License Details License The name of the license plan. Name Total License The number of licenses that have been purchased for a specific licensing plan. Count Consumed The number of licenses that have been assigned to users from a specific licensing plan. Licenses Unassigned The number of licenses available for assignment Licenses Warning The number of licenses in a licensing plan that you haven''t renewed, and that will expire after the Units 30-day grace period. Locked Out The number of accounts that have been locked out Units Suspended The number of accounts that have been suspended Units Microsoft 365 Service Health Details Service ID ID of the Microsoft 365 service. Service Name of the service. Name Overall status of the service. Possible values are serviceOperational, investigating, restoringService, verifyingService, serviceRestored, postIncidentReviewPublished, Service serviceDegradation, serviceInterruption, extendedRecovery, falsePositive, Status investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, or unknownFutureValue. Microsoft 365 Service Issue Details Service ID - Feature Group - Indicates the Service ID, Feature Group, Feature, and Issue ID of the Microsoft 365 service issue. Feature - Issue ID Status of the service issue. Possible values are serviceOperational, investigating, restoringService, Issue verifyingService, serviceRestored, postIncidentReviewPublished, serviceDegradation, Status serviceInterruption, extendedRecovery, falsePositive, investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, and unknownFutureValue. Issue Type Type of the service issue. Possible values are advisory, incident, or unknownFutureValue. Origin of the service issue. Possible values are microsoft, thirdParty, customer, or Issue Origin unknownFutureValue. Issue Indicates the description for the service issue. Description Hour(s) since issue Amount of time (in hours) elapsed since the issue has occurred. occurred Issue Start Timestamp at which the service issue was started. Time Last Modified Timestamp at which service issue was last modified. Time Endpoints ConnectivityParameter Description Endpoint The Microsoft 365 endpoint / URL. Port The port on which endpoint / URL is accessible. Status The status of endpoint/ URL. Response The time taken for connecting to endpoint/URL. Time Exchange Online Monitoring Exchange Online - An Overview Monitoring Exchange Online - What we do Monitored Parameters Exchange Online - An Overview Exchange Online is a business-class email and calendaring service developed by Microsoft and hosted in the public cloud. It is available as a stand-alone service or as part of an Microsoft 365 plan. Exchange Online provides the benefits of a cloud-based email service with the robust capabilities of an on-premises Exchange server deployment. Monitoring Exchange Online - What we do Applications Manager gathers long-term data and present detailed reports for Exchange Online, such as mailbox statistics, Exchange Online service health, endpoint connectivity and dozens of other details. Note: Microsoft 365 Services are supported only on Windows installations of Applications Manager Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Exchange Online monitors under the Cloud Apps table. Displayed is the Exchange Online bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. You can also navigate to the Exchange Online bulk configuration view through the Exchange Online tab in the Microsoft 365 Monitor page. Click on the monitor name to see all the server details listed under the following tabs: Overview Mailbox Statistics Overview Parameter Description Exchange Online Service Health Details Service ID ID of the Exchange Online service. Service Name of the service. Name Overall status of the service. Possible values are serviceOperational, investigating, restoringService, verifyingService, serviceRestored, postIncidentReviewPublished, Service serviceDegradation, serviceInterruption, extendedRecovery, falsePositive, Status investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, or unknownFutureValue. Exchange Online Issue DetailsParameter Description Feature Group - Indicates the Feature Group, Feature, and Issue ID of the Exchange Online service issue. Feature - Issue ID Status of the service issue. Possible values are serviceOperational, investigating, restoringService, Issue verifyingService, serviceRestored, postIncidentReviewPublished, serviceDegradation, Status serviceInterruption, extendedRecovery, falsePositive, investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, and unknownFutureValue. Issue Type Type of the service issue. Possible values are advisory, incident, or unknownFutureValue. Issue Origin of the service issue. Possible values are microsoft, thirdParty, customer, or Origin unknownFutureValue. Issue Indicates the description for the service issue. Description Hour(s) since issue Amount of time (in hours) elapsed since the issue has occurred. occurred Issue Start Timestamp at which the service issue was started. Time Last Modified Timestamp at which service issue was last modified. Time Endpoints Connectivity Endpoint The Exchange Online endpoint / URL Port The port on which endpoint / URL is accessible Status The status of endpoint/ URL Response The time taken for connecting to endpoint/URL Time Mailbox Statistics Parameter Description Top Mailboxes by Size Mailbox UserName The mailbox account username Total Mailbox Size(MB) The total size of Mailbox in MB Number of Items The number of items in mailbox Inactive Mailbox Users Mailbox UserName The Mailbox account username Last Logon Time The last Login Time of Mailbox User SharePoint Online Monitoring Sharepoint Online - An Overview Monitoring Sharepoint Online - What we do Monitored Parameters SharePoint Online - An Overview SharePoint online is a cloud-based service that allows organizations store, retrieve, search, archeive, track, manage, and report on digitized documents. It is available as a standalone product. SharePoint Online comes in handy when the security requirements are complex and when content management requires custom workflows. Monitoring SharePoint Online - What we do Get detailed metrics into the health and affected tenant count of SharePoint Online services, including Access Services, Office Web Apps, Yammer components, etc. Applications Manager also keeps track of the TCPconnectivity of various SharePoint Online endpoints as well as the performance of SharePoint applications and sites. Note: Microsoft 365 Services are supported only on Windows installations of Applications Manager Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Sharepoint Online monitors under the Cloud Apps table. Displayed is the SharePoint Online bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. You can also navigate to the Sharepoint Online bulk configuration view through the Sharepoint Online tab in the Microsoft 365 Monitor page. Click on the monitor name to see all the server details listed under the following tabs: Overview Sites and Applications Overview Parameter Description Sharepoint Online Service Health Details Service ID ID of the Sharepoint Online service. Service Name of the service. Name Overall status of the service. Possible values are serviceOperational, investigating, restoringService, verifyingService, serviceRestored, postIncidentReviewPublished, Service serviceDegradation, serviceInterruption, extendedRecovery, falsePositive, Status investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, or unknownFutureValue. Sharepoint Online Issue Details Feature Group - Indicates the Feature Group, Feature, and Issue ID of the Sharepoint Online service issue. Feature - Issue ID Status of the service issue. Possible values are serviceOperational, investigating, restoringService, Issue verifyingService, serviceRestored, postIncidentReviewPublished, serviceDegradation, Status serviceInterruption, extendedRecovery, falsePositive, investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, and unknownFutureValue. Issue Type Type of the service issue. Possible values are advisory, incident, or unknownFutureValue. Issue Origin of the service issue. Possible values are microsoft, thirdParty, customer, or Origin unknownFutureValue. Issue Indicates the description for the service issue. Description Hour(s) since issue Amount of time (in hours) elapsed since the issue has occurred. occurred Issue Start Timestamp at which the service issue was started. Time Last Modified Timestamp at which service issue was last modified. Time Endpoints Connectivity Endpoint The Sharepoint Online endpoint / URL Port The port on which endpoint / URL is accessibleParameter Description Status The status of endpoint/ URL Response The time taken for connecting to endpoint/URL Time Sites and Applications Parameter Description Sites Statistics Site URL The sharepoint Site URL Storage Used (GB) The storage used by sites in GB Storage Free (GB) The storage free for use for site in GB Resources Used The resources used out of allocated limit Resources Free The resources free for use from allocated limit. Lock State The lock status of site. Last Content Modified The last content modified time of sharepoint site. Time Status The status of site. Websites Count The number of websites in sharepoint site collection. Application Statistics Product ID Unique ID of the SharePoint application. Application Name Name of the SharePoint application. Source Source of the SharePoint application. Install Errors Number of errors occurred during installation of SharePoint application. Runtime Errors Number of errors occurred during runtime of SharePoint application. Upgrade Errors Number of errors occurred during upgrade of SharePoint application. Skype for Business Online Monitoring Note: Skype for Business Online monitoring is not supported from Applications Manager version 15340 onwards as it has reached end of support. Please unmanage or delete this monitor if already present. By default, these monitors will be unmanaged from version 15340 onwards. Skype for Business - An Overview Monitoring Skype for Business - What we do Monitored Parameters Skype for Business - An Overview Skype for Business (formerly known as Microsoft Lync Server) is a unified communications (UC) platform that integrates common channels of business communication and online meetings, including instant messaging (IM), presence, voice over IP (VoIP), voicemail, file transfers, video conferencing, web conferencing and email. Skype for Business can be deployed on premises, in the cloud or as a hybrid service. Monitoring Skype for Business - What we do Monitor key metrics of Skype for Business Online, including the health status of services such as audio and video, federation, sign-in, etc. Checks for the connectivity status and response time of various endpoints as well as the top sessions by duration. Note: Microsoft 365 Services are supported only on Windows installations of Applications Manager. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Skype for Business monitors under the Cloud Apps table. Displayed is the Skype for Business bulk configuration view distributed into three tabs:Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. You can also navigate to the Skype for Business bulk configuration view through the Skype for Business tab in the Microsoft 365 monitor page. Overview Sessions * Note: Tabs/attributes marked with * have been removed from the UI as the APIs used to fetch these details have been deprecated. Overview Parameter Description Skype For Business Online Service Health Service – Feature The Skype For Business Online Service – Feature Name. Status The status of the Service – Feature. Affected Tenant Count The number of tenants potentially affected by service incident. Affected User Count The number of users potentially affected by service incident. Last Updated Time The last updated time for service incident. Description The description of the service incident. Endpoints Connectivity Endpoint The Skype For Business Online endpoint / URL. Port The port on which endpoint / URL is accessible. Status The status of endpoint / URL. Response Time The time taken for connecting to endpoint/URL. Sessions * Parameter Description Top Sessions Statistics * From URI The user’s SIP URI from which the call was made. To URI The user’s SIP URI to which the call was made. Call Duration (Minutes)  The length of calls (actively connected) in a time slot. Media Type The media type - Conference, IM, Audio, Video Microsoft Teams Monitoring Microsoft Teams - An Overview Microsoft Teams is a proprietary business communication platform developed by Microsoft, as part of the Microsoft 365 family of products. Teams primarily competes with the similar service Slack, offering workspace chat and video conferencing, file storage, and application integration. Also, it helps you to replace other Microsoft- operated business messaging and collaboration platforms, including Skype for Business and Microsoft Classroom. Monitoring Microsoft Teams - What we do Applications Manager''s Microsoft Teams monitoring helps you to keep track of the key performance metrics such as the health status of services, connectivity status and response time of various endpoints. Obtain useful insights about the number of members and channels of all the teams in your organization, and get complete information on the usage statistics based on various devices and activity types. Note: Microsoft 365 Services are supported only on Windows installations of Applications ManagerMonitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the MS Teams monitors under the Cloud Apps table. Displayed is the Microsoft Teams bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. You can also navigate to the Microsoft Teams bulk configuration view through the Microsoft Teams tab in the Microsoft 365 monitor page. Click on the monitor name to see all the server details listed under the following tabs: Overview Teams and Channels Usage Overview Parameter Description Microsoft Teams Service Health Details Service ID ID of the Microsoft Teams service. Service Name of the service. Name Overall status of the service. Possible values are serviceOperational, investigating, restoringService, verifyingService, serviceRestored, postIncidentReviewPublished, Service serviceDegradation, serviceInterruption, extendedRecovery, falsePositive, Status investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, or unknownFutureValue. Microsoft Teams Issue Details Feature Group - Indicates the Feature Group, Feature, and Issue ID of the Microsoft Teams service issue. Feature - Issue ID Status of the service issue. Possible values are serviceOperational, investigating, restoringService, Issue verifyingService, serviceRestored, postIncidentReviewPublished, serviceDegradation, Status serviceInterruption, extendedRecovery, falsePositive, investigationSuspended, resolved, mitigatedExternal, mitigated, resolvedExternal, confirmed, reported, and unknownFutureValue. Issue Type Type of the service issue. Possible values are advisory, incident, or unknownFutureValue. Issue Origin of the service issue. Possible values are microsoft, thirdParty, customer, or Origin unknownFutureValue. Issue Indicates the description for the service issue. Description Hour(s) since issue Amount of time (in hours) elapsed since the issue has occurred. occurred Issue Start Timestamp at which the service issue was started. Time Last Modified Timestamp at which service issue was last modified. Time Endpoints Connectivity Endpoint The Microsoft Teams endpoint / URL. Port The port on which endpoint / URL is accessible. Status The status of endpoint / URL. Response The time taken for connecting to endpoint / URL (in milliseconds). TimeTeams and Channels Parameter Description Team Details Team Name Name of the team. Team ID Unique identifier assigned for the team. Description Gives the description about the team. Channel Count Number of channels created in the team. Member Count Number of members added to the team. Channel Details Channel Name Name of the channel. Team Name The team in which the channel is present. Channel ID Unique identifier assigned for the channel. Description Gives the description about the channel. Member Count Number of members added to the channel. Note: While monitoring Channel Details, there are instances where data might not be shown for Member Count attribute. To resolve this, refer here. Usage Parameter Description Collected Date Collected date for usage data Date from which the usage data is collected. NUMBER OF USERS BASED ON DEVICE TYPE PER DAY Web (Users Per Day) Number of users using Microsoft Teams from the Web per day. Number of users using Microsoft Teams from the Windows Phone per Windows Phone (Users Per Day) day. Number of users using Microsoft Teams from the Android Phone per Android Phone (Users Per Day) day. iOS (Users Per Day) Number of users using Microsoft Teams from the iOS per day. Mac (Users Per Day) Number of users using Microsoft Teams from the Mac per day. Windows (Users Per Day) Number of users using Microsoft Teams from the Windows per day. NUMBER OF USERS BASED ON DEVICE TYPE IN LAST 30 DAYS Number of users using Microsoft Teams from the Web in the last 30 Web (Users Per Month) days. Number of users using Microsoft Teams from the Windows Phone in the Windows Phone (Users Per Month) last 30 days. Number of users using Microsoft Teams from the Android Phone in the Android Phone (Users Per Month) last 30 days. Number of users using Microsoft Teams from the iOS in the last 30 iOS (Users Per Month) days. Number of users using Microsoft Teams from the Mac in the last 30 Mac (Users Per Month) days. Number of users using Microsoft Teams from the Windows in the last 30 Windows (Users Per Month) days. USER COUNT BASED ON ACTIVITY TYPE Team Chat Messages (Users Per Day) Number of users doing team chat messages per day. Private Chat Messages (Users Per Day) Number of users doing private chat messages per day. Calls (Users Per Day) Number of users doing calls per day. Meetings (Users Per Day) Number of users doing meetings per day. ACTIVITY COUNT BASED ON ACTIVITY TYPEParameter Description Team Chat Messages (Activity Count Total number of team chat messages done by all users per day. Per Day) Private Chat Messages (Activity Count Total number of private chat messages done by all users per day. Per Day) Calls (Activity Count Per Day) Total number of calls done by all users per day. Meetings (Activity Count Per Day) Total number of meetings done by all users per day. Custom Monitors The following custom monitors are available in Applications Manager. JMX / SNMP Dashboard File / Directory Monitor Windows Performance Counters Script Monitors Database Query Monitor JMX / SNMP Dashboard These custom monitors provide a real-time, correlated view of the entire application stack improving J2EE/J2SE application performance by monitoring its data sources such as JMX MBean source and SNMP Agents. JMX / SNMP Dashboard is a logical grouping that consist of data sources such as JMX MBean and SNMP OID. It can have both the JMX and SNMP attributes. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Building JMX / SNMP Dashboard involves Creating JMX / SNMP Dashboard and adding it to a specific Monitor Group Adding Attributes The advantage of creating the dashboard is to monitor various data source at a common place. Creating a JMX / SNMP Dashboard For example, you have a Java application with built-in manageability using JMX and any application that has an SNMP interface, then they are managed by building JMX / SNMP Dash Board. To create a JMX / SNMP Dash Board, follow the given steps: Select New Monitor. Choose JMX / SNMP Dashboard. Provide any name for the custom monitor and a description. Click Add JMX / SNMP Dashboard to create the custom monitor. This opens a screen that allows you to add attributes for custom monitors. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] The next step is to build the custom monitor to enable monitoring your data sources. You need to discover JMX MBeans and SNMP Agent data source to add attributes. The following are the JMX MBean resources whose MBean attributes are monitored by Applications Manager using Custom Monitor. Troubleshoot: Having trouble in monitoring custom applications? Refer the Online Troubleshooting section. Adding AttributesOnce you add a JMX / SNMP Dashboard, the Add Attributes option is available. Click that to add custom attributes to your Custom Monitor. The following are the data source for which custom monitors are built by Applications Manager. Click on the topics to view the steps required to add the respective data sources or attributes to the Custom Monitor. Adding JMX MBean Attributes. Adding SNMP OID Attributes. Adding JMX MBeans Attributes The following are the JMX MBean resources whose MBean attributes are monitored by Applications Manager using Custom Monitor: JMX [MX4J / JDK 1.5] WebLogic Server JBoss Server To add the attributes, follow these steps: In the Add Attributes screen, select the JMX MBean resource from the combo box and click Add. You can also discover a resource using Add Monitorprovided alongside the combo box and add them to the list of resources. Select the domains and click Show MBeans to list all the MBeans of those domains. You can also specify some filter criteria to match the MBean names. Alternatively, you can add the MBean atrributes directly, by choosing the Add the MBean attributes directly option. You can enter the MBean ObjectName, Attribute Name and Attribute Type (String / Numeric) and then add that attribute to be monitored. For Numeric attributes, you can edit and set whether you want to view the values as Counters or Non Counters. From the next poll onwards, the latest type would be displayed. On clicking Show MBeans button, you get the list of all the MBeans. Select the MBean (all attributes) or only the required attribute(s) by enabling the check box provided alongside. In case of tabular MBeans, select the attribute (all columns) or only the required columns. Click Add Attributes. All the selected attributes will be listed with their details. Note: You have an option to enable / disable reports for scalar numerical attributes, which is indicated through the above images in the Reports column. Refer to Viewing Reports for more details on report generation. Click the Back to Details Page button to view the newly created Custom Monitor. This screen lists all the attributes added. If you want to add or delete attributes, click Add or Delete Custom Attributes. Note: If the JMX data source is WebLogic Server 6.1 or WebLogic 6.1 sp1, you have to specify the full object name in the filter criteria to get the MBean attributes. This is because of the implementation bug in WebLogic 6.1. However, versions WebLogic 6.1 SP2 and above do not have this problem. Note: Steps to Create JMX Notification Listener (JMX [MX4J / JDK 1.5]) In the JMX [MX4J / JDK 1.5] Monitor page, click on the ''Create new JMX Notification Listener'' link. The first step is to choose the Domain of the JMX Agent. After selecting the Domain, Click on ''Show MBeans'' to view the MBeans that belong to the selected Domain. The second step is to choose the Mbeans from the list that is shown. The third step will be to create the new JMX Notification Listener. Enter the Name and select the status of the Listener as enabled or disabled. Set the severity of the Alarm that will be generated once a JMX notification is received, as Critical/Warning/Clear. Associated actions that need to be executed when the notification is received can be chosen from the list of actions configured. Clicking on ''Save'' will have a JMX Notification Listener configured, which would generate alarms of the configured severity and execute actions. Adding SNMP OID Attributes Once the Custom Monitor is created, you have to add the required SNMP attributes added to it. Follow these steps: Click on Add attributes link.It opens up Customize screen - Select a SNMP monitor from the combo box for adding the attributes. Click add. Mib Browser opens up - select the MIB that contains the attribute to be added to the Custom Monitor. Select the attributes that you want to monitor. Click Add to add the selected attributes. Note: The MIB, whose attributes are required to be added to the Custom Monitor, must be present in the /working/mibs directory of Applications Manager. To add the MIBs to the directory, use Add Mib Form. The MIB must be implemented in the SNMP Agent being monitored. File / Directory Monitor Creating a new monitor Monitored Parameters Configuring RCA Message for File Monitor Creating a new File/Directory monitor Using the REST API to add a new File/Directory monitor: Click here To create a file / directory monitor, follow the steps given below: From the New Monitor link, select File / Directory Monitor. Provide a Display Name for the monitor. Select whether it is a File or Directory monitor. Specify whether the File / Directory to be monitored is in the Local or Remote Server. If it is in the Local Server, provide the absolute path to the file / directory. If it is in the Remote Server, either select the Host Name from the dropdown or create a new host, and then provide the file / directory''s absolute path. You can create a new host by entering a new hostname / IP address and login credentials of the host. You can either enter the credential details like user name, password, the command prompt or select the required credential from the Credential Manager list. Select the Mode Of Monitoring (WMI for Windows, Telnet / SSH for Linux), the port and the Command Prompt, if required. Also, there is an option to Resolve Hostname / IP, enabling which will resolve the entered IP address to its corresponding hostname. The new hosts that are created can also be deleted by selecting the required host and clicking on the Delete Host link. However, hostnames that are already present and configured for server monitoring cannot be deleted in this manner. For a File monitor, select the Do Content Check checkbox if you wish to run a content check. If this checkbox is enabled, perform the following steps: Choose between the File Parsing Options to perform a content check to Only appended content or the Whole File. Select the required option under Monitor Severity to perform this content check to change the Health or Availability severity status. You can add criteria based on which the content check can be performed to change the Health or Availability severity by clicking on the Create New Rule link. This opens a new window where you can add new rules. Under this window, select the severity criteria for Health (CRITICAL / WARNING / CLEAR) or Availability (UP / DOWN) from the Severity drop-down menu. Enter the string for which you want to check content matching in the Content to be searched text box. You can add/remove multiple strings using the (+ / -) button. There are two conditions to configure the monitor status: Any: When this option is chosen, the monitor status will be affected based on the chosen Severity criteria if any of the contents from the above Content textbox match. Also, you can enter the number of contents to be checked in the corresponding textbox if you wish to check for more than one string. All: If all of the content matches, the monitor status will become UP / DOWN. The monitor status will be affected based on the chosen Severity criteria.You can perform a content check for regular expressions by enabling the Do Regular Expression Search checkbox (Refer Regex Guide for more info). You can perform a content check for case sensitive character strings by enabling the Do Case Sensitive Search checkbox. Enable the Clear monitor status when the file is not modified checkbox to control content check when the file is not updated during the polling interval. If this option is enabled and the file was not updated, then the current monitor status will be set for Availability as UP and Health as CLEAR. However, this option is displayed only after selecting the Only appended content option under File Parsing Options. For both File and Directory monitor, you can enable the Do file / directory age check checkbox to change the monitor status to UP / DOWN if the file/directory is MODIFIED / NOT MODIFIED within a certain time period. For Directory monitor, enable the Filter files in directory option to filter files in the given directory (does not include Sub-directories) and generate alerts. After enabling, enter the following details: File Name: File name pattern with which the files need to be filtered in the directory. Filter Category: Parameters based on which the files need to be filtered. Files can be filtered based on their Size, Last Modified Time, and Created Time (supported only for Windows directory). Alert for Severity: The severity with which alert needs to be raised when the above specified conditions are met. Enable the Alert when file / directory doesn''t exist checkbox for alerting when the required file / directory to be monitored is not found. Enter the Polling interval time period in minutes and the Timeout in seconds. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the dropdown to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the file/directory from the network and starts monitoring them. Note: Applications Manager cannot perform multiple regex checks. The file present in a remote Windows server cannot be monitored by using the Applications Manager which is installed in the Linux OS. The severity of the monitor will be affected based on the order of the criteria configured. The content match will be not proceeded to next criteria when the match is found. When the content match is configured with Availability as DOWN or Health as CRITICAL / WARNING for Primary Severity, and if the content match is not found, then the alert will be triggered for Monitor Severity Availability as UP and Health as CLEAR respectively. Similarly when the content match is configured for Availability as UP or Health as CLEAR for Primary Severity, and if the content match is not found, then the alert will be triggered for Monitor Severity Availability as DOWN and Health as CRITICAL respectively. If the user wishes to retain previous severity with Availability as UP or Health as CLEAR, then ''Clear monitor status when the file is not modified'' option can be chosen. Limitations for ''Check Content'' String: For Windows file, double quotes (") will be not be supported . For Non-Windows file, double quotes(") needs to be prepended with backslash as (\"). Monitored Parameters Applications Manager uses this File / Directory Monitor to monitor the changes in the selected files and directories. Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configuration. Click on the individual monitors listed, to view the following information. File Monitor Parameter Description File size The size of the file. (KB) Change in File Size The amount of change in file size. (KB) % Change in File Size The amount of change in file size. (%)File Modified Duration The modified time duration of the file. (Minutes) Last Modified Time The time at which the file was last modified. Contents Matched Displays the matched contents. Directory Monitor Parameter Description Directory Size The size of the directory. (MB) Change in Directory Size The amount of change in directory size. (MB) % Change in Directory Size The amount of change in directory size. (%) Directory Modified Duration The modified time duration of the directory. (Minutes) Total No. of Subdirectories The subdirectory count of a directory. Total No. of Files The total number of files available in the directory. Total No. of Files (in Main Folder) The total number of files available under the main folder in the directory. Directory Modified Duration Amount of time elapsed since the directory was last modified (in minutes). View Filtered Files Displays the list of files that are filtered in the directory. Last Modified Time The time at which the directory was last modified. Configuring RCA Message for File Monitor The Root Cause Analysis message of the File monitor can be configured by navigating to Admin -> Performance Polling -> Optimize Data Collection -> File / Directory Monitor. There are 3 different options available: Content match File link: This is the default option in which the contents that have been matched will be shown in the RCA message along with the link to the HTML file that contains line number and lines in which content was matched. Last Matched Lines: The last matched lines for the configured content will be added to the RCA message along with the default content file match link. All matched content: All the matched content is appended on to the RCA file along with the default content file match link. Note: All matched content option is only available for files hosted on linux servers and the last matched line is appended for files hosted on windows servers. Database Query Monitoring Overview Database Query Monitor is used to monitor a single query or a set of queries for any given database. This SQL- based query monitor allows user to monitor the status of that particular query. Creating a new Database Query monitor Using the REST API to add a new DB Query Monitor: Click here To create a new Database Query Monitor, follow the below given steps: Click New Monitor and select Add New Monitor. Choose Database Query Monitor. Enter the Display Name of the Monitor. Select the Database for which the query is being executed. The Database Query monitor currently supports queries of the following databases - DB2, Informix, Ingres, MS SQL, MySQL, Oracle, Oracle RAC, Postgres, Sybase, DB2 for i, SAP HANA (on-premise) and SAP Max DB. The DB2 for i database will be shown only for trail users and the Users with AS400 Add-on. Enter the Host Type of the Monitor on which the database is running - New or Existing (You can select the an existing host from a drop-down list). Enter the Hostname or IP Address of the host. Enter the Port number in which the database is running.Select the Enable Kerberos Authentication checkbox if you want to monitor MS SQL database through Kerberos authentication. Enter the Username and Password of the database server. Enter the Database name. If you want to connect using a Named Instance, enable the Connect using Named Instance checkbox and specify the instance name for MS SQL database. Check the SSL is enabled checkbox if SSL authentication is enabled for MySQL, MS SQL, Oracle and PostgreSQL databases. Choose jTDS JDBC Driver or Microsoft JDBC Driver option in Driver for SQL Server Connection field to choose the required driver for connecting to the MS SQL database for data collection. Enter the Query. Please note that the number of queries is limited to five queries. Also, note that the delimiter for a query is new line. Select whether you would prefer Query Output by choosing the Yes or No radio button. If a table row is unavailable in the next poll, you can configure appropriate table row actions (Retain, Delete or Unmanage) by enabling the Manage Table Row option. Enter the Polling Interval. By default, it is 5 minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Database Query monitor. Limitation: From the Enterprise Edition Admin Server, only the following database types are supported for Database Query Monitoring - MySQL, Oracle, DB2, MsSQL, Sybase, PostgreSQL, SAP HANA and SAP MaxDB. Enable Configure Alarms Template for Database Query Monitor You can enable a link to Configure Alarms (link will appear on the right top corner of each table in your Database Query Monitor page). Using the link, the user can set Predefined Thresholds for any attributes in the table. Here is how you can enable Configure Alarms Template for Database Query Monitor: Go to the Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, click on the Optimize Data Collection tab. Choose Script / Database Query Monitor from the drop-down menu. Check the Enable Configure Alarm Template for Script Monitor and Database Query Monitor option. The Configure Alarm link will appear on the right top corner of each table in your Database Query Monitor page. Monitored Parameters Database Query Monitor is used to monitor a single or a specific set of queries for any given database. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Using a single query or a given set of queries, you can monitor the status of any given database using Applications Manager Database Query monitor. Queries are the best way to find out whether your database is up and running 24x7. In business enterprises such as an online store, there are a number of applications and databases used for e- commerce. Any interruption in such an environment could mean only one thing: loss of revenue. The execution of such a query or a set of queries can be automated by setting the polling interval. By fixing the polling interval, user can automate this process and the results are obtained at the end of the polling. The result includes execution time (time taken by the query to provide results) and also displays any error that may occur during regular polling intervals. These errors help identify any issue that may occur with the database. Let us consider an example. Many enterprise environment run critical applications which need to be up and running 24x7. Let us assume, the status of such applications are maintained in a "APPLICATION_STATUS" table. Using Database Query monitor, the user shall be able to send a select set of queries to that database to find out if they are operational or not. |-----------------------------------------------------------| | APPLICATIONS_STATUS                      | |-----------------------------------------------------------| | APPLICATIONS_NAME   | Status         ||-----------------------------------------------------------| | PURCHASE                    | OK             | | CRM                                | CRITICAL    | | PAYROLL                        | OK             | | LEADS                            | OK             | |-----------------------------------------------------------| SELECT * APPLICATIONS_STATUS By executing the above command using Database Query monitor, the user will then obtain the list of applications that are running along with its status. The user can then identify the applications whose status is ''Critical'' and then carry out necessary action by configuring Alarms in Applications Manager. This action could be in the form of creating a ticket, or executing a script to rectify the problem. Database Query monitor can also be used to identify any bottle necks in the networks which are linked to several databases and help remove them by identifying the correct database which has the issue. This bottle neck issue can arise because there is a problem with the one of applications or with the databases. Using Database Query monitor, user can then execute a given set of queries and analyze the result which provides a clear indication of the error that has caused such an occurance. The result includes the execution time (time taken by the query to generate the result). If the execution time is above a certain pre-assigned threshold, then the issue is with the database or if the result is below the pre-assigned threshold, then the issue is elswhere. Supported Databases The Database Query monitor currently supports queries of the following databases: DB2 Informix Ingres MS SQL MySQL Oracle Oracle RAC Postgres Sybase SAP HANA SAP MaxDB DB2 for I SAP MaxDB SAP HANA Applications Manager also provides the ability to compare various column value in the output by attributes types. Option to Enable or Disable Reports is provided. Note: Please note that the number of queries is limited to five queries. Total number of rows shown in the output is limited to 50 rows. Here is a list of the compatible JDBC URLs for Oracle database type under Database query monitor: jdbc:oracle:thin:@HOSTNAME:PORTNUMBER:INSTANCE jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=HOSTNAME) (PORT=PORTNUMBER)))(CONNECT_DATA=(SID=INSTANCE)(SERVER=DEDICATED))) jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=HOSTNAME)(PORT=PORTNUMBER)) (CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=INSTANCE))) jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=yes)(ADDRESS=(PROTOCOL=TCP)(HOST=NODE1-VIP) (PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=NODE2-VIP)(PORT=1521))(CONNECT_DATA= (SERVER=DEDICATED)(SERVICE_NAME=MYRAC)))Support for Stored Procedures in Database Query Monitor We have added support for Stored Procedures for all databases that we support in Database Query Monitor. We support Stored Procedures which returns only one Result Set. To Enable Stored Procedures, go to Admin → Performance Polling → Optimize Data Collection → Script / Database Query Monitor and select Enable Stored Procedure Monitoring for Database Query Monitor. FAQs and Troubleshooting 1. How can I form an SQL Query? The query should be in a single line and maximum of 2000 characters. Please note that the number of queries is limited to five queries in one monitor. Also, note that the delimiter for query is new line. Total number of rows shown in the output is limited to 50 rows. If there is more than one column in the results, we recommend that you set a column which has string values as primary key in the monitor. The query should have an identifier. For queries involving counts we recommend you have a dummy column and use that as primary key. Let''s take the example below: Select ''count'' as value, count(*) as alert_count from alert; In the above query, we the identifier is alert_count and a dummy primary column is set called value. Whenever this query is executed during the polling we store the actual count values based on the primary key selection. In this case, the primary key is alert_count. You can configure an alarm for the count attribute and then define a threshold value. For reference: https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/ef/language- reference/identifiers-entity-sql 2. How can I form SQL Queries when using Aggregate functions like count, min, max etc? The query should be in a single line and maximum of 2000 characters. Please note that the number of queries is limited to five queries in one monitor. Also, note that the delimiter for query is new line. Total number of rows shown in the output is limited to 50 rows. If there are more than one columns in the results, we recommend to have set a column which has string values as primary key in the monitor. For queries involving counts we recommend to have a dummy column and use that as primary key. Lets take for example some pending tasks for your application is stored in app_pending_tasks table and you want to monitor the number of pending tasks for the application. Typically we will form the query as given below: select count(*) from app_pending_tasks The problem with the above query is it doesn''t have an identifier. Instead you can form the query as given below. For MySQL, Oracle, Sybase: --------------------------------- select ''Number of Pending Tasks'', count(*) as totalcount from app_pending_tasks Make the ''Number of Pending Tasks'' the primary column. For MS SQL, PostgreSQL, Db2: --------------------------------- select ''Number of Pending Tasks'' as NumberOfPendingTasks, count(*) as totalcount from app_pending_tasks Make the ''Number of Pending Tasks'' the primary column. Now you can generate alarms by assigning thresholds and generate reports for ''totalcount''. Note: After adding Database Query Monitor, the user should select the primary key for every table and update it.Script Monitors Script Monitor - An Overview Creating a new Script Monitor Sample Input Sample Output Monitored Parameters Examples: Sample Scalar Usecase Sample Table Usecase Other: Overriding Availability and Response Time of the Script Monitoring SNMP OIDs Rest API for getting the remote hostname for Script monitor Custom Monitor Types Script Monitor - An Overview Custom script monitoring can be a tedious task if the output of the scripts that are run, are to be monitored manually. Applications Manager provides with script monitoring functionality to ease the process by automatically monitoring the output of in-house custom scripts (Windows/Linux) and by creating alarms as per the configuration. Script monitor allows you to monitor the script that is present in the local system or in the remote system, transfers the output to an Output File, parses the output and executes the actions configured. Applications Manager provides Script Monitoring functionality to automatically monitor the output of ad-hoc Windows/Linux/Solaris scripts that are used in-house. During creation of a new script monitor, you must give the location of the custom script (local / remote), attributes (numeric/string) to be monitored, the Output File in which the output is going to be redirected and the polling interval. Based on the polling interval, Applications Manager executes the script. The script will transfer its output to the Output File configured. The output of the script should be in a Key=Value format where ''='' can be any delimiter. Applications Manager parses the Output File and executes the actions configured. It enables you to alert an Administrator or automatically take corrective actions by way executing other OS scripts. Reports for the attributes configured would be shown as graphs. Option to enable or disable reports is given. Creating a new Script Monitor Using the REST API to add a new Script monitor: Click here To add a Script Monitor, follow the given steps: Click New Monitor. Choose Script Monitorstrong> Enter the Display Name of the Monitor. Specify if the script to be monitored is present in the Local Server or in a Remote Server. If it is Local Server, Give the absolute path of the Script to be Monitored and also the absolute path of the directory from which the script should be executed. The execution directory should in the same hierarchy of the ''script to be monitored'' directory structure. Select the script location as command or script / batch file. Specify the absolute path of the script / command to be monitored. Specify the absolute path of the execution directory from which the script should be executed.. The execution directory should in the same hierarchy of the script to be monitored directory structure. Check the Output Settings checkbox, to configure output settings Check the Get output from file checkbox and specify the path of the file. If the checkbox is not checked, Applications Manager takes the output from the output stream. Enter the String and Numeric attributes (one attribute per line).Enter the value of Delimiter used in the output file. By default, it is "=". If you don''t specify a delimiter, then ''space'' would be considered as a delimiter. If you want to monitor a tabular Output file, enter the details of the tables - Name, String and Numeric column attributes, delimiter and also specify which attribute is the Unique Column. Inorder to identify a tabular output file, execute the following commands before and after the actual script. echo <--table starts-->  [Script Commands] echo <--table ends-->  This would enable Applications Manager to identify the Output File''s table. Even if you''re using a command instead of a script as input, then the output of the command should be in the above format. It is also mandatory to have the headers and footer in the command output as the first line in the file.  If a table row is unavailable in the next poll, you can configure appropriate table row actions (Retain, Delete or Unmanage) by enabling the Manage Table Row option. If no table rows are available in the output file, you can configure appropriate health severity (Critical, Warning, or Clear) by enabling the Manage Table Data option. Enable the ''Affect health when exception occurs'' option if you want to configure health severity based on exceptions occurred in the scripts. Note: This option can be configured by enabling under Admin → Performance Polling → Optimize Data Collection → Script/Database Query Monitors. Specify the Arguments. For e.g., hostname 80 http Set the Polling Interval. By default, it is 5 minutes Specify the Timeout value in seconds. The value can be the maximum time taken by the script to execute. In Linux, Specify the mode in which script should be executed. By default, it is "sh". If the script is in a remote server, select the Host Name from the list If the remote server is a new host, then enter the server''s Host Name / IP Address. Choose the Mode of Monitoring - Telnet, SSH or Powershell. Enter the User Name and Password of the server. Enter the Port number - Default Telnet port no: 23, SSH: 22 Specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. Upon adding the script monitor, you can view the details of the newly added Script Monitor Note: Remote Windows script monitoring is supported only in Powershell mode of monitoring. Script/Command to monitor should not contain whitespace(s) for Powershell mode of monitoring. Output file is mandatory when ''Output Settings'' option is enabled for Powershell mode of monitoring. Enable Configure Alarms Template for Script Monitor You can enable a link to Configure Alarms (link will appear on the right top corner of each table in your Script Monitor page). Using the link, the user can set Predefined Thresholds for any attributes in the table. Here is how you can enable Configure Alarms Template for Script Monitor: Go to the Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, click on the Optimize Data Collection tab. Choose Script / Database Query Monitor from the drop-down menu. Check the Enable Configure Alarm Template for Script Monitor and Database Query Monitor option. The Configure Alarm link will appear on the right top corner of each table in your Script Monitor page. Tips If you choose the Script Location as command: Command Length must not exceed 255 characters. Linux commands must not contain backslash (\) Here is an example. If you choose the Command type of script:Here is an example. If you choose the Script Location as script: Any Script in a Local Windows server will be executed as,    cmd /C [ScriptName]  [Arguments] Example: cmd /C D:\testScript.bat hostname username password. To execute a VBS, Powershell or any script that is not a batch file: The script should write the output to command prompt or file. You can also execute files by embedding them inside a Batch script and using the Batch script for monitoring. Here are some examples. You can use them directly by selecting "Command", without using another batch file:           C:\windows\system32\cscript.exe D:\testFile.vbs hostname username > outputfile.txt Arguments can be used in the script. Local & Remote Non-Windows Script Monitoring: Provide proper "Shell Type" for executing the scripts. By default "sh" is used. You can execute script directly as "Command": sh ./test.sh Note: The user must have permission to execute the script and read/write permission for Output file. Example Command Command: netstat -an | grep "CLOSE_WAIT" | wc -l | awk ''{print "CLOSE_WAIT=" $1}'' Example Scripts To Execute VBS files: To execute testFile.vbs, embed it inside a batch script testScript.bat Contents of testScript.bat file: c:\windows\system32\cscript.exe D:\testFile.vbs  > outputFile.txt Add testScript.bat for monitoring and use outputFile.txt to get Output. To Execute a Powershell file: To execute test.ps1, embed it inside a batch script testScript.bat Content of test.bat:PowerShell.exe -NoProfile -ExecutionPolicy Bypass -Command Add test.bat file for monitoring and use outputFile.txt to get Output. Note:  PowerShell script must be executed with -NoProfile -ExecutionPolicy Bypass  Need to add "-encoding ascii" for output files created via powershell. Sample Input To monitor a script interfacestatus.bat that creates a user defined table called InterfaceStats and user defined parameters like DiskStatus, DiskErrors and No. ofProcess, in the output file interfacestatusoutput.txt In the Script Monitor creation form, give the absolute path of the script : c:\interfacestatus.bat Under Output settings, give the absolute path of Output file: c:\interfacestatusoutput.txt Give DiskStatus as the string attribute, No.ofProcess and DiskErrors are the numeric attributes with Delimiter "=" If you want to monitor statistics in a table format , select Tables in output file. Here, we have the table InterfaceStats with the stats Name, IP, Status, In, Out where Name, IP, Status are string attributes; In & Out are numeric attributes. TheDelimiter is the separater between the two column names -> space. If tab is the delimiter, then give \t . Usually tab will be the delimiter for sql queries results. Note: The starting tag of the table, InterfaceStats is "<--table InterfaceStats starts-->" and the end tag is "<-- table InterfaceStats ends-->". Also, the first line of the table should contain the attribute names. The attribute names or the column names should also be separated by the same delimiter used to separate the data rows and that is specified as the column delimiter. In this case, they are Name, IP, Status, In and out. The remaining lines between the start and end tag should comprise of the actual data. Make sure that the delimiter for the table is unique and you should specify that as the column delimiter.Unique Column is the attribute that doesn''t repeat itself in the rows and identify the row by that value. Here it is IP. Sample Output DiskStatus=Up No.ofProcess=1 DiskErrors=0 <--table InterfaceStats starts-->  Name IP In Out eth0 192.168.1.1 123451 234567 eth1 192.168.1.2 345633 453267 <--table InterfaceStats ends--> Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Script Monitor under the Custom Monitors Table. Displayed is the Script Monitor bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Overriding Availability and Response Time of the Script This option would be useful, if you want to override the response time measured for custom scripts using a defined value in the output file. Applications Manager looks for few reserved keywords in the output file, if it matches then it will replace the corresponding attribute. For eg., if the script output looks like this, script_availability=1 (Allowed values are 0 or 1. "0" refers to success. "1" refers to failure.) script_message=Server is not running. script_responsetime=10 Then, while parsing the output file, script_availability value will be taken and based on that the availability is calculated.The same is the case for response time. Examples: Sample Scalar Usecase Let''s assume you want to monitor a script < filesystem.sh> present under /home/test-solaris/ in test-solaris machine. The output from this script is dumped to output.txtfile present under the same directory. The format of output.txt is as shown below : SystemTemperature=37  TimeSinceLastReboot=30  TopPaginApp=sendmail IOReads=1050 Setting up Script Monitor: Login to the Applications Manager Web Client. Click New Monitor. From the combo box, choose Script Monitor. For the Display Name give some name. For e.g FileSystem Choose whether the script to be monitored is present in the Local Server or in a Remote Server. If the script is in a Remote Server, then make sure you put the script in the Remote Server. If it is Local Server/ Remote Server, give the absolute path of the Script to Monitor (/home/test- solaris/filesystem.sh) and also the absolute path of the directory from which the script should be executed(/home/test-solaris/). Under Output Settings, give the Output file name (/home/test-solaris/output.txt) with absolute path. This is the file where the output from the script is dumped. Enter the Name of the Non Numeric and Numeric attributes.In the Numeric area, add SystemTemperature TimeSinceLastReboot IOReads In the String Attributes Text area, add : TopPaginApp Enter the value of Delimiter (=) used in the output file. By default, it is "=". If you don''t specify a delimiter, then ''space'' would be considered as a delimiter. Specify the additional Arguments (if required to pass to the script). For e.g., hostname 80 http Set the Polling Interval. By default, it is 5 minutes Specify the Timeout value in seconds. The value can be the maximum time taken by the script to execute. In Linux, Specify the mode in which script should be executed. By default, it is "sh". If the script is in a Remote Server, select the Host Name from the list If the remote server is a new host choose New Host, then enter the server''s Host Name / IP Address (test- solaris). Choose the mode of monitoring - Telnet, SSH, or Powershell. (Telnet) Enter the User Name(test) and Password(test) of the server. Enter the Port number - Default Telnet port no: 23, SSH: 22 Specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. Once all the values are entered, click Add Monitor(s). The success message should be displayed. Click Monitor Details > Script Monitor and go to the create script, to view the details. Note: Applications Manager uses either ANSI or UTF-8 encoding. Hence it is advised that you use the same format while writing output to the file. Sample Table Usecase Let''s assume you want to monitor a script   present under /home/test-solaris/ in test-solaris machine. The output from this script is dumped to output.txt file present under the same directory. The format of output.txt is as shown below <--table prustat starts--> PID CPU Mem Disk Net COMM 7176 0.88 0.70 0.00 0.00 dtrace 7141 0.00 0.43 0.00 0.00 sshd 7144 0.11 0.24 0.00 0.00 sshd 3 0.34 0.00 0.00 0.00 fsflush 7153 0.03 0.19 0.00 0.00 bash 99 0.00 0.22 0.00 0.00 nscd 7146 0.00 0.19 0.00 0.00 bash 52 0.00 0.17 0.00 0.00 vxconfigd 7175 0.07 0.09 0.00 0.00 sh 98 0.00 0.16 0.00 0.00 kcfd <--table prustat ends--> Note: the table headers <--table prustat starts-->. This is mandatory and should follow the same format as mentioned. Here "prustat" should be replaced by the Table Name explained below Setting up Script Monitor Follow the same instructions as mentioned for Scalar till point 6 Select Tables in output file check box For the Table Name provide some name(prustat). Note that this same should be present in the table header(<-- table prustat starts-->) in the output file. For the Numeric Attributes area provide the column names in the script output that are numeric: CPU, Mem, Disk, Net For the String Attributes provide the column names in the script output that are non numeric: PID, COMM For the Unique Column provide the column names that can identify a row data. This can be a single value or multiple value: PID, COMMFor the Column Delimiter provide the column separator. The default value is a space. In case you have scripts that output multiple tables then you can select More and configure the values. Once all the values are entered, click Add Monitor(s). You can use script monitor to monitor the SNMP OIDs Please look at the steps below for creating a script monitor, Create a script file ( say script.sh ) under the /opt/ManageEngine/AppManager_Home/ directory Edit that file and type in the following content into that file,  snmpwalk -v 1 -c public app-w2k1 CPQHLTH-MIB::cpqHeFltTolPowerSupplyRedundant.0.1| awk ''{ y = $1; x = $4 ; gsub(/[a-zA-Z()]/, "", x)} {print y " = " x}''>> output.txt  snmpwalk -v 1 -c public app-w2k1 CPQHLTH-MIB::cpqHeFltTolPowerSupplyRedundant.0.2 | awk ''{ y = $1; x = $4 ; gsub(/[a-zA-Z()]/, "", x)} {print y " = " x}'' >> output.txt Click on "New Monitor" in applications manager and choose script monitor. Then create a new monitor using the following parameters, Script to Monitor    Directory from which the script should be executed   Under Output Settings, Output File    Numeric Attributes   Use the default parameters for configuring the remaining attributes. Note: If an attribute does not have any data, the script returns ''N.D'', where ''N.D'' means No Data. REST API to get the HostName This API gives host name for the given Script Monitor. Syntax http://[Host]:[Port]/AppManager/json/GetRemoteHost?apikey=[APIKEY]&resourceid=[RESOURCEID] Request Parameters The parameters involved in executing this API request are: Field Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. resourceid The resource id of the monitor that needs to be polled. Sample Request http://app-windows:9090/AppManager/json/GetRemoteHost? apikey=095cb3835ff015b01a3b3a6c4ab2c38a&resourceid=10000293 Sample Response {"response":{"result":[{"hostname":"app-w7-64-8"}],"uri":"/AppManager/json/GetRemoteHost"},"response- code":"4000"} Custom Monitor Types Custom Monitor Types in Applications Manager allow you to associate a monitor type to the inhouse scripts, for monitoring your own applications. You can define your own monitor types apart from the monitor types that are available by default. Know more. Windows Performance Counters To create windows performance counters in Applications Manager, follow the steps given below:Select New Monitor. Choose Windows Performance Counters. Provide Name for Windows Performance Counter. Enter the Description for the counter. Enter the Polling Interval for the counter. If you are adding a new monitor from an Admin Server, select a Managed Server. Select the Host Name from the combo box or you can create a new host (by giving the new host name / IP address, username and password of the host) Note: Windows Performance Counters is currently supported for Windows Vista, Windows 7, Windows 8, Windows Server 2000, 2003, 2008 and 2012. Applications Manager uses WMI (Windows Management Instrumentation) for monitoring Windows Performance Counters. WMI gives preinstalled performance counter classes; each class describes an object in performance libraries. For eg., the object that appears in the Perfmon System Monitor named NetworkInterface is represented in WMI by the Win32_PerfRawData_Tcpip_NetworkInterface class for raw data  Win32_PerfFormattedData_Tcpip_NetworkInterface class for pre-calculated, or "cooked" data. Currently Applications Manager supports monitoring the counters of classes derived from Win32_PerfFormattedData Some of the WMI Performance classes for Performance Objects that are present in Perfmon are  Processor -Win32_PerfFormattedData_PerfOS_Processor  Browser -Win32_PerfFormattedData_PerfNet_Browser  PagingFile -Win32_PerfFormattedData_PerfOS_PagingFile  Memory -Win32_PerfFormattedData_PerfOS_Memory  Server -Win32_PerfFormattedData_PerfNet_Server Some classes can only have one instance of it, they are called "Singleton Classes". After creating Windows Performance Counters, You will see the WMI Monitor details page showing availability and other details.Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information. The windows performance counter values can be added and monitored as attribues. The overall ability to configure thresholds on attributes and taking corrective actions are supported out-of-the-box. Adding Attributes Click on Add Attributes link. This will take you to the list of WMI Performance Classes. You can choose the classes whose attributes you want to monitor. Click on Show Attributes; the list of WMI classes selected along with their attributes and instances are displayed. Select the attributes and instances. The attributes would then be added for monitoring. You can configure thresholds and alarms for the attributes. At a class level, you can configure alarms for Health, which inturn depends on the attributes it comprises of.  Note: Windows Performance Counters is currently supported for Windows Vista, Windows 7, Windows 8, Windows Server 2000, 2003, 2008 and 2012.. Database Servers Applications Manager provides Database Server monitoring that monitors system resources. It also provides proactive measures by notifying database and system administrators about potential problems that could compromise database performance. This database server monitoring has the ability to connect to the database source, process any query received in the database, monitor various system table column values, collect data, etc. and also notify through alarms, if the database system properties are beyond a given threshold. The different database servers supported are: MySQL Database ServersOracle Database Servers MS SQL Database Servers IBM DB2 Database Servers IBM Informix Database SAP HANA Database Servers Sybase Database Servers PostgreSQL Database Servers Database Query Monitor Apache HBase Database Servers NoSQL Database Servers Cassandra Database Servers CouchBase Database Servers MongoDB Database Servers Redis Database Servers Memcached Database Servers Oracle NoSQL Database Servers Please browse through the different database servers that provide server information and their parameters being monitored. For all databases, data collection happens by establishing a JDBC connection and executing queries to collect the data. SQL Anywhere Monitoring User Guide To ensure peak health and performance, SQL Anywhere monitoring tools that are perceptive and sensitive to errors are employed by businesses. Applications Manager''s SQL Anywhere monitor is one such tool which can help you monitor and maintain your databases and IT environments with minimal manual intervention. Adding a SQL Anywhere monitor Follow the steps given below to create a new SQL Anywhere monitor: Click on New Monitor link. Select SQL Anywhere under Database Servers category. Specify the Display Name of the SQL Anywhere Server. Enter the Hostname of the server on which SQL Anywhere is running.   Specify the Port at which SQL Anywhere is running. The Default Port is 2638. If you choose the Use Below Credentials option, then enter the credentials - UserName and Password of the SQL Anywhere Instance. UserName - Name of the User who has read permission.   Password - Password of the above user.If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the SQL Anywhere to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the SQL Anywhere from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on SQL Anywhere under the Database Servers table. Displayed is the SQL Anywhere bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the SQL Anywhere monitor dashboard. It has 4 tabs- Overview Databases Connections Configurations Overview Parameter Description CONNECTION STATISTICS   Total Connection Count  Total number of connections made to the SQL Anywhere server. HTTP Connections  Number of HTTP connections made to the SQL Anywhere server. HTTPS Connections  Number of HTTPS connections made to the SQL Anywhere server. SESSION ACTIVITY   Active HTTP Requests  Number of active HTTP requests. Active HTTPS Requests  Number of active HTTPS requests. Unscheduled Requests  Number of unscheduled requests. Active Sessions  Total number of active sessions. CACHE USAGE   Current Cache Size  Size of the cache memory currently used in KB. Max Cache Size  The maximum allowed cache size in KB. Peak Cache Size  The largest value the cache has reached in the current session in KB. CACHE STATISTICS   Cache Dirty  Number of cache pages that are dirty i.e. that needs to be written. Cache Pinned  Number of pinned cache pages. Cache Replacements  Number of pages in the cache that have been replaced. Main Heap Pages  Number of pages used for global server data structures. Databases Parameter Description Databases   Name  Name of the database. Total Size(MB)  Total size of the database in MB. Used(MB)  Size of the used database memory in MB. Free(MB)  Size of the free database memory in MB. Used(%)  Size of the used database memory in %.Disk Reads/Min  Number of disk reads in a minute. Disk Writes/Min  Number of disk writes in a minute. Connection Count  Number of connections made to the database. Locks Count  Number of locks held on the database. Database Details  Click one of the database names in the Databases table to view database details. Dbspace and File Details   Dbspace Name  Name of the dbspace. File Name  Name of the file inside the dbspace. Total Disk Size(MB)  Total size of the disk for dbspace in MB. Disk Free(MB)  Free disk space for dbspace in MB. Disk Free(%)  Free disk space for dbspace in %. Total File Size(MB)  Total size of the file in MB. File Used(MB)  Total size of the file used in MB. File Free(MB)  Total size of the file which is free in MB. File Used(%)  Size of the used file in %. DB Mirroring Details   Name  Name of the database. Mirror Mode  Mode of mirroring. Mirror State  Status of the mirrored database—whether it is synchronized or not. Partner State  Status of the partner server—whether it is connected or not. Arbiter State  Status of the arbiter server—whether it is connected or not. Connections Parameter Description DB Connections   DB Name  Name of the database. Connection ID  Unique ID number of the connection.  Connection Name  Name of the connection. Connection Host  Name of the host. User  Name of the user. Communication Link     Type of communication link. Last Request Type     Type of request that was previously processed. Blocked On    Connection ID of the user who blocked the database. Configurations Parameter Description CONFIGURATION PROPERTIES   Sybase Version  Version of the SQL Anywhere server used. Server Name  Name of the SQL Anywhere server used. Server Language  Language used in the SQL Anywhere server. Start up time  Time at which the server started running. License Seats  Number of license seats or processors. License Type  Type of license. Licensed Company  Name of the licensed company. Licensed User  Name of the licensed user. Network Server  Whether the added SQL Anywhere server is a network server or not.Neo4j Monitoring User Guide Neo4j, one of the most popular databases, is a graph database management system which is ACID-compliant. As with any database, Neo4j is also a core component in any system and requires constant monitoring. Tracking memory management, garbage collection, and also aspects of Neo4j such as growth of your store, active transactions, and many other operational facets is important to understand the relationship between Neo4j and other elements in your IT environment. Applications Manager''s Neo4j monitoring tool provides valuable insights into key Neo4j metrics, and notifies of areas that need attention, enabling you to optimize performance of Neo4j servers. Adding a Neo4j monitor: Follow the steps given below to create a new Neo4j monitor: Click on New Monitor link.Select Neo4j under Database Servers category. Specify the Display Name of the Neo4j Server. Enter the Hostname of the server on which Neo4j is running.   Specify the bolt Port at which Neo4j is running. The Default Port is 7687. If you choose the Use Below Credentials option, then enter the credentials - UserName and Password of the Neo4j Instance. UserName - Name of the User who has read permission.   Password - Password of the above user. If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Choose whether you want to Discover all nodes in the cluster. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Neo4j to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Neo4j from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Neo4j under the Database Servers table. Displayed is the Neo4j bulk configuration view distributed into three tabs: Infrastructure View tab, gives the details about all Neo4j instances present in the Infrastructure.  Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Neo4j monitor dashboard. It has 9 tabs- Overview Thread Heap Details ID Allocation Store Transactions Page Cache Clustering Configurations Overview Parameter Description PHYSICAL AND VIRTUAL MEMORY Total Physical  Size of the total physical memory of the machine in GB. Used Physical  Size of the total physical memory used in GB.Free Physical  Size of the total physical memory free in GB. Committed Virtual  Size of the total virtual memory committed. SWAP MEMORY Total Swap Space  Size of the total swap space of the machine in GB. Free Swap Space  Size of the total swap space free in GB. Used Swap Space  Size of the total swap space used in GB. NODE DETAILS Name  Name of the node. Role in cluster  Role of the node in cluster.  Read Only Instance  Shows whether it''s read only instance- TRUE/FALSE.  MEMORY UTILIZATION Physical Memory Utilization  Total physical memory usage calculated and represented in %. Swap Space Utilization  Total swap space usage calculated and represented in %. Thread Parameter Description THREAD DETAILS Daemon  Number of Daemon Threads. Peak  Number of Peak Threads. Live  Number of Live Threads. Total Started  Number of total threads started. Heap Details Parameter Description HEAP MEMORY DETAIL Committed Heap  Size of Heap memory committed in GB. Initial Heap  Size of initial Heap memory in GB. Maximum Heap   Size of maximum Heap memory in GB. Used Heap  Size of Heap memory used in GB. NON HEAP MEMORY DETAIL Committed Non Heap  Size of Non Heap memory committed in GB. Initial Non Heap  Size of initial Non Heap memory in GB. Maximum Non Heap  Size of maximum Non Heap memory in GB. Used Non Heap  Size of Non Heap memory used in GB. ID Allocation Parameter Description ID ALLOCATION Node Ids   An estimation of the number of nodes used in this Neo4j instance. Property   An estimation of the number of properties used in this Neo4j instance Relationship  An estimation of the number of relationships used in this Neo4j instanceRelationship Type   The number of relationship types used in this Neo4j instance Store Parameter Description STORE SIZES Total   Disk space used by whole store, in KB. Labels   Disk space used to store labels, in KB. Nodes   Disk space used to store nodes, in KB. Transaction Log   Disk space used by the transaction logs, in KB. Relationships   Disk space used to store relationships, in KB. Indices   Disk space used to store all indices, in KB. Counters   Disk space used to store counters, in KB.  PROPERTY SIZES Schemas   Disk space used to store schemas (index and constrain declarations), in KB. Properties   Disk space used to store properties (excluding string values and array values), in KB. String Properties   Disk space used to store string properties, in KB. Array Properties  Disk space used to store array properties, in KB. Page Cache Parameter Description PAGE CACHE COUNT DETAILS Hit Ratio   Ratio of hits to the total number of lookups in the page cache Hits   Number of page hits. How often requested data was found in memory. Exception while Page  Number of exceptions caught during page eviction.  Eviction   Number of page evictions. How many pages have been removed from memory to Evictions  make room for other pages.   Number of page faults. How often requested data was not found in memory and had Faults  to be loaded. Flushes   Number of page flushes. How many dirty pages have been written to durable storage. Usage Ratio   The percentage of used pages. PAGE CACHE SIZE DETAILS Read    Number of bytes read from durable storage.  Write   Number of bytes written to durable storage. Files Mapped   Number of files that have been mapped into the page cache. Files UnMapped  Number of files that have been unmapped from the page cache. Pins   Number of page pins. How many pages have been accessed.  Number of page unpins. How many pages have been accessed and are not accessed UnPins  anymore. Transactions Parameter Description TRANSACTION DETAILSCommitted   The total number of committed transactions. Started   The total number started transactions. Open   The number of currently open transactions. Rollbacked   The total number of rolled back transactions. Peak  The highest number of transactions ever opened concurrently. Concurrent  DEADLOCK Averted  The number of lock sequences that would have lead to a deadlock situation that Neo4j has Deadlocks detected and averted (by throwing DeadlockDetectedException). Clustering Parameter Description CLUSTERING DETAILS Raft Log  Total amount of disk space used by the raft log, in KB. Replicated State  Total amount of disk space used by the replicated states, in KB. Configurations Parameter Description CONFIGURATIONS DETAILS Mounted Database  The name of the mounted database. Name   Start Time  The time from which this Neo4j instance was in operational mode. Version   The version of Neo4j. Store Creation Time   The time when this Neo4j graph store was created.  An identifier that, together with store creation time, uniquely identifies this Neo4j Store Id  graph store.     MySQL Database / MariaDB Monitoring Note: In the MySQL database (that you are trying to monitor), ensure that the user name assigned to Applications Manager has the permission to access the MySQL database from the host where Applications Manager is running. Else, give a relevant user who has the privileges to do the same. Creating a new MySQL monitor Minimum User Privileges : The user should have privileges to execute SELECT, SHOW DATABASES, REPLICATION commands in the MySQL server. Also, Applications Manager machine should be allowed to access the MySQL database server. For enabling the privileges, execute the below commands in the remote MySQL Server INSERT INTO user (Host,User) VALUES('' '','' ''); GRANT SELECT,SHOW DATABASES,REPLICATION CLIENT ON *.* TO '' ''@'' ''; FLUSH PRIVILEGES; (Host -> Applications Manager machine) Prerequisites for monitoring MySQL DB metrics: Click here Using the REST API to add a new MySQL DB monitor: Click hereTo create a MySQL database server Monitor, follow the steps given below: Click on New Monitor link. Select MySQL DB Server. Enter the IP Address or hostname of the host. Enter the Subnet Mask of the network. Check the ''Force SSL'' box to force an SSL connection. Enter the port number in which MySQL is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the user name and password of user who has permission to access the MySQL database. Specify the database name. Please note that the Database name must be valid. Also, the database name is associated with the user name. Hence, provide the database name corresponding to the user name given in the above field. Choose the Monitor Group from the combo box with which you want to associate MySQL database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers MySQL database server from the network and starts monitoring them. Troubleshoot: Having trouble in monitoring MySQL database server? Refer to the online troubleshooting section. Supported Versions MySQL 3.23.x MySQL 4.x, 4.1.x MySQL 5.x, 5.1.x, 5.5.x, 5.6.x, 5.7.x MySQL 8.x All Versions of MariaDB Monitored Parameters Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. To view detailed performance metrics of a MySQL server, click the corresponding monitor listed in the Availability tab. These metrics are categorized into six different tabs for better understanding. Overview Database Replication Performance Session Configuration Overview This tab provides information into the overall performance of the MySQL server. Parameter Description Monitor Information Name Denotes the name of MySQL server monitor. Health Denotes the health (Clear, Warning, Critical) of the MySQL server. Type Denotes the type you are monitoring. MySQL Version Specifies the version of the database server. Port Specifies the port number at which the database server is running. Base Directory Specifies the directory in which the database server is installed. Data Directory Specifies the directory in the hard disk of the system where the data for the databaseserver is stored. Host Name Specifies the host at which the database server is running. Host OS Specifies the OS of the host where the database server is running. Last Alarm Specifies the last alarm that was generated for the database server. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the server - available or not available. Connection Time The time taken to connect to the MySQL database server from Applications Manager Connection Time server. Connection Time Out Specifies the maximum time taken by the application to connect to MySQL Server Request Statistics Request Rate Number of request received in one second. Bytes Received Rate Number of bytes received in one second. Bytes Sent Rate Number of bytes sent in one second. Connection Statistics Open Connections The number of connections opened at present in the MySql Server. Aborted Connections Number of tries to connect to the MySQL server that failed. Aborted Clients Number of clients aborted by MySQL server. Open Connections in The ratio of connections opened with max connections. (%) Thread Details Threads Used Number of threads processing the request. Threads in Cache Number of threads currently placed in the thread cache. Thread Cache Size Specifies the cache size in the MySQL server. Table Lock Statistics Immediate Locks Number of times a table lock for the table is acquired immediately. Locks Wait Number of times a table lock could not be acquired after waiting. Key Efficiency Key Hitrate Percentage of key read requests that resulted in actual key reads from the key buffer. Key Buffer Used Amount of allocated key buffer in use. Key Buffer Size Size of the buffer used for index blocks. Also known as the key cache. Query Statistics Queries Inserted/Min No. of Insert Queries executed per minute Queries Deleted/Min No. of Delete Queries executed per minute Queries No. of Update Queries executed per minute Updated/Min Queries No. of Select Queries executed per minute Selected/Min Query Cache Hitrate (This performance data is not available for MySQL versions 3.23.x) Query Cache Hitrate Ratio of queries that were cached and queries that were not cached. Query Cache Size Amount of memory allocated for caching query results. Query Cache Limit Maximum amount of memory for storing cache results. Database Parameter Description Database Details Database Name Name of the database instance. Database Size Size of the various databases in the MySQL server (in MB).Replication Parameter Description Replication Details 1. Master-Slave Replication Replication The status of Slave process in MySQL Server Status Slave IO Status of the Slave IO Process in MySQL Server. Possible values are Yes or No. Running Slave SQL Status of the Slate SQL Process in MySQL Server. Possible values are Yes or No. Running Last Error The last error occured when Slave is synching the data from master. Master Host The hostname or IP number of the master replication server. Master Port The TCP/IP port number that the master is listening on. The username of the account that the slave thread uses for authentication when it connects to the Master User master. Time Behind This indicates of how “late” the slave is behind the Master. Master 2. Group Replication Defines the state of the Member. Possible values are ONLINE, OFFLINE, ERROR, RECOVERY, State UNREACHABLE. Connection The status of connection whether it is active/Idle or no Longer exists or trying to connect. Possible State values are ON, OFF, CONNECTING. Count Conflicts The number of transactions that did not pass the conflict detection check. Detected Count The number of transactions in the queue pending conflict detection checks. Once the Transactions transactions have been checked for conflicts, if they pass the check, they are queued to be In Queue applied as well. Count The number of transactions that this member originated that were rolled back after being sent to Transactions the replication group. Rollback Last Error The error message which has triggered lastly. Last Error The Timestamp of last Error. TimeStamp Replication Gives the status of Replication Applier Thread is Active/Idle and Dead. Possible values are ON, Applier OFF. The member server UUID. This has a different value for each member in the group. This also Member ID serves as a key because it is unique to each member. Host Name The Name of the Host of this Member. Role This metric defines the member''s role in the group. Possible values are PRIMARY, SECONDARY. Port The port Number on which the Member is Running. Replication The mode of Replication, which the group is using. Possible values are single-primary, multi- Mode primary. Group Name The name group that the Member (MySQL server) belongs to. Channel The name of the Group Replication Channel. Name Primary Host Host Name of the Primary Member in the Group. Primary Port Port Number of the Primary Member in the Group. Performance Parameter Description TOP QUERIES BY CPU Avg. CPU Time The average CPU time taken to execute the query (in millisecond).The cumulative total amount of CPU time that has been spent running this query (in Total CPU Time millisecond). Max CPU The maximum amount of time that was taken by the CPU to run this query (in millisecond). Query The SQL query which consumed the maximum CPU time. DB Name The database under which this query has been executed. Last Execution The last time at which the query executed. Time Note : The TOP QUERIES BY CPU data will be displayed only for MySQL versions 5.7 & above. Session Parameter Description Session Details PID Displays the process ID of the session running in the MySQL server. Status Displays the status of the process in the MySQL server.  User The login name of the user executing the process. DB Name Displays the name of the database currently being used by the process. Program Name The name of the program that has established the session. Memory Usage The amount of memory that has been utilized by the process (in kilobytes).  CPU Time The cumulative CPU time taken for the process running in the MySQL Server (in millisecond). Lock Latency Amount of time taken to establish a lock for the established session (in millisecond). For foreground threads, the type of command the thread is executing on behalf of the client, or Command Sleep if the session is idle. Query The query the thread is executing, or NULL if it is not executing any statement. Last Query The last query executed by the thread, if there is no currently executing statement or wait. Last Query CPU The CPU time taken for the last query to be executed (in millisecond). Time Note : The Session Details data will be displayed only for MySQL versions 5.7 & above. Configuration This tab provides information about the system variables maintained by the MySQL server. These system variables indicate how the server is configured. You can also view realtime and historical data of any of the attributes present in the ''Configuration Information'' section in the Configuration tab. Click on any attribute under the Configuration tab. This will open up a new window named ''History Data'' that provides more information about these attributes. There are two tabs in the History Data window - History Report and Global View. History Report: This tab provides historical reports of the attribute selected based on the time period chosen. You can also use the Select Attribute drop-down box and view reports for other attributes. Global View: This tab displays the current values of the attribute selected, across multiple monitors. To view information about other attributes present in the monitor, use the Select Attribute drop-down box and change the attribute. If you want to view data of multiple attributes, click the Customize Columns link present at the top left corner of the window. This will take you to the Edit Global Viewscreen. In this screen, you can change the monitor type using the Filter by Monitor Type drop-down box, select the metrics to be displayed, and show monitors on a monitor basis or a monitor group basis. After you select your options, click the Show Report button to view those information in the Global View tab. The View Process List option present on the right side under the Show Status section gives you information on the current threads that are running in the MySQL server. Oracle Database ServersOverview Applications Manager provides out-of-the-box performance metrics and helps you visualize the health and availability of an Oracle Database server farm. Database administrators can login to the web client and visualize the status and Oracle performance metrics. Creating a new Oracle DB monitor Supported Versions: Applications Manager supports monitoring of Oracle database servers of versions 9i, 10g, 10.1.3, 11g, 12c, 18c & 19c. Prerequisites for monitoring Oracle DB metrics: Click here Using the REST API to add a new Oracle DB monitor: Click here Follow the given steps to create a Oracle database server monitor: Click on New Monitor link. Select Oracle DB Server. Enter the IP Address or hostname of the host. Enter the Subnet Mask of the network. Enter the port number in which the Oracle is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the user name of the admin user (''system'' is the default username) and its corresponding password. Provide a valid System Identifier / Host Connection String. Choose Discover Pluggable Database (PDB) as ''Yes'' to discover and monitor pluggable databases associated with the Oracle DB server (Applicable only for CDB instance of an Oracle Multitenancy-enabled server). To add only the required PDB(s), choose ''No'' and add the PDB(s) via Add PDB link available under ''PDB'' tab in Oracle DB monitor. Provide the Socket Read Timeout and Query Execution Timeout values in seconds. Choose the Monitor Group from the combo box with which you want to associate Oracle database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Oracle database server from the network and starts monitoring them. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Oracle Server under the Database Servers Table. Displayed is the Oracle servers bulk configuration view in three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Note: To create a new Oracle database monitor, you should have admin privileges. Minimum User Privileges → user with CONNECT and SELECT_CATALOG_ROLE roles. Click on the monitor name to see all the server details listed under the following tabs: Overview PDB Tablespace Session Rollback & Corrupted Blocks * SGA Query Lock Statistics Jobs & Backup * PGA Process ASM * RPO Alert Logs Redo LogsNote: The server details marked with * symbol is supported in Oracle database servers version 10g and above. Overview Parameters Type Description Monitor Information Name String Name of the Oracle server monitor Oracle Version String The version of the Oracle Database. Oracle Start String The time when Oracle server was started. Time Availability String The status of the database server - available or not available. Today''s Availability Current Status String Availability history graph with uptime Connection Statistics Response Time String The time taken to connect to the database. Session Activity Number of Numeric Graph for the number of users executing an SQL Statement. vs time Session Users Table spaces with least free bytes Name String The name of the table space. Free Bytes (MB) Numeric The free space available in bytes. % of Free Bytes Numeric The percentage of free space available in bytes. Database Details Version Numeric Version of the database. Indicates whether the added Oracle DB Sever is a CDB instance or Non-CDB DB Type String instance. Database String Creation time of the database. Created Time Open Mode String Indicates the Open mode of the Instance which can be either Read Write or Read. FRA Status String Indicates whether Flashback is enabled for the database instance. The two Log Modes are: NOARCHIVELOG - When you run your database in NOARCHIVELOG mode, you Log Mode String disable the archiving of the redo log. ARCHIVELOG - When you run a database in ARCHIVELOG mode, you enable the archiving of the redo log. Current role of the database: LOGICAL STANDBY DB Role String PHYSICAL STANDBY PRIMARY Type of control file: STANDBY - Indicates that the database is in standby mode CLONE - Indicates a clone database Control File type String BACKUP | CREATED - Indicates the database is being recovered using a backup or created control file CURRENT - database is available for general useParameters Type Description Indicates whether switchover is allowed: NOT ALLOWED - Either this is a standby database and the primary database has not been switched first or this is a primary database and there are no standby databases. SESSIONS ACTIVE - Indicates that there are active SQL sessions attached to the primary or standby database that need to be disconnected before the switchover operation is permitted. Query the V$SESSION view to identify the specific processes that need to be terminated. SWITCHOVER PENDING - This is a standby database and the primary database switchover request has been received but not processed. SWITCHOVER LATENT - The switchover was in pending mode, but did not complete and went back to the primary database. TO PRIMARY - This is a standby database and is allowed to switch over to a primary database. Switch over String TO STANDBY - This is a primary database and is allowed to switch over to a status standby database. RECOVERY NEEDED - This is a standby database that has not received the switchover request. PREPARING SWITCHOVER - Either this is a primary database that is accepting redo data from a logical standby database in preparation for switch over to the logical standby database role, or it is a logical standby database sending redo data to a primary database and other standby databases in preparation for switch over to the primary database role. In the latter case, a completed dictionary has already been sent to the primary database and other standby databases. PREPARING DICTIONARY - This is a logical standby database that is sending redo data to a primary database and other standby databases in the configuration in preparation for switch over to the primary database role. TO LOGICAL STANDBY - This is a primary database that has received a complete dictionary from a logical standby database. Protection mode currently in effect for the database: MAXIMUM PROTECTION - Database is running in maximized protection mode MAXIMUM AVAILABILITY - Database is running in maximized availability mode RESYNCHRONIZATION - Database is running in resynchronization mode Protection Mode String MAXIMUM PERFORMANCE - Database is running in maximized protection mode UNPROTECTED - Database is unprotected (this normally occurs when the primary database is mounted and not open) Indicates whether the next database open allows or requires the resetlogs option NOT ALLOWED Open reset logs String ALLOWED REQUIRED Protects data from being changed: ALL - Indicates all users other than SYS are prevented from making changes to any data in the database. Guard Status String STANDBY - Indicates all users other than SYS are prevented from making changes to any database object being maintained by logical standby. NONE - Indicates normal security for all data in the database. Force logging String Indicates whether the database is under force logging mode (YES) or not (NO). Database Status Database Size ** Numeric Size of the database in Megabytes. Average This is the average number of executions that happen during the execution of every Numeric Executions SQL Statement.Parameters Type Description Reads Numeric Refers to the number of reads from the database. Writes Numeric Refers to the number of writes to the database. Database Block Numeric This refers to the lowest possible storage area for an Instance in bytes. Size Free Space ** Numeric Size of free extents in all tablespaces in the database (Size in MB). Invalid/Unusable Numeric Number of Invalid/Unusable indexes in the databse. Index Count Current SCN Numeric Current System Change Number (SCN) of the database. Data transferred Numeric Total data sent and received via SQL*Net services in MB. via SQL*Net Database CPU Numeric Ratio of DB CPU time to DB time. Ideal value is greater than 90%. Time Ratio Hit Ratio The buffer cache hit ratio calculates how often a requested block has been found in Buffer Cache Hit Numeric the buffer cache without requiring disk access. It is the percentage of cache hits Ratio taking place from the buffer cache. The Data Buffer Hit Ratio Oracle metric is a measure of the effectiveness of the Data Buffer Hit Numeric Oracle data block buffer. It is the percentage of logical reads taking place from the Ratio data block. The ratio of the data gets to the data misses in the row cache is Data Dictionary Hit Data Dictionary Numeric Ratio. The Library cache stores all shared SQL and PL/SQL blocks, along with their parse trees. In OLTP environments where a large numbers of users are entering and Library Numeric exchanging data, there is a great chance for overlapping the parse and execute needs of those different queries. Such an overlap in the library is called a cache hit and the ratio determined to the misses and hits is called Library Cache Hit Ratio. SGA Details Buffer Cache Numeric The total size of the Buffer Cache given in bytes. Size Shared Pool Size Numeric The size of the shared pool given in bytes. Shared Pool Numeric Amount of space utilized in the shared pool in percentage. Used Size Redolog Buffer Numeric The size of the buffers for the Redo Logs in mb. Size Library Cache Numeric The size of the Library Cache given in bytes. Size Data Dictionary Numeric The cache size of the data dictionary or row cache in bytes. Cache Size SQL Area Size Numeric The size of the SQL Area for usage of SQL/PL statements in bytes. Fixed Area Size Numeric The size of the SGA, which is fixed throughout the instance. Oracle DB Links DB link name String Name of the database link Owner String Owner of the database link User String Name of the user when logging in Oracle Net String Host Name connect string Creation time String Creation time of the database link Invalid Objects Owner String Owner of the invalid dba object. Object Name String Name of the invalid object. Status String Status of the invalid object. Invalid/Unusable Indexes Index Name String  Name of the indexParameters Type Description Tablespace String  Name of the tablespace containing the index Name Owner String  Owner of the index Table Name String  Name of the indexed object Indicates whether a nonpartitioned index is VALID or UNUSABLE. We list all Index Status String UNUSABLE indexes. Note: Metrics marked with ** are mapped under Admin → Performance Polling. PDB Parameter Type Description Pluggable Database (PDB) Details Name String Name of the pluggable database. Open Mode String Displays the open mode information like MOUNTED, READ WRITE, READ ONLY. Database Size Numeric Size of the pluggable database in MB. Database Block Size Numeric Size of the pluggable database block in MB. By clicking over the PDB name, you will be redirected to the Oracle PDB monitoring dashboard. Tablespace Parameter Type Description Table Space Details Name String Refers to the name of the Table space. Allocated Numeric Refers to the size of the Table space in bytes. Bytes Allocated Numeric Refers to the number of allocated blocks in Table space. Blocks Data Files Numeric Refers to the number of data files in Table space. Table Space Status Name String Refers to the name of the Table space. Status String Tablespace status: ONLINE, OFFLINE, or INVALID (tablespace has been dropped) Free Bytes Numeric Refers to the available free space in bytes. Free Blocks Numeric Refers to the number of free blocks in Table space. Reads Numeric Refers to the number of reads from the Table space. Writes Numeric Refers to the number of writes on the Table space. Read Time Numeric Time taken for a single read from the Table space. Write Time Numeric Time taken for a single write on the Table space. Performance of Data Files Data File String Name and location of the data file. Name Table Space String Name of the Table space. Name If a data file is a part of the system table space, its status is SYSTEM (unless it requires recovery). If a data file in a non-SYSTEM table space is online, its status is ONLINE. If a Status String data file in non-SYSTEM table space is offline, its status can be either OFFLINE OR RECOVER. AutoExtend String Indicates whether AutoExtend is enabled for this data file or not. Created Numeric Size of the Data file in bytes. Bytes Reads Numeric Refers to the number of reads from the Data file.Parameter Type Description Writes Numeric Refers to the number of writes to the Data file. Average Numeric Refers to the average read time. Read Time Average Numeric Refers to the average write time. Write Time Objects Approaching MAX Extents Owner String Owner name of the table space. TableSpace String Name of the TableSpace. Name Segment String Name of the segment approaching maximum extents Name Segment String The type of segment approaching maximum extents Type Extents Numeric Number of extents allocated to the segment Max Extents Numeric Maximum allowed extents that can be filled in a segment Next Extent Numeric Next extent size in MB (MB) Note: Data collection is scheduled to take place once a day; the user can use the ''Optimize Data Collection'' option to change the schedule. Session Parameter Type Description Session Details ID String Session Identifier for the connected session. Status String Current status: ONLINE, OFFLINE, or INVALID (tablespace has been dropped). Machine String Name of the operating system user. User String Name of the Oracle process user. Name Elapsed Numeric Time elapsed in seconds after which the user has logged into the oracle server. Time CPU Used Numeric CPU centiseconds (divide by 100 to get real CPU seconds) used by this session. Memory Numeric Number of memory sorts performed. Sorts Table Numeric Number of table scans performed. Scans Physical Numeric Physical reads for the session. Reads Logical Numeric Sum of consistent gets and db block gets. Reads Commits Numeric Number of commits made by user in a second. Cursor Numeric Number of cursor currently in use. Buffer Percentage of session logical reads taking place from the buffer (1 - physical Cache Hit Numeric reads/session logical reads * 100). Ratio Session Waits ID String Session Identifier for the connected session. User String Name of the Oracle process user. Name Event Numeric Resource or event for which the session is waiting State Numeric Wait state: 0 - WAITING (the session is currently waiting) -2 - WAITED UNKNOWN TIME (duration of last wait is unknown)-1 - WAITED SHORT TIME (last wait <1/100th of a second) >0 - WAITED KNOWN TIME (WAIT_TIME = duration of last wait) A non-zero value is the session''s last wait time (in milliseconds). A zero value means the Wait Time Numeric session is currently waiting. If WAIT_TIME = 0, then SECONDS_IN_WAIT is the seconds spent in the current wait Seconds condition. If WAIT_TIME > 0, then SECONDS_IN_WAIT is the seconds since the start of the Numeric in Wait last wait, and SECONDS_IN_WAIT - WAIT_TIME / 100 is the active seconds since the last wait ended. Users Username String The username assigned to the user. Expiry String The date when the user account expires. Date Days to Numeric The number of days to account expiration. Expiry Account String The current status of the user account. Status User String The profile name of user. Profile Rollback & Corrupted blocks Parameter Type Description Rollback Segment Segment String Name of the rollback segment. Name Table Space String Name of the tablespace containing the rollback segment. Name ONLINE if the segment is online, or PENDING OFFLINE if the segment is going offline but Status String some active (distributed) transactions are using the rollback segment. When the transaction(s) complete, the segment goes OFFLINE. Current Size Numeric Current size in bytes of the rollback segment. Initial Extent Numeric Initial extent size in bytes. Next Extent Numeric Secondary extent size in bytes. Min. Extent Numeric Minimum number of extents. Max. Extent Numeric Maximum number of extents. Hit Ratio Numeric Ratio of gets to waits. This should be >= 99%. HWMSize Numeric High Water Mark of rollback segment size. Number of times rollback segment shrank, eliminating one or more additional extents Shrinks Numeric each time. Wraps Numeric Number of times rollback segment wraps from one extent to another. Extend Numeric Number of times rollback segment was extended to have a new extent. Blocks Corrupted File Number Numeric Datafile number Data File String Name of the database file. Name Block Numeric First block of the corrupted range Number Number of corrupted Numeric Number of contiguous blocks in the corrupted range blocks Type of String Type of block corruption in the datafile: block ALL ZERO - Block header on disk contained only zeros. The block corruption may be valid if it was never filled and if it is in an Oracle7 file. The buffer will be reformatted to the Oracle8 standard for an empty block.FRACTURED - Block header looks reasonable, but the front and back of the block are different versions. CHECKSUM - optional check value shows that the block is not self-consistent. It is impossible to determine exactly why the check value fails, but it probably fails because sectors in the middle of the block are from different versions. CORRUPT - Block is wrongly identified or is not a data block (for example, the data block address is missing) LOGICAL - Specifies the range is for logically corrupt blocks. CORRUPTION_CHANGE# will have a nonzero value. Fast Recovery Area FRA Name String Current location of the FRA. FRA Space The maximum amount of disk space that the database can use for the flash recovery Numeric Limit area (in MB). FRA Space The amount of disk space used by flash recovery area files created in current and all Numeric Used previous flash recovery areas (in MB). Used The percentage of disk space used by flash recovery area files created in current and all Numeric Percentage previous flash recovery areas. FRA Space Reclaimable Numeric The amount of flash recovery area that is reclaimable (in MB). Limit FRA Reclaimable Numeric The percentage of the amount of flash recovery area that is reclaimable. Percentage FRA Actual Used Numeric The percentage of the amount of flash recovery area used, including reclaimable space. Percentage Note: Data collection is scheduled to take place once every 12 hours; the user can use the ''Optimize Data Collection'' option to change the schedule. SGA Parameter Type Description SGA Performance: Graph displaying value (in %) of Buffer Cache Hit Ratio, Data Buffer Hit Ratio, Data Dictionary Hit Ratio and Library Hit Ratio vs time Buffer Cache Hit Numeric Percentage of cache hits taking place from the buffer cache. Ratio When a scan of the buffer cache shows that there are no free buffers, Database Block Data Writer determines which blocks to be eliminated based on a least recently used algorithm Buffer Hit Numeric or LRU. Having a block required by a user process in the buffer cache already is called a Ratio buffer cache hit or is determined as a ratio. Hits are good because they reduce the amount of disk I/O required for the user process. The purpose of the row or dictionary cache is to store rows of information from the data dictionary in memory for faster access. The row cache is designed to hold the actual rows Data of data from objects in data dictionary. While this data is held in the row cache, the users Dictionary Numeric of the database may access that information more quickly than if Oracle had to read the Hit Ratio data into memory from disk. The ratio of the data gets to the data misses in the row cache is Data Dictionary Hit Ratio. The Library cache stores all shared SQL and PL/SQL blocks, along with their parse trees. In OLTP environments where a large numbers of users are entering and exchanging data, Library Hit Numeric there is a great chance for overlapping the parse and execute needs of those different Ratio queries. Such an overlap in the library is called a cache hit and the ratio determined to the misses and hits is called Library Cache Hit Ratio. SGA Details Buffer Cache Numeric The total size of the Buffer Cache given in bytes. Size Shared Numeric The size of the shared pool given in bytes.Pool Size Shared Pool Used Numeric Amount of space utilized in the shared pool in percentage. Size Redolog Numeric The size of the buffers for the Redo Logs in bytes. Buffer Size Library Cache Numeric The size of the Library Cache given in bytes. Size Data Dictionary Numeric The cache size of the data dictionary or row cache in bytes. Cache Size SQL Area Numeric The size of the SQL Area for usage of SQL/PL statements in bytes. Size Fixed Area Numeric The size of the SGA, which is fixed throughout the instance. Size SGA Status When a scan of the buffer cache shows that there are no free buffers, Database Block Writer determines which blocks to be eliminated based on a least recently used algorithm Buffer Hit Numeric or LRU. Having a block required by a user process in the buffer cache already is called a Ratio buffer cache hit or is determined as a ratio. Hits are good because they reduce the amount of disk I/O required for the user process. The purpose of the row or dictionary cache is to store rows of information from the data dictionary in memory for faster access. The row cache is designed to hold the actual rows Data of data from objects in data dictionary. While this data is held in the row cache, the users Dictionary Numeric of the database may access that information more quickly than if Oracle had to read the Hit Ratio data into memory from disk. The ratio of the data gets to the data misses in the row cache is Data Dictionary Hit Ratio. The Library cache stores all shared SQL and PL/SQL blocks, along with their parse trees. In OLTP environments where a large numbers of users are entering and exchanging data, Library Hit Numeric there is a great chance for overlapping the parse and execute needs of those different Ratio queries. Such an overlap in the library is called a cache hit and the ratio determined to the misses and hits is called Library Cache Hit Ratio. Free Numeric Refers to the size of the free memory in bytes. Memory Query Query attributes are not monitored by default. Applications Manager allows you to enable/disable data collection of query metrics. Once enabled, you can also customize the polling interval of these metrics. To monitor query metrics: Go to Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select Oracle from the Monitor Type drop-down menu. Select Top 10 Queries by Buffer Gets from the Metric Name drop-down menu. Select how you wish to configure the queries: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of any particular monitor(s). Parameter Type Description Buffer Gets Buffer Gets Numeric Number of buffer gets for the child cursorParameter Type Description Number of executions that took place on the object since it was brought into Executions Numeric the library cache Buffer Gets per Numeric The ratio of buffer gets to execution in the current polling interval Executions Query String First thousand characters of the SQL text for the current cursor Disk Reads Disk Reads Numeric Number of disk reads for this child cursor Number of executions that took place on this object since it was brought into Executions Numeric the library cache Disk Reads per Numeric The ratio of disk reads to execution in the current polling interval Executions Query String First thousand characters of the SQL text for the current cursor Lock Statistics Lock statistics are not monitored by default. Applications Manager allows you to enable/disable data collection of Lock statistics. Once enabled ,you can also customize the polling interval of these metrics. To monitor Lock statistics: Go to Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select Oracle from the Monitor Type drop-down menu. Select Lock and Wait Statistics from the Metric Name drop-down menu. Select how you wish to configure the Lock and Wait Statistics: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of any particular monitor(s). Parameter Type Description Sessions holding a lock Id Numeric Session identifier of Session holding a lock Session serial number. Used to uniquely identify a session''s objects. Guarantees that Serial  Numeric session-level commands are applied to the correct session objects if the session ends and another session begins with the same session ID. Machine String Operating system machine name. PROGRAM String Operating system program name. Lock Wait  String Address of lock waiting for; null if none. Sessions waiting for a lock Waiting Numeric ID of Session waiting for lock. Session ID Holding Numeric ID of Session holding lock. Session ID Lock Type String The lock type. Mode String The mode held. Held  Mode String The mode requested. Requested Lock ID1, String The Lock IDs. ID2 Lock StatisticsObject String Name of the locked object Name Session Id  Numeric The session ID of a locked object. Serial    Numeric The session serial number. Used to uniquely identify a session''s objects. Lock Mode Numeric The lock mode in which the session holds the lock. OS Numeric The operating system process identifier. Process ID If the session STATUS is currently ACTIVE, then the value represents the elapsed time in Blocked minutes since the session has become active. If the session STATUS is currently Session Numeric INACTIVE, then the value represents the elapsed time in minutes since the session has Time become inactive. Time of String Login time. logon Blocked Sessions Waiting Session Numeric Serial number of the session waiting for lock. Serial Waiting Numeric Session ID of the session waiting for lock. Session ID Blocking Numeric Session ID of the blocking session. Session ID Waiting String The SQL query that waiting for lock. Query If the session STATUS is currently ACTIVE, then the value represents the elapsed time (in Blocked minutes) since the session has become active. If the session STATUS is currently Numeric Time INACTIVE, then the value represents the elapsed time (in minutes) since the session has become inactive. Instance Numeric ID of the database instance. ID OS Numeric The operating system process ID. Process ID Machine String Name of the machine where the blocking session is running. Program String Name of the program where the blocking session is running. LogOn String Date and time of logon. Time Jobs & Backup Parameter Type Description Schedule jobs details Job Name String Name of the job. Current state of the job (DISABLED, RETRY SCHEDULED, SCHEDULED, RUNNING, Current State String COMPLETED, BROKEN, FAILED, REMOTE, SUCCEEDED, CHAIN_STALLED) Last Run String Status of the job run. Status Last Run Date String Last date on which the job started running. Last Run Numeric Amount of time the job took to complete during the last run (in seconds) Duration  (sec) Next Run Date String Next date on which the job is scheduled to run. Schedule Jobs Stats Job Name String Name of the job. Run Count Numeric Number of times the job has run. Failure Count Numeric Number of times the job has failed to run. Retry Count Numeric Number of times the job has retried, if it is retrying.Parameter Type Description Elapsed Time  Numeric Elapsed time since the job was started (in seconds). (sec) Running Backup Jobs Count DB FULL Numeric Number of jobs running of type DB FULL. RECVR AREA Numeric Number of jobs running of type RECVR AREA. DB INCR Numeric Number of jobs running of type DB INCR. DATAFILE Numeric Number of jobs running of type DATAFILE FULL. FULL DATAFILE Numeric Number of jobs running of type DATAFILE INCR. INCR ARCHIVELOG Numeric Number of jobs running of type ARCHIVELOG. CONTROLFILE Numeric Number of jobs running of type CONTROLFILE. SPFILE Numeric Number of jobs running of type SPFILE. Backup Jobs Details Session Key Numeric The Session identifier. Type of input files backed up in this session. Can have one of the following values: DB FULL RECVR AREA DB INCR Backup Type String DATAFILE FULL DATAFILE INCR ARCHIVELOG CONTROLFILE SPFILE Last Backup String Last backup start time. Time Backup Status String Back up status with the value FAILED. Time Taken Numeric Time Taken to complete last back-up (in seconds). Backup Size Numeric Backup size in megabytes. (MB) Backup Jobs History Recent Backups Backup Type String Type of input files backed up in this session. Session Key Numeric The Session identifier. Last Backup String Last backup start time. Time Backup Status String Back up status with the value FAILED. Time Taken Numeric Time Taken to complete last back-up (in seconds). Backup Size Numeric Backup size in megabytes. (MB) Click the Recent backups link on the top right-hand corner of the Backup Job Details table to view recent backup job detailsfor each backup type. Note: Data collection is scheduled to take place once every 12 hours; the user can use the ''Optimize datacollection'' option to change the schedule. Limitation: Thresholds configured on older backup jobs status will not be retained for PPM users. PGA Parameter Type DescriptionParameter Type Description TOP 10 Process using PGA - Graphical representation of the PGA used by processes. PGA Stats Per Process (TOP 10) Process Id Numeric Oracle process identifier. Program Name String Program in progress. PGA used (MB) Numeric Amount of PGA memory consumed in megabytes. PGA Allocated (MB) Numeric Maximum PGA memory allocated at one time since instance startup. Max PGA Used (MB) Numeric PGA memory currently used by the process. Freeable PGA (MB) Numeric Allocated PGA memory which can be freed. PGA Stats Total PGA used (MB) Numeric Indicates how much PGA memory is currently consumed. Total PGA allocated (MB) Numeric Current amount of PGA memory allocated by the instance. Maximum PGA allocated Numeric Maximum amount of PGA memory consumed . (MB) Number of bytes of PGA memory in all processes that could be freed Total freeable PGA (MB) Numeric back to the operating system. PGA freed back to OS (MB) Numeric Number of bytes of PGA memory freed back to the operating system. Percentage of PGA memory component, cumulative since instance Cache hit percentage Numeric startup Resource being used by Numeric Percentage resources currently being used by processes. processes (%) Resouce limit for processes Resource being used by Numeric Resources (locks or processes) currently being used. processes Free Resource Numeric Percentage of unused resources. Process Parameters Type Description Session Details Process Id Numeric Oracle process identifier. PGA used (MB) Numeric Indicates how much PGA memory is currently consumed. PGA Stats Per Process (TOP 10) Process Id Numeric Oracle process identifier. Program Name String The program in progress. PGA used(MB) Numeric Indicates how much PGA memory is currently consumed. PGA Numeric Current amount of PGA memory allocated by the instance. Allocated(MB) Max PGA Numeric Maximum amount of PGA memory consumed . Used(MB) Freeable Number of bytes of PGA memory in all processes that could be freed back to the Numeric PGA(MB) operating system. ASM Applications Manager allows you to enable/disable data collection of several metrics. Once enabled ,you can also customize the polling interval of these metrics. Data collection for ASM is not enabled by default and here is how you can enable it: Enabling ASM Metrics Go to the Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab.Select Oracle from the Monitor Type drop-down menu. Select ASM Details from the Metric Name drop-down menu. Select how you wish to configure the mertics: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of any particular monitor(s). Click Save. Parameter Type Description Disk Group Details Disk Group Numeric Cluster-wide number assigned to the disk group. Number Name String Name of the disk group. State of the disk group relative to the instance (Connected, Broken, Unknown, State String Dismounted, Mounted). Type String Redundancy type for the disk group (EXTERN, NORMAL, HIGH). Total Memory Numeric Total capacity of the disk group (in megabytes). (GB) Free Memory Numeric Unused capacity of the disk group (in megabytes). (GB) RPO RPO statistics are not monitored by default. Applications Manager allows you to enable/disable data collection of RPO statistics. Once enabled, you can also customize the polling interval of these metrics. To monitor RPO statistics: Go to Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select Oracle from the Monitor Type drop-down menu. Select Log Apply Gap details in Primary Server/Log Apply Lag details in Standby Server from the Metric Name drop-down menu. Select how you wish to configure the Log Apply Gap details: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of any particular monitor(s). Log Apply Gap Details For Primary and Physical Standby Databases: Parameter Type Description Thread Numeric Indicates the thread number. Last Sequence Numeric Shows the last log sequence that was received by the database. Received Last Sequence Numeric Shows the last log sequence that was applied to the database. Applied Shows the difference between log sequence received and the log sequence Log apply gap Numeric applied. For Logical Standby databases:Parameter Type Description Type String Type of the log applied. SCN Numeric The System Change Number (SCN) of the database. Time String Timestamp of the log that was applied. Sequence Numeric Sequence number of the log that was applied. Log Apply Lag Details Parameter Type Description Log Apply Lag Details (only from standby) Transport Transport lag is a measure of the degree to which the transport of redo to the standby Numeric Lag database lags behind the generation of redo on the primary database. (no units) Log Apply Log Apply lag is a measure of the degree to which the redo data on the standby database Numeric Lag lags behind the primary database. (no units) Apply Estimated time before log apply services will finish applying the redo data available on Finish Numeric the standby database. (in minutes) Time Archive Log Destination Details are not monitored by default. Applications Manager allows you to enable/disable data collection of archive log destination metrics. Once enabled ,you can also customize the polling interval of these metrics. To monitor metrics: Go to Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select Oracle from the Monitor Type drop-down menu. Select Archive Log Destination Monitoring from the Metric Name drop-down menu. Select how you wish to configure the queries: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of any particular monitor(s). Parameter Type Description Archive Log Destination Details (only from primary) Dest Id Numeric Identifies the log archive destination parameter Name String Archived log file name. Status String Status of the archived log. Type of archival destination database: LOCAL - Local to primary database Type String PHYSICAL - Physical standby CROSS-INSTANCE - An instance of the primary LOGICAL - Logical standby Destination String Original destination from which the archive log was generated. Indicates whether the database is protected: MAXIMUM PROTECTION Protection MAXIMUM AVAILABILITY String Mode RESYNCHRONIZATION MAXIMUM PERFORMANCE UNPROTECTEDParameter Type Description Specifies network transmission mode: SYNCHRONOUS Transmit String mode PARALLELSYNC ASYNCHRONOUS Current mode of media recovery at the archival destination database: IDLE - Managed recovery is not active MANUAL - Manual media recovery active Recovery String mode MANAGED - Managed recovery is active MANAGED REAL TIME APPLY - Log apply services recover redo data from standby redo logs at the same time the logs are being written to, as opposed to recovering redo from archived redo logs when a log switch occurs Archive Log Destination Stats (only from primary) Dest Id Numeric Log archive destination parameter identifier Log Numeric Identifies the sequence number of the last archived redo log to be archived sequence Net Number of seconds the log writer process will wait for status from the network server of a Numeric timeout network operation issued by the log writer process Fail Numeric Sequence number of the archived redo log being archived when the last error occurred Sequence Archived Identifies the log sequence number of the most recent archived redo log received at the Numeric Sequence destination Applied Identifies the log sequence number of the most recent applied redo log received at the Numeric Sequence destination Delay Identifies the delay interval (in minutes) before the archived redo log is automatically Numeric (Mins) applied to a standby database Error String Displays the error text Alert Logs Alert Logs are not monitored by default. Applications Manager allows you to enable/disable data collection for Lock statistics. Once enabled, you can also customize the polling interval of these metrics. To monitor Alert Log Statistics: Go to the Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, click on the Optimize Data Collection tab. Select Oracle from the Monitor Type drop-down menu. Select Oracle Alert Log from the metric drop-down menu. Select how you wish to configure the Alert Log Statistics: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type will have the default polling status, until any exclusive customization is performed. You can choose between three different polling settings: Never collect data, Collect data at every poll and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of a particular monitor(s). Oracle Error List table lists only recent errors. To view history of ORA errors, click View Alert Log history. Monitored Parameters Parameter Type Description Oracle ORA Error CountParameter Type Description Critical / Severe / The number of critical errors, severe errors, important message and Numeric Important / Normal normal messages. Oracle ORA Error List The record number for the message (this value is same as the row Record ID Numeric number). Level the message belongs to. Lower level values imply higher severity for errors. Possible values include: 1: CRITICAL: critical errors Message Level String 2: SEVERE: severe errors 8: IMPORTANT: important message 16: NORMAL: normal message Originating Time String The date and time at which the message was generated. Host Address String The IP of other network address of the originating host for the mesaage. Message Text String The fully formed and localized text of the message. Redo Logs Redo Logs are not monitored by default. To enable Redo Log monitoring: Go to the Admin Tab Click Performance polling. Go to the Optimize data collection tab. Select Oracle from the Monitor Type drop-down menu. Select Redo Logs. Parameter Type Description REDO PERFORMANCE Buffer The ratio of redo buffer allocation retries/redo writes in Percentage. Ideal value is upto Allocation Numeric 1%. Retries Ratio Space Numeric The ratio of redo log space requests/redo entries in Percentage.Ideal value is upto 1%. Request Ratio Space Wait Numeric The ratio of redo log space requests/redo writes in Percentage.Ideal value is upto 1% Ratio REDO LOG DETAILS RedoLog Numeric The size of the buffers for the Redo Logs in Mb. Buffer Size Log switches Numeric The average number of log switches in the last hour. in past 1 hour Current Redo Numeric The percentage of redo logs used/filled up. Log Usage REDO LOG GROUPS INFORMATION Group Numeric The redo log group identifier. The number of redo log threads. (The redo log file groups of an instance are Thread Numeric collectively called a redo log thread.) Log Size  Numeric The size of each log in the redo log groups. (MB) Member Numeric The number of members in the log group. Count Archive Archive status: YES or NO. (Oracle lets you save filled groups of redo log files to one or String Status more offline destinations, known as the archived redo log.)Parameter Type Description Log status: UNUSED - Online redo log has never been written to. This is the state of a redo log that was just added, or just after a RESETLOGS, when it is not the current redo log. CURRENT - Current redo log. This implies that the redo log is active. The redo log could be open or closed. ACTIVE - Log is active but is not the current log. It is needed for crash recovery. It may be in use for block recovery. It may or may not be archived. Log Status String CLEARING - Log is being re-created as an empty log after an ALTER DATABASE CLEAR LOGFILE statement. After the log is cleared, the status changes to UNUSED. CLEARING_CURRENT - Current log is being cleared of a closed thread. The log can stay in this status if there is some failure in the switch such as an I/O error writing the new log header. INACTIVE - Log is no longer needed for instance recovery. It may be in use for media recovery. It may or may not be archived. REDO LOG MEMBERS INFORMATION Member String The redo log member name. Name Group Numeric The redo log group identifier. The status of the log member: INVALID - File is inaccessible Member String STALE - File''s contents are incomplete Status DELETED - File is no longer used IN USE - File is in use The member status type: Member String ONLINE Type   STANDBY Oracle Pluggable Database (PDB) Servers Overview Multitenancy is the new feature introduced in Oracle 12c and it is the concept of consolidating Pluggable Databases (PDB) into a single database server. Starting in Oracle Database 12c Release 1 (12.1), you must create a database as either a Multitenant Container Database (CDB) or as an Oracle database that is non-CDB. A Pluggable Database (PDB) is a portable collection of Schemas, Schema Objects, and Non-Schema Objects that appears as a separate database with its own instance name. Monitored Parameters Prerequisites for monitoring Oracle PDB metrics: Click here Go to the Monitors Category View by clicking the Monitors tab. Click on Oracle PDB Server under the Database Servers table. Displayed is the Oracle PDB servers bulk configuration view in three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Tablespace SessionQuery Lock Statistics Jobs Overview Parameters Type Description Database Details Database String Creation time of the database. Created Time Open Mode String Indicates the Open mode of the Instance which can be either Read Write or Read. The two Log Modes are: NOARCHIVELOG - When you run your database in NOARCHIVELOG mode, you Log Mode String disable the archiving of the redo log. ARCHIVELOG - When you run a database in ARCHIVELOG mode, you enable the archiving of the redo log. Indicates whether the next database open allows or requires the resetlogs option NOT ALLOWED Open Reset Logs String ALLOWED REQUIRED Protects data from being changed: ALL - Indicates all users other than SYS are prevented from making changes to any data in the database. Guard Status String STANDBY - Indicates all users other than SYS are prevented from making changes to any database object being maintained by logical standby. NONE - Indicates normal security for all data in the database. Database Status Database Size ** Numeric Size of the database in Megabytes. Average This is the average number of executions that happen during the execution of every Numeric Executions SQL Statement. Total Reads Numeric Number of reads from the database. Total Writes Numeric Number of writes to the database. Database Block Numeric Refers to the lowest possible storage area for an Instance (in MB). Size Free Space ** Numeric Size of free extents in all tablespaces in the database (in MB). Invalid/Unusable Numeric Number of Invalid/Unusable indexes in the database. Index Count Current SCN Numeric Current System Change Number (SCN) of the database. Data transferred Numeric Total data sent and received via SQL*Net services (in MB). via SQL*Net Database CPU Numeric Ratio of DB CPU time to DB time. Ideal value is greater than 90%. Time Ratio Connection Statistics Response Time Numeric The time taken to connect to the database (in milliseconds). Session Activity Number of User Numeric The number of user sessions running in the database. Sessions Table spaces with least free bytes Name String The name of the TableSpace. Free Bytes Numeric The free space available in MB.Parameters Type Description % of Free Bytes Numeric The percentage of free space available in MB. Oracle DB Links DB Link Name String Name of the database link. Owner String Owner of the database link. User String Name of the user using the database link. Oracle Net String The Oracle Net Connection String of the database link. Connect String Creation time String Creation time of the database link. Invalid Objects Owner String Owner of the invalid dba object. Object Name String Name of the invalid object. Status String Status of the invalid object. Invalid/Unusable Indexes Index Name String  Name of the index Tablespace String  Name of the tablespace containing the index Name Owner String  Owner of the index Table Name String  Name of the indexed object Indicates whether a nonpartitioned index is VALID or UNUSABLE. We list all Index Status String UNUSABLE indexes. Note: Metrics marked with ** are mapped under Admin → Performance Polling. Tablespace Parameter Type Description TableSpace Details Name String Name of the Table space. Allocated Numeric Allocated size of the TableSpace in MB. Bytes Total Allocated Numeric Allocated size of the TableSpace in MB. Bytes Used Bytes Numeric Used size of the TableSpace in MB. Free Bytes Numeric Available free space of the TableSpace in MB. Percentage of Used Numeric Used size of the TableSpace in percentage. Bytes Percentage of Free Numeric Available free space of the TableSpace in percentage. Bytes Allocated Numeric Number of allocated blocks in TableSpace. Blocks Free Blocks Numeric Number of free blocks in TableSpace. TableSpace Status Name String Name of the Table space. Status String Tablespace status: ONLINE, OFFLINE, or INVALID (tablespace has been dropped) Data Files Numeric Number of data files in TableSpace. Reads Numeric Number of reads from the TableSpace per minute. Writes Numeric Number of writes on the TableSpace per minute. Read Time Numeric Time taken for a single read from the TableSpace in centiseconds.Parameter Type Description Write Time Numeric Time taken for a single write on the TableSpace in centiseconds. Performance of Data Files Data File String Name and location of the data file. Name TableSpace String Name of the Table space. Name If a data file is a part of the system table space, its status is SYSTEM (unless it requires recovery). If a data file in a non-SYSTEM table space is online, its status is ONLINE. If a Status String data file in non-SYSTEM table space is offline, its status can be either OFFLINE OR RECOVER. AutoExtend String Indicates whether AutoExtend is enabled for this data file or not. Created Numeric Size of the Data file in MB. Bytes Reads Numeric Number of reads from the Data file. Writes Numeric Number of writes to the Data file. Average Numeric The average time taken for read operations to occur in milliseconds. Read Time Average Numeric The average time taken for write operations to occur in milliseconds. Write Time Objects Approaching MAX Extents Owner String Owner name of the table space. TableSpace String Name of the TableSpace. Name Segment String Name of the segment approaching maximum extents Name Segment String The type of segment approaching maximum extents Type Extents Numeric Number of extents allocated to the segment Max Extents Numeric Maximum allowed extents that can be filled in a segment Next Extent Numeric Size of the Next Extent in MB Note: Data collection is scheduled to take place once a day; the user can use the ''Optimize Data Collection'' option to change the schedule. Session Parameter Type Description Session Details ID Numeric Session Identifier for the connected session. Serial String Serial number of the connected session. Status String Current status: ONLINE, OFFLINE, or INVALID (tablespace has been dropped). Machine String Name of the machine. User String Name of the Oracle process user. Name Elapsed Numeric Time elapsed in seconds after which the user has logged into the oracle server. Time CPU Used Numeric Amount of time the CPU was in use by the session in centiseconds. Memory Numeric Number of memory sorts performed. Sorts Table Numeric Number of table scans performed. Scans Physical Numeric Physical reads for the session. ReadsLogical Numeric Sum of consistent gets and db block gets. Reads Commits Numeric Number of commits made by user in a second. Cursor Numeric Number of cursor currently in use. Buffer Cache Hit Numeric Amount of session logical reads taking place from the buffer in percentage. Ratio Sessions Summary Machine String Name of the machine. Program String Name of the program. Session String Status of the sessions. Status Session Numeric Number of sessions available. Count Session Waits ID String Session Identifier for the connected session. User String Name of the Oracle process user. Name Event Numeric Resource or event for which the session is waiting Wait state: 0 - WAITING (the session is currently waiting) State Numeric -2 - WAITED UNKNOWN TIME (duration of last wait is unknown) -1 - WAITED SHORT TIME (last wait <1/100th of a second) >0 - WAITED KNOWN TIME (WAIT_TIME = duration of last wait) A nonzero value is the session''s last wait time (in milliseconds). A zero value means the Wait Time Numeric session is currently waiting. If WAIT_TIME = 0, then SECONDS_IN_WAIT is the seconds spent in the current wait Seconds condition. If WAIT_TIME 0, then SECONDS_IN_WAIT is the seconds since the start of the Numeric in Wait last wait, and SECONDS_IN_WAIT - WAIT_TIME / 100 is the active seconds since the last wait ended. Users Username String The username assigned to the user. Expiry String The date when the user account expires. Date Days to Numeric The number of days to account expiration. Expiry Account String The current status of the user account. Status User String The profile name of user. Profile Query Query attributes are not monitored by default. Applications Manager allows you to enable/disable data collection of query metrics. Once enabled, you can also customize the polling interval of these metrics. To monitor query metrics: Go to Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select Oracle PDB from the Monitor Type drop-down menu. Select Top 10 Queries by Buffer Gets from the Metric Name drop-down menu. Select how you wish to configure the queries: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in everypolling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of any particular monitor(s). Parameter Type Description Buffer Gets Buffer Gets Numeric Number of buffer gets for the child cursor Number of executions that took place on the object since it was brought into Executions Numeric the library cache Buffer Gets per Numeric The ratio of buffer gets to execution in the current polling interval Executions Query String First thousand characters of the SQL text for the current cursor Disk Reads Disk Reads Numeric Number of disk reads for this child cursor Number of executions that took place on this object since it was brought into Executions Numeric the library cache Disk Reads per Numeric The ratio of disk reads to execution in the current polling interval Executions Query String First thousand characters of the SQL text for the current cursor Lock Statistics Lock statistics are not monitored by default. Applications Manager allows you to enable/disable data collection of Lock statistics. Once enabled ,you can also customize the polling interval of these metrics. To monitor Lock statistics: Go to Admin tab. Click Performance Polling under Discovery and Data Collection. Under Performance Data Collection, Click on the Optimize Data Collection tab. Select Oracle PDB from the Monitor Type drop-down menu. Select Lock and Wait Statistics from the Metric Name drop-down menu. Select how you wish to configure the Lock and Wait Statistics: By Monitor Type - This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. You can choose between three different polling settings: Never collect data, Collect data in every polling and Collect data at customized time interval. Changing the polling status of ''Monitor Type'', will also change any configuration done for its ''Monitors''. By Monitors - Use this option to change the polling status of any particular monitor(s). Parameter Type Description Sessions holding a lock Id Numeric Session identifier of Session holding a lock Session serial number. Used to uniquely identify a session''s objects. Guarantees that Serial  Numeric session-level commands are applied to the correct session objects if the session ends and another session begins with the same session ID. Machine String Operating system machine name. PROGRAM String Operating system program name. Lock Wait  String Address of lock waiting for; null if none. Sessions waiting for a lock Waiting Numeric ID of Session waiting for lock. Session ID Holding Numeric ID of Session holding lock. Session ID Lock Type String The lock type. Mode String The mode held. Held Mode String The mode requested. Requested Lock ID1, String The Lock IDs. ID2 Lock Statistics Object String Name of the locked object Name Session Id  Numeric The session ID of a locked object. Serial    Numeric The session serial number. Used to uniquely identify a session''s objects. Lock Mode Numeric The lock mode in which the session holds the lock. OS Numeric The operating system process identifier. Process ID If the session STATUS is currently ACTIVE, then the value represents the elapsed time in Blocked minutes since the session has become active. If the session STATUS is currently Session Numeric INACTIVE, then the value represents the elapsed time in minutes since the session has Time become inactive. Time of String Login time. logon Blocked Sessions Waiting Session Numeric Serial number of the session waiting for lock. Serial Waiting Numeric Session ID of the session waiting for lock. Session ID Blocking Numeric Session ID of the blocking session. Session ID Waiting String The SQL query that waiting for lock. Query If the session STATUS is currently ACTIVE, then the value represents the elapsed time (in Blocked minutes) since the session has become active. If the session STATUS is currently Numeric Time INACTIVE, then the value represents the elapsed time (in minutes) since the session has become inactive. Instance Numeric ID of the database instance. ID OS Numeric The operating system process ID. Process ID Machine String Name of the machine where the blocking session is running. Program String Name of the program where the blocking session is running. LogOn String Date and time of logon. Time Jobs Parameter Type Description Schedule Job Details Job Name String Name of the job. Current Current state of the job (DISABLED, RETRY SCHEDULED, SCHEDULED, RUNNING, String State COMPLETED, BROKEN, FAILED, REMOTE, SUCCEEDED, CHAIN_STALLED) Last Run String Status of the job run. Status Last Run String Last date on which the job started running. Date Last Run Numeric Amount of time the job took to complete during the last run (in seconds) Duration Next Run String Next date on which the job is scheduled to run. DateParameter Type Description Schedule Job Stats Job Name String Name of the job. Run Count Numeric Number of times the job has run. Failure Numeric Number of times the job has failed to run. Count Retry Numeric Number of times the job has retried, if it is retrying. Count Elapsed Numeric Elapsed time since the job was started (in seconds). Time Is Enabled String Indicates whether the job is enabled or not. MS SQL DB Servers Monitoring MS SQL Server - An Overview Creating a new MS SQL database monitor Monitored Parameters MS SQL Server - An Overview Applications Manager''s SQL Server monitoring feature helps database administrators monitor the performance and availability of production databases. It is an agentless monitoring solution that provides out-of-the-box performance metrics making sure that the SQL server runs efficiently. Creating a new MS SQL database monitor Supported Versions - Applications Manager supports monitoring of MS SQL 2000, 2005, 2008, 2008 R2, 2012, 2014, 2016, 2017 and 2019 versions. Prerequisites to create a new monitor: Click here To create a MS SQL database server Monitor, follow the given steps: Click on New Monitor link. Select MS SQL DB Server. Enter the IP Address or Hostname of the host. Enter the subnetmask of the network. Enter the Port number in which the MS SQL is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the User Name and Password of user who has permission to access the MS SQL database. The user name specified for collecting the data from MS SQL Server should have either System Administrator role or the user should be the DB owner for master database. Alternatively, you can provide the Windows Authentication details (give the User Name like domainname\username) also. Select the Enable Kerberos Authentication checkbox, if you want to monitor MS SQL server through Kerberos authentication. If you want to connect using a Named Instance, check the Connect using Named Instance checkbox and specify the instance name. Choose Force Encryption option if the server is configured for encrypted connections. Choose jTDS JDBC Driver or Microsoft JDBC Driver option in Driver for SQL Server Connection field to choose the required driver for connecting to the database for data collection. Choose the Monitor Group from the combo box with which you want to associate MS SQL database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers MS SQL database server from the network and starts monitoring them. Note: Applications Manager allows you to enable/disable data collection of the SQL Server Performance several metrics like Jobs, Backup and Replications . Once enabled, you can also customize the polling interval of these metrics. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on MS SQL under the Databases Table. Displayed is the MS SQL bulk configuration view distributed into three tabs:Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the MS SQL Database metrics listed under the following tabs: Overview Performance Database Sessions Jobs Backup/Restore Replication Users Configuration AlwaysOn Availability Groups SQL Server - Cluster Details Overview Parameters Description Name The name of MS SQL server monitor. Health The health (Clear, Warning, Critical) of the MS SQL server. Type The type you are monitoring. Version The version of the database server. ODBC Driver The ODBC driver version used. Version Instance Name Name of the SQL instance Port The port number at which the database server is running. Host Name The host at which the database server is running. Host OS The OS of the host where the database server is running. Last Alarm The last alarm that was generated for the database server. Last Polled at The time at which the last poll was performed. Next Poll at The time at which the next poll is scheduled. Availability Shows the current status of the server - available or not available. Percentage of pages found in the buffer cache without having to read from disk. If Buffer Buffer Cache Hit Cache Hit Ratio value is “high”, then SQL Server is efficiently caching the data pages in Ratio memory, reads from disk are relatively low, and so there is no memory bottleneck. It should be > 90% for a well performing server. This metric measures how much the plan cache is being used. A high percentage here means Plan Cache Hit that your SQL Server is not building a new plan for every query it is executing so is working Ratio effectively and efficiently. A low percentage here means that for some reason, the SQL Server is doing more work than it needs to. MEMORY USAGE Total Memory The total amount of dynamic memory the server is currently consuming. SQL Cache The total amount of dynamic memory the server is using for the dynamic SQL cache. Memory Lock Memory The total amount of dynamic memory the server is using for locks. Optimizer The total amount of dynamic memory the server is using for query optimization. Memory Connection The total amount of dynamic memory the server is using for maintaining connections. MemoryParameters Description Granted The total amount of memory granted to executing processes. This memory is used for hash, WorkSpace sort and create index operations. Memory Memory Grants The current number of processes waiting for a workspace memory grant. Pending Memory Grants The current number of processes that have successfully acquired a workspace memory grant. Success BUFFER MANAGER STATISTICS The percentage of pages that were found in the buffer pool without having to incur a read Buffer Hit Ratio from disk. Page The number of requests to find a page in the buffer pool. LookUps/Min Page Reads/Min The number of physical database page reads issued. Page Writes/Min The number of physical database page writes issued. Total Pages The number of pages in the buffer pool (includes database, free, and stolen). Database Pages The number of pages in the buffer pool with database content. Free Pages The total number of pages on all free lists. Page Life The number of seconds a page will stay in the buffer pool without references. Expectancy ACCESS METHOD DETAILS Full Scans/Min The number of unrestricted full scans. These can either be base table or full index scans. Range The number of qualified range scans through indexes. Scans/Min The number of probe scans. A probe scan is used to directly look up rows in an index or base Probe Scans/Min table. Work Files Displays the number of work files created per minute. These work files could be used to store Created/Min temporary results for hash joins and hash aggregates. Work Tables Displays the number of work tables created per minute. These work tables could be used to Created/Min store temporary results for query spool, LOB variables, XML variables, and cursors. Free Space Displays the number of scans per minute that were initiated to search for free space within Scans/Min pages already allocated to an allocation unit to insert or modify record fragments. Lazy Writes/Min Displays the number of buffers written by buffer manager''s lazy writer per minute. Scan point Displays the number of times the scan point had to be revalidated to continue the scan. Revalidation/Min Index Displays the number of index searches per minute. These index searches are used to start Searches/Min range scans, single index record fetches, and to reposition within an index. CACHE DETAILS This metric measures how much the plan cache is being used. A high percentage here means Plan Cache Hit that your SQL Server is not building a new plan for every query it is executing so is working Ratio effectively and efficiently. A low percentage here means that for some reason, the SQL Server is doing more work than it needs to. Total Log Cache Displays the overall total percentage of log cache reads that were satisfied from the log Hit Ratio cache. Cache Used/Min Displays the number of times each type of cache object has been used. Cache Count Displays the number of cache objects in the cache. Cache Pages Displays the number of 8k pages used by cache objects. LOCK DETAILS Lock The number of new locks and lock conversions requested from the lock manager. Requests/Min Lock Waits/Min The total wait time for locks in the last minute.Parameters Description Lock The number of lock requests that timed out. This includes internal requests for NOWAIT locks. Timeouts/Min Deadlocks/Min The number of lock requests that resulted in a deadlock. Average Lock The average amount of wait time for each lock request that resulted in a wait. Wait Time LATCH DETAILS The number of latch requests that could not be granted immediately and had to wait before Latch Waits/Min being granted. Average Latch The average latch wait time for latch requests that had to wait. Wait Time Performance Parameters Description TOP QUERIES BY CPU Avg. CPU Time Average CPU Time taken to execute the query. The cumulative total amount of CPU time that has been spent running this query since the plan Total CPU Time was compiled. Query The SQL Query Text. DB Name The database against which this query has been executed. Last Execution The last time at which the query started executing. Time Average Average time taken to execute an individual query. Execution Time TOP QUERIES BY I/0 Avg. Logical Average number of logical reads and logical writes performed by executions of this query. I/O The cumulative total number of logical reads and logical writes performed by executions of this Total I/O query since the plan was compiled. Query The SQL query text. The Database against which this query has been executed (will be empty for ad hoc and DB Name prepared batches). Last Execution The last time at which the query started executing. Time Average Average time taken to execute an individual query. Execution Time TOP QUERIES BY CLR (Top 10 queries having high CLR time (Common Language Runtime inside Microsoft .NET Framework). Average Time consumed inside Microsoft .NET Framework Common Language Runtime (CLR) Average CLR for executions of this query. The cumulative Total Time consumed inside Microsoft .NET Framework Common Language Total CLR Runtime (CLR) objects by executions of this query since the plan was compiled. DB Name The Database against which this query has been executed. Last Execution The last time at which the query started executing. Time Average Average time taken to execute an individual query. Execution Time Top Waits by Waiting Tasks Wait Type Indicates name of the wait type. Waiting Tasks Displays the number of waits on that particular wait type. Wait Time Total time in milliseconds for that particular type of wait. Average Wait Average time in milliseconds for that particular type of wait. TimeParameters Description Displays the difference between the time the waiting thread was signaled and when it started Signal Time running. Top Slow Running Queries Avg. Execution Average time taken for complete execution of this query. Time Maximum Maximum elapsed time for any complete execution of this query. Execution Time Minimum Minimum elapsed time for any complete execution of this query. Execution Time No of The number of times that the query has been executed since the plan was last compiled. Executions Query The SQL query text. The Database against which this query has been executed (will be empty for ad hoc and DB Name prepared batches). Object Name Returns the database object name for schema-scoped objects. Last Execution The last time at which the query started executing. Time Most Frequently Executed Queries Execution The number of times that the query has been executed since the plan was last compiled. Count Query The SQL query text. The Database against which this query has been executed (will be empty for ad hoc and DB Name prepared batches). Last Execution The last time at which the query started executing. Time Average Average time taken to execute an individual query. Execution Time Most Blocked Queries Average Time The average amount of time the query was blocked. Blocked Total Time The cumulative total amount of time for which the query was blocked. Blocked Query The SQL query text. DB Name The Database against which this query has been executed. Last Execution The last time at which the query started executing. Time Average Average time taken to execute an individual query. Execution Time Top Queries by Lowest Plan Reuse (Top 10 queries whose query plan are not cached by the SQL Server. Query plan will be cached by SQL Server for faster query execution.) Plan Usage Number of times this cache object has been used since its inception. Cache Object Type of object in the cache. (Possible Values : Compiled Plan / Compiled Plan Stub / Parse Tree Type / Extended Proc / CLR Compiled Func / CLR Compiled Proc). Query The SQL Query Text. The Database against which this query has been executed (will be empty for ad hoc and DB Name prepared batches). Last Execution The last time at which the query started executing. Time Average Average time taken to execute an individual query. Execution Time Cost of Missing Indexes (Displays information of the Top 10 missing indexes in the SQL Server. These indexes will have varying levels of impact on query performance. From this table, you can find out the most costly missing indexes across all the databases on the server and thus help finding out which missing indexes are likely to have the most significant impact on performance.)Parameters Description Overall cost of the queries executing without having the recommended indexes. It simply is a unit, the SQL Server Query Optimizer does its calculations with and is not associated with any type of known measurement unit like seconds or CPU time. Bigger the total cost number, more Total Cost the resources could be saved after creating the recommended index. You need to check the query execution plan before creating the index for these particular columns and you need not check any other details. Also note that every index has a negative impact on the inserts/updates/deletes on that table and this impact can not be measured. Displays the average percentage of benefit that the user queries could experience if this Avg. User missing index group was implemented. This value means that the query cost would on average Impact drop by this percentage if this missing index group was implemented. Displays the name of table (along with Database Name and Schema Name) in which the index Table Name is missing. Displays the column names for which Index is missing. These column names are used in Equality Usage equality predicates of the form: table.column = constant_value Displays the column names for which Index is missing. These column names are used in Inequality inequality predicates ( any comparison operator other than "=" ) of the form: table.column > Usage constant_value. Include Displays the column names for which Index is missing. These column names are Comma- Columns separated list of columns needed as covering columns for the query. Top Components by Memory Usage (Displays information about the various Memory clerks. Memory clerks allocates resource / memory to SQL memory object during times of need.) Component The type of memory clerk. Type Single The total amount of single page memory allocated in kilobytes (KB) directly from the buffer Pages(KB) pool. Its is the memory consumed by this component from the Buffer pool. Multi The total amount of multipage memory allocated in (KB) from outside the buffer pool. Pages(KB) Virtual Memory The total amount of virtual memory reserved directly by the component that uses this clerk. Reserved(KB) Virtual Memory The total amount of virtual memory that is committed by the memory clerk. This should be Committed(KB) always less than the amount of reserved memory. AWE Memory The total amount of memory that is allocated by the memory clerk by using Address Windowing Allocated(KB) Extensions (AWE). Shared The total amount of shared memory that is reserved by a memory clerk memory reserved for use Memory by shared memory and file mapping. Allocated(KB) Shared Memory The total amount of shared memory that is committed by the memory clerk. Committed(KB) Database Database Management Actions Applications Manager provides the ability to perform the following actions on your database(s). Parameters Description Online Changes the offline database(s) to online state. Changes the online database(s) to offline state. If there is any open connection in the database, Offline this action waits for the connection to be closed and then brings the database offline. Checks for open connections and changes the online database(s) to offline state only if all Offline with no connections are closed. This action returns error without waiting for existing connections to be wait closed. Offline with Changes the database(s) to offline state immediately and all incomplete transactions are rolled immediate back. rollback Offline with Waits for the specified period of time for the open connections to close and then brings the rollback after database offline. If there is any incomplete transactions even after specified period of time, the given time transactions will be rolled back.Parameters Description Delete Deletes the selected database(s) permanently from the server. Database Connection Detail Parameters Description Database Name Displays the name of the database. Login Name Displays the SQL user name connected to the database. No. of Connections Displays the number of connections currently open in the database. Parameters Description Database Details Name The Name of the database of the SQL server. Data File (MB) The data file size of the database of the SQL server. Used The total used space of the data file/log file of the SQL server. Free The total free space available in the data file/log file of the SQL server. Total The total alloted size of the data file/log file of the SQL server. Max size The maximum file size of the data file/log file of the SQL server upto which it can grow. Log File (MB) The log file size of the database of the SQL server Used The total used space of the data file/log file of the SQL server. Free The total free space available in the data file/log file of the SQL server. Total The total alloted size of the data file/log file of the SQL server. Max size The maximum file size of the data file/log file of the SQL server upto which it can grow. Total size (MB) The total file size of the entire database of the SQL server. Percentage Log The percentage of Log used of the database of the SQL Server. Used Availability The current availability of the database in the SQL Server. Health The current health of the database in the SQL Server. The current status of the database of the SQL Server.: ONLINE: Database is available for query. INACTIVE: Database is inactive as it is no longer accessed by any application for some time now. OFFLINE: Database was explicitly taken offline. Status RESTORING: Database is being restored. RECOVERING: Database is recovering and not yet ready for queries. SUSPECT: Database did not recover. EMERGENCY: Database is in an emergency, read-only state. Access is restricted to sysadmin member. Click on the database name to see further details: Parameters Description System Table Name - Name of the System Table. System Tables Total Rows - Total number of rows present in that table. Total Space Used in MB - Size of the table (MB). Parent Table – Table which contains the primary / parent column for the foreign key. Table Parent Column – The primary column for which a foreign exists. Relationship Foreign Table – Table name of foreign key column. Foreign Column – The foreign key column name.Parameters Description System Table Name - Name of the User Table. User Tables Total Rows - Total number of rows present in that table. Total Space Used in MB - Size of the table (MB). View Name - Name of the View. Schema Name - Schema Name to which this view is associated. IsIndexed - Shows if there is an index for the view ( 1 = Index Present, 0 = No Index ). View Details IsIndexable - Shows whether an index can be created ( 1 = Index can be created, 0 = No Index can be created ). Create Date - Date on which the view was created. Modify Date - Date on which the view was last modified. Table Name - Name of the Table. Index Name - Name of Index present in the table. Maximum Size Row - Maximum size for a row in that table (in bytes). Max Noleafindex Row - Maximum size of a nonleaf index row (in bytes). Index Details File Group Name - Name of the filegroup (Primary or User-defined). Column Name - Name of the column for which index is present. Type - Data type of the Column. Clustered Index - Shows if the index is a Clustered Index or not (Yes or No). A clustered index determines the physical order of data in a table. Indexes that Object Name – Name of the table in which the index is present. have not been Index Name – Name of the index which is not used. used Type – Type of the Index. Table Name - Name of the table in which the index is present Index Name - Name of Index present in the table Fragmentation Fragmentation Percent - Percentage of Logical fragmentation present in the Index. This is Details the percentage of out-of-order pages in the leaf pages of an index. The Percentage of Fragmentation should be as close to zero as possible for maximum performance. However, values from 0% through 10% may be acceptable Object Name – Name of the table in which the index is present. Schema Name – Schema Name to which this table is associated. Index Name – Name of the index which is not used. Indexes that Type – Type of the Index. have been used User Seeks - The number of seeks in this index by user queries. User Scans - The number of scans in this index by user queries. User Lookups - The number of bookmark lookups in this index by user queries. User Updates - The number of updates in this index by user queries. Note: The data file details of the database are updated once in an hour. You can also manually update each data file of the database by clicking on the ''Update Data/ Log File''. Parameters Description Database Disk Utilization Total Size The total disk space of all available data files(in MB). Used % The percentage of used disk space. Used MB The total disk space used by all data files (in MB). Free % The percentage of free/unused disk space. Free MB The free/unused disk space (in MB).Parameters Description Growth % The percentage at which all data files grow. Data File Details File Name Name of the data file. Total Size The total disk space of all available data files(in MB). Used % The percentage of used disk space. Used MB The total disk space used by all data files (in MB). Free % The percentage of free/unused disk space. Free MB The free/unused disk space (in MB). Growth % The percentage at which all data files grow. Growth Rate The rate at which the data files grow. Maximum size The maximum size (in MB) up to which the data file can grow. Log File Details File Name Name of the log file Total Size The total disk space of all available log files(in MB). Used % The percentage of used disk space. Used MB The total disk space used by all log files (in MB). Free % The percentage of free/unused disk space. Free MB The free/unused disk space (in MB). Growth % The percentage at which all log files grow. Growth Rate The rate at which the log files grow. Maximum size The maximum size (in MB) up to which the log file can grow. Transaction Details Transactions/Min Number of transactions started for the database per minute. Active Number of transactions that''s currently executing. Transactions Replication Number of replication transactions per minute. Transactions/Min Bulk Copy Number of rows bulk copied. Rows/Min Bulk Copy Amount of KiloBytes bulk copied. Throughput/Min Backup/Restore Read/write throughput for backup/restore of a database. Throughput/Min Log Cache Reads performed through the log manager cache. Reads/Min Log Flush Details Log Flush/Min Number of log flushes Log Flush Number of commits waiting on log flush Waits/Min Log Flush Wait Total wait time (milliseconds) Time Log Cache Hit The log cache hit ratio file size. Ratio VLF Details The number of VLFs (Virtual Log Files) created. A transaction log is split internally into smaller Number of VLFs chunks called virtual log files. A large number of VLFs can cause degradation in performance when transaction log backups occur or in any transaction log related activities. FileID Physical log file identifier from sysfiles FileSize Virtual log file size ( in bytes ) StartOffset Beginning point of the virtual log fileParameters Description FSeqNo Virtual log file''s sequence number Whether the virtual file contains the active part of the transaction log. 0 means that virtual file Status does not contain the active portion of the log and it is available for log use ; 2 means that VLF is active Parity Parity information for virtual log file CreateLSN Log sequence number that began the virtual log file. Database Properties Creation Date Date in which the Database was created. Database Mode The recovery model for the database which shows how transactions are logged. Page Verify The option used to discover and report incomplete I/O transactions caused by disk I/O errors. Compatibility The latest version of SQL Server that the database supports. The values are SQL Server 2014 Level (120), SQL Server 2012 (110), and SQL Server 2008 (100). Auto Shrink Indicates whether the database files are available for periodic shrinking. Auto Create Indicates whether the database automatically creates missing optimization statistics. Statistics Auto Update Indicates whether the database automatically updates out of date optimization statistics. Statistics DBCC Information DBCC CHECKDB Shows when the DBCC CHECKDB command was issued last. DBCC Shows when the DBCC INDEXDEFRAG command was issued last. INDEXDEFRAG Database Mirroring Details Applications Manager provides the option to monitor mirroring details of SQL databases. You can monitor attributes like Mirroring role, Status, Mirroring partner details,Witness details, Unsent log available in Send Queue, Current send rate, Time to restore log and more. Parameters Description Mirroring Role- Displays the role of the mirroring database. The possible values are: Principal Mirror Mirroring Status - Displays the status of mirroring process. The possible values are Synchronized, Synchronizing, Suspended, Pending failover, Disconnected. Transaction Safety - Displays whether the mirroring operates in synchronous or Mirroring asynchronous mode. Details Mirroring Partner - Displays the server name of the mirroring partner. Mirroring Partner Connection - Displays the connection string of the mirroring partner server. Witness Status - Displays the status of witness connection. The possible values are Connected, Unknown, Disconnected. Witness Connection - Displays the connection string of the witness server. Witness Address - Displays the name of the witness server Unsent Log (in KB) - Displays the unsent logs that are in the Send Queue. Oldest Unsent Transaction (DD:HH:mm:ss) - Displays the estimated time of transaction pending in the Send Queue. Time to send log (DD:HH:mm:ss) - Displays the estimated time that takes to send the log to Principal Log the mirror server. Current Send Rate - Displays the current send rate in KB/Sec. Current Rate of new transactions - Displays the rate of new transactions entered in the principal server in KB/Sec.Parameters Description Unrestored log - Displays the amount of log waiting in the redo queue in KB/Sec. Time to restore log (DD:HH:mm:ss) - Displays the estimated amount of time that takes to Mirror Log restore the log to the mirroring database. Current restore rate - Displays the current restore rate in KB/Sec Mirror Commit Overhead - Displays the amount of overhead incurred in milliseconds while the principal server instance waits for the mirror server instance to write the transaction''s Mirroring log record into the redo queue. session Time to send and restore log (DD:HH:mm:ss) - Displays the time needed to send and restore the transactions committed in the principal database. For Principal database : Logs Sent KB/Min - The number of logs sent per minute. Log Send Queue KB - Total kilobytes of log that have not yet been sent to the mirror server. Average Delay/Transaction (ms) - The delay (in milliseconds) in waiting for commit acknowledgement from the mirror. This reports the approximate delay for a single Mirroring transaction in process at that time. Performance Counters For Mirror database : Logs Redo KB/Min - The amount of transaction log applied on the mirror database per minute. Redo Queue KB - Total kilobytes of hardened log that remain to be applied to the mirror database to roll it forward. Sessions Parameters Description Connection Statistics The time taken to connect to the Microsoft SQL database server from Applications Connection Time Manager server. Active Connections Number of users connected to the system. Logins/Min Total number of logins started per minute. Logouts/Min Total number of logouts started per minute. Blocked Sessions Number of sessions that are blocked. SQL Statistics Batch Requests/Min Number of SQL batch requests received by server. SQL Compilations/Min Number of SQL compilations. SQL Number of SQL re-compiles. Recompilations/Min AutoParams/Min Number of auto-parameterization attempts. Failed AutoParams/Min Number of failed auto-parameterizations. Host Details Host Connected to the Displays the hosts name connected to the SQL server. SQL No. of Connections Displays the number of connections each host has to the SQL server. Memory Usage Displays the total memory usage by each host connected to the SQL server. CPU Time (ms) Displays the total CPU time (in milliseconds) of each host connected to the SQL server. I/O The cumulative Disk reads and writes for the process running in the SQL Server. Database Connection Detail Database Name Displays the name of the database. Login Name Displays the SQL user name connected to the database.Parameters Description No. of Connections Displays the number of connections currently open in the database. You can find the list of sessions, lock and block running for the selected database. Parameters Description Database Name The name of the database. Agent Type The type of agent - Backup, Copy or Restore. Status The status of the database log shipping - Starting, Running, Success, Error, Warning. Time Elapsed (in min) The total time taken to run the log shipping operation. Log Time The time and date last log shipping operation. Error Log Time The time of the last error log shipping operation ran. Error Message The error messages received while running the log shipping operation if any. Session Details Parameters Description PID Displays the SQL server session ID running in SQL Server. Displays the status of the process in SQL Server. The possible values are: Dormant : SQL Server session that hasn''t done any work in more than an hour. Running : SQL Server session running one or more batches. A session can run multiple batches when Multiple Active Result Sets (MARS) is enabled. Background : SQL Server session running a background task, such as deadlock detection. Rollback : SQL Server session which has a transaction rollback in process. Status Pending : SQL Server session waiting for a worker thread to become available. Runnable : The task in SQL Server session which is in the runnable queue of a scheduler while waiting to get a time quantum. Spinloop : The task in SQL Server session waiting for a spinlock (Spinlock is a lock where the thread waits in a loop, repeatedly checking until the lock becomes available) to become free. Suspended : SQL Server session is waiting for an event, such as I/O, to complete. User Name The login name used for executing the process. Host The host machine name from where the session has been established from. DB Name Displays the name of the database currently being used by the process. Program The application in SQL Server which has established the session. Memory The number of pages in the procedure cache that are currently allocated to this process (in KB). Usage CPU Time The cumulative CPU time for the process running in the SQL Server (in ms). I/O The cumulative Disk reads and writes for the process running in the SQL Server. Session Blocked Amount of time elapsed after the session was blocked (in seconds). Time Displays the ID of the session that is blocking the request. If this column is 0, then the request is not blocked, or the session information of the blocking session is not available (or cannot be identified). Blocking If value is -2, then the blocking resource is owned by an orphaned distributed transaction. Session If value is-3, then the blocking resource is owned by a deferred recovery transaction. If value is -4, then the Session ID of the blocking latch owner could not be determined due to internal latch state transitions. Kill Allows you to kill the session of the selected database. SQL Session Blocked Lock Details On clicking ''View More'', following details will be displayed: Parameters DescriptionParameters Description Holding ID The Blocked sessions ID. The status of the process in SQL Server. The possible values are: Dormant : SQL Server session that hasn''t done any work in more than an hour. Running : SQL Server session running one or more batches. A session can run multiple batches when Multiple Active Result Sets (MARS) is enabled. Background : SQL Server session running a background task, such as deadlock detection. Rollback : SQL Server session which has a transaction rollback in process. Status Pending : SQL Server session waiting for a worker thread to become available. Runnable : The task in SQL Server session which is in the runnable queue of a scheduler while waiting to get a time quantum. Spinloop : The task in SQL Server session waiting for a spinlock (Spinlock is a lock where the thread waits in a loop, repeatedly checking until the lock becomes available) to become free. Suspended : SQL Server session is waiting for an event, such as I/O, to complete. Lock Type The type of Lock. Command Displays the command that is being currently executed. Name Query Displays the query for the selected database session. Hold User The user the Lock. Wait User The blocked user waiting for the Lock. DB Name The Name of the database being used by the process. Object ID The Object ID associated with the resource. Hold Host The host machine holding the Lock. Wait Host The Blocked Host waiting the Lock. Host The Command being executed by the process holding the Lock. Command Wait The Command to be executed by the process waiting for the Lock. Command Memory The number of pages in the procedure cache that are currently allocated to this process. Usage Wait Time The time, in milliseconds, in which this task is waiting for a resource. When the task is not waiting, (ms) the wait time is 0. Last Wait The name of the last wait type. Type Wait The name of the resource that is needed. Resource Jobs Applications Manager also allows you to easily manage these Jobs and Backup processes in bulk. Just select the Job(s) you wish to manage and then select any one of the option ( ''Start Job, Stop Job, Delete Job, Enable Job, Disable Job, Manage, Unmanage, Unmanage and Reset'') from the pull-down menu. Create a new Job You can also create a job right from Applications Manager console. To do so, follow the steps given below: Click on ''Create job'' link. Provide Job Name, select the Owner from the pull-down menu, select the Category and the Description. You can also set the status as either ''Enable'' or ''Disable'' if you choose to run the Job later. Provide the Step Name, Type, Run As, Database on which it should run, enter the SQL Command you wish to execute. You can repeat this process to add ''n'' number of steps. You can also edit them at a later stage or even delete a step if found not required. Set the action On Success Action either as ''Go to the next step'' or ''Quit the job reporting success'' or ''Quit the job reporting failure''. Set the Retry attempts and Retry interval (minutes). Set the action On Failure Action either as ''Quit the job reporting failure'' or ''Go to the next step'' or ''Quit the job reporting success''.If you like to schedule the job, click on Schedule and provide the following information. Provide a Name for the schedule job. Select the Frequency at which you want the job to be executed : Daily / Weekly / Monthly. If its Daily, then choose the occurrence at which you want this job to run daily: Occurs once / Multiple Times. If it Occurs once, provide the time (hh:mm). Also select the date from which the job needs to run. If the frequency is Weekly, choose the days on which you want this job to run and provide whether it recurring every ''nth'' weeks. If the frequency is Monthly, choose the nth day of every nth month or select whether it should run on ''nth'' day of every ''nth'' week of every nth month. If you like to receive/send notifications of these jobs, click on Notifications, and select Email notification when the job either succeeds, fails or finishes to the appropriate operator. If the operator name is not specified, then select ''New Operator'' and provide the Name and Email ID of the same. You can also set notification and allow jobs to be written into Windows Event Log files when it succeeds, fails or finishes. The Jobs tab displays the performance metrics of various Jobs history running in SQL Server. You will be able to view SQL Job''s history when you click on the corresponding SQL Job from Job History table. This will show the step by step job execution history for that corresponding job in a pop-up window. Note: Applications Manager allows you to enable/disable data collection of the SQL Server Performance several metrics like Jobs, Backup and Replications . Once enabled, you can also customize the polling interval of these metrics. Parameters Description Job Name Name of the SQL Job Current Execution Status The status of the job execution in each step. Last Run Status Gives the last run status of the job Run Date & Time Gives the date & time for which the jobs are scheduled to run. Job Time (in seconds) Elapsed time in seconds for the execution of the job or step. Retries Attempted Gives the number of times the scheduled jobs attempted to run. Backup/Restore Details Backup Details Parameters Description DB Name Displays the name of the database involved in the backup operation. Start Displays the date and time of the back up operation started. End Displays the date and time of the back up operation ended. Expiration Displays the date and time the back up operation is supposed to expire. If the value is 1, then it means that the damage to database was detected while this back up was Damaged being created. However the back up operation continued despite the errors. Size Displays the size of the back up set (in bytes). Physical Displays the physical name of the back up device. Name Backup Age Displays the number of hours passed since the back up operation was completed. (Hours) Note: Applications Manager allows you to enable/disable data collection of the SQL Server Performance several metrics like Jobs, Backup and Replications . Once enabled, you can also customize the polling interval of these metrics. Restore Details Parameters Description DB Name Displays the name of the destination database for which the restore operation operate upon. Restore by Displays the name of the user who performed the restore operation on the database.Parameters Description Restore Displays the type of restore operation performed which could be either Database / File / Filegroup Type / Log / Verifyonly / Differential / Revert. Started Displays the date and time of the restore operation. Restore Displays the physical name of the backup file created. From Restore To Displays the name of the file where the backup was restored to. Replication Log Shipping Status Parameters Description Database Primary Name of the primary database. Secondary Name of the secondary database. Status Backup Status of the backup session. (Starting, Running, Success, Error, or Warning) Copy Status of the copy session. (Starting, Running, Success, Error, or Warning) Restore Status of the restore session. (Starting, Running, Success, Error, or Warning) Time since Amount of time elapsed since the last log backup (in minutes). Backup Time since Amount of time elapsed since the last log backup was copied (in minutes). Copy Time since Amount of time elapsed since the last log backup was restored (in minutes). Restore Restore Amount of time that elapsed between when the log backup was created on the primary database Latency and when it was restored on the secondary databases (in minutes). Log Shipping Role Parameters Description Primary Server Agent Type Type of the log shipping job. (Backup) Secondary Server(s) Name of the secondary instance(s) of MS SQL in the log shipping configuration. Backup File The filename of the last backup file. Backup Time The time and date of the last backup operation ran. Backup Error Log Time Date and time at which the error occurred during backup operation. Backup Error Message Displays the error messages received while running the backup operation if any. Secondary Server Agent Type Type of the log shipping job. (Copy or Restore) Copied File The filename of the last backup file that was copied to the secondary server. Copied Time The time and date of the last copy operation to the secondary server. Copy Error Log Time Date and time at which the error occurred during copy operation. Copy Error Message Displays the error messages received while running the copy operation if any. Restored File The filename of the last backup file that was restored to the secondary server. Restored Time The time and date of the last restore operation on the secondary database. Restore Error Log Time Date and time at which the error occurred during restore operation. Restore Error Message Displays the error messages received while running the restore operation if any. Replication Status Note:The Distributor is the same SQL Server as the Publisher, or can be a separate SQL Server from the Publisher. As Applications Manager monitors publication and subscription metrics from the distributor server, add the distributor SQL server as a monitor. The SQL user used for monitoring must be given read access to the distribution database present in the distributor. Publications This table displays status information for all publications available in the corresponding SQL monitor. Parameters Description Status The status of each publication. Publication Name of the publication Type Type of the publication No. of Subscriptions Number of subscriptions associated with the corresponding publication. Synchronizing The number of distribution agents running for the publication. Current Average Performance Current average performance of the replication based on the latency. Current Worst Performance Current worst performance of the replication based on the latency. Subscriptions Applications Manager provides information about subscriptions available in the corresponding monitor. Parameters Description Running status Status of each subscription. Subscription Name of the subscription Publication Name of the publication running the corresponding subscription. Performance Performance of the subscription. Latency Latency value Shows expiring status of the subscription which can be one of the following Expired Expiration Status Expiring soon Critical Replication Agents Replication Agents tab displays information about each replication agent running in the corresponding monitor. Parameters Description Agent Name Name of the agent involved in the replication Agent Type Type of the agent Current Status Current status of the agent [Database]. Name of the publisher [Publication] Last Start Time Last start time of the agent Duration Duration of the agent session. (HH:mm:ss) Delivary Rate Ratio of delivered commands to the duration of the agent. (cmds/sec) The current amount of time, in milliseconds, elapsed from when transactions are applied at the Latency Publisher to when they are delivered to the distributor. #Trans The number of transactions delivered to the distributor. #Cmds The number of commands delivered to the distributor. Avg #Cmds The average number of commands per transaction delivered to the distributor for the session. Replication Agent History TableDisplays the performance metrics of various agents history running in SQL server. You will be able to view replication agent''s history when you click on the corresponding agent from Agent Details table. This will show the step by step agent execution history for that corresponding agent in a pop-up window. Parameters Description Current status Current status of the agent Last start time Last start time of the agent Duration (HH:mm:ss) Duration of the agent session. Last Action Displays the last action message of the agent. Users ManageEngine Applications Manager User Details section displays the entire list of active users of SQL servers. It displays the Username, Status, Login Type, Default DB and Creation Date. The DBA can also, quite easily, perform actions to the selected list of users such as Enable User, Disable User and Delete User. Parameters Description User Details User Name Name of the user. Status Status of the user. Login Type Type of login made by the user. Default DB Default database name accessed by the user. Creation Date Timestamp at which the user was created. Configuration You can manage and optimize SQL Server resources using configuration options in Applications Manager. Optimizing these resources can have a significant effect on SQL Server''s behavior and performance. Applications Manager lists all available configuration options, the range (minimum and maximum value) of possible settings, and configuration values. Parameters Description Configuration Details Name Name of the configuration option Minimum Minimum range of configuration value Maximum Maximum range of configuration value Configured The value currently configured to the server. For few options, this value takes effect for use only value after restarting the SQL instance Value in use The value currently in use for the server Advanced options will be available or changed only when the ''show advanced option'' is set to 1. You can enable these options in the following two ways: Click on the link ''Enable Advanced options'' (or) Change the value of show advanced options to 1. For some of the configuration options, the changes take effect only after restarting the SQL instance.The values used for the parameters Configured value and Value in use columns should match for a dynamically updated option. Options that require SQL Server to restart will initially show the changed value only in the Configured value column. After restart, the new value will appear in both the Configured value column and the Value in use column. For example, the minimum and maximum server memory options are updated dynamically in the Database Engine; therefore, you can change them without restarting the server. Note: Only users with Administrator / Operator with permission can edit the SQL Server Configuration Settings. Parameters DescriptionParameters Description access check The Access check cache bucket count option controls the number of hash buckets used for cache bucket access check result cache. The default value - 0 indicates that SQL Server is managing these count* options. access check The access check cache quota option controls the number of entries used for access check cache quota* result cache. The default value - 0 indicates that SQL Server is managing these options. Ad Hoc By default, SQL Server does not allow ad hoc distributed queries. When this option is set to 1, SQL Distributed Server allows ad hoc access. When this option is not set or is set to 0, SQL Server does not allow Queries* ad hoc access. The value for affinity I/O mask specifies which CPUs in a computer are eligible to process SQL Server disk I/O operations. The values for affinity I/O mask are as follows: A 1-byte affinity I/O mask covers up to 8 CPUs in a multiprocessor computer. affinity I/O A 2-byte affinity I/O mask covers up to 16 CPUs in a multiprocessor computer. mask* A 3-byte affinity I/O mask covers up to 24 CPUs in a multiprocessor computer. A 4-byte affinity I/O mask covers up to 32 CPUs in a multiprocessor computer. To cover more than 32 CPUs, configure a four-byte affinity I/O mask for the first 32 CPUs and up to a four-byte affinity64 I/O mask for the remaining CPUs. The affinity mask option dynamically controls CPU affinity. The values for affinity mask are as follows: A one-byte affinity mask covers up to 8 CPUs in a multiprocessor computer. affinity A two-byte affinity mask covers up to 16 CPUs in a multiprocessor computer. mask* A three-byte affinity mask covers up to 24 CPUs in a multiprocessor computer. A four-byte affinity mask covers up to 32 CPUs in a multiprocessor computer. To cover more than 32 CPUs, configure a four-byte affinity mask for the first 32 CPUs and up to a four-byte affinity64 mask for the remaining CPUs. affinity64 I/O The affinity64 I/O mask binds SQL Server disk I/O to a specified subset of CPUs. This option is mask* only visible on the 64-bit version of SQL Server. affinity64 The affinity64 mask binds processors to specific threads. This option is only visible on the 64-bit mask* version of SQL Server. Use the Agent XPs option to enable the SQL Server Agent extended stored procedures on this server. The possible values are: 0 - indicating that SQL Server Agent extended stored procedures are not available (the Agent XPs* default). 1 - indicating that SQL Server Agent extended stored procedures are available. The setting takes effect immediately without a server stop and restart. allow This option is still present in the sp_configure stored procedure, although its functionality is updates unavailable in SQL Server. awe You can use the Address Windowing Extensions (AWE) API to provide access to physical enabled* memory in excess of the limits set on configured virtual memory. backup Used by the BACKUP Transact-SQL statement to select the backup compression setting if a user compression does not specify WITH COMPRESSION or WITH NO_COMPRESSION. Used in SQL Server 2008 default Enterprise and later only. Default backup compression is set to 0 blocked Use the blocked process threshold option to specify the threshold, in seconds, at which blocked process process reports are generated. The threshold can be set from values 0 to 86,400. threshold (s)* c2 audit This option will configure the server to record both failed and successful attempts to access mode* statements and objects. Use the clr enabled option to specify whether user assemblies can be run by SQL Server. Possible values are as follows: clr enabled 0 - Assembly execution not allowed on SQL Server 1 - Assembly execution allowed on SQL ServerParameters Description cost The cost threshold for parallelism option specifies the threshold at which Microsoft SQL Server threshold for creates and runs parallel plans for queries. The cost threshold for parallelism option can be set to parallelism* any value from 0 through 32767. Use the cross db ownership chainingoption to configure cross-database ownership chaining for an instance of Microsoft SQL Server. Possible Values are : cross db 0 - cross db ownership chaining is off for the instance, cross-database ownership chaining is ownership disabled for all databases. chaining 1 - cross db ownership chaining is on for the instance, cross-database ownership chaining is on for all databases. The cursor threshold optionspecifies the number of rows in the cursor set at which cursor keysets are generated asynchronously. Possible Values are: cursor threshold* 1 - all keysets are generated synchronously. 0 - all cursor keysets are generated asynchronously. The Database Mail XPs option enables Database Mail on this server. Possible values are: Database 0 - Database Mail is not available (default). Mail XPs* 1 - Database Mail is available. default full- The default full-text language option specifies a default language value for full-text indexed text columns. The default value of this option is the language of the server and requires an LCID value. language* default The default language option to specify the default language for all newly created logins. language default trace The default trace enabled option enables or disables the default trace log files. enabled* This option controls whether triggers return result sets. disallow When set to 1 (ON) any attempt by a trigger to return a result set fails, and the user receives results from an error message triggers* The default setting for this option is 0 (OFF). Use the filestream access leveloption to change the FILESTREAM access level for this instance of SQL Server. Possible values are: filestream 0 - Disables FILESTREAM support for this instance. access level 1 - Enables FILESTREAM for Transact-SQL access. 2 - Enables FILESTREAM for Transact-SQL and Win32 streaming access. The fill factor option specifies how full Microsoft SQL Server should make each page when it fill factor (%)* creates a new index using existing data. The ft crawl bandwidth option specifies the size to which the pool of large memory buffers can ft crawl grow. The max parameter value specifies the maximum number of buffers that the full-text bandwidth memory manager should maintain in a large buffer pool. If the max value is zero, then there is no (max)* upper limit to the number of buffers that can be in a large buffer pool. The ft crawl bandwidth option specifies the size to which the pool of large memory buffers can ft crawl grow. The min parameter specifies the minimum number of memory buffers that must be bandwidth maintained in the pool of large memory buffers. Upon request from the Microsoft SQL Server (min)* memory manager, all extra buffer pools will be released but this minimum number of buffers will be maintained. If, however, the min value specified is zero, then all memory buffers are released. The ft notify bandwidth option specifies the size to which the pool of small memory buffers can ft notify grow. The max parameter value specifies the maximum number of buffers that the full-text bandwidth memory manager should maintain in a small buffer pool. If the max value is zero, then there is no (max)* upper limit to the number of buffers that can be in a small buffer pool.Parameters Description The in-doubt xact resolutionoption controls the default outcome of transactions that the Microsoft Distributed Transaction Coordinator (MS DTC) is unable to resolve. Inability to resolve transactions may be related to the MS DTC down time or an unknown transaction outcome at the time of recovery. Possible Values are : in-doubt xact resolution* 0 - No presumption. Recovery fails if MS DTC cannot resolve any in-doubt transactions. 1 - Presume commit. Any MS DTC in-doubt transactions are presumed to have committed. 2 - Presume abort. Any MS DTC in-doubt transactions are presumed to have aborted. The index create memory option controls the maximum amount of memory initially allocated for index create creating indexes. If more memory is later needed for index creation, and the memory is available, memory the server will use it, thus exceeding the setting of this option. If additional memory is not (KB)* available, the index creation will continue using the memory already allocated. The default value for this option is 0 (self-configuring). The lightweight pooling option provides a means of reducing the system overhead associated lightweight with the excessive context switching seen in symmetric multiprocessing (SMP) environments. pooling* Possible Values:1 - causes SQL Server to switch to fiber mode scheduling. The default value for this option is 0. The locks option to set the maximum number of available locks, thereby limiting the amount of memory used. Possible Values: 0 (Default) - allows the Database Engine to allocate and locks* deallocate lock structures dynamically, based on changing system requirements. When locks is not set to 0, lock escalation occurs when the number of locks reaches 40 percent of the value specified for locks. You can use the max degree of parallelism option to limit the number of processors to use in parallel plan execution. Possible Values: max degree 0 default value - allows SQL Server to use all the available processors up to 64 processors. of 1 - To suppress parallel plan generation parallelism* greater than 1 - to restrict the maximum number of processors used by a single query execution. The max full-text crawl range option optimizes CPU utilization; you can specify the number of max full-text partitions that Microsoft SQL Server should use during a full index crawl. The default value of this crawl range* option is 4; the minimum value is 1, and the maximum value is 256. max server Use the max server memory option to reconfigure the amount of memory (in megabytes) that is memory managed by the SQL Server Memory Manager for a SQL Server process used by an instance of (MB)* SQL Server. The max text repl size option to specify the maximum size (in bytes) of text, ntext, varchar(max), max text repl nvarchar(max), varbinary(max), xml, and image data that can be added to a replicated column or size (B) captured column in a single INSERT, UPDATE, WRITETEXT, or UPDATETEXT statement. The default is 65536. A value of -1 indicates no limit, other than the limit imposed by the data type. The max worker threads option is used to configure the number of worker threads available to max worker Microsoft SQL Server processes. 0(default value)- allows SQL Server to automatically configure threads* the number of worker threads at startup. This setting is best for most systems. The media retention option provides a system-wide default for the length of time to retain each media backup set. This option helps protect backups from being overwritten until the specified number retention* of days has elapsed. The default is 0 days. min memory The min memory per query option specifies the minimum amount of memory (in kilobytes) that per query will be allocated for the execution of a query. (KB)* min server The min server memory option is used to reconfigure the amount of memory (in megabytes) that memory is managed by the SQL Server Memory Manager for a SQL Server process used by an instance of (MB)* SQL Server. The default setting for min server memory is 0. Use the nested triggersoption to control whether a trigger can cascade (perform an action that initiates another trigger that initiates another trigger, and so on). Possible values: nested triggers 0 - triggers cannot cascade. 1 - triggers can cascade to as many as 32 levels. network The network packet size option to set the packet size (in bytes) used across the entire network. If packet size an application sends and receives small amounts of information, the packet size can be set to 512 (B)* bytes, which is sufficient for data transfers.Parameters Description Use the Ole Automation Procedures option to specify whether OLE Automation objects can be Ole instantiated within Transact-SQL batches. Possible Values: Automation 0 - OLE Automation Procedures are disabled. Default for new instances of SQL Server. Procedures* 1 - OLE Automation Procedures are enabled. This option is still present in sp_configure, although its functionality has been disabled in open Microsoft SQL Server. (The setting has no effect.) In SQL Server, the number of open database objects* objects is managed dynamically and is limited only by the available memory. The open objects option available in sp_configure for backward compatibility with existing scripts. The optimize for ad hoc workloads option is used to improve the efficiency of the plan cache for optimize for workloads that contain many single use ad hoc batches. When this option is set to 1, the Database ad hoc Engine stores a small compiled plan stub in the plan cache when a batch is compiled for the first workloads* time, instead of the full compiled plan. The PH timeout option to specify the time, in seconds, that the full-text protocol handler should PH timeout wait to connect to a database before timing out. The default value is 60 seconds. Increase the ph (s)* timeout value when connection attempts are timing out due to temporary network issues. The precompute rank server-level advanced option to improve the performance of FREETEXTTABLE queries that specify the top_n_by_rank parameter. When the option is set to 1, precompute FREETEXTTABLE queries specified with top_n_by_rank use precomputed rank data stored in the rank* full-text catalogs. When you use precomputed rank data, the result set that is returned by top_n_by_rank may not contain the same results as those that are returned when the precompute rank option is set to 0. Use the priority boostoption to specify whether Microsoft SQL Server should run at a higher Microsoft Windows 2000 or Windows 2003 scheduling priority than other processes on the same computer. Possible Values: priority boost* 1 - SQL Server runs at a priority base of 13 in the Windows 2000 or Windows Server 2003 scheduler. 0 (default) - A priority base of 7. Use the query governor cost limit option to specify an upper limit on the time period in which a query query can run. If you specify a nonzero, nonnegative value, the query governor disallows execution governor of any query that has an estimated cost exceeding that value. Specifying 0 (the default) for this cost limit* option turns off the query governor, and all queries are allowed to run without any time limitation. The query wait option specifies the time in seconds (from 0 through 2147483647) that a query query wait waits for resources before timing out. If the default value of -1 is used, or if –1 is specified, then (s)* the time-out is calculated as 25 times of the estimated query cost. Use the recovery interval option to set the maximum number of minutes per database that recovery Microsoft® SQL Server™ needs to recover databases. Keep recovery interval set at 0 (self- interval configuring) unless you notice that checkpoints are impairing performance because they are (min)* occurring too frequently. If this is the case, try increasing the value in small increments. Use the remote accessoption to control the execution of stored procedures from local or remote servers on which instances of Microsoft SQL Server are running. Possible Values: remote 0 - to prevent local stored procedures from being run from a remote server or remote stored access procedures from being run on the local server. 1 (default) - to grant permission to run local stored procedures from remote servers or remote stored procedures from the local server SQL Server provides a dedicated administrator connection (DAC). The DAC lets an administrator access a running server to execute diagnostic functions or Transact-SQL statements, or to remote troubleshoot problems on the server, even when the server is locked or running in an abnormal admin state and not responding to a SQL Server Database Engine connection. Possible Values: connections 0 - Indicates only local connections are allowed by using the DAC. 1 - Indicates remote connections are allowed by using the DAC. Use the remote login timeout option to specify the number of seconds to wait before returning remote login from a failed attempt to log in to a remote server. The default setting for remote login timeout is timeout (s) 20 seconds. A value of 0 allows for an infinite wait. remote proc The remote proc trans option protects the actions of a server-to-server procedure through a trans Microsoft® Distributed Transaction Coordinator (MS DTC) transaction.Parameters Description Use the remote query timeout option to specify how long (in seconds) a remote operation can remote query take before Microsoft SQL Server times out. The default value is 600, which allows a 10-minute timeout (s) wait. Replication This option is for internal use only. XPs* The scan for startup procsoption to scan for automatic execution of stored procedures at scan for Microsoft SQL Server startup time. Possible Values: startup 1 - SQL Server scans for and runs all stored procedures defined on the server. procs* 0 (default value) - do not scan The server trigger recursionoption specifies whether to allow server-level triggers to fire recursively. Possible values: server trigger recursion 1 (ON) - server-level triggers will be allowed to fire recursively. 0 (OFF)- server-level triggers cannot be fired recursively. The set working set size option to reserve physical memory space for SQL Server that is equal to set working the server memory setting. Before setting set working set size to 1, set both min server memory set size* and max server memory to the same value, the amount of memory you want SQL Server to use. show The show advanced options option to display the sp_configure system stored procedure advanced advanced options. When you set show advanced options to 1, you can list the advanced options options by using sp_configure. The default is 0. Use the SMO and DMO XPs option to enable SQL Server Management Object (SMO) extended stored procedures on this server. Possible Values are: SMO and DMO XPs* 0 - SMO XPs are not available. 1 - SMO XPs are available. This is the default. Use the SQL Mail XPs option to enable SQL Mail on this server. The possible values are: SQL Mail 0 indicating SQL Mail is not available (default) XPs* 1 indicating SQL Mail is available Use the transform noise wordsserver configuration option to suppress an error message if noise words/stopwords, cause a Boolean operation on a full-text query to return zero rows. Possible Values: transform noise words* 0-Noise words (or stopwords) are not transformed. 1-Noise words (or stopwords) are transformed. They are ignored, and the rest of the query is evaluated two digit The two digit year cutoff option to specify an integer from 1753 to 9999 that represents the year cutoff* cutoff year for interpreting two-digit years as four-digit years. user The user connections option specifies the maximum number of simultaneous user connections connections* allowed. The User Instance Timeout option that you can access through sp_configure is not supported in user instance Microsoft SQL Server 2008. This option works only with SQL Server 2008 Express (SQL Server timeout* Express). user The user instance enabled option that you can access through sp_configure is not supported in instances Microsoft SQL Server 2008. This option works only with SQL Server 2008 Express (SQL Server enabled Express).Parameters Description The user options option specifies global defaults for all users. The user optionsoption allows you to change the default values of the SET options (if the server''s default settings are not appropriate). Possible Values: 1- DISABLE_DEF_CNST_CHK - Controls interim or deferred constraint checking. 2- IMPLICIT_TRANSACTIONS - For dblib network library connections, controls whether a transaction is started implicitly when a statement is executed. The IMPLICIT_TRANSACTIONS setting has no effect on ODBC or OLEDB connections. 4 - CURSOR_CLOSE_ON_COMMIT - Controls behavior of cursors after a commit operation has been performed. 8 - ANSI_WARNINGS - Controls truncation and NULL in aggregate warnings. 16 - ANSI_PADDING - Controls padding of fixed-length variables. 32 - ANSI_NULLS - Controls NULL handling when using equality operators. 64 - ARITHABORT - Terminates a query when an overflow or divide-by-zero error occurs during query execution. 128 - ARITHIGNORE - Returns NULL when an overflow or divide-by-zero error occurs during a user options query. 256 - QUOTED_IDENTIFIER - Differentiates between single and double quotation marks when evaluating an expression. 512 - NOCOUNT - Turns off the message returned at the end of each statement that states how many rows were affected. 1024 - ANSI_NULL_DFLT_ON - Alters the session''s behavior to use ANSI compatibility for nullability. New columns defined without explicit nullability are defined to allow nulls. 2048- ANSI_NULL_DFLT_OFF - Alters the session''s behavior not to use ANSI compatibility for nullability. New columns defined without explicit nullability do not allow nulls. 4096 - CONCAT_NULL_YIELDS_NULL- Returns NULL when concatenating a NULL value with a string. 8192- NUMERIC_ROUNDABORT- Generates an error when a loss of precision occurs in an expression. 16384 - XACT_ABORT - Rolls back a transaction if a Transact-SQL statement raises a run-time error. The xp_cmdshell option is a server configuration option that enables system administrators to xp_cmdshell* control whether the xp_cmdshell extended stored procedure can be executed on a system. By default, the xp_cmdshell option is disabled on new installations and can be enabled. AlwaysOn Availability Groups Applications Manager lets you monitor the status of your SQL Server AlwaysOn resources by displaying all the Availability Groups running in your SQL server. Click on the links below to view all the required details listed under the following tables: Availability Groups Availability Replicas Availability Databases Availability Groups Parameters Description Name The name of an availability group for which the connected server instance hosts a replica. Primary Replica Name of the server instance that is hosting the primary replica of the availability group. Availability Replicas On clicking the required availability group, you can view detailed information on various replicas available under that group. Parameters Description Replica The name of the server instance that hosts the availability replica.Parameters Description Indicates the current role of the availability replica. Possible values are Primary, Secondary and Role Resolving. Availability Indicates the replica property that you set separately for each availability replica. Possible Mode values are Synchronous and Asynchronous. Displays the failover mode for which the replica is configured. Possible failover mode values Failover Mode are Automatic and Manual. Synchronization Indicates the synchronization health of the replica. Possible values are Healthy, Partially Health Healthy and Not Healthy. Indicates whether a secondary replica is currently connected to the primary replica. If the Connection replica is primary, It indicates whether it connected with all the secondary replicas. Possible Status values are either Connected or Disconnected. Indicates the current operational state of the secondary replica. Possible values are: Pending State failover, Pending, Online, Offline, Failed, Failed, No Quorum and Not Local. Bytes Received Rate at which data is received from the Primary Replica by the Secondary Replica (in MB/Sec). from Primary * Bytes Sent to Rate at which data is sent to the Primary Replica by the Secondary Replica (in MB/Sec). Primary * * - Obtained after clicking over the required replica under Replica Stats. Availability Databases On clicking the required replica, you can view detailed information of various databases available under that replica. Primary Databases: Database Status Information: Parameters Description Synchronization Indicates the Synchronization health of the database. Possible values are Healthy, Partially Health Healthy and Not Healthy. Indicates whether the availability database is currently synchronized with other replicas. Synchronization Possible values are Not Synchronizing, Synchronizing, Synchronized, Reverting and State Initializing. Failover Indicates which availability database can be failed over with or without potential data loss. Readiness Possible values are either Data Loss or No Data Loss. Indicates whether the state at which the availability database is currently in. Possible values State are either Suspended or Resumed. Performance Statistics: Parameters Description Redone Bytes The rate at which log records are redone on the primary database (in MB/Sec). Log Bytes The rate at which log records are received by the primary database (in MB/Sec). Received Amount of data written from the log cache to the physical transaction log file on the disk (in Log Flushed MB). Secondary Databases: Database Status Information: Parameters Description Synchronization Indicates the Synchronization health of the database. Possible values are Not Healthy, Partially Health Healthy and Healthy. Indicates whether the availability database is currently synchronized with other replicas. Synchronization Possible values are Not Synchronizing, Synchronizing, Synchronized, Reverting and State Initializing. Failover Indicates which availability database can be failed over with or without potential data loss. Readiness Possible values are either Data Loss or No Data Loss.Parameters Description Indicates whether the state at which the availability database is currently in. Possible values State are either Suspended or Resumed. Transaction Details: Parameters Description Log Send Indicates the amount of log records in the log files of the primary database that have not been sent Queue to the secondary replica (in MB). Redo Indicates the amount of log records in the log files of the secondary database that have not yet Queue been redone (in MB). Log Indicates the amount of data written from the log cache to the physical transaction log file on the Flushed disk (in MB). Log Send Indicates the rate at which log records are being sent to the secondary database (in MB/Sec). Rate Redo Rate Indicates the rate at which the log records are being redone (in MB/Sec). Performance Statistics: Parameters Description Send Indicates the amount of time taken by the Primary Replica to send all the log records to the Latency Secondary Replica (in Sec). Indicates the amount of time taken to redo the catch-up time (in Min). The catch-up time is the time Redo Lag taken for the secondary replica to catch up with the primary replica. Indicates the amount of time delay observed in the last transaction log records between the Sync Lag primary and the secondary replica (in Min). If the primary replica fails, all the transaction log records within that time lag will be lost. Redone Indicates the amount of log records that are redone on the secondary database in the last second Bytes (in MB/Sec). Log Bytes Indicates the amount of log records received by the secondary replica for the database in the last Received second (in MB/Sec). SQL Server - Cluster Details Applications Manager lets you monitor the status of your SQL Server Clusters and Cluster resources. Click on the monitor name to see all the Cluster details listed under the following links: Cluster Details Disk Utilization Storage Nodes Networks Resource Groups Note: ''Cluster Details'' tab can be viewed only in Windows installations of Applications Manager. Cluster Details Parameters Description Cluster Name/IP Address The name/IP Address of the cluster. Quorum Owner Node The node in which the sql cluster configuration data is currently accessible. Quorum Path The path to the quorum files. The current quorum type. The following are the possible values: Quorum Type Majority No Majority Number of Nodes The total number of nodes in a cluster. Max Nodes The maximum number of nodes that can participate in a cluster.Parameters Description Number of Networks The number of networks used by the server cluster for communication. Resources Online The SQL server cluster resources that are currently online. Resources Offline The SQL server cluster resources that are currently offline. Resource Groups Online The SQL server cluster resource groups that are currently online. Resource Groups Offline The SQL server cluster resource groups that are currently offline. Disks in Use The number of disks currently in use in the cluster. Disk Utilization You can monitor the total Disk Utilization of a Cluster. Parameters Description Used Percentage The total percentage of used disk space in a Cluster. Free Percentage The total percentage of free disk space in a Cluster. Size The total size of disk memory, in megabytes. Used The total used space in the disk, in megabytes. Free The total free space available in the disk, in megabytes. Storage Parameters Description Path The path (including the drive letter if present) of the clustered disk partition. Volume Label Specifies access to the VolumeLabel property, which is the volume label of the partition. Size The total size for the partition, in megabytes. Used The total used space in the partition, in megabytes. Free The total free space available for the partition, in megabytes. Used Percentage The percentage of used space in the partition. Free Percentage The percentage of free space in the partition. Nodes Parameters Description Node Name Specifies the label by which the node is known. Specifies the current state of a node. Node states can be: Up - The node is physically plugged in, turned on, booted, and capable of executing programs. Down - The node is turned off or not operational. State Joining - The node is in the process of joining a cluster. Paused - The node is running but not participating in cluster operations. Unknown - The operation was not successful. Networks Parameters Description Name Specifies the name of the network.Parameters Description Provides access to the network''s Role property i.e, the role of the network in the cluster. The following are the possible values: 0 - None - The network is not used by the cluster. 1 - Cluster - The network is used to carry internal cluster communication. Role 2 - Client - Not supported - Windows Server 2003: The network is used to connect client systems to the cluster. 3 - Both - The network is used to connect client systems and to carry internal cluster communication. Specifies the current state of the network. The following are the possible values: -1 - Unknown - The operation was not successful. 0 - Unavailable - All of the network interfaces on the network are unavailable, which means the nodes that own the network interfaces are down. State 1 - Down - The network is not operational; none of the nodes on the network can communicate. 2 - Partitioned - The network is operational, but two or more nodes on the network cannot communicate. Typically a path-specific problem has occurred. 3 - Up - The network is operational; all of the nodes in the cluster can communicate. Address Specifies the address for the entire network or subnet. Resource Groups Parameters Description Name The name of the Resource group. Current Node The node in which the sql server is currently running. Preferred Node The node that is primarily responsible for hosting a cluster resource. The current state of the resource group. The following are the possible values. Unknown (-1) Online (0) State Offline (1) Failed (2) PartialOnline (3) Pending (4) IBM DB2 Server Monitoring Overview Creating a new IBM DB2 monitor Monitored Parameters Overview IBM DB2 is a family of relational database management system (RDBMS) products from IBM that serve a number of different operating system platforms. DB2 is designed to store, analyze and retrieve the data efficiently and is supported across Linux, Unix, and Windows operating systems. Applications Manager''s DB2 Server Monitoring capability helps database administrators (DBAs) monitor the availability and performance of production databases. Creating a new IBM DB2 monitor Supported Versions: Applications Manager supports monitoring of IBM DB2 Versions 8, 9, 10 and 11. Prerequisites for monitoring IBM DB2 metrics: Click here Using the REST API to add a new IBM DB2 monitor: Click hereTo create a IBM DB2 database server monitor, follow the given steps: Click on New Monitor link. Select DB2 DB Server. Enter the IP Address or hostname of the host. Enter the SubNetMask of the network. Enter the port number in which DB2 is running. Choose SSL is enabled option if DB2 server is to be accessed via SSL port. Provide the user name and password of user who has permission to access the DB2 database. The user name specified for collecting the data from DB2 Server should have either System Administrator role or the user should be the DB owner for master database. Else, you can select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Specify the Database Name. Enter the polling interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate DB2 database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers DB2 database server from the network and starts monitoring them. Monitored Parameters Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed to view the following information in the below tabs: Overview Performance Session Overview Monitor Information Parameters Description Name Specifies the name of IBM DB2 server monitor. Health Specifies the health (Clear, Warning, Critical) of the IBM DB2 server. Type Specifies the type you are monitoring. Version Specifies the version of the database server. Port Specifies the port number at which the database server is running. Instance Name The name of the instance in which the database is present Server Status The current status of the database server itself Started Time The date and time that the database manager was started using the db2start command. Host Name Specifies the host at which the database server is running. Host OS Specifies the OS of the host where the database server is running. Last Alarm Specifies the last alarm that was generated for the database server. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the server - available or not available. Connection Statistics Parameters Description Connection Time Time taken to get connected to the IBM DB2 database server Total The total number of local and remote connections that currently present in the database Connections manager Local The number of connections initiated from remote clients to the current instance of theConnections database manager Remote The number of local applications that are currently connected to the database within the Connections database manager Agents Statistics Parameters Description The number of agents in the agent pool that are currently active and assigned to an Active Agents application Idle Agents The number of agents in the agent pool that are currently unassigned to any application Number of The number of agents registered in the current database manager instance Agents The number of agents waiting for a token so they can execute a transaction in the database Agents Waiting manager Database Information Parameters Description Database Name The real name of the database for which information is collected Health Specifies the health (Clear, Warning, Critical) of the database. Database Alias The alias of the database provided when calling the snapshot function The full path of the location where the database is stored on the monitored Database Path system Database Status The current status of the database Connected Time The date and time when the activate database was issued Deadlock Rate The total number of deadlocks that have occurred in the given polling interval Percentage of Log Utilization The total amount of active log space used in bytes in the database Percentage of Sorts The percentage of sorts that have over flowed Overflowed Backup Age Amount of time elapsed since the last backup (in hour(s)). Transaction Statistics Parameters Description Successful The total number of successful SQL statements executed at the database in the given polling Queries interval Failed The number of SQL statements that were attempted, but failed at the database in the given polling Queries interval Units of This represents the total number of sql commits, internal commits, sql roll backs and internal roll Work backs done by the database manager in the given polling interval Cache Performance Parameters Description The hit ratio is a percentage indicating how well the package cache is helping to avoid Package Cache Hit reloading packages and sections for static SQL from the system catalogs as well as Ratio helping to avoid recompiling dynamic SQL statements. Catalog Cache Hit The hit ratio is a percentage indicating how well the catalog cache is helping to avoid Ratio actual accesses to the catalog on disk Buffer Statistics Parameters Description Buffer Pool The buffer pool hit ratio indicates the percentage of time that the database manager loaded the Hit Ratio required page from buffer pool in order to service a page request Index Page The Index Page hit ratio indicates the percentage of time that the database manager accessed the Hit Ratio index pages present in the buffer pools. Data Page The Data Page hit ratio indicates the percentage of time that the database manager accessed the Hit Ratio data pages present in the buffer pools.Direct The number of read operations that do not use the buffer pool Reads Direct The number of write operations that do not use the buffer pool Writes TableSpace Status Parameters Description Name Refers to the name of the Table space. Allocated Bytes calculated from (tablespace_total_pages)*(tablespace_page_size) and converted to MB Free Bytes calculated from (tablespace_free_pages)*(tablespace_page_size) and converted to MB % of Free Bytes calculated from (tablespace_free_pages) /(tablespace_total_pages)*100 Performance Parameters Description Top 10 Long Running Query Program Name of the program/application that was running the query. Name User Name Name of the user executing the query. DB Name The database name under which the query has been running. Run Time Amount of time for which the query has been running (in seconds). Activity State The current state of the activity. The cumulative total amount of CPU time that has been spent in running the query (in Total CPU millisecond). Query The query which consumed the maximum CPU time. Session Parameters Description Top 100 Session Details per Database PID Displays the process ID of the session running in the DB2 server. User The login name of the user executing the process. Host Name/IP The hostname of the machine where the session is running. Program Name Name of the program/application that has established the session. DB Name Displays the name of the database currently being used by the process. Total CPU The cumulative CPU time taken for running the process (in milliseconds). CPU I/O Amount of CPU time taken by the process to perform I/O operations (in milliseconds). Network Amount of time spent by the CPU on client-server communications (in milliseconds). Communication CPU The total amount of time spent by an application waiting within the DB2 database server Total Wait Time (in milliseconds). Amount of time spent by an application queued to wait for an agent under concentrator Agent Wait Time configurations (in milliseconds). Lock Wait Time Amount of time spent by an application waiting for locks (in milliseconds). Client Idle Time Amount of time spent waiting for the client to send its next request (in milliseconds). Start Time The date and time at which the session started. IBM DB2 for i Monitoring IBM DB2 for i - An Overview Monitoring IBM DB2 for i - What we do Adding a new IBM DB2 for i monitorMonitored Parameters IBM DB2 for i - An Overview DB2 for i is a member of IBM’s family of DB2 databases. It is an integrated relation database management system for the IBM i platform. DB2 for i contains a rich set of security features and services that pertain to the goals of authentication, authorization, integrity, confidentiality, and auditing. Monitoring IBM DB2 for i - What we do. Applications Manager aims to help database admins with tuning their DB2 and gather operating system level data to understand performance issues. Let’s take a look at what you need to see to monitor IBM DB2 for i, the performance metrics to gather and how you can ensure that your DB2 database is up and operating as expected with Applications Manager: Monitor Jobs status and health and also optimize your server''s resources by minimizing network traffic, disk I/O and CPU time.  Track memory usage details and keep track of JVM metrics to correlate server performance. Get instant notifications when there are performance issues with the components of your DB2. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Adding a new IBM DB2 for i monitor Prerequisites for monitoring IBM DB2 for i: To monitor IBM DB2 Version 8 and 9, the minimum user privileges required is the ability to access the SYSPROC procedures. To monitor IBM DB2 Version 10, the minimum user privileges required is the ability to access the SYSIBMADM functions. To create a IBM DB2 for i database server Monitor, follow the given steps: Click on New Monitor link. Select DB2 for i Server. Enter a Display Name for your monitor. Enter the IP Address or hostname of the host. Enter the Subnet Mask of the network. Enter the port number in which DB2 is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the user name and password of user who has permission to access the DB2 database. The user name specified for collecting the data from DB2 Server should have either System Administrator role or the user should be the DB owner for master database. Specify the Database Name. Choose the Monitor Group from the combo box with which you want to associate the DB2 database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers DB2 for i database server from the network and starts monitoring them. Monitored Parameters Overview System Information Jobs and JVM Information Configuration Overview ATTRIBUTE DESCRIPTION UNITS NAME CPU DETAILSATTRIBUTE DESCRIPTION UNITS NAME Average CPU The average CPU utilization for all the active processors. % Utilization The average CPU rate expressed as a percentage where 100% indicates the processor is running at its nominal frequency. A value above or below 100% indicates how much the Average processor has been slowed down (throttled) or speeded up (turbo) relative to the nominal % CPU Rate frequency for the processor model. For instance, a value of 120% indicates the processor is running 20% faster against its nominal speed. Configured The total number of configured CPUs. - CPUs The current processing capacity specifies the processor units that are being used in the partition. For a partition sharing physical processors, the current processing capacity Current CPU represents the share of the physical processors in the pool it is running. For a partition GHz Capacity using dedicated processors, the current processing capacity represents the number of virtual processors that are currently active in the partition. SCHEMA DETAILS FOR TOP 10 SCHEMA BY SIZE Schema Schema Name - Table Count The number of tables in the schema - Size The size of the Schema MB Partition The number of Partitions present in the Schema - Count Pages The number of 64K pages in all partitions or members of the table. - Distinct The number of distinct indexes built over any partitions or members of the table. This - Indexes does not include maintained temporary indexes. Insert The number of insert operations of all partitions or members of the table since the last IPL - Operations (Initial Program Load). Update The number of update operations of all partitions or members of the table since the last - Operations IPL. Delete The number of delete operations of all partitions or members of the table since the last - Operations IPL. Logical The number of logical read operations of all partitions or members of the table since the - Reads last IPL. System Information ATTRIBUTE DESCRIPTION UNITS NAME SYSTEM DETAILS Main Storage The amount of main storage in the system. GB Size System ASP The amount of ASP storage in the system. GB Storage System ASP The amount of ASP Memory used by the System MB Used Partitions The number of Partitions in the System - Count Active Threads in The number of Active Threads in the System - System MEMORY POOL INFORMATIONATTRIBUTE DESCRIPTION UNITS NAME The name of the storage pool. The name may be a number, in which case it is a private pool associated with a subsystem, or one of the following special values. • MACHINE - The specified pool definition is defined to be the machine pool. • BASE - The specified pool definition is defined to be the base system pool, which can Pool Name be shared with other subsystems.   • INTERACT - The specified pool definition is defined to be the shared pool used for the QINTER subsystem. • SPOOL - The specified pool definition is defined to be the shared pool used for spooled writers. • SHRPOOLx - The specified pool definition is defined to be a shared pool. Reserved The amount of storage in the pool reserved for system use (for example, for save/restore GB Size operations). Current Size The amount of main storage in the pool. GB Maximum Active The maximum number of threads that can be active in the pool at any one time. - Threads Current The number of threads currently using the pool. - Threads Elapsed Time The time since the measurement start time. Sec Jobs and JVM Information TOP 10 GARBAGE COLLECTIONS AND HEAP TIME USING JVM INFORMATION ATTRIBUTE DESCRIPTION UNITS NAME JOB DETAILS Active Jobs The number of jobs active in the system (jobs that have been started, but have not yet - in System ended), including both user and system jobs Interactive The percentage of interactive performance assigned to this logical partition. This value is Jobs in % a percentage of the total interactive performance available to the entire physical system. System The total number of user and system jobs that are currently in the system. The total includes: Total Jobs in • All jobs on job queues waiting to be processed.   System • All jobs currently active (being processed). • All jobs that have completed running but still have output on output queues to be produced. The maximum number of jobs that are allowed on the system. When the number of jobs reaches this maximum, you can no longer submit or start more jobs on the system. The Maximum total includes: Jobs in • All jobs on job queues waiting to be processed.   System • All jobs currently active (being processed). • All jobs that have completed running but still have output on output queues to be produced. Job Name The name of Job that is running in DB2 Database - Process ID The process identifier used by the kernel to uniquely identify the process. - Total GC The total time spent performing garbage collection tasks. Min Time Current Java The current number of java threads within the JVM job. - Threads Current The amount of memory currently allocated for heap space. MB Heap Size In Use Heap The amount of memory  currently in use by the heap. MB Size Max Heap The maximum heap size available to the JVM code, MB SizeConfiguration ATTRIBUTE NAME DESCRIPTION Aliases Alias is an alternative name for database objects. Sequences The number of Sequences Global Variables The number of Global Variables Journals The number of Journals Journal Receivers The number of Journal Receivers Schemas The number of Schemas Tables The number of Tables Partitioned Tables The number of Partitioned Tables Distributed Tables The number of Distributed Tables Materialized Tables The number of Materialized Tables Physical Files The number of Physical Files Source Files The number of Source Files Logical Files The number of Logical Files DDM Files The number of DDM Files External Triggers The number of External Triggers SQL Procedures The number of SQL Procedures External Procedures The number of External Procedures SQL Procedures The number of SQL Procedures IBM Informix Database Monitoring IBM Informix - An Overview Creating a new Informix monitor Monitored Parameters IBM Informix - An Overview IBM Informix is one of the industry''s most widely used database servers with a comprehensive set of high availability options, high levels of performance, data replication capabilities, scalability and minimal administrative overhead for both simple and complex IT infrastructures. Applications Manager performs effective monitoring, which is very critical in Informix administration, to collect system and database performance stats, session details and to identify problems at an early stage for proactive troubleshooting and performance tuning. Creating a new Informix monitor Supported versions of Informix Server: Informix 10.x & above. Prerequisite: Click here to know about the user previleges and other necessary prerequisites to monitor IBM Informix database. To create an Informix Server Monitor Click on New Monitor link. Select Informix under Database Servers. Specify the Display Name of the Informix monitor Enter the HostName or IP Address of the host where Informix server is installed. Enter the port number for eg., 1526. Enter the Database Server name i.e the name of the Informix database server to which you want to connect. You can enter your own credential details or select preconfigured credentials from Credentials Manager. If you wish to enter your own credentials, specify Informix username and password details for this monitor. Set the Polling Interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Informix Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Informix server from the network and starts monitoring them.Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Informix under the Database Servers Table. Displayed is the Informix Database bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Database Sessions Overview Parameter Description Response time The time taken to establish a JDBC connection with the Informix Server. Database Space Details Dbspace Name The unique name of the Database Space. Allocated (MB) The total physical disk size allocated for the Database Space in MB. Free (MB) The free physical disk size for the Database Space in MB. Used % The percentage of physical disk utilization by the Database Space. Disk Reads/sec The number of Disk Reads happening in the Database Space per second. Disk Writes/sec The number of Disk Writes happening in the Database Space per second. Database Parameter Description Name The name of the database. DBSpace The Database Space which stores data for this database. Name Owner The User ID of the creator of the database. Created The time at which the Database was created. On The current logging modes of a database: Is Logging Is Buff Log Unbuffered logging. Values are either 0 or 1. (1=Yes, 0=No) Is ANSI Buffered logging. Values are either 0 or 1. (1=Yes, 0=No) ANSI mode database. Values are either 0 or 1. (1=Yes, 0=No) Is NLS NLS support. Values are either 0 or 1. (1=Yes, 0=No) Is Case Indicates whether NCHAR and NVARCHAR columns are case-insensitive or not. Values are Insens either 0 or 1. (1=Case-insensitive, 0=Case-sensitive) Sessions Parameter Description Session Id A unique identifier number assigned to the session. User Name The User name of the Informix user account. Host Name The host from which the user is connecting to the Informix database Login Time The time at which the user connected to the database server. SAP HANA MonitoringCreating a new SAP HANA monitor Prerequisites for monitoring SAP HANA metrics: Click here Using the REST API to add a new SAP HANA monitor: Click here To create a SAP HANA DB server monitor, follow the steps given below: Click on New Monitor link. Select SAP HANA under Database Servers. Specify the Display Name of the SAP HANA monitor Enter Host Name of HANA server. If Using SAP HANA Cloud Platform, Select SAP HANA Cloud Platform. Enter Cloud Account Name, UserName and Password. Enter Port as IndexServer port, default port is 30015. You can enter your own credential details or select pre-configured credentials from Credentials Manager. If you wish to enter your own credentials, specify SAP HANA username and password details for this monitor. Enter Database Username and Database Password. Enter Instance Name. Set the Polling Interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate SAP HANA Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers SAP HANA server from the network and starts monitoring them. Prerequisites: Need to copy ngdbc.jar into the location /working/classes. ngdbc.jar can be copied from installed SAP HANA Client folder. Click here to download SAP HANA Client If HANA is running On-demand, in addition to the above, SAP Cloud Platform SDK is needed. However, this is not needed for HANA On-premise. Click here to download SAP Cloud Platform SDK. The downloaded zip should be extracted under /working/hanacloud folder. After extracting need to verify whether /working/hanacloud/tools folder is available. Need to restart APM after performing the above steps. To effectively monitor SAP HANA, the SAP HANA DB User must have the below privileges, System privilege CATALOG READ Object privilege SELECT on the schema _SYS_STATISTICS To grant these privileges to the user, execute the below statements in SAP HANA SQL console.(Replace USER_NAME with actual HANA DB Username) GRANT MONITORING to CALL GRANT_ACTIVATED_ROLE (''sap.hana.admin.roles:Monitoring'','' '') Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on SAP HANA under the Database Servers Table. Displayed is the SAP HANA bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Alerts Caches Jobs Expensive Statements Transactions WorkloadBackup Replication Schema Disk Services Overview Parameter Description Memory and CPU Memory Utilization Percentage of Memory Utilized by HANA System as a whole CPU Utilization Percentage of CPU Utilized by HANA System as a whole CPU  Available No. of CPU Available CPU Used Used no. of CPU. Total Physical Memory Total Physical Memory of HANA System Used Physical Memory Memory Used by HANA System Total Swap Memory Total Swap Memory allocated for HANA System Connection Statistics Active Connections Total No. of Active Connections Inactive Connections Total No.of Inactive connections Memory Details of Host Total Physical Memory Total Memory for each host in the HANA system. Free Physical Memory Free Memory Available in individual host Used Physical Memory Used Memory in individual host (HANA+other appllications) Swap Memory Swap Memory of individual host Used Swap Memory Swap Memory used. Peak Memory Peak Memory used in each host Memory Used By HANA Allocation Limit Memory allocated for HANA in each host HANA used memory Memory Used only by HANA in each host (Total resident) Memory Used by Column The amount of memory used for column tables. (A major part of the SAP HANA Used Tables Memory is taken up by the data tables). Memory Used by Row The total amount of memory used for row tables. (A major part of the SAP HANA tables Used Memory is taken up by the data tables). Code & Stack Memory Memory used by HANA Code and Stack The amount of physical memory actually in operational use by a process. (When a DataBase Resident part of the virtually allocated memory actually needs to be used, it is loaded or mapped to the real, physical memory of the host, and becomes "resident".) System Information Version The version of the SAP HANA database that is installed on the system. System Type A SAP HANA system can be configured as a single-host or multiple-host system. All Services Started Indicates if all services are started and the system is operational and accessible. Platform The operating system of the SAP HANA system. Instance ID The instance ID of the SAP HANA database. Services Parameter Description Service name The name of the service. CPU used The percentage of CPU used by the service. Memory Used The memory used by each service.Requests per sec The number of requests that are processed by the host computer. The time (in milliseconds) that is taken by the service to respond to requests from Response Time the clients. Active Requests count The number of active requests that are being processed by the service. The number of requests that are waiting in a queue to be processed by a service in Pending requests count the SAP HANA database server. Active Threads count The total number of active threads for the service. The number of files that are currently opened through a service in the SAP HANA Open File Count database server. Service status The status of the service. The status can be no, yes, unknown, starting,and stopping. Disk Parameter Description The type of disk usage on the host computer. The usage types are log,data, trace, Disk usage Type data_backup, and log_backup. Total Disk Space The total Space allocated for each Disk Disk Used Disk Used Disk Free percentage The free space percentage of the disk. Disk Path The path to the disk, disk location. Disk Volume size The total disk space in GB. Disk Volume Service Name The name of the service. Volume ID The unique volume identifier. File Type The type of file in the volume directories. Possible values are - DATA, LOG, TRACE. File Name The name of the file, Total Volume Size The total data volume sizes of the SAP HANA servers. Used Volume Size The total data volume sizes used. Free Size The free memory size of the module. Volume IO Statistics Service Name The name of the service. Volume ID The unique volume identifier. Volume Path The Filesystem path. Disk Type The Filesystem type. Blocked Write Requests The count of blocked write requests. Total Reads Total number of file reads on the disk for all file types. Total Failed Reads Total number of failed reads from the disk. Total Read Size Total size of read data (in MB). Total Read Time Total time taken to read data (in sec). Total Appends Total number of file appends on the disk for all file types. Total Writes Total number of file writes on the disk for all file types. Total Failed Writes Total number of of failed writes. Total Write Size Total size of written data (in MB). Total Write Time Total time taken to write data (in sec). Total I/O Time Total time taken to perform I/O operations (in sec). Speed The I/O performance measured in MB/sec. Schema Parameter DescriptionNo.of Column Tables The number of Column Tables in this partition. Size of Column Tables Allocated memory size for fixed-size and variable-size column table paritions. No. of Row Tables The number of Row Tables in this partition. Size of row tables Allocated memory size for fixed-size and variable-size row table paritions. Replication Parameter Description Host Host name Service Name Name of the Service Site Name Logical site name Secondary Host The secondary host name. Secondary Site Name The secondary logical site name. Replication Status Replication Status Backup Parameter Description Backup Size The size of the backup. Source Type name Type of persistence to be backed up: ''volume'', ''topology''. Service Type Name Type of database service: ''indexserver'', ''nameserver'', ''statisticsserver''. Classification of backup catalog entries: ''complete data backup'', ''data snapshot'', Entry type Name ''log backup'', ''log missing'' Start time Time stamp when backup started Total Time TimeTaken for Backup Result of corresponding action: ''successful'', ''failed'', ''running'', ''cancel pending'', Backup status ''canceled'' Backup Configuration Max Recovery File Age The maximum recovery file age in seconds. Log Replay Step Size The Log replay step size in bytes. Max Recovery Backint The max number of parallel backint channels per request during recovery. Channels Backint Executable Link The link name of the backint executable. Backint Executable The filename of the backint executable. Backint Data Backup Path The data backup directory for backint. File Data Backup Path The default directory for file-based data backups. File Log Backup Path The current directory for file-based log backups. Latest Backup Details Latest Backup ID The unique ID of a data backup or a log backup respectively. Latest Backup Start Time The start time of the backup operation. Latest Backup End Time The end time of the backup operation. The classification of backup catalog entries. The following types are supported: Latest Backup Entry Type ''complete data backup'', ''log backup'', ''log missing''. Latest Backup Destination The type of backup location. Possible values are - ''file'' or ''backint''. Type Latest Backup Size Specifies the size of the backup. Workload Parameter Description Current Execution The current statement execution count per minute. Rate/minCurrent Compilation The current statement preparation count per minute. Rate/min Current Transaction The current transaction count per minute. Rate/min Current Commit Rate/min The total number of commits per minute. Current Rollback Rate/min The total number of rollbacks per minute. Current Memory Usage The total size of used memory per minute. Rate/min Transactions The Blocked Transaction data set provides information about the transactions that are waiting to acquire transaction locks held by another transaction, network, or disk. Parameter Description Blocked Transaction Id The connection ID of the blocked transaction. Lock Owner Transaction Id The connection ID associated with the write transaction that is holding the lock. Blocked Time The time from when the transaction is blocked. Waiting Schema Name The name of the schema on which the lock is placed. Waiting Object Name The type of the object on which the lock is placed. The type of lock that is held by the blocking transaction. The lock type can be record, Lock Type object, and metadata. The access level of transactions to the locked record, table, and database. The lock Lock Mode mode can be shared, exclusive, and intentional exclusive. Blocked Statement The statement that is blocking the transaction. Expensive Statements The Expensive Statement data set provides information about the statements for which execution timewas greater than the configured threshold. Parameter Description Statement Duration The time that is required for executing the statement. Records The number of records in the database table. Memory Size The memory required for computing the statement. DB User The user name that is used to connect to the database. Operation Type of operation: e.g. prepare, execute, fetch, close. Statement The SQL statement that runs for duration longer than the defined threshold. Error Code The error code associated with the query. Error Message The error message associated with the error code. Jobs Parameter Description Connection Id The connection that triggered the operation. Schema name Schema of the object. Object name Name of the object. Job Name The type of the operation. Start Time The time when the operation was started. The current status of the operation. One of the following values is possible: inactive, Current Job Progress active, precommitted, aborting, partial_aborting, and active_prepare_commit. Caches Parameter DescriptionCache id The unique identifier for the cache. Total Size Maximum available memory for each cache instance Used Size Memory Used by Cache instance Hits Count Number of cache hits for the cache instance. Misses Count Number of cache misses for the cache instance. Alerts Parameter Description Alert ID The ID of the current alert. The severity of the alert occurrence. The severity might be different for each alert. Alert rating The following values are possible: 1 (information message), 2 (warning level 1), 3 (warning level 2), 4 (warning level 3), 5 (error message). Alert TimeStamp The time according to the local server time when the alert was occurred. Description The information about the alert. Sybase ASE Monitoring Creating a new Sybase monitor Supported Versions: Applications Manager supports monitoring of Sybase ASE 12.5.3 and above. Prerequisites for monitoring Sybase metrics: Click here Using the REST API to add a new Sybase monitor: Click here To create a Sybase database server monitor, follow the given steps: Click on New Monitor link. Select Sybase. Enter the IP Address or Host Name of the host. Enter the SubNetMask  of the network. Enter the port number in which sybase is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the user name and password of user who has permission to access the Sybase database. The user name specified for collecting the data from Sybase should have either System Administrator role or the user should be the DB owner for master database. Specify the Database Name. Choose the Monitor Group from the combo box with which you want to associate Sybase database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Sybase database server from the network and starts monitoring them. Monitored Parameters Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. Click on the following tabs listed to view the following information: Monitor Information Overview Database Performance Process Monitor Information Parameters DescriptionName Specifies the name of Sybase server monitor. Health Specifies the health (Clear, Warning, Critical) of the Sybase server. Type Specifies the type you are monitoring. Version Specifies the version of the database server. Port Specifies the port number at which the database server is running. Server Status The current status of the database server itself Started Time The date and time that the database manager was started Host Name Specifies the host at which the database server is running. Host OS Specifies the OS of the host where the database server is running. Last Alarm Specifies the last alarm that was generated for the database server. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the server - available or not available. Overview Parameters Description CONNECTION TIME Time taken to get connected to the Sybase database ASE server (in Connection Time milliseconds). MEMORY UTILIZATION Total Memory Total amount of memory available for the ASE server (in MB). Used Memory Amount of memory used by the ASE server (in MB). Free Memory Remaining amount of memory available for the ASE server (in MB). Used Memory Percentage Amount of memory used by the ASE server (in percentage). REMOTE CONNECTION STATISTICS Max Remote Connections The number of max remote connections available in the ASE server. Remote Connection Percentage of the amount of active remote connections after the ASE server has Percentage restarted. Active Remote Connections The number of active remote connections after the ASE server has restarted. USER CONNECTION STATISTICS Max User Connections The number of max user connections available in the ASE server. Active User Connections The number of active user connections after the ASE server has restarted. Percentage of the amount of active user connections after the ASE server has User Connection Percentage restarted. LOCK STATISTICS Max Locks Total number of locks configured to be held in the ASE server. Active Locks Number of locks that are in active state. Active Lock Percentage Percentage of active locks with total locks configured. DISK I/O STATISTICS Max Disk I/O Total number of disk I/O available in the ASE server. Active Disk I/O Number of disk I/O that are active and currently in use. Active Disk I/O Percentage Percentage of active disk I/O with the max disk I/O. PROCEDURE CACHE USAGE Max Procedure Cache Total amount of procedure cache allocated for Sybase ASE server. Procedure Cache Used Amount of procedure cache that are currently in use. Procedure Cache Used Percentage of procedure cache used with the max procedure cache. Percentage Stored Procedure Request Number of stored procedure requests processed per second. RateDATA CACHE USAGE Configured Data Cache Amount of data cache configured during the server startup (in MB). Current Data Cache Amount of data cache that are currently in use (in MB). CACHE HIT RATIO Ratio of Logical Reads to Cache Searches performed for default cache (in Data Cache Hit Ratio percentage). Ratio of difference between procedure requests and load to requests made (in Procedure Cache Hit Ratio percentage). Database Parameters Description Database Details DB Name Name of the database instances. Total Size Total amount of space allocated for the database (in MB). Used Size Amount of space used in the database (in MB). Free Size Remaining amount of space available in the database (in MB). Used Size (%) Amount of space used in the database (in percentage). Log Size Amount of space allocated for logs in the database (in MB). Log Used Amount of space used from the allocated log space in the database (in MB). Log Used (%) Amount of space used from the allocated log space in the database (in percentage). Creator Name of the user who created the database. Health Health status of the database. Database Backup Details DB Name Name of the database. Backup Status Status of the backup performed. Backup Start Time Date and time at which backup was started. Backup Age Amount of time elapsed since the last backup (in hours). Number of processes that are currently suspended due to the database transaction log Suspended Processes being full. Transaction Log Full Indicates whether the database transaction log is full. (Yes or No) Last Checkpoint Date and time at which checkpoint was last run for this database. Last Transaction Log Date and time of this database’s most recently successful transaction log dump. Dump Transaction Details Type The type of the transaction Coordinator The coordinator of the transaction State The state of the current transaction like it is started or in process or ended Connection The type of connection DB Name The database name in which the transaction is executed Process Name The process which is executing the transaction Transaction Name The name of the transaction Start Time The time at which the transaction started Performance This tab displays the performace of top 10 queries in terms of various factors such as CPU Time, Memory Usage, Run Time and Wait Time. Top 10 queries by CPU - Displays the list of top 10 queries with high CPU Time. Top 10 queries by Memory Usage - Displays the list of top 10 queries with high Memory Usage. Top 10 slow running queries - Displays the list of top 10 queries with high execution time.Top 10 most waited query - Displays the list of top 10 queries with high Wait Time. Below are the list of metrics that are displayed in this tab: Parameters Description Process ID ID of the process currently connected to ASE server. DB Name Name of the database currently in use. Query Displays the database query that is running. CPU Time Amount of time taken by the CPU to execute the query (in milliseconds). Wait Time Amount of time for which the task has waited to execute the query (in milliseconds). Execution Time Amount of time taken for the query to be executed (in seconds). Memory Usage(kB) Amount of memory utilized to execute the query (in kilobytes). Physical Reads Number of buffers reads that have been performed from disk while executing the query. Logical Reads Number of buffers reads that have been performed from cache while executing the query. Process Parameters Description Command Process Details Process ID ID of the process currently connected to ASE server. Process Name The name of the process currently connected to ASE server Host The Host Name / IP address of the process connected to ASE Name/IPAddress User Name The name in which the process is connected to ASE DB Name The name of the Database to which process is connected to ASE The command executed by process connected to ASE (command shown here limits to 255 Command chrs) Status The current status of the process Physical IO The Physical IO of the process Memory Usage The memory used by the process Time Blocked Amount of time blocked by the process (in seconds). PostgreSQL Performance Monitoring Overview Applications Manager''s PostgreSQL monitoring tool plays a vital role in monitoring your PostgreSQL database servers by providing end-to-end visibility into the performance of your database server in real-time. It aids you to keep check over the health and availability of your PostgreSQL servers by monitoring various key metrics such as database utilization, response time, query performance, session details and much more. With proactive PostgreSQL performance monitoring tools like Applications Manager in place, you can ensure that the performance of your PostgreSQL environments are kept on point. In this help document, you will learn how to get started with PostgreSQL performance monitoring, along with the list of parameters that are monitored with Applications Manager. Creating a new PostgreSQL performance monitor Supported Versions : 8.1 and above. Prerequisites for monitoring PostgreSQL metrics : Click here Rest API to add a new PostgreSQL performance monitor : Click here To create a PostgreSQL database server monitor, follow the steps given below: Click on New Monitor link. Select PostgreSQL. Enter the Display Name of the database server.Enter the IP Address or the Host Name of the host. Enter the port number in which PostgreSQL is running. Provide the user name and password of user who has permission to access the PostgreSQL database. Specify the DBName. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the PostgreSQL database server to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers PostgreSQL database server from the network and starts monitoring them. Monitored Parameters Availability tab displays the availability history of the PostgreSQL database servers in your network for the past 24 hours or 30 days. Performance tab displays the health status and events for the past 24 hours or 30 days. List view tab displays all the PostgreSQL servers that you monitor along with their current availability and health status. You can also perform bulk admin configurations from this view. Applications Manager''s PostgreSQL monitoring tool provides complete visibility into your database environments based on the metrics listed in the following tabs: Monitor Information Overview Performance Database Session Replication Configuration Monitor Information Parameter Description Name Denotes the name of PostgreSQL database server monitor. Type Denotes the type you are monitoring. Health Denotes the health (Clear, Warning, Critical) status of the PostgreSQL server. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the server - available or not available. Overview Parameter Description Connection Statistics: Active Connections Number of currently active connections to the database Total Users The total number of users active at the time of data collection Lock Statistics: Locks Held Number of locks held by the indicated session Locks Wait Number of locks waiting in the database Buffer Statistics: Total buffer hits (i.e., block read requests avoided by finding the block already in Buffer Hits/min buffer cache) per minute Block Reads/Min Total disk blocks read per minute Cache Hit Ratio The current ratio of buffer cache hits to total requests Disk Usage Details:Disk Usage Size of the on-disk representation of all tables in the database in MB Index usage Size of the on-disk representation of all indexes in the database in MB Index Scan Details: Index scans/min Total number of index scans initiated per minute Index Reads/min Total number of index entries returned by index scans per minute Index Fetches/min Total number of live table rows fetched by simple index scans per minute Query Statistics: Row inserts/min Total numbers of rows returned by each type of scan per minute Row Updates/min Total of row insertions and updates per minute Row Deletes/min Total number of rows deleted per minute Transaction Details: Total Commits Total transactions committed Total Rollbacks Total transactions rolled back Commits/Min Total transactions committed per minute Rollbacks/Min Total transactions rolled back per minute Table Level Scan Details: Sequential Scans/min Total number of sequential scans per minute Table Index Scans/min Total number of index scans per minute Sequential Scan Rows Total number of rows returned by sequential scans per minute Read/min Table Index Scan Rows Total numbers of rows returned by index scans per minute Read/min Primary Database Object Statistics: Total Tables Total number of tables in the database server Total Triggers Total number of triggers in the database server Total Procedures Total number of procedures in the database server Size of the Largest Table Size of the largest table in the database server Largest Table(s) Largest table in the database server Performance Parameter Description Top Queries by CPU: Database The database name under which the query has been executed. Name Total CPU The cumulative total amount of CPU time that has been spent in running the query (in Time millisecond). Average CPU The average CPU time taken to execute the query (in millisecond). Time The maximum amount of time that was taken by the CPU to run the query (in millisecond). Max CPU Time (Available from Postgres 9.4) Query The SQL query which consumed the maximum CPU time. Long Running Query Details: Process ID The identifier for the process caused by the query. Runtime Amount of time for which the query has been running (in minutes). User Name Name of the user executing the query. Query The SQL query that was running. Database The database name under which the query has been running. Name Top 50 Table Row Details: Table Name Name of the table.No. of Rows Number of rows available in the table. Table Size Size of the table (in MB). Database Parameter Description Database Details: Database Name Name of the database instance. DB Size Size of the database instance (in MB). Connections Number of connections for the database instance. TableSpace Name of the tablespace. TableSpace Details: Name Name of the tablespace. Owner Owner who created the tablespace. Location Location where the tablespace is created. Size Current size of the tablespace (in MB). Session Parameter Description Session Details: Process ID Displays the process ID of the session running in the Postgres server. Client Address IP address of the client connected to the server. Application The name of the application that has established the session. (Available from Postgres 9.0) Name Database Name Displays the name of the database currently being used by the process. User The login name of the user executing the process. State The state of the process in the Postgres server. (Available from Postgres 9.2) Blocked Indicates whether the process is blocked or is currently waiting on lock. Displays the Wait Event Name and Wait Event Type that is currently waiting. (Available from Wait Event Postgres 9.6) Query The SQL query that was last executed in the process. CPU Time The cumulative CPU time taken for the process running in the Postgres server (in millisecond). Replication Parameter Available Description Versions Replication Details: WAL files count >=9.2 Number of WAL files present in WAL directory. Current WAL >=9.2 Gives the last inserted location. Location wal_level determines how much information is written to the WAL. Default value = minimal (version < 10) minimal → writes only the information needed to recover from a crash or immediate shutdown. Default value = replica (version > 10) replica → writes enough data to WAL level >=9.2 support WAL archiving and replication, including running read-only queries on a standby server. Other states: hot_standby → minimal state/replica state info + adds information required to run read-only queries on a standby server. WAL sync method >=9.2 Method used for forcing WAL updates out to disk. If fsync is off, then this setting is irrelevant, since WAL file updates will not be forced out at all. Possible values are: open_datasync (write WAL files with open() option O_DSYNC), fdatasync(call fdatasync () at each commit), fsync (call fsync () at each commit), fsync_writethrough (call fsync () at each commit, forcing write-through of any disk write cache) checkpoints_timed >=9.2 Number of scheduled checkpoints that have been performed. checkpoints_req >=9.2 Number of requested checkpoints that have been performed. buffers_checkpoint >=9.2 Number of buffers written during checkpoints. buffers_clean >=9.2 Number of buffers written by the background writer. buffers_backend >=9.2 Number of buffers written directly from backend. Client Address >=9.2 Address of client/standby server address. TCP port number that the client is using for communication with this WAL Client Port >=9.2 sender. PID >=9.2 Process ID of a WAL sender process. application name >=9.2 Name of the application that is connected to this WAL sender. Current WAL sender state. Possible values are: startup: This WAL sender is starting up. catchup: This WAL sender''s connected standby is catching up with the primary. Sender State >=9.2 streaming: This WAL sender is streaming changes after its connected standby server has caught up with the primary. backup: This WAL sender is sending a backup. stopping: This WAL sender is stopping. Synchronous state of this standby server. Possible values are: async: This standby server is asynchronous. potential: This standby server is now asynchronous, but can potentially Sync State >=9.2 become synchronous if one of the current synchronous ones fails. sync: This standby server is synchronous. quorum: This standby server is considered as a candidate for quorum standbys. Sending lag >=9.2 Lag in sending the transactions to standby Last replay location >=9.2 Gives the last replayed location Write lag >=9.2 Lag in writing transaction to disk in standby. Flush lag >=9.2 Lag in flushing transactions to disk in standby. Replay lag >=9.2 Lag in replaying the transactions on standby Total lag >=9.2 Total lag sending from master to replaying transaction on standby. Master Host >=9.6 Host details of master node. Master Port >=9.6 Port of master node. Master User >=9.6 User details of the master node. Time lag between the last received transaction and the last replayed Replication Delay >=9.1 transaction. Replication Slots: slot_name >=9.6 A unique, cluster-wide identifier for the replication slot. slot_type >=9.6 The slot type - physical or logical. active >=9.6 True if this slot is currently actively being used. The address (LSN) of oldest WAL which still might be required by the consumer restart_lsn >=9.6 of this slot and thus won''t be automatically removed during checkpoints. The address (LSN) up to which the logical slot''s consumer has confirmed confirmed_flush_lsn >=9.6 receiving data. Data older than this is not available anymore. NULL for physical slots. Configuration Parameter DescriptionVersion Version of the PosgreSQL Server. Config File Location of Postgres server configuration file. Data Directory Location of data directory used by the Postgres server. External PID File Location of external PID file. hba File Location of hba file. ident File Location of ident file. Apache HBase Monitoring Apache HBase - An Overview Monitoring Apache HBase - What we do Adding a new Apache HBase monitor Monitored Parameters Apache HBase - An Overview Apache HBase is a distributed, scalable, data store. Being open-sourced and non-relational, HBase is the database for you when you need random, real-time read/write access to your Big Data. Apache HBase provides Google''s Bigtable-like capabilities on top of Hadoop and HDFS. Monitoring Apache HBase - What we do. Applications Manager aims to help Apache HBase administrators monitor the cluster in terms of region distribution. Let’s take a look at what you need to see to monitor Apache HBase, the performance metrics to gather and how you can ensure that your HBase database is up and operating as expected with Applications Manager: Track HBase cluster metrics - Monitor HBase clusters to make sure your HBase cluster is up and running and is continuously operating as expected. Track the average load, requests, and the number of dead, live and overall number of region servers. Memory and JVM usage - Track memory usage details such as available memory, free and total swap space size, the committed virtual memory size, etc. Keep track of JVM metrics to correlate server performance. Guage Region servers performance - Get metrics about the block cache, the cache hit and miss counts and the hit ratio. Look at compaction metrics and and the total size of storage files that have been compacted. Fix performance problems faster - Get instant notifications when there are performance issues with the components of Apache HBase components. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues.   Apache HBase - Adding a new monitor Supported versions: HBase version 1.x Prerequisites for monitoring Apache HBase: JMX MBeans are used to collect HBase metrics. To enable JMX, open HBase/conf/HBase-env.sh and uncomment/add the below JVM arguments. export HBase_JMX_BASE="-Dcom.sun.management.jmxremote.ssl=false - Dcom.sun.management.jmxremote.authenticate=false" export HBase_MASTER_OPTS="$HBase_MASTER_OPTS $HBase_JMX_BASE - Dcom.sun.management.jmxremote.port=10101" export HBase_REGIONSERVER_OPTS="$HBase_REGIONSERVER_OPTS $HBase_JMX_BASE - Dcom.sun.management.jmxremote.port=10102" Using the REST API to add a new Apache HBase monitor: Click here To create an Apache HBase Monitor, follow the steps given below:  Click on New Monitor link. Choose Apache HBase. Enter Display Name of the monitor. Enter the IP Address or hostname of the host in which HBase is running. Enter the JMX Port in the JMX Port field. For default installations of HBase, the JMX port number is 10101 for Master and 10102 for RegionServer.Enter the credential details like user name, password and JNDIPath or select credentials from a Credential Manager list. If no authentication is required, then leave the fields blank. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Apache HBase Server. Choose the Monitor Group from the combo box with which you want to associate Apache HBase Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Apache HBase from the network and starts monitoring. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on HBase under the Database Table. Displayed is the HBase bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview IPC Master Region Server Details RegionServer Region Details Region Server Details HLog Configuration Overview Parameter Description HBase MASTER OVERVIEW Average Load The average number of regions served by each region server. Dead Region Servers The number of dead region servers. Count Region Servers Count The number of online region servers. Cluster Requests / Min The total number of requests from all region servers to a cluster per minute. HBase JVM METRICS Total Heap Memory Calculates the total heap memory in MB. Used Heap Memory Calculates the heap memory used in MB. Committed Heap Calculates the heap memory committed in MB. Memory Total Garbage Total JVM garbage collection. Collections MEMORY DETAILS Free Physical Memory The amount of free physical memory in Megabytes. Size Free Swap Space Size Total amount of free swap space in Megabytes. Total Physical Memory Total amount of physical memory in Megabytes.Size Total Swap Space Size Total amount of swap space in Megabytes. Committed Virtual The amount of virtual memory that is guaranteed to be available to the running process Memory Size in Megabytes. THREAD DETAILS Timed Waiting Threads The number of threads that are waiting for another thread to perform an action for up to Count a specified waiting time. Waiting Threads Count The number of threads waiting for another thread to perform a particular action. Blocked Threads Count The number of threads that are blocked waiting for a monitor lock. Runnable Threads The number of threads that are being executed in the JVM Count IPC Parameter Description IPC DETAILS Number of Open Connections The number of open connections at the RPC layer. Total Call Time The total call time, including both queued and processing time. Number of Active RPC Handlers The number of RPC handlers actively servicing requests. Number of Calls In Replication The number of currently enqueued operations received from replication. DATA TRANSFERRED Sent Data The number of bytes of sent data in the call queues. Received Data The number of bytes of recieved data in the call queues. EXCEPTIONS Out of Order Scanner Exception   Unknown Scanner Exception   Region Too Busy Exception The region server is too busy exception. Master - RegionServer Parameter Description REGIONS IN TRANSITION Regions in Transition Counts the number of regions in transition. Regions in Transition Counts the number of regions in transition that exceed the threshold as defined by the over Threshold property rit.metrics.threshold.time. REGION SERVERS Name The name of the region server. Start Time The HBase master start time. Region Server - Region Details Parameter Description STORE FILES Store File Count The number of store files in the RegionServer. Store File Size The total size of the store files (data files) in the RegionServer. MEMSTORE Memstore Size The total Memstore memory size of the RegionServer. COMPACTION DETAILS Compactions Completed Count Total number of compactions completed since startup by the nodes. Num Bytes Compacted Count The number of bytes compacted across all this entity''s hregions. Num Files Compacted Count The number of files compacted across all this entity''s hregions.HLog COUNT Delete Count The total number of Delete requests in the RegionServer. Increment Count The total number of Increment requests in the RegionServer. Append Count The total number of Append requests in the RegionServer. Mutate Count The total number of Mutate requests in the RegionServer. OPERATIONAL LATENCY - SCAN NEXT Scan Next Num Operations The numer of Scan Next operations across all this entity''s hregions. Scan Next Min The minimum latency for Scan operation in the RegionServer. Scan Next Max The maximum latency for Scan operation in the RegionServer. Scan Next Mean The mean latency for Scan operation in the RegionServer. Scan Next Median The median latency for Scan operation in the RegionServer. OPERATIONAL LATENCY - GET Get Num Operations The total number of Get requests per second in the RegionServer. Get Min The minimum latency for Get operation in the RegionServer. Get Max The maximum latency for Get operation in the RegionServer. Get Mean The mean latency for Get operation in the RegionServer. Get Median The median latency for Get operation in the RegionServer. Region Server Details Parameter Description CACHE DETAILS Block Cache Count The number of Store Files cached in the block cache. Block Cache Eviction Count The total number of blocks that have been evicted from the block cache. Block Cache Free Size The number of bytes that are free in the block cache. Block Cache Express Hit The block cache hit percent for requests where caching was turned on. Percent Block Cache Hit Count The total number of block cache hits for requests, regardless of caching setting. Block Cache Count Hit Percent The block cache hit percent for all requests regardless of the caching setting. The total number of block cache misses for requests, regardless of caching Block Cache Miss Count setting. Block Cache Size The number of bytes used by cached blocks. SLOW OPERATIONS COUNT Slow Append Count The number of appends that took more than 1000 ms to complete. Slow Get Count The number of gets that took more than 1000 ms to complete. Slow Put Count The number of puts that took more than 1000 ms to complete. Slow Increment Count The number of increments that took more than 1000 ms to complete. Slow Delete Count The number of deletes that took more than 1000 ms to complete. HLog Parameter Description HLog FILES SPLIT TIME HLog Split Time Mean The average time to split the total size of a write-ahead log file. HLog Split Time Min The minimum time to split the total size of a write-ahead log file. HLog Split Time Max The maximum time to split the write-ahead log file after a restart. HLog Split Time Num Operations The time to split write-ahead log files. HLog FILE SPLIT SIZE HLog Split Size Mean The average time to split the total size of an HLog file. HLog Split Size Min The minimum time to split the total size of an HLog file.HLog Split Size Max The maximum time to split the total size of an HLog file. HLog Split Size Num Operations The size of write-ahead log files that were split. Configuration Parameter Description CONFIGURATION VM Name The Java virtual machine implementation name. Boot Class Path The boot class path that is used by the bootstrap class loader to search for class files. VM Vendor The Java virtual machine implementation vendor. Spec Version The version of the JMX specification implemented by this product. SAP MaxDB Monitoring (Add-On) SAP MaxDB - An Overview Monitoring SAP MaxDB - What we do Adding a new SAP MaxDB Monitor Monitored Parameters SAP MaxDB - An Overview The SAP MaxDB database (formerly SAP DB), developed and supported by SAP AG, is a compliant relational enterprise database system  available on Microsoft Windows, Linux and Unix, and other prominent hardware platforms. Monitoring SAP MaxDB - What we do Applications Manager''s SAP Monitoring aims to help database admins with tuning their SAP MaxDB, ensuring the availability and performance of production databases, and gathering operating system level data to understand performance issues from your infrastructure and applications to your end-user experience. System And Memory Details - Check which operational state the database is in, gather information about the size and efficiency of the caches of the database. Track the number of accesses to caches and cache hit rates Data and Log Area Stats - Regularly check data and log volume and confirm that there is sufficient free space in the data and log areas and know if the maximum number of database sessions has been reached.   Data Cache and OMS Heap Usage - Analyze the Data Cache with Hit-rate metrics and OMS Heap consumption Lock Activity and Session Management - Get information about the maximum number of available database locks (entries) so you can raise the value of maximum locks allowed when the set number approaches the number of available locks. Monitor Schema Statistics like table sizes and growth. Identify the top tables in MaxDB query. Backups and Backup Template Metrics - Regularly check whether your backups are intact and have not failed. Generate the backup history to display backups have been carried out and whether they were successful. Monitor the log backup and the archiving for the backup files. Check regularly that automatic log backup is activated. Creating a new SAP MaxDB monitor Prerequisites for setting up SAP MaxDB monitoring: sapdbc.jar should be copied to Appmanager_Home\working\classes folder. By default, this jar will be available under  \runtime\jar\sapdbc.jar. Note: X-Server in SAP MaxDB should be running when the user sets up the SAP MaxDB Monitor Creating a new Monitor To create a new SAP MaxDB monitor, follow the steps given below: Click on New Monitor link.Select SAP MaxDB under the Database category. In the add monitor window, enter the Host Name of MaxDB server. Enter the Port as X-Server port (default port is 7210). Enter your Database Username and Password. Enter the Schema /Database Name. Enter Timeout in minutes i.e the Session Timeout. Click Add Monitor. Monitored Parameters Overview Data Area Log Area Session Cache Stats OMS Heap Schema and Tables Resource Monitor Locks Backup Overview Parameter Description SYSTEM DETAILS The State of the Database. A database can be in one of the following operational states. ONLINE: The database is running and can be used by database system Database State administrator, DBM operators and database users with the corresponding authorizations. ADMIN: The database is only available for administration tasks. OFFLINE: The database is not running. The database instance type: Instance Type OLTP LiveCache (You can only use liveCache technology with SAP applications) DB Speed   The run directory of the MaxDB database where the database system saves Running Directory configuration and log files. Kernel Version The database kernal version. MEMORY OVERVIEW The I/O buffer cache is the alloted working memory area used by the database I/O Buffer Cache system for I/O operations (data cache, converter and other caches). Data Cache The alloted size of the data cache. Converter The alloted size of the converter cache. File/Directory Used Size The space currently used by the file directories in MB. The size of the catalog cache that is available for the database user to maintain the Catalog Cache frequently accessed sections of the catalog. The size of shared SQL caches. The shared SQL caches hold already executed SQL Shared SQL Data queries, thus memory is kept to a minimum. The size of sequence cache. The sequence cache stores current values of database Sequence Cache sequences. OMS Heap The size of the OMS heap portion of main memory. Log Queue Cache The size of the log queues. The log queue contains the log entries of the current transactions (redo log entries) and writes them to the log volumes using the logwriter. Block Allocator The amount of memory currently used by block allocators in MB. The free space in the I/O buffer cache in MB. Ideally, this value should be high. A Unused Size very low value of this measure indicates the need to reset the CACHE_SIZE. IO Management The current size of the I/O management. Index Creation The current rate at which indexes were being created. DATA CACHE Data Cache The alloted size of the data cache. OMS Data The size of the OMS heap. SQL Data The size of area occupied by SQL data. The size of the used pin area. (Data that is to be kept for a longer time from being Used Pin Area displaced from the data cache is held in a special area of the data cache, the pin area.) History/Undo   Changed Data   Data Area Parameter Description DATA AREA INFO Total Data Area The total size of the data area in MB. Used Data Area The memory in data area that is currently used for data. Used Data Area The percentage of memory in data area that is currently used for data. Free Data Area The data area that is currently available for data. Free Data Area The percentage of data area that is currently available for data. Permanent Data Size The data area that is currently used for permanent data. Temporary Data Size The data area that is currently used for temporary data. Permanent Converter Size The space in the I/O buffer cache that is permanently used by the converter. Temporary Converter Size The space in the I/O buffer cache that is temporarily used by the converter. Size of an incremental The size of an incremental backup. An incremental backup contains only data that is backup new or has changed since the last backup, regardless of the type. Shadow Data Size   DATA VOLUME Volume Id The unique identifier of the Data Volume. Total Volume Size (MB) The total size of the data volume, both used and free. Used Volume Size (MB) The amount of data that has been written to the volume in the data area. Used Volume Size (%) The percentage amount of data that has been written to the volume in the data area. Path   The Data Volume Path. Log Area Parameter Description LOG AREA INFO The logging status, i.e if logging is currently happening (The database system writes the redo log entries of transactions in the log segments of the log area.) Possible values are: Logging Status Yes= Logging is currently happening. No= Logging is not happening. Auto Overwrite Specifies whether overwrite mode is activated for the log area. Possible Values are: YES= The Log area is overwritten cyclically, log backup is not possible; NO= The log area is not in overwrite mode.Specifies if Log Writer is Enabled. The log writer writes the redo log entries from the log queues to the log area. The log writer is a task in the user kernel thread. Possible Values are: Log Writer Status YES= The Log Writer is not enabled. NO= The Log Writer is enabled. The state of the device. Possible Values are: Device State Active Passive Specifies if the log area is full (no space left on the log volumes). Possible Values are: Is Log Area Full YES - The log area is full. NO - The log area is not full. Flush Mode   Total Log Area The total area taken up by all the log volumes in a database instance. Used Log Area The size of the log area currently utilized in MB. Used Log Area The percentage size of the log area currently utilized. LOG VOLUMES Volume Id The unique identifier of the Log Volume. Total Size (MB) The total size of the log volume, both used and free in MB. Used Volume Size  (MB) The amount of logs that has been written to the volume in the log area in MB. Used Volume Size  (%) The percentage amount of logs that have been written to the volume in the log area. Path   The Log Volume path. Session Parameter Description SESSION Max No.of Sessions The maximum number of sessions a user can open on the database. Used Sessions The number of currently active database sessions. Used Sessions Percentage The percentage of currently active database sessions. Cache Stats Parameter Description CACHE HIT RATE Cache Name The name of the cache. The time data was retrieved from the database cache in the last measurement Hit Rate period. CACHE STATISTICS Name The name of the cache. Access Count The number of times the cache was accessed. Successful Access Count The number of times the cache was successfully accessed. Unsuccessful Access The number of times the cache access was unsuccessful. Count The percentage of time data was retrieved from the database cache in the last Hit Rate (%)   measurement period. OMS Heap Parameter DescriptionOMS HEAP STATISTICS Allocator Name The name of the memory allocating process. Reserved Memory (KB) The total memory allocated by the process. Used Heap (KB) The current memory usage. Used Heap (%) The percentage of current memory usage. Max Heap Usage (KB)    The maximum value allowed for the size of the heap. Schema and Tables Parameter Description SCHEMA DETAILS Schema Name The name of the schema. Tables Count The number of system tables in the Schema. Schema Used Size (MB) The space used for tables and indexes that belong to the schema in MB. TOP 10 LARGE TABLES Schema Name The name of the schema. Table Name The name of the table. Table Used Size (KB) The amount of space used by the table in KB. Row Count The number of rows in the table. Resource Monitor Parameter Description TOP 10 FREQUENTLY CALLED QUERIES Cmd ID The command ID. SQL Query The SQL Query called. Called Count The number of queries called. Row Reads The number of full-row reads. Virtual Reads The number of reads (page accesses). Collision on SQL Locks The number of SQL lock requests that could not be satisfied. Collision on internal Locks The number of internal lock requests that could not be satisfied. I/O access The number of I/O accesses to disk (reading and writing). Rows fetched The number of rows fetched. Locks Parameter Description LOCKS USAGE Maximum Locks The number of available locks in the lock list Used Locks The number of used locks. LOCK STATISTICS The number of situations where at least two transactions collided with each other DeadLocks due to held and requested locks in such a way that this collision can be resolved only by implicitly ending a transaction. SQL Lock Collisions The number of SQL lock requests that could not be satisfied (immediately). OMS Lock Collisions The number of OMS lock requests that could not be satisfied (immediately). Lock Escalations The number of lock escalations Row Locks The number of row locks held. Table Locks The number of table locks held. SQL Request Timeout The number of SQL lock requests that could not be satisfied because they had Locks exceeded the maximum wait time.OMS Request Timeout The number of OMS lock requests that could not be satisfied because they had Locks exceeded the maximum wait time. Backup The number of pages read/written during the I/O operation Parameter Description LAST/CURRENT BACKUP DETAILS Latest ThreadID The Id of the latest SAP MaxDB thread created inside the SAP MaxDB kernel process. Latest Backup Thread The name of the latest SAP MaxDB thread created inside the SAP MaxDB kernel Name process. Specifies if Automatic Log Backup is enabled. If you have activated Automatic Log Automatic Log Backup Backup, the database system backs up the redo log entries automatically Latest Backup IO Count The number of I/O operations. Latest Backup IO Page The number of pages read/written during the I/O operation. Count Latest Backup IO Time The total time of the I/O operations. Latest Backup Pending IO The number of pending I/O operations. Count Latest Backup Path The latest data backup path. RECENT BACKUP TEMPLATE DETAILS The name of the backup template. This has no influence on the name of the backup Backup Template Name created later using this backup template. Backup ID The template ID. The backup action that is scheduled in the template (for example, data backups, log Backup Action backups, updates of SQL Optimizer statistics, and database structure checks). These are then performed at the specified time. Backup Start Time The start time of the backup. Backup End Time The end time of the backup. Backup Size (Pages) The size of full and incremental backups together. Backup Result Result obtained in last template backup. Backup Error Result obtained in last template backup, if any. Sybase Replication Server Monitoring Overview Sybase Replication Server is a ‘data movement’ product, which moves data from one place to another. More specifically, it captures database transactions in one database and then applies these to another database. Creating a new Sybase Replication Server monitor Supported Versions: Applications Manager supports monitoring of Sybase Replication Server v15.7 and above. Using the REST API to add a new Sybase replication server monitor: Click here To create a Sybase replication server monitor, follow the given steps: Click on Add New Monitor link under New Monitor. Select Sybase Replication. Enter the display name of the monitor. Enter the Host Name or IP Address of the host. Enter the SubNetMask  of the network. Enter the port number in which sybase is running. Enter the polling interval time in minutes. Enter the credential details like user name and password for authentication along with the database name, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. If you are adding a new monitor from an Admin Server, select a Managed Server.Choose the Monitor Group from the combo box with which you want to associate Sybase database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Sybase replication server from the network and starts monitoring them. Monitored Parameters Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. Click on the following tabs listed to view the following information: Overview Threads Connections Configuration Overview Parameters Description CONNECTION TIME Connection Time Time taken to get connected to the Sybase replication server (in milliseconds). MEMORY UTILIZATION Current Memory Amount of memory currently being used by replication server (in MB). Usage Max Memory Usage The maximum amount of memory allocated for use to the replication server (in MB). Memory Usage Amount of memory used by the replication server (in percentage). Disk Utilization Partition Name & ID Name of the partition and its corresponding ID. Partition Location Location of the partition on the disk. Current state of the partition. Possible values are ON-LINE – The device is normal State OFF-LINE – The device cannot be found DROPPED – The device has been dropped but has not disappeared (some queues are using it) Total Segments (MB) Total amount of segments available on the partition (in MB). Used Segments Amount of segments currently in use from the partition (in MB). (MB) Free Segments (MB) Remaining amount of segments available after use on the partition (in MB). Disk Used (%) Amount of disk space utilized by the partition (in percentage). Disk Free (%) Remaining amount of disk space available after use on the partition (in percentage). Disk Usage Graphical representation of amount of disk utilized by the partition (in percentage). Threads Parameters Description Thread Details PID A unique process identifier for a thread running in the replication server. Name Name of the thread running in the replication server. Current status of the thread. Possible values are Active, Awaiting Command, Awaiting I/O, State Awaiting Message, Awaiting Wakeup, Connecting, Down, Getting Lock, Inactive, Initializing, or Suspended. Info Displays information about threads running in the replication server.Connections Parameters Description Logical Connection Details PID A unique process identifier for the connection running in the replication server. Logical Connection The logical data server and database names for the connection. Name Active Connection The data server and the database names for the current active database connection. Name Active Connection Status of the active connection. Possible values are Active, Suspended, or Suspended by State error. Standby Connection The data server and the database names for the current standby database connection. Name Standby Connection Status of the standby connection. Possible values are Active, Suspended, Suspended by State error, or Waiting for marker. Replication Server Name of the replication server. Name The description of the operation in process. Possible values are None, Switch Active, or Operation Create Standby. Operation State State of the operation in process. Configuration Parameters Description Configuration Details RSSD/ERSSD Dataserver Name of the RSSD/ERSSD dataserver. Intallation Information Displays the installation information of the replication server. Log File Displays the name and location of the log file. NoSQL Database Servers NoSQL databases defined as a non-relational, distributed database, are gaining recognition as an alternative mode to the relational database management system among the organizations. Inspite of the fact that NoSQL databases have a number of significant advantages, they share almost an equal set of setbacks. However when used appropriately, NoSQL databases can offer real benefits. How will you ensure a smooth and unruffled operation of these boundless unstructured data? Applications Manager provides NoSQL database monitoring, helping you to keep track of how the database is used and alerts you on any threshold breaches ensuring the performance of the database to the highest standards. The Applications Manager functionality includes the ability to collect metrics like Bytes received / sent per minute helping to monitor the network traffic, Transaction details, response time, number of open connections, items cached, etc., from the NoSQL database and present them using our dashboard in a simple and impactful manner. The different NoSQL database servers supported are: CassandraDB Server CouchBase Server MongoDB Server Redis Server Memcached Database Server Oracle NoSQL Browse through the different database servers that provide server information and their parameters being monitored. Cassandra Database ServersCreating a new Cassandra DB monitor Using the REST API to add a new Cassandra monitor: Click here To create a Cassandra database server monitor, follow the steps given below: Click on New Monitor link. Select Cassandra. Specify the Display Name of the Cassandra monitor Enter the HostName or IP Address of the host where Cassandra server runs Enter the JMX Port where the server is running. By default, it will be 7199 or else check in cassandra-env.sh file for the JMX_PORT. If you want to discover only this node, disable the option Discover all nodes in the Cluster. By default, it is enabled which means all the nodes in the cluster are discovered by default Check the Is Authentication Required field, to give the JMX credentials to be used to connect to the Cassandra server. Now enter the UserName and Password of the credential Specify the Polling Interval in minutes If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Cassandra server to, from the combo box (optional). You can choose multiple groups to associate your monitor Click Add Monitor(s). This discovers the Cassandra server from the network and starts monitoring it Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Monitored Parameters Applications Manager monitors attributes of your Windows Server Cluster components - nodes in a cluster, cluster networks, resource groups and critical cluster events. You can also configure thresholds to the numerical attributes monitored by the server based on these details. Availability tab shows the Availability history of the Cassandra database for the past 24 hours or 30 days. Performance tab shows the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. Click on the individual monitors listed to view the following information in the below tabs: Monitor Information Performance Pending Tasks Cluster Stats Messages Configurations Monitor Information This tab displays the basic information like the name of the server, host name and the JMX port where the server is running. Additional parameters like Token, Gossip Active, Load, Generation No, Uptime, DataCenter, Rack Name are also displayed. These are the equivalent of the Nodetool result got using the command ''nodetool.bat/sh -h -p info'' Performance Parameters Description Availability and Performance History Displays the availability and performance history for the last six hours. CPU Usage (available till version Specifies the usage of CPU in percentage. 2.1.13) Memory Utilization Specifies the used, free and total memory of the server in mega bytes Exceptions (available till version Count of various exceptions such as not found, invalid, unavailable, 2.1.13) timed out, etc.Parameters Description Storage Stats Specifies the storage load in GB. Operation Stats (available till version Number of range, read and write operations per second since executor 2.1.13) start. Operation Latency (available till The latency of range, read and write operations since the last time the version 2.1.13) attribute was read. Bloom Filter Statistics (available from Version 2.0.9 onwards) Number of false positives (Occurs when the bloom filter says a non- Bloom Filter False Positives existential row exists) Bloom Filter False Positive Ratio Fraction of all bloom filter checks resulting in a false positive Bloom Filter Disk Space Used The size of the bloom filter files on disk Memtable Statistics (available from Version 2.0.9 onwards) Memtable Columns Count Total number of columns present in memtable Memtable Data Size Amount of data stored in memtable, including column-related overhead Memtable Switch Count Number of times flushing results in the memtable being switched out Client Details Connected Native Clients Number of Native Clients currently connected to the server instance Connected Thrift Clients Number of Thrift Clients currently connected to the server instance Average Operational Latency (available till version 2.1.13) Average Range Latency The average latency per range operation since the last poll Average Read Latency The average latency per read operation since the last poll Average Write Latency The average latency per write operation since the last poll Operational Timeouts (available till version 2.1.13) Number of read, write and range slice operation timeouts since the last Recent Timeouts poll Pending Tasks Parameters Description COMMITLOG/COMPACTION - PENDING TASKS (available till version 2.1.13) Commitlog - Number of Commitlog tasks waiting in the queue to be executed. Pending Tasks Compaction - Number of Compaction tasks waiting in the queue to be executed. Pending Tasks COMMANDS/RESPONSES - PENDING TASKS (available till version 2.1.13) Commands - Number of Command tasks waiting in the queue to be executed. Pending Tasks Responses - Number of Response tasks waiting in the queue to be executed. Pending Tasks Task Statistics of Status of various stages of thread pools like active and pending tasks, completed and Thread Pools blocked tasks are being displayed. These are equivalent of the Nodetool result got using (available till the command ''nodetool.bat/sh -h -p tpstats''. version 2.1.13) Cluster Stats Parameters Description Cluster Details Specifies details on live, leaving, moving, joining and unreachable nodes. Cluster Node Details Health status and storage load (in GB) of the nodes in the cluster. Messages This tab contains the Dropped Message and Message Timeout statistics:Parameter Description Recent Total Timeouts Number of timeouts since last poll Configurations This tab contains the configuration values of files that are part of cassandra.yaml config file. CouchBase Monitoring Overview CouchBase Server is an open-source, distributed NoSQL document-oriented database and key-value store that is optimized for interactive applications. CouchBase is designed to provide easy-to-scale key-value or document access with low latency and high sustained throughput. Applications Manager helps to actively monitor all aspects of a CouchBase server like health, availability, response time etc., and helps take informed decisions in case of downtimes. Creating a new CouchBase server monitor Using the REST API to add a new CouchBase monitor: Click here To create a CouchBase server monitor, follow the steps given below: Click on New Monitor link. Select CouchBase from Database Servers. Specify the Display Name of the CouchBase monitor. Enter the HostName or IP Address of the host where CouchBase process runs. Enter the Port where the server is running.By default, it will be 8091. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the CouchBase server to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the CouchBase server from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on CouchBase under the Database table. Displayed is the CouchBase bulk configuration view distributed into three tabs: Availability tab, gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the database details listed under the following tabs: Monitor Information Performance Overview Server Nodes Data Buckets Monitor Information: This tab contains all general information regarding the monitor like Monitor name, port, hostname, username, associated groups etc. Performance Overview Parameters Description Total Memory (MB) Total memory available for the cluster. Used Memory (MB) RAM usage of the cluster. Free Memory (MB) Free memory available.Cluster Disk Utilization (GB) Total disk usage of the cluster. Total Cluster Storage (GB) Total disk space available for the cluster. Other Data (GB) Disk used by other data other than Couchbase. Usable Free Space (GB) Maximum free space available for Couchbase server. Server Nodes Parameters Description Server Node Name Server IP address where the Couchbase is running. RAM Usage RAM usage of the server. Swap Usage Swap usage of the server CPU Usage CPU usage of the server. Data Usage Data usage of this node. Disk Usage Disk usage of this node. Node Memory Utilization Memory Utilization of the alloted memory. Active Items Active data is the data written in this node. Replica Items Replica item is the copy of item from another node. Node Disk Usage Individual node disk consumed by Couchbase. Background Data Fetches Data not in cache and pulled from the disk. Data Buckets Parameters Description Data Buckets Bucket Name Name of the bucket. Bucket Type Bucket type can be either Memcached or CouchBase. Nodes Number of nodes available in the CouchBase server. Item Count Number of objects stored in the bucket. Used RAM Quota Memory used from the given quota (in MB). RAM Quota Memory allocated for this bucket (in MB). Quota Memory Amount of memory utilized from the available quota (in %). Utilization Data Usage Data used by this bucket (in MB). Disk Usage Disk used by this bucket (in MB). Docs Indicates how much fragmented data is to be compacted compared to real data for the Fragmentation data files in this bucket (in %). Number of back-offs sent per second to client SDKs due to "out of memory" situations from OOM/sec this bucket. Current The number of connections per host. Connections Resident item ratio Ratio of items that are kept in memory versus stored on disk. Total disk drain Number of items actually written to disk from the disk queue. rate Memory Headroom This value indicates when you need to  allocate more memory to a bucket. Bucket Operation Details Bucket Name Name of the bucket. Ops/sec Number of operations per second for this data bucket. Gets/sec Number of reads (GET operations) per second from this bucket. Total Gets/sec Total number of GET operations per second from this bucket. Sets/sec Number of writes (SET operations) per second to this bucket Deletes/sec Number of delete operations per second for this bucketCAS Ops/sec Number of operations with a CAS ID per second for this bucket. Ratio of the objects fetched from disk as opposed to memory (in %). Value should be as for Cache Miss Ratio be as close to 0 performance. Bucket Disk Details Bucket Name Name of the bucket. Disk Creates/sec Number of new items created on disk per second for this bucket. Disk Updates/sec Number of items updated on disk per second for this bucket. Disk Reads/sec Number of reads per second from disk for this bucket. Disk Fetches/sec Number of operations required to fetch the items from disk. Disk Write Queue Number of items waiting to be written to disk in this bucket. Disk Write Failures Number of disk write failures. Disk Read Failures Number of disk read failures. Disk Usage Disk used by this bucket (in MB). MongoDB Database Monitoring MongoDB - An Overview Adding a new MongoDB  monitor Monitored Parameters MongoDB - An Overview MongoDB is a NoSQL database designed for ease of development and scalability to support massive data processing and storage. With Applications Manager''s MongoDB monitoring capability, we''re letting users gain in- depth visibility into critical metrics to optimize their data infrastructures. Users can collect statistical data like Memory Utilizations statistics, open connections statistics, CPU usage, database operation performance and latency, transaction details, response time, lock current queue and journaling statistics. Applications Manager features graphs, custom dashboards and automated alerts to track performance and resource utilization of your database systems from a centralized console. Creating a new MongoDB monitor Supported Versions MongoDB 4.2 and older versions. We support mongod services and mongos services Prerequisites for monitoring MongoDB: Click here Using the REST API to add a new MongoDB monitor: Click here To create a Mongo database server monitor, follow the steps given below: Click on New Monitor link. Select Mongo. Specify the Display Name of the Mongo monitor. Enter the HostName or IP Address of the host where MongoDB/mongo process runs. Enter the Port where the server is running.By default, it will be 27017. To discover only this node and not all nodes in the ReplicaSet / Sharding disable the option Discover all nodes in the ReplicaSet / Sharding. By default, it is enabled. Check the Is Authentication Required field, to give the credentials to be used to connect to the MongoDB server. Now enter the UserName and Password of the credential. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the MongoDB server to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the MongoDB server from the network and starts monitoring it. Monitored Parameters MongoDB is monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the monitors of MongoDB. You can also configure thresholds to the numerical attributes monitored by the server based on these details.Go to the Monitors Category View by clicking the Monitors tab. Click on MongoDB under the Database Table. Displayed is the Mongodb bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Following are the list of tabs that are shown in MongoDB monitor: Monitor Snapshot Server Stats Replica Stats Operation Details Cache Details Configuration Monitor Snapshot The Monitor Snapshot tab displays the availability and performance history for the past 6 hours. The business view will help you have an integrated high-level view of the links between the different nodes in the replica set or sharding server. However, this view will not be available for single servers that are not part of any replica set or sharding server. Server Stats Parameters Description Performance Status Specifies the used and free memory of the server in percentage. Memory Utilization Specifies the used, free and total memory of the server in mega bytes. Number of used and available connections in the database server. This will Current Connections help to asses the current load and capacity requirements of the server. Specifies the amount of network traffic sent and received by the database, in Network Traffic bytes per second. This value will help you ensure that network traffic sent to and by the mongod process is consistent. The total number of various database operations (insert, get, query, update, Database Operations Counter command) per second since the mongod instance last started. This data helps to analyze and track the load on the database. The number of asserts (regular, warning, message, user, rollover) per Assert Errors second raised since the server process started. Lock Statistics The time, in seconds, since the database last started. Number of operations that are currently queued and waiting for the read-lock/ Lock Current Queue Details write-lock. Number of active client connections to the database, performing read/ write Lock Active Client Details operations. Background Flushes Number of times the database has flushed all writes to disk per second. Total number of seconds that the mongod processes have spent writing data Background Flushes Statistics to disk. Number of transactions written to the journal during the last journal group commit interval. A Journal is a sequential, binary transaction used to bring the database into a consistent state in the event of a hard shutdown. MongoDB Journaling Commits performs group commits when journaling, i.e., a series of operations are committed at once over many milliseconds. This is done to achieve high performance. Number of data in megabytes (MB) written to journal during the last journal Journaling Data group commit interval. Number of seconds spent for each phase of journaling in the last journal group Journaling Statistics commit interval. Note: All the metrics above in Server Stats will be displayed for a mongod device. Whereas for a mongos device, only the first six metrics will be displayed.Following are the list of metrics that are monitored in this tab: Cursors Index Counters Page Faults Cursor Timeout Memory Details Latency Details Global Lock Details Database Lock Details Database Statistics Cursors Parameters Description The maximum number of open cursors a session can have at once. You can use Number of open cursors this parameter to prevent a session from opening an excessive number of cursors. Number of timed-out cursors The number of timed out cursors since the last server restart. Index Counters Parameters Description Index Accessed The number of indexes accessed by a MongoDB statement. Indexes that reside in memory and when queried, will be served from memory Index served from Memory as long as the whole set fits in the memory. Index served from Disk Indexes that don''t fit in the memory and must be served from disk. The ratio of hits to misses. The misses is the total number of times that an operation tried to access an index that was not in memory per collection. The Miss Ratio hits is the total number of times that indexes have been accessed and the mongod was able to return the index from memory per collection. Page Faults Parameters Description The total number of page faults that occured when MongoDB reads from or Total Page Faults writes data to parts of its data files that are not currently located in physical memory or when physical memory is exhausted . MongoDB on Windows counts both hard and soft page faults. The MongoDB Page Faults Counter page fault counter may increase dramatically in moments of poor performance and may correlate with limited physical memory environments. Cursor Timeout Parameters Description Cursor Timeout Timeout value set for the cursor (in ms). Memory Details Parameters Description Memory Size Total memory size of the node (in bits). Resident Memory Amount of resident memory currently used by the database process (in MiB). Virtual Memory Amount of virtual memory currently used by the database process (in MiB). Mapped Memory Amount of mapped memory currently used by the database process (in MiB). Latency Details Parameters Description Output Latency Read Latency statistics for read requests (in hrs).Parameters Description Output Latency Write Latency statistics for write requests (in hrs). Global Lock Details Parameters Description Global Read Lock Number of read locks that are present globally. Global Write Lock Number of write locks that are present globally. Database Lock Details Parameters Description Database Read Lock Number of read locks that are present for the database. Database Write Lock Number of write locks that are present for the database. Database Statistics Parameters Description Database Name The name of the database whose statistics are being monitored. The number of the Collections, i.e a group of MongoDB documents, in the Collections database. Objects All the json data and performance objects in a collection. Avgerage Object Size The average size of all the KEY:VALUE objects contained within the shard. Data Size The size of data stored in a collection in MB. Indexes The total number of indexes in the database. Index Size The total size of all indexes on the database in KB. File Size The size of the files that hold the database contents in MB. Replica Stats Parameters Description Status information for MongoDB’s replica set configuration. Only when the Replication Details current host has replication enabled these values will be displayed. Total number of various database replication operations (insert, update, Replication Operations Counter delete, getmore, command) per second since the mongod instance last started. These values will help to analyze the load on the replica. Total number of various database sharding and notsharding operations Sharding Operations Counter - (insert, update, delete, getmore, command) per second since the mongos Sharded/ NotSharded instance last started. Replication Buffer Count The current number of operations in the OpLog buffer. REPLICA AND SHARD Replica Count Number of replicas present in the database. Shard Count Number of shards present in the database. REPLICATION OPLOG DETAILS Total OpLog size (in MB) configured by the customer or the default value Configured oplog size configured which is 50 MB. Log length start to end The difference between the first and last operation in the OpLog (in seconds). OpLog first event time Timestamp of the first record present in OpLog. OpLog last event time Timestamp of the latest record present in OpLog. Note: The Replica Stats tab displays only replication details for a mongod device and sharding details for a mongos device. Operation Details Parameters DescriptionParameters Description OPERATION SCAN AND ORDER The total number of queries that return sorted numbers that cannot perform Operation Scan the sort operation using an index. Write Conflicts The total number of queries that encountered write conflicts. Cache Details Parameters Description CACHE SIZE Cache Configured Size Maximum size configured for the cache (in GB). Cache Current Size Size of the data currently present in cache (in GB). DIRTY CACHE Dirty Cache Size Size of the dirty data in the cache (in GB). Dirty Cache Pages Number of dirty pages into the cache (in GB). CACHE PAGES DETAILS Cache Pages Read Number of pages read into the cache. Cache Pages Write Number of pages write into the cache. UnModified Evicted Pages Main statistics for page eviction. Threads Cache Pages A document that returns statistics on yields during page acquisitions. CACHE READ AND WRITE DETAILS Cache Read Size Amount of cache read (in GB). Cache Write Size Amount of cache write (in GB). Configuration Parameters Description CONFIGURATION DETAILS HostName Host name on which the database is running. Version Version of the Mongodb database. Running Process Number of processes that are running. Process ID The process ID number. Redis Server Monitoring Creating a new Redis monitor Supported Versions: Redis 2.4 and above Using the REST API to add a new Redis monitor: Click here To create a Redis database server monitor, follow the steps given below: Click on New Monitor link. Select Redis. Specify the Display Name of the Redis monitor Enter the HostName or IP Address of the host where Redis server runs. Enter the Port where the server is running.By default, it will be 6379. Or else you can also check it in the redis.conf file. To discover only this node and not all nodes in the cluster disable the option Discover all nodes in the cluster. By default, it is enabled. Check the Is Authentication Required field, to give the credentials to be used to connect to the Redis server. Now enter the Password of the credential. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Redis server to, from the combo box (optional). You can choose multiple groups to associate your monitor.Click Add Monitor(s). This discovers the Redis server from the network and starts monitoring it. If you have added Monitors and not associated them with a Monitor Group, you can do this manually anytime. For information on associating a Monitor with a Monitor Group, refer to Associating Monitor with Monitor Groups topic. Monitored Parameters Redis database server is monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of Redis database. You can also configure thresholds for the attributes monitored by the server based on these details. Availability tab shows the availability history of the Redis database for the past 24 hours or 30 days. Performance tab shows the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. Click on the individual monitors listed to view the following information: Monitor Information Persistence Replication Monitor Information This tab displays the basic information like the name of the server, host name and the port where the server is running. Additional parameters like ProcessID, RunID, uptime and associated groups are also displayed. Performance Parameters Description Availability and Displays the availability and performance history for the last six hours. Performance History System CPU Usage Amount of CPU used by system initiated processes (in percentage). User CPU Usage Amount of CPU used by user initiated processes (in percentage). Memory Utilization Amount of memory utilized by the Redis server (in percentage). Percentage System CPU Amount of CPU used by system initiated processes (in milliseconds/minute). Usage/Min User CPU Usage/Min Amount of CPU used by user initiated processes (in milliseconds/minute). The CPU consumed by the background processes (like SORT, SUNION, BGSAVE, Children CPU Usage BGREWRITEAOF). Memory Utilization Specifies the used, free and total memory of the server in mega bytes. Memory The ratio between the number of bytes that Redis allocated as seen by the operating Fragmentation Ratio system and the total number of bytes allocated by Redis using its allocator. Connected/ Blocked Number of client connections and number of clients pending on a blocking call. Clients Rejected Connections Number of connections rejected because of maxclients limit. Connections Stats Number of connections accepted by the server per second. Operations Stats Number of commands processed per second. Keyspace Stats Specifies the number of successful and failed lookup of keys in the main dictionary. Keyspace Hit Percentage of the number of successful and failed lookup of keys in the main dictionary. Percentage Expired/ Evicted Key Displays the total number of key expiration events and the number of evicted keys due to Stats max memory limits. Publish Subscribe The global number of pub/sub channels with client subscriptions. Stats PersistenceParameters Description Displays the details about RDB and AOF persistence states like the status of the last RDB Persistence Stats save operation, status of the AOF rewrite operation, etc. Displays the details about the database, like the db name, total number of keys and Database Stats number of expired keys. Replication Parameters Description Displays if the replication role is master or slave. In case of slave, master node details Replication Details like master host, master port and status of the link, etc., are displayed. Specifies the number of slaves connected. This graph will be populated in case of Slave Connections master node alone. Memcached Servers Creating a new Memcached monitor Supported Versions: Memcached v1.2 and above. To create a Memcached database server monitor, follow the steps given below: Click on New Monitor link. Select Memcached under Cloud Computing/Virtualization category. Specify the Display Name of the memcached server Enter the HostName or IP Address of the host where Memcached server runs. Enter the Port where the server is running. If you want to enable Transaction test, select ''Yes'' radio button, otherwse select ''No'' button. Set the Polling Interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Memcached server to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Memcached server from the network and starts monitoring it. Monitored Parameters Memcached Servers are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the monitors of Memcached server. You can also configure thresholds to the numerical attributes monitored by the server based on these details. Availability tab shows the Availability history of the Memcached server for the past 24 hours or 30 days. Performance tab shows the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed to view the following information: Parameters Description Monitor Details Availability Shows the current status of the Memcached server - available or not available Performance Status Used Memory Specifies the used memory of the server in percentage Free Memory Specifies the free memory of the server in percentage Hit Ratio Refers to the hit ratio in percentage Memory Utilization Used Memory Specifies the used memory of the server in mega bytes Free Memory Specifies the free memory of the server in mega bytes Total Memory Specifies the total memory of the server in mega bytes CPU Utilization User CPU* Specifies the accumulated user time for a process in secondsSystem CPU* Specifies the accumulated system time for a process in seconds Cached Hits and Misses Hits/min Number of keys that have been requested and found present per minute Misses/min Number of items that have been requested and not found per minute GET and SET Requests Gets/min Number of retrieval requests per minute Sets/min Number of storage requests per minute Cached Items Items cached Current number of items stored by server Evictions Number of valid items removed from cache to free memory for new items Network Traffic Bytes Received Number of bytes read by this server from network per min Bytes Sent Number of bytes sent by this server to network per min Current Connections Connections Number of open connections Response Time The time taken by Applications Manager to execute the STATS command on the memcached Response Time server Version Version of Memcached server Transaction SET-Time The time taken by Applications Manager to set the content on the memcached server GET-Time The time taken by Applications Manager to fetch the content from the memcached server DELETE-Time The time taken by Applications Manager to delete the content from the memcached server Total Transaction The total time taken to connect to memcached server, set content, fetch content and delete Time content from the server * - not supported in Memcached installed in Windows Oracle NoSQL Database Server Monitoring Overview Applications Manager provides out-of-the-box performance metrics and helps you visualize the health and availability of an Oracle NoSQL server farm. Database administrators can login to the web client and visualize the status and Oracle NoSQL performance metrics. Creating a new Oracle NoSQL monitor Using the REST API to add a new Oracle NoSQL monitor: Click here Follow the given steps to create a Oracle NoSQL server monitor: Click on New Monitor link. Select Oracle NoSQL. Enter the Display Name of the monitor Enter the IP Address or hostname of the host. Enter the JMX Port in which the JMX is running. Enter the Additional JMX Port in which the JMX is already running in any of the other machine of the same cluster. Choose the Credential Details either use below credentials or select from credential list Enter the Username and Password of the Oracle NoSQL. Enter JNDI Path ex. /jmxrmi Enter the polling interval time in minutes. Choose the Monitor Group from the combo box with which you want to associate Oracle database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Oracle database server from the network and starts monitoring them. Note:Ensure that you enable JMX for Oracle NoSQL monitoring. To create a new Oracle NoSQL monitor, you should have admin privileges. In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP]  Setting up JMX for Oracle NoSQL monitoring Oracle NoSQL Database allows Java Management Extensions (JMX) or Simple Network Management Protocol (SNMP) agents to be optionally available for monitoring, in addition to the native monitoring provided by the Admin CLI and the Admin Console. These agents provide interfaces on each storage node that allow management clients to poll them for information about the status, performance metrics, and operational parameters of the storage node and its managed services, including replication nodes and admin instances. Both these management agents can also be configured to push notifications about changes in the status of any of the services, and for violations of preset performance limits. The JMX interface can be enabled in either the Community Edition or the Enterprise Edition. To use SNMP, however, you must have the Enterprise Edition. The JMX service exposes MBeans for the three types of components. These MBeans are the java interfaces StorageNodeMBean, RepNodeMBean, and AdminMBean in the package oracle.kv.impl.mgmt.jmx. For more information about the status reported for each component, see the javadoc for these interfaces. The same information that is reported via JMX can also be reported through SNMP. In this case, the information is organized according to the Management Information Base (MIB) named OracleNosqlMIB, which is included with the Enterprise Edition, in the file lib/nosql.mib. Simple Network Management Protocol (SNMP) and Java Management Extensions (JMX) Both the SNMP and JMX agents in NoSQL Database are read-only interfaces and allow you to poll the storage nodes for information about the storage node and about any replication nodes or admins that are hosted on the storage node. The available information includes service status (such as, RUNNING, STOPPED etc.), operational parameters, and performance metrics. SNMP and JMX traps/notifications are also delivered for particular events. Notifications are sent for every service status state change; and for violations of performance limits. Enabling Monitoring Monitoring can be enabled on a per-storage node basis in two different ways: In the Bootfile You can specify that you want to enable JMX or SNMP in the storage node''s boot configuration file. Usually, these files are created by using the makebootconfig utility, which has the following options to control these features: [-mgmt {snmp|jmx|none} -pollport ] -traphost ] -trapport ] Note: When you specify -mgmt snmp, you must also specify -pollport. The SNMP agent listens for connections from SNMP management clients on this port. You may also optionally specify -traphost and -trapport to indicate the destination address for notifications. This would be the hostname and port number of an SNMP management service that is configured to receive notifications at that address. Note: When you specify -mgmt jmx, you do not have to specify -pollport. A storage node''s JMX agent uses the RMI registry at the same port number as is used for all other RMI services managed by the storage node. (This port number is specified as the -port argument to makebootconfig.) By Changing Storage Node Parameters You can still enable JMX or SNMP after a store is deployed, by changing the storage node parameters "mgmtClass", "mgmtPollPort", "mgmtTrapHost", and "mgmtTrapPort". Similar to configuring via makebootconfig, the "mgmtPollPort", "mgmtClass", "mgmtTrapHost", and "mgmtTrapPort" are used only for SNMP; and the parameter "mgmtPollPort" must be set when enabling SNMP. The value of the "mgmtClass" parameter may be one of the following class names: To enable JMX: oracle.kv.impl.mgmt.jmx.JmxAgentTo enable SNMP: oracle.kv.impl.mgmt.snmp.SnmpAgent To enable neither JMX nor SNMP: oracle.kv.impl.mgmt.NoOpAgent For example, you could issue the following command in the Admin CLI to enable SNMP on a storage node: plan change-parameters -service sn1 -wait -params \ mgmtClass=oracle.kv.impl.mgmt.snmp.SnmpAgent \ mgmtPollPort=5002 mgmtTrapHost=192.168.26.42 mgmtTrapPort=32767 Note: Only a single implementation of the management agent may be enabled at a particular time. If you enable SNMP on a storage node where JMX is already enabled; the JMX agent shuts down, and the SNMP agent takes its place.  Displaying the NoSQL DB MBeans To view the NoSQL Database JMX Mbeans in a monitoring tool such as JConsole, connect using the hostname and registry port for each Storage Node that you would like to view. This is the port that is named by the "-port" argument to the java -jar kvstore.jar makebootconfig command. It is also used in the deploy-sn plan during configuration. The documentation examples use 5000 as the registry port. For example, you would specify localhost:5000 to the JConsole Remote Process connection box in the New Connection tab. Monitored Parameters Note:  To create a new Oracle NoSQL monitor, you should have admin privileges.  Jconsole can also be used to access the Mbeans Oracle NoSQL Monitoring Metrics: Admin Attributes Storage Attributes Replicated Node Table Attribute Admin Attributes Attribute Name Description Admin ID Number of an Admin instance. HttpPort The port number used by the Admin Console web application. LogFileCount Number of log files that are kept. LogFileLimit The maximum size of log files. Master Whether this Admin is the master among Admin instances. PollPeriodMillis The polling period for collecting metrics. ServiceStatus The reported service status of the Admin. Storage Attributes Attribute Name Description The number of Replication Nodes that can be hosted on this Capacity Storage Node. AdminHttpPort The http port used by the Admin Console web application. The name of the network interface used for communication HostName between Replication Nodes The range of port numbers available for assigning to Replication HAPortRange Nodes that are hosted on this Storage Node.HostingAdmin True if this Storage Node hosts an Admin instance The amount of memory known to be available on this Storage Node, MemoryMB in megabytes. A list of file system mount points on which Replication Nodes can MountPoints be deployed NumCPUs The number of CPUs known to be available on this Storage Node. RegistryPort The port number of the Storage Node''s RMI registry. RootDirPath The pathname of the store''s root directory SnId The StorageNodeId number of this Storage Node. The configured name of the store to which this Storage Node StoreName belongs. Replicated Node Table Attribute Attribute Name Description CacheSize The size of the BDB-JE cache, in MBytes. If true, then the underlying BDB-JE subsystem will dump statistics CollectEnvStats into a local .stat file. Average commit lag(in milliseconds) for a given replication node''s CommitLag update operations during a given time interval. RepNodeId The RepNodeId, in its String form Average commit lag (in milliseconds) for a given replication node during a given time interval exceeds the value returned by this CommitLagThreshold method, a notification event will be sent to any parties that have registered interest. CumulativeEnd The timestamp at the end of a cumulative measurement period. CumulativeLatAvg The average latency for single operations since service startup. The highest latency measured for single operations since service CumulativeLatMax startup. The timestamp at the beginning of a cumulative measurement CumulativeStart period CumulativeThroughput Single operations per second since service startup. CumulativeTotalOps The total number of single operations since service startup. HeapMB The size of the Java heap for this Replication Node, in MB. IntervalLatAvg Average Latency of Operations in the given Interval ERP Monitoring Below are the list of ERP monitoring tools that are monitored in Applications Manager: Oracle EBS SAP CCMS SAP Server SAP Business One Siebel Microsoft Dynamics CRM / 365 (On-Premise) Microsoft Dynamics AX Browse through the different ERP servers that provide server information and their parameters being monitored.   Oracle E-Business Suite MonitoringOracle EBS - An Overview Creating a new Oracle EBS monitor Monitored Parameters Oracle EBS - An Overview Oracle E-Business Suite (Oracle EBS) monitor allows you to monitor the availability and performance of Oracle EBS from a centralized web console. Data of Oracle E-Business Suite are collected using DMS stands for Dynamic Monitoring Service (a web application which get data from the fusion middleware components). Data that is created and updated by DMS-enabled applications and components is accessible through the DMS Spy Servlet. Only users having administrator rights can access this servlet. Creating a new Oracle EBS monitor Oracle EBS Versions Supported: R11i, R12.0, R12.1.3, R12.2.0, R12.2.5 & above. Prerequisites for monitoring Oracle EBS: Applications Manager uses the Dynamic Monitoring Service (DMS) provided by Oracle Application Server to monitor the same. For this reason, the DMS Servlet has to be made accessible to the system where the Applications Manager is running. Refer Prerequisites Section. Using the REST API to add a new Oracle EBS monitor: Click here Follow the steps given below to create a new Oracle EBS monitor in Applications Manager: Go to New Monitor. Click on Oracle EBS. Enter Display Name. Provide Host Name & Port. Select the EBS Server Version - R11i, R12.0, R12.1.3, R12.2.0, 12.2.5 & above. If you select Version R12.2.0/R12.1.3/R12.2.5 & above, a username and password details are mandatory. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. If you wish to enter your own credentials, specify username and password details for this monitor. For version R12.1.3, you will have to specify whether SSL is enabled, the instance name(service name) and concurrent request filter. Concurrent request filter can be selected from the drop down list which holds values such as pending, running and inactive. Choose SSL Enabled checkbox if SSL authentication is enabled on the server connection channel. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). Upon adding the Oracle EBS monitor, you can view the details of the newly added Oracle monitor. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Oracle EBS under the ERP Table. Displayed is the Oracle EBS bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: For Oracle E-Business Suite R11i: Performance Overview For Oracle E-Business Suite R12.0: Performance Overview Process Information Applications For Oracle E-Business Suite R12.2.0, R12.2.5 & above: Performance OverviewProcess Information Clusters Servers Applications Forms Oracle Process Manager and Notification Server Web Cache For Oracle E-Business Suite R12.1.3: Performance Overview Applications Forms details Workflow Manager Concurrent Manager For Oracle E-Business Suite R11.0 Performance Overview Parameter Description Name The name of Oracle EBS monitor. Health The health (Clear, Warning, Critical) of the server Type The type you are monitoring. Last Polled at The time at which the last poll was performed. Next Poll at The time at which the next poll is scheduled. Availability The current status of the server - available or not available. Connection Statistics Connections per Minute Number of times an HTTP connection was established. Active Connections Number of connections that are active. Requests Statistics Active Requests Number of requests that are active Completed Requests per min Number of HTTP request completed per minute Response Time Average Response Time Average Response time of the request Minimum Response Time Minimum Response time for the request Maximum Response Time Maximum Response time for the request Process Stats Process Name Name of the process like BDMSProcess Heap Size Heap memory size of the process For Oracle E-Business Suite R12.0 Performance Overview Parameter Description Active Requests Number of child servers currently in the request processing phase. Completed Requests per min Number of HTTP request completed per minute Average Response Time Average time required to service an HTTP request Min Response Time Minimum time required to service an HTTP request Max Response Time Maximum time required to service an HTTP request Active Connections Number of connections currently openConnections per Minute Number of times an HTTP connection was established. Virtual Host Processes Virtual Host Name Specifies Virtual host name. Active Requests Total time spent processing requests for this virtual host. Completed Requests Per Minute Number of requests processed completely per minute. Average Response Time Average time spent processing requests for this virtual host. Applications Parameter Description Applications Requests The echo of the value specified as the path for OC4J Mount directive in Applications mod_oc4j.conf. Success Requests per Specifies the number of requests per minute, both session and non-session together, Minute that mod_oc4j successfully routed to an OC4J instance. The number of requests per minute, both session and non-session, that mod_oc4j Error Requests per Minute failed to route to an OC4J. Sessions Success Specifies the number of session requests per minute that mod_oc4j successfully Requests per Minute routed to an OC4J instance. Sessions Error Requests The number of session requests per minute that mod_oc4j failed to route to an OC4J. per Minute Non-Sessions Success Specifies the number of non-session requests per minute that mod_oc4j successfully Requests per Minute routed to an OC4J instance. Non-Sessions Error The number of non-session requests per minute that mod_oc4j failed to route to an Requests per Minute OC4J. Process Information Parameter Description Process Details Process ID The process ID for the process. Process Name The process name. Heap Size The heap size of the process in MB. For Oracle E-Business Suite R12.2.0, R12.2.5 & above Performance Overview Parameter Description Server Name The name of the Server. Process Name of the process. For eg, opmn:/EBS_web_VIS_OHS. Min Response Time (ms) Minimum time required to service an HTTP request. Max Response Time (ms) Maximum time required to service an HTTP request. Average Response Time (ms) Average time required to service an HTTP request. Active Requests Child servers currently in the request processing phase. Completed Requests per minute Number of HTTP request completed per minute. Active Connections Number of connections currently open Connections per Minute Number of times an HTTP connection was established. Virtual Hosts Process Stats Virtual Host Name Host name of the virtual host. Server Name The name of the Server. Active Requests Number of requests currently being processed by this host.Average Response Time Average time spent processing requests for this virtual host Completed Requests Per Minute Number of requests processed completely per minute Process Information Parameter Description Process Details Process Name of the process. For eg, opmn:/EBS_web_VIS_OHS. Host Name The name of the host where the process is running. Server name The name of the Server. Heap Size The heap size of the process. Clusters Parameter Description Cluster Statistics Cluster Specifies Cluster Name Name Number of managed servers in running state. Servers in the following states are taken as running servers: RUNNING STARTING Running ADMIN Servers STANDBY RESUMING SUSPENDING FORCE_SUSPENDING Number of managed servers in shutdown state. Servers in the following states are taken as Shutdown servers: Shutdown Servers SHUTTING_DOWN SHUTDOWN Failed Number of managed servers in failed state Servers Server Status Server Specifies Server Name Name Server Specifies state of the server. Possible States are: State Starting - During the STARTING state, a WebLogic Server instance transitions from SHUTDOWN to STANDBY, as a result of a Start, Start in Admin, or Start in Standby command. Resuming - The WebLogic Server performs the operations required to move itself from the STANDBY or ADMIN state to the RUNNING state. Running -The WebLogic Server is fully functional, offers its services to clients, and can operate as a full member of a cluster. Admin - In the ADMIN state, WebLogic Server is up and running, but available only for administration operations, allowing you to perform server and application-level administration tasks. StandBy - The WebLogic Server instance transitions from SHUTDOWN to STANDBY. A server instance in STANDBY does not process any request—its regular Listen Port is closed. Suspending - The WebLogic Server performs the operations required to place itself in the ADMIN state, suspending a subset of WebLogic Server subsystems and services, and completing a predefined portion of the application work currently in process Force_Suspending - The WebLogic Server performs the operations required to place itself in the ADMIN state, suspending a subset of WebLogic Server subsystems and services in an orderedfashion. During the FORCE_SUSPENDING state, WebLogic Server does not complete in-flight work; application work in progress is abandoned. Shutdown - The WebLogic Server instance is configured but inactive. The WebLogic Server completes the suspension of subsystems and services and does not accept application or administration requests. Shutting_Down - The WebLogic Server is in the process of shutting down. Failed - A running server instance can fail as a result of out-of-memory exceptions or stuck application threads, or if one or more critical services become dysfunctional. Cluster Name of the cluster Name Servers Parameter Description Threads in JVM Server Name The name of the Server. Active Threads The number of active threads. Daemon Threads The number of daemon threads. Deadlock Threads The number of threads which are deadlock. Self-Tuning Thread Pool Server Name The name of the Server. Hogged Threads The number of threads that are being held by a request right now. Idle Threads The number of idle threads in the pool. Pending Requests The number of pending user requests in the priority queue. StandBy Threads The number of threads in the standby pool. Active Threads The total number of threads in the pool. Server Login Rate Server Name Specifies the server where metrics come Success Logins Percentage of successful logins Failed Logins Percentage of failed logins Blocked Logins Percentage of blocked logins Forms Resource Usage Server Name The name of the Server. Instance Name The name of the FMW instance home. CPU Usage The Percentage of CPU space used. Memory Usage Percentage of Total Memory Used. Private Memory Usage The total private memory used by the run-time process in MB. Resource Usage of Forms JVM Server Name Specifies server name from where metrics come CPU Usage by JVM Percentage of CPU used by form''s JVM processes Memory Usage by JVM Memory used by form''s JVM processes in MB. Applications Parameter Description Applications Status Server Name The name of the Server. Applications The name of the cluster application Cluster Name The name of the cluster in which the application is deployed Status The current status of the applicationForms Parameter Description Form Application Details Server Name The name of the Server. Form Applications The name of the Forms Application. Instance Name The name of the FMW instance home. Process The process where metrics come. Number of Sessions The total number of sessions in the application. Status The status of the application. Oracle Process Manager and Notification Server Parameter Description OPMN Components Resource Usage Server Name The name of the Server. Component Name The name of the component in server. Memory Usage The percentage of memory space used by component. CPU Usage The percentage of CPU used by the component. Web Cache Parameter Description WebCache Performance Server Name The name of the Server. Process Name The processes where metrics are monitored. The average amount of time for client requests forwarded by Oracle Web Cache to Average Latency be resolved. Processed Requests Per The number of client requests forwarded by Oracle Web Cache processed by origin Minute server The number of client requests forwarded by Oracle Web Cache that resulted in an Failed Requests Per Minute error. WebCache Requests Filter Site Name The name of the website Server Name The processes where metrics are monitored. Instance Name The name of the instance Cache Size The size of the objects currently stored in the cache Hit Rate The percentage of requests resolved by cache content Denied Request Per Minute The number of requests denied by request filters. Served Request Per Minute The number of requests that Oracle Web Cache has served. For Oracle E-Business Suite R12.1.3 Performance Overview Parameter Description Session Details Active Sessions Number of Active Sessions Inactive Sessions Number of Inactive Sessions Session Usage Sessions Usage in % Concurrent Request Count Details Pending Concurrent Request Number of Concurrent Requests which are pendingRunning Concurrent Request Number of Concurrent Requests which are running Inactive Concurrent Request Number of Concurrent Requests which are inactive Notification Mailer Count Details Pending Notification Mailer Request Number of Notification Mailer Requests which are pending Running Notification Mailer Request Number of Notification Mailer Requests which are running Inactive Notification Mailer Request Number of Notification Mailer Requests which are inactive Database Details(Average) Name Name of the Database attribute Value Data value Unsuccessful Login Unsuccesful login attempt details Applications Parameter Description Application Details Application ID Application ID Application Name Name of the application Application Code Application code Basepath Basepath Product Code Product Code Created By ID of the user who created the application Creation Time Time at which the application was created Last Updated By ID of the user who modified the application recently Last Update Time Time at which the application was modified recently Forms Details Parameter Description Forms Details Form Id Form ID Form Name Name of the form User Form Name Name of the form which is displayed to the users Last Updated Time Time at which the Form was modified recently Description Details about the form Workflow Manager Parameter Description Workflow Manager Component Name Name of component Component Type Type of component Component Status Status of the component StartUp Mode Mode of start up Last Update Time Time at which it was updated recently Creation Time Time at which it was created Concurrent Manager Parameter Description Concurrent Manager Concurrent Manager Name Name of the Concurrent ManagerConcurrent Queue Name Name of the Concurrent Queue Actual Processes Number of actual processes running Target Processes Number of target processes which are supposed to run Minimum Process Minimum number of processes which are supposed to run Cache Size Size of the cache Sleep Seconds No of seconds it can rest Manager Type Type of manager Running Status Status of the Manager- shows whether it''s running or not SAP CCMS Monitors Creating a new SAP CCMS monitor Prerequisites for monitoring SAP CCMS Monitors: SAP JavaConnector (JCo) should be present in Applications Manager''s classpath. Learn More Using the REST API to add a new SAP CCMS monitor: Click here Follow the steps given below to add a SAP CCMS monitor in Applications Manager: Click on New Monitor. Click on SAP CCMS monitor. Enter Display Name. Provide Host Name / IP Address. Check the Connect using Router String checkbox to enter the SAP Router String through which SAP Server is connected. Enter the SAP Logon client. Enter the SAP System number. Enter the SAP Logon language like EN for English. Enter the polling interval time in minutes. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Select CCMS Monitor Sets by clicking on Click Here link. It then displays a list of CCMS monitor sets present in SAP server. Select a CCMS monitor set from the list which you would like to monitor. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). Upon adding the SAP CCMS monitor, you can view the details of the newly added SAP CCMS monitor. Monitored Parameters Note: While creating a SAP monitor, you need a SAP user profile with the following authorization objects: S_RFC, S_XMI_LOG and S_XMI_PROD which are minimum prerequisities for adding a SAP monitor. Applications Manager''s SAP Monitoring allows you to monitor the availability and connection time of SAP CCMS monitors from a centralized web console. Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. The Connection time refers to the time taken by Applications Manager to connect to SAP server. You can also add performance / status / log attributes in the same page by clicking on link ''Add Attributes'' or by clicking on ''Add Custom Attributes'' under Quick Links section. The following parameters are monitored for SAP CCMS: Parameter Description Monitor Information Health Specifies the health of the monitor based on its dependencies Type Type of the Monitor Host Name Specifies the host in which SAP is runningHost OS The Operating System of the host Last Polled at The time at which last polling happened Next Polled at The time at which the next polling is scheduled Availability The current status of the SAP CCMS Monitor - whether it is up or down. Adding SAP CCMS Attributes To add a SAP CCMS monitor set''s attributes, follow the steps given below: Click on Add Attributes or Add Custom Attributes link in SAP CCMS monitor page. In the Add Attributes screen, you will find the entire set of CCMS monitoring tree elements (MTE) listed below. Click on MTE which you would like to monitor, and this will expand the entire set of attributes available inside the monitor set. Similarly, you can also select various MTE and its attributes inside available CCMS monitors. If there are no attributes present inside MTE, an error message appears: "There are no Performance / Status / Log Attributes present in this Node" Click on Add Attributes button to complete the process. If you would like to delete exisiting attributes, click on Add Custom Attributes link. In SAP Custom Attributes screen, Applications Manager will list the exisiting attributes that are being monitored and provides you the option to delete attributes. You can also enable / disable reports for the attributes in the same screen. SAP Server Monitoring Overview SAP Monitoring allows you to monitor the availability and performance of SAP environment from a centralized web console. SAP monitor takes advantage of the SAP CCMS (Computer Center Management System) architecture to give insightful information about the SAP system along with fault management and reporting capabilities. Creating an SAP Server Monitor Prerequisites for monitoring SAP Server: SAP JavaConnector (JCo) should be present in Applications Manager''s classpath. Learn more Using the REST API to add a new SAP server monitor: Click here Follow the steps given below to create an SAP server monitor in Applications Manager: Click on New Monitor. Click on SAP Server. Provide Host Name/IP Address. Enter the SubNetMask of the network. Check the Connect using Router String checkbox to enter the SAP Router String through which SAP Server is connected (optional). Enter the SAP Logon client. Enter the SAP System number. Enter the SAP Logon language like EN for English. Enter the polling interval time in minutes. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). Upon adding the SAP monitor, you can view the details of the newly added SAP monitor. Note: While creating an SAP monitor, you need an SAP user profile with the following authorization objects: S_RFC, S_XMI_LOG and S_XMI_PROD which are minimum prerequisites for adding an SAP monitor. Monitored Parameters Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. The following parameters are monitored for SAP:Overview Buffer OS Processes Background Dialog Enqueue Spool Update Alarms Background Jobs RFC Overview Parameter Description Monitor Information Health Specifies the health of the monitor based on its dependencies Type Type of the Monitor Host Name Specifies the host in which SAP is running Host OS The Operating System of the host Last Polled at The time at which last polling happened Next Polled at The time at which the next polling is scheduled Availability The current status of the SAP Monitor - whether it is up or down. System Information CPU Utilization Amount of CPU utilized by the SAP server (in percentage). Memory Utilization Amount of memory utilized by the SAP server (in percentage). Disk Utilization Amount of disk utilized by the SAP server (in percentage). Spool Utilization Amount of spool work processes utilized by the SAP server (in percentage). Amount of background work processes utilized by the SAP server (in Background Utilization percentage). Buffer Parameter Description Percentage of the database queries that were met from the buffer (hit rate) Hit Ratio and did not have to be passed on to the database for different buffer types like Program, Repository, Table & GUI Percentage usage of the directory (number of entries) for different buffer Directory Used types like Program, Repository, Table & GUI Percentage usage of the buffer storage for different buffer types like Program, Space Used Repository, Table & GUI Swaps due to a full buffer per minute for different buffer types like Program, Swap Repository, Table & GUI Operating System Parameter Description CPU Utilization Average usage of the CPU in a host system Disk Utilization Average usage of the disk in a host system Extended Memory Utilization of the extended memory as a percentage. Private Memory Utilization of the private memory as a percentage.Roll Area Usage Usage of the roll area as a percentage Average number of page-ins per second; a page-in occurs if a process must Page In access a data page that is not available in the main memory Average number of page-outs per second (page-out occurs if a page is stored Page Out out of the main memory to make room for the pages required by other processes) Number of messages per minute that appeared in the system log of an Syslog Frequency application server. Processes Parameter Description Work Processes Overview Total Work Processes Number of total work processes. Running Work Processes Number of running work processes. Waiting Work Processes Number of waiting work processes. Stopped Work Processes Number of stopped work processes. SAP Work Process Information Server Name Name of the server. The internal ID number of a process. Used to identify messages that belong to No a work process in the system log. The type of work process. Possible values are: DIA - Work process for executing dialog steps in user transactions UPD - Update process for making V1 (time-critical) database changes UP2 - Update process for executing V2 (not time-critical) database Type changes ENQ - For locking or releasing SAP lock objects BTC - For processing background jobs SPO - For spool formatting processes PID Process ID of the work process (on the operating system). Current status of the work process. Possible statuses are: Running - Process is executing a request Waiting - Process is idle and waiting for a request. Hold- Process is held for one user. A work process can only serve a single user. Status If too many processes are on Hold, then system performance suffers. You can then use the Reason field to identify holds that perhaps can be released. Stopped - Process is aborted. (Start set to No) Shutdown - Process terminated because of a shutdown. Reserved - Process is reserved. Reason Reason displayed if a work process is in Hold status. Indicates whether the process should be automatically restarted if a process Start ends prematurely. Indicates how many times a work process has aborted since the instance was Error started. Indicates the number of the semaphore for which a work process is waiting. Sem Normally, this field should be empty. CPU Cumulative CPU time used by a work process since it was started. Indicates the elapsed time used by a work process for the dialog step that it is Time currently being processed. Report ABAP program or report that is currently being executed.User User whose request is currently being processed Action that is being performed by the program that is running. The actions that Action are displayed are those that are recorded by the SAP performance monitor. Table Name of the table that is being accessed by the database. Background Parameter Description Background Processing Background Utilization Percentage of the background processing capacity currently utilized. Number of jobs that are ready to be executed, have start authorization and have no target server specified for which there are no free background work System Wide Queue Length processes, averaged over all application servers with background work processes. System Wide Free Processes Number of free background work processes Number of released jobs that are explicitly to be executed on this application Server Specific Queue Length server, but for which there are no free background work processes Background work processes Number of background work processes on an application server count Number of errors in background work processes since the monitoring segment Error count was created (that is, since the application server was started) Error frequency Number of errors in background work processes per minute Terminated on error count Number of background work processes terminated after an error Number of jobs that are ready to be executed, have start authorization and Running Background Work have no target server specified for which there are no free background work Processes processes, averaged over all application servers with background work processes. Waiting Background Work Number of free background work processes Processes Stopped Background Work Number of released jobs that are explicitly to be executed on this application Processes server, but for which there are no free background work processes Dialog Parameter Description Average time that a user waits at the front end for the processing of his or her Frontend Response Time request Database Request Time Average time for processing logical database requests Load And Generation Time Average load and generation time of CUA objects Response Time Average response time of the dialog service Time used in the network during the first data transfer from the front end to the Network Time application server and during the last data transfer from the application server to the front end. Users Logged In Number of users logged on Queue Time Average time in the dispatcher wait queue Total Dialog Work Processes Number of total dialog work processes. Running Dialog Work Processes Number of running dialog work processes. Waiting Dialog Work Processes Number of waiting dialog work processes. Stopped Dialog Work Processes Number of stopped dialog work processes. Enqueue Parameter Description Enqueue Requests Number of lock requestsEnqueue Request Rejects Number of rejected lock requests Enqueue Requests Errors Number of errors that occurred during lock requests Dequeue Requests Number of release requests Dequeue Requests Errors Number of errors that occurred when releasing locks Dequeue All Requests Number of releases of all locks of an LUW CleanUp Requests Number of releases of all locks of an application server Backup Requests Number of update calls for which locks were forwarded to the update. Reporting Requests Number of operations for reading the lock table. Owner Names Actual Utilization Current number of lock owners in the lock table Granule Arguments Actual Current number of different lock arguments in the lock table Utilization Granule Entries Actual Current number of elementary locks in the lock table Utilization Update Queue Actual Current number of open update requests with locks Time spent in the critical path of the lock table for lock operations (in seconds Recent Lock Time (per minute) per minute) Recent Lock Wait Time (per Wait time of parallel processes before entering the critical path of the lock minute) table (in seconds per minute) Recent Server Time (per minute) Total time spent in the enqueue server (in seconds per minute) Enqueue operations (logical data locks) per minutes that are coming from Enqueue Frequency another instance to the central instance Total Enqueue Work Processes Number of total enqueue work processes. Running Enqueue Work Number of running enqueue work processes. Processes Waiting Enqueue Work Number of waiting enqueue work processes. Processes Stopped Enqueue Work Number of stopped enqueue work processes. Processes Spool Parameter Description Spool Utilization Utilization of the spool work processes as a percentage Spool Work Processes Count Number of spool work processes Spool Work Processes Errors Number of errors in spool work processes Spool Work Processes Number of spool work processes that terminated after errors Terminated Dispatcher Queue Utilization Used area of the dispatcher queue as a percentage Request Queue Utilization Used area of the spool request queue as a percentage Used area of the spool request queue for processing in chronological order as Service Queue Priv a percentage Service Queue Pages Number of pages in the spool request queue Device Cache Used Used area of the entire device cache as a percentage Device Cache Fixed Used area of the fixed device cache as a percentage Host Spool List Used Used area of the host spool request list as a percentage Shows all the alerts under System Errors tree node of SAP CCMS monitor [RZ 20]. Alerts When you set an alert to completed status, it is deleted from the active alerts that are shown in the Alert Monitor and the Alert Browser. Running Spool Work Processes Number of running spool work processes. Waiting Spool Work Processes Number of waiting spool work processes. UpdateParameter Description Total Update Work Processes Number of total update work processes. Running Update Work Processes Number of running update work processes. Waiting Update Work Processes Number of waiting update work processes. Stopped Update Work Number of stopped update work processes. Processes Alarms Parameter Description Date The date at which the alerts were generated. Time The time at which the alerts were generated. System System ID of the SAP instance. Context Name of the monitoring context to which the MTE belongs. Object Name Name of an ABAP Dictionary Object. Module Name Short name of the MTE. Severity Severity of the alarm. Alarm Message Displays the detailed information for the alert shown. In addition, you can also perform the following operations with respect to the alarms in SAP server monitor: Complete Alarms: The Alert Monitor generates an alert for every status that deviates from the norm and traces it until you set the status to complete. Clicking on the Complete Alarms button will clear the displayed alarms from the SAP Server by completing the alarms. Filter Alarms: Allows you to filter the alerts generated in SAP server by monitoring only the selected set of filters in Alarms tab. Clicking the Filter Alarms button opens up a new popup window, wherein the following details will be displayed in their respective dropdowns: The Object Name dropdown displays the list of object names of the Monitor Tree Elements (MTEs). The Module Name dropdown displays the list of module names based on the object name selected from the dropdown in the form of Module Name(Object Name). Select the respective Object and Module Names based on which the alarms need to be filtered. Upon clicking Save, the alarms will be filtered and monitored in the Alarms tab.   Background Jobs Parameter Description Job Name The name of the background job monitored. The current status of the background job. Possible Statuses are: No Released Job Exists, Current Status Scheduled, Released, Active. The status of the background job during last execution. Possible Statuses are: Last Run Status Finished, Terminated, - (No Status If it is executed for first time) Last Run Date & Time The date & time of the last executed background job. The runtime in seconds ( the difference between starttime and endtime) of the Runtime (Sec) last executed background job. Delay(Sec) The delay in seconds ( the difference between scheduled starttime and starttime) of the last executed background job.Age Time since last execution of the background job in minutes. Note: Click the   icon to view the logs of a terminated background job and it''s history. SAP RFC Monitoring Remote Function Call (RFC) is the standard SAP interface for communication between SAP systems. The RFC calls a function to be executed in a remote system. Applications Manager monitors metrics pertaining to Queued RFCs (qRFC) and Transactional RFC (tRFC) like: QOUT Scheduler (SMQS) - The QOUT Scheduler processes qRFC outbound queues and controls the sending of qRFC calls. This information can be used to monitor the QOUT Scheduler. QIN Scheduler (SMQR) - The QIN Scheduler processes qRFC inbound queues and controls the processing of inbound qRFC calls.This information can be used to monitor the QIN Scheduler. QOUT Data (SMQ1) - QOUT Data can be used to monitor the Individual qRFC Outbound queues. QIN Data (SMQ2) - QOUT Data can be used to monitor individual qRFC inbound queues. Transactional RFC (SM58) - Every transactional RFC that is executed in a monitored SAP Server  is listed here. Parameter Description QOUT Scheduler (SMQS) Client The Logon Client. The status of the Scheduler at the moment when SMQS is executed. Possible State states are: SYSFAIL, CPICERR, INACTIVE, WAITING, WAITCONN, STARTING, ACTIVE. Time The time of last update. Group The group to which this scheduler belongs. Host The host in which this scheduler is running. QIN Scheduler (SMQR) Client The Logon Client. The status of the Scheduler. Possible states are: SYSFAIL, CPICERR, INACTIVE, State RESOURCE LACK, WAITING, BATCH , ACTIVE,STARTING. Time The time of last update. Group The group to which this scheduler belongs. Host The host in which this scheduler is running. QOUT Data (SMQ1) Client The Logon Client. Queue Name The name of the queue. Destination The target destination of the queue. The current state of the queue. Possible states are: SYSFAIL, CPICERR, STOP, SYSLOAD, VBERROR, READY, RUNNING, NOSEND, NOSENDS, WAITING, State WAITSTOP, WAITUPDA, RETRY, ARETRY, ANORETRY, MODIFY, EXECUTED, AFINISH, FINISH. Message The message while executing the queue. Time The time of last update. QIN Data (SMQ2) Client The logon Client. Queue Name The name of the queue. The current state of the queue. Possible States are:SYSFAIL, CPICERR, STOP, State READY, RUNNING, WAITING, WAITSTOP, RETRY, ARETRY, ANORETRY, MODIFY, EXECUTED, NOEXEC, AFINISH, FINISH, SAVED. Message The message while executing the queue. Time The time of last update. Transactional RFC (SM58) Transactional ID The identifier of the Transaction.Functional Name The name of the function that executed for transaction. Destination The target destination where this function is executed. Caller The user who called this transaction. The state of the transaction. Possible States are : CPICERR, SYSFAIL, CONFAIL, State RECORDED, VBERROR, SYSLOAD, RETRY, ARETRY, ANORETRY, EXECUTED, MAILED, READ, VBRECORD, SENDED, DEBUG, VXRECORD Message The message while executing the transaction. Time The time of last update. Tcode The Tcode from where this transaction is called.   Note: Data Retention: For Transactional RFC, only 2 hours of RAW data will be retained. After two hours the collected RAW data available in Applications Manager database will be deleted. This is because of the HUGE volume of transaction data available in SAP system. Applications Manager database will not scale the huge volume of transaction data. Data Archiving: Data archiving of transaction data will not happen due to the following reasons. The RAW data is deleted after two hours. Archiving huge volume of transaction data is not a scalable option. The alert history will be available but no reporting is possible for Transactional RFC. SAP Business One Monitoring Overview SAP Business One ERP is designed for small and mid-sized business. It provides solution for accounting and financials, purchasing, inventory, sales, customer relationships, project management, operations, and human resources. SAP Business One is based on a two-tier client/server architecture. Most of the application resides on the client (fat client). This means that processing is carried out locally and is largely independent of server performance. Creating a new SAP Business One monitor Prerequisites for monitoring SAP Business One metrics: Integration Framework should be launched for SAP Business One. Using the REST API to add a new SAP Business One monitor: Click here Follow the steps given below to create a new SAP Business One monitor in Applications Manager: Click on Add New Monitor under New Monitor. Select SAP Business One under ERP category. Enter the display name for the monitor to be added. Provide Host Name/IP Address. Enter the port number in which the integration framework is running. (Default port is 8080) Enter the credential details like user name and password of the integration framework for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Enter the timeout value in minutes. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers SAP Business One integration framework from the network and starts monitoring them. Monitored Parameters Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations.The following parameters are monitored for SAP Business One monitor: Overview SLD BizStore Scenario Users Transaction Errors & Conflicts Overview Parameter Description SYSTEM INFORMATION (B1iP) Database Size Database size allocated for the integration platform (in GB). Used Memory Amount of memory utilized by the integration platform (in MB). Used Memory Percentage Amount of memory utilized by the integration platform (in percentage). Maximum Memory Maximum amount of memory available for the integration platform (in MB). Detected CPU Cores Number of CPU Cores or Processors detected. Scheduler Threads Number of scheduler threads available in the integration platform. Last Start of B1iP Date and time at which the integration platform was last started. Last crashed time Date and time at which the integration platform was last crashed. Deployed B1i Apps Number of B1i apps that are deployed in the integration platform. QUEUES DB Queues Number of available database queues. DBQ Streams Number of available database queue streams. DBQ Messages Number of available database queue messages. Blocked Queues Number of queues that are blocked. SLD Parameter Description System Landscape Directory (SLD) Details SLD System ID System ID of the SLD. SLD Name Name of the SLD. Adapter Adapter name of the SLD. System Type System type of the SLD. Status Connectivity status of the SLD. In addition, you can also choose to filter systems based on specific adapters. Using the Choose Adapters option, systems under System Landscape Directory (SLD) can be filtered based on the selected adapters. Updated systems for the selected adapters will be available in the next poll data. BizStore Parameter Description BIZSTORE BizStore Datasets Number of BizStore datasets available. BizStore Groups Number of BizStore groups available. BizStore Documents Number of BizStore documents available. DOCUMENT CACHE Doc Cache Accesses Number of accesses given to BizStore document cache.Doc Cache Hit Rate Hit rate of BizStore document cache (in percentage). Scenario Parameter Description SCENARIO DETAILS Scenario Transactions Number of scenario transactions available. Total Scenario Packages Total number of scenario packages available. INTERNAL PROCESS STEPS Stopped steps due to errors Number of stopped internal process (IPO) steps due to errors. Stopped steps due to recovery Number of stopped internal process (IPO) steps due to recovery. Manually stopped steps Number of manually stopped internal process (IPO) steps. Stopped steps due to Number of stopped internal process (IPO) steps due to deployment. deployment Users Parameter Description User Details User Name Name of the user. The roles assigned to the user. (Administrator, Developer, Configurator or Roles Supervisor) Status Current status of the user. (Active or Locked) DaysToExpire Number of days remaining for the user entry to expire. Transaction Parameter Description TRANSACTION STATUS Completed Transactions Number of successfully completed transactions. In Commit Transactions Number of transactions with in-commit status. Cancelled Transactions Number of cancelled transactions. In Rollback Transactions Number of transactions with rollback status. Aggregated Transaction Data (Last 1 day) Status Status of the transaction. Duration Time duration of the aggregated transaction (in ms). No. of processed messages Number of processed messages for the aggregated transaction. Size of inbound messages Size of inbound messages for the aggregated transaction (in KB). Errors & Conflicts Parameter Description ERRORS Error Inbox: Receiver System Number of receiver systems with error messages. with Error Error Inbox: Technical Errors Number of technical error messages in error inbox. CONFLICTS Activation Conflicts Number of activation conflicts occurred. Namespace Conflicts Number of namespace conflicts occurred. APP ERRORS & WARNINGS App Init Errors Number of errors occurred during last app initialization.App Init Warnings Number of warnings occurred during last app initialization. Siebel Server Monitoring Overview Applications Manager lets you monitor the status of Siebel server components that are essential to keeping the application up and running. You can monitor as far down as the process level CPU and memory utilization of a Siebel task. Auto-discover your entire Siebel Enterprise; get out-of-the-box performance graphs showing Application Object Manager and Enterprise Application Integration Stats of processes within your enterprise. Creating a new Siebel monitor Using the REST API to add a new Siebel server monitor: Click here Follow the steps given below to create a new Siebel Enterprise Server monitor in Applications Manager: Copy the APMSiebelCommands.txt file (located under /working/resource directory) and paste it under /bin directory. Click on Add New Monitor under New Monitor in the Applications Manager web client. Click on Siebel Enterprise Server under ERP. Enter the Display Name of the monitor. Provide the Host Name or IP Address of the server where Siebel is installed. Select the Mode of Monitoring (SSH or WMI). If SSH, provide the port number (default is 22), username and password information of the Siebel server. You have an option to configure Public Key Authentication (Username and Private Key). You can also give a Passphrase if the private key is protected with one. Also, you can specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. If WMI, provide the username and password of the Siebel server. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Enter the Siebel Gateway Server and Enterprise Server names. Enter the Siebel administrator name (administrator or equivalent user) and Password. Enter the path to the Siebel Installation Directory. Specify the Timeout in minutes. Default value is 10 minutes. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). Upon adding the Siebel Server monitor, you can view the details of the newly added Siebel Server monitor. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Siebel server under the ERP Table. Displayed is the Siebel Server bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Monitor Information Performance Components AOM Statistics DB Statistics InfraStructure EAI Statistics Task Active SessionsMonitor Information Parameters Description Name Name of the Siebel server monitor Last Polled at  Specifies the time at which the last poll was performed. Next Poll at  Specifies the time at which the next poll will be performed. Associated Groups  Denotes the monitor groups associated with the Siebel server monitor. Performance Parameters Description Availability history for last 6 Name of the Siebel server monitor hours Performance history for last 6 Specifies the time at which the last poll was performed. hours CPU Utilization Displays the current CPU utilization of the server. Memory Utilization Displays the current memory utilization of the server. Statistic Name Siebel application statistic name. Statistic Value Siebel application statistic value. Description Description of the statistic. Transactions from PIM in Number of inprocess transactions from PIM Progress Global Data Cursor Cache Number of global data cursor cache misses Misses Tests Successful Number of tests that were successful Global Data Cursor Cache Number of objects currently in the global data cursor cache Objects Transactions form Siebel in Number of inprocess transactions from Siebel Progress Maximum OOB Component Maximum OOB Component Time Time Total CPU time spent on creating global data cursor objects in cache (in Global Data Cursor Cache CPU seconds) Failed Transactions from Siebel Number of failed transactions from Siebel Global Data Cursor Cache Total memory spent on creating global data cursor objects in cache (in bytes) Memory Global Data Cursor Cache Hits Number of global data cursor cache hits Events Processed Total number of events processed Data Cursor Cache Objects Number of objects currently in the data cursor cache Failed Transactions from PIM Number of failed transactions from the PIM Events Processed Rate Rate of Processing the events Data Cursor Cache Memory Total memory spent on creating data cursor objects in cache (in bytes) Number of Component Crashes The number of times a process of the component has crashed. Data Cursor Cache Misses Number of SQL data cursor cache misses Number of Component Restarts The number of times a process of the component has restarted. Number of Errors Total number of level 0 and 1 errors. This statistics represents the cumulative number of records assigned by this Number of object rows assigned component since the server was started PSP Cache Hit Total Total PSP Cache Hit Number PSP Cache Miss Total Total PSP Cache Miss Number SQL Object Cache Memory Total memory spent on creating SQL object objects in cache (in bytes) Data Cursor Cache CPU Total CPU time spent on creating data cursor objects in cache (in seconds)Completed Transactions from Number of completed transactions from Siebel Siebel Completed Transactions from Number of completed transactions from the PIM Server PIM Average OOB Queue Size Average OOB Queue Size SearchEvents Processed Rate Rate of Processing the records during indexing Average OOB Component Time Average OOB Component Time SearchEvents Processed Total number of records processed during indexing Tests Failed Number of tests that failed Tests Attempted Number of tests that were started Data Cursor Cache Hits Number of SQL data cursor cache hits Components Parameters Description Component Specifies the name of the Siebel component. Component Group Specifies the name assigned to the Siebel component group. Specifies the value returned for the state of the component. An example value RunState of RunState is offline ActiveMTSProcess The number of running multi-threaded shell (MTS) processes. RunningTasks The current number of running tasks for the component. AOM Statistics Application Object Manager Statistics Parameters Description The time required to perform all the activities required to establish an Average Connect Time interactive session (such as authentication, initialization, and allocating the necessary resources) with Object Manager. The average (mean) time required to respond to an end-user action. If Average Response Time application performance is deteriorating, the metric value increases. Statistic Name Siebel application statistic name. Statistic Value Siebel application statistic value. Description Description of the statistic. Average Request Size The average size of request messages (in bytes) Average Reply Size The average size of reply messages (in bytes) Average Requests Per Session The average number of requests per Object Manager session Total Think Time The total end-user think time (in seconds) Average Think Time The average end-user think time between requests (in seconds) Object Manager Errors The number of errors encountered during Object Manager session Reply Messages The number of reply messages sent by the server Request Messages The number of request message received by the server Total Database Response Time The total Database Response/Processing Time (milliseconds) Total Reply Size The total size (in bytes) of reply messages Total Request Size The total size (in bytes) of request messages Total Response Time The total Object Manager response time (msec) Database Statistics Parameters Description Average Execution The average (mean) amount of time the database requires to process the SQL statement Time after the statement is parsed.Average Fetch The average (mean) amount of time the database requires to fetch records by an SQL Time statement after the statement is parsed. Statistic Name Siebel application statistic name. Statistic Value Siebel application statistic value. Description Description of the statistic. SQL Cursor Cache The number of SQL cursor cache misses Misses SQL Cursor Total The total CPU time spent on creating SQL cursor objects in cache (in seconds) Cpu SQL Parse Time The total elapsed time for SQL parse operations (in seconds) Number of SQL The total number of SQL fetch operations Fetches SQL Object Cache The number of objects currently in the SQL object cache Objects Number of SQL The total number of SQL execute operations Executes SQL Object Cache The number of SQL object cache misses Misses SQL Cursor Cache The number of SQL cursor cache hits Hits Number of SQL The total number of SQL parse operations Parses SQL Object Cache The number of SQL object cache hits Hits SQL Object Cache The total CPU time spent on creating SQL object objects in cache (in seconds) CPU SQL Fetch Time The total elapsed time for SQL fetch operations (in seconds) Avg SQL Parse The average time for SQL parse operations (in seconds) Time SQL Execute Time The total elapsed time for SQL execute operations (in seconds) InfraStructure Parameters Description Statistic Name Siebel application statistic name. Statistic Value Siebel application statistic value. Description Description of the statistic. Tasks Exceeding Configured Capacity The number of tasks stated that exceeded configured capacity CPU Time The total CPU time for component tasks (in seconds) Num of DLRbk Retries The number of Retries due to Deadlock Rollbacks Num of Exhausted Retries The number of Times All Retries are Exhausted Elapsed Time The total running time elapsed for component tasks (in seconds) Number of Sleeps The total number of sleeps for component tasks FDR Avg time between aging Avg Seconds per buffer wrap Sleep Time The total amount of sleep time for component tasks (in seconds) FDR Buffer Life in seconds Seconds since buffer was created Num of DBConn Retries The number of retries due to DB Connection Loss Minimum Peak Memory Usage Peak Mem used by task. Rolls up differently than MaxPeakMemory Maximum Peak Memory Usage The Peak Memory used by task. Rolls up differently from MinPeakMemory Total Tasks The total number of tasks completed for server components FDR Buffer Wraps The number of buffer wraps EAI StatisticsParameters Description Statistic Name Siebel application statistic name. Statistic Value Siebel application statistic value. Description Description of the statistic. EAI Receiver Total Messages The total number of messages processed by the Enterprise Application Processed Integration receiver. Siebel Adapter Total Query The total cumulative size of output property sets (in KB) for all queries Calls Siebel Adapter Total The total number of non-query (synchronize, upsert, update or insert) calls made Sync/Upsert Calls to Siebel Adapter Total XML Converter Size of The total cumulative size of input buffer (in KB) Input Buffer Siebel Adapter Total Query The total cumulative size of output property sets (in KB) for all queries Size Siebel Adapter Total Sync The total cumulative size of input property sets (in KB) for all non-query calls Size (synchronize, upsert, update or insert) Total XML Parser Calls The total number of XML parser calls Total XML Converter Size of The total cumulative size of output buffer (in KB) Output Buffer Total XML Generator Calls The total number of XML generator calls Tasks Parameters Description Tasks Running The current number of concurrent task instances running in the Siebel component. Tasks Paused The tasks that have been temporarily placed in a suspended state. Tasks Completed The tasks that have run to completion. Tasks Exited with Errors The tasks that encountered an error during its processing and exited. Tasks Killed The tasks that were not able to shut down cleanly, and were forced to shut down. Error Tasks Component Name of the Siebel component. TaskID The operating system identification number assigned to the task. Run State Current run state for the Siebel task (Running, Paused, Stopping, A task may be in one of four states Running Task Status Paused Stopping Completed Task Label The task label. Start Time The time when this task started. End Time The time when this task ended. Active Sessions Parameters Description Component Specifies the name of the Siebel component. TaskID Siebel task ID for the application OM that handles the user session. Run State The running state of the users'' sessions for the selected Siebel Server. Hung State The state of the users'' sessions for the selected Siebel Server not responding. DB Session ID A unique session number created for the user OM Login Object Manager login ID of the user.Task Status Current status of the task i.e running or paused. Microsoft Dynamics CRM / 365 (On-Premise) Monitoring Microsoft Dynamics CRM / 365 (On-Premise) - An Overview Adding a new monitor Monitored Parameters An Overview Dynamics CRM/365 is Microsoft''s fully integrated customer relationship management system that helps organizations attract and develop new profitable relationships with customers while managing ongoing relationships from a single operating platform. Microsoft Dynamics CRM/365 offers both on-premise and cloud- based options, tight integration with Microsoft Office and Outlook, and all-out customization flexibility. As a system administrator you need to be able to to respond quickly to critical events and prevent service outages. Applications Manager helps you track the set of counters that generate data about how various components perform as they run in the Microsoft Dynamics CRM/365 environment. You can monitor the WMI Performance counters, Services, Transactions and Eventlogs for CRM Applications. You can get deeper insight into the performance of CRM''s Authentication, Outlook Sync, e-mail Router, Discovery, Locator, Platform Services, Sandbox counters and Async Services. Creating a new Monitor Supported versions of Microsoft Dynamics CRM / 365 (On-Premise): CRM 2011, CRM 2013, CRM 2016 and Dynamics 365 Prerequisites for monitoring Microsoft Dynamics CRM / 365 (On-Premise): Click to know about the user previleges and other necessary prerequisites to monitor Microsoft Dynamics CRM/365. Note: Powershell script execution must be enabled on Applications manager server for data collection. Click here to know how Follow the steps given below to create a new Dynamics CRM/365 Application monitor: Click on New Monitor link. Select Microsoft Dynamics CRM / 365 (On-Premise) under ERP category. Specify the Display Name of the Dynamics CRM/365 Application. Enter the Host Name or IP Address of the host where the Dynamics CRM/365 Application runs. Select the Version number from the drop-down menu. If you choose the Use Below Credentials option, then enter the credentials - UserName and Password of the Host Machine. UserName - To monitor a Microsoft Dynamics CRM/365 application, use Administrator user account which has the permission to execute WMI queries on ''root/CIMV2'' namespace of the Dynamics CRM/365 Server. Password - Password of the above user who has the permissions to execute WMI Queries. If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Select Enable Event Log Monitoring if you wish to monitor event logs. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Dynamics CRM/365 monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Dynamics CRM/365 Application from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Microsoft Dynamics CRM / 365 (On- Premise) under the ERP Table. Displayed is the Microsoft Dynamics CRM/365(On-Premise) bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days.Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Server Requests Sandbox Async Services (Only for CRM 2011 and CRM 2013) Performance SQL Server Web Traffic .NET CLR Events OVERVIEW Parameter Description AUTHENTICATION FAILURES IN LAST MINUTE Claims Authentication The total number of failed authentication requests processed per minute using claims. This Failures In The counter measures the whole deployment including all organizations. Last Minute Config DB Windows The number of unsuccessful authentication requests per minute that are processed by using Authentication Active Directory authentication credentials. This counter measures the entire Microsoft Failures In The Dynamics CRM deployment including all organizations.  Last Minute CRM Post The number of unsuccessful authentication requests per minute that are processed by using Authentication Microsoft Dynamics CRM authentication credentials. This counter measures the entire Failures In The deployment including all organizations. Last Minute Passport The number of failed authentication requests per minute that are processed by using Microsoft Authentication account authentication credentials. This counter measures the entire Microsoft Dynamics CRM Failures In The deployment including all organizations. This counter is CRM Online - specific. Last Minute The number of unsuccessful authentication requests per minute. There are several possible Windows causes for authentication failure. For example, the user may have been authenticated Authentication successfully by Active Directory but Microsoft Dynamics CRM authentication failed to Failures In The communicate with the Kerberos servers, or a token expired, or the user''s credentials are Last Minute incorrect. This counter measures the entire Microsoft Dynamics CRM deployment including all organizations. OUTLOOK SYNC REQUESTS Current MAPI The number of MAPI sync requests currently executing. Sync Requests Current Offline Sync The number of offline sync requests currently executing. Requests Current Outlook Sync The number of Microsoft Office Outlook sync requests currently executing. Requests The total number of Address Book Provider (ABP) synchronization requests made from CRM for Total ABP Sync Outlook to a Microsoft Dynamics CRM server; a high count indicates a high client load on the Requests Asynchronous Processing Service. The total number of offline synchronization requests made from CRM for Outlook to a Microsoft Total Offline Dynamics CRM server; a high count indicates a high client load on the Asynchronous Processing Sync Requests Service.Parameter Description Total Outlook The total number of ABP Sync Requests and the Offline Sync Requests; a high count indicates a Sync Requests high client load on the Asynchronous Processing Service. Total The number of successful offline synchronization requests made from CRM for Outlook to a Succeeded Microsoft Dynamics CRM server; a count that is much lower than the total number of offline Offline Sync synchronization requests may indicate a problem with clients that try to synchronize with the Requests server. The number of failed offline synchronization requests made from CRM for Outlook to a Microsoft Total Failed Dynamics CRM server. This is calculated from ''Total Offline Sync Requests'' and ''Total Offline Sync Succeeded Offline Sync Requests'' . A count greater than ''Total Succeeded Offline Sync Requests Requests'' or a count close to ''Total Offline Sync Requests'' may indicate a problem with clients that try to synchronize with the server. SERVICES The name of the service. Note that the display name and the service name (which is stored in the Name registry) are not always the same. The Start mode of the service. The different start modes are: Boot - The device driver is started by the operating system loader (valid only for driver services). System - The device driver started by the operating system initialization process. This value is valid only for driver services. Start Mode Auto - The service to be started automatically by the service control manager during system startup. Auto services are started even if a user does not log on. Manual - The service to be started by the Service Control Manager when a process calls the StartService method. These services do not start unless a user logs on and starts them. Disabled - The service that cannot be started until its StartMode is changed to either Auto or Manual. The current state of the base service. The values are: Stopped, Start Pending, Stop Pending, State Running, Continue Pending, Pause Pending, Paused, Unknown. SERVER Parameter Description SERVER Number of The number of organizations that are currently active. Organizations Failed Internal The total number of failed web service requests to Microsoft Dynamics CRM InProc calls that are Organization made by applications that use the methods described in the Microsoft Dynamics CRM SDK. Service Requests Failed Organization The total number of metadata requests received by the Microsoft Dynamics CRM Organization Service Web Service that failed because of a time-out or other SOAP failure. Metadata Requests Failed Organization The total number of requests to the Microsoft Dynamics CRM Organization Web Service that Service failed because of a time-out or other SOAP failure. Requests Failed Report The number of requests to render Microsoft SQL Server Reporting Services reports that failed Render because of a time-out or error. Requests The total number of error reports generated by the web client and CRM for Outlook. This counter is reset weekly to zero. This counter is an indicator of high script error frequency. If a large Script Error number of error reports are received in a short time, the operations team should investigate to Reports determine which pages are producing errors. We recommend that you set a monitoring alert to notify you if there are more than 500 error reports in a 10-minute period. REQUESTSParameter Description DISCOVERY SOURCE Failed The number of requests to the Microsoft Dynamics CRM Discovery service that are unsuccessful Discovery for any reason. For example, a request may fail because the requesting party is not recognized as Service a user in the organization. A high count may indicate that the system is possibly under a denial-of- Requests service (DoS) attack, or there is some problem with the Discovery service configuration. Successful Discovery The number of requests to the Microsoft Dynamics CRM Discovery service that completed Service successfully. Requests Total The total number of requests (successful and unsuccessful) received by the Microsoft Dynamics Discovery CRM Discovery service. This counter can be used to track traffic patterns for Discovery service Service capacity planning. Requests LOCATOR SERVICES The number of LocatorService cache flush requests that were unsuccessful for any reason. For Failed example, a request may fail because it was for an invalid cache entry, or the cache may not flush Cache Flush because of an incorrect cache state. A high count may indicate a problem with the LocatorService Requests cache, or a problem with the connection to CONFIG_DB. For information about the cause, review the event log for errors. Total Cache Flush The total number of successful LocatorService cache flush requests that have been received.  Requests ROUTER SERVICE REQUEST AppFabric Request The number of time-outs seen making requests to Windows Azure. Timeout Router Request The number of requests made on the faulted channel to the router. Faulted Router Request The number of requests received by the router. Received (Throughput) Router Request The number of time-outs seen making requests to the router. Timeout PLATFORM The average time that is required to process Microsoft Dynamics CRM data import requests. Average Import requests are resource-intensive SQL Server operations. If the average time is too high and Time Of the number of concurrent imports is high, some organizations may have to be moved to a different Import deployment. Also, you may want to consider processing import jobs during a maintenance Request window to reduce the performance effect on users. Number Of The number of import requests that have been submitted by organizations in the deployment in Import the past hour. This counter is useful to indicate how many import requests are being processed Requests Per concurrently. Hour Number Of The number of requests that have been submitted by organizations in the deployment in the past Publish hour. This counter is useful to indicate how many publish requests are being processed Requests Per concurrently. Hour SANDBOX Parameter Description SANDBOX HOST Worker Processes Crashed The percentage of Sandbox Worker processes that have crashed. Percentage Worker Processes The percentage of Sandbox Worker processes that have been terminated due to Terminated Percentage excessive resource usage or no response.Parameter Description Active Assemblies The number of plug-in assemblies currently in use. Active Organizations The number of organizations that currently have a Sandbox Worker process active. Active Plugins The number of plug-ins currently in use. Handles The total handle count used by all Sandbox Worker processes. CPU Usage Percentage The total CPU percentage used by all Sandbox Worker processes. Assembly Cache Hits The assembly cache hit rate percentage. Percentage Assembly Cache Usage The percentage of the total assembly cache disk space that is in use. Percentage Execute Failures The incoming execution failure rate percentage in the Sandbox Host. Percentage SDK Failures Percentage The outgoing Request failure rate percentage in the Sandbox Host. Assembly Cache Disk The total disk space used by all plug-in assemblies in the assembly cache, in KB. Space (KB) Memory Usage (MB) The total memory used by all Sandbox Worker processes, in MBytes. SANDBOX CLIENT Execute Failures The outgoing execution failure rate percentage in the Sandbox Client. Percentage SDK Failures Percentage The incoming SDK Request failure rate percentage in the Sandbox Client. ASYNC SERVICES (Only for CRM 2011 and CRM 2013) Parameter Description ASYNC SERVICES Active The total number of organizations in the Microsoft Dynamics CRM deployment that are actively Organizations being polled by the Microsoft CRM Asynchronous Processing Service. Total The number of organizations being monitored for the entire Microsoft Dynamics CRM Organizations deployment. Capacity Per The number of asynchronous operations to be removed from the processing queue that are Organization currently allocated to an organization. Items In The maximum number of asynchronous operations to hold in memory for processing. Memory (high) Items In The threshold of asynchronous operations to trigger loading of additional operations. Memory (low) The number of threads currently employed in the processing of asynchronous operations for all Threads In Use organizations in the deployment. Total Operations The total number of asynchronous operations that failed for all organizations in the deployment. Failed PERFORMANCE Parameter  Description The Percent Processor Time i.e, the percentage of the time the processor is busy doing non- CPU Utilization idle threads. Memory The amount of memory immediately available for allocation to a process or for system use. Utilization Disk I/O Statistics Devices The display name of the disks. Transfers/Sec The rate of read and write operations on the disk per second. Writes/Sec The rate at which bytes are transferred to the disk during write operations. Reads/Sec The rate of write operations on the disk.Parameter  Description The percentage of elapsed time that the selected disk drive is busy servicing read or write % Busy Time requests. Avg. Queue The average number of both read and write requests that were queued for the selected disk Length during the sample interval. Network Interface Name The display name of the network connector Speed (MBps) The interface''s current bandwidth in megabits per second (MBps). Input Traffic The rate at which bytes are received on the interface, including framing characters. (MBps) Output Traffic The rate at which bytes are sent on the interface, including framing characters. (MBps) Port Connectivity Port Name The name of the port monitored. Port Number The port number specified for that port. Connectivity Specifies if the connection is UP / DOWN. Status Response The time taken to check the connectivity status in milliseconds. Time(ms)   Follow these steps to add, remove or edit the TCP ports monitored: Go to \working\conf\application\script\powershell folder and open DynamicsPorts.ps1 file in an editor. To add new TCP port to be monitored, add the port name and port number in the below format along with the other ports: " : " Example: "DNS:53" To remove any TCP ports which are monitored, comment the respective line by using ''#'' in the beginning of the line. Example: # "DNS:53" If any ports have been changed from the default port number in the server, please edit the respective port numbers. Save the file after the changes are done. Changes will be effective from the next poll in the monitor.  SQL SERVER Parameters Description General Statistics Total Active The total number of active transactions Transactions Transactions/Sec Number of transactions started for the database per second Dynamic Server Total amount of dynamic memory, in kilobytes, that the server is currently consuming Memory User Connections Number of users connected to the system SQL Statistics SQL Compilations / Number of SQL Server query compilations per second Sec SQL Re- Compilations / Number of SQL Server query re-compilations per second SecParameters Description Batch Requests / Number of SQL Server batch request executed per seconds Sec Buffer Manager Buffer Cache Hit Percentage of pages that were found in memory, this not requiring a physical I/O operation Ratio Free List Stalls / The number of requests per second that had to wait for a free page Sec Lazy Writes / Sec Pages written to the disk during the LazyWriter process freeing up SQL cache. Page Life Estimated number of seconds a page will stay in the buffer pool before it is written out Expectancy Page lookups / Indicates the number of requests per second to find a page in the buffer pool Sec Lock Statistics Lock Requests / Number of new locks and lock conversions per second requested from the lock manager Sec Lock Memory The total amount of memory in kilobytes, that is allocated to locks Access Method Metrics Forwarded The number of records fetched through forwarded record pointers Records / Sec FreeSpace Scans The number of scans per second that were initiated to search for free space within pages / Sec already allocated to an allocation unit to insert or modify record fragment Either table or Index is fully scanned. This could be caused because of wrong or unhelpful Full Scans / Sec indexes WorkFiles The number of work files created per second Created / Sec WorkTables The number of worktables created in tempdb per second. Worktables are used for queries Created / Sec that use various spools (table spool, index spool, etc) WEB TRAFFIC Parameter  Description Bytes Received/Sec The rate at which bytes are received by the web service. Bytes Sent/Sec The rate at which bytes are sent by the web service. Current Connections The current number of connections established with the web service. Connection Attempts/Sec The rate at which connections using the web service are being attempted. Files Received/Sec The rate at which files are received by the web service. Files Sent/Sec The rate at which files are sent by the web service. .NET CLR Parameter  Description The total number of exceptions thrown since the start of the application. These include both Exceptions/sec .NET exceptions and unmanaged exceptions. The elapsed time that was spent in performing a garbage collection (GC) since the last GC Time in GC cycle. Current Queue The total number of threads currently waiting to acquire some managed lock in the application. length Contention The rate at which threads in the runtime attempt to acquire a managed lock unsuccessfully. Rate/sec Logical The number of current .NET thread objects in the application. Threads Physical The number of native OS threads created and owned by the CLR to act as underlying threads for Threads .NET thread objects.Parameter  Description JIT compilation The percentage of elapsed time spent in JIT compilation since the last JIT compilation phase. time EVENTS Event Log from the Dynamics CRM/365 Application can be monitored by creating EventLog Rules in Applications Manager. Parameter Description EVENTS Rule Name The name of the event log rule Log File Indicates the Log File Type (i.e) Application, system, security, file replication service, DNS Server or Type directory service. Source The Application which created the event. Event Id The Event ID associated with the Event Log File. Indicates the Event Type (i.e) Error, Warning, Information or Event of Any Type. In case of Security Type Events, the types would vary between Success Audit and Failure Audit. User Name The system component or User account that was running the process which caused the event. Description A description of the event. Generated The time when the event entry was submitted. Time Microsoft Dynamics AX Monitoring Microsoft Dynamics AX - An Overview Monitoring Microsoft Dynamics AX - What we do Creating a new Microsoft Dynamics AX monitor Monitored Parameters Microsoft Dynamics AX - An Overview Microsoft Dynamics AX 2012 is an Enterprise Resource Planning (ERP) system suitable for midsize to large enterprises. It provides your enterprise with comprehensive core functionality like financial, human resources and operations management so that your business can thrive. Microsoft Dynamics AX offers complete functionality for inventory control, warehouse management, transportation management, demand and supply chain planning, material requirements planning, production management, quality assurance, product lifecycle management, asset management, and business intelligence so you can make important business decisions. Monitoring Microsoft Dynamics AX - What we do To actively monitor the behavior of the Microsoft Dynamics AX application and related applications, Applications Manager effectively collects information pertaining to the performance of each component of the system architecture, i.e.: Application Object Server (AOS), the SQL Database Server, and their Server Stats. Creating a new Microsoft Dynamics AX monitor Supported versions : Microsoft Dynamics AX 2012, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 R3 Prerequisites for monitoring Microsoft Dynamics AX metrics : Click here Rest API to add a new Microsoft Dynamics AX monitor : Click here To create a new Dynamics AX monitor, follow the steps given below: Click on New Monitor link. Select Microsoft Dynamics AX under ERP category. Specify the Display Name of the Dynamics AX Application. Enter the AX Host Name or IP Address of the host where the AX Server runs. Select the Version number from the drop-down menu. Select the AX Services to be monitored from the drop down list.If you choose the Use Below Credentials option, then enter the credentials - Username and Password of the Host Machine. Username - To monitor a Microsoft Dynamics AX application, use Administrator user account which has the permission to execute WMI queries on ''root/CIMV2'' namespace of the AX Server. Password - Password of the above user who has the permissions to execute WMI Queries. If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Choose Remote SQL Server option if the MSSQL of Dynamics AX is in a remote server other than the AX server. If this option is enabled, enter the following details: SQL Server Host Name - Enter the hostname of the remote SQL server SQL Server Credentials Details - Choose if you want to use the same AX Server Credentials or Enter new credentials for the SQL server. SQL Server Username - Use Administrator user account which has the permission to execute WMI queries on ''root/CIMV2'' namespace of the SQL Server. SQL Server Password - Password of the above user who has the permissions to execute WMI Queries of the SQL Server. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Dynamics AX monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This starts monitoring the Dynamics AX Server Application from the network. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Microsoft Dynamics AXmonitor under the ERP Table. Displayed is the Microsoft Dynamics AX bulk configuration view distributed into three tabs: Availability tab displays the availability history for the past 24 hours or 30 days. Performance tab displays the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Application Object Server (AOS) AOS Data Cache SQL Server Server Statistics Overview Parameters Description AOS Active Sessions Active The number of currently active server sessions Sessions Total The total number of active sessions since the AOS instance started Sessions Microsoft Dynamics AX and MSSQL Services Service The name of the service. Note that the display name and the service name (which is stored in the Name registry) are not always the same. Availability The current state (Running or stopped) of the base service. Application Object Server (AOS) Parameters Description AOS TrafficParameters Description Bytes Received/Sec The number of bytes received by the AOS instance per second Bytes Sent/Sec The number of bytes sent by the AOS instance per second Request Statistics Total Client Requests The number of client-to-server requests since the AOS instance started Client requests/Min The number of client-to-server requests per minute Client requests processed/Sec The number of client-to-server requests processed per second Server responses/Min The number of server-to-client requests that have been processed per minute AOS Data Cache Parameters Description Hits & Miss The number of times a record was found successfully in the cache per Hits/Min minute Miss/Min The number of times a record was not found in the cache Data Cache Clears(Total) Total Number of Clears The total number of times the cache was cleared of all contents Clears due to AOS The total number of times the cache was cleared because of AOS Synchronization(Total) synchronization Deletes from Data Cache(Total) The total number of times records were deleted from the data cache Cache flushes due to Size(Total) The total number of times the cache was flushed due to size Selects on Cached Tables(Total) The total number of selects on tables that are cached Data Cache Clears(Rate) Number of Clears / Min The number of times the cache was cleared of all contents per minute The  number of times the cache was cleared because of AOS Number of Clears by AOS / Min synchronization per minute Deletes from Data Cache / Min The number of times records were deleted from the data cache per minute Cache Flush due to Size / Min The number of times the cache was flushed due to size per minute Selects on Cached Tables / Min The number of selects on tables that are cached per minute SQL Server Parameters Description General Statistics Total Active The total number of active transactions Transactions Transactions/Sec Number of transactions started for the database per second Dynamic Server Total amount of dynamic memory, in kilobytes, that the server is currently consuming Memory User Connections Number of users connected to the system SQL Statistics SQL Compilations / Number of SQL Server query compilations per second Sec SQL Re- Compilations / Number of SQL Server query re-compilations per second Sec Batch Requests / Number of SQL Server batch request executed per seconds Sec Buffer ManagerParameters Description Buffer Cache Hit Percentage of pages that were found in memory, this not requiring a physical I/O operation Ratio Free List Stalls / The number of requests per second that had to wait for a free page Sec Lazy Writes / Sec Pages written to the disk during the LazyWriter process freeing up SQL cache. Page Life Estimated number of seconds a page will stay in the buffer pool before it is written out Expectancy Page lookups / Indicates the number of requests per second to find a page in the buffer pool Sec Lock Statistics Lock Requests / Number of new locks and lock conversions per second requested from the lock manager Sec Lock Memory The total amount of memory in kilobytes, that is allocated to locks Access Method Metrics Forwarded The number of records fetched through forwarded record pointers Records / Sec FreeSpace Scans The number of scans per second that were initiated to search for free space within pages / Sec already allocated to an allocation unit to insert or modify record fragment Either table or Index is fully scanned. This could be caused because of wrong or unhelpful Full Scans / Sec indexes WorkFiles The number of work files created per second Created / Sec WorkTables The number of worktables created in tempdb per second. Worktables are used for queries Created / Sec that use various spools (table spool, index spool, etc) Server Statistics Parameters Description Processor % Privileged Time The percentage of non-idle processor time spent in privileged mode % User Time The percentage of non-idle processor time spent in user mode Memory The amount of physical memory available to processes running on the computer in Available bytes megabytes Committed bytes The amount of committed virtual memory in megabytes Page Faults / Sec The average number of pages faulted per second Disk Average Queued The average number of both read and write requests that were queued for the selected Requests disk during the sample interval. % Disk Time Measures how busy a physical array is. Average time / Disk The average time in seconds for a read of data from the disk. Read Average time / Disk The average time in seconds for a write of data from the disk. Read Network Segments Sent / Sec The rate at which segments are sent. Segments Received / The rate at which segments are received. Sec Segments Re- The rate at which segments are re-transmitted. transmitted / Sec Mail ServersBelow are the list of mail servers that are monitored in Applications Manager: Exchange Server Mail Server Browse through the different mail servers that provide server information and their parameters being monitored. Exchange Server Monitoring Exchange Server Versions Supported: Exchange 2019, Exchange 2016, Exchange 2013, Exchange 2010, Exchange 2007, Exchange 2003 and older versions. Prerequisites for monitoring Exchange Server: Monitoring of Exchange Server is possible only if Applications Manager is running in a Windows System. Refer Prerequisites Section. Using the REST API to add a new Exchange server monitor: Click here Attributes Monitored: Refer Exchange Server Parameters to know more about the attributes monitored. To create a Exchange Server Monitor, follow the given steps: Click on New Monitor link. Choose Exchange Server under Mail Servers. Enter a Display name for the new monitor that you''re going to add. Enter the IP Address or hostname of the host in which the Exchange Server is running. Select Exchange Server Version - Exchange 2019, Exchange 2016, Exchange 2013, Exchange 2010, Exchange 2007, Exchange 2003 or below. Select the Server Role to be monitored. Choose the Exchange Server Services you want to monitor from the list. Select the Exchange Server Services you want to monitor. Provide the authentication details such as User Name, Domain Name, and Password for the system in which Exchange server is running. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. If you wish to enter your own credentials, specify username and password details for the monitor. Choose the Mode of Monitoring - Powershell or WMI. By default, the connectionURI will be detected. If neccessary, it can be customized. Know more about using the Powershell option Provide the port number in which Exchange Server is running. Also, you can provide multiple ports separated by commas. Enable the Use CredSSP Authentication option only if you want to fetch Exchange Queues metrics for non- mailbox roles in versions 2010 and above where the Applications Manager and Exchange server are in different domains. Know more about using CredSSP authentication Specify the timeout value in seconds. Value should be greater than 120 seconds. However, this is applicable only in Powershell mode of monitoring. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitor from the network and starts monitoring them. Know more about Exchange Server''s component-specific performance counters that Applications Manager monitors. Note: Monitoring of Exchange Server is possible only if Applications Manager is running in a Windows System. Also, Exchange Server monitor will work only if WMI is enabled in the remote machine in which Exchange Server is running. Exchange Monitoring now supports data collection in two ways : WMI - For users who have not installed / do not require powershell In the new monitor page, choose the WMI Mode of Monitoring Mailbox and Database Statistics for Mailbox Server Role is not available for this setting. Powershell: In the new monitor page, Choose the Powershell Mode of Monitoring and provide the connectionURI. To use Powershell for data collection make sure the proper steps have been followed to enable powershell remoting. If the user has not modified any ports or connectionURI, it need not be customized. Default value for connectionURI will be used. Use CredSSP Authentication needs to be enabled only for fetching Exchange Queues in non-mailboxroles in versions 2010 and above where the Applications Manager and Exchange server are in different domains. Click here for the steps to enable CredSSP Applications Manager lets you effectively monitor the different versions of your Exchange Server and report on performance, availability, and the working of its server roles. You can collect Exchange component-specific performance counters in one central location, detect issues, send alerts and thus prevent possible service outages or configuration problems. Users can proactively manage Exchange servers and identify issues before they become critical. Applications Manager gathers data related to each of your Exchange Server Roles: Mailbox Server Role - Monitor your mailbox and public folder databases and diagnose issues pertaining to all related messaging data. Client Access Server Role - Monitor overall client access like ActiveSync, .NET, OWA, Web Services connections and hardware performance. Unified Messaging Server Role - Track integrated dial-in access performance and monitor e-mail, voicemail, fax, calendar information and contacts. Hub Transport Server Role - Monitor the mail flow, routing, and delivery within the Exchange organization and identify disk performance bottlenecks. Edge Transport Server Role - Monitor EdgeSync services, Active Directory Application Mode, SMTP connection authentication, transport queue databases and logs. Applications Manager supports monitoring of counters relevant to the following server roles: Exchange Server 2019 Server roles: Mailbox Server Role Counters Edge Transport Server Role Counters Exchange Server 2016 server roles:  Mailbox Server Role Counters | Mailbox and Database Statistics ( This includes Client Access Role Counters too because Mailbox server in Exchange 2016 includes all of the server components from Exchange 2013 Mailbox and Client Access roles ) Edge Transport Server Role Counters Exchange Server 2013 Server roles: Mailbox Server Role Counters | Mailbox and Database Statistics Client Access Server Role Counters Edge Transport Server Role Counters Exchange Server 2010 and 2007 Server roles: Mailbox Server Role Counters | Mailbox and Database Statistics Client Access Server Role Counters Hub Transport Server Role Counters Edge Transport Server Role Counters Unified Messaging Server Role Counters Exchange Server 2003 and older versions Performance Counters Common Counters (For all versions and roles) Exchange Services and Active-Directory Access Domain Controllers Host Performance Counters Queues Exchange Server - Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Exchange Server under the Mail Servers Table. Displayed is the Exchange Server bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days.Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Mailbox Role Counters Exchange Server Version Attribute Description 2007 2010 2013 2016 2019 name POP & IMAP Connections Current POP The total number of POP connections opened since the Connections computer was last started. Current The total number of POP connections opened since the IMAP computer was last started. Connections SMTP Connections Inbound The total number of currently inbound connections. Connections Outbound The number of connections that were currently outbound. Connections Messages Sent Per The rate at which outbound messages are being sent. Second Messages Received The rate at which inbound messages are being received. Per Second Latency Requirements Counters Database The rate of page faults that can''t be serviced because there are PageFault no pages available for allocation from the database cache. This Stalls Per counter should be 0 on production servers. Second Database The average time, in ms, to read from the database file. The I/O Reads average value should be below 200 ms. Maximum values Average shouldn''t be higher than 1,000 ms. Latency Database The average time, in ms, to write to the database file. This I/O Writes latency should be less than the MSExchange Database\I/O Average Database Reads (Recovery) Average Latency when battery- Latency backed write caching is utilized. I/O Log The number of times data was read from a log file. Specific to Reads Per log replay and database recovery operations. Second I/O Log The number of times a log buffer was written to the active log Writes Per file. Specific to log replay and database recovery operations Second The number of log records that can''t be added to the log buffers Log Record per second because the log buffers are full. The average value Stalls Per should be below 10 per second. Maximum values shouldn''t be Second higher than 100 per second. The number of threads waiting to complete an update of the Log Threads database by writing their data to the log. The average value Waiting should be less than 10 threads waiting. Message Queuing Counters Mailbox The current number of submitted messages not yet processed Messages by the transport layer. The threshold value should be below 50 Queued For at all times. Shouldn''t be sustained for more than 15 minutes. Submission Public The current number of submitted messages not yet processed Messages by the transport layer. The threshold value should be less than Queued For 20 at all times. Submission Information Store RPC Processing CountersIS RPC The latency, in ms, averaged for the past 1,024 packets. Requests IS RPC The number of client requests currently being processed by the Averaged RPC Client Access service. Latency Cache Statistics Number Of Cache The number of active connections in all data connection pools Active created for a specific PowerPivot service application instance. Connections Number Of The number of idle connections in all data connection pools Cache Idle created for a specific PowerPivot service application instance. Connections Number Of Cache The number of connections to the server stored in the cache. Connections Cache Total The size of the cached server connection pool. Capacity RPC Client Throttling & Client Activity Counters Client RPC RPC Average Latency is server RPC latency, in ms, averaged for Average the past 1,024 packets. The threshold value should be less than Latency 50 ms on average for each client. The rate that the server notifies the client to back-off. Higher RPC Client values may indicate that the server may be incurring a higher BackOff Per load resulting in an increase in overall averaged RPC latencies, Second causing client throttling to occur. Client: RPCs The client-reported rate of failed RPCs since the store was Failed Per started. Second Client: RPCs The client-reported number of failed RPCs since the store was Failed started. Content Indexing Counters Percentage The amount of processor time being consumed to update Processor content indexing within the store process. Full crawls increase Time of overall processing time, but should never exceed overall store indexing CPU capacity. Average Document The average, in ms, of how long it takes to index documents. Indexing The threshold value should be less than 30 seconds at all time. Time This counter is used to determine if a full crawl is occurring for any specified database. Possible values are Full Crawl Mode Status 1 - going through a full crawl 0 - not going through a full crawl Average Latency of The average latency, in ms, of the most recent RPCs to the RPCs used Information Store service. These RPCs are used to get content to Obtain for the filter daemon for the specified database. Content Crawler Any value of 1 or higher indicated the mailboxes in the database Mailboxes are being crawled but when the crawl is completed, the value is Remaining set to 0.  Client-Related Search Counters The rate at which the slower FindRow needs to be used in the mailbox store. The threshold value should be no more than 10 Slow Find for any specific mailbox store. Higher values indicate Row Rate applications are crawling or searching mailboxes, which is affecting server performance. Search Task The number of search tasks created per second. The thresholdRate value should be less than 10 at all times. The number of query processor threads currently running Slow QP queries that aren''t optimized. The threshold value should be Threads less than 10 at all times. The number of search threads currently running queries that Slow Search aren''t optimized. The threshold value should be less than 10 at Threads all times. Database Counters Log Bytes The rate of bytes written to the log. The threshold value should Writes Per be less than 10,000,000 at all times. Second The percentage of database file page requests fulfilled by the database cache without causing a file operation. If this percentage is too low, the database cache size may be too Database small. The threshold value should be over 90% for companies Cache with majority online mode clients. The threshold value should Percent Hit be over 99% for companies with majority cached mode clients. If the hit ratio is less than these numbers, the database cache may be insufficient. The amount of system memory, in megabytes (MB), used by the Database database cache manager to hold commonly used information Cache Size from the database files to prevent file operations. Maximum in MB value is RAM-2GB. Use this counter along with store private bytes to determine if there are store memory leaks. Version The total number of version buckets allocated. The threshold Buckets value should be less than 12,000. The maximum default version Allocated is 16,384. The number of threads waiting for their data to be written to the log to complete an update of the database. If this number is too Log Threads high, the log may be a bottleneck. The threshold value should Waiting be less than 10 on average. Regular spikes concurrent with log record stall spikes indicate that the transaction log disks are a bottleneck. Represents the amount of work in the log file count that needs to be redone or undone to the database files if the process fails. Log The threshold value should be below 500 at all times for the Generation Mailbox server role. A healthy server should indicate between Check Point 20 and 30 for each database instance. If checkpoint depth Depth increases continually for a sustained period, this indicates either a long-running transaction, or a bottleneck. Database I/O Reads The average length of time, in ms, per database read operation. Average The threshold value should be 20 ms on average. Latency Database The average length of time, in ms, per database write operation. I/O Writes The threshold value should be 50 ms on average. Maximum Average values of up to 100 ms are acceptable if not accompanied by Latency database page fault stalls. Mailbox Assistant Counters Percentage Processor Percentage Processor Time of Mailbox Assistant. The threshold Time of value should be less than 5% of overall CPU capacity. Mailbox Assistant Average Event The average processing time of the events chosen. The Processing threshold value should be less than 2 at all times. Time in Seconds The number of events in the in-memory queue waiting to be Events in processed by the assistants. The threshold value should be a Queue low value at all times. High values may indicate a performance bottleneck.Events The number of events polled per second. Determines current Polled Per load statistics for this counter. Second Mailboxes The rate of mailboxes processed by time-based assistants per Processed second. Determines current load statistics for this counter. Per Second Resource Booking Counters Average Resource The average time to process an event in the Resource Booking Booking Attendant. High values may indicate a performance bottleneck. Processing Time Requests The total number of failures that occurred while the Resource Failed in Booking Attendant was processing events. The threshold value Resource should be 0 at all times. Booking Calendar Attendant Counters Average Calendar The average time to process an event in the Calendar Attendant. Attendant High values may indicate a performance bottleneck. Processing Time Requests The total number of failures that occurred while the Calendar Failed in Attendant was processing events.The threshold value should be Calendar 0 at all times. Attendant Store Client Request Counters The average latency, in ms, of RPC requests. The average is RPC Latency calculated over all RPCs since exrpc32 was loaded. The Average threshold value should be less than 100 ms at all times. ROP The total number of outstanding remote operations requests. Requests Used for determining current load. Outstanding RPC Requests The current number of outstanding RPC requests. Outstanding RPC Requests The total number of outstanding RPC requests. Used for Sent Per determining current load. Second Percentage The percentage of failed requests in the total number of RPC RPC requests. Failed means the sum of failed with error code plus Requests failed with exception. The threshold value should be less than 1 Failed at all times. Percentage The percentage of slow RPC requests among all RPC requests. A RPC Slow slow RPC request is one that has taken more than 500 ms. The Requests threshold value should be less than 1 at all times. HUB Servers The number of Hub Transport servers in retry mode. The in Retry threshold value should be 0 at all times. Successful The number of currently successful mail submission per Submission second. Per Second Failed Submission The number of failed submissions per second. Per Second Temporary Submission The number of temporary submission failures per second. Failures Per Second RPC The current number of RPC operations occurring per second. OperationsPer Second Information Store Counters Client: RPC The number of RPC operations per second for each client type Operations connection. Per Second JET Log The rate that database log records are generated while Records Per processing requests for the client. Used to determine current Second load. JET Pages The rate that database pages are read from disk while Read Per processing requests for the client. Used to determine current Second load. Directory The current rate that LDAP reads occur while processing Access: requests for the client. Used to determine the current LDAP read LDAP Reads rate per protocol. Per Second Directory The current rate that LDAP writes occur while processing Access: requests for the client. Used to determine the current LDAP read LDAP Writes rate per protocol. Per Second Messages The rate that messages are delivered to all recipients. Indicates Delivered current message delivery rate to the store. Per Second Messages The rate that messages are sent to transport. Used to determine Sent Per current messages sent to transport. Second Messages The rate that messages are submitted by clients. Used to Submitted determine current rate that messages are being submitted by Per Second clients. User Count The number of users connected to the information store. Used of IS to determine current user load. Replication Receive The number of replication messages waiting to be processed. Queue Size   Mailbox and Database Statistics Counters Exchange Server Version Attribute Description 2007 2010 2013 2016 2019 name Top Mailboxes By Size Mailbox Username for Exchange Mailbox User. User Name Total Item Specifies used mailbox size, in MB. Size Item Count Specifies number of items in mailbox. Inactive Mailbox Users Mailbox Username for Exchange Mailbox User. User Name Last Logon Time of Last Login by Mailbox User. Time Database Statistics (2010, 2013, 2016 & 2019) Master Specifies if the Mailbox Database is part of a DAG/ Server. Type The Database Accessibility Group (DAG) name. DAG allows you DAG Name to replicate / Server your database where your mail is stored across any number of servers. Database Name of the mailbox database. NameMount The mount status of the mailbox stores on the server. Mailboxes Status contained in unmounted mailbox stores cannot receive incoming messages. Mailbox The total number of mailboxes that reside in all mailbox stores Count and public folders. Database The size of the mailbox database. Size (GB) Available New The disk space consumed by the mailbox stores on this server in Mailbox GB. Space (GB) Last Full Detailed information about backups performed on storage Backup groups on the connected server. Circular Specifies whether or not circular logging is enabled. Circular Logging Logging saves storage on your Exchange Server by preventing Enabled transaction logs from building up on the Server. Days Since Indicates the number of days passed since the last full backup Last Full operation was performed. Backup Database Statistics (2007) Database Name of the mailbox database Name The mount status of the mailbox stores on the server. Mailboxes Mount contained in unmounted mailbox stores cannot receive incoming Status messages. Mailbox The total number of mailboxes that reside in all mailbox stores Count and public folders. The exchange storage group name. A Storage Group is a Storage grouping of one or more Mailbox Databases along with Log Files Group and a Checkpoint File. Not available for versions later than 2007. Database Availability Groups Database Availability The name of the database availability group. Group Name DAG The database availability group members. Members DAG The number of members in the particular database availability Members group. Count Database Copy Statistics Database The name of the mailbox database. Name Database The current status of the database. Possible Statuses are: Status Failed - The mailbox database copy is in a Failed state because it is not suspended, and it is notable to copy or replay log files. While in a Failed state and not suspended, the system will periodically check whether the problem that caused the copy status to change to Failed has been resolved. After the system has detected that the problem is resolved, and barring no other issues, the copy status will automatically change to Healthy. Seeding - The mailbox database copy is being seeded, the content index for the mailbox database copy is being seeded, or both are being seeded. Upon successful completion of seeding, the copy status should change to Initializing. SeedingSource - The mailbox database copy is being used as a source for a database copy seeding operation.Suspended - The mailbox database copy is in a Suspended state as a result of an administrator manually suspending the database copy by running the Suspend- MailboxDatabaseCopy cmdlet. Healthy - The mailbox database copy is successfully copying and replaying log files, or it has successfully copied and replayed all available log files. ServiceDown - The Microsoft Exchange Replication service is not available or running on the server that hosts the mailbox database copy. Initializing - The mailbox database copy will be in an Initializing state when a database copy has been created, when the Microsoft Exchange Replication service is starting or has just been started, and during transitions from Suspended, ServiceDown, Failed, Seeding, SinglePageRestore, LostWrite, or Disconnected to another state. While in this state, the system is verifying that the database and log stream are in a consistent state. In most cases, the copy status will remain in the Initializing state for about 15 seconds, but in all cases, it should generally not be in this state for longer than 30 seconds. Resynchronizing - The mailbox database copy and its log files are being compared with the active copy of the database to check for any divergence between the two copies. The copy status will remain in this state until any divergence is detected and resolved. Mounted - The active copy is online and accepting client connections. Only the active copy of the mailbox database copy can have a copy status of Mounted. Dismounted - The active copy is offline and not accepting client connections. Only the active copy of the mailbox database copy can have a copy status of Dismounted. Mounting - The active copy is coming online and not yet accepting client connections. Only the active copy of the mailbox database copy can have a copy status of Mounting. Dismounting - The active copy is going offline and terminating client connections. Only the active copy of the mailbox database copy can have a copy status of Dismounting. DisconnectedAndHealthy - The mailbox database copy is no longer connected to the active database copy, and it was in the Healthy state when the loss of connection occurred. This state represents the database copy with respect to connectivity to its source database copy. It may be reported during DAG network failures between the source copy and the target database copy. DisconnectedAndResynchronizing - The mailbox database copy is no longer connected to the active database copy, and it was in the Resynchronizing state when the loss of connection occurred. This state represents the database copy with respect to connectivity to its source database copy. It may be reported during DAG network failures between the source copy and the target database copy. FailedAndSuspended - The Failed and Suspended states have been set simultaneously by the system because a failure was detected, and because resolution of the failure explicitly requires administrator intervention. An example is if the system detects unrecoverable divergence between the active mailbox database and a database copy. Unlike the Failed state, the system will not periodically check whether the problem has been resolved, and automatically recover. Instead, an administrator must intervene to resolve the underlying cause of the failure before the database copy can be transitioned to a healthy state.SinglePageRestore - This state indicates that a single page restore operation is occurring on the mailbox database copy. Based on these values, we want the Status attribute to be either Mounted (true for the server where the database is mounted) or Healthy (for the servers that hold a copy of it). For the ContentIndexState attribute, we want it to be always Healthy. The Copy Queue Length shows the number of transaction log Copy files waiting to be copied to the passive copy log file folder. A Queue copy is not considered complete until it has been checked for Length corruption. The state of Microsoft Exchange Server content indexes: Crawling - Database is in the process of indexing database content. Depending on the size of the database, this process could take some time to complete. Disabled - Indexing for the database has been disable by an administrator. Failed - An error has occurred causing the content index to fail. FailedAndSuspended - The Failed and Suspended states have been set simultaneously by the system because a Content failure was detected, and because resolution of the failure Index explicitly requires administrator intervention. State Healthy - This indicates the Content Index is up to date and has not detected any issues. This is the only state in which a failover (automatic process) to a specific database copy can occur. Seeding - A database copy is in the process of updating its Content Index from another database copy. Suspended - The Suspended status occurs if an administrator manually pauses or suspends it from receiving updates from the active copy. This might be done to update a failed Content Index or to perform troubleshooting for other issues. Latest Full Backup Last full backup time for the mailbox database Time Active If the database copy is active "True" is shown else,if Passive, Copy "False" is shown Days Since Indicates the number of days passed since the latest full backup Latest Full operation was performed. Backup   Client Access Server Role Counters Exchange Server Version Attribute name Description 2007 2010 2013 2016 2019 Outlook Web Access Counters The number of users currently logged on to Outlook Web Access. This value monitors the number of unique active Current Users user sessions, so that users are only removed from this counter after they log off or their session times out. Determines current user load. Outlook Requests The number of Outlook requests processed each Persec second. Determines current user load. Average Search The average time elapsed while waiting for a search to Time complete. Searches timed out The number of Outlook requests timed out. Average response The average time (in milliseconds) that elapsed time between the beginning and end of an OEH or ASPX request. Used to determine the latency that a client isexperiencing. The threshold value should be less than 100 ms at all times. Higher values may indicate high user load or higher than normal CPU time. ASP.NET Counters The number of times the application has been restarted Application Restarts during the Web server''s lifetime. Worker Process The number of times a worker process has restarted on Restarts the computer. The number of ms the most recent request was waiting Request Wait Time in the queue. Availability Service Counters The number of requests in the application request queue per second. The request can be only for free/busy Availability information or include suggestions. One request may Requests sec contain multiple mailboxes. Determines the rate at which Availability service requests are occurring. Average Time to The average time to process a free/busy request in Process a Free Busy seconds. A single request may contain multiple Request mailboxes. The number of HTTP requests waiting to be assigned to Current requests a thread. Mailbox Session The number of hits in a mailbox session. Hits Per Second Public Folder Queries per second is the number of Public Folder mailboxes for which free busy information is requested Queries Per Second from the public folders per second. Public Folder The number of public folder free busy requests failed Request Failures Per per second. Second ActiveSync Service Counters ActiveSync The number of HTTP requests waiting to be assigned to Requests Per a thread. (Average of 50-100.) second The number of ping commands currently pending on Ping Commands the server. Ping Commands Pending are the number of Pending hanging requests, which should be almost equal to the number of Direct Push and hanging sync users. The number of sync commands currently pending on Sync Commands the server. Sync Commands Pending are the number of Pending hanging requests, which should be almost equal to the number of Direct Push and hanging sync users. Requests Queued The number of HTTP requests queued in a thread. CAS OAB Download Counters The number of OAB download tasks queued since the Download Task File Distribution service started. The threshold value Queued should be 0 at all times. The number of OAB download tasks completed since Download Tasks the File Distribution service started. The default value is Completed every 480 minutes or 8 hours. The threshold value should be less than or equal to 3 per day. WebService Counters Current The current number of connections established with the Connections Web service. Determines current user load. Connection The rate that connections to the Web service are being Attempts Per attempted. Determines current user load. Second The rate that Internet Server API (ISAPI) extension Current ISAPI requests are received by the Web service. Determines Extension Requests current user load.Other Request The rate HTTP requests are made that don''t use the Methods Per OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, Second MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, SEARCH, LOCK, or UNLOCK methods. Determines current user load. Requests Per The number of requests processed each second. Second Determines current user load. Completed The number of requests completed each second. requests Per Determines current user load. Second Autodiscover Counters Autodiscover The number of Autodiscover service requests processed Requests Per each second. Determines current user load. Second Unified Messaging Counters Percentage of failed The percentage of mailbox connection attempts that mailbox connection failed in the last hour. The threshold value should be attempts over the less than 5%. last hour Percentage of inbound calls The percentage of inbound calls that were rejected by rejected by the the Microsoft Exchange Unified Messaging service over Unified Messaging the last hour service over the last hour. Percentage of inbound calls rejected by the The percentage of inbound calls that were rejected by Unified Messaging the UM worker process over the last hour. worker process over the last hour Percentage of messages The percentage of messages that were successfully successfully processed by the Microsoft Exchange Unified processed over the Messaging service over the last hour. last hour Percentage of partner voice message The percentage of voice messages for which transcription transcription failed in the last hour. failures over the last hour Unified Messaging calls disconnected The number of calls disconnected after an internal on irrecoverable system error occurred. internal error Unified Messaging The total number of calls disconnected after too many calls disconnected user entry failures. by user failure Unified Messaging The number of calls that are currently connected to the current calls UM server. Unified Messaging Total Calls per Second is the number of new calls that total calls per have arrived in the last second. second User Response Latency is the average response time, in Unified Messaging milliseconds, for the system to respond to a user user response request. This average is calculated over the last 25 latency calls. This counter is limited to calls that require significant processing. Exchange Control Panel Counters Explicit Sign-On The average time (in ms) that requests sent to a Outbound Proxy secondary Client Access server took to complete duringRequests - Average the sampling period. The threshold value should be Response Time under 6,000 ms. The average time (in ms) the Exchange Control Panel Requests - Average took to respond to a request during the sampling Response Time period. The threshold value should be under 6,000 ms. ASP.net Request The number of failures per second detected by ASP.NET Failures Per Second in the Exchange Control Panel. Powershell The average time (in seconds) that a Windows Runspaces - PowerShell runspace stays active while executing Average Active cmdlets in the Exchange Control Panel during the Time sampling period. Powershell The number of Windows PowerShell runspaces created Runspaces Per per second in the Exchange Control Panel. Second RBAC sessions Per The number of RBAC sessions loaded per second in the Second Exchange Control Panel.   Hub/Edge Transport Role Counters Exchange Server Version Attribute Description 2007 2010 2013 2016 2019 name Transport Database Counters (HUB,EDGE) IO Log Writes The rate of log file write operations completed. Determines Per Second the current load. IO Log Reads The rate of log file read operations completed. Determines Per Second the current load. Log Generation The amount of work (in count of log files) that needs to be Checkpoint redone or undone to the database files if the process fails. Depth Version Total number of version buckets allocated. Shows the default Buckets backpressure values as listed in the edgetransport.exe.config Allocated file. IO Database The rate of database read operations completed. Determines Reads Per the current load. Second IO Database The rate of database write operations completed. Determines Writes Per the current load. Second The number of log records that can''t be added to the log Log Record buffers per second because they are full. If this counter is Stalls Per nonzero most of the time, the log buffer size may be a Second bottleneck. The number of threads waiting for their data to be written to Log Threads the log to complete an update of the database. If this number Waiting is too high, the log may be a bottleneck. Transport Dumpster Counters (HUB,EDGE) Dumpster The total size (in bytes) of mail items currently in the transport Size dumpster on this server. Dumpster The rate at which items are inserted into the transport Inserts Per dumpster on this server. Determines the current rate of Second transport dumpster inserts. The total number of mail items currently in the transport Dumpster dumpster on this server. Shows the current number of items Item Count being held in the transport dumpster. Dumpster The rate at which items are deleted from the transport Deletes Per dumpster on this server. Determines the current rate of Second transport dumpster deletions. Transport Queue Length Counters (HUB,EDGE)Aggregate The number of messages queued for delivery in all queues. Delivery The threshold should be less than 3,000 and not more than Queue Length 5,000. All Queues Active Remote The number of messages in the active remote delivery Delivery queues. The threshold should be less than 250. Queue Length Active Mailbox The number of messages in the active mailbox queues. The Delivery threshold should be less than 250. Queue Length The number of messages in the submission queue. The Submission threshold should be less than 100. If sustained high values Queue Length occur, investigate Active Directory and Mailbox servers for bottlenecks or performance-related issues. Active Non- The number of messages in the drop directory used by a SMTP Delivery Foreign connector. The threshold should be less than 250. Queue Length Retry Mailbox The number of messages in a retry state attempting to deliver Delivery a message to a remote mailbox. The threshold should be less Queue Length than 100. Retry Non- The number of messages in a retry state in the non-SMTP SMTP Delivery gateway delivery queues. The threshold should be less than Queue Length 100. Retry Remote The number of messages in a retry state in the remote delivery Delivery queues. The threshold should be less than 100. Queue Length Unreachable The number of messages in the Unreachable queue. The Queue Length threshold should be less than 100. Largest The number of messages in the largest delivery queues. The Delivery threshold value should be less than 200 for the Edge Queue Length Transport and Hub Transport server roles. Poison Queue The number of messages in the poison message queue. The Length threshold value should be 0 at all times. Transport Load Assessment Counters (HUB,EDGE) Messages The number of messages queued in the Submission queue Submitted Per per second. Determines current load. Compare values to Second historical baselines. Messages Completed The number of messages delivered per second. Determines Delivery Per current load. Compare values to historical baselines. Second Inbound Local The number of local delivery attempts per second. Delivery Calls Determines current load. Compare values to historical Per Second baselines. The average number of message bytes per inbound message Average Bytes received. Determines sizes of messages being received for an Per Message SMTP receive connector. Messages The number of messages received by the SMTP server each Received Per second. Determines current load. Compare values to Second historical baselines. Messages The number of messages sent by the SMTP send connector Sent Per each second. Determines current load. Second Items Queued The number of messages queued for delivery per second. for Delivery Determines current load. PerSecond Inbound The number of attempts for delivering transport mail items Message per second. Determines current load. Compare values to Delivery historical baselines.Attempts Per Second Messages The number of messages queued for delivery per second. Queued for Determines current load. Compare values to historical Delivery Per baselines. Second Edge Sync Counters(EDGE) Total topology Exchange topology updates found by EdgeSync updates Exchange Total number of Exchange Servers found by EdgeSync. servers total Edge servers Total number of Edge Transport servers found by EdgeSync. total Hub transport Total number of Hub Transport servers found by EdgeSync. servers total Edge servers Total number of Edge Transport servers leased by EdgeSync. leased total Edge objects added Per The rate of Edge objects added per second by EdgeSync. Second Edge objects deleted Per The rate of Edge objects deleted per second by EdgeSync. Second Edge objects updated Per The rate of Edge objects updated per second by EdgeSync. Second Scan jobs completed The total number of scan jobs completed successfully by successfully EdgeSync. total Scan jobs failed The total number of EdgeSync scan jobs that failed because because EdgeSync could not extend its lease of an Edge Transport could not server. extend lock total Scan jobs failed because of The total number of EdgeSync directory errors. directory error total Scan jobs failed The total number of Scan jobs failed because could not lock because total. could not lock total Source objects The rate of Active Directory objects scanned per second by scanned Per EdgeSync. Second Target objects scanned Per The rate of Edge objects scanned per second by EdgeSync. Second Recipient Filter Agent Counters(EDGE) Recipients rejected by Show the number of recipients rejected by recipient recipient validation per second. validation Per Second Recipients Show the number of recipients rejected by block list per rejected by second.block list Per Second Sender Filter Agent Counters(EDGE) Messages filtered by Show the number of messages filtered by the Sender Filter sender filter agent per second. Per Second DNS queries The number of DNS queries per second performed by the Per Second Sender Id agent. Attachment Filtering Counters(EDGE) Messages The number of messages that were blocked, stripped of attachment attachments, or silently deleted (as per configuration) by the filtered attachment filtering agent. The number of messages per second that the attachment Messages filtering agent blocked, stripped of attachments, or silently filtered Per deleted. If this rate rises greatly beyond what is “normal” for Second the Exchange server, it may indicate that the organization is being flooded with malicious e-mail. Content Filter Agent Counters(EDGE) Messages The total number of messages that were deleted by Content deleted Filter Agent. Messages The total number of messages that were quarantined by quarantined Content Filter Agent. Messages The total number of messages that were rejected by Content rejected Filter Agent. Messages that bypassed The total number of messages that bypass scanning. scanning Messages scanned per The number of messages scanned per second. second Active Directory Application Mode (ADAM) Counters (EDGE) LDAP The number of Lightweight Directory Access Protocol (LDAP) Searches Per search requests issued per second. Used to determine the Sec current LDAP search rate. LDAP Writes The rate at which LDAP clients perform write operations. Per Sec   Edge Transport Role Counters Exchange Server Version Attribute name Description 2007 2010 2013 2016 2019 Exchange-Agents Agent Name The Name of the agent counters. Average Agent The average agent processing time in seconds per event. Processing Time The threshold value should be less than 20 in sec Total Agent The total number of invocations since the last restart. The Invocations current invocation rate. Message Hygiene Counters Average time taken to perform scanning of mailboxes as Average Scan part of the message hygiene using scheduled and on- Time demand scans. A high value could indicate a bottleneck in scanning. Scan Requests The number of scan requests in this application pool’s Rejected Per queue that were rejected. Second Scan Requests The number of scan processes currently running. Being ScannedScan Requests The amount of time spent in processing a request. Processing Time Per Request Antimalware The amount of time taken for the Antimalware engine to Processing Time process an item. Per Request Unhealthy Antimalware Antimalware engines with errors in engine functioning. engines Indicates what percentage of scan requests submitted Scan Requests encountered errors that prevented the processing of those Fatal Errors scan requests. Scan Request The number of scan requests that timed out in the last Timeouts minute. Scan Processes The number of scan processes currently running. Running Scan Time Per The scan time per request. Request Scan Requests Processed Per The number of scan requests processed per second. Second Scan Request The time for which a scan request waits in the internal Wait Time Per queue. Request Scan Requests The number of scan requests that are currently in the Queued internal queue. Scan Requests The number of scan requests submitted per second, Submitted Per including requests accepted and rejected by the scanning Second system. SafetyNet Counters Resubmission Average time spent to resubmit each message when Latency processing a Safety Net resubmit request. SafetyNet The number of messages resubmitted from Safety Net. Resubmission Resubmit requests are generally triggered by HA but can Rate also be requested manually via New-ResubmitRequest. SafetyNet Number of resubmit requests that were made to safety net Resubmit during the sampling period. Request rate Shadow Total number of messages resubmitted from Shadow SafetyNet Safety Net. Shadow resubmit requests occur when a Resubmission primary Safety Net server cannot be reached for several Rate hours. Shadow SafetyNet Number of shadow resubmit requests that were made to Resubmit shadow safety net during the sampling period. Request rate Resubmit Total number of resubmit requests encountered per Request rate resubmit request state.   Unified Messaging Server Role Counters Exchange Server Version Attribute name Description 2007 2010 Unified Messaging Counters Percentage of failed mailbox connection The percentage of mailbox connection attempts that failed in the last attempts over the last hour. hourPercentage of inbound The percentage of inbound calls that were rejected by the Microsoft calls rejected by the Exchange Unified Messaging service over the last hour. um service over the last hour Percentage of inbound calls rejected by the The percentage of inbound calls that were rejected by the UM worker um worker process process over the last hour. over the last hour Percentage of messages The percentage of messages that were successfully processed by the successfully Microsoft Exchange Unified Messaging service over the last hour. processed over the last hour Percentage of partner voice message The percentage of voice messages for which transcription failed in the transcription failures last hour. over the last hour Directory access The number of times that attempts to access Active Directory failed. failures Calls disconnected on irrecoverable internal The number of calls disconnected after an internal system error occurred. error The number of all UM operations that took more than six seconds to Operations over six complete. This is the time during which a caller was waiting for UM to seconds respond. Calls disconnected by The number of calls during which the caller disconnected while Unified callers during um Messaging was playing the audio hourglass tones. audio hourglass Total inbound calls The total number of inbound calls that were rejected by the Microsoft rejected by the um Exchange Unified Messaging Service since the service was started. service Total inbound calls The total number of inbound calls that were rejected by the UM Worker rejected by the um process since the service was started. worker process Call answer queued The number of messages created and not yet submitted for delivery. messages Direct access failures The number of times that attempts to access Active Directory failed. The number of times that attempts to access a Hub Transport server Hub transport access failed. This number is only incremented if all Hub Transport servers were failures unavailable. Unhandled exceptions The number of calls that were disconnected after an internal system error Per Second occurred in the last second. The number of notifications that have been created and not yet submitted Queued ocs user event for delivery. Represents the number of missed call notifications that have notifications been generated in the Office Communications Server environment and have not been submitted for delivery. Mailbox server access The number of times the system did not access a Mailbox server. failures   Overview - Common Counters Exchange Server Version Attribute Description 2007 2010 2013 2016 2019 name Server Component States Component Specifies the Exchange Component name. Name State Specifies the Exchange Component Status. Availability Specifies the availability of the Exchange Component. Exchange ServicesService Specifies the Exchange Agent Service name. Name Status Specifies the Exchange Agent Service Status. Availability Specifies the availability of the Exchange Agent Service. AD Access Domain Controllers Domain The specified domain controller Controller The time in milliseconds that a LDAP read request takes to be LDAP Read fulfilled. The average value should be under 50 milliseconds. Time Maximum values should not exceed 100 milliseconds. The time in milliseconds that it takes a Lightweight Directory LDAP Access Protocol (LDAP) search request to be fulfilled. The Search threshold values should be below 50 ms. Maximum values Time should not be higher than 100 ms. LDAP The number of LDAP searches that returned LDAP_Timeout searches during the last minute. The threshold value should be below 10 timed-out at all times for all roles. Higher values may indicate issues with per Minute Active Directory resources. Long- The number of LDAP operations on this domain controller that running took longer than the specified threshold per minute. The default LDAP threshold value is 15 seconds. The threshold values should be operations below 50 ms. Higher values may indicate issues with Active Per Minute Directory resources.   Host Performance Counters Exchange Server Version Attribute name Description 2007 2010 2013 2016 2019 Disk Utilization Percent Free The percentage of free Space on the disk. Space Number of disk reads per second on the physical disk. This Disk Reads Per counter should be well under the maximum capacity for the Second disk device. Number of disk writes per second on the physical disk. This Disk Writes Per counter should be well under the maximum capacity for the Second disk device. Memory Utilization Used Memory The memory space used by the server Space Free Physical The amount of free physical memory available. Memory Used Memory The percentage of memory space used by the server Percent Total Visible Total amount of physical memory available to the operating Memory Size system. Exchange Domain Controllers Connectivity Counters Cache Hits Per The number of object found in cache events per second. Second Cache Misses The number of objects not found in cache events per Per Second second. LDAP Searches The number of LDAP search requests issued by a process Per Second per second. Outstanding Asyncronous The number of outstanding LDAP read requests. Reads Memory Pages Pages Input/sec The rate at which pages are read from disk to resolve hardpage faults. The rate at which pages are written to disk to free up space Pages in physical memory. A high rate of pages output might Output/sec indicate a memory shortage. The rate at which pages are read from or written to disk to Total Pages/sec resolve hard page faults. This counter is a primary indicator of the kinds of faults that cause system-wide delays. The number of read operations, without regard to the Page Reads/sec number of pages retrieved in each operation. The number of write operations, without regard to the Page Writes/sec number of pages written in each operation. Transition Pages The rate at which the number of transition cache pages Repurposed/sec were reused for a different purpose.   Queues Exchange Server Version Attribute Description 2007 2010 2013 2016 2019 name Exchange Queues * Queue The identity of the queue in the form of \ . Learn Name more The current queue status. A queue can have one of the following Status status values: Active, Connecting, Suspended, Ready, or Retry. Learn more Message The number of messages in the queue. Count The drain rate of the queue, calculated by subtracting the value of Velocity Incoming Rate from the value of Outgoing Rate. Learn more Represents how the Transport service intends to transmit the message to the next hop, which could be the ultimate destination of the message, or an intermediate hop along the way. The value Delivery External indicates the next hop for the queue is outside the Type Exchange organization. The value Internal indicates the next hop for the queue is inside the Exchange organization. Possible values: Internal, External, Undefined The next domain where the messages hops from the current queue. For delivery queues, the value of this field is effectively the name of Next Hop the queue. The value of NextHopDomain isn''t always a domain Domain name. For example, the value could be the name of the target Active Directory site or database availability group (DAG). * Metrics for Exchange Queues are mapped under Admin → Performance Polling → Optimize Data Collection.   Exchange 2003 Performance Counters Attribute name Description SMTP Connections Inbound The total number of connections that were currently inbound. Connections Outbound The number of connections that were currently outbound. Connections SMTP statistics Local Retry Queue The number of messages in the local retry queue. Length Remote Retry The number of messages that were in the retry queue for remote delivery. Queue Length Remote Queue The number of messages that were in the remote queue.Length Messages Pending The number of messages that were categorized but not routed. Routing Messages in Local The number of messages that were currently being processed by a server event sink for Delivery local delivery. Currently Undeliverable The number of messages that were reported as currently undeliverable by routing. Messages Categorizer Queue The number of messages in the categorizer queue waiting to be categorized. Length POP & IMAP Connections Current POP The total number of POP connections opened since the computer was last started. Connections Current IMAP The total number of IMAP connections opened since the computer was last started. Connections Information Store Mailbox statistics The number of messages in the mailbox''s receive queue. The threshold value should be Receive Queue Size below 500 at all times. The number of messages in themailbox''s send queue. In a server with no mail-enabled Send Queue Size mailbox, it should be below 10. Otherwise, it should be below 500 at all times. Active Client The active client logons to Mailbox Stores during the specified time period. Logons Client Logons The client logons to Mailbox stores during the specified time period. Logon Operations The number of logon operations to Mailbox stores per minute. Per Min Message Recipients The message delivery rate. System Monitor data should match the Exchange Load Delivered Per min Generator predicted value for message received rate. Messages Delivered The message submission rate. Per min Messages Sent Per The message sent rate. min Mailbox Used The amount of space used by the Mailbox. Space Information Store Public Folder statistics Send Queue Size The number of messag es in the public store''s send queue. Receive Queue Size The number of messag es in the public store''s receive queue. Active Client The active client logons to Public Folder Stores during the specified time period. Logons Client Logons The client logons to Public Folder Stores during the specified time period. Logon Operations The number of logon operations to Public Folders per minute. Per Min Messages Delivered The message delivery rate. Per min Message Recipients The message recipients delivery rate. System Monitor data should match the Exchange Delivered Per min Load Generator predicted value for message received rate. Messages Sent Per The message sent rate. minute Messages Submitted Per The message submission rate. minute Public Folders Used The amount of space used by Public Folders. Space Information Store Connections & Users Information Store Active Connection The number of connections that have shown some activity in the last 10 minutes. CountInformation Store The number of client processes connected to the information store. Connection Count Information Store The number of user connectio ns that have shown some activity in the last 10 minutes. Active User Count MTA statistics MTA Work Queue The number of messages in the MTA work queue. This indicates the number of messages Length not yet processed to completion by the MTA. MTA Message Bytes The rate at which message bytes are processed. Per Min MTA TCP/IP Received Bytes Per The rate at which bytes are received over a TCP/IP connection. Min MTA TCP/IP Transmit Bytes Per The rate at which bytes are transmitted over a TCP/IP connection. Min MTA Total The maximum number of recipients permitted in the MTA queues. Recipients Queued MTA Work Queue The total volume of messages (in MB) stored in the message transfer agent (MTA). Bytes Information Store statistics Current Pending Messages currently pending in the MTA Queue Local Delivery Current message from Messages currently in transit from MSExchangeMTA to Exchange Store MSExchangeMTA Currentmessages to Messages currently in transit to MSExchangeMTA from Exchange Store MSExchangeMTA Messages Received The number of messages received by the SMTP server each min Per Min Messages Sent Per The number of messages sent by the SMTP server each min Min HSOT Cache Hits The number of objects found in cache events per second. Directory & Event Service statistics Pending Replication The number of directory synchronizations that are queued for this server. This counter Synchronizations helps identify replication backlogs - the higher the number, the larger the backlog. Remaining The number of directory synchronizations remaining. This counter helps identify Replication replication backlogs - the higher the number, the larger the backlog. Updates Notify Queue The queue of store notifications waiting to be processed. Address Lists The number of entries in the Address List queue. Queue Length Message Transfer Agent Connections MTA Queue Length The number of outstanding messages queued for transfer The total volume of message content (in MB) that is stored in the queue of the Message MTA Queued Bytes Transfer Agent. MTA Current The number of inbound (remotely initiated) associations between the MTA and the Inbound connected MTA. MTAs can open multiple associations, if additional transfer throughput is Associations necessary. MTA Current The number of inbound (locally initiated) associations between the MTA and the Outbound connected MTA. MTAs can open multiple associations, if additional transfer throughput is Associations necessary. Mail Server Monitoring To create a Mail Server Monitor, follow the steps given below: Click on New Monitor link. Choose Mail ServerSelect a Display Name. Enter the IP Address or hostname of the host in which the SMTP server is running. You can check the Secure Connection(SSL) option to enable TLS for securing data transmission between Applications Manager & other applications. Enter the SMTP Port number. Enter an email address available in that SMTP server. If the SMTP server requires authentication, specify the User Name and Password by clicking SMTP Server requires Authentication field. If the POP/Imap service is in a different host, specify its POP/Imap Host (host where POP service runs) and POP Port. Also provide the authentication details User Name and Password for the POP service. If the SMTP and POP/Imap service are running in the same host, then ignore this step. Check the Secure Connection(SSL) option to enable TLS for securing data transmission Enter the message to appear in the subject of the mail. Enter the timeout in seconds. Enter the polling interval time in minutes, in Polling Interval field. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Mail Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Mail server from the network and starts monitoring them. If you have added Monitors and not associated them with a Monitor Group, you can do this manually anytime. For information on associating a Monitor with a Monitor Group, refer to Associating Monitor with Monitor Groups topic.   Connects to the Mail Server and performs both SMTP and POP operations, by sending and fetching test mails. Checks both SMTP and POP servers to ensure availability. Enables performance management by monitoring the response time of the server and updates the status based on a given threshold. Middleware / Portal Applications Manager monitors middleware software servers and applications to detect performance problems before they could affect the system. Applications Manager provides Middleware monitoring that monitors system resources. It also provides proactive measures by notifying system operators about potential problems. The different middleware / portal supported are: Microsoft Message Queue (MSMQ) Microsoft Office Sharepoint Server  WebLogic Integration IBM WebSphere MQ  WebSphere MQ Message Broker VMware vFabric RabbitMQ Microsoft Biztalk Oracle Tuxedo Azure Service Bus Microsoft Skype for Business Apache Kafka Apache ActiveMQ Browse through the different servers that provide server information and their parameters being monitored. Microsoft MQ (MSMQ) Monitoring Creating a new MSMQ monitor Prerequisites for monitoring MSMQ metrics: Click here Using the REST API to add a new MSMQ monitor: Click here Follow the steps given below to create a new Microsoft MQ monitor:Click on New Monitor link. Select Microsoft MQ (MSMQ) under Middleware/Portal category. Enter the display name of the host. Enter the HostName of the MSMQ server. Select the Mode of Monitoring (WMI or Powershell). Provide the monitor-specific authentication information, such as User Name and Password. Enter the Timeout value in seconds. The value should be between 60 and 900 seconds. However, this is applicable only in Powershell mode of monitoring. (Default value is 300 seconds.) Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the Microsoft MQ server to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Microsoft MQ server from the network and starts monitoring it. Monitored Parameters Applications Manager monitors the critical components of Microsoft Message Queue (MSMQ) servers to detect any performance problems. These components include message stats, session stats, Microsoft message queue stats, etc. Availability tab shows the availability history of the MSMQ for the past 24 hours or 30 days. Performance tab shows the response time of the MSMQ as well as the health status and events for the past 24 hours or 30 days. List view tab lists all the MSMQ servers monitored by Applications Manager along with their overall availability and health status. You can also perform bulk admin configuration from this view. Click on the individual monitors listed to view detailed performance metrics. Parameters Description Monitor Information Name The name of the Microsoft Message Queue Server (MSMQ) monitor. Type Describes the type of monitor. Health Represents the health (Clear, Warning, Critical) status of the MSMQ server. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Shows the overall availability status of the monitor for the day. You can also Today''s Availability view 7/30 reports and the current availability status of the monitor. Microsoft Message Queue Services Service Name The name of the message queue service. Status The current status of the message queue service. Messages Stats The rate at which incoming Message Queuing messages are placed in queues Incoming messages/sec on the selected computer by the Message Queuing service. The rate at which outgoing Message Queuing messages are sent from the Outgoing messages/sec selected computer by the Message Queuing service. The total number of incoming Message Queuing messages placed in queues MSMQ Incoming Messages on the selected computer by the Message Queuing service. The total number of outgoing Message Queuing messages sent from the MSMQ Outgoing Messages selected computer by the Message Queuing service. The total number of bytes in all Message Queuing messages residing in active Total bytes in all Queues queues on the selected computer. The total number of Message Queuing messages residing in active queues on Total messages in all Queues the selected computer. Session Stats Sessions The total number of open network sessions involving the selected computer. IP Sessions The number of open IP sessions involving the selected computer. The number of open incoming multicast sessions involving the selected Incoming Multicast Sessions computer.Parameters Description The number of open outgoing multicast sessions involving the selected Outgoing Multicast Sessions computer. Outgoing HTTP Sessions The number of open outgoing HTTP sessions involving the selected computer. Microsoft Message Queue Stats Queue Name The name of the Message queue. The total number of bytes in all Message Queuing messages that currently Bytes in Journal Queue reside in the selected journal. The total number of bytes in all Message Queuing messages that currently Bytes in Queue reside in the selected queue. The total number of Message Queuing messages that currently reside in the Messages in Journal Queue selected journal. The total number of Message Queuing messages that currently reside in the Messages in Queue selected queue. Azure Service Bus Monitoring (Classic) (Deprecated) Azure Service Bus is a cloud based messaging system for connecting applications, services and devices irrespective of their locations. Applications running on Azure, on-premise systems, or both, can commmunicate, message delivery can be managed and numerous applications can be accessed with minimum response time. With Applications Manager, monitoring Azure Service Bus becomes more easier. Usage and throughput statistics of Queues, Relays, Topics, Event Hubs and Subscriptions are accurately displayed that help you track your connectivity and monitor the exchange of messages between various devices. Configure alarms for various metrics and get notified in case of irregularities and take necessary corrective actions. Creating a new monitor To add an Azure Service Bus Monitor for a Namespace, follow the steps given below: Enter the Subscription ID for your Microsoft Azure account. Enter the Service Bus Namespace to be monitored. Specify a Timeout interval in seconds. Specify the Polling Interval in minutes. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Azure Service Bus under the Middleware/Portal Table. Displayed is the Azure Service Bus bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Monitored Parameters Click on the monitor name to see all the server details listed under the following tabs: Monitor Information Overview Queues Topics Subscriptions Event Hubs Relays Monitor InformationLists out all the basic details about the monitor like monitor name, associated groups, next poll time, last poll time etc. Custom fields can be added or removed from here. Overview Group/ Table Name Metric Description Namespace The Service Bus Namespace name. The location/ region of the Service Bus Location Namespace. Current status of the Service Bus Namespace. Can be one of the following values: Active Status Creating Suspended Service Bus Namespace Deleting Configuration Whether the Namespace is enabled or Namespace Enabled disabled. Messaging Namespace Type Notification hub Specifies the Resource Group of the Resource Group Service Bus Namespace. Specifies whether Event Hub is Event Hub Enabled enabled or not. Queues Number of Queues being used. Topics Number of Topics being used. Namespace Usage Subscriptions Number of Subscriptions being used. Event Hubs Number of Event Hubs being used. Relays Number of Relays being used. Queues Group/ Table Name Metric Description Queue Usage Queue Specifies the Name of the Queue. Specifies the percentage of space Used Percentage used in Queue. Specifies the percentage of space Free Percentage free in the Queue. Specifies the size used in the Queue in Used Size (MB) MB. Specifies the free size in the Queue in Free Size (MB) MB. Length of the Queue specifies the Length total number of messages in the Queue. The number of active messages in the Active Message Count Queue. The number of messages that are Dead Letter Message Count dead letters. The number of scheduled messages Scheduled Message Count in Queue. Transfer Dead Letter Message The number of messages transferred Count into dead letters.Transfer Message Count The number of messages transferred to another Queue Current state of the Queue entity. Active Disabled Status SendDisabled ReceiveDisabled When the Queue is disabled, it cannot be used to send or receive messages. Queue Specifies the name of the Queue. Rate of incoming messages in the Incoming Rate (Messages/Sec) Queue. Rate of outgoing messages in the Outgoing Rate (Messages/Sec) Queue. Queue Throughput  Failed Requests Total number of requests failed. Requests Failed Internal Server Number of requests failed due to Errors internal server errors. Requests failed -Server Busy Number of requests failed due to Errors Server Busy errors Number of requests failed due to Requests failed -Other Errors Other errors. Topics Group/ Table Name Metric Description Topic Specifies the Name of the Topic Specifies the percentage of space Used Percentage used in Topic. Specifies the percentage of space Free Percentage free in the Topic. Specifies the size used in the Topic in Used Size (MB) MB. Specifies the free size in the Topic in Free Size (MB) MB. The number of active messages in the Active Message Count Topic. The number of messages that are Dead Letter Message Count dead letters. Topic Usage The number of scheduled messages Scheduled Message Count in Topic. Transfer Dead Letter Message The number of messages transferred Count into dead letters. The number of messages transferred Transfer Message Count to another Topic. Current state of the Queue entity. Active Disabled Status SendDisabled When the Topic is disabled, it cannot be used to send or receive messages. Topic Throughput Topic Specifies the name of the Topic Incoming Rate (Messages/Sec) Rate of incoming messages in theTopic. Failed Requests Total number of requests failed. Requests Failed Internal Server Number of requests failed due to Errors internal server errors. Requests failed -Server Busy Number of requests failed due to Errors Server Busy errors Number of requests failed due to Requests failed -Other Errors Other errors. Subscriptions Group/ Table Name Metric Description Specifies the Name of the Subscription Subscription Specifies the name of the Topic to Topic which the Subscription belongs. Specifies the percentage of space Used Percentage used in Subscription. Specifies the percentage of space Free Percentage free in the Subscription. Specifies the size used in the Used Size (MB) Subscription in MB. Specifies the free size in the Free Size (MB) Subscription in MB. Length of the Subscription specifies Length the total number of messages in the Subscription. The number of active messages in the Active Message Count Subscription Usage Subscription. The number of messages that are Dead Letter Message Count dead letters. The number of scheduled messages Scheduled Message Count in Topic. Transfer Dead Letter Message The number of messages transferred Count into dead letters. The number of messages transferred Transfer Message Count to another Subscription. Current state of the Queue entity. Active Disabled Status SendDisabled When the Subscription is disabled, it cannot be used to send or receive messages. Subscription Throughput Specifies the name of the Subscription Subscription Rate of incoming messages in the Incoming Rate (Messages/Sec) Subscription. Failed Requests Total number of requests failed. Requests Failed Internal Server Number of requests failed due to Errors internal server errors. Requests failed -Server Busy Number of requests failed due to Errors Server Busy errors Requests failed -Other Errors Number of requests failed due to Other errors.Event Hubs Group/ Table Name Metric Description Event Hub Specifies the name of the Event Hub. Rate of incoming messages in the Incoming Rate (Messages/Sec) Event Hub. Rate of outgoing messages in the Outgoing Rate (Messages/Sec) Event Hub. Failed Requests Total number of requests failed. Event Hub Throughput Requests Failed Internal Server Number of requests failed due to Errors internal server errors. Requests failed -Server Busy Number of requests failed due to Errors Server Busy errors Number of requests failed due to Requests failed -Other Errors Other errors. Relays Group/ Table Name Metric Description Listener Specifies the name of the listener. Specifies the type of Relay used.Supported Relays are: RelayType NetTcp NetOneWay Http Number of listeners for the particular Listener Count Relay. The data size in bytes sent through Relay Bytes the Relay. Specifies the number of connection Listeners Connection Attempts attempts made by the listener. Specifies the number of disconnects Disconnects by the listener.  Already Exists errors Number of Already Exists errors. Does Not Exist errors Number of Does Not Exist errors. Internal Errors Number of Internal Errors. Other Errors Number of Other Errors. Quota Exceeded errors Number of Quota Exceeded errors. Unauthorized Errors Number of Unauthorized Errors. Up- The listener is activeDown- The Availability listener is inactive. Microsoft Office Sharepoint Servers Office Sharepoint - Overview Applications Manager provides comprehensive monitoring for key SharePoint performance indicators. Monitor underlying server resources for CPU, memory, and disk constraints as well as SharePoint services, requests queued and infrastructure performance for virtual machines and server hardware health. The monitoring details of Microsoft Office Sharepoint Servers are represented graphically that helps to understand the parameters with ease. Administrators can configure thresholds to the attributes monitored, pinpoint and fix problems before users notice performance issues.Office Sharepoint - Adding a new monitor Microsoft Office SharePoint Server Versions Supported: 2007, 2010, 2013, 2016, and 2019 Prerequisites for monitoring Microsoft Office SharePoint Server: Click here to know the prerequisites for monitoring MS Office SharePoint server. To use Powershell for data collection, make sure the proper steps have been followed to enable powershell remoting. Attributes Monitored: Refer SharePoint Server Parameters to know more about the attributes monitored. To create a Office SharePoint Server Monitor, follow the steps given below: Click on New Monitor link. Select MS Office SharePoint. Give the Display Name. Enter the Hostname of the host where Office SharePoint Server runs. Select the Version of Microsoft Office SharePoint Server - 2007, 2010, 2013, 2016 or 2019. Choose the Features to be monitored for the different versions (Click on the Features textbar to display a drop- down features menu). To use powershell for data collection, tick the Use Powershell checkbox. Checking this option will display Installation Type option: SharePoint Farm Server: Select this option if server has Farm setup. If the monitor is added as a SharePoint Farm Server setup, Applications Manager will discover all other servers in the farm and will add them automatically as separate monitors. A monitor group will be created for the farm and all discovered monitors will be added in the monitor group with the name same as the Farm name. PowerShell is required for discovering servers in the farm. SharePoint Server: Select this option if server has Stand-Alone setup. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. If you wish to enter your own credentials, specify username and password details for this monitor. Enter the Username and Password for the server. Set the Poll interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate MS Office SharePoint server (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers MS Office SharePoint server from the network and starts monitoring them. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on MS Office SharePoint under the Middleware/Portal Table. Displayed is the MS Office SharePoint bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Performance Overview Web Applications Databases Timer Jobs Access Services Visio Web Access Services InfoPath Services Excel Services (For Versions 2007, 2010 and 2013) Office Search Gatherer (For Versions 2007, 2010 and 2013) Search Services (For Version 2016 and 2019) Performance Overview Parameter DescriptionActive Server Pages The total number of errors per second including runtime, preprocessor and Errors/sec script compilation errors. Requests Queued The number of requests waiting for service from the queue. Requests Rejected The total number of requests not executed due to insufficient resources. Requests/sec The number of requests executed per second. Current Sessions The current number of sessions being serviced. Transactions/sec Transactions started per second. Pending Transactions The number of transactions still in progress. Server Stats Free Memory in MB The physical memory available for allocation. Page Faults Per Sec The number of times that data was not found in memory per second. Percentage of Committed Bytes The ratio committed to commit limit. In Use Percentage of Processor Time The percent processor time. SharePoint Server Services Service Name The name of the SharePoint Server Service. Status The status of the service. Availability The availability status of the service Office Search Archival Plugin (For Versions 2010 and 2013) The current number of queues that are committing changes and completing Queries Commiting uploads. Queues Filtering The current number of queues that are being used by the filter threads. The current number of queues that are waiting to flush data to the property Queues Waiting store. Retried Microsoft Office The number of documents which were marked for retry from the plugin. Sharepoint Serverss Total Microsoft Office Sharepoint The total number of documents which have used the first queue. Serverss Blocked Microsoft Office The number of documents waiting for a queue. Sharepoint Serverss Active Queue The currently active queue. Bulk Insert Sessions The number of active bulk insert sessions to the database server. Office Search Archival Plugin (For Version 2007) Active Docs in First Queue The number of documents actively using the first queue. Total Docs in First Queue The total number of documents which have used the first queue. Active Docs in Second Queue The number of documents actively using the second queue. Total Docs in Second Queue The total number of documents which have used the second queue. Total Microsoft Office Sharepoint The number of documents processed. Serverss Error Microsoft Office Sharepoint The number of documents which returned errors from the plug-in. Serverss Active Queue The currently active queue. Bulk Insert Sessions The number of active bulk insert sessions to the database server. Web Content Management-Publishing Cache Publishing Cache Hit Ratio The ratio of hits to misses on the Publishing cache. The total number of items that have been removed from the Publishing cache Total Object Discards due to cache compaction. Publishing Cache Hits / sec The hit rate on the Publishing cache. Publishing Cache Misses / sec The miss rate on the Publishing cache. Publishing Cache Flushes / sec The rate that we are updating the cache due to site changes.Web Applications Parameter Description SharePoint Web Applications DisplayName The display name of the web application. URL The URL to access the web application. The number of Content Databases processed during profile Content database synchronization. Jobs Succeeded The number of timer jobs succeeded related to the web application Jobs Failed The number of timer jobs failed related to the web application Status The status of the web application, if it is online or offline. Databases Parameter Description SharePoint Content Databases Name The name of the content database Server The server in which the database is stored Disk Size Required (GB) The size allocated by the database on disk Web Application The web applications which use the database Current Site Count The number of sites that are stored in the database Status The status of the content database, if it is online or offline Timer Jobs Parameter Description Timer Jobs Jobs Succeeded The total number of timer jobs succeeded Jobs Failed The total number of timer jobs failed SharePoint Failed Timer Jobs DisplayName The name of the timer job Status The status of the content database (online or offline). LastRunTime The last time when the timer job was executed ErrorMessage The error due to which the timer job failed. Access Services Parameter Description Access Data Services Applications Server The total number of active requests being processed by Excel Active Requests Calculation Services at sampling time. The number of active sessions by Excel Calculation Services at sampling Active Sessions time. The average processing time for a request by Excel Calculation Services Average Request Processing Time between sampling times. Access Services Data Access Layer Average Data Fetch Duration The average time (in seconds) that is spent to retrieve data. Average Delete Duration The average time (in seconds) that is spent to delete data. Average Insert Duration The average time (in seconds) that is spent to insert data. Average Update Duration The average time (in seconds) that is spent to update data. Failed Insert Requests / sec The current number of insert requests that failed per second. Failed Delete Requests / sec The current number of delete requests that failed per second.Get Data Requests / sec The current number of data query requests per second. Delete Requests / sec The current number of delete requests per second. Insert Requests / sec The current number of insert requests that are active. Update Requests / sec The current number of update requests per second. Visio Web Access Services Parameter Description Visio Web Access Services The average processing time for a request to Excel Web Front End Request Processing Time component. Large value indicates high response time. The total number of requests per second to Excel Web Front End Requests Received / Sec component. The number of requests that are returned with errors. Higher rate of Requests with Errors / Sec errors indicate unexpected behavior of an Excel Calculation Services that directly affects the performance. InfoPath Services Parameter Description Infopath Forms Services The average time to complete a form-filling session, summed up over Average Session Duration all transactions in the form-filling session. Data Connection Submit Failure Rate The rate of failures for data connection submits in form-filling sessions. Session Completed Rate The rate at which form-filling sessions completed. Transactions Completed Rate The rate at which transactions completed in form-filling sessions. Excel Services (For Versions 2007, 2010 and 2013) Parameter Description Excel Services Web Frontend The number of active requests being processed on Excel Calculation Active Requests - Excel Web FrontEnd Services at sampling time The number of requests received per second on Excel Calculation Requests Per Second Services between sampling times Excel Webaccess The Excel Web Access Average Request time between the last two Excel Web Access Request Time samples The number of requests for chart images served by Excel Web Access Chart Image Requests per Second per second The average time it takes between the request for a chart image and the Average Chart Image Request Time issuance of the response to the web browser by Excel Web Access Excel Calculation Services Requests With Errors / Sec - Excel The number of requests that are returned with errors per second on Calculation Excel Calculation Services between sampling times The average number of sessions opened per second between the last Sessions Per Second two samples Cached Charts Requested Per Sec The number of charts that are provided from a cached image The number of active sessions on Excel Calculation Services at Active Sessions sampling time Rendered Charts Requested Per Sec The number of chart requests per second The number of active requests being processed on Excel Calculation Active Requests Services at sampling time Requests Received per Sec The number of requests received per second on Excel CalculationServices between sampling times Office Search Gatherer (For Versions 2007, 2010 and 2013) Parameter Description Office Search Gatherer Delayed Microsoft Office Sharepoint The number of documents delayed due to site hit frequency rules. Serverss The number of threads waiting for a response from the filter Threads Accessing Network process. Idle Threads The number of threads waiting for documents. Microsoft Office Sharepoint Serverss The number of documents that will be retried after time-out. Delayed Retry Search Services (For Version 2016 and 2019) Parameter Description Office Search Gatherer The number of documents delayed due to site hit frequency Delayed Microsoft Office Sharepoint Serverss rules. The number of threads waiting for a response from the filter Threads Accessing Network process. Idle Threads The number of threads waiting for documents. Microsoft Office Sharepoint Serverss Delayed The number of documents that will be retried after time-out. Retry Search Query Processor Query Client Failures The number of client failures per second.  Query Consecutive Failures The number of consecutive query failures per second. Query Direct Probe Failures The number of Probe Failures per second. Query Load Balancer Errors The number of Load Balancer Errors per second. Query Load Balancer Retries The number of Load Balancer Retries per second. Query Network Failures The number of Network Failures per second. Query Server Failures The number of Server Failures per second. Note: To fetch data in the following tabs ''Web Applications'', ''Databases'', ''Timer Jobs'' & ''SharePoint Services'', make sure you have selected the Use Powershell checkbox when adding the monitor. Data for these tabs cannot be collected using ''WMI'' mode. To view the above said tabs for an existing monitor, click Edit Monitor and select the Use Powershell option for datacollection. For more help on enabling Powershell Remoting, click here. WebLogic Integration Server Monitoring Creating a new WebLogic Integration Server monitor Supported Versions: WebLogic Integration Server 8.x Prerequisites for monitoring WebLogic Integration Server metrics: Click here Using the REST API to add a new WebLogic Integration server monitor: Click here To create a WebLogic Integration Server monitor, follow the steps given below: Click on New Monitor link. Select WebLogic Integration. Enter the IP Address/hostname of the host. Enter the SubNetMask of the network. Enter the port number in which WebLogic Integration Server is running. Enter the polling interval time in minutes.If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the monitor-specific authentication information, such as user name and password. Note: WebLogic Integration Server needs some additional configuration and conditions to be followed for monitoring. For monitoring WebLogic Integration Server 8.x, you should set the weblogic.disableMBeanAuthorization and weblogic.management.anonymousAdminLookup system variable to true for enabling data collection. Follow the steps given below: Edit startWLS.cmdsh present in the /server/bin directory and add the following argument -Dweblogic.disableMBeanAuthorization=true and - Dweblogic.management.anonymousAdminLookupEnabled=true (click on the link to view the sample startWLS.cmdsh file) Restart the WebLogic Integration Server for the changes to take effect. Copy weblogic.jar from folder /weblogic81/server/lib in Remote WebLogic server version 8 and place it under \working\classes\weblogicversion8 folder in the machine where Applications Manager is running. Choose the Monitor Group from the combo box with which you want to associate WebLogic Integration Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers WebLogic Integration server from the network and starts monitoring them. Monitored Parameters WebLogic Integration servers are monitored based on a parameters/ attributes like Business Process Details, Application Integration details & Message Broker details. These attributes provide information about the functioning of WebLogic Integration server monitor and you can receive alarms based on the thresholds configured on the attributes of the server. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information. Parameters Description Business Process Details Process Name of the Process. Name Health Health of the process, depends on the below given parameters. Avg Specifies the average elapsed time of the process. Elapsed time is the time elapsed since all the Elapsed instances started. Time Completed Specifies the number of instances completed per minute. Instances SLA Exceeded Shows the number of instances where SLA exceeded per minute. Instances Running Shows the number of instances running currently per minute. Instances Aborted Shows the number of instances that were aborted - threw an unhandled exception per minute. Instances Frozen Shows the number of instances running frozen - failed but can be unfrozen per minute. When an Instances instance is unfrozen, it resumes from the point where it failed. Terminated Shows the number of instances that were terminated per minute. Instances Application Integration Details AppView Application View ID Name Health Health of the Application Service Number of service invocations since the service counter was last resetCount Service Number of service errors since the service counter was last reset plus the number of event delivery Error Count errors since the event counter was last reset. Avg. Average elapsed time in milliseconds for service invocations. This number averages elapsed time Service for both synchronous and asynchronous services. For asynchronous services, elapsed time includes Elapsed only time spent communicating with the adapter and excludes time spent waiting on the Time asynchronous request queue.. Event Count Number of events delivered since the event counter was last reset. Event Error Number of event delivery errors since the event counter was last reset. Count Message Broker Details Channel Specifies the name of the Channel Name Specifies the health of the Channel, depends on the Message Count, Subscriber Count & Dead Health Letter Count Message Specifies the number of messages delivered to this channel. Count Subscriber Specifies the number of process or Web service types that can subscribe to the channel. Count When the Message Broker is unable to determine the URI to send a message to (that is, no Dead Letter subscribers are found), the message is sent to the appropriate deadletter channel: Count /deadletter/xml, /deadletter/string, or /deadletter/rawData. The Dead Letter Count specifies the number of messages sent to the dead letter channels since the count was last reset. IBM WebSphere MQ Monitoring Creating a new IBM MQ monitor Prerequisites for monitoring IBM MQ metrics: Click here Using the REST API to add a new IBM MQ monitor: Click here To create a IBM WebSphere MQ Monitor, follow the steps given below: Click on New Monitor link. Enter the Queue Manager Name. Give the Hostname of the host where IBM WebSphere MQ runs. Enter the Listener Port. Give the Coded Character Set Identifier (CCSID). Enter the ServerConnection Channel. SSL Enabled checkbox - If SSL authentication is enabled on the server connection channel, then select this option and also provide SSL Cipher specifications. To configure SSL authentication in Applications Manager, refer here. Authentication Enabled checkbox - Provide the monitor-specific authentication information, such as Username and Password. If the timezone of the MQ server is different from that of Applications Manager, select the appropriate Timezone from the dropdown. If both have the same timezone, then choose the timezone as Default. Filter System Objects checkbox - Add the System Objects to Monitor. This option to Include / Exclude the SYSTEM Queues, Channels and Inactive Channels is added will be helpful in reducing unnecessary data in monitor details page. User can use either INCLUDE_QUEUES or EXCLUDE_QUEUES, INCLUDE_CHANNELS or EXCLUDE_CHANNELS and INCLUDE_INACTIVE_CHANNELS: true/false. INCLUDE_QUEUES: SYSTEM.DEAD.*, *.ADMIN.COMMAND.QUEUE EXCLUDE_CHANNELS: SYSTEM.AUTO.SVRCONN INCLUDE_INACTIVE_CHANNELS:true/false. (Note: if this entry is not available in filters then it will be considered as false by default.) ConfigManagerProxy.jar located at \classes directory. ibmjsseprovider2.jar located at \jre\lib directory. Check the Discover Message Broker checkbox to discover the broker. For Version10.x and Above, you can provide the Broker Port. If Broker Authentication is Enabled, provide the Broker username and password. Set the Polling Interval. Click Test Credential. If you are adding a new monitor from an Admin Server, select a Managed Server.Choose the Monitor Group from the combo box with which you want to associate IBM WebSphere MQ Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers IBM WebSphere MQ from the network and Applications Manager starts monitoring it. Know the Prerequisites that are required to monitor IBM WebSphere MQ ( jar files must be added to the respective locations). Discover Message Broker checkbox: To discover Message Broker, the following jars are required: Copy the two jar files to \working\jre\lib\ext directory. Monitored Parameters IBM WebSphere MQ servers are monitored based on the attributes such as listener stats, channel monitoring, etc. and the different web applications and EJB deployed in the server. You can also monitor the operation of the queue managers through event logs. The monitoring details of IBM WebSphere MQ server are represented graphically that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored by the server based on these details. Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. The WebSphere MQ server attributes monitored are classified under the following tabs in Applications Manager: Monitor Information Performance Overview Queues Channels Listeners Services Event Log Configuration Monitor Information Parameter Description Name The Display name of the Monitor Health Represents the health status Last Polled at Time at which the previous poll had started Next Poll at Time at which the next poll has been scheduled Availability Shows the current status of the server - available or not available. Performance Overview Parameter Description Name The Display name of the monitor Health Represents the health status Command Server Specifies the status the command server. It used to check whether the command server on Status the target queue manager is running or not Channel Initiator Specifies the status the channel initiator. It used to check whether the channel initiator on Status the target queue manager is running or not Active Connections The current number of connections to the queue manager. Graphical View of Count of events occurred in the below category in last data collection. Events Count Queue Manager Channel PerformanceConfiguration Command Logger Queues Parameter Description Queue Monitoring Queue Name Name of the Queue Current Depth Current queue depth. % of Queue Percentage of Queue Depth occupied against the max Queue Depth. Occupied Open Input Count Open input count (parameter identifier: MQIA_OPEN_INPUT_COUNT). Open Output Count Open output count (parameter identifier: MQIA_OPEN_OUTPUT_COUNT) Health Health of the Queue based on all the above attributes Queue Usage Graph Graphical view queue depth percentage against the max Queue Depth % of Queue Free Percentage of Queue Depth free against the max Queue Depth It indicates whether there are any uncommitted changes (puts and gets) pending for the queue. Uncommitted Messages YES - There are uncommitted changes pending. NO - There are no uncommitted changes pending. The interval, in seconds, between messages being put on the queue and then being Latency destructively read. It indicates whether the triggering on the queue enabled or not. Trigger Control On triggering enabled for this queue. Off triggering not enabled for this queue. Queue Statistics Queue Name Name of the Queue Last Get Time Date and time at which the GET operation was last performed. Last Get Since Amount of time elapsed since the last GET operation was performed (in minutes). Last Put Time Date and time at which the PUT operation was last performed. Last Put Since Amount of time elapsed since the last PUT operation was performed (in minutes). Oldest Message Age The age of the oldest message on the queue (in seconds). Channels Parameter Description Channel Name of the Channel Name Status Status of the channel - running Bytes Sent Number of bytes sent Bytes Number of bytes Received Received Buffers Sent Number of buffers sent Buffers Number of buffers Received Received Availability of Channel,based on the status attribute.If the status of the channle is RUNNING then Availability it is considered to be available .If the channel is in other states then it is considered to be down. Health Health of the Channel based on all the above attributes Compression The amount of time per message, displayed in milliseconds, spent during compression orTime decompression. Compression Rate of compression achieved in percentage. Rate Listeners Parameter Description Listener Name Specifies the name of the listener The current status of the listener. The value can be: Initializing Status Running Stopping Session Count The number of sessions that the listener can use. This is valid only on Windows. Backlog The number of concurrent connection requests that the listener supports. Health Health of the Listener based on all the above attributes Services Parameter Description Name Name of the service Specifies on which mode the service was started Manual - The service is not to be started automatically or stopped automatically. It is to be controlled by user command. Mode Queue Manager - The service is to be started and stopped at the same time as the queue manager is started and stopped Queue Manager Start - The service is to be started at the same time as the queue manager is started, but is not request to stop when the queue manager is stopped. Type of the service Type Server - Only one instance of the service can be executed at a time Command - Multiple instances of the service can be started Start Time Specifies at which time the service was started.It is applicable only for Server type of service Alteration Specified at which time the service configuration was last altered. Time Status of the service: Starting Status Running Stopped It is applicable only for the server type of service Event Log WebSphere MQ events provide information about errors, warnings, and other significant occurrences in a queue manager. You can monitor the operation of the queue managers by analyzing these events. When an event occurs, the queue manager puts an event message on the appropriate event queue. The event message contains information about the event. Search Options : We have provided the On-demand event search with multiple search options in ''Event Log'' tab. You can also export the event search result to PDF. Event Category From Date To DateEvent Type Any keyword in the event message Note: All the messages in the event queue will be cleared when you restart the queue manager. If the event queue reaches the max depth limit then the further events will not be stored in the queue. So set the threshold for ''% of Queue Occupied'' property for the event queues to avoid loss of event message. All the events are not enabled by default. You can check the enabled or disabled events in the Event Log tab of the MQ monitor details page. Events can be enabled using MQSC commands. Enable only necessary events. Because it will slightly affect the performance of the queue manager. Check the following link to control events: http://publib.boulder.ibm.com/infocenter/wmqv7/v7r0/index.jsp? topic=%2Fcom.ibm.mq.csqzax.doc%2Fmo10670_.htm Currently, we are only displaying the count of events occurred in each category. We do not have the option to monitor the events. Events & Corresponding Queues Events Queues SYSTEM.ADMIN.QMGR.EVENT Local, Remote, Inhibit, Authority, Start & Stop SYSTEM.ADMIN.CHANNEL.EVENT IMS Bridge, Channel, SSL SYSTEM.ADMIN.PERFM.EVENT Performance SYSTEM.ADMIN.CONFIG.EVENT Configuration SYSTEM.ADMIN.COMMAND.EVENT Command SYSTEM.ADMIN.LOGGER.EVENT Logger Event Categories: Events Queues Event Name Identifier Reason Code Start and Stop Events Queue Manager Active MQRC_Q_MGR_ACTIVE 2222 Queue Manager Not Active MQRC_Q_MGR_NOT_ACTIVE 2223 Event Name Identifier Reason Code Queue Depth High MQRC_Q_DEPTH_HIGH 2224 Queue Depth Low MQRC_Q_DEPTH_LOW 2225 Performance Events Queue Full MQRC_Q_FULL 2053 Queue Service Interval High MQRC_Q_SERVICE_INTERVAL_HIGH 2226 Queue Service Interval OK MQRC_Q_SERVICE_INTERVAL_OK 2227 Event Name Identifier Reason Code Change Object MQRC_CONFIG_CHANGE_OBJECT 2368 Configuration Events Create Object MQRC_CONFIG_CREATE_OBJECT 2367 Delete Object MQRC_CONFIG_DELETE_OBJECT 2369 Refresh Object MQRC_CONFIG_REFRESH_OBJECT 2370 Channel Auto Definition DISABLED Events Channel Events Reason Event Name Identifier Code Channel Activated MQRC_CHANNEL_ACTIVATED 2295 Channel Auto-Definition MQRC_CHANNEL_AUTO_DEF_ERROR 2234 Error Channel Auto-Definition OK MQRC_CHANNEL_AUTO_DEF_OK 2233 Channel Blocked MQRC_CHANNEL_BLOCKED 2577Channel Conversion Error MQRC_CHANNEL_CONV_ERROR 2284 Channel Not Activated MQRC_CHANNEL_NOT_ACTIVATED 2296 Channel Not Available MQRC_CHANNEL_NOT_AVAILABLE 2537 Channel Started MQRC_CHANNEL_STARTED 2282 Channel Stopped MQRC_CHANNEL_STOPPED 2283 Channel Stopped By User MQRC_CHANNEL_STOPPED_BY_USER 2279 Event Name Identifier Reason Code Command Events MQSC command is executed MQRC_COMMAND_MQSC 2412 PCF command is executed MQRC_COMMAND_PCF 2413 Event Name Identifier Reason Code SSL Events Channel SSL Error MQRC_CHANNEL_SSL_ERROR 2371 Channel SSL Warning MQRC_CHANNEL_SSL_WARNING 2552 Reason Event Name Identifier Code Default Transmission Queue Type MQRC_DEF_XMIT_Q_TYPE_ERROR 2198 Error Default Transmission Queue Usage MQRC_DEF_XMIT_Q_USAGE_ERROR 2199 Error Queue Type Error MQRC_Q_TYPE_ERROR 2057 Remote Events Remote Queue Name Error MQRC_REMOTE_Q_NAME_ERROR 2184 Transmission Queue Type Error MQRC_XMIT_Q_TYPE_ERROR 2091 Transmission Queue Usage Error MQRC_XMIT_Q_USAGE_ERROR 2092 Unknown Default Transmission MQRC_UNKNOWN_DEF_XMIT_Q 2197 Queue Unknown Remote Queue Manager MQRC_UNKNOWN_REMOTE_Q_MGR 2087 Unknown Transmission Queue MQRC_UNKNOWN_XMIT_Q 2196 Event Name Identifier Reason Code Authority Events Not Authorized Type MQRC_NOT_AUTHORIZED 2035 Event Name Identifier Reason Code Inhibit Events Get Inhibited MQRC_GET_INHIBITED 2016 Put Inhibited MQRC_PUT_INHIBITED 2051 Event Name Identifier Reason Code Logger Events Logger Status MQRC_LOGGER_STATUS 2411 Event Name Identifier Reason Code Alias Base Queue Type Error MQRC_ALIAS_BASE_Q_TYPE_ERROR 2001 Local Events Unknown Alias Base Queue MQRC_UNKOWN_ALIAS_BASE_Q 2082 Unknown Object Name MQRC_UNKNOWN_OBJECT_NAME 2085 Event Name Identifier Reason Code Bridge Events Bridge Started MQRC_BRIDGE_STARTED 2125 Bridge Stopped MQRC_BRIDGE_STOPPED 2126 Configuration Parameter Description Name The Display name of the Monitor Queue Manager Name of the Queue Manager Command Queue Name of the Command Input QueueDead Letter Queue Name of the Dead Letter Queue Transmission Queue Name of the Transmission Queue Max length of Message Specifies length of the longest message that the queue manager can handle Specifies the maximum number of open handles that any one task can use Max Number of Handles concurrently Max Uncommitted Specifies the maximum number of uncommitted messages that can exist within a Messages unit of work. Specifies the time interval (in milliseconds) used to restrict the number of trigger Max Trigger Interval messages Platform The operating system on which the queue manager is running Version Version number of the queue manager IBM WebSphere Message Broker Monitoring Overview WebSphere Message Broker is an enterprise service bus providing connectivity and universal data transformation for service-oriented architecture (SOA) and non-SOA environments. It performs comprehensive range of operations on data, including routing, filtering, enrichment, multicast for publish-subscribe, sequencing, and aggregation. Monitored Parameters Applications Manager monitors availability and performance of the Message Broker, execution group and message flow and memory usage of the execution group. You can also collect Message Flow Accounting and Resource Statistics and configure thresholds to the attributes monitored by the server based on these details. The monitoring details of IBM WebSphere Message Broker are represented graphically that helps to understand the parameters with ease. Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. The WebSphere Message Broker attributes monitored are classified under the following tabs in Applications Manager: Performance Overview Execution Group Message Flow Performance Overview Parameter Description Execution Group Running - Number of execution groups in running Graphical view of Execution Group state status Execution Group Stopped - Number of execution groups in stopped state Message Flow Running - Number of message flows in running state Graphical view of Message Flow status Message Flow Stopped - Number of message flows in stopped state Execution Group Parameter Description Name Name of the Execution Group Used Memory In MB The amount of memory that is currently in use.Free Memory In MB The amount of memory that is currently free.Its value might be undefined. Committed Memory In The amount of memory that is allocated to the JVM by the operating system. MB The maximum amount of memory that can be used for memory management. Its value Max Memory In MB might be undefined. Garbage Collection The total number of garbage collections that have occurred per minute for this instance per Min of the JVM Garbage Collection The garbage collection elapsed time in seconds for this instance of the JVM Time Status Status of the Execution Group Message Flow Parameter Description Name Name of the Message Flow Execution Group Name Name of the Execution Group Messages Processed per Min Total number of messages that are processed MQ Errors per Min Total Number of MQGET errors Total Commits per Min Number of transaction commits that occur when processing a message Total Back outs per Min Number of transaction backouts that occur when processing a message. Timeouts per Min Number of transaction timeouts that occur when processing a message Processing Time in milliseconds CPU time in milliseconds spent processing an input message Status Status of the message flow You can also compare the values between the various attributes. Message Flow Accounting and Statistics Message flow accounting and statistics data is the information that can be collected by a broker to record performance and operating details of message flow execution. Use the below commands to trigger statistics and reports for the message flows. mqsichangeflowstats -a -e -j -c active -o xml -n basic (enable statistics for particular execution group) [OR] mqsichangeflowstats -a -g -j -c active -o xml -n basic (enable statistics for all execution group) mqsichangebroker -v (Poll Interval of the monitor in minutes) Message Broker Resource Statistics Resource statistics are collected by a broker to record performance and operating details of resources that are used by execution groups. Use the below command to trigger resource statistics mqsichangeresourcestats -c active -e (enable statistics for particular execution group) mqsichangeresourcestats -c active (enable statistics for all execution group)   Note: The broker should be restarted after executing the commands. Enabling the above statistics will moderately affect performance. So it is recommended that you enable these statistics only for the required executions groups. RabbitMQ MonitoringOverview Applications Manager monitors the critical components of RabbitMQ servers to detect individual queues and collect metrics which reflect the queue''s performance and throughput. The critical components of RabbitMQ servers include: Queued messages and message rates statistics Node details like socket descriptor and Erlang process utilization Channel statistics like message publish rates Exchange message rates In depth connection status Creating a new RabbitMQ server monitor Using the REST API to add a new RabbitMQ monitor: Click here To create a RabbitMQ Server Monitor, follow the steps given below: Click on New Monitor link. Select RabbitMQ under the Middleware/Portal list. Enter the Display Name and the name of the host where the RabbitMQ Server is running. Enter the Port ID where the management plugin is configured. For default installations of RabbitMQ management plugin, the port number is 55672. Enter the correct User Name and Password of RabbitMQ server. Set the polling interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Select the Monitor Group from the combo box with which you want to associate RabbitMQ server (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This identifies RabbitMQ server from the network and starts monitoring. Monitored Parameters RabbitMQ monitoring includes delivering proactive alarm notifications during network congestion, checking if a consumer is processing slowly or has gone down under heavy message traffic, identifying performance bottlenecks due to high socket descriptors utilization and generating historical reports. Availability tab shows an availability history bar graph of the RabbitMQ server. Using the drop-down list at the right-hand corner of the page, you can set the bar chart to show availability history for the past 24 hours or 30 days. Performance tab gives a graphical representation of the publish, delivery, acknowledged and unacknowledged rates of RabbitMQ server as well as the health history for the past 24 hours or 30 days. The colored icons at the corners of the graphs pop up a ''heat chart'' for the respective metric rate. List view tab lists all the RabbitMQ servers monitored by Applications Manager along with their overall availability and health status. You can edit the monitor details and configure alarms from the list. You can also perform bulk admin configurations from this view. The table below gives a detailed description of the parameters displayed in each of the following tabs: Overview Queues Exchanges Channels Connections Overview Parameter Description Monitor Information General details like name, type, health, host name, etc. Bar graph showing the availability history of the server for the last six Availability history for last 6 hours hours. Performance history for last 6 hours Chart showing the performance history of the server for the last six hours.Queued Messages Message vs time graph showing the ready and unacknowledged messages. Message per second vs time graph showing the deliver, acknowledged Message Rates and publish rates Socket descriptors The number of concurrently open/available/used socket descriptors for used/available/utilization the monitor. Erlang processes The number of concurrently open/available/used Erlang processes for the used/available/utilization monitor. Queues Parameter Description Name The name of the message queue. Exclusive Number of messages of the exclusive consumer subscribed to this queue. Messages Ready Number of messages ready to be delivered to clients. Messages Number of messages delivered to clients, but not unacknowledged yet (meaning it is in Unacknowledged progress or has been reserved). Total Messages Sum of ready and unacknowledged messages (queue depth) Incoming rate The rate at which messages are received. Deliver/Get rate The rate at which messages are delivered. Ack rate The rate at which messages are acknowledged. Exchanges Parameter Description Name The RabbitMQ exchange name. Type The exchange type. (direct, topic, headers, or fanout) Incoming Publish rate The per second rating of incoming messages. Outgoing Publish rate The per second rating of outgoing messages. Channels Parameter Description Channel The channel through which messages are sent. User Name The RabbitMQ username associated with the channel. Prefetch msgs QoS prefetch count value for the channel. Unacked msgs Number of messages delivered via this channel, but not yet acknowledged. Number of published messages not yet confirmed. On channels not in confirm mode, Unconfirmed msgs this remains 0 Publish rate msgs/sec The per second publishing rate of messages. DeliverGet rate The per second recieving rate of messages. msgs/sec Ack rate msgs/sec The per second acknowledgment rate of messages. Connections Parameter Description Peer Address The IP address of the host on the other side of the connection. Protocol Protocol used in connection. Receive rate Rate at which the message is being received (in kbps). Send rate Rate at which the message is being sent (in kbps). State Connection state (starting, tuning, opening, running, closing, or closed)You can enable, disable or delete any of the nodes, queues, exchanges, channels or connections from the drop- down menu at the bottom of the page. You can also compare reports from an adjacent drop-down list. Microsoft BizTalk Monitoring Microsoft BizTalk - An Overview Adding a new Microsoft BizTalk monitor Monitored Parameters Microsoft BizTalk - An Overview Microsoft BizTalk Server provides a powerful Web-based development and execution environment for solving integration problems. BizTalk handles enterprise application integration, business process automation, business- to-business communication, message broker and business activity monitoring. With Applications Manager''s BizTalk Monitoring capability, you can monitor the core components and performance counters like messaging engine, orchestration engine, throttling and adapter performance, ensuring the overall health of BizTalk Environment. Microsoft BizTalk - Adding a new monitor Microsoft BizTalk Server Versions Supported: BizTalk 2013 or below, Biztalk 2016 Prerequisites to monitor Microsoft BizTalk metrics: Click to know about the user previleges and other necessary prerequisites to monitor Microsoft BizTalk Server. Using the REST API to add a new Biztalk monitor: Click here To create a Microsoft BizTalk monitor, follow the steps given below: Click on New Monitor link. Select Microsoft BizTalk. Enter the Display Name of the monitor Enter the Hostname of the host where the BizTalk Server is running. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. If you wish to enter your own credentials, specify username and password details for this monitor. Check Enable PowerShell option to enable data collection through PowerShell. If PowerShell is enabled then Application Name for the related artifacts will be displayed along with other information. For more help on enabling Powershell Remoting, click here. Enter: Database Server Name: If the management database is stored in some other server, provide the name of that database server (optional). Database Name: Provide the management database name. Set the Poll interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate BizTalk server (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers BizTalk server from the network and starts monitoring them. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Microsoft BizTalk under the Middleware/Portal Table. Displayed is the Microsoft BizTalk bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configuration. Click on the monitor name to see all the server details listed under the following tabs: Performance Overview Messaging Orchestrations File Adapters EMail AdaptersWeb Adapters Microsoft Adapters Performance Overview Parameter Description Orchestration Engine Performance Counters (for each HostInstance) Used Physical The percentage of used physical memory on the machine. Memory DB TXN/Sec Average number of database transactions performed per second The average number of dehydrated orchestrations per second. Dehydration is the process of Orch serializing the state of an orchestration into a SQL Server database. The orchestration engine Dehydrated/Sec dehydrates the instance by saving the state, and frees up the memory required by the instance. The average number rehydrated per second. Rehydration is the process of deserializing the Orch last running state of an orchestration from the database.The orchestration engine can be Rehydrated/Sec triggered to rehydrate an orchestration instance by the receipt of a message or by the expiration of a time-out specified in a Delay shape. Number of idle orchestration instances currently hosted by the host instance. This refers to Idle orchestrations that are not making progress but are not dehydratable, such as when the Orchestrations orchestration is blocked waiting for a receive, listen, or delay in an atomic transaction. MsgBox DB The number of attempted database connections that failed since the host instance started. Conn Failures Orch The average number of orchestration instances suspended per second since the host instance Suspended/Sec started. Number of received messages for which receipt has not yet been acknowledged to the Pending Msgs message box. Orch The average number of orchestration instances discarded per second from memory since the Discarded/Sec host instance started. An orchestration can be discarded if the engine fails to persist its state. Orch The average number of orchestration instances created per second since the host instance Created/Sec started. Running Number of orchestration instances currently executing. Orchestrations Host Throttling Performance Counters (for each HostInstance) Active Instance The number of service instances active in memory. Count Database The number of concurrent MessageBox database connections being used. Session Database Size The number of messages in the database queues that this process has published. Process Memory The process memory consumption in MB. This is the maximum of the process’s working set Usage size and the total space allocated for the page file for the process. Total Messages The number of outbound messages delivered to the Orchestration engine or the End Point Delivered  Manager (EPM). Total Messages The number of messages published Published  Message Delivery The current delay in ms imposed on each message delivery batch. Delay(ms) Message Publishing The current delay in ms imposed on each message publishing batch. Delay(ms) Message Indicates whether the system is throttling message delivery (affecting XLANG message Delivery processing and outbound transports). Throttling State 0: Not throttling 1: Throttling due to imbalanced message delivery rate    (input rate exceeds output rate) 3: Throttling due to high in-process message count4: Throttling due to process memory pressure 5: Throttling due to system memory pressure 9: Throttling due to high thread count 10: Throttling due to user override on delivery Indicates whether the system is throttling message publishing (affecting XLANG message processing and inbound transports). 0: Not throttling 2: Throttling due to imbalanced message publishing rate (input rate exceeds output rate) Message 4: Throttling due to process memory pressure Publishing 5: Throttling due to system memory pressure Throttling State 6: Throttling due to database growth 8: Throttling due to high session count 9: Throttling due to high thread count 11: Throttling due to user override on publishing Indicates whether the thread count exceeds the threshold. High Thread 0: Normal Count 1: Thread count exceeds threshold Host Instances Host Name The name of the host instance. This metric indicates which runtime model the instances of the BizTalk host will be running in: In-process - In-process hosts represent service instances that an administrator creates, Host Type deletes, and fully controls with WMI and the BizTalk Administration console. Isolated - Isolated hosts primarily host adapters that must run outside of the normal BizTalk Server runtime process. The current service state of the host instance: 1: Stopped 2: Start pending 3: Stop pending Service State 4: Running 5: Continue pending 6: Pause pending 7:Paused 8:Unknown Status The status of the host instance, enabled or disabled Receive Locations Name The name of the Receive Locations. Inbound The primary location to which the receive location is mapped for receiving the message Transport URL content. Host Name The name of the receive handler used by the receive location. Adapter Name The name of the adapter used by the receive location. Receive Port The name of the port used by the receiver location. Name Send Ports Name The name of the send port. Is Two-Way Gets a value indicating whether the sent port is set up as a request-response port. Is Dynamic Gets a value indicating whether the send port is dynamic or static. Application The application that encloses the send port. Status The status of the send port. Receive PortsName The name of the receive port. Is Two-Way Gets a value indicating whether the receive port is set up as a request-response port. Primary Receive The primary receive location for receiving the message content. Location Application The application that encloses the receive port. Messaging Parameter Description Message Box  Spool Size The size of the spool on a particular message box on a particular server. Tracking Data The size of the tracking data table on a particular message box on a server. Size Total Instances The total number of instances of the host. Message Box Host Queue (For each HostInstance) Suspended Message Total number of messages suspended for the host. Length Host Queue Total number of messages in the host queue. Length Messaging Performance Counters (For each HostInstance) Pending The number of batches received by the Messaging Engine that have not completed Receive processing. These include batches that have been processed asynchronously by the adapters. Batches Pending The number of messages given by the Messaging Engine to send adapters that have not Transmitted completed processing. This includes response messages for adapters. Messages Throttled The number of batches that have been blocked on receive by the Messaging Engine due to high Receive service load. These batches contain new messages to be processed. Batches Messaging Latency (For each HostInstance) Inbound The average latency in seconds from when the Messaging Engine receives a document from Latency the adapter until the time it is published to Message Box. Outbound The messaging Engine receives a document from the Message Box until the time document is Latency sent by the adapter. Orchestrations Parameter Description Name The name of the orchestration. Host Name The name of the BizTalk host instance in which the orchestration runs. Application The name of the application to which the orchestration is associated. This metric returns the status of a specific orchestration. Possible values are: 1 - Unbound. Status 2 - Bound. 3 - Stopped. 4 - Started. File Adapters Parameter Description File Receive Adapter(For each HostInstance) File - Byte The number of bytes received by the file adapter per second. The counter applies only to Received/Sec messages that have been completely read by the file adapter from the file system.Parameter Description File - Messages The number of messages received by the file adapter per second. The counter applies only to Received/Sec messages that have been completely read by the file adapter from the file system. File Send Adapter(For each HostInstance) File - Bytes The number of bytes sent by the file adapter per second. The counter applies only to messages Sent/Sec that have been completely written to file system. File - Messages The number of messages sent by the file adapter per second. The counter applies only to Sent/Sec messages that have been completely written to file system. FTP Receive Adapter (For each HostInstance) FTP - Bytes The number of bytes received by the FTP adapter per second. The counter applies only to Received/Sec messages that have been completely read by the FTP adapter from the FTP server. FTP - Messages The number of messages received by the FTP adapter per second. The counter applies only to Received/Sec messages that have been completely read by the FTP adapter from the FTP server. FTP Send Adapter (For each HostInstance) FTP - Bytes The number of bytes sent by the FTP adapter per second. The counter applies only to messages Sent/Sec that have been written to the destination FTP server. FTP - Messages The number of messages sent by the FTP adapter per second. The counter applies only to Sent/Sec messages that have been written to destination FTP server. SFTP Send Adapter (For each HostInstance) SFTP Bytes The number of bytes sent by the SFTP adapter per second.  Sent/Sec SFTP Messages The number of messages sent by the SFTP  adapter per second. Sent/Sec SFTP Receive Adapter (For each HostInstance) SFTP Bytes The number of bytes received by the SFTP adapter per second. Received/Sec SFTP Messages The number of messages received by the SFTP adapter per second. Received/Sec Email Adapters Parameter Description POP3 Adapter Performance Counters (For each HostInstance) Active Sessions The number of open POP3 connections the POP3 adapter is managing at a time. POP3 - Bytes The number of bytes downloaded by the POP3 adapter from a mail server per second. Receive/Sec POP3 - Messages The number of email messages downloaded by the POP3 adapter from mail server per Received/Sec second. SMTP Adapter (For each HostInstance) SMTP - Messages The number of messages sent by the SMTP adapter per second. The counter applies only to Sent/Sec messages that have been transmitted to the SMTP server. Web Adapters Parameter Description HTTP Receive Adapter (For each HostInstance) The number of HTTP requests received by the HTTP adapter per second. The counter HTTP - Messages applies only to request messages that have been completely read by the HTTP adapter Received/Sec from the HTTP client. HTTP Receive Adapter--Memory The number of incoming messages in the HTTP adapter''s internal memory queue. Queue Size HTTP Send Adapter (For each HostInstance) HTTP - Messages The number of HTTP requests sent by the HTTP adapter per second. The counter applies Sent/Sec only to request messages that have reached the destination URL.Parameter Description HTTP Send Adapter--Memory The number of outgoing messages in the HTTP adapter''s internal memory queue. Queue Size SOAP Send Adapter (For each HostInstance) SOAP - Messages The number of messages sent by the SOAP adapter per second.  Sent/Sec SOAP Receive Adapter (For each HostInstance) SOAP - Messages The number of messages received by the SOAP adapter per second.  Received/Sec Microsoft Adapters Parameter Description MSMQ Receive Adapter (For each HostInstance) MSMQ - Bytes The number of bytes received by the MSMQ  adapter per second. The counter applies only to Received/Sec messages that have been completely read by the MSMQ  adapter from the source queue. MSMQ - The number of messages received by the MSMQ  adapter per second. The counter applies Messages only to messages that have been completely read by the MSMQ  adapter from the source Received/Sec queue. MSMQ Send Adapter (For each HostInstance) MSMQ - Bytes The number of bytes sent by the MSMQ  adapter per second. The counter applies only to Sent/Sec messages that have reached the destination queue. MSMQ - The number of messages sent by the MSMQ  adapter per second. The counter applies only to Messages messages that have reached the destination queue. Sent/Sec SQL Send Adapter (For each HostInstance) SQL Messages The total Messages sent using SQL adapter. Sent SQL Messages The number of messages sent by the SQL adapter per second. The counter applies only to Sent Per Sec messages that have reached the destination queue. SQL Receive Adapter (For each HostInstance) SQL Messages The total Messages received using SQL adapter. Received SQL Messages The number of messages received by the SQL  adapter per second. The counter applies only Received Per Sec to messages that have been completely read by the SQL  adapter from the source queue. Windows SharePoint Services Adapter Performance Counters Percentage The percentage of Windows SharePoint Services files that have not been processed Receive Message by BizTalk Server due to receive errors. Failures Percentage Send The percentage of failed messages BizTalk Server attempted to send to Message Failures Windows SharePoint Services.   Note: The application name for artifacts (Send Ports, Receive Ports, Orchestrations ) will be displayed only if PowerShell is enabled. For more info on how to enable powershell, click here. SFTP Adapter metrics is supported only for Biztalk 2016. Enabling Credential Delegation for Biztalk server If the Biztalk Management Database is on a different server from that where Applications Manager is running, the credentials of the Biztalk Server should be delegated for data collection to happen (Delegation is disabled by default). Here is how you can enable it: Open the Run command Run gpedit.mscOpen the following policy: Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials Right-Click and choose Edit. Select Enabled. Apply and click OK. A user must execute commands in Applications Manager server and the Biztalk server for credential delegation. Now execute the below command as done before in powershell prompt of Applications Manager Server: New-PSSession -ComputerName ''chluzsap2031.root.local'' -Credential Get-Credential -Authentication ''CredSSP'' Oracle Tuxedo Monitoring Overview Oracle Tuxedo provides the framework for building scalable multi-tier client/server applications in heterogeneous distributed environments. From the Web to the Enterprise, Tuxedo users can develop, manage, and deploy distributed applications independent of the underlying hardware, operating system, network and database environment. Monitoring Oracle Tuxedo applications can be complex, providing requests that run across multiple processes, machines, and domain boundaries. Applications Manager can help you monitor system and application data from key Tuxedo components like the bulletin board, queue and communication bridge details, transaction info, ATMI operations and service details. Creating a new Oracle Tuxedo monitor Oracle Tuxedo Versions Supported: Tuxedo version 6.5 and above.We are using BEA SNMP Agent and the SNMP MIBs to manage Tuxedo applications. Prerequisites for monitoring Oracle Tuxedo: You must have Tuxedo SNMP agent installed. When you specify the SNMP community string, make sure that the community string has at least ''Read-only'' privileges. Attributes Monitored: Refer Oracle Tuxedo Monitoring Parameters to know more about the attributes monitored. To create a Oracle Tuxedo Monitor: Click on New Monitor link. Select Oracle Tuxedo. Enter the Display Name of the monitor. Enter the Hostname of the host where the Oracle Tuxedo Server is running. Enter the SNMP port number , on which the Tuxedo SNMP agent is running. The default port number is 161. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. Specify the SNMP community string of Tuxedo SNMP agent. The default value is ''public''. Make sure you use a community string, that has ''Read'' privileges. Enter the timeout in seconds. Set the Polling interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Tuxedo server (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Tuxedo server from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Oracle Tuxedo under the Middleware/Portal Table. Displayed is the Oracle Tuxedo bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Performance Overview ServersQueue Service Configuration Performance Overview Parameter Description BULLETIN BOARD PARAMETERS The maximum number of clients and servers that can have access to the Max Accessers bulletin board on the server machine at one time. The maximum number of simultaneous conversations in which clients Max Conversations and servers on the Tuxedo server can be involved. The maximum number of simultaneous global transactions in which this Max Transactions machine can be involved. The default maximum number of active objects to be accommodated in Max Objects the Active Object Map Tables. BULLETIN BOARD STATUS The number of processes in use that can have access to a bulletin board Accessers Used on a particular processor at any one time. Conversations Used The current number of conversations used. Service Load Enqueued The service load currently enqueued on the server machine. The number of clients, both native and workstation, currently logged in to Current Clients Count the server machine. The state of the domain. The various states are: 1 - Active 2 - Inactive Domain State 3 - Forcible Inactive Note: Forcible shutdown works only in case of single-machine applications. MACHINE STATUS Machine Name The source logical machine name. The state of the source machine. The various states are: 1 - Active 2 - InActive Machine State 3 - Partitioned 4 - Invalid 5 - Re-Activate 6 - Cleaning BULLETIN BOARD LIAISON (BBL) The name of the Tuxedo server where the BBL administration process Server running Process Name The name of the BBL process running on the Tuxedo server State The state of the BBL Process. TLISTEN Lmid The logical machine identifier. The state of your workstation listener within the application. Various states are: TListen State 1 - active 2 - inactiveBRIDGE DETAILS Bridge Lmid The source logical machine identifier. The state of the communication bridge. The various states are: 1 - active Bridge State 2 - inactive 3 - suspended 4 - pending The average number of bytes sent per second from the destination logical Bytes Received/Sec machine to the source logical machine. The average number of bytes sent per second from the source logical Bytes Sent/Sec machine to the destination logical machine. The average number of messages sent per second from the destination Messages Received/Sec logical machine to the source logical machine. The average number of messages sent per second from the source Messages Sent/Sec logical machine to the destination logical machine. TRANSACTION DETAILS Initiated/Sec The number of transactions initiated per second from the server machine. Aborted/Sec The number of transactions aborted per second from the server machine. The number of transactions committed per second from the server Committed/Sec machine. Transactions Used The number of transactions on the tuxedo server. ATMI OPERATION DETAILS Connections/Sec The number of connections performed per second from the server. The number of dequeue operations performed per second from the Dequeues/Sec server. The number of enqueue operations performed per second from the Enqueues/Sec server. Post/Sec The number of post operations performed per second from the server. Servers Parameter Description SERVER DETAILS Name The name of the Tuxedo machine. Group Number The group number associated with a server''s group. Server ID A numeric identifier that uniquely identifies a server within a group. This field displays the state of your server. A server can be in one of the following states: 1 - active 2 - inactive  3 - migrating State 4 - cleaning 5 - restarting 6 - suspended 7 - partitioned 8 - dead 9 - invalid SERVER TRANSACTION DETAILS Transaction Initiated/Sec The number of transactions initiated per second from the server. Aborted/Sec The number of transactions aborted per second from the server. Committed/Sec The average number of transactions committed per second from theserver. SERVER OPERATION DETAILS The number of dequeue operations performed per second from the Dequeues/Sec server. The number of enqueue operations performed per second from the Enqueues/Sec server. Post/Sec The number of post operations performed per second from the server. The number service requests operations performed per second from the Requests/Sec server. The number of subscribe operations performed per second from the Subscriptions/Sec server. Queue Parameter Description QUEUE DETAILS The address of the request queue for an active server offering the Queue Address interface. The state of the Interface Queue objects. Values are: 1 - Active state State 2 - Migration State 3 - Suspended state 4 - Partitioned state Active Servers The number of active servers associated with this queue. Queue Length The sum of the queue lengths of this queue while it has been active. Workload/Sec The load on the system imposed per second by the queue. Requests/Sec The number of requests enqueued per second for this interface. Service Parameter Description SERVICE DETAILS Name  The name of the service on which the server is currently working. The state of the service: 1 - active State 2 - inactive 3 - invalid Load On System The relative load that the service imposes on the system. Timeout (in Seconds) The time limit (in seconds) for processing requests for this service. Configuration Parameter Description CONFIGURATION Domain Master The host where the Tuxedo domain master is running. The classification of your Tuxedo application as a single-machine (SHM) or Model multiprocessor (MP) application. The expiration date for the binary on the server machine or a 0- length License Expiration Date string if binary is not a TUXEDO System/T master binary. MACHINE DETAILS The name of the machine used by Tuxedo for mapping application Machine Name resources to machines configured for this application.Machine Lmid The machine identifier used for mapping application resources to configured machines. This field displays the role of this machine. The various roles are: MASTER Machine Role BACKUP OTHER (Neither the master nor the backup master machine). TUXDIR The absolute path name of the installation directory of Oracle Tuxedo. Each Tuxedo application is controlled by a configuration file in which TUX Conf File installation-dependent parameters are defined. This parameter displays the path to the location of the configuration file. Microsoft Skype for Business Server Monitoring Overview Microsoft Skype for Business is a unified communication application that enables users to use instant messaging (IM), audio and video calls, online meetings, availability information, sharing capabilities and other powerful collaboration tools for corporate users all from one, easy-to-use program. Each server running Skype for Business runs one or more server roles. A server role is a defined set of Skype for Business Server functionalities provided by that server. Applications Manager lets you effectively monitor your Skype for Business Server, collect metrics pertaining to it''s server roles and performance counters in one central location, detect issues, send alerts and thus prevent possible service outages or configuration problems. Users can proactively manage their Skype for Business servers and identify issues before they become critical. Applications Manager gathers data related to the following Server Roles: Front End Server - Monitor the Registrar, User Services, SIP related KPIs (peers,protocol,responses), Storage services, MCU performance and diagnose issues pertaining to all mobility related data. A/V Conferencing Server - Monitor the overall performance and functionality of the Conferencing server in your deployment. Edge Server - Track client communication over SIP, requests and messages. Mediation Server - Monitor call failure between proxies and gateways as well as media connectivity checks. Creating a new Microsoft Skype for Business monitor Supported Versions: Microsoft''s Lync 2013 and Skype for Business 2015. Prerequisites for monitoring Microsoft Skype for Business metrics: To monitor a Microsoft Skype for Business Server the user must have "Administrator" privileges and WMI access enabled for that server. Using the REST API to add a new Microsoft Skype for Business monitor: Click here To create a new Microsoft Skype for Business monitor, follow the steps given below: Click on New Monitor link. Select Microsoft Skype for Business. Enter the Display Name of the monitor Enter the Hostname of the host where the Microsoft Skype for Business Server is running. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. If you wish to enter your own credentials, specify username and password details for this monitor. Select the Server Roles to be monitored from the drop-down menu. Set the Poll interval. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Microsoft Skype for Business server (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Microsoft Skype for Business server from the network and starts monitoring them. Microsoft Skype for Business Server - Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Microsoft Skype for Business under the Middleware/Portals Category. Displayed is the Microsoft Skype for Business Server bulk configuration viewdistributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Applications Manager supports monitoring of counters relevant to the Microsoft Skype for Business server roles under the following tabs: Performance Overview Front End Server | Mobility A/V Conferencing Server Edge Server Mediation Server Performance Overview Attribute name Description System Statistics Available Physical Memory The amount of available physical memory in MB. Web Components The number of requests rejected because the request queue was full ASP.NET Apps v2.0 - Requests Rejected for ASP.NET Apps v2.0. The number of requests rejected because the request queue was full ASP.NET Apps v4.0 - Requests Rejected for ASP.NET Apps v4.0. Join Launcher Service Failures The number of join failures. Failed File Requests Per Sec The per-second rate of failed Address Book file requests. Failed Search Requests Per Sec The per-second rate of failed address book search requests. Failed Validate Cert Calls to other Cert The number of failed validate cert calls to the cert auth provider. Authprovider Timed out Active Directory Requests The per-second rate of timed out Active Directory requests. Per Sec Failed Get Locations Requests The per-second rate of failed Get Locations requests. HTTP 5xx Responses Per Sec The per second rate of responses with HTTP 5xx code. Microsoft Skype for Business Server Services Display Name Name of the Microsoft Skype for Business service. Start Mode The start up type of the service. State The current state of the service. Front End Attribute name Description Registrar Module REG DB Store - Queue The average time a request is held in the request queue to RTC database. Latency REG DB Store - Sproc The average time it takes to execute a sproc call against RTC database. Latency REG DB Store - Throttled The number of requests that were rejected with a retry since the database queue Requests Per Sec latency was high. User Services Module DB Store - Queue Latency The average time a request is held in the request queue to RTCDyn database. DB Store - Sproc Latency The average time it takes to execute a sproc call against RTCDyn database. DB Store - Throttled The number of requests that were rejected with a retry since the database queue Requests Per Sec latency was high.Shared User Services Module Shared DB Store - Queue The average time a request is held in the request queue to RTC Shared database. Latency Shared DB Store - Sproc The average time it takes to execute a sproc call against RTC Shared database in Latency ms. Shared DB Store - Throttled The number of requests that were rejected with a retry since the database queue Requests Per Sec latency was high. SIP Peers Authentication System Errors The per-second rate of authentication failures caused by system errors (due to low Per Sec memory conditions or otherwise). Average Outgoing Queue The average outgoing queue delay in seconds. Delay XmppFederation Failure The failure IMDNs sent per sec. IMDNs Sent Per Sec Connections Active The number of connections that are currently established and active. The number of connections that are currently established and active which are TLS Connections Active authenticated using Transport Layer Security (TLS) protocol. Sends Outstanding The number of messages that are waiting in the outgoing queues. Average Flow Control Delay The average delay time  due to messages waiting in the outgoing queue. Incoming Requests Per Sec The number of request received per second by the server. Incoming Responses Per Sec The number of responses received per second by the server. Outgoing Requests Per Sec The number of request going out per second from the server. Outgoing Responses Per Sec The number of responses going out per second from the server. SIP Protocol Outgoing Messages Per Sec The number of messages sent per second. The per-second rate of incoming responses dropped because they could not be Incoming Responses processed (due to bad headers, insufficient routing information, server resource Dropped Per Sec allocation failure). Average Event Processing The average time to process a SIP transaction or dialog state change event, in Time seconds. Average Incoming Message The average time (in seconds) it takes to process an incoming message. Processing Time Average Number of Active The average time to process an incoming message, in seconds. Worker Threads This metric shows the number of SIP transactions or dialog state change events, Events in Processing that are currently being processed. Incoming Messages Per Sec The number of messages received per second. The number of SIP transaction or dialog state change events that were delivered Events Processed Per Sec for processing per second. Messages in Server The number of messages that are currently being processed by the server. SIP Responses Incoming 503 Responses Per The total number of incoming 503 responses per second. Sec Local 500 Responses Per The total number of 500 responses generated by the server per second Sec Local 504 Responses Per The total number of 504 responses generated by the server per second Sec SIP Load Management Incoming Messages Timed The number of incoming messages currently being held by the server for Out processing for more than the maximum tracking interval. Average Holding Time For The average time that the server held the incoming messages currently being Incoming Messages processed. The available page file space currently in use by the server process, in Page File Usage percentage.Routing Apps Primary Registrar Timeouts Number of requests for which primary registrar timed out. Backup Registrar Timeouts Number of requests for which backup registrar timed out. Number of Incoming Failure Number of times an Emergency Call failure response was received from Gateway. Responses Storage Service Skype for Business Storage The current number of Storage Service queue items which are not owned and last Service Stale Queue Items attempted a long time ago. Dataloss Events with State The total number of data loss events with state change. Change Dataloss Events without The total number of data loss events without state change. State Change Failures of Replication Operations Sent to other The per-second rate of replication operation failures. Replicas Per Sec Server Connected to Fabric Indicates whether server is connected to fabric pool manager. Pool Manager MCU Health and Performance The current health of the MCU (Multi-point Control Unit) responsible for Application Sharing. 0 = Normal. ASMCU - Health State 1 = Loaded. 2 = Full. 3 = Unavailable. The current health of the MCU (Multi-point Control Unit) responsible for Audio/Video support. 0 = Normal. AVMCU - Health State 1 = Loaded. 2 = Full. 3 = Unavailable. The current health of the MCU (Multi-point Control Unit) responsible for data. 0 = Normal. DATAMCU - Health State 1 = Loaded. 2 = Full. 3 = Unavailable. The current health of the MCU (Multi-point Control Unit) responsible for instant messaging. 0 = Normal. IMMCU - Health State 1 = Loaded. 2 = Full. 3 = Unavailable. IMMCU Statistics Throttled SIP Connections The number of throttled Sip connections. Active Conferences The number of conferences that are currently active. Connected Users The number of users which are connected in all conferences. Mobility Attribute name Description Mobility Health Push Notification Requests Failed Per Sec The per second rate of failed push notifications.Push Notification Requests Throttled Per Sec The per second rate of throttled push notifications. Requests Failed Per Sec The per second rate of failed requests. Requests Rejected Per Sec The per second rate of rejected requests. Conferencing Attribute name Description Conferencing Statistics CAA Incomplete Calls The per second rate of incomplete calls to Conferencing Attendant. This includes Per Sec (only for Lync calls disconnected by the user and by the system due to invalid conference id, Server) passcode, etc. Allocation Latency The average time (in milliseconds) taken to complete a full MCU allocation request. Create Conference The average time (in milliseconds) taken to complete a create conference call. Latency Edge Server Attribute name Description Edge Server Statistics Bad Requests Received Per Sec The per-second number of bad requests received. SIP Above Limit Connections The total number of connections that were dropped because the limit on Dropped Access (Proxies Only) number of incoming connections from a federated partner or clearing house (only for Lync Server) was exceeded. The number of sends dropped per second because they stayed in the SIP Sends Timed Out Per Sec outgoing (send) queue for too long. The number of connections that are currently being flow-controlled (no SIP Flow controlled Connections socket receives are posted). The per-second rate of incoming requests dropped because they could not SIP Incoming Requests Dropped be processed (due to bad headers, insufficient routing information, server Per Sec resource allocation failure). Average Incoming Message The average time (in seconds) it takes to process an incoming message. Processing Time Mediation Server Attribute name Description Mediation Server Statistics Total Failed Calls Caused by Unexpected The number of calls that failed because of unexpected Interaction from the Proxy interaction from the Proxy. Total Failed Calls caused by Unexpected The number of calls that failed because of unexpected Interaction from a gateway interaction from the Gateway The scaled index between zero and 100 that is related to all Load Call Failure Index call failures due to heavy load The number of times Media stack does not have Media relay Candidates Missing candidates. Media Connectivity Check Failures The number of media connectivity check failures. Apache Kafka Monitoring Apache Kafka - An Overview Monitoring Apache Kafka - What we do Creating a new Apache Kafka monitor Monitored Parameters Apache Kafka - An OverviewApache Kafka is an open-sourced, fault-tolerant publish-subscribe-based messaging system developed by LinkedIn. A distributed log-service, Kafka is often used in place of traditional message brokers because of its higher throughput, scalability, reliability and replication. Monitoring Apache Kafka - What we do An attractive option for data integration, Apache Kafka is fast and highly scalable. Kafka nodes are created and taken down in an elastic manner; with a single node handling hundreds of read/writes from thousands of clients in real-time. Data streams are split into partitions and spread over different brokers. Although very simple at a high level, Kafka has an incredible depth of technical detail, for which, having a robust Kafka monitoring software is essential to troubleshoot issues and optimize performance. Applications Manager''s Kafka performance monitoring aims to help administrators collect Kafka metrics, manage clusters and be alerted automatically on potential issues. Let us take a look at what you need to see to monitor Kafka and the performance metrics to gather with Applications Manager Kafka monitor: Resource utilization details - Automatically discover Kafka servers, monitor memory and CPU and get alerts of changes in resource consumption. Thread and JVM usage - Track thread usage with metrics like Daemon, Peak and Live Thread Count. Ensure that started threads don’t overload the server''s memory. Broker, Controller and Replication Statistics - Gauge active controllers and see if brokers are up with the number of unavailable partitions. Monitor broker stats like log flush latency (to make sure longer flushes don’t back up the pipeline) and under-replicated partitions (indicating replication is not going as fast as configured). Network and Topic Details - Pinpoint the requests segment causing a slowdown. Keep an eye on network usage on your host so degraded performance is not network-related. Ensure disk throughput does not cause performance bottlenecks, with Broker Topic byte rates metrics. Fix Performance Problems Faster - Get instant notifications when there are performance issues with the components of Apache Kafka. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Creating a new Kafka monitor Supported versions: Versions 0.7.0 to 0.10.0.1 Using the REST API to create a new Kafka monitor: Click here To create an Apache Kafka Monitor, follow the steps given below:  Click on New Monitor link. Choose Apache Kafka. Enter Display Name of the monitor. Enter the IP Address or hostname of the host in which Kafka is running. Enter the JMX Port in the JMX Port field. Enter the credential details like user name, password and JNDIPath or select credentials from a Credential Manager list. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Apache Kafka Server. Choose the Monitor Group from the combo box with which you want to associate Apache Kafka Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Apache Kafka from the network and starts monitoring. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Apache Kafka under the Middleware/Portal Table. Displayed is the Apache Kafka bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Applications Manager''s Kafka performance monitoring provides complete visibility into your Kafka servers based on the metrics listed in the following tabs:Overview Controller Details Broker Details Network Details Topics Details Configurations Overview Parameter Description Memory Details Total Physical Memory The total amount of physical memory in Megabytes. Size Free Physical Memory The amount of free physical memory in Megabytes. Size Committed Virtual The amount of virtual memory that is guaranteed to be available to the running Memory Size process in Megabytes. Total Swap Space Size The total size of virtual memory hold by the JVM. Free Swap Space Size The free virtual memory size. Thread Details Daemon Thread Count The number of daemon threads currently running. Peak Thread Count The peak live thread count since the Java virtual machine started or peak was reset. Live Thread Count The number of live threads currently running. Total Started Thread The total number of threads created and also started since the Java virtual machine Count started. Heap and Non Heap Memory Details NonHeapMemoryUsage The non-heap memory currently in use. HeapMemoryUsage The heap memory currently in use. Controller Details In a Kafka cluster, one of the brokers serves as the controller, which is responsible for managing the states of partitions and replicas and for performing administrative tasks like reassigning partitions. Parameter Description Kafka Controller Details Active Controller Number of active controllers in the cluster. Count Offline Partitions The number of unavailable partitions. Count Leader Election The rate of leader elections. (When a partition leader dies, an election for a new leader is triggered.) Rate Unclean The rate of Unclean Leader Elections. (Unclean leader elections are caused by the inability to find a Leader qualified partition leader among Kafka brokers. When a broker that is the leader for a partition goes Election offline, a new leader is elected from the set of ISRs for the partition. An unclean leader election is a Rate special case in which no available replicas are in sync) Broker Details Parameter Description Log Details Log Flush Rate The asynchronous disk log flush rate.Broker Topic Metrics Bytes In / Min The aggregate incoming byte rate (amount of data written to topic on this broker) per minute. Bytes Out / Min The aggregate outgoing byte rate per minute. Bytes Rejected The amount of data in messages rejected by broker per minute. / Min Failed Fetch The number of data read requests from consumers that brokers failed to process for this topic Requests / Min per minute. Failed Produce The number of requests from producer that have failed. Requests / Min Messages In / The number of Messages that comes into the Kafka broker. Min Replication Manager The number of "in-sync" replica expansions. (If a broker goes down, ISR for some of the IsrExpands / partitions will shrink. When that broker is up again, ISR will be expanded once the replicas are Min fully caught up). The number of "in-sync" replica shrinks. (If a broker goes down, ISR for some of the partitions IsrShrinks / Min will shrink. When that broker is up again, ISR will be expanded once the replicas are fully caught up) . Leader Count The number of partitions for which a particular host is the leader. Partition Count The number of partitions in the cluster. Under Replicated This indicates the number of partitions in the cluster are under-replicated. Partitions Request Handler Avg The average fraction of time the request handler threads are idle. Idle Percent Network Details Parameter Description Requests Process Rate Request Produce / Min The number of messages written to topic on this broker. The amount of data that the consumers fetched from this topic on this Request Fetch Consumer / Min broker. The requests from brokers that are the followers of a partition to get new Request Fetch Follower / Min data. Time Taken For Requests Total Time Produce / Min The total time to serve the specified request. The total time that the consumers fetched data from this topic on this Total Time Fetch Consumer / Min broker. The total time that is taken by the followers of a partition to get new Total Time Fetch Follower / Min data Network Processor Rate Network Processor Avg Idle Percent / The average free capacity of the network processors per minutes. Min Topics Details Parameter Description Topic Details Topic Name Specifies the name of the topic. The aggregate incoming byte rate (amount of data written to topic on this broker) Bytes in / Min per minute. Bytes Out / Min The aggregate outgoing byte rate per minute. Failed Fetch Requests / The total number of failed Fetch Requests per minute.Min Failed Produce Requests / The total number of failed producer requests. Min Messages In / Min The number of messages that comes into the Kafka broker. Configurations Parameter Description Storage Details Boot Class Path The boot class path that is used by the bootstrap class loader to search for class files. Class Path The Java class path that is used by the system class loader to search for class files. Spec Vendor The vendor of the JMX specification implemented by this product. Spec Version The version of the JMX specification implemented by this product. VM Name The Java virtual machine name. VM Vendor The Java virtual machine implementation vendor. Apache ActiveMQ Monitoring Apache ActiveMQ - An Overview Monitoring Apache ActiveMQ - What we do. Adding a new Apache ActiveMQ monitor Monitored Parameters Apache ActiveMQ - An Overview Apache ActiveMQ is a powerful open source message broker that supports JMS and a variety of Cross Language Clients and Protocols (from Java, C, C++, C#, Ruby, Perl, Python and PHP). ActiveMQ offers full support for the Enterprise Integration Patterns both in the JMS client and the Message Broker.  Monitoring Apache ActiveMQ - What we do. Applications Manager''s Apache ActiveMQ Monitoring aims to help administrators collect ActiveMQ metrics, correlate your queue and broker performance with your infrastructure, maintain configurations for high availability and scalability, and be alerted automatically of potential issues. Let’s take a look at what you need to see to fully utilize ActiveMQ  and the performance metrics that you can gather with Applications Manager: Resource utilization details - Automatically discover ActiveMQ servers, monitor memory and CPU and get alerts of changes in resource consumption. Topic and Queue Details - Automatically collect and visualize ActiveMQ queue data like memory usage, average message size, average enqueue time and broker metrics all in one place. Analyse topic details including memory consumed by each topic, average message size, blocked sends, health of each topic etc. and make informed decisions. Subscriber Statistics -  Monitor the most important subscriber metrics from the out-of-the-box ActiveMQ dashboard, including subscriber count and subscriber queue metrics. Correlate subscriber metrics with their respective topic metrics to diagnose issues. Fix Performance Problems Faster - Get instant notifications when there are performance issues with the components of Apache ActiveMQ. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Apache ActiveMQ - Adding a new monitor Prerequisites for setting up Apache ActiveMQ Monitoring: Apache ActiveMQ has extensive support for JMX to allow you to monitor and control the behavior of the broker via the JMX MBeans. You can enable/disable JMX support by following the steps mentioned here. Using the REST API to add a new Apache ActiveMQ monitor: Click here To create an Apache ActiveMQ monitor, follow the steps given below: Click on New Monitor link. Choose Apache ActiveMQ. Enter Display Name of the monitor. Enter the IP Address or hostname of the host in which Apache ActiveMQ Broker is running. Enter the JMX Port in the JMX Port field. Enter the credential details like user name and password  of Apache ActiveMQ Broker or select credentials from a Credential Manager list. Enter the JNDI path. For example:- JNDIPATH for default installations of Apache ActiveMQ Broker is /jmxrmi. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Apache ActiveMQ Server. Choose the Monitor Group from the combo box with which you want to associate Apache ActiveMQ Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Apache ActiveMQ from the network and starts monitoring. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Click here to know more about establishing Apache ActiveMQ Failover. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Apache ActiveMQ under the Middleware/Portal Table. Displayed is the Apache ActiveMQ bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Topic Details Queue Details Subscriber Details Configuration Overview Parameter Description RESOURCE USAGE DETAILS Memory Usage The memory usage, in bytes, used by undelivered messages. Store Usage   Temp Usage   MEMORY DETAILS Total Physical Memory Size The total amount of physical memory in Megabytes. Free Physical Memory Size The amount of free physical memory in Megabytes. The amount of virtual memory that is guaranteed to be available to the Committed Virtual Memory Size running process in Megabytes. Total Swap Space Size The total size of virtual memory hold by the JVM. Free Swap Space Size The free virtual memory size. THREAD DETAILS Daemon Thread Count The number of daemon threads currently running. The peak live thread count since the Java virtual machine started or peak Peak Thread Count was reset. Live Thread Count The number of live threads currently running. The total number of threads created and also started since the Java virtual Total Started Thread Count machine started.Heap and Non-Heap Memory Details Heap Memory Usage The heap memory currently in use. Non-Heap Memory Usage The non-heap memory currently in use. BROKER STATISTICS The total number of messages removed from the queue (acknowledged Total DeQueue Count by consumer) since last restart. Total Enqueue Count The total number of messages sent to the queue since the last restart. The total number of consumers that have consumed the messages posted Total Consumer Count by the producers The total number of producers that have posted messages to the Total Producer Count ActiveMQ instance The total number of messages in the queue, including the number of Total Message Count  enqueued and dequeued messages.  Current Connection Count Number of connections that are currently active. The total number of connections (Both the producer and consumer have to Total Connection Count connect to the ActiveMQ instance for posting and consuming messages respectively).  Job Scheduler Store The percentage of job store limit used. Topic Details Parameter Description Topic Details Name   Memory Usage (%)   The number of messages in the destination which are yet to be consumed Queue Size (potentially dispatched but unacknowledged). Average Message Size The average message size on this destination. Blocked Sends  The number of messages blocked for Flow Control. Average Blocked Time The average time (ms) messages are blocked for Flow Control. Topic Count Details The total number of producers that have posted messages to the ActiveMQ Producer instance The total number of consumers that have consumed the messages posted Consumer Count by the producers. The number of messages sent to a consumer session and have not received In Flight Count an acknowledgement. Enqueue Count The total number of messages sent to the queue since the last restart. The total number of messages sent to consumer sessions (Dequeue + Dispatch Count Inflight). The total number of messages removed from the queue (acknowledged by Dequeue Count consumer) since last restart. The number of messages that were not delivered because they were Expired Count  expired. Queue Details Parameter Description Queue Details Memory Usage The memory usage, in bytes, used by undelivered messages. Cursor Usage The message cursor memory usage, in bytes. Average Message Size The average message size on this destination.Parameter Description Average Enqueue Time The average time a message has been held this destination. Average Blocked Time The average time (ms) a message is blocked for Flow Control. Cache Enabled Specifies if caching is enabled. The interval between warnings issued when a producer is blocked from Blocked Producer Warning Interval adding messages to the destination. Queue Count Details Enqueue Count The total number of messages sent to the queue since the last restart. The total number of messages sent to consumer sessions (Dequeue + Dispatch Count Inflight). The total number of messages removed from the queue (acknowledged by Dequeue Count consumer) since last restart. The number of messages that were not delivered because they were Expired Count   expired. Subscriber Details Parameter Description Subscriber Details Destination Name Name of the destination. Cursor Usage The message cursor memory usage, in bytes. Maximum Pending Messages The maximum number of pending messages allowed. Messages Awaiting The number of messages dispatched to the client and are awaiting Acknowledgement acknowledgement. Pending Queue Size The number of messages pending delivery. Enqueue Counter Counts the number of messages that matched the subscription. Counts the number of messages were sent to and acknowledge by the Dequeue Counter   client. Configuration Parameter Description Configuration Details Broker Version The version of the broker. Broker ID The unique id of the broker. Broker Name The name of the broker. Average Message Size The average message size on this destination. The disk limit, in bytes, used for scheduled messages before producers Job Scheduler Store Limit are blocked. Maximum Message Size The maximum message size on this destination. The memory limit, in bytes, used for holding undelivered messages Memory Limit before paging to temporary storage. Minimum Message Size The minimum message size on this destination. Store Limit  The percent of store limit used. Server Monitoring Overview In network-level management, maintaining the status and connectivity of the network is a picture at a higher level. It is of prime importance to know the status of the machines in the network, how loaded (or overloaded) they are and how efficiently they are utilized (or overused) to enable necessary corrective administrative functions to be performed on the identified overloaded/poorly performing systems. Server-level management is a down-to-earth concept which involves a lot of manual intervention, human resources, and administrative tasks to be performed.Applications Manager provides a server-level monitoring functionality to achieve such goals and to ease the process of configuration management of hosts. Supported Operating Systems Windows Linux Sun Solaris IBM AIX (Page Space Details) IBM AS400/iSeries HP Unix Tru64 Unix FreeBSD Mac OS Novell Creating a new server monitor To create any of the above server monitors, follow the steps given below: Go to New Monitor and click Add New Monitor. Choose the required server under Servers section. Enter the IP Address or hostname of the host. Enter the subnet mask of the network. Select the Mode of Monitoring. (WMI/SNMP/SSH/TELNET) Enter the credential details like username and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential List option. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Provide the monitor specific authentication information: Choose the OS type Windows ((2000, 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2, XP, NT, Vista, 7, 8 and 10), Linux, Sun OS, IBM AIX, IBM AS400 / iSeries, HP Unix, Tru64 Unix, FreeBSD, Mac OS, Novell, Windows Clusters 2008, 2008 R2) . Based on the type of OS, the ''Mode of Monitoring'' information changes. Choose the Monitor Group from the combo box with which you want to associate the server monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the required server from the network and starts monitoring them. Note: You can diagnose issues that occur while adding a server monitor whenever any input details are wrongly entered. By clicking the Diagnose the Problem link, you will be able to view various information associated with the server such as Ping test, host details, monitoring modes along with the list of tables having stray entries of the same host. However, this is not applicable for WMI monitoring mode. Monitored Parameters Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed to view the following information. Parameters Description System Specifies the number of jobs handled by the system in 1/ 5/ 15 minutes with its peak and current Load value, and current status. Specifies the hard disk space utilized by the system and updates with the peak and current value, Disk and current status of the Disk Partition parameter.(The parameter includes C, D, E, F drives, etc. in Utilization windows, /home, etc. in Linux.) Swap Memory Utilization: Specifies the swap space or the virtual memory utilized by the Memory system with peak and current value, and current status of the parameter. Utilization Physical Memory Utilization: Specifies the amount of physical memory utilized by the system with peak and current value, and current status of the parameter. Disk I/O Specifies read/writes per second, transfers per second, for each device. StatsCPU Specifies the total CPU used by the system with its peak and current value, and current status. Utilization   Note: Option is provided for ignoring the monitoring of a specific disk drive in a server. Open file in and add the drive that you do not want to monitor to . For eg., # The drives beginning with the characters given below will not be monitored in the server monitor. am.disks.ignore=C: Here, monitoring will not happen for C: drive. Likewise, you can add further disks comma-separated(C;D:/home). The following table briefs the parameters monitored & the mode of monitoring ( - yes).   Note: If the server monitor is added in Telnet & SSH mode, you have the option to directly access Telnet client by clicking on the ''Execute Commands on this server'' link found below Today''s Availability pie chart. This option is disabled by default. To enable it, permissions need to be given to the admin or operator to use this telnet client. The permissions can be given from Admin tab->User Administration -->Permissions link.   Operating System Telnet SSH SNMP WMI (only if Applications Windows     Manager is installed on a Windows machine) Linux   Solaris   HP-UX / Tru64 Unix     FreeBSD   Mac OS   IBM AIX     Novell       Attributes         CPU Utilization (all types except Windows NT) Disk Utilization (all types) Physical Memory Utilization (IBM AIX -only for the root user, Windows - WMI mode, all other types) Swap Memory Utilization (IBM AIX - only for the root user, FreeBSD, Linux, Solaris, Windows, Novell) Computational Memory Utilization (IBM AIX) [status attribute data is Network Interface (all types)     not available] Connection Stats (IBM AIX) NTP Stats (IBM AIX and Linux)     Process Monitoring (all types)Process Monitoring - Memory Utilization (all types) Process Monitoring - CPU Utilization (IBM AIX - FreeBSD,   Linux, Mac OS, Solaris, HP Unix / Tru64) Process Monitoring - Zombie Process Count (IBM AIX and     Linux) Service Monitoring (only for       Windows ) Event log (only for Windows )       System Load ( IBM AIX, FreeBSD, Linux, Mac OS, HP-Unix, Solaris,   Novell ) Disk I/O Stats (only for IBM AIX,     Linux, Solaris, Novell) Hardware monitoring ( Dell & HP)       Server Uptime ( IBM AIX, FreeBSD, Linux, Mac OS, HP- Unix, Solaris, Novell, Windows ) Firewall monitoring ( Only for       Windows ) Note: To know more about the configuration details required while discovering the host resource, click here. Avg. Queue Length in Disk I/O Statistics for AIX is not supported When it comes to choosing the mode of monitoring for servers, we recommend Telnet/SSH over SNMP. Page Space in AIX Servers: To get in-depth details on Page Space in AIX servers, you can use the following command "lsps -a". The command "lspa -a" lists the location of the paging space logical volumes as they were, not as they are. Normally page spaces are used when the process running in the system has used the entire allocated memory and it has run out of memory space. It then uses the page spaces in the system to move the piece of code/data that is not currently referenced by the running process into the page space area so that it could be moved back to the Primary memory when it is been referenced again by the currently running process. While trying to monitor the AIX server, if you get "No data available" for Page Space, you can troubleshoot it by following the steps given below: First, you need to establish a connection only through TELNET or SSH mode. Second, check whether the command lsps -a exists in the system and then execute it. Note: Avg. Queue Length in Disk I/O Statistics for AIX is not supported Displaying Paging Space Characteristics The "lsps" command displays the characteristics of paging spaces, such as the paging space name, physical volume name, volume group name, size, percentage of the paging space used, whether space is active or inactive, and whether the paging space is set to automatic. The paging space parameter specifies the paging space whose characteristics are to be shown. The following examples show the use of lsps command with various flags to obtain the paging space information. The "-c" flag will display the information in colon format and paging space size in physical partitions. # lsps -a Page Space Physical Volume Volume Group Size %Used Active Auto Type paging00 hdisk1 rootvg 80MB 1 yes yes lvhd6 hdisk1 rootvg 256MB 1 yes yes lv Adding and Activating a Paging Space To make a paging space available to the operating system, you must add the paging space and then make it available. The total space available to the system for paging is the sum of the sizes of all active paging-space logical volumes. Note: You should not add paging space to volume groups on portable disks because removing a disk with an active paging space will cause the system to crash. You can get more details about the command here: https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/devicemanagement/pscpag_space_config.html Apart from the above-mentioned parameters, you can also monitor the following: Processes Windows Services Network Interface To monitor processes in a server In the Server Monitor page under Process Details, click Add New Process. All the processes that are running would be displayed along with CPU and Memory utilization statistics. (Only memory statistics is shown for Windows and SNMP mode of monitoring) Select the processes that you want to monitor. After configuring the processes, they are listed under the Process Details section of the Server Monitor page. By clicking on the process, you can view its availability graph. You can also configure alarms for a particular process. You can edit the Display Name, Process Name, Commands and Arguments of the particular process by clicking on the Edit Process icon. To monitor windows services In the Windows Monitor page, under Service Details, click Add New Service All the services that are running would be displayed along with service name and status. Select the services that you want to monitor. After configuring the services, they are listed under the Service Details section of the Windows Monitor page. By clicking on the service, you can view its availability graph. You can also configure alarms for the availability of that particular service. Apart from monitoring the availability of the service, you can manage the services by using the start, stop, restart options. When the service goes down, you can configure action "Restart the Service " along with other actions. Note: Windows Services monitoring is possible only in WMI mode of monitoring To monitor Network Interfaces In the Server Monitor page, under Network Interfaces, all the network interfaces will be listed. The various attributes that can be monitored are: Interface Traffic - Input traffic (bits received), Output Traffic (bits transmitted). You can set alarm thresholds for these attributes. Interface utilization - Input Utilization %, Output Utilization %. You can set alarm thresholds for these attributes. Packets received - Packets received per second Packets transmitted - Packets transmitted per second Error packets - No. of packets in error per second after receiving the packets Discarded packets - No. of packets discarded per second after receiving the packets Health - the health of the interface based on the attributes Status - whether the interface is up or down (shown only in SNMP mode of monitoring) Note: Network Interface monitoring is possible only in SNMP and WMI mode of monitoring Associating Scripts and URLs to the Host ResourceBy associating a script or a URL to a Host resource, their attributes become one among the other attributes of the Host and their data is also shown under Host Details itself. The health of the Host resource is dependent on the Health of the Scripts and URLs as well. For eg., If you wish to monitor RequestExecutionTime, RequestsCurrent, RequestsDisconnected of the ASP.NET application, WMI scripts can be used to get the statistics (this info is not available when Applications Manager is used). You can write your own script that would fetch these details then configure this script to the Applications Manager. After configuring this script to the Applications Manager you can associate this script to the host monitor itself. Then the attributes of the script would behave like the other attributes of the Host monitor. Hence, you can configure in such a way that the Health of the script directly affects the health of the host. Likewise, If you want to monitor a website hosted in a system in such a way that, whenever there is a change in the health of the website, the health of the server should reflect the change. In this case, you can configure the URL monitor and then associate that URL to the host. Hence, if the website is down, the health of the Host resource is affected. Associate/Remove Scripts: Click on the ''Associate/Remove Scripts'' link in Host Details. Scripts that are associated and that are not associated with the Host would be listed. Accordingly, you can then select the scripts that you want to associate or remove. Associate/Remove URLs: Click on the ''Associate/Remove URLs'' link in Host Details. URLs that are associated and that are not associated with the Host would be listed. Accordingly, you can then select the URLs that you want to associate or remove. Mode of Monitoring - SSH/Telnet vs SNMP We recommend Telnet or SSH mode of monitoring because the following attributes are not available through SNMP: Disk I/O Stats Process Monitoring - CPU Utilization Swap Memory Utilization Please check this link for more details. System administrators generally prefer to check system resources with commands and will prefer to compare it with the SSH/telnet mode output, rather than running SNMP walk to compare. Also, having the connection to the Linux boxes over SSH will make it easier for you to configure the same for script monitors or ''execute program'' actions if required. Commands used for server monitoring Here is a list of commands used by Applications Manager for both Windows, Linux and Unix Servers: Windows: Parameter Command Disk Utilization “disk.vbs” Win Physical Disk Stats "diskio.vbs" Network Interface "NetworkInterface.vbs" Network Adapter "NetworkAdapter.vbs" Memory Utilization "memory.vbs" CPU Utilization "cpu.vbs" CPU Core Utilization "cpucore.vbs" Services "services.vbs" Process "PhyMemCpuImportProduct.vbs" Server Uptime "uptime.vbs" Linux: Parameter CommandParameter Command Memory "free -b" Utilization System reboot "date +%s;/bin/cat /proc/uptime | cut -d "." -f1" ThreadCount "ps -eo nlwp | awk ''{ threadcount += $1 } END { print threadcount }''" "/bin/df -Pm |awk ''{print $(NF-3) " " $(NF-2) " " $(NF-1) " Disk Utilization " $NF}''" Disk IO Stats "LANG=C iostat -d;echo ''-----DISK_EXTENDED_STATS-----'';iostat -d -x 1 3" System Load "uptime" CPU Utilization "/usr/bin/vmstat 1 3" CPU Core "mpstat -P ALL 1 3" Utilization Server Uptime "uptime|cut -d '','' -f1,2|tr -s '' '' ''^''|cut -d ''^'' -f 2-" Unix: Parameter Command Memory Utilization "export UNIX95;top -d 1 -n 2" Disk Utilization "/bin/df -m" System Load "uptime" CPU Utilization "/usr/bin/vmstat 1 3" CPU Core Utilization "/usr/bin/vmstat -n 0 -P 1 3" Server Uptime "uptime|cut -d '','' -f1,2|tr -s '' '' ''^''|cut -d ''^'' -f 2-"   Note: 1.) For Windows Open command prompt as administrator, execute the commands under App Manager Home/ working/ conf/ applications/ scripts directory and execute in the following format: cscript command hostname domain\username password Replace the command with the command specified above respectively, the hostname with the actual hostname of the server and username and password with the credentials. 2.) Also the command for CPU Utilization for Windows 2008 and Windows 2000 alone changes as "cpu_2008.vbs" and "cpu_2000.vbs" respectively. Windows Server Monitoring Creating a new Windows monitor Supported Versions: Windows XP, NT, Vista, 7, 8, 10, 11 and Windows Servers 2000, 2003, 2008, 2012, 2016, 2019, 2022 Prerequisites for monitoring Windows server metrics: Click here Using the REST API to add a new Windows server monitor: Click here To create a new Windows server monitor, follow the steps given below: Go to New Monitor and select Add New Monitor. Under Servers, select Windows server. Enter the IP Address or Hostname of the host. Enter the Subnet Mask of the network. Select the OS Type to be monitored. Select the Mode of Monitoring (SNMP or WMI). If SNMP, provide the Port at which it is running (default is 161) and the SNMP Community String (default is ''public''). This requires no user name and password information.If WMI, provide the user name and password information of the server. Select the Enable Event Log Monitoring checkbox, if you want to monitor Windows Event Logs. Kindly refer Windows Event Log Rules under Admin Activities section for more information. This section deals with the performance metrics displayed for Windows servers. Select the Enable Kerberos Authentication checkbox, if you want to monitor Windows server through Kerberos authentication. However, this is applicable only in WMI mode of monitoring. Choose the Monitor Group from the combo box with which you want to associate the Windows server monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Windows server from the network and starts monitoring them. Note: For WMI Mode of Monitoring: In Windows Server 2008 and later versions, and in Windows Vista and later versions, use the following dynamic port range: Start port: 49152 End port: 65535 If your computer network environment uses only Windows Server 2012, Windows Server 2008 R2, Windows Server 2008, Windows 8, Windows 7, or Windows Vista, you must enable connectivity over the high port range of 49152 through 65535. Windows 2000, Windows XP, and Windows Server 2003 use the following dynamic port range: Start port: 1025 End port: 5000 If your computer network environment uses Windows Server 2012, Windows Server 2008 R2, Windows Server 2008, Windows 8, Windows 7, or Windows Vista together with versions of Windows earlier than Windows Server 2008 and Windows Vista, you must enable connectivity over both the following port ranges: High port range: 49152 through 65535 Low port range: 1025 through 5000 Limitation: Adding a Windows Monitor containing a password with double quotes is not supported. If Kerberos authentication is enabled, then Scheduled Task Monitoring will not be supported. Monitored Parameters Applications Manager monitors the critical components of Windows servers to detect any performance problems. These components include CPU, memory, disk, network traffic, etc. Availability tab shows the availability history of the Windows server for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the Windows server such as physical memory utilization, CPU utilization, response time and swap memory utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. List view tab lists all the Windows servers monitored by Applications Manager along with their overall availability and health status. It enables you to perform bulk admin configurations. Click on the individual monitors listed to view detailed performance metrics. The list view also shows the virtual machines (Windows guest OS) configured in your data center along with their availability and health status. Applications Manager''s Windows server monitoring allows you to view the detailed performance metrics of a Windows server, which are categorized into 9 different tabs: Overview Page Memory Usage Statistics Process Details Service Details CPU DiskNetwork Network Interfaces Network Adapters Firewall Details Event Log (only supported in WMI mode) Hardware NLB Configuration Scheduled Tasks (only supported in WMI mode) Overview This tab provides a high-level overview of the health and performance of the Windows server along with information pertaining to the processes and services running on the system. Monitor Information Parameters Description Name The name of the Windows server monitor. System Denotes the health status of the Windows server. (Critical, Warning, and Clear) Health Type Denotes the type you are monitoring. Host Name The hostname of the Windows system. Host OS The main OS installed on the system. Last Polled Specifies the time at which the last poll was performed. at Next Poll at Specifies the time at which the next poll is scheduled. Today''s Shows the overall availability status of the server for the day. You can also view 7/30 reports and the Availability current availability status of the server. Response Amount of time taken by the server to respond (in ms). Time Server Indicates the server uptime of the Windows monitor. Uptime Current date and time of the Windows server with its timezone. (Applicable only in WMI mode of Server Time monitoring) Time Time difference between the monitoring server time and the Applications Manager''s server time (in Difference minutes). (Applicable only in WMI mode of monitoring) You can use the Custom Fields option in the ''Monitor Information'' section to configure additional fields for the monitor. The CPU and memory utilization - last six hours graph shows the memory usage and CPU usage values for the last six hours. The attributes shown here are Swap Memory Utilization (in % and MB), Physical Memory Utilization (in % and MB), Free Physical Memory (MB), and CPU Utilization (%). The Breakup of CPU Utilization graph provides a break up of metrics for the entire system processor with attributes such as Run Queue, User Time (%), System Time (%), I/O Wait Time (%), Idle Time (%) and Interrupts/sec. Page Memory Usage Statistics This section shows information about the page memory usage statistics in Windows servers. The Page Memory Usage Statistics table displays the following attributes: Description Monitoring Parameter Mode SNMP WMI The number of pages that are read from or written to the disk to resolve PagesPerSec hard page faults PageWritesPerSec The number of times the pages were written to the disk to free up spacein physical memory. The number of times the pages were read from the disk to resolve hard PageReadsPerSec page faults. The number of pages that are read from the disk to resolve hard page PagesInputPerSec faults. The number of pages that are written to the disk to free up space in PagesOutputPerSec physical memory   Note: Minimum supported server = Windows Server 2003, Windows XP   Process Details This tab shows information about the required processes running in the Windows server. You can add the required processes for monitoring using the Add New Process option. You can also delete unwanted processes and enable/disable reports for specific processes. You can click on any of the attributes listed to view detailed performance stats of that process. The Process Details tab displays the following attributes: Description Monitoring Mode Parameter SNMP WMI Name The display name of the process. Process The name of the process running. No of Instances The number of instances running for the process. CPU(%) The CPU utilization of the process (in percentage). Mem(%) The memory consumption of the process (in percentage). Handles The handle count of the process.   Service Details This tab shows the availability of the required services running in the Windows server. You can add the required services for monitoring using the Add New Service option. You can also stop, start, restart and delete services from within Applications Manager itself. The Service Details tab displays the following attributes: Monitoring Mode Parameter Description SNMP WMI Display Name The display name of the service. Service Name The name of the service running. Availability The availability of the service running. The Monitors in this System section shows the availability and health of the monitors configured in this server. The attributes shown here are Name, Type, Health, and Availability. To add new monitors for monitoring, use the Add Monitors option. CPU This tab provides the CPU usage statistics of the Windows server. The tab includes two graphs - one that displays the CPU utilization by CPU Cores and another that shows the Breakup of CPU utilization - by CPU cores. You can view additional reports by clicking the graphs present in the Breakup of CPU Utilization - by CPU cores section. These reports include Break up of CPU Utilization (%) Vs Time, User Time (%) Vs Time, System Time (%) Vs Time, I/O Wait Time (%) Vs Time, Idle Time (%) Vs Time, CPU Utilization (%) Vs Time and Interrupts/sec Vs Time for all the CPU cores.   The CPU tab also shows the following performance metrics: Description Monitoring Mode ParameterSNMP WMI Core The name of the CPU core. The percentage of time that the processor spends on User mode User Time(%) operations. This generally means application code. System The percentage of CPU kernel processes that are in use. Time(%) I/O Wait The time spent by the processor to waiting for I/O to complete. Time(%) Idle Time(%) The time when the CPU is idle (not being used by any program). CPU Specifies the total CPU used by the system. Utilization(%) The rate at which CPU handles interrupts from applications or hardware Interrupts/sec each second. If the value for Interrupts/sec is high over a sustained period of time, there could be hardware issues. You can also view graphs for these attributes by selecting the necessary CPU core and then choosing the appropriate attribute. Disk This tab displays the disk usage and disk I/O statistics of the Windows server. Disk Utilization Parameters Description Disk The name of the disk drive. Denotes how much disk space out of the total disk space has actually been Used(%) used (in percentage). Used(MB) The disk space used (in megabytes). The percentage of total usable space on the disk that was free (in Free(%) percentage). Free(MB) The unallocated space on the disk in megabytes (in megabytes).   Disk I/O Statistics Description Monitoring Mode Parameter SNMP WMI Transfers/sec Rate of read and write operations on the disk. Writes/sec Rate of write operations on the disk. Reads/sec Rate of read operations on the disk. % Busy Time The percentage of time the disk was busy. Average Queue The average number of both read and write requests that were queued Length for the disk during the sample interval. Note: You can also delete disks that have been physically removed using the Delete Orphaned Disk option. Network Network Interface This table shows details about Network Interfaces. Parameters Description Name The name of the network interface present in the Windows system. Speed (Mbps) Current bandwidth of the network interface (in Mbps). Input Traffic The rate at which packets are received on the interface (in Kbps). (Kbps)Parameters Description Output Traffic The rate at which packets are sent on the interface (in Kbps). (Kbps) Errors The number of packets that could not be sent or received. Note: You can also delete interfaces that have been physically removed using the Delete Orphaned Interface option. Network Adapter This table shows details about Network Adapters. Parameters Description Name The name of the network adapter present in the Windows system. Status The connection status of the network adapter connected to the network. Net Enabled The status of the network adapter.   Note: Network Adapters monitoring option is only supported in WMI mode. By default, Network Adapter monitoring is disabled. To enable it, Go to Admin tab -> Performance Polling ->Server tab -> Check Enable Network Adapter Monitoring If an adapter is removed, the alarm will be raised automatically for adapter removal. By default, an alarm is enabled. The setting can be changed from: Admin tab -> Performance Polling ->Server tab -> Alert if Network Adapter is removed You can also delete adapters that are removed by using the Delete Orphaned Adapters option. Firewall Details This table shows details about the firewall status. Parameters Description Firewall Profile The name of the network profile. Status Firewall status of the network profile.   Note: Supported servers = Windows 8, Windows Server 2012 and above. Available only in WMI mode of monitoring. Event Log This tab shows information pertaining to the recent Windows events. Parameters Description Rule Name The name of the event log rule. Log File Type The type of the Windows event log file. Source The source that generated the event. Event Id The identifier of the event. Type The type of event. User name of the logged-on user when the event occurred. If the user name cannot be User Name determined, this will be None. Description Description of the event. Generated The time when the event was generated. Time Hardware Metrics The following are metrics pertaining to the hardware of Dell and HP servers:Category Attribute Description DELL HP SNMP WMI SNMP WMI Mode Mode Mode Mode The name of the Sensor temperature sensor. Temperature The current /present Temperature Reading (deg C) temperature reading. The temperature status - Status Critical, Warning, and Clear. Sensor Name of the fan sensor. The fan speed values Fan Speed (RPM) Fan displayed in RPM. The fan status - Critical, Status Warning, and Clear. Name of the power Sensor supply. The power supply reading Reading (Watts) Power values displayed in Watts. The power status - Status Critical, Warning, and Clear. Name of the voltage Sensor supply. The voltage reading Reading (Volts) Voltages values displayed in Volts. The voltage status - Status Critical, Warning, and Clear. Name of the Battery Sensor sensor. Battery The battery status - Status Critical, Warning, and Clear. Name of the Memory Sensor sensor. Memory Device The type of memory Type device. Memory The amount of memory Size (MB) currently installed in MB. The memory status - Status Critical, Warning, and Clear. Sensor Identifies the disk''s label. The device name Device Name configured for the disk. Disk Size (MB) The allocated size in MB. The disk status - Critical, Status Warning, and Clear. Array The name of the array Sensor disk. The bus type of the array Bus protocol disk. The amount in MB of the Size (MB) used space on the array disk.Status The array status - Critical, Warning, and Clear. The user-assigned Sensor chassis name of the chassis. The system model type Chassis Model for this chassis. The chassis status - Status Critical, Warning, and Clear. The location name of the Sensor processor device status probe. The brand of the Processor Brand processor device. Processor Current The current speed of the Processor Speed processor device in MHz. The number of processor Processor Core cores detected for the Count processor device. The processor status - Status Critical, Warning, and Clear. If a component is functioning normally, the status indicator is green. The status indicator changes to orange or red if a system component violates a performance threshold or is not functioning properly. Generally, an orange indicator signifies degraded performance. A red indicator signifies that a component stopped operating or exceeded the highest threshold. If the status is blank, then the health monitoring service cannot determine the status of the component. Note: Currently, hardware performance monitoring is supported in SNMP and WMI monitoring mode. Hardware Device-Level Configuration Hardware Configuration option available under Host Details on the right-hand side of the details page will allow you to opt for the various hardware components you want to monitor. This operation can also be done using the Performance Polling option under the Admin tab which will globally configure the hardware stats. Advanced Settings By clicking the Advanced Settings option available under Host Details on the right-hand side of the details page, you can go to the Performance Data Collection page for Servers. Here you can use the Hardware Health monitoring option to enable or disable hardware monitoring in servers. You can also opt the various hardware components (like power, fan, disk,etc.,) to be monitored by checking the options given. This will globally configure the hardware monitoring status. You can also configure the health status by defining values in the respective text boxes: Critical Severity: If the status matches with any of the values defined in the Critical Severity text box, then Applications Manager displays the status of the hardware device as Critical. The values defined by default are failed, error, failure, nonRecoverable, criticalUpper, criticalLower, nonRecoverableLower and critical. Warning Severity: If the status matches with any of the values defined in the Warning Severity text box, then Applications Manager displays the status of the hardware device as Warning. The values defined by default are degraded, warning, nonCritical, nonCriticalUpper, nonRecoverableUpper and nonCriticalLower. Clear Severity: If the status matches with any of the values defined in the Clear Severity text box, then Applications Manager displays the status of the hardware device is Clear. The value defined by default is ''ok''.Note If the status of the device does not match with any of the values defined in the severity text box, the device status is displayed as unknown. Status values defined within the severity text boxes are comma-separated and case-insensitive. NLB This tab displays the Network Load Balancing (NLB) information of the Windows server. Node Information Monitoring Mode Parameter Description SNMP WMI Node State The current state of the node. Dedicated IP The dedicated IP address of the node. Subnet Mask Subnet mask for the dedicated IP address. Node Priority Indicates the priority assigned to the node. No. of Port The number of defined port rules for the node. Rules Cluster Information Monitoring Mode Parameter Description SNMP WMI Cluster Name The name of the NLB cluster. IP Address The primary IP address of the cluster. MAC Address The Media Access Control (MAC) address of the cluster. The Globally Unique Identifier (GUID) of the adapter to which NLB is GUID bound. No. of Nodes The total number of nodes available in the cluster. Other Nodes in the Cluster Monitoring Mode Parameter Description SNMP WMI Priority Indicates the priority assigned to the node. Dedicated IP The dedicated IP address of the node. Display name of the node in the form of a Fully Qualified Domain Name Display Name (FQDN).   Note: Minimum supported server = Windows Server 2008 NLB should be enabled and configured in the corresponding server. Configuration This tab contains information about system configuration attributes. Parameters Description SYSTEM INFORMATION Host Name The name of the system. Manufacturer The name of the machine manufacturer. Model The Product name that a manufacturer gives to the computer. Domain The name of the domain to which the system belongs. BIOS Version The current BIOS version that is running on the motherboard of the system.Parameters Description OS INFORMATION OS Name The name of the operating system instance. OS Version The version number of the operating system. The latest service pack installed on the computer. If no service pack is installed, the value will OS Release be ''-'' Name of the operating system manufacturer. For Windows-based systems, this value is Manufacturer "Microsoft Corporation". OS Installed The date the OS was installed on the system. Date Registered User Name of the registered user of the operating system. Windows Windows directory of the operating system. Directory OS Language Language version of the operating system installed. MEMORY INFORMATION Total Physical The total amount of physical memory as available to the operating system. Memory (MB) Total Virtual The total amount of area on the hard disk that Windows uses as if it were RAM. Memory (MB) PROCESSOR INFORMATION Id Unique identifier of a processor on the system. Model The processor model type Implementation The processor family type. Manufacturer Name of the processor manufacturer. Speed(MHz) The current speed of the processor. Size of the processor cache. A cache is an external memory area that has a faster access time Cache (KB) than the main memory. NETWORK INTERFACE SETTINGS Name The name of the network adapter. IP Address The IP address configured for this network interface. Type The network medium in use. The Media access control address for this network adapter. A MAC address is a unique 48-bit Mac Address number assigned to the network adapter by the manufacturer. It uniquely identifies this network adapter and is used for mapping TCP/IP network communications. Manufacturer The name of the network adapter''s manufacturer. Status The current status of the network adapter. PRINTER SETTINGS Name Name of the printer Name of the server that controls the printer. If this value is not shown, it means the printer is Server controlled locally. Type Denotes whether the printer is controlled locally or remotely. Default Indicates whether the printer is the default one. Values are either True or False. Status Current status of the printer. Location The physical location of the printer. Scheduled Tasks Prerequisites: WMI access to a remote server. Administrator user credentials. The following are the metrics pertaining to Scheduled Tasks:Parameters Description Task Name Name of the scheduled task. Enabled Displays if the task is enabled or not. Last Run Time The timestamp of when the task ran for the last time. Last Run Result The outcome of the last run of the task. Next Run Time The timestamp of when the task will run again. Missed Runs The number of times the task missed its scheduled execution. Status Current status of the task. You can perform the following actions on the required task(s): Delete Task(s): Deletes the selected task(s) from Applications Manager. Clear Alarm(s) for Last Run Result: Clears the alarm associated with the ''Last Run Result'' attribute for the selected task(s). Scheduled Tasks Monitoring is not supported for Windows servers 2003, 2008 or Windows XP. Note: It works only for WMI mode. User can add a scheduled task by clicking ''Add Scheduled Task''. A scheduled task can be deleted by clicking ''Delete Task(s)''. If a scheduled task is deleted, then an alarm will be raised automatically depending on the setting in Admin → Performance Polling → Servers → Alert if any Scheduled Task is removed (by default, value is true). Applications Manager should be running with administrator privileges, else some tasks may not get fetched for monitoring. An Alarm will only be raised (after the threshold is checked) if the current target server time exceeds the next run time for the task although, for ''Enabled'' attribute, the threshold is checked in each poll (since its value can be changed anytime). Windows Cluster Monitoring Follow the steps given below to create a new Windows Cluster monitor in Applications Manager: Click on New Monitor link. Select Windows Cluster under the Servers category. Specify the Display Name of the Windows Cluster. Enter the Cluster Name or the IP Address of the cluster Select the Version of the Windows Server from the drop-down menu. You can either use your Cluster Domain Administrator username and password, or select credentials from the Credential Manager drop-down menu. To use your Cluster Domain Administrator credentials, make sure the user account has permission to excute WMI queries on ''root\mscluster'' namespace in cluster server nodes. Select the Node Discovery option. The available options are Do not Discover Nodes and Discover and Monitor Nodes Do not Discover Nodes - Selecting this option will not discover the cluster server nodes as a Windows Server. If the node already added as windows server, it will be associated internally for collecting the event logs specific to cluster. Discover and Monitor Nodes - Selecting this option will discover the cluster server nodes as a Windows Server and monitor availability and performance. If the node already added as windows server , it will not be discovered again and the existing server will be associated internally for collecting the event logs specific to cluster. Select the Enable Event Log Monitoring option: Checked - This will enable the eventlog monitoring in all the cluster server nodes. The events generated from the configured eventlog rules will be propagated to cluster. During the eventlog collection of servers, it will collect the events for cluster as well and add them to database without generating the alert. Then,during the data collection of cluster, it will take the cluster events from database from all the nodes and then generate the alert for the configured Eventlog rule. Unchecked - This will disable the eventlog monitoring in the Cluster. Cluster Add : While adding the cluster, selecting this option will not enable eventlog monitoring in the nodes discovered. If a node already exists, this option will leave the current event log status in the server as it is. Cluster Update : If this option is selected while updating the cluster, it will disable event log monitoring in the all the servers & cluster. Also it will clear the eventlog related Alarms and Events from database for all the servers & cluster. Hence use this option only when it is necessary. Enter the polling interval time in minutes. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). Click Add Monitor(s). Monitored Parameters Applications Manager''s Windows Cluster monitoring capability includes monitoring of the cluster details, the cluster nodes, resource groups, cluster performance, networks, disk utilization and storage stats. You can also monitor the cluster events by configuring the Event log Rules.   The monitoring details of Windows Cluster are represented graphically that helps to understand the parameters with ease. You can also configure thresholds to the attributes monitored and in case of threshold violation you can get notified on this by associating Actions. This will also help, to get notified on the failover happened in the Cluster.   Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information.   The Windows Cluster attributes monitored are classified under the following tabs in Applications Manager: Overview Performance Networks Storage Resource Groups Events Overview Parameter Description CLUSTER DETAILS Cluster Name/IP Address The name/IP Address of the cluster. Quorum Owner Node The node name, which currently owns the Quorum Resource. Quorum Path The path to the quorum files. The current quorum type. The following are the possible values: InputObject Cluster Quorum Type DiskOnly NodeAndDiskMajority NodeAndFileShareMajority NodeMajorityNumber of Nodes The total number of nodes in a cluster. Max Nodes The maximum number of nodes that can participate in a cluster. Number of Networks The number of networks used by the server cluster for communication. Resources Online  The count of resources that are currently online. Resources Offline  The count of resources that are currently offline. Resource Groups Online  The count resource groups that are currently online. Resource Groups Offline  The count resource groups that are currently offline. Disks in Use The number of disks currently in use in the cluster. Number of Nodes The total number of nodes in cluster. DISK UTILIZATION Disk Used Percentage The total percentage of used disk space in a Cluster. Disk Free Percentage The total percentage of free disk space in a Cluster. Disk Size The total size of disk space, in megabytes. Disk Used The total used space in the disk, in megabytes. Disk Free The total free space available in the disk, in megabytes. NODES Node Name Specifies the label by which the node is known. Specifies the current state of a node. Node states can be: Up - The node is physically plugged in, turned on, booted, and capable of executing programs. State Down - The node is turned off or not operational. Joining - The node is in the process of joining a cluster. Paused - The node is running but not participating in cluster operations. Unknown - The operation was not successful. RESOURCE CONTROL AND MULTICAST RR Messages Outstanding Specifies the length of the internal message queue. RHS Processes Specifies how many Resource Host Monitor processes are running on the node. RHS Restarts Specifies how many Resource Host Monitor failures have taken place on this node. NETWORK RECONNECTIONS Reconnect Count Specifies the number of times the TCP connection was broken and reestablished. Performance Parameter Description MULTICAST REQUEST REPLY Messages Outstanding Specifies the length of the internal message queue. RESOURCE CONTROL MANAGER RHS Processes Specifies how many Resource Host Monitor processes are running on the node. RHS Restarts Specifies how many Resource Host Monitor failures have taken place on this node. NETWORK RECONNECTIONS   Node Name Specifies the label by which the node is known. Reconnect Count Specifies the number of times the TCP connection was broken and reestablished. Normal Message Queue Length Specifies the number of messages in the queue waiting to be sent. Normal Message Queue Length Delta Specifies the incoming message rate to the queue. Urgent Message Queue Length Specifies the number of urgent messages in the queue waiting to be sent.Urgent Message Queue Length Delta Specifies the incoming message rate to the queue. RESOURCE TYPE STATS Indicates the number of times, the Resource Host Monitor get terminated due to a failure of a Resource Failure resource. Indicates the number of times, the Resource Host Monitor get terminated due to a failure of a Resource Failure Access Violation resource, which caused by access violation. Indicates the number of times, the Resource Host Monitor get terminated due to a failure of a Resource Failure Deadlock resource, which caused by deadlock. Networks Parameter Description Name Specifies the name of the network. Address Provides the address for the entire network or subnet. Provides access to the network''s Role property i.e, the role of the network in the cluster. The following are the possible values: None - The network is not used by the cluster. Role Cluster - The network is used to carry internal cluster communication. Client - The network is used to connect client systems to the cluster. Both - The network is used to connect client systems and to carry internal cluster communication. Specifies the current state of the network. The following are the possible values: Unknown - The operation was not successful. Unavailable - All of the network interfaces on the network are unavailable, which means the nodes that own the network interfaces are down. State Down - The network is not operational; none of the nodes on the network can communicate. Partitioned - The network is operational, but two or more nodes on the network cannot communicate. Typically a path-specific problem has occurred. Up - The network is operational; all of the nodes in the cluster can communicate. NETWORK MESSAGES The Bytes Received/sec performance counter shows the number of new cluster message bytes Bytes Received received on the network per second The Bytes Sent/sec performance counter shows the number of new cluster message bytes sent Bytes Sent over the network per second. The Messages Received/sec performance counter shows the number of new cluster messages Messages Received received on the network per second. The Messages Sent/sec performance counter shows the number of new cluster messages sent Messages Sent over the network per second. Storage Parameters Description The path (including the drive letter if present) of the Path clustered disk partition. Specifies access to the VolumeLabel property, which is Volume Label the volume label of the partition. Size The total size for the partition, in megabytes. Used The total used space in the partition, in megabytes. The total free space available for the partition, in Free megabytes. Used Percentage The percentage of used space in the partition. Free Percentage The percentage of free space in the partition. Resource GroupsParameters Description Name The name of the Resource group. The node in which the resource group is currently Current Node running. Indicates the preferred node names from the cluster, to Preferred Node which the resource group can failover/failback The current state of the resource group. The following are the possible values. Unknown Online State Offline Failed PartialOnline Pending Events   Parameters Description Rule Name The name of the Windows Cluster Event Log rule.   The Log File Type under which the the Event Log rule was created. The Windows Cluster Events is generated in ''System'' log file but Applications Manager users can Log File Type Create a rule for Cluster under any Log File Type in Applications Manager. Hence, you can see the other events generated in all the Servers in the Cluster Level. Name of the windows cluster node, in whcih the Node Name particular Event was generated. Source Specifies the Source associated with the Event Log. Event Id Specifies the Event ID associated with the Event Log The Event Type - Event of Any Type, Error, Warning and Type Information.Note: In case of Security Events, the types would vary between Success Audit and Failure Audit. Description Description content for the incoming event Generated Time The time at which the event is generated. Linux Performance Monitor Overview ManageEngine Applications Manager provides out-of-the-box Linux server performance monitoring capabilities. It helps the operations team ensure the servers are up (ping) and also run at peak performance by monitoring CPU usage, memory utilization, processes, disk utilization, disk I/O Stats. In this help document, you will learn how to get started with Linux performance monitoring along with the list of parameters that are monitored with Applications Manager''s Linux monitoring tool. Creating a new Linux monitor Prerequisites for monitoring Linux server performance metrics: Click here Using the REST API to add a new Linux server monitor: Click here Follow the steps given below to create a new Linux server monitor: Select the Mode of Monitoring (Telnet, SSH or SNMP). For IBM AIX, HP Unix, Tru64 Unix, only Telnet and SSH are supported. For Novell, only SNMP is supported. If Telnet, provide the port number (default is 23) and user name and password information of the server.If SSH, provide the port number (default is 22) and user name and password information of the server. You have an option to give Public Key Authentication (User name and Private Key). You can also give a Passphrase if the private key is protected with one. Note: To identify the Public/Private key, go to command prompt, type cd.SSH/ then from the list, open the files / [Public] or / [Private] to get the keys. If SNMP, provide the port at which it is running (default is 161) and SNMP Community String (default is ''public''). This requires no user name and password information. For Telnet/SSH mode of monitoring, specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. Note: In the server which you are trying to monitor through SSH, the PasswordAuthentication variable should be set as ''yes'' for the data collection to happen. To ensure this, access the file /etc/ssh/sshd_config and verify the value of PasswordAuthentication variable. If it is set as ''no'', modify it to ''yes''and restart the SSH Daemon using the command /etc/rc.d/sshd restart. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). Click Add Monitor(s). This discovers the host or server from the network and starts monitoring them. Monitored Parameters Applications Manager''s Linux performance monitoring monitors the key performance indicators of Linux servers to detect any performance problems. These indicators include CPU, memory, disk, etc. Availability tab shows the availability history of the Linux server for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the Linux server such as physical memory utilization, CPU utilization, response time and swap memory utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. List view tab lists all the Linux servers monitored by Applications Manager along with their overall availability and health status. It enables you to perform bulk admin configurations. Click on the individual monitors listed to view detailed Linux server performance metrics. The performance metrics have been categorized into 7 different tabs: Overview CPU Disk Memory Network Cron Job Hardware Configuration Overview This tab provides a high-level overview of the health and performance of the Linux server along with information pertaining to the processes running on the system. Parameter Description Monitor Information Name The name of the Linux server monitor. System Denotes the health status of the Linux server(clear, critical, warning). Health Type Denotes the type you are monitoring. Host Name The host name of the Linux system. Host OS The main OS installed on the system. Last Polled Specifies the time at which the last poll was performed. at Next Poll at Specifies the time at which the next poll is scheduled. Today''s Shows the overall availability status of the server for the day. You can also view 7/30 reports andAvailability the current availability status of the server.   Parameter Description Thread The number threads running in the Linux machine count Process The number of processes. Too many open processes can give poor performance on servers. it is Count helpful to be warned that process count is increasing so users can remedy before an issue arises. Zombie The number of Zombie processes. Zombie Processes can hold ports open with no control. it is Process helpful to see when a zombie process is spawned so it can be deal with accordingly before any Count issues arise Major Page Number of major faults the system has made per second, those which have required loading a Faults/s memory page from disk. Context Total number of context switches per second. Switches/s You can use the Custom Fields option in the ''Monitor Information'' section to configure additional fields for the monitor. The Overview tab shows dials for CPU, memory and disk utilization. You can click on these dials to view detailed graphs and charts for these attributes. The graphs available are History report, hour of day report, day of week report and heat chart. These graphs can be generated for both real time and historical data. The CPU and memory utilization - last six hours graph shows the memory usage and CPU usage values for the last six hours. The attributes shown here are Swap Memory Utilization, Physical Memory Utilization (in % and MB) and CPU utilization (%). The Breakup of CPU Utilization graph provides a break up of performance metrics for the entire system processor with attributes such as run queue, blocked process, user time (%), system time (%), I/O wait (%), idle time (%), steal time (%) and interrupts/sec. The System Load graph provides you an idea of the amount of work that the system performs. The system load during the last one-, five- and fifteen-minute periods are represented by parameters such as Jobs in Minute, Jobs in 5 minutes and Jobs in 15 minutes. The Process Details section shows information about the processes running on the Linux server. You can add processes for monitoring using the Add New Process option. You can also delete unwanted processes and enable/disable reports for specific processes. Click on any of the attributes listed to view more details. The Monitors in this System section shows the availability and health of the monitors configured in this server. To add new monitors for monitoring, use the Add Monitors option. CPU This tab provides the CPU usage statistics of the Linux server. The tab includes two graphs - one that displays the CPU utilization by CPU Cores and another that shows the Breakup of CPU utilization - by CPU cores. You can view additional reports by clicking the graphs present in the Breakup of CPU Utilization - by CPU coressection. These reports include Break up of CPU Utilization (%) Vs Time, User Time (%) Vs Time, System Time (%) Vs Time, I/O Wait Time (%) Vs Time, Idle Time (%) Vs Time, Steal Time (%) vs Time, CPU Utilization (%) Vs Time and Interrupts/sec Vs Time for all the CPU cores. The CPU tab also shows the following performance metrics: Parameter Description Monitoring Mode Telnet/SSH SNMP Core The name of the CPU core     The percentage of time that the processor spends on User mode User Time(%) operations. This generally means application code. System The percentage of CPU kernel processes that are in use. Time(%) I/O Wait The time spent by the processor to waiting for I/O to complete. Time(%) Idle Time(%) The time when the CPU is idle (not being used by any program) Amount of time a virtual CPU waits for a real CPU while the hypervisor is Steal Time(%) servicing another virtual processor. CPU Specifies the total CPU used by the system.Utilization(%) The rate at which CPU handles interrupts from applications or hardware Interrupts/sec each second. If the value for Interrupts/sec is high over a sustained period of time, there could be hardware issues. You can also view graphs for these attributes by selecting the necessary CPU core and then choosing the appropriate attribute. Disk This tab displays disk usage and disk I/O statistics of the Linux server. Parameters Description Disk Utilization Disk The name of the disk drive. Used (%) Denotes how much disk space out of the total disk space has actually been used (in percentage) Used (MB) The disk space used in mega bytes. Free (%) The percentage of total usable space on the disk that was free. Free (MB) The unallocated space on the disk in mega bytes. Disk I/O Statistics Transfers/sec The number of read/write operations on the disk that occur each second. Writes/sec The percentage of elapsed time that the disk drive was busy servicing write requests. Reads/sec The percentage of elapsed time that the disk drive was busy servicing read requests. % Busy Time The percentage of time the disk was busy. Average The average number of both read and write requests that were queued for the disk during the Queue sample interval. Length Avg. Disk The average time (in milliseconds) for I/O requests issued to the device to be served. This Latency includes the time spent by the requests in queue and the time spent servicing them. Read Wait The average time (in milliseconds) for read requests issued to the device to be served. This Time includes the time spent by the requests in queue and the time spent servic‐ ing them. Write Wait The average time (in milliseconds) for write requests issued to the device to be served. This Time includes the time spent by the requests in queue and the time spent servic‐ ing them. Inode Usage Inode The name of the Inode. Total The total number of Inodes available in that particular disk. Used The percentage of elapsed time that the disk drive was busy servicing read requests. Free The remaining number of Inodes that are available in that particular disk. Used (%) The number of Inodes used in that particular disk, in percentage. Free (%) The remaining number of Inodes that are available in that particular disk, in percentage. You can also delete disks that have been physically removed using the Delete Orphaned Disk option. Note: Data collection for Disk I/O statistics and Inode statistics can be enabled from ''Disk I/O Statistics Monitoring'' and ''Inode Monitoring'' options under Admin → Performance Polling → Servers tab. Memory Parameters Description Memory Usage Statistics Memory that has been used more recently and usually not reclaimed unless absolute necessary Active Memory (in MB). Active anonymous Anonymous memory that has been used more recently and usually not swapped out (in MB). memory Active Files Pagecache memory that has been used more recently and usually not reclaimed until needed (in Memory MB).Anonymous huge pages Non-file backed huge pages mapped into userspace page tables (in MB). memory Anonymous pages Non-file backed pages mapped into userspace page tables (in MB). memory Cached Memory in the pagecache (Diskcache and Shared Memory) (in MB). memory Based on the overcommit ratio (vm.overcommit_ratio), this is the total amount of memory Commit limit currently available to be allocated on the system (in MB). This limit is only adhered to if strict memory overcommit accounting is enabled (mode 2 in vm.overcommit_memory). The amount of memory presently allocated on the system (in MB). The committed memory is a Committed sum of all of the memory which has been allocated by processes, even if it has not been "used" Memory by them as of yet. Unevictable Unevictable pages that cannot be swapped out for a variety of reasons (in MB). memory Unreclaimable The part of the slab that cannot be reclaimed under memory pressure (in MB). memory Network Parameter Description Monitoring Mode Telnet/SSH SNMP NETWORK INTERFACE Name The name of the network interface present in the Windows system. Speed (Mbps) The estimate of the current bandwidth in Mbps. Maximum Transmission Unit (MTU) is a measurement of the largest data MTU packet that a network-connected device can accept. Input Traffic The rate at which packets are received on the interface, in kilo bytes per (Kbps) second. Output Traffic The rate at which packets are sent on the interface, in kilo bytes per (Kbps) second. Errors Number of packets that could not be sent or received. Connection Stats The state in which the sockets are present. Following are the list of sockets that are shown: ESTABLISHED - The socket has an established connection. FIN_WAIT1 - The socket is closed, and the connection is shutting down. Socket State FIN_WAIT2 - Connection is closed, and the socket is waiting for a shutdown from the remote end. LISTEN - The socket is listening for incoming connections. TIME_WAIT - The socket is waiting after close to handle packets still in the network. No. of Number of connections that are available for the particular socket state. Connections NTP Stats NTP Status Indicates whether the client is synchronized with the server or not. Server Name Indicates the hostname of the server to which the client is synchronized. Stratum Level Indicates the level of the strata at which the client is located. Indicates the time offset value (in milliseconds) displayed for ''time NTP Time correct to within'' after executing the npstat command. correct to within Time correct to within = (Root dispersion + Root Delay) / 2 Poll Interval Indicates the polling time interval between each sync (in seconds).Note: You can also delete interfaces that have been physically removed using the Delete Orphaned Interface option. Cron Job Cron jobs are used for scheduling tasks like backups, emails, status checks, etc. in Linux and can have a major impact on the performance of your web servers and applications. Applications Manager makes it easy by continuously monitoring them and helps you gain insight into the execution of important jobs in the back-end systems. Adding a Cron job monitor Prerequisites : Click here Go to the Cron Job tab and click on Add Cron Job. Enter the following details: Display Name - A user-friendly name for identification. Cron Expression - Expression used for scheduling the cron job. Time Zone - Appropriate time zone configured in the remote Linux machine by selecting from the drop- down. Job Script Path - The complete script path that needs to be executed in the cron job. Cron Job Period - The amount of time within which the job should run (in Minutes). If it exceeds the configured time, then the status will be updated as EXCEEDJOBTIME. After adding a cron job monitor, the curl details for your cron job will be shown below. Copy the displayed curl details by clicking over it and close the curl details window. You will now be redirected to the Cron Job tab of Applications Manager automatically. In the remote Linux machine, open the command prompt and execute the command crontab -e. This will open the crontab in edit mode. Paste the cron details that was copied earlier, then save and close the crontab. The below table contains information about Cron job details running in the Linux server. Parameters Description Cron Job Details: Cron Name Name of the Cron job. Cron Expression The Cron expression for the corresponding Cron job. Job Start Time Time and date at which the Cron job started. Job End Time Time and date at which the Cron job ended. Next Run Time Time and date at which the next Cron job is scheduled to run. Elapsed Time The amount of time elapsed since the Cron job started (in Minutes). Exit Code Denotes the exit code of the Cron job. Missed Runs The number of times Cron job had failed/missed to start at the scheduled time. Status of the Cron job. Possible values are: PASSED - Job has run successfully with exit code equal to 0. Status RUNNING - Job is running currently. FAILED - Job has failed with exit code greater than 0. EXCEEDJOBTIME - Job has been running more than the configured job time. Note: Once the Cron job is added, it will be in discovery state until we receive the first response from the remote server. Updating cron jobs To update a Cron job, Click on the Edit icon for the required cron job. Enter the required display name and the Cron Job Period for that cron job. Click Update. Deleting cron jobsTo delete Cron jobs, Select the cron jobs that need to be deleted. Click on Delete Cron Jobs. This will delete the cron jobs from Applications Manager. Finally, make sure you remove the curl appended to the cron jobs in the remote server using the crontab -e command. Note: Addition, update, and deletion of Cron jobs will be possible only in managed servers by the administrator user. Configuration This tab contains information about system configuration attributes. Parameters Description System Information Host Name The name of the system. Domain The name of the domain to which the system belongs. OS Information OS Name The name of the operating system instance. OS Version Version number of the operating system. OS Release The Linux distribution Memory Information Total Physical Total amount of physical memory as available to the operating system. Memory (MB) Total Swap Total amount of swap memory available. Memory (MB) Processor Information Id Unique identifier of a processor on the system Model The processor model type Implementation The processor family type. Manufacturer Name of the processor manufacturer Speed(MHz) Current speed of the processor Size of the processor cache. A cache is an external memory area that has a faster access time Cache (KB) than the main memory. Network Interface Settings Name The name of the network adapter. IP Address The IP address configured for this network interface MTU The network medium in use. Type The type of network adapter. The Media access control address for this network adapter. A MAC address is a unique 48-bit Mac Address number assigned to the network adapter by the manufacturer. It uniquely identifies this network adapter and is used for mapping TCP/IP network communications. Status The current status of the network adapter. Broadcast The IP address to which messages are broadcast. Address Printer Settings Name Name of the printer. Device The name of the server that controls the printer. Default Indicates whether the printer is the default one. Values are either True or False. Status Current status of the printer. Note: The data present in the configuration tab is not updated during every poll. So if you make any changes to the server configuration, you need to restart Applications Manager for those changes to be reflected in the ''Configuration'' tab.Hardware Metrics The following are metrics pertaining to the hardware of Dell and HP servers: Category Attribute Description DELL HP SNMP WMI SNMP WMI Mode Mode Mode Mode The name of the Sensor temperature sensor. Temperature The current /present Temperature Reading (deg C) temperature reading. The temperature status - Status Critical, Warning, Clear Sensor Name of the fan sensor. The fan speed values Fan Speed (RPM) Fan displayed in RPM. The fan status - Critical, Status Warning, Clear Name of the power Sensor supply. The power supply reading Power Reading (Watts) values displayed in Watts. The power status - Status Critical, Warning, Clear Name of the voltage Sensor supply. The voltage reading Voltages Reading (Volts) values displayed in Volts. The voltage status - Status Critical, Warning, Clear Name of the Battery Sensor sensor.. Battery The battery status - Status Critical, Warning, Clear Name of the Memory Sensor sensor. Memory Device The type of memory Type device Memory The amount of memory Size (MB) currently installed in MB. The memory status - Status Critical, Warning, Clear Sensor Identifies the disk''s label The device name Device Name configured for the disk Disk Size (MB) The allocated size in MB The disk status - Critical, Status Warning, Clear. Sensor The name of the array disk The bus type of the array Bus protocol disk Array The amount in MB of the Size (MB) used space on the array disk. The array status - Critical, Status Warning, Clear Chassis Sensor The user-assignedchassis name of the chassis. The system model type Model for this chassis The chassis status - Status Critical, Warning, Clear The location name of the Sensor processor device status probe The brand of the Processor Brand processor device. The current speed of the Processor Current Processor processor device in MHz Speed   The number of processor Processor Core cores detected for the Count processor device. The processor status - Status Critical, Warning, Clear If a component is functioning normally, the status indicator is green. The status indicator changes to orange or red if a system component violates a performance threshold or is not functioning properly. Generally, an orange indicator signifies degraded performance. A red indicator signifies that a component stopped operating or exceeded the highest threshold. If the status is blank, then the health monitoring service cannot determine the status of the component. Note: Currently hardware performance monitoring is supported in SNMP and WMI monitoring mode. Hardware Device-Level Configuration Hardware Configuration option available under Host Details in the right hand side of the details page, will allow you to opt for the various hardware components you want to monitor. This operation can also be done using the Performance Polling option under the Admin tab which will globally configure the hardware stats. Advanced Settings By clicking the Advanced Settings option available under Host Details in the right hand side of the details page, you can go to the Performance Data Collectionpage for Servers. Here you can use the Hardware Health monitoring option to enable or disable hardware monitoring in servers. You can also opt the various hardware components (like power, fan, disk,etc.,) to be monitored by checking the options given. This will globally configure the hardware monitoring status. You can also configure the health status by defining values in the respective text boxes: Critical Severity: If the status matches with any of the values defined in the Critical Severity text box, then Applications Manager displays the status of the hardware device as Critical. The values defined by default are failed, error, failure, nonRecoverable, criticalUpper, criticalLower, nonRecoverableLower and critical. Warning Severity: If the status matches with any of the values defined in the Warning Severity text box, then Applications Manager displays the status of the hardware device as Warning. The values defined by default are degraded, warning, nonCritical, nonCriticalUpper, nonRecoverableUpper and nonCriticalLower. Clear Severity: If the status matches with any of the values defined in the Clear Severity text box, then Applications Manager displays the status of the hardware device as clear. The value defined by default is ''ok''. Note: If the status of the device does not match with any of the values defined in the severity text box, the device status is displayed as unknown. Status values defined within the severity text boxes are comma- separated and case-insensitive. IBM i Monitoring Creating a new IBM i monitor Prerequisites for monitoring IBM i metrics: Click here Using the REST API to add a new IBM i monitor: Click hereTo create a new IBM i monitor, follow the steps given below: Click on New Monitor link. Select IBM i. Enter the Host Name / IP Address of IBM i server. Provide Subnet Mask and set Polling interval for the monitor. If you are adding a new monitor from an Admin Server, select a Managed Server. Enter Username and Password for authentication. Choose the Monitor Group from the combo box with which you want to associate IBM i Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers IBM i from the network and starts monitoring them. There are situations where the host gets automatically discovered with the Monitor running in the host. To disable the default option, disable it using Global Settings. It is important to note that if Applications Manager server is running in Windows machine, then it can monitor any type of host but if the server is running in Linux, then it can monitor Windows only if an SNMP agent is running in it. Also, any type of user can be used to log into Linux, whereas only Admin users can log into Windows. Note: The important configuration details that are required while discovering host resource by Applications Manager are available in Appendix - Data Collection. Monitored Parameters Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. In addition, it also provides the auxillary storage pool percentage, processing unit percentage, number of users signed on and response time of the server. Each attribute has heat chart report enabled. List view tab enables you to perform bulk admin configurations. The attributes for IBM i monitored are classified under the following tabs by Applications Manager: Overview Status Pool Jobs Messages Spool Printer Disk Problem Subsystem History Log Queues Admin Overview Parameters Description Server Snapshot Server snapshot provides an quick overview of current server''s auxillary storage pool''s usage in percentage, processing units'' usage in percentage, permanent address usage in percentage, temporary address usage in percentage and interactive performance usage in percentage. ASP Usage: The amount of hard disk capacity available in your system is called Auxiliary Storage Pool (ASP). This can be a deceiving number if you have more than one ASP defined on your system, because this number only reflects the System ASP. Applications Manager provides you with the percentage of disk storage in your System ASP that is currently used. If the percentage exceeds 90 percentage the system can fail. The performance of your IBM i server is affected if the percentageusage crosses 80 percent. You can create an alarm for this percentage and alert you whenever the percentage exceeds 80. Permanent addresses percentage and Temporary addresses Usage: Applications Manager provides you the usage in percentage for the two addresses - Permanent and Temporary Addresses - which refer to the possible system addresses created for permanent and temporary objects in your IBM i. Any variation in these values may reflect on rapid changed in the creation or destruction of objects in your IBM i at much rapid pace. This may affect the performance of your server. This displays the value and health of ASP percentage, Disk Utilization, Processing System Status Unit percentage, Permanent and Temporary Addresses percentage. Displays bar charts showing the Availability History and the Performance History History for the last 6 hours. This provides general information about the IBM i server such as name of the server, current health of the server, type, system model, system serial, and latest polled values. In addition, it also displays system configuration details such as security Monitor Information level, version number, Previous System End, Auto Device Configuration, System Console, Job Message Queue Initial Size, Job Message Queue Maximum Size, Spooling Control Initial Size, Maximum Jobs Allowed, Password Valid Days and Query Processing Time Limit. Provides the various job counts of various job types currently running in IBM i server. The information is displayed in a pie-chart with clearly distinction of each job types contribution to total job count. By default, the following services job count is displayed: Source PF system Spooled Writer Job Counts System Spooled Reader Subsystem Autostart Interactive Batch Specifies the hard disk space utilized by the system and updates with the peak and Disk Utilization current value, and current status of the Disk Partition parameter.(The parameter includes C, D, E, F drives, etc. in windows, /home, etc. in Linux.) System information displays the shared processing pool information, uncapped System Information CPU utilization and current processing capacity resources. Memory utilization for IBM i is displayed through pool size, reserved size, DB pages Memory Utilization and Non DB pages and through DB faults and Non DB faults. Status Under Status tab, Applications Manager monitors the status of various attributes of IBM i server. You can also configure alarms for each of these attributes by clicking on ''Configure Alarms'' link. Parameters Description This contains details of your IBM i main storage, number of processors, number of System Information pools, number of partitions and the number of active threads in your system along with the health of each individual attribute. This displays the value and health of ASP percentage, Disk Utilization percentage, System Status Processing Unit percentage, Permanent and Temporary Addresses percentage. The amount of hard disk capacity available in your system is called Auxiliary Storage Pool (ASP). This can be a deceiving number if you have more than one ASP defined on your system, because this number only reflects the System ASP. Applications Manager provides you with the percentage of disk storage in your System ASP that is ASP Percentage currently used. If the percentage exceeds 90 percentage the system can fail. The performance of your IBM i server is affected if the percentage usage crosses 80 percent. You can create an alarm for this percantage and alert you whenever the percentage exceeds 80. Auxillary Storage The auxillary storage displays ASP total value and health, current unprotecteduseage and maximum protected usage along with the health of each attribute. Displays information like Current Processing Capacity, Current Interactive Additional Information Performance Percentage, Shared Processor Pool Used Percentage and Uncapped CPU Capacity Used Percentage. Displays the total number of jobs, number of active jobs, number of batch jobs, jobs waiting for messages, and maximum number of jobs in your IBM i server along with Jobs the health of each attribute. For number of active jobs, the 7/30 reporting is enabled. Displays the number batch jobs ended, ending, held on queue and held while running along with the health of each attribute. It also displays the batch jobs on Batch Jobs unassigned job queue and waiting to run/already scheduled jobs in IBM i server. For number of batch jobs on jobqueue, the 7/30 reporting is enabled. Displays the values for total number of users signed on and signed off, along with users suspended by group jobs, users suspended by system request and users Users temporarily signed off. For number of users signed on, the 7/30 reporting is enabled. Pool Under Pool tab, Applications Manager displays pool details for the IBM i server. Applications Manager provides you in-depth details for Pool such as Pool Name, Pool Size, DB pages, DB faults, Non DB pages and Non DB faults. The health and alarm configuration for each corresponding attribute is also provided. Click on the metric names (say Pool Name, Pool Size or DB pages) for column-wise sorting. You can enable or disable data collection for a monitor by clicking on the Enable/Disable Pool button on the top right hand corner of the Pool Details table. In the Performance Polling Settings window that pops up, un-check the metrics that you need to disable and click Apply to save the settings. You can also apply the same settings to other IBM i servers by clicking on Apply to Selected Monitors link. Parameters Description Name of the pool. By default, there are four predefined storage pools: *MACHINE, Pool Name *BASE, *INTER, and *SPOOL. There are up to 12 user-definable storage pools available. This displays the amount of memory assigned to each default pools such as *MACHINE, *BASE, *INTER and *SPOOL. You can also edit the amount of memory Pool Size allocated for each pool by executing the Change Subsystem Description (CHGSBSD) command through Non- interactive Command available in Admin tab. Better allocation would help improve the performance of the server. This displays the pool''s reserved memory allocation size. The information provided here gives better understanding to how much of the memory allocation has been used by jobs and how much memory is still unused. This reserved size can affect Reserved Size system performance. If insufficient memory is not provided to the default *MACHINE pool, then it can affect overall performance of your IBM i server. Hence monitoring this attribute becomes critical for maintaining better performance of your IBM i server. This displays the DB and Non DB pages and fault for each pool. This bascially DB and Non DB Faults and displays how program instructions and database information enter and leave the Pages pool''s memory. Monitoring this information provides better visibility on various programs and jobs that are being executed in IBM i server. Jobs Under Jobs tab, Applications Manager monitor Jobs status and health in detail. You can easily configure alarms for Job details by clicking on ''Configure Alarms'' link. The table consists of the following columns: Job Name User Number Type Status Pool Function PriorityThreads Queue Subsystem CPU (ms) Uptime (mins) and Log Parameters Description Displays the total number of jobs in clear, critical and warning states along with the health of each attribute. You can view jobs in clear, critical or warning state separately by click on the respective counts. For eg, if there are 25 jobs in critical state, the users can view these jobs alone by clicking on the number. Also, from the pop up window, users can navigate through jobs which are in clear, critical or Job Summary warning conditions using the Filter By option for the respective monitor.  You can also navigate through the For Monitor drop down menu where all the IBM i monitors in APM are listed.The line graph shows the percentage of jobs in clear, critical and warning condition out of the total number of jobs. The number of jobs collected from the server is set to 100 by default, which can be changed by the user by changing the values in AS400Server.properties file. Displays a wealth of information on various jobs being executed in IBM i server. The user can sort jobs column-wise by clicking on the metric names. Each attribute is explained below: Batch Job: The user name is specified on the Submit Job (SBMJOB) command, or it is specified in the job description. Interactive Job: The user name is either typed in at signon or is provided by the default in the job description. Autostart Job: The user name is specified in the job description referred to by the job entry for the autostart job. Job Details You can enable or disable data collection for a monitor by clicking on the Enable/Disable Job button on the top right hand corner of the Job Details table.If a user wants to monitor a specific job, they can add job(s) by clicking on the link Add Job(s) to Monitor. Users can also perform actions like END, HOLD and RELEASE from the Actions drop down list and Job(s) can be removed from monitoring by click on the Remove Job(s) link. These actions can also be performed from the double click mouse event.Users can configure alarms to jobs by clicking on the configure alarm icon and create thresholds for THREADS, PRIORITY and STATUS of the jobs.From the Add Job(s) to Monitor pop-up, you can fetch job details of currently running specific job/ all jobs, directly from the IBM i server. This will help you to add jobs to monitor even after disabling data collection for jobs. Job Name The name of the job as identified by IBM i. The user name is the same as the user profile name and can come from several User different sources, depending on the type of job. Number The system-assigned job number. The type of active job. Possible values are: ASJ: Autostart BCH: Batch BCI: Batch Immediate EVK: Started by a procedure start request INT: Interactive o M36: Advanced 36 server job Type MRT: Multiple requester terminal PJ: Prestart job PDJ: Print driver job RDR: Reader SBS: Subsystem monitor SYS: System WTR: Writer Status This displays the status of the initial thread of the job. Only one status is displayed Status per job. The status ''NONE'' represents an initial thread that is in transition.Pool This displays the system-related pool from which the job''s main storage is allocated. This displays the last high-level function initiated by the initial thread. This field is Function blank when a logged function has not been performed. The field is not cleared when a function is completed. This displays the run priority of the job. A lower number indicates a higher priority. System jobs and subsystem monitors with a run priority higher than priorities allowed for user jobs show a priority of 0. Run priority ranges from 1 (highest) to 99 Priority (lowest). Jobs with the highest priority receive the best service from the CPU. This value is the highest run priority allowed for any thread within the job. Individual threads may have a lower priority. Threads Displays the number of active threads in the job. Queue Displays the name of the Queue where the job is located. Subsystem The name of the subsystem that holds the job. CPU (ms) Displays the amount of CPU time used by the job, in milliseconds. Uptime (mins) Displays the amount of time the job is running, in minutes. Logs View the Job log for any particular job by clicking on the log icon in the Log column. The job status in IBM i is classified into three types: 1. Jobs Clear 2. Jobs Warning 3. Jobs Critical If you would like to define a particular job status as critical, edit AS400server.properties in AppManager Conf directory and include the particular job status as critical. Open the conf file in the Applications Manager directory: Windows: C:\Program Files\ManageEngine\ \conf Linux: \ManageEngine\ \Conf The file consists of jobs in pre-defined classification under clear, warning and critical categories. If you would like to include a particular job status say for example CMNA as critical, add CMNA in the following line as follows am.as400.critical = MSGW, CMNA Save the file and restart Applications Manager. After the next polling interval, you will find that the particular job is now classified as a Critical job status.  Messages Message Information display gives you more detailed information about the various message(s) being received in the message queue (By default we are monitoring ''QSYSOPR'' message queue, but user can change this value for key ''am.as400.messagequeue'' in AS400Server.properties file''). The messages are displayed with in-depth details such as message ID, severity of the message, type of the message, message text with a cause and recovery information if applicable, date and time of the message generated and help information for that particular message. You can view more detailed information of a particular message by clicking on the Help icon -  . By default only messages that need a reply are displayed. To view all the messages click on the link Show all messages. From the pop-up window that appears, the user can also view filter messages by Messages Need Reply / All Messages. This can be done for a specific monitor or for all IBM i monitors from For Monitor drop down menu. The number of messages collected from the server is set to most recent 100 messages by default, which can be changed by the user by changing the values in AS400Server.properties file. The user can create thresholds for ''Messages'' and configure alarms for MESSAGE ID, SEVERITY, and MESSAGE to capture the critical messages. The user can sort messages column-wise by clicking on the metric names: Parameters Description The message ID identifies the type of message. This is useful when doing problem Message ID analysis. A 2-digit value ranging from 00 through 99. The higher the value the more severe or Severity important the condition. Type The following values may be shown:Completion: A message that conveys completion status of work. Diagnostic: A message that indicates errors in a system function, errors in an application, or errors in input data. Escape: A message that describes a condition for which a program must end abnormally. Information: A message that provides general non error-related information. Inquiry: A message that conveys information but also asks for a reply. Notify: A message that describes a condition for which a program requires corrective action or a reply. Reply: A message that is a response to a received inquiry or notify message. Request:A message that contains a command for processing by a request processor, such as command entry. Sender Copy: A copy of an inquiry or notify message that is kept in the sender''s message queue. Message The text of the message. Date This is the date (in job format) that the message was sent. Displays the default reply that was generated by your IBM i server for the particular Default Reply generated message. Displays in-depth details for the particular message from your IBM i server. It displays the following values: Message ID Date Sent Alert Option Current User Help From Job Number From Program Reply Status Message Queue File Name Message Cause Spool Parameters Description Displays the total number of jobs in clear, critical and warning states along with the health of each attribute. For eg, if there are 10 spool files in critical state and you want to view these spool files alone, you can do it by just clicking on the number.Also, from the pop up window you can navigate through spooled files which are in clear, critical or warning using the Filter Byoptions for that respective monitor. You can also do the same for other IBM i monitors through the For Monitor drop down menu where all the IBM i monitors in APM are listed.The user can view spooled files in clear, critical or warning condition in all IBM i monitors by Spool Summary choose ''Show all'' in ''For monitor'' drop down and navigate through all monitors at a glance.The line graph shows the percentage of Spooled files in clear, critical and warning condition out of the total number of spool files.The number of spooled files collected from the server is set to 100 by default, which can be changed by the user by changing the values in AS400Server.properties file.You can enable or disable data collection for a monitor by clicking on the Enable/Disable Spool button on the top right hand corner of the details table.The user can sort spools column-wise by clicking on the metric names. The file name that was specified by the user program when the file was created, or Spool Name the name of the device file used to create this file. Number The system-assigned spool number. Job Name The name of the job that produced the spooled file. Job Number The number of the job that produced this spooled file.Job Owner The name of the user who owns the spooled file. The status of the spooled file. The following list of values is used to describe the file''s status:RDY (Ready) The file is available to be written to an output device by a writer.OPN (Open) The file has not been completely processed and is not ready to be selected by a writer.DFR (Deferred) The file has been deferred from printing.SND (Sending) The file is being or has been sent to a remote system.CLO (Closed) The file has been completely processed by a program but SCHEDULE(*JOBEND) was Status specified and the job that produced the file has not yet finished.HLD (Held) The file has been held.SAV (Saved) The file has been written and then saved. This file will remain saved until it is released.WTR (Writer) This file is currently being produced by the writer on an output device.PND (Pending) The file is pending to be printed.PRT (Printing) The file has been completely sent to the printer but print complete status has not been sent back.MSGW (Message Waiting) This file has a message which needs a reply or an action to be taken. Printer Name The name of the printer in which that spooled file is assigned. The total number of pages or records in the file (pages for print, records for diskette). If the file is still open, this field is blank for diskette files or will have the Pages current number of pages spooled for printer files. An "R" is displayed after the value if the file is a diskette file. Printer Parameters Description Device Name Specifies the Printer or Device name. Device Class Specifies the class of the device. For Eg: virtual/ LAN. Device Type Specifies the manufacturer type of the device. Specifies the status of the printer device. Valid values are:Varied OffVary Off PendingVary On PendingVaried OnConnect PendingActiveActive Status WriterHeldPowered OffRecovery PendingRecovery CanceledFailedFailed WriterBeing ServicedDamagedLockedUnknown Job Name Specifies the name of the job that created the spooled file. Job Number Specifies the number of the job that created the spooled file. Specifies the status of the writer job. Valid values are STR, END, JOBQ, HLD and Job Status MSGW. Job Owner Specifies the name of the user that created the spooled file. Started By Specifies the name of the user who started the writer. Spooled File Name Specifies the name of the spooled file. Specifies the spooled file number. Special values allowed are -1 and 0. The value Spooled File Number *LAST is encoded as -1, the value *ONLY is encoded as 0. Output Queue Name Specifies the name of the output queue. Output Queue Status Specifies the status of the output queue. Valid values are RELEASED, HELD. If a user does not need printer details, he can disable data collection for printer by clicking on the Enable/Disable Printer option in the top right hand corner of thePrinter Details Table. The user can also sort printer details column-wise by clicking on the metric names. Disk The Disk Status display shows performance and status information about the disk units on the system. It displays the number of units currently on the system, the type of each disk unit, the size of disk space, whether the disk is currently on the system, the percentage of disk space used, the average amount of data read and written, and the percentage of time the disk is being used. If a user does not need disk details, he can disable data collection for disk by clicking on the Enable/Disable Disk option in the top right hand corner of the Disk Details Table. The user can also sort Disk Details column-wise by clicking on the metric names. Parameters Description Disk Arm Number Specifies the unique identifier of the unit. Each actuator arm on the disk drives available to the machine represents a unit of auxiliary storage. The value of the unitnumber is assigned by the system when the unit is allocated to an ASP. Total number of auxiliary storage provided on the unit for the storage of objects and internal machine functions when the ASP containing it is not under checksum Drive Capacity (in MB) protection. The unit reserved system space value is subtracted from the unit capacity to calculate this capacity. Drive Available Space (in Total number of auxiliary storage space that is not currently assigned to objects or MB) internal machine functions, and therefore is available on the unit. Number of blocks written: The block length is 520 bytes, which includes 8 bytes of Blocks Write system control information. Number of blocks read: The block length is 520 bytes, which includes 8 bytes of Blocks Read system control information. Specifies the ASP to which this unit is currently allocated. A value of 1 specifies the system ASP. A value from 2 through 32 specifies a basic ASP. A value from 33 to 255 ASP specifies an independent ASP. A value of 0 indicates that this unit is currently not allocated. Unit Status Local mirroring status.1 = active2 = resuming3 = suspended Combined wait (queue) time of all disk operations completed since last sample (milliseconds). Divide by number of read and write commands to obtain average Disk Wait Time wait (queue) time. Add to disk service time to obtain disk response time. Set to zero if data is not available. Arm Utilization(%) The part of the total interval that the arm was being used for I/O operations. Problem Parameters Description Specifies the problem identifier of the problem being selected. Problems with different system origins can have the same identifier. This parameter can be used Problem ID with the ORIGIN parameter to select a single problem from a particular system origin. This specifies the severity level of the problem. Severity levels are assigned by the user when the problem is prepared for reporting. The four severity levels are: High Problem Severity Medium Low None Specifies which type of problems to work with. Possible values are: *ALL - All problem log entries are shown, regardless of the problem type. 1 - Only machine-detected problems are shown. 2 - Only user-detected problems are shown. Problem Type 3 - Only PTF order problems are shown. 4 - Only application-detected problems are shown. 5 - Only Client machine-detected problems are shown. 6 - Only Client user-detected problems are shown. Specifies the status of the problem log entries. The various status are: Status OPENED,READY,SEND,ANSWERED,PREPARED,VERIFIED,CLOSED. Date Opened Specifies the date the problem was opened. Time Opened Specifies the time the problem was opened. If a user does not need problem details, he can disable data collection for disk by clicking on the Enable/Disable Problem option in the top right hand corner of theProblem Details table. The user can also sort Problem Details column-wise by clicking on the metric names. SubSystem Parameters DescriptionSubsystem Summary Displays the total number of subsystems in clear and critical states along with the health of each attribute. For eg, if there are 4 subsystems in critical state and the users want to view those subsystems alone, he can do it by just a click on the number.Also, from the pop up window you can navigate through subsystems which are in clear or critical state using the Filter Byoptions for that respective monitor. You can also do the same for other IBM i monitors through the For Monitor drop down menu where all the IBM i monitors in APM are listed.The user can view subsystems in clear, critical or warning condition in all IBM i monitors by choosing ''Show all'' in ''For monitor'' drop down and navigate through all monitors at a glance.The line graph shows the percentage of subsystems in clear, critical and warning condition out of the total number of subsystems. The number of subsystems collected from the server is set to 100 by default, which can be changed by the user by changing the values in AS400Server.properties file. Provides subsystem details like Name, Library, Current Active Jobs, Maximum Active Jobs and Status. If a user wants to monitor a specific subsystem, they can add subsystem(s) by clicking on the link Add Subsystem(s) to Monitor. Users can also perform actions like START, END, DELETE and REFRESH from the Actions drop down list andSubsystem(s) can be removed from monitoring by a click on Subsystem Details the Remove Subsytem(s) link. These actions can also be performed from the double click mouse event. You can enable or disable data collection for a monitor by clicking on theEnable/Disable subsystems button on the top right hand corner of the details table. The user can sort subsystems column-wise by clicking on the metric names. The name of the subsystem that was specified on the STRSBS (Start Subsystem) Name command. The number of jobs active in the subsystem. If more than one interactive job is Current Active Jobs started from the same work station (with system request or Transfer to Group Job), they are counted as only one job on this display.  The status of the subsystem, which can be either ACTIVE, END (in the process of ending), or RSTD (the controlling subsystem is in the restricted condition). More Status information on the restricted condition of the controlling subsystem is in the online help information for the ENDSBS command. Library The name of the library where the subsystem description is located. Maximum Active Jobs The maximum number of jobs active allowed in the subsystem. History Log Display of history log contents, will help you to track the system activities, such as messages related to system failure, security vulnerabilities , warning messages which are send to QHST and dumped. History Log Details Parameters Description The message ID identifies the type of message. This is useful while doing problem Message ID analysis. A 2-digit value ranging from 00 through 99. The higher the value the more severe or Severity important the condition. Type The following values may be shown: Completion: A message that conveys completion status of work. Information: A message that provides general non error-related information. Diagnostic: A message that indicates errors in a system function, errors in an application, or errors in input data. Escape: A message that describes a condition for which a program must end abnormally. Inquiry: A message that conveys information but also asks for a reply. Notify: A message that describes a condition for which a program requires corrective action or a reply. Reply: A message that is a response to a received inquiry or notify message. Request:A message that contains a command for processing by a request processor, such as command entry. Sender Copy: A copy of an inquiry or notify message that is kept in the sender''s message queue.Message The text of the message. Date This is the date when the log was sent. Note: 1. Monitoring of history log is supported for versions IBM i 6.1 & above. For other versions, you can monitor an alternate message queue if specified in the AS400Server.properties file for the key ''am.as400.historylogalternative''. 2. Double click on the history log details table , to find options such as ''Configure Alarms'', ''Show All Messages'', ''Show Debug Info'', ''Enable/Disable History Log''. 3. ''Show All Messages'' pop up, helps you to navigate through clear/warning/critical messages depending upon the configured alarms for any IBM i or all IBM i servers. 4. History log monitoring will only monitor latest messages. The number of messages collected from the server is set to 100 by default, which can be changed by the user by changing the values in AS400Server.properties file. 5. When there is no data available for historylog or for the alternate message queue configured due to errors like authority failure/ message queue not found/ version not supported , an error message will be displayed under message tab. Queues Data queues provide a fast means of inter-process communication, and is a method used to pass information to another program. Applications Manager allows you to monitor pre-defined system library data queues and objects to let you maintain the overall performance of IBM i server. Queues monitoring is of importance to operators as they are the holding areas for messages, printed reports, batch jobs, and other work that is waiting to be received, released to the CPU, or accessed by a specific user. You can perform in-depth data queue monitoring viz., job queues and output queues and set up alerts for when the queue exceeds resources available over a specified period of time. Monitored Data Queue(s) Parameters Description Data Queue The data queue being monitored. Library The name of the library where the data queue resides. Sequence Specifies the sequence in which entries are received from the data queue. Object Size (KB) The object size information of the data queue object in kilobytes. Object Unchanged (Mins) The time this object is unchanged in minutes Number of Messages The number of messages(Entries) currently on the data queue. Entries Allocated The number of entries that will fit into the data queue before it is extended Max.Entries The maximum data queue entries allowed in a library. Current Entries (%) Percentage of Entries Currently Present in the Queue. Utilized Allocation (%) The percentage of allocated storage currently in use by the data queue. Monitored Job Queue(s) Parameters Description Job Queue The qualified name of the job queue or queues.   Library The library in which the specified job queue resides. The job queue entry sequence number. The subsystem uses this number to Sequence determine the order in which job queues are processed. Subsystem The name of the subsystem that can receive jobs from this job queue. The status of the job queue. The status may be one of the following values: Status RELEASED - The job queue is released.HELD - The job queue is held.Object Size (KB) The object size information of the job queue object in kilobytes. Number of Jobs The current number of jobs in the job queue. Current Active The current number of active jobs that came through this job queue entry. Monitored Out Queue(s) Out Queue''s can be added to monitor by clicking on the ''Add Queue(s) to Monitor'' link. Parameters Description Out Queue The qualified name of the output queue. Library The library in which the specified job queue resides. Sequence The order of spooled files on this output queue. The status of the output queue. The status may be one of the following values: Status  RELEASED - The job queue is released. HELD - The job queue is held. Object Size (KB) The object size information of the out-queue object in kilobytes. Number of Files The number of spooled files that exist on the output queue. Writer The name of the spooling writer for which information is to be displayed. The status of the spooling writer. The status may be one of the following values: Started Ended Writer Status On job queue Held Message waiting Printer The system name of the printer device to which the output is sent. Out Queue''s can be added to monitoring by clicking on ''Add Queue(s) to Monitor'' link , from the pop up we can select the available out queues (Queues with TYPE *OUTQ) to monitor. User can search and fetch available data queue''s from IBM i server or from data base if available (we will store the queue info which are fetched from IBM i server for the first time in our db). Admin System Value List Parameters Description Displays some of the key attributes on which certain actions can be performed. System Value List You will be able to execute Non-interactive commandsfrom Applications Manager and also will be able to edit any of the System Value list attributes. Message and Logging,Network Displays a pop-up window with the parameter details for a particular monitor. Attributes,Date and You can view parameters like Name, Value and Description. You can edit the Time,System Control,Library System Values by clicking on the respective icon in the edit column. List,Storage,Allocation,Security Some of the key attributes on which certain actions can be performed are as Tools given below You can execute non-interactive commands from Applications Manager. Enter Non-Interactive Command the Command in the text box in the pop up window and click on Execute. Displays the job log for any job if you enter the job name, user, job number of Job Log the required job in the respective text boxes.  Displays a pop-up window with the Product list parameter details for a Product List particular monitor. You can view parameters like Product ID, Product options and Description. Lists User list with details like User Name , Description, Status, Group profile User List Name, Limit Capabilities, Storage Allocated in Bytes, Storage occupied by this user''s owned objects in bytes and Number of days left for password expiration.Note: Error Message: [ibm][db2][jcc][10109][10354] The version of the IBM Universal JDBC driver in use is not licensed for connectivity to QDB2 databases. The above error occurs when adding DB2 7.1 installed over Z/OS and to fix it, need to copy the db2jcc_license_cisuz.jar file from your DB2 installation. Troubleshooting: For troubleshooting tips, go to our Support Portal. Virtualization Server virtualization is one of the highest impact trends in the IT industry today with proven cost savings and other benefits. It is basically a method of running multiple independent virtual operating systems on a single physical computer. It is a way of maximizing physical resources to maximize the investment in hardware. Applications Manager''s monitoring capabilities enables you to ensure your virtual infrastructure is performing as expected. Applications Manager enables high performance business process management by detecting and diagnosing problems of virtualization infrastructure faster. Applications Manager supports the following virtual systems: VMWare ESX/ESXi Servers Hyper-V Servers Citrix Hypervisor (XenServer) VMware Horizon View XenApp Docker Red Hat Virtualization (RHV) Server Kernel-based Virtual Machine (KVM) Oracle Virtual Machine (OVM) OpenShift Kubernetes Citrix Virtual Apps and Desktops Oracle VM Manager Servers OVM - Overview Creating a new OVM Monitor Group User Permissions Monitored Parameters OVM - Overview Oracle VM (OVM) is a platform that provides a fully equipped environment with all the latest benefits of virtualization technology. Oracle VM enables us to deploy operating systems and application software within a supported virtualization environment. Oracle VM insulates users and administrators from the underlying virtualization technology and allows daily operations to be conducted using goal-oriented GUI interfaces. Applications manager can discover your entire Oracle VM Virtual Infrastructure and its components through Oracle VM Manager. The Oracle VM Virtual Infrastructure group allows you to discover virtual resources and categorize them into server pools, Oracle VM Server, Storage, Repository, etc. Creating a new Oracle VM Monitor Group Supported Versions: Oracle VM Version 3.4.6 and above. Click on the New Monitor Group link. Select Oracle VM Virtual Infrastructure under Monitor Group listing. Specify the Display Name of the Oracle VM Manager. Enter the Host Name or the IP Address of the host where the Oracle VM Manager is running.Enter the Port where the server is running. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. Select the VM Discovery option. The available options are Do not discover, Discover VM but do not monitor metrics, and Discover and Monitor VM metrics. Specify the Polling Interval in minutes. Enter the Timeout value in seconds. If you are adding a new monitor from an Admin Server, select a Managed Server. Click on the Fetch OracleVM Servers button. This discovers the Oracle VM servers from the network and starts monitoring it. User Permissions We recommend to use the admin privilege account to monitor the Oracle VM Virtual Infrastructure. Monitored Parameters Oracle VM Virtual Infrastructure groups will be listed among monitor groups and can be accessed from the ''Monitor Group'' view under the Monitors tab. Within the Oracle VM Virtual Infrastructure group, Summary tab provides an overall view of the components of the Oracle VM Virtual Infrastructure and their health status. It shows you the number of Server Pools, Storage, Repository, Oracle VM Servers, VMs present in the Oracle VM Virtual Infrastructure. Business View tab allows you to configure business views that help you visualize the inter dependencies between your Oracle VM virtual infrastructure as well as view their health status. Dashboards tab lets you create your own custom pages by adding widgets into your dashboards. By using the Custom Dashboards feature, you can create dashboards of your choice - like Status View of all the Databases, Status view of all Web Applications deployed in the Tomcat Server, etc. If you create a dashboard as a template, the same dashboard can be reused across various Monitor Groups. Below are the list of parameters that are monitored in the Summary tab: Server Pool Storage Repository Server Pool Server pools logically organize one or more Oracle VM Servers into groups where virtual machines can run. Each server pool can have up to 32 physical servers. Each Oracle VM Server can be a member of only one server pool. The server pool is the operational unit of Oracle VM. This section provides details about server pools and their corresponding servers associated with the Oracle VM Virtual Infrastructure. Parameter Description Server Pool Details Name The name of the server pool. Health The health status of the server pool. Availability The availability status of the server pool. Server Count The number of servers available in the server pool. VMs Count The number of virtual machines available in the server pool. Oracle VM Server Details Server Name The name of the Oracle VM server. Server Pool The name of the server pool to which the Oracle VM Server belongs. Health The health status of the Oracle VM Server. Availability The availability status of the Oracle VM Server. CPU Utilization (%) The amount of CPU currently being used by the server. (%) Memory Utilization (%) The amount of memory currently being used by the server. (%)Storage A File Server is used to serve File System-based storage made available to the environment. A File Server can serve File Systems of the following types: Network - A File System where directories and files are shared with others over a network. Cluster - A File System which is shared by being simultaneously mounted on multiple servers. Local - A File System where the devices are locally attached and they are not shared with other servers. This section provides details about storage and file systems associated with the Oracle VM Virtual Infrastructure. Parameter Description Storage Details Storage Name The name of the file server. Type The type of the file server. FileSystem Count The number of file systems available in the file server. Health The health status of the file server. FileSystem Details FileSystem Name The name of the file system. Storage The name of the file server to which the file system belongs. Capacity (GB) The total amount of memory allocated to this file system. Used (GB) The amount of memory used by the file system. Free (GB) The remaining amount of memory available in the file system. Utilization (%) The percentage of memory used by the resources in the file system. Health The health status of the file system. Repository A repository is a file system that is logically structured in a particular way so that different resources can be located easily and made available for creating, cloning or running virtual machines. This section provides details about repositories associated with the Oracle VM Virtual Infrastructure. Parameter Description Repository Details Repository Name The name of the repository which is used to store the virtual machine resources. FileSystem ID The ID of the file system which is present in the repository. FileSystem Path The path of the file system in which it is mounted. Oracle VM Server Monitoring OVM - Overview Monitored Parameters OVM - Overview Oracle VM (OVM) is a self-contained virtualization environment powered and designed by Oracle to provide a lightweight, secure, server-based platform for running virtual machines. ManageEngine Applications Manager provides comprehensive performance metrics to monitor your Oracle VM servers and their guest virtual machines, and helps you ensure they are performing well at all times. Applications Manager connects with Oracle VM servers through standard APIs and determines the health status as well as the performance of the host servers and their corresponding virtual machines. It provides a single console to monitor physical, virtual and cloud components of your IT infrastructure. Monitored ParametersGo to the Monitors Category view by clicking the Monitors tab. Click on Oracle VM Server under the Virtualization table. Displayed is the Oracle VM server bulk configuration view distributed into three tabs: Availability tab gives the Availability history of the Oracle VM server in the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days, some key performance indicators of the Oracle VM server such as CPU Utilization and Memory Utilization along with heat charts for these attributes. List view enables you to perform bulk admin configurations and displays all the Oracle VM servers along with an overall idea of their availability and health status.  Click on the monitor listed in the Availability tab to view detailed performance metrics of the OVM server. These metrics are categorized into four different tabs for easy understanding.  Overview Network Disk Configuration Overview This tab provides a high-level overview of the performance and availability of the OVM server. Parameter Description CPU & Memory Utilization CPU Utilization The amount of CPU currently being used by the server. (%) Memory Utilization The amount of memory currently being used by the server. (%) Total Memory The total amount of memory allocated to the server. (GB) Used Memory The amount of memory used by the server. (GB) Free Memory The remaining amount of memory available for the server. (GB) Disk & Network Usage Read Bytes The number of bytes read from the disk by the server. (MB/Min) Write Bytes The number of bytes written to the disk by the server. (MB/Min) Bytes Received The number of bytes received over the network interface by the server.(MB/Min) Bytes Transmitted The number of bytes sent over the network interface by the server. (MB/Min) Virtual Machines VM Name The name of the virtual machine (VM) present in the OVM server. Availability Denotes the availability of the VM - available or not available. State The current state of the VM. Memory Utilization The memory utilization of the VM. (%) CPU Utilization The CPU utilization of the VM. (%) Health The health status of the VM. (Critical, Warning, and Clear) Network This tab provides details about the network interface of the Oracle VM server. Parameter Description Interface name The name of the network interface associated with the Ethernet port. Status The status of the network interface. MAC Address The Media Access Control (MAC) address of the Ethernet port. Network The name of the network with which the Ethernet port is associated. Maximum Transmission Unit The Maximum Transmission Unit (MTU) associated with the Ethernet Port. IP Address The IP address of the network interface associated with the Ethernet port.Disk This tab provides details about the physical disk storage available in the Oracle VM server. Parameter Description Name The name of the physical storage device (LUN). ID The ID value of the physical storage device (LUN). Size The size of the physical storage device. (GB) Volume Group The name of the volume group that contains the physical storage device. SAN Server The name of the storage array that owns the physical storage device. Type The type of the physical storage device. Storage Plugin Name The name of the storage plugin which is responsible for managing storage arrays. Configuration This tab provides configuration details of the Oracle VM Server.  Parameter Description Configuration Details Server Name The name of the Oracle VM server. IP Address The IP Address of the Oracle VM server. Server ID The Universally Unique Identifier (UUID) of the Oracle VM server. Maintenance Mode Indicates whether the server is currently in maintenance mode. (True or False) Run State The current state of the server. OVM Version The version of the Oracle VM server. Hypervisor Type The type of the hypervisor. Ethernet Ports The number of Ethernet ports available. Processor Details Type Type of the CPU. CPU Speed Speed of the CPU. CPU Cores The number of cores available for the CPU. Number of CPU Sockets The number of sockets available for the CPU. Cores Per Socket The number of cores available per socket. Threads Per Core The number of threads available per core. Control Domain Details Control Domain Name The name of the control domain. OS Name The name of the operating system. OS Type The type of the operating system. Memory The size of the control domain memory. (GB) Oracle VM Server Monitoring - Virtual Machines The virtual machines (VMs) present in an Oracle VM (OVM) server are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the VMs. You can also configure thresholds to the numerical attributes of the VMs based on these details.  The Availability tab lists all the virtual machines present in the OVM servers and their availability status. You can also view Availability history of the virtual machines for the past 24 hours or 30 days. The Performance tab shows some key performance indicators of the virtual machine including CPU Utilization, Memory Utilization, Disk I/O Utilization and Network Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days.  The List view displays all the virtual machines discovered under each OVM server. This view provides an overall idea of the availability and health of all the virtual machines. The list view also enables you to perform bulk admin configurations. Click on the individual virtual machines listed to view detailed VM metrics. The Top Virtual Machines tab shows graphs for the top CPU consumers, top memory consumers, top disk I/O consumers, and top network consumers of the OVM server. This section enables you to find out which virtual machines are consuming your server resources and take action accordingly.  Click on the individual monitors listed in the Availability tab to view detailed performance metrics of the corresponding virtual machine. These metrics are categorized into four separate tabs for easy understanding. Overview Disk Network Configuration Overview  This tab provides a high-level overview of virtual machines running under OVM servers.  Parameter Description CPU & Memory Utilization CPU Utilization The amount of CPU currently being used by the virtual machine. (%) Memory Utilization The amount of memory currently being used by the virtual machine. (%) Total Memory The total amount of memory allocated to the virtual machine. (GB) Used Memory The amount of memory used by the virtual machine. (GB) Free Memory The remaining amount of memory available for the virtual machine. (GB) Disk & Network Usage Read Bytes The number of bytes read from the disk by the virtual machine. (MB/Min) Write Bytes The number of bytes written to the disk by the virtual machine. (MB/Min) Bytes Received The number of bytes sent over the network interface by the virtual machine. (MB/Min) Bytes Transmitted The number of bytes received over the network interface by the virtual machine. (MB/Min) Disk This tab provides details about disk storage of virtual machines running under Oracle VM Servers. Parameter Description Name The name of the virtual disk used by the virtual machine. Type The type of the virtual disk used by the virtual machine. Size The size of the virtual disk used by the virtual machine. (GB) Repository The name of the repository used by the virtual machine. Absolute Path The absolute path of the image file that represents the virtual disk. Mounted Path The mounted path of the file that represents the virtual disk. Network This tab provides details about network interface of virtual machines running under Oracle VM servers. Parameter Description Name The name of Network Interface Card (NIC) used by the virtual machine. The Media Access Control (MAC) address of the virtual Network Interface Card (NIC) used by the MAC Address virtual machine. Ethernet The IP address of the Ethernet network of the virtual Network Interface Card (NIC) used by the Network virtual machine. Configuration This tab provides the configuration details of virtual machines running under Oracle VM servers.  Parameter DescriptionHost Name The host name of the virtual machine. ID The Universally Unique Identifier (UUID) of the virtual machine. IP Address The IP address of the virtual machine. OS Type The name of the operating system installed on the virtual machine. State The current state of the virtual machine. Total CPU(s) The number of CPUs assigned to the virtual machine. Kernel-based Virtual Machine Monitoring KVM - Overview Prerequisites Creating a new KVM Monitor User Permissions Monitored Parameters KVM - Overview Kernel-based Virtual Machine (KVM) technology is built into Linux kernel. It turns the Linux kernel into a hypervisor to run multiple guest virtual machines. Applications Manager collects performance metrics from KVM host and guest virtual machines to be monitored. It uses CLI commands to report the real-time resource usage of the host and their guest virtual machines.  Prerequisites The libvirt package should be installed on the KVM host. Enable root user privileges for the KVM host. Install balloon driver on Windows virtual machines for collecting its memory statistics. Install qemu-agent on virtual machines to get its IP Address. Creating a new KVM Monitor Supported Versions: QEMU Version 2.5.0 and above.   Using the REST API to add a new KVM monitor: Click here Click on the New Monitor link. Select KVM under Virtualization category. Specify the Display Name of the KVM server. Enter the Host Name or the IP Address of the host where the KVM server is running. Select the Mode of Monitoring (Telnet / SSH) If Telnet, provide the port number (default is 23) along with the user name and password information of the server. If SSH, provide the port number (default is 22) along with the user name and password information of the server. You have an option to enable Public Key Authentication where you have to enter the User name and Private Key information. Additionally, you can enter a Passphrase if the private key is protected by one. Enter the Port where the server is running. Select the VM Discovery option. The available options are Do not discover, Discover VM but do not monitor metrics, and Discover and Monitor VM metrics. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the KVM server from the Select the Monitor Group combo box (optional). You can choose multiple groups to associate your monitor. Click on the Add Monitor(s) button. This discovers the KVM server from the network and starts monitoring it.  User Permissions We recommend to use the root account to monitor the KVM server.Monitored Parameters Go to the Monitors Category view by clicking the Monitors tab. Click on KVM under the Virtualization Table. Displayed is the KVM bulk configuration view distributed into three tabs: Availability tab gives the availability history of the KVM server in the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days, some key performance indicators of the KVM server such as CPU Utilization and Memory Utilization along with heat charts for these attributes. List view enables you to perform bulk admin configurations and displays all the KVM servers along with an overall idea of their availability and health status.  KVM servers are monitored by keeping an eye on the parameters or the attributes listed below. These attributes provide information about the functioning of the monitors of the KVM server. In addition, you can configure thresholds to the numerical attributes monitored by the server based on these details. Click on the monitor listed in the Availability tab to view detailed performance metrics of the KVM server. These metrics are categorized into five different tabs for easy understanding. Below is an explanation of the metrics shown in these tabs: Overview CPU Network Storage Configuration Overview This tab provides a high-level overview of the performance and availability of the KVM server. Parameter Description CPU Utilization CPU Utilization The current CPU Utilization value of the KVM server. (%) User The time taken by the CPU to execute user commands. (%) System The time taken by the CPU to execute kernel commands. (%) Idle The amount of time the CPU is in idle state.(%) I/O Wait The amount of time the CPU is waiting for I/O device. (%) Memory Utilization Memory Utilization The amount of memory consumed across the system. (%) Total Physical Memory The total amount of memory allocated to the KVM server. (GB) Used Physical Memory The amount of memory used by the KVM server. (GB) Free Physical Memory The remaining amount of memory available for the KVM server. (GB) Buffer Memory The amount of memory available on buffer in the KVM server. (GB) Cache Memory The amount of memory used for cache by the KVM server. (GB) Virtual Machine VM Name The name of the virtual machine (VM) present in the KVM server. Availability Denotes the availability of the VM - available or not available. State The current status of the VM.  Memory Utilization The memory utilization of the VM. (%) CPU Utilization The CPU utilization of the VM. (%) Health The health status of this VM. (Critical, Warning, and Clear)By clicking over the VM Name, you will be redirected to the KVM virtual machine monitoring dashboard. CPU This tab provides details about CPU usage statistics of the cores. Parameter Description CPU Details CPU The name of the CPU core. CPU Utilization The value of CPU utilization of that core. (%) User The time taken to execute user commands. (%) System The time taken to execute kernel commands. (%) Idle The amount of time the CPU is in an idle state.(%) I/O Wait  The amount of time the CPU is waiting for I/O device. (%) Network This tab provides details about the network utilization of the KVM server. Parameter Description Network Details Network Name The name of the virtual network. State The current status of the virtual network. (Active or Inactive) Determines whether the virtual network is automatically started during guest VM''s boot time Autostart or not. (Yes or No) Network Interface Interface Name The name of the Network Interface Card (NIC). State The status of the NIC. (Active or Inactive) MAC Address The value of the Media Access Control (MAC) address for this NIC.  Bytes Received The rate at which this NIC receives data. (MB/Sec) Bytes The rate at which this NIC transfers data. (MB/Sec) Transmitted Packets The number of packets received by the interface. Received Packets The number of packets transferred by the interface. Transmitted Storage This tab provides metrics about the storage pools and volumes. Parameter Description Storage Pools Pool Name The name of the storage pool. UUID The value of Universal Unique Identifier of the storage pool. State The current status of the storage pool.  Capacity The total capacity of the storage pool. (GB) Used Space The amount of space utilized in this storage pool. (GB) Free Space The remaining amount of space available in this storage pool. (GB)Autostart Indicates whether this pool is automatically started during boot time or not. (Yes or No) Storage Volumes Volume Name The name of the storage volume. Path The absolute path where the storage volume is mounted. Type The type of the storage volume. Pool Name The name of the storage pool. Capacity The total capacity of this storage volume. (GB) Used Space The amount of space utilized in this storage volume. (GB) Free Space The remaining amount of space available in this storage volume. (GB) Configuration This tab provides the configuration details of the KVM server. Parameter Description Host Name The name of the hypervisor host. Host OS The name of the operating system installed in the KVM server. Libvirt Version The version of the Libvirt library. Hypervisor Version The version of the hypervisor. CPU Model Information about the overall CPU. CPU Frequency The overall CPU capacity. (MHz) CPU(s) The number of CPU cores. CPU Sockets The number of CPU sockets. Cores Per Socket The number of cores per socket. Threads Per Core The number of threads per core.  KVM Server - Virtual Machines The virtual machines (VMs) present in a KVM server are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the VMs. You can also configure thresholds to the numerical attributes of the VMs based on these details.  Availability tab lists all the virtual machines present in the KVM servers and their availability status. You can also view Availability history of the virtual machines for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the virtual machine including CPU Utilization, Memory Utilization, Disk I/O Utilization and Network Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days.  List view displays all the virtual machines discovered under each KVM server. This view provides an overall idea of the availability and health of all the virtual machines. The list view also enables you to perform bulk admin configurations. Click on the individual virtual machines listed to view detailed VM metrics.  Top Virtual Machines tab shows graphs for the top CPU consumers, top memory consumers, top disk I/O consumers, and top network consumers of the KVM server. This section enables you to find out which virtual machines are consuming your server resources and take action accordingly.  Click on the individual monitors listed in the Availability tab to view detailed performance metrics of the corresponding virtual machine. Below is an explanation of the metrics categorized into five separate tabs: Overview Memory Disk NetworkConfiguration Overview  This tab provides a high-level overview of virtual machines running under KVM servers.  Parameter Description CPU Utilization CPU Utilization The current CPU utilization value on the virtual machine. (%) User The time taken to execute user commands. (%) System The time taken to execute kernel commands. (%) Memory Utilization Memory Utilization The amount of memory consumed by the virtual machine. (%) Used Memory The amount of memory used by the virtual machine. (GB) Free Memory The remaining amount of memory available for the virtual machine. (GB) Total Memory The total amount of memory allocated to the virtual machine. (GB) Memory  This tab provides details about the memory utilization of virtual machines running under KVM servers.  Parameter Description Ballooned The amount of balloon memory allocated to the virtual machine. (GB) Memory Read from Swap The amount of data read from swap. (GB) Write into Swap The amount of memory written into swap. (GB) Disk I/O Fault The number of page faults where Disk I/O was required. Count Page Fault Count The number of other page faults. The amount of memory allocated for Resident Set Size (RSS) of the running virtual machine''s RSS Memory process. (GB) Disk This tab provides details about disk utilization of virtual machines running under KVM servers.  Parameter Description Disk Details Name The name of the device block available in virtual machine. Source The path of the device block where it is mounted. Capacity The total amount of space allocated in this device block. (GB) Used The amount of memory utilized from this block by the virtual machine. (GB) Free The remaining amount of memory available for use in this block. (GB) Used Space The amount of memory used from this block by the virtual machine. (%) Free Space The remaining amount of memory available for use in this block. (%) Disk I/O Details Name The name of the device block available in virtual machine. Read Operations The number of read operations taking place in the virtual machine. Time taken to Read The amount of time taken for the read operation to execute. (Sec) Write Operations The number of write operations taking place in the virtual machine. Time taken to Write The amount of time taken for the write operation to execute. (Sec) Bytes Received The rate at which the data is received. (MB/Sec) Bytes Transmitted The rate at which the data is transmitted. (MB/Sec)Disk Block Details Name The name of the device block available in virtual machine. Block Capacity Total block device size for each block-device (Eg: vda, vdb, vdc, etc.) of a domain (in GB). Block Used Amount of block size used for each block-device of a domain (in GB). Block Free Remaining amount of block size available for each block-device of a domain (in GB). Block Used Space Amount of block size used for each block-device of a domain (in %). Block Free Space Remaining amount of block size available for each block-device of a domain (in %). Note: The metrics in this tab will be shown only if the root user privileges are enabled in the KVM host server. Network This tab provides details about network utilization of virtual machines running under KVM servers. Parameter Description Network Interfaces Name The name of the virtual network. Type The type of virtual network used to connect to the network interface. Source The source of the network interface through which the virtual network is connected. Model The model name of the network interface card (NIC). MAC Address The value of the Media Access Control (MAC) address for this NIC.  Network Interface Utilization Bytes Received The rate at which this NIC receives data. (MB/Sec) Bytes Transmitted The rate at which this NIC transfers data. (MB/Sec) Packets Received The number of packets received by the network interface. Packets Transmitted The number of packets transferred by the network interface. Configuration This tab provides the configuration details of virtual machines running under KVM servers.  Parameter Description ID The ID value of the virtual machine. Name The name of the virtual machine. IP Address The value of IP address of the virtual machine. UUID The value of Universal Unique Identifier of the virtual machine. OS Type The type of virtualization supported by this OS. Installed OS The name of the OS installed on this virtual machine. State The current status of the virtual machine. CPU(s) The number of CPUs allocated for the virtual machine. Autostart Indicates whether this pool is automatically started during boot time or not. (Enabled or Disabled) Red Hat Virtualization Server Monitoring RHV - Overview Creating a new RHV Monitor Group User Permissions Monitored Parameters RHV - Overview Red Hat Virtualization (RHV) is an open, software-defined platform that visualizes Linux and Microsoft Windows workloads. The RHV infrastructures are based on KVM hypervisor (Kernel-based Virtual Machine) and featuresmanagement tools that provides resources, processes, and applications to ensure service performance and business continuity. Applications Manager lets you perform precise hierarchical service topology mapping of all aspects of the RHEV hypervisor and RHEV guest VMs, where admins can set up a consistent monitoring system, control user experience and improve real-time performance of mission critical business services in the RHV cluster. Creating a new RHV Monitor Group Supported Versions: RHV 4.2 version and above. Using the REST API to add a new RHV monitor: Click here Click on the New Monitor Group link. Select RHEV Virtual Infrastructure under Monitor Group listing. Specify the Display Name of the RHV server. Enter the Host Name or the IP Address of the host where the RHV server is running. Enter the User Name and Password for authentication. Enter the Port where the server is running. Select the VM Discovery option. The available options are Do not discover, Discover VM but do not monitor metrics, and Discover and Monitor VM metrics. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the RHV server from the Select the Monitor Group combo box (optional). You can choose multiple groups to associate your monitor. Click on the Fetch Hosts button. This discovers the RHV server from the network and starts monitoring it. User Permissions We recommend to use the admin privilege account to monitor the RHV server. Monitored Parameters Go to the Monitors Category view by clicking the Monitors tab. Click on RHV under the Virtualization table. Displayed is the RHV bulk configuration view distributed into three tabs: Availability tab gives the Availability history of the RHV server in the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days, some key performance indicators of the RHV server such as CPU Utilization and Memory Utilization along with heat charts for these attributes. List view enables you to perform bulk admin configurations and displays all the RHV servers along with an overall idea of their availability and health status. RHV servers are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the monitors of the RHV server. In addition, you can configure thresholds to the numerical attributes monitored by the server based on these details. Click on the monitor listed to view detailed performance metrics of the RHV server. These metrics are categorized into four different tabs for easy understanding. Below is an explanation of the metrics shown in these tabs: Overview Memory Network Configuration Overview This tab provides a high-level overview of the performance and availability of the RHV server. Parameter Description CPU Utilization CPU Utilization The current CPU Utilization value of the RHV server. (%) User The amount of CPU used by the user. (%) System The amount of CPU used by the system. (%) Idle The amount of CPU in idle state. (%)Memory Utilization Memory Utilization The amount of memory used across the system. (%) Total Memory The total amount of memory allocated to the RHV server. (GB) Used Memory The amount of memory used by the RHV server. (GB) Free Memory The remaining amount of memory available on the RHV server. (GB) Buffered Memory The amount of memory available on buffer in the RHV server. (GB) Shared Memory The amount of memory shared in the RHV server. (GB) Virtual Machine Name The name of the virtual machine (VM) present in the RHV server. Availability Denotes the availability of the VM - available or not available. State The current status of the VM. (UP or DOWN) Memory Utilization The memory utilization of the VM. (%) CPU Utilization The CPU utilization of the VM. (%) Health The health status of this VM. (Critical, Warning, and Clear) Memory This tab provides details about the memory usage of the RHV server. Parameter Description Swap Utilization Swap Total Memory The total amount of swap memory allocated for the host in bytes. Swap Free Memory The remaining amount of swap memory available for the host in bytes. Swap Used Memory The amount of swap memory utilized by the host in bytes. Swap Cached Memory The amount of swap memory that is cached by the host. Network This tab provides details about the network utilization of the RHV server. Parameter Description Network Details Name The name of the virtual network. Status The current status of the virtual network. (UP or DOWN) Speed The speed of the network. (Mbps) Data Received The amount of data received by this network. (MB) Data Transmitted The amount of data transmitted from this network. (MB) Data Receive Rate The rate at which this network receives data. (KBps) Data Transmitted Rate The rate at which this network transmits data. (KBps) Received Errors The number of errors occurred when the data is received by the network. Transmitted Errors The number of errors occurred when the data is transmitted from the network. Configuration This tab provides the configuration details of the RHV server. Parameter Description CPU Details CPU Model The model name of the CPU. CPU Cores The number of CPU cores available. CPU Sockets The number of sockets available for the CPU. CPU Threads The number of threads available for the CPU.Number of CPUs The total number of CPUs available. Speed (Mhz) The speed of the CPU. (Mhz) Configuration Details Host Name The name of the RHV hypervisor host. Status The status of the RHV host server. OS Name The name of the operating system installed in the RHV server. Version The version of the OS used by the RHV host. IP Address The IP Address of the RHV host server. Vendor Name The vendor name of the hardware. Hardware Family The product name of the hardware. Hardware Model The model name of the hardware. Libvirt Version The version of the Libvirt library. KSM Enabled Shows if KSM is enabled by the host or not. Power Management Shows if Power Management is enabled by the host or not. UUID The value of Universal Unique Identifier of the host. Number of VMs The number of virtual machines available in the RHV host. Red Hat Virtualization Server - Virtual Machines Monitored Parameters The virtual machines (VMs) present in a RHV server are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the VMs. You can also configure thresholds to the numerical attributes of the VMs based on these details.  The Availability tab lists all the virtual machines present in the RHV servers and their availability status. You can also view Availability history of the virtual machines for the past 24 hours or 30 days. The Performance tab shows some key performance indicators of the virtual machine including CPU Utilization, Memory Utilization, Disk I/O Utilization and Network Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days.  The List view displays all the virtual machines discovered under each RHV server. This view provides an overall idea of the availability and health of all the virtual machines. The list view also enables you to perform bulk admin configurations. Click on the individual virtual machines listed to view detailed VM metrics.  The Top Virtual Machines tab shows graphs for the top CPU consumers, top memory consumers, top disk I/O consumers, and top network consumers of the RHV server. This section enables you to find out which virtual machines are consuming your server resources and take action accordingly.  Click on the individual monitors listed in the Availability tab to view detailed performance metrics of the corresponding virtual machine. These metrics are categorized into five separate tabs for easy understanding. Below is an explanation of the metrics shown in these tabs: Overview Memory Network Disk I/O Configuration Overview  This tab provides a high-level overview of virtual machines running under RHV servers.  Parameter Description CPU & Memory Utilization CPU Utilization The current CPU utilization value on the virtual machine. (%) Memory Utilization The amount of memory consumed by the virtual machine. (%) Memory This tab provides details about the memory utilization of virtual machines running under RHV servers.  Parameter Description Used Memory The amount of memory consumed by the virtual machine. (GB) Buffered Memory The amount of memory buffered by the virtual machine. (GB) Total Memory The total amount of memory available for the virtual machine. (GB) Free Memory The remaining amount of memory available for the virtual machine. (GB) Configured Memory The amount of memory configured or allocated for the virtual machine. (GB) Swap Cached Memory The amount of swap memory that is cached by the virtual machine. (GB) Network This tab provides details about network utilization of virtual machines running under RHV servers. Parameter Description Network Details Name The name of the network interface. Data Received Rate The rate at which the network receives data. (KBps) Data Transmitted Rate The rate at which the network transmits data. (KBps) Data Received The amount of data received by the network. (Kb) Data Transmitted The amount of data transmitted from the network. (Kb) Received Errors The number of errors occurred when the data is received by the network. Transmit Errors The number of errors occurred when the data is transmitted from the network. Disk I/O This tab provides details about disk I/O of virtual machines running under RHV servers.  Parameter Description Disk Details Disk ID The value of LUN ID for the disk.  Disk Read Rate The rate at which the data is read from the disk. (KBps) Disk Write Rate The rate at which the data is written to the disk. (KBps) Read Latency The amount of time taken by the disk to read data. (Sec) Write Latency The amount of time taken by the disk to write data. (Sec) Flush Latency The amount of time taken by the disk to flush data. (Sec) Configuration This tab provides the configuration details of virtual machines running under RHV servers.  Parameter Description UUID The value of Universal Unique Identifier of the virtual machine. OS Name The name of the OS installed on this virtual machine. Status The current status of the virtual machine. (UP or DOWN) IP Address The value of IP address of the virtual machine. Host Name The host name of the virtual machine. Boot Time The latest boot time of the virtual machine. CPU Cores The number of CPU cores available. CPU Sockets The number of sockets available for the CPU. CPU Threads The number of threads available for the CPU. VMware ESX/ESXi Server MonitoringVMware ESX/ESXi Server - An Overview Adding a new VMware ESX/ESXi Server Monitor User Permissions Monitored Parameters FAQ VMware ESX/ESXi Server Monitoring - An Overview ManageEngine Applications Manager provides comprehensive performance metrics to monitor your VMware ESX/ESXi servers and their guest virtual machines, and helps you ensure they are performing well at all times. Applications Manager connects with VMware ESX/ESXi servers through standard APIs and determines the health status as well as the performance of the host servers and their corresponding virtual machines. It provides a single console to monitor physical, virtual and cloud components of your IT infrastructure. Creating a new monitor Supported Versions: ESX 3.5 and above; ESXi 3 and above. Using the REST API to add a new VMware ESXi monitor: Click here Follow the steps given below to create a new VMware ESX/ESXi server monitor: Click on New Monitor link. Select VMware ESX/ESXi under Virtualization category. Specify the Display Name of the VMware ESX server Enter the Host Name or IP Address of the host where the VMware server is running. Enter the Port where the server is running. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Select the VM Discovery option based on which the virtual machines should be discovered and monitored. The available options are Do not discover, Discover VM but do not monitor metrics, and Discover and Monitor VM metrics. For Discover VM but do not monitor metrics and Discover and Monitor VM metrics options, you can also specify the Discovery Filter Regex based on which the virtual machines are to be discovered and monitored. Learn more Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group with which you want to associate the VMware ESX server to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the VMware ESX/ESXi server from the network and starts monitoring it. User Permissions In order to add VMWare ESX/ESXi servers for monitoring, we recommend to use the root account. However, in case you are unable to use the root account, you can use a ''view-only'' profile to add the servers. This profile has enough rights to be used for monitoring. The user you create must be: a member of the group user based on the profile ''read only'' Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on VMware ESX/ESXi under the Virtualization Table. Displayed is the VMware ESX/ESXi bulk configuration view distributed into three tabs: Availability tab gives the Availability history of the ESX server in the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days,some key performance indicators of the ESX server such as CPU Utilization, Memory Utilization, Disk Usage and Network Usage along with heat charts for these attributes. List view enables you to perform bulk admin configurations and displays all the VMware ESX/ESXi servers along with an overall idea of their availability and health status. Top ESX/ESXi tab shows graphs for the top CPU consumers, top memory consumers, top disk I/O consumers and top network consumers of the ESX/ESXi server.Infrastructure View tab displays all the virtual machines discovered under each ESX/ESXi server. This view provides an overall idea of the availability, health, CPU (%), Memory (%), Disk I/O and Network traffic of all the virtual machines. Click on the individual virtual machines listed to view detailed VM metrics. VMware ESX servers are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the monitors of VMware ESX server. You can also configure thresholds to the numerical attributes monitored by the server based on these details. Click on the monitor listed in the Availability tab to view detailed performance metrics of the ESX/ESXi server. These metrics are categorized into 9 different tabs for easy understanding. Below is an explanation of the metrics shown in these tabs: Overview CPU Memory Datastore Network Disk I/O Hardware Storage Replication Event Log Configuration Overview This tab provides a high-level overview of the ESX/ESXi server as well as its resource utilization. Parameter Description Monitor Information Name The name of VMware ESX/ESXi server monitor Type Denotes the type of servers you are monitoring. Health Denotes the health (Clear, Warning, Critical) status of the ESX/ESXi server. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the server - available or not available. CPU & Memory Utilization CPU Utilization The current CPU Utilization value of the ESXi host (in %). CPU Idle Time The average time that the CPU cores remain in an idle state (in ms). CPU Usage The total CPU usage across the system (in MHz). The average value of CPU Utilization of all the cores combined across the system CPU Utilization of Cores (in %). Memory Utilization Amount of memory utilized across the system (in %). Disk & Network Usage Disk Usage Disk usage of ESX/ESXi server (in KBps). Network Usage Network usage of ESX/ESXi server (in KBps). Virtual Machines VM Name Name of the virtual machine (VM) present in the host Availability Denotes the availability of the VM - available or not available CPU Utilization The CPU utilization of this VM in percentage Memory Utilization The memory utilization of this VM in percentage Disk I/O Utilization The disk input/output utilization of this VM (in KBps). Network Utilization The network usage of this VM (in KBps). Health The health status (Clear, Warning, Critical) of this VMCPU This tab provides metrics about CPU Utilization details of the cores. Parameter Description CPU Utilization The cpu utilization of the CPU core over a period of time(in percentage) Health The overall health of the CPU core CPU Idle Time The total time that each CPU core remains in an idle state (in ms). Memory This tab provides metrics about memory utilization of the ESX server. Parameter Description Consumed Memory The value of total memory minus free memory (in MB). Active Memory Amount of memory that is actively used Overhead Memory Sum of overhead memory across all VMs Amount of memory currently utilized to satisfy minimum memory values set for all Reserved Memory VMs. Shared Memory Amount of memory shared between virtual machines Granted Memory Amount of physical memory granted Swapped Memory Amount of memory that is swapped Heap Memory Amount of memory allocated for heap VMKernel Memory Amount of memory used by the VMKernel Datastore This tab displays metrics pertaining to the data stores of the server. Parameter Description Datastore Name of the datastore Type Type of datastore (Example: VMFS or VMware File System) Capacity GB The total space available in this datastore (in GB). Used GB The used space of this datastore (in GB). Free GB The free space of this datastore (in GB). Utilization % Percentage of used space in this datastore Free Space % Percentage of free space in this datastore Health Overall health of the datastore Read Rate The rate at which data is read from the datastore (in KBps). Write Rate The rate at which data is written to the datastore (in KBps). Read Latency The average time taken for a read from the datastore (in ms). Write Latency The average time taken for a write to the datastore (in ms). Note: The capacity, used and free metrics are not supported for NFS datastores. Important Note: In Applications Manager versions below 14790, if a datastore was used by multiple ESXi servers, then each ESXi server would add the same datastore and monitor it separately. From version 14790 onwards, existing datastore would be dropped and added automatically, and all associated ESXi servers would then be mapped to the single datastore instance. As a result, this would lead to data and alert configuration loss for existing datastores.However, history data can be obtained if proper backup is performed before upgrading Applications Manager. Network This tab provides metrics about network utilization Parameter Description Name Name of the Network Interface Card (NIC) of the host Data Receive Rate The rate at which this NIC receives data (in KBps). Data Transfer Rate The rate at which this NIC transfers data (in KBps). Packets received Number of network packets received by this NIC Packets Transmitted Number of network packets transmitted by this NIC Health Overall health of this NIC Disk I/O This tab shows detailed disk I/O (Input/Output) stats of the ESX/ESXi server Parameter Description LUN Logical unit number associated with the physical disk Disk Read Rate Disk read rate of this LUN (in KBps). Disk Write Rate Disk write rates of this LUN (in KBps). Disk Reads Number of reads to this LUN Disk Writes Number of writes to this LUN Health Overall health of this LUN The average amount of time taken during the collection interval to process a SCSI Read Latency read command issued from the Guest OS to the virtual machine (ms). Average amount of time taken during the collection interval to process a SCSI write Write Latency command issued by the Guest OS to the virtual machine (ms). Commands Aborted The number of SCSI commands aborted during the collection interval. Bus Resets The number of SCSI-bus reset commands issued during the collection interval. Hardware The folloiwng are metrics pertaining to the hardware of the server. Parameter Description Power Sensor Reading will be monitored (in Watts). Fan Sensor Reading will be monitored (in percentage). Temperature Sensor Reading will be monitored (in Degree Celsius). Processors Health status of the sensor will be monitored. Memory Health status of the sensor will be monitored. If a component is functioning normally, the status indicator is green. The status indicator changes to orange or red if a system component violates a performance threshold or is not functioning properly. Generally, an orange indicator signifies degraded performance. A red indicator signifies that a component stopped operating or exceeded the highest threshold. If the status is blank, then the health monitoring service cannot determine the status of the component. The Reading column displays the current values for the sensors. For instance, the column displays watts consumed for System Board and degrees Celsius for temperature. StorageApplications Manager automatically maps VMware vSphere servers and their VMs to their underlying physical storage arrays. You can track the vSphere servers and their VMs to the datastores, to the host bus adapters and the actual physical storage. The Storage Mapping table displays a hierarchial map view containing the list of Virtual Machines, Datastores, Storage Arrays and corresponding LUN statistics associated with the ESXi host. Parameter Description STORAGE ADAPTERS Adapter Name  The  name of the Storage Adapter. Adapter Status The status of the Storage Adapter: Online, Offline, Fault, Unknown. Model The model of the storage adapter. Type The type of storager adapter. Driver The driver details of the storage adapter. Target Count The Target Count for that storage adapter. LUN Count The number of array LUNs on the host. Path Count The number of total storage paths on the server. Replication Parameter Description NETWORK TRAFFIC HBR Received Rate Outgoing host-based replication network traffic for this virtual machine or host (in kB/s). HBR Transmitted Rate Average amount of data transmitted per second in the host-based replication (in kB/s). Number of HBR Number of powered-on virtual machines running on this host that currently have host- Configured VMs based replication protection enabled. Event Log This tab shows a detailed Event List for monitoring of ESX Events. Parameter Description Event Name The name of the event. Description A description of the Event. Severity The severity of the log event. Generated Time The time at which the event is generated. Note: To configure new events, Click the Monitor Actions button in the right-hand corner of the page and in the drop-down menu, click Configure Events. Configuration This tab provides info on the ESX/ESXi server''s configuration details. Parameter Description Host Name The name of VMware ESX/ESXi server monitor The power status of the server. The values include poweredOn, poweredOff and Power standBy. Vendor Name The name of the vendor offering Virtualization (VMware) Version Version of ESX/ESXi server Hardware Vendor Name Hardware vendor identification Hardware Model System model identification CPU Model Information about the overall CPU CPU Capacity MHz The overall CPU capacity (in Mega Hertz) CPU Cores Number of CPU cores present in the server Logical Processors Number of Virtual Processors currently configured in the server. Number of VMs Number of virtual machines discovered in the serverNTP Configuration Indicates whether NTP feature is enabled or not in the ESXi server. NTP Status Indicates whether NTP service running or not in the ESXi server. Frequently Asked Questions (FAQ): 1. How can I check if the Managed Object Browser (MOB) service is enabled in the ESX host? Connect to the host using the ESXi Shell. Determine if the managed object browser (MOB) is enabled, by running the following command: vim-cmd proxysvc/service_list If the service is running, the following text appears in the list of services: ... serverNamespace = ''/mob'', accessMode = "httpsWithRedirect", pipeName = "/var/run/vmware/proxy-mod", ... If the service is not running, enable MOB service using the following command:vim-cmd proxysvc/add_np_service "/mob" httpsWithRedirect /var/run/vmware/proxy-mob To disable the MOB service, use the following command: vim-cmd proxysvc/remove_service "/mob" "httpsWithRedirect"   For ESXi 6.0 and above: The MOB service is disabled by default. So when you try to access the MOB url of ESX host, the output should look like this: You can enable MOB service from the VSphere client (or) ESXi shell.   From VSphere Client: Connect to the ESX host via VSphere client version 6. In the Configuration tab, go to Software and then Advanced Settings. Enable the Config.HostAgent.plugins.solo.enableMob check box and click ok.   From ESXi Shell: Connect to the host using the ESXi Shell. Check the ESXi Advanced Setting using vim-cmd as follows: vim-cmd hostsvc/advopt/view Config.HostAgent.plugins.solo.enableMob  The Output should look like this:   Configuring the ESXi Advanced Setting to true: vim-cmd hostsvc/advopt/update Config.HostAgent.plugins.solo.enableMob bool true 2. What is the MOB URL used to obtain the datastore details in the ESXi host? The MOB URL we use for obtaining the ESXi host datastore details is as follows: https:// : /mob/?moid=ha-folder-datastore where           ESXiHOST_IP          --->   IP address of the ESXi host server           ESXiHOST_PORT   --->   Port number of the ESXi host server After accessing this link, you''ll find a list of all the available datastores within the ESXi host under the ''value'' field of ''datastore'' name field. Select and click over the required datastore from the list in order to get the complete details of that particular datastore. VMware ESX/ESXi Server - Virtual Machines The virtual machines (VMs) present in a VMware ESX/ESXi server are monitored based on the parameters or the attributes listed below. These attributes provide information about the functioning of the VMs. You can also configure thresholds to the numerical attributes of the VMs based on these details. Availability tab lists all the virtual machines present in the ESX/ESXi servers and their availability status. You can also view Availability history of the virtual machines for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the virtual machine including CPU Utilization, Memory Utilization, Disk I/O Utilization and Network Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. List view tab displays all the virtual machines discovered under each ESX/ESXi server. This view provides an overall idea of the availability and health of all the virtual machines. The list view also enables you to perform bulk admin configurations. Top Virtual Machines tab shows graphs for the top CPU consumers, top memory consumers, top disk I/O consumers, and top network consumers of the ESX/ESXi server. This section enables you to find out which virtual machines are consuming your server resources and take action accordingly. Click on the individual monitors listed to view detailed performance metrics of the corresponding virtual machine. These metrics are categorized into 6 separate tabs for easy understanding. Below is an explanation of the metrics shown in these tabs: Overview Memory Datastore Network Disk ConfigurationOverview This tab provides a high-level overview of the virtual machine as well as its resource utilization. Parameter Description Monitor Information Name The name of the virtual machine Type Denotes the type you are monitoring. Health Denotes the health (Clear, Warning, Critical) status of the VM. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the VM - available or not available. CPU & Memory Utilization CPU The CPU Usage of the VM as percentage Utilization CPU Usage The CPU usage in Mega Hertz Memory The memory utilization of theVM in percentage Utilization The percentage of time that the virtual machine was ready, but could not be scheduled to run on CPU Ready the physical CPU (in ms). CPU Wait Total CPU time spent in wait state (in ms). Disk & Network Usage Disk I/O The disk input/output utilization of the VM (in KBps). Utilization Network The network usage of the VM (in KBps). Utilization Memory This tab shows metrics about the memory utilization of the virtual machine Parameter Description Amount of memory that is actively used, measured as recently touched pages (in Active Memory MB). Overhead Memory Amount of additional host memory allocated to the virtual machine. Swapped Memory Amount of memory that is swapped. Shared Memory Amount of memory that is shared between virtual machines. Ballooned Memory Amount of memory held by memory control for ballooning. Amount of physical memory granted. For hosts this can be represented as regions Granted Memory of memory for each virtual machine. Datastore Parameter Description Datastore Name of the datastore Type Type of datastore (Example: VMFS or VMware File System) Capacity GB The total space available in this datastore (in GB). Used GB The used space of this datastore (in GB). Free GB The free space of this datastore (in GB). Utilization % Percentage of used space in this datastore Free Space % Percentage of free space in this datastore Health Overall health of the datastore Read Rate Rate of reading data from the datastore (in KBps). Write Rate Rate of writing data to the datastore (in KBps).Read Latency The average time a read from the datastore takes (in ms). Write Latency The average time a write to the datastore takes (ms)   Important Note: In Applications Manager versions below 14790, if a datastore was used by multiple ESXi servers, then each ESXi server would add the same datastore and monitor it separately. From version 14790 onwards, existing datastore would be dropped and added automatically, and all associated ESXi servers would then be mapped to the single datastore instance. As a result, this would lead to data and alert configuration loss for existing datastores. However, history data can be obtained if proper backup is performed before upgrading Applications Manager. Network The metrics in this category contain the VM network status details. Parameter Description Network Interface Name Name of the Network Interface Card (NIC) IP Address The ip address of the NIC Mac Address The Mac address of the NIC Network The name of the network Health Indicates the health of the Network Interface Card Network Interface Utilization Name Name of the network inteface card(NIC) of the host Data Receive Rate The rate at which this NIC receives data (in KBps). Data Transmit Rate The rate at which this NIC transfers data (in KBps). Packets Received Number of network packets received by this NIC Packets Transmitted Number of network packets transmitted by this NIC Health Overall health of this NIC Disk This tab shows detailed disk stats of the virtual machine Parameter Description LUN Logical unit number associated with the physical disk Disk Read Rate Disk read rate of this LUN (in KBps). Disk Write Rate Disk write rate of this LUN (in KBps). Disk Reads Number of reads to this LUN during the defined interval Disk Writes Number of writes to this LUN during the defined interval Health Overall health of this LUN Commands Aborted Number of SCSI commands aborted during the collection interval Bus Resets Number of SCSI-bus reset commands issued during the collection interval Guest Disk Partitions Disk Partition Name of the partition Capacity Capacity of the Disk Partition (in GB). Free Free Space available in the Partition (in GB). Used Used Space in the Partition (in GB). Utilization % Percentage of used space in this datastore Free Space % Percentage of free space in this datastoreConfiguration Parameter Description UUID Universal Unique Identifier (UUID) assigned to the VM. OS Name Operating System assigned to the VM Power The status of the power of the virtual machine (poweredOn, poweredOff, suspend) Path name to the configuration file for the virtual machine, e.g. the .vmx file. This VM Path Name also implicitly defines the configuration directory. IP Address The IP address assigned to the VM Host Name The host on which the VM is running Boot time The time when the VM was booted. Tools Version Current version of VMware Tools running Number of CPUs Number of CPUs present in the VM Configured Memory The amount of memory configured for this VM Number of Virtual Disks The number of virtual disks in the VM VMware vCenter Servers Applications Manager can discover your entire VMware virtual infrastructure through the vCenter server. The VMware virtual infrastructure groups allows you to discover virtual resources and categorize them into components such as Data Center, Cluster, ESX/ESXi hosts, etc. Monitored Parameters VMware Virtual Infrastructure groups will be listed among monitor groups and can be accessed from the ''Monitor Group'' view under the Monitors tab. Within the VMware Virtual Infrastructure group, the Summary tab provides an overall view of the components of the VMware virtual infrastructure and their health status. It shows you the number of datacenters, clusters, resource pools, ESX hosts, VMs, datastores and network components present in the vCenter server. Data Centers The Summary tab displays the overall health status of the infrastructure present just below the vCenter server level. For example, if your vCenter has data centers configured, the ‘Summary’ tab will show the health status of the datacenters. You can drill down into a Data Center and view the health of its underlying components such as Clusters. If the health status of the Data Center turns critical, you can perform root cause analysis to troubleshoot the issue. Clusters Clusters are displayed one level below the Data Center view. As is the case with the Data Center view, you can drill down into a cluster and view the health of the underlying components such as ESX/ESXi hosts, VMs, etc. If the health of a cluster is found to be critical, you can perform root cause analysis to troubleshoot the issue. At the cluster level, you can also view the DRS migration report that shows the movement of virtual machines from one ESX host to another. Resource Pool In the next level, correlated performance metrics of the resource pool is displayed. You can monitor and manage your server’s current CPU/memory usage, reservation and allocation statistics. This data can be used to re-allocate or organize resources for the server or cluster accordingly. Summary The Summary tab also shows the following performance metrics at both data center and cluster levels: Parameter Description ESX/ESXi Host Details Name The name of VMware ESX/ESXi server monitor Datacenter The name of the Datacenter to which the ESX host belongs Cluster The name of the cluster to which the ESX host belongsCPU (%) The CPU utilization of the ESX/ESXi host (in %). Memory (%) The percentage of memory used across the ESX/ESXi host. Network (KBps) The network usage of the ESX/ESXi host (in KBps). Disk I/O (KBps) The disk usage of the ESX/ESXi host (in KBps). Cluster Details Cluster Name The name of the vCenter cluster Datacenter The datacenter to which this cluster belongs Effective memory resources (in MB) available to run virtual machines. This is the Effective CPU aggregated effective resource level from all running hosts. The number of physical CPU cores. Physical CPU cores are the processors CPU Cores contained by a CPU package. CPU Threads The aggregated number of CPU threads. Tolerated Failover Number of failures that can be tolerated by the VMware HA. Memory Utilization The percentage of memory used across the cluster. Consumed Memory The memory utilized so far (in MB). Total Memory The amount of memory used by this cluster Effective memory resources (in MB) available to run virtual machines. This is the Effective Memory aggregated effective resource level from all running hosts. Active Memory The amount of memory that is actively used measured (in Mhz). Swap Memory The amount of memory that is swapped. Resource Pool Details Overall CPU Usage The total amount of CPU resources utilized measured (in MHz). Maximum CPU Usage The maximum amount of CPU resources utilized measured (in MHz). CPU Reservation The amount of CPU resources reserved for a virtual machine measured (in Mhz). CPU Allocation Limit The amount of CPU resources allocated to a virtual machine measured (in Mhz). Overall Memory Usage The total amount of RAM being used by a virtual machine measured (in MB). The maximum amount of RAM that can be used by a virtual machine measured (in Maximum Memory Usage MB). Memory Reservation The amount of RAM reserved for a virtual machine measured (in MB). Memory Allocation Limit The amount of RAM allocated to a virtual machine measured (in MB). Business View In the Business View tab, you can configure business views that help you visually represent the interdependencies between your VMware virtual infrastructure as well as view their health status. In the Dashboards tab, you can configure custom dashboards by adding widgets. Dashboard In the In the Dashboards Tab, dashboards can be used to create your own custom pages by adding widgets. By using Custom Dashboards feature, you can create Dashboards of your choice - like Status View of all the Databases, Status view of all Web Applications deployed in Tomcat Server. If you make a Dashboard as template the same Dashboard can be reused across the Monitor Groups . Note: The DRS Migration Report will be shown only when the DRS is in automatic mode. Microsoft Hyper-V Server Monitoring Hyper-V - An Overview Creating a new Hyper-V Monitor User Permissions Firewall Requirements Supported Versions Monitored ParametersHyper-V - An Overview Microsoft Hyper-V is a hypervisor-based virtualization solution for x86-64 systems and an important player in the booming server virtualization space; a critical part of a working IT environment, it needs to be tracked and observed constantly to ensure zero downtime. A Hyper-V monitor helps in monitoring your Microsoft Hyper-V servers and their guest virtual machines, and ensures they are performing well at all times. Applications Manager monitors the critical components of the Hyper-V server to detect any performance problems. The components includes processor, CPU, memory, disk, hardware, virtual & physical network, virtual storage, etc. Creating a new Hyper-V monitor Follow the steps given below to create a new Microsoft Hyper-V Server monitor: Click the New Monitor drop-down link menu. Select Hyper-V Server under Virtualization category. This action will load the Add Monitor screen. Specify the Display Name of the Hyper-V server. Enter the Host Name or IP Address of the host where the Hyper-V server is running. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Select the Monitor Performance Metrics of Virtual Machines option if you want Applications Manager to collect performance metrics of VMs of this server. Select the Version of your Microsoft Hyper-V Server from the drop-down menu (2008, 2012, 2016 or 2019). Select the VM Discovery option. Available options are Do not discover, Discover VM but do not monitor metrics, and Discover and Monitor VM metrics. Select the Enable Kerberos Authentication checkbox if you want to monitor Hyper-V server through Kerberos authentication. Specify the Polling Interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Select the Monitor Group with which you want to associate the Hyper-V server, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Hyper-V server from the network and starts monitoring it. User Permissions To monitor a Hyper-V host, the user must have ‘Administrator’ privileges to the root OS (Windows 2008 R2 and other supported Hyper-V versions). Firewall Requirements If a firewall is present between Applications Manager and the Hyper-V server, open ports 135,443 and 1025 in the firewall to enable access. Supported Versions Versions: Hyper-V Server 2008 R2, Windows Server 2008 R2 Standard, Windows Server 2008 R2 Enterprise, Windows Server 2008 R2 Datacenter, Hyper-V Server 2012, Hyper-V Server 2016, and Hyper-V Server 2019. Monitored Parameters Availability tab shows the Availability history of the Hyper-V server for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the Hyper-V server such as Total CPU Utilization, Guest CPU Utilization, Hypervisor CPU Utilization and Physical Memory Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. List view lists all the Hyper-V servers monitored by Applications Manager along with their overall availability and health status. You can also perform bulk admin configurations from this view. Click on the individual servers listed to view detailed performance metrics. Top Hyper-V servers tab shows graphs for the top total CPU utilization consumers, top guest CPU utilization consumers, top memory consumers and top idle CPU utilization consumers. To view detailed performance metrics of a Hyper-V server, click the corresponding monitor listed in the Availability or List view tab. These metrics are categorized into six tabs for easy understanding. OverviewCPU Memory Network Storage Virtual Storage Virtual Network Hardware Configuration Note: Applications Manager also supports Hyper-V cluster monitoring and is mapped under Admin → Performance Polling → Optimize Data Collection → Hyper-V. Overview This tab provides a high-level overview of the availability and performance of the Hyper-V server. Parameter Description Monitor Information Name The name of the Microsoft Hyper-V server monitor. Type Denotes the type you are monitoring. Health Denotes the health (Clear, Warning, Critical) status of the Hyper-V server. The total number of partitions in the Hyper-V server. Each virtual machine on the Hyper-V Server Partitions runs on a container called a partition. Number of The number of virtual machines configured in this Hyper-V server (Partitions - 1) VMs Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Today''s Shows the overall availability status of the server for the day. You can also view 7/30 reports and Availability the current availability status of the server. Hypervisor CPU Usage Details Total CPU The sum of Guest CPU utilization and Hypervisor CPU utilization. Utilization Guest CPU The percentage of CPU used by guest VMs. Utilization Hypervisor CPU The percentage of CPU used by the hypervisor. Utilization Idle CPU The percentage of CPU when the processor is in an idle state. Utilization Processor Details Logical The total number of logical processors present in the Hyper-V server. These are the number of Processors cores / HT that the hypervisor is managing. Virtual The total number of virtual processors present in the Hyper-V server. All execution in the root and Processors child partitions (where guest VMs run) happens on Virtual Processors. Physical The total number of physical processors present in the Hyper-V server. Processors Memory Details Total Physical The total amount of physical memory utilized by the Hyper-V system. Memory Total Swap The total swap space or the virtual memory utilized by the Hyper-V system. Memory Total Remote Physical The total number of physical pages not allocated from the preferred NUMA node. Pages Total Physical The total number of guest pages and VID pages needed to manage the VM. PagesAllocated HyperV System Services The name of the system services of Hyper-V. The services available include Hyper-V Image Service Name Management Service, Hyper-V Networking Management Service and Hyper-V Virtual Machine Management. Service The current status of the service Status Virtual Machines Virtual The name of the virtual machine. Machine VM State Specifies the current state of the VM such as Running, Paused, Suspended, etc. CPU The percentage of CPU used by this VM Utilization Total Memory The amount of memory used by this VM Health Denotes the overall health status of the VM CPU This tab provides CPU utilization statistics of the Hyper-V server. Parameter Description CPU Details Core Name Name of the CPU Core. User Time Time taken by the CPU to execute user-mode operations (in percentage). System Time Time taken by the CPU to execute kernel-mode operations (in percentage). I/O Wait Time The amount of time the CPU is waiting for I/O requests to complete (in percentage). Idle Time The amount of time the CPU is in idle state (in percentage). CPU Utilization Amount of CPU utilized in this core (in percentage). Interrupts/sec The rate at which CPU handles interrupts from applications or hardware each second. Memory This tab provides memory usage statistics of the Hyper-V server. Parameter Description Memory Usage Details Swap Memory The total swap memory or virtual memory used by the system (in percentage). Utilization Swap Memory Used The swap memory used by the system in mega bytes. Physical Memory The amount of physical memory used by the system (in percentage). Utilization Physical Memory The amount of physical memory used by the system (in mega bytes). Used The amount of free physical memory, in megabytes, immediately available for allocation Free Physical Memory to a process or for system use. Page Details Deposited Pages The total number of deposited pages used by the root partition. Virtual TLB Pages The total number of pages used by the virtual TLB of the root partition. Total Remote Physical The number of physical pages not allocated from the preferred NUMA node. Pages Total Physical Pages The total number of guest pages and VID pages needed to manage the VM. Allocated Pages Per Second The rate at which pages are read from or written to the disk to resolve hard page faults. NetworkThis tab provides metrics about the overall networking performance of the Hyper-V server. Parameter Description Network Traffic Stats Network Adapter The name of the network adapter of the host. Name Speed The rate at which data is transferred (in Mbps). Input Traffic The amount of data received over the adapter (in Kbps). Input Traffic The percentage of input utilization. Utilization Output The amount of data sent over the adapter (in Kbps). Traffic Output Traffic The percentage of output utilization. Utilization Network Packet Stats Offloaded The number of TCP connections (over both IPv4 and IPv6) that are currently handled by the TCP Connections chimney offload capable network adapter. Outbound Packets The number of outbound packets that could not be transmitted because of errors. Errors Outbound The number of outbound packets that were chosen to be discarded even though no errors had Packets been detected to prevent transmission. One possible reason for discarding packets could be to Discarded free up buffer space. Packets Sent The rate at which packets are send on the network interface Per Second Packets Received The rate at which packets are received on the network interface. Per Second Storage This tab displays metrics pertaining to the overall disk performance of the Hyper-V system. Parameter Description Disk IO Details Name The name of the storage device Current Disk Queue The number of requests outstanding on the disk at the time the performance data is Length collected. The rate at which bytes are transferred to or from the disk during write or read Disk Bytes Per Second operations. Disk Transfers Per The rate of read and write operations on the disk. Second Disk Partition Details Free Space The total usable space on the selected disk drive that is free. Used Space The total space on the disk currently in use. Percent Used Space The percentage of total space on the disk currently in use. Percent Free Space The percentage of total usable space on the selected disk drive that is free. Virtual Storage This tab provides information about the virtual storage devices of the Hyper-V server. Parameter Description Virtual Storage Stats Name The name of the virtual storage device.Error Count The total number of errors that have occured on this virtual storage device. Flush Count The total number of flush operations that have occured on this virtual storage device. Read Count The total number of read operations that have occured on this virtual storage device. Write Count The total number of write operations that have occured on this virtual storage device. The total number of bytes that have been read per second on this virtual storage Read Bytes Per Second device. The total number of bytes that have been written per second on this virtual storage Write Bytes Per Second device. Virtual IDE Controller Details Name The name of the virtual IDE controller. Read Bytes Per Second The number of bytes read per second from the disks attached to the IDE controller. Read Sectors Per Second The number of sectors read per second from the disks attached to the IDE controller. Write Bytes Per Second The number of bytes written per second to the disks attached to the IDE controller. Written Sectors Per The number of sectors written per second to the disks attached to the IDE controller. Second Virtual Network This tab shows detailed virtual network stats of the Hyper-V server. Parameter Description Virtual Network Adapter Details Network Interface Name The name of the virtual network interface configured in the Hyper-V server. Bytes/Sec The total number of bytes that have traversed the network adapter per second. Packets/Sec The total number of bytes received per second by the network adapter. Legacy Virtual Network Adapter Details Legacy Network Interface Name The name of the legacy network interface configured in the Hyper-V. Bytes Received Per Second The number of bytes received per second on the network adapter. Bytes Sent Per Second The number of bytes sent per second over the network adapter. Bytes Dropped The number of bytes dropped on the network adapter. Virtual Switch Details Switch Name The name of the virtual switch configured in the Hyper-V Bytes Per Second The total number of bytes per second traversing the virtual switch. Packets Per Second The total number of packets per second traversing the virtual switch. Hardware This tab provides hardware details of the Hyper-V server. Parameter Description Power Name Name of the power source. Voltage The voltage reading value of the power source (in mV). Status The status of the power source. Fan Name Name of the fan. Status Status of the fan. Temperature Name Name of the temperature sensor. Status Status of the temperature sensor. Processor Processor Name Name of the processor.Clock Speed The current clock speed of the processor (in MHz). Voltage Amount of voltage utilized by the processor (in Volts). Number of Cores The total number of cores present. Number of Logical Processors The total number of logical processors present. Status The status of the processor. Socket Designation The socket designation of the processor. Memory Memory Device Name Name of the memory device slot. Capacity The capacity of the memory device slot (in GB). Speed The operational speed of the memory device slot (in MHz). Disk Disk Name Name of the physical hard disk. Capacity The capacity of the hard disk (in GB). Status The status of the hard disk. Configuration This tab provides configuration details of the Hyper-V server. Parameter Description Configuration Details Host Name Name of the Hyper-V host. Hardware Manufacturer The manufacturer name of the hardware used. CPU Model The model name of the CPU. CPU Capacity The overall CPU capacity (in MHz). CPU Manufacturer The manufacturer name of the CPU used. CPU Caption Denotes the family of the CPU used. You can enable, disable or delete virtual storage devices / VMs / network adapters / disk from Applications Manager itself. Just select the required item from the corresponding tab, and choose the appropriate action from the Action list box. You can also compare reports between any two metrics by using the Compare Reports option. Hyper-V Virtual Machines Applications Manager monitors the virtual machines configured in the Hyper-V server. It gives the ability to manage VMs (Start / Stop / Restart) from the Applications Manager web client in case of any performance problems. The solution also tracks attributes related to processes, guest OS, event log, etc. at the VM level. Availability tab lists all the virtual machines present in the Hyper-V servers and their availability status. You can also view the Availability history of the virtual machines for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the virtual machine including CPU Utilization, Memory Utilization, Disk I/O Utilization and Network Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. List view displays all the virtual machines discovered under each Hyper-V server. This view provides an overall idea of the availability and health of all the virtual machines. The list view also enables you to perform bulk admin configurations. Click on the individual virtual machines listed to view detailed VM metrics. Top Virtual Machines tab shows graphs for the top CPU consumers, top memory consumers, top disk I/O consumers, and top network consumers of the Hyper-V server. This section enables you to find out which virtual machines are consuming your server resources and take action accordingly. Click on the individual monitors listed in the Availability tab to view detailed performance metrics of the corresponding virtual machine. Below is an explanation of the metrics shown in these tabs: Monitor Information Performance Overview MemoryNetwork Storage Configuration Monitor Information Parameter Description Name The name of the virtual machine. Type Denotes the type you are monitoring. Health Denotes the health (Clear, Warning, Critical) status of the VM. GUID The unique Hyper-V identifier of this virtual machine. VM State Specifies the current state of the virtual machine. Last Polled Specifies the time at which the last poll was performed. at Next Poll at Specifies the time at which the next poll is scheduled. Shows the overall availability status of the VM for the day. You can also view 7/30 reports and the Availability current availability status of the VM. Performance Overview Parameter Description CPU Stats CPU Utilization The CPU Usage of the virtual machine (in percentage). VM Details Number of Virtual The number of virtual processors present in the partition. All execution in this child Processors partition happens on Virtual Processors. Memory Parameter Description Memory Details The total amount of memory currently available to the virtual machine (in Total Memory megabytes). Deposited Pages The number of deposited pages in this partition. Address Spaces The number of address spaces in the virtual TLB of the partition. Virtual TLB Size recommended The recommended number of pages to be deposited for the virtual TLB. Virtual TLB Pages The number of pages used by the virtual TLB of this partition. GPA space modifications per The rate of modifications to the GPA space of this partition. second Virtual TLB Flush Entries per The rate of flushes of the entire virtual TLB. second Physical Pages Allocated The number of physical pages allocated in this partition. Preferred NUMA Node Index The preferred NUMA node index associated with this partition. Remote Physical Pages The number of physical pages not allocated from the preferred NUMA node. Guest Visible Physical Memory The amount of virtual memory visible to this virtual machine. Demand Memory Amount of memory required by this virtual machine. Average Demand Memory The average value of the amount of memory required by this virtual machine. Network Parameter Description Network Interface UtilizationName Name of the Network Interface Card (NIC). Data Receive Rate The rate at which this NIC receives data (in Bytes/sec). Data Transmit Rate The rate at which this NIC transmits data (in Bytes/sec). Packets Received The number of packets received by the interface. Packets Transmitted The number of packets transmitted from the interface. Storage Parameter Description Disk I/O Utilization Hard Disk Name Name of the parent virtual hard disk. Differencing Hard Name of the differencing disk representing to this parent virtual hard disk. Disk Disk Read Rate The rate at which data is read from the disk (in Bytes/sec). Disk Total Read The total number of read operations that have occurred in this disk. Disk Write Rate The rate at which data is written to the disk (in Bytes/sec). Disk Total Write The total number of write operations that have occurred in this disk. VM Hard Disk Information Hard Disk Name Name of the virtual hard disk. Total Disk Size The total amount of disk space configured for this virtual machine (in GB). The actual amount of disk space utilized on the physical disk for this virtual machine (in File Size GB). Amount of file segments that have been fragmented in this virtual hard disk (in Disk Fragment percentage). Disk Partition Utilization Disk Name of the disk partition. Total Size (MB) The total amount of disk space allocated to this partition. Used (%) Amount of disk space used from this partition. Used (MB) Amount of disk space used from this partition. Free (%) The remaining amount of disk space available after use in this partition. Free (MB) The remaining amount of disk space available after use in this partition. Configuration Parameter Description GUID The value of the Globally Unique Identifier (GUID) of the virtual machine. OS Name * The name of the OS installed on this virtual machine. VM Health State The current health status of the virtual machine. VM State The current state of the virtual machine. Configuration File Path * The path where the configuration file is located for this virtual machine. IP Address * The value of the IP address of the virtual machine. Host Name * The hostname of the virtual machine. Boot Time * The latest boot time of the virtual machine. Up Time * The amount of time the virtual machine is in running condition. Number of Virtual Processors The number of virtual processors available in this virtual machine. Memory Allocated The amount of memory allocated for this virtual machine. Virtual Hard Disk File Path * The path where the Virtual Hard Disk file is located for this virtual machine. * Not available for the Hyper-V server 2008 version. Hyper-V Cluster MonitoringOverview A Failover Cluster is a group of independent computers that work together to increase the availability and scalability of Hyper-V Virtual Machines (VMs). Failover clusters also provide Cluster Shared Volume (CSV) functionality that provides a consistent, distributed storage that clustered roles can use to access shared storage from all nodes. Applications manager can discover your entire Hyper-V clusters and its underlying components through Hyper-V VMs. The Hyper-V Cluster group allows you to discover virtual resources and categorize them into Nodes, Storage, Network, Clustered VMs, etc. Monitored Parameters Hyper-V cluster groups will be listed among monitor groups and can be accessed from the ''Monitor Group'' view under the Monitors tab. Within the Hyper-V cluster group, Summary tab provides an overall view of the components of the Hyper-V cluster and their health status. It shows you the cluster details along with the number of Nodes, Storage, Network, and Clustered VMs present in the Hyper-V cluster. Business View tab allows you to configure business views that help you visualize the inter dependencies between your Hyper-V clusters as well as view their health status. Dashboards tab lets you create your own custom pages by adding widgets into your dashboards. By using the Custom Dashboards feature, you can create dashboards of your choice - like Status View of all the Databases, Status view of all Web Applications deployed in the Tomcat Server, etc. If you create a dashboard as a template, the same dashboard can be reused across various Monitor Groups. Below are the list of parameters that are monitored in the Summary tab: Cluster Details Nodes Storage Network Clustered VMs Cluster Details Parameter Description Cluster Details Number of Nodes The total number of nodes in a cluster. Max Nodes The maximum number of nodes that can participate in a cluster. Number of Networks The number of networks used by the server cluster for communication. Disks in Use The number of disks currently in use in the cluster. Quorum Owner Node The node name, which currently owns the Quorum Resource. The current quorum type. The following are the possible values: InputObject Cluster Quorum Type DiskOnly NodeAndDiskMajority NodeAndFileShareMajority NodeMajority Quorum Path The path to the quorum files. Nodes Parameter Description Nodes Node Name Specifies the label by which the node is known.CPU Utilization The amount of CPU currently being used by the node (in percentage). Memory Utilization The amount of memory currently being used by the node (in percentage). Storage Parameter Description Storage Disk Name The name of the disk partition. Volume Label The volume label of the disk partition. State Current state of the disk partition. Owner Node The name of the node owning the disk partition. Mount Points The path of the disk partition. Path The absolute path (including the drive letter if present) of the disk partition. Disk Space Details Disk Name Name of the disk space. Disk Size (MB) The total size of disk space (in MB). Disk Used (MB) The total used space in the disk (in MB). Disk Free (MB) The total free space available in the disk (in MB). Disk Used Percentage (%) The total percentage of used disk space in a cluster. Disk Free Percentage (%) The total percentage of free disk space in a cluster. Network Parameter Description Network Network Specifies the name of the network. Name Address Provides the IP address for the entire network or subnet. Provides access to the network''s role property i.e, the role of the network in the cluster. The following are the possible values: None - The network is not used by the cluster. Role Cluster - The network is used to carry internal cluster communication. Client - The network is used to connect client systems to the cluster. Both - The network is used to connect client systems and to carry internal cluster communication. Specifies the current state of the network. The following are the possible values: Unknown - The operation was not successful. Unavailable - All of the network interfaces on the network are unavailable, which means the Network nodes that own the network interfaces are down. State Down - The network is not operational; none of the nodes on the network can communicate. Partitioned - The network is operational, but two or more nodes on the network cannot communicate. Typically a path-specific problem has occurred. Up - The network is operational; all of the nodes in the cluster can communicate. Clustered VMs Parameter Description Clustered VMs Name The name of the VM cluster. Owner Node The name of the node owning the VM cluster. CPU Utilization The amount of CPU currently being used by the VM cluster (in percentage).Memory Utilization The total amount of memory currently being used by the VM cluster (in MB). Citrix Hypervisor (XenServer) Overview Applications Manager provides monitoring support and virtual machine management of your Citrix Hypervisor (formerly XenServer) infrastructure with a comprehensive view into individual components. You can monitor Citrix Hypervisor host metrics, virtual machines metrics for your Citrix Hypervisor Host and capture XenMotion under Resource Pools for easier management of hosts and to detect performance problems. The key performance metrics monitored by Applications Manager include those pertaining to CPU usage, memory usage, storage details, network utilization and configuration info at both the Citrix Hypervisor host and VM level. Once the host is added, the virtual machines are auto-discovered. You can receive immediate notification with historical reporting of VM performance to enable the rapid diagnosis of problems in your virtual infrastructure. Creating a new Citrix Hypervisor monitor Supported versions: Citrix Hypervisor 5.6 and 6.2 Using the REST API to add a new Citrix Hypervisor monitor: Click here Follow the steps given below to create a new Citrix Hypervisor monitor: Click on New Monitor link. Select Citrix Hypervisor under Virtualization category. Specify the Display Name of the Citrix Hypervisor. Enter the Host Name or IP Address of the host where the Citrix Hypervisor runs. Enter the Https Port where the Citrix Hypervisor web service runs. The default port is 443. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. It should be the credentials of any Citrix Hypervisor Host user with admin privileges. Select the VM Discovery option. Available options are Do not discover, Discover VM but do not monitor metrics, and Discover and Monitor VM metrics. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Citrix Hypervisor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Citrix Hypervisor from the network and starts monitoring it. Citrix Hypervisor resource pool discovery Applications Manager automatically discovers the slave Citrix Hypervisor Hosts under the Resource Pool when adding the Master Citrix Hypervisor Host. Once the Master host is added, the resource pool will be discovered and added as a monitor group. The user must provide the credentials for the slave Citrix Hypervisor Host and manage the Citrix Hypervisor Host to collect the performance metrics. Adding a Slave Citrix Hypervisor Host is equivalent to a standalone Citrix Hypervisor Host and Applications Manager will not determine the master and other slave Citrix Hypervisor Hosts. Read more about Citrix Hypervisor monitor and metrics monitored Monitored Parameters Availability tab shows the availability history of Citrix Hypervisor for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the Citrix Hypervisor such as Response time, Total CPU Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. List view lists all the Citrix Hypervisor servers monitored by Applications Manager along with their overall availability and health status. You can also perform bulk admin configurations from this view. Click on the individual servers listed to view detailed performance metrics. Top Citrix Hypervisor tab shows graphs for the top total CPU utilization consumers, top guest CPU utilization consumers, top memory consumers and top idle CPU utilization consumers. Citrix Hypervisor Resource Pool discovery Applications Manager automatically discovers virtual elements within the environment - including Resource Pools, physical hosts, and VM guests. The Resource Pool will be automatically discovered when the Master Citrix Hypervisor Host is added.Once the Master Citrix Hypervisor host is added, the Resource Pool will be discovered and added as a monitor group. All the slave Citrix Hypervisor hosts under the resource rool will be discovered automatically and all the Citrix Hypervisor Hosts (both Master & Slaves) will be mapped to the Resource Pool. Note: The discovered slave Citrix Hypervisor hosts are added in ''UnManaged'' state. To associate/dissociate any monitors to this Resource Pool, the user must provide the credentials for the Slave Citrix Hypervisor Host and change it to managed state. After providing the credentials, Applications Manager discovers the virtual machines under the slave Citrix Hypervisor Host and collects performance metrics. The Resource Pool will have the separate details view which has the following list of information: Master Citrix Hypervisor Host and list of Slave Citrix Hypervisor Hosts. Pool Configuration details. VM and storage counts for all the hosts under the Resource Pool. Click on the Resource Pool name under monitor groups to see the availability and health status of the pool, number of hosts, vms, storage and network. The Summary tab displays Citrix Hypervisor host details like name, type, IP address, number of VMs, cpu core, cpu and memory percentage. Parameter Description Host Name The name of Citrix Hypervisor monitor. Type Type of Citrix Hypervisor host (master or slave). IP Address IP Address of the host. Number of VM Total Number of VM''s in the Citrix Hypervisor Host. Number of CPU Core Total Number of CPU Cores created in the Citrix Hypervisor Host. CPU (%) Average physical CPU usage (%). Memory (%) Average memory usage (%). The Pool Configuration Details tab displays high availability, WLB enabled, high availability overcommitted, virtual switch controller address, the number of VM''s running, suspended, halted and paused. Parameter Description HA Enabled Configuration property to enable high availability in Citrix Hypervisor. WLB Enabled Configuration property to enable Workload Balancing in Citrix Hypervisor. HA OverCommitted Configuration property stating whether pool resources are overcommitted. Virtual Switch Controller Address Pool Virtual Switch Controller Address Configuration. Number of VM''s Running Number of virtual machines running in the Citrix Hypervisor host. Number of VM''s Suspended Number of virtual machines in suspended state in the Citrix Hypervisor host. Number of VM''s Halted Number of virtual machines halted in the Citrix Hypervisor host. Number of VM''s Paused Number of virtual machines paused in the Citrix Hypervisor host. Click on the tabs listed below to view the corresponding metrics monitored: Overview CPU Memory Storage Network Configuration Overview This tab provides a high-level overview of the Citrix Hypervisor as well as its resource utilization. Parameter DescriptionAvailability and Performance History Displays the availability and performance history for the last six hours. CPU Utilization The combined CPU utilization across the system(%). Memory Utilization Percentage of memory used across the system(%) Virtual Machines VM Name Name of the virtual machines(VM) present in the host Availability Denotes the availability of the VM - available or not available Power Indicates whether the VM is running or not CPU Utilization The disk input/output utilization of this VM in percentage Health The health status(Clear, Warning, Critical) of this VM Number of Virtual CPUs Displays the total number of virtual CPUs. CPU This tab provides metrics about CPU Utilization details of the cores. Parameter Description CPU Utilization of Cores Core Name The core name of the processor. CPU Utilization The CPU utilization of the CPU core over a period of time(in percentage). Speed The speed of the physical processor in Megahertz. Model Name The model name of the physical processor. Family The family (number) of the physical processor. Model The model number of the physical processor. Stepping The stepping of the physical processor. Health The overall health of the CPU core. Memory This tab provides metrics about memory utilization of the Citrix Hypervisor. Parameter Description Memory Utilization Overhead Memory Memory overhead in MB on the Citrix Hypervisor Host. Memory Available The amount of available physical memory in MB. Memory Usage The amount of physical memory in use in MB. Total Memory The total physical memory in Citrix Hypervisor Host in MB. Agent Memory Utilization Memory Allocation The allocation of the XAPI process in MB. Memory Live The live memory for the XAPI process in MB. Memory Usage The memory used by the XAPI process in MB. Memory Free The memory which is unutilized/ free for the XAPI process in MB. Storage This tab displays metrics pertaining to the overall disk performance of the Citrix Hypervisor. Parameter Description Name The name of the storage repository. Description The description of the storage repository. Type The type of the storage repository. Content Type The type of content in the storage repository. Shared Indicates whether this storage repository can be shared between multiple hosts. Usage The percentage of this storage repository that is in use.Capacity The total physical size of the repository in GB. Virtual Allocation The sum of virtual sizes of all virtual disk images in this storage repository in GB. Network This tab provides metrics about network utilization. Parameter Description Network Utilization Name Name of the device IP Address IP address of this physical network interface Mac Address MAC address of this physical network interface. Netmask Netmask of this physical network interface. Gateway The IP address of the gateway of this physical network interface. Speed Indicates the metrics speed. The network traffic out, measured in KB/sec across all of the physical adapters of this Citrix Data Received Hypervisor host. Data The network traffic in, measured in KB/sec across all of the physical adapters of this Citrix Transmitted Hypervisor host. Transmit Errors Transmit errors per second on this physical network interface. Received Received errors per second on this physical network interface. Errors Duplex Indicates whether this device is duplex. MTU Maximum transmission units of the physical network interface. Configuration This tab provides info on the Citrix Hypervisor''s configuration details. Parameter Description HostName The name of Citrix Hypervisor monitor. Power The power status of the server. Version The software product version of this Citrix Hypervisor host. CPU Model The model name of the physical processor. CPU Capacity The capacity of the physical processor. CPU Vendor The vendor of the physical processor. Number of CPU Cores Total Number of CPU Cores created in the Citrix Hypervisor Host. Number of VM''s Total Number of VM''s created in the Citrix Hypervisor Host. Major Version Major version number of the API of this host. Minor Version Minor version number of the API of this host. Description The description of this Citrix Hypervisor host. Enabled Indicates whether this Citrix Hypervisor host is enabled to run VMs. Scheduler Policy The scheduler policy currently enforced on this Citrix Hypervisor host. License Expiry The expiration date of the license for this Citrix Hypervisor host. Citrix Hypervisor Virtual Machines The key performance metrics monitored by Applications Manager include those pertaining to CPU usage, memory usage, storage details, network utilization and configuration info at both the Citrix Hypervisor host and VM level. The solution also tracks attributes related to processes, guest OS, event log, etc. at the VM level. Applications Manager also enables IT administrators to automate the provisioning of Citrix Hypervisor VMs based on threshold breaches. For example, Applications Manager can automatically start/stop/restart VMs in a Citrix Hypervisor farm when the number of active sessions in a Tomcat server or Oracle application server exceeds thespecified threshold limit. This automation capability helps IT teams significantly reduce manual intervention and ensure their business-critical applications running in Citrix environments do not experience resource shortage. Availability tab lists all the virtual machines present in the Citrix Hypervisors and their availability status. You can also view Availability history of the virtual machines for the past 24 hours or 30 days. Performance tab shows some key performance indicators of the virtual machine including CPU Utilization, Memory Utilization, Disk I/O Utilization and Network Utilization along with heat charts for these attributes. This tab also shows the health status and events for the past 24 hours or 30 days. List view tab displays all the virtual machines discovered under each Citrix Hypervisor. This view provides an overall idea of the availability and health of all the virtual machines. It also enables you to perform bulk admin configurations. Click on the individual virtual machines listed to view detailed VM metrics. Top Virtual Machines tab shows graphs for the top CPU consumers, top memory consumers, top disk I/O consumers, and top network consumers of the Citrix Hypervisor. This section enables you to find out which virtual machines are consuming your server resources and take action accordingly. Click on the individual monitors listed to view detailed performance metrics of the corresponding virtual machine. These metrics are categorized into 5 separate tabs for easy understanding. Below is an explanation of the metrics shown in these tabs: Overview Memory Storage Network Configuration Overview This tab provides a high-level overview of the virtual machine as well as its resource utilization. Parameter Description Monitor Information Name The name of the virtual machine Type Denotes the type you are monitoring. Health Denotes the health (Clear, Warning, Critical) status of the VM. Last Polled at Specifies the time at which the last poll was performed. Next Poll at Specifies the time at which the next poll is scheduled. Availability Shows the current status of the VM - available or not available. CPU Utilization CPU Utilization The CPU Usage of the VM as percentage Memory This tab shows metrics about the memory utilization of the virtual machine Parameter Description Overhead Memory Amount of additional host memory allocated to the virtual machine in MB. Target Memory The maximum memory which is allocated to the virtual machine. Minimum Dynamic Memory The minimum dynamic allocation of memory to a VM from a pool of memory on the host. Maximum Dynamic Memory The maximum dynamic allocation of memory to a VM from a pool of memory on the host. Minimum Static Memory Specifies the minimum amount of static memory allocated to the virtual machine. Maximum Static Memory Specifies the maximum amount of static memory allocated to the virtual machine. Storage Parameter Description VBD (Virtual Block Device) Details Name Name of this virtual block device.Bootable Indicates whether this virtual block device is bootable. Device Attached Indicates whether the device is attached or not. Drive Empty Indicates whether this device is an empty drive. Mode The mode the virtual block device must be mounted with. Status Code Error/success code that is associated with last attach-operation. Storage Level Lock Indicates whether a storage level lock was acquired. VBD Type Indicates how the virtual block device appears to the guest. Unpluggable Indicates whether this virtual block device supports hot-unplug. VDI (Virtual Disk Image) Details Name Name of the virtual disk image. Description The description of the virtual disk image. Location Displays the location information of the virtual disk image. Managed Disk Indicates whether the virtual disk image is a managed disk image. Missing Indicates whether the virtual disk image is present on disk. Physical Utilization The physical utilization of this virtual disk image in GB. Size Displays the size of the disk as presented to the guest in GB. Read Only Indicates whether this disk can be mounted only as read-only. Sharable Indicates whether this disk can be shared. SR Name The name of the storage repository where the virtual disk image is located. Network The metrics in this category contain the VM network utilization details. Parameter Description Name Name of this virtual network interface. MAC Address Ethernet MAC address of virtual interface, as exposed to guest. Network The name of the virtual network to which this virtual network interface is connected. IP Address IP Address of the virtual interface. MTU Maximum transmission units of the virtual network interface in octets. Active Indicates whether the device is attached. Data Transmit Data transmitted on virtual interface in kilo bytes per second. Data Received Data received on virtual interface in kilo bytes per second. Transmit Errors Indicates the transmit errors per second on this virtual interface. Received Errors Errors received per second on this virtual interface. I/O Read The read bandwidth of the device in kilo bytes per second . I/O Write The write bandwidth of the device in kilo bytes per second .   Configuration Parameter Description VM Name The name of the Virtual Machine. Power Current power state of the VM. OS Name Operating System of the VM. Citrix Hypervisor HostName Displays the name of the Citrix Hypervisor host where the virtual machine is located. Displays the status of the the virtual machine''s HA(high availability). If this value is true, it indicates HA Always Running that the system will attempt to keep the VM running. HA Restart Priority If ha_always_run is set, this describes the restart priority. Description Any description of the VM. Is Snapshot Indicates whether this virtual disk image is a snapshot.Snapshot Name The name of the VM of which this is a snapshot. Snapshot Creation Time Date/time when this snapshot was created. User Version A user version number of this machine. XenTool Status Indicates the Status of XenTools on the VM XenTool Version Version Number of the XenTool. XenTool Build Build Number of the XenTool. Docker Monitoring Docker - Overview Docker is a new container technology. Docker allows you to package an application with all of its dependencies into a standardized unit for software development. With Docker, you can separate your applications from your infrastructure and treat your infrastructure like a managed application. Applications Manager''s Docker monitoring helps to actively monitor all aspects of a Docker monitor like health, availability, running stats etc., and helps take informed decisions in case of downtimes. Creating a new Docker monitor Prerequisites for monitoring Docker metrics: Click here Rest API to add a new Docker monitor : Click here Once the prerequisites are fulfilled, follow the steps given below to create a new Docker monitor: Click on New Monitor link. Select Docker under Virtualization category. Specify the Display Name of the Docker Monitor. Enter the HostName/IP Address of the server where Docker is running. Enter the Docker socket port to access REST API. The default port used is 4243. If you choose the Use Below Credentials option, then enter the credentials - UserName and Password to access Remote REST API. If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Choose SSL is enabled if REST API is to be accessed via SSL port. Default SSL port for Docker REST API is 2376. Select the Container Discovery options based on which the containers should be discovered and monitored. The available options are Do not discover, Discover and monitor all containers, and Discover and monitor specific containers based on regex. If Discover and monitor specific containers based on regex option is selected, specify the Discovery Filter Regex based on which the containers are to be discovered and monitored. Learn more Select the Client Certificate Authentication checkbox if and only if you have enabled Client Certificate Authentication for the Docker server you want to monitor. Add the certificate under  \working\Cert\Docker directory. Please note that only files of type "PKCS#12"(.p12) are supported. Also, provide the Client Certificate Name and the Password for the certificate, if required. Under Action on deleted resources option, select any one of the following options to perform appropriate action on the deleted Docker resources: Unmanage Resource: Unmanages the deleted container and stops polling for the same. Delete Resource: Removes the deleted containers completely from the Applications Manager console. Note: Action on deleted resources option is available under the Advanced Settings checkbox. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Docker monitor from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Docker from the network and starts monitoring it. Monitored Parameters Parameters Descripton Total Number of Containers Total number of containers in Docker. Total Number of Images Total number of images present. Crashed Containers Number of containers, that exited abnormally.  Running Containers Containers that are currently running. Error Message Error message for list of crashed containers. Memory Limit ''True'', if a memory limit is set, ''False'' otherwise. Memory Used Total memory used by Docker. Docker Id The unique Id, used to identify each Docker.  Name Name of the Docker. Docker Version The version of Docker daemon running in the host machine. API Version The version of Docker''s remote API. Kernel Version Kernel version used in the host. Operating System Name of the operating system. Build Time Last build time of Docker. Init Path Path of Docker init directory.  Docker Root Dir Root directory path of Docker.   Note: Applications Manager supports only Docker Version 1.5, API Version 1.17 As Docker REST APIs does not Support SSLv3 and lower protocols due to security reasons, Docker Monitoring will work only in Java 7 and above. If your Applications Manager is still in Java 6, migrate it to Java 7. (Refer Java Migration in Applications Manager for more info.) Docker is a new container technology. Docker allows you to package an application with all of its dependencies into a standardized unit for software development. With Docker, you can separate your applications from your infrastructure and treat your infrastructure like a managed application. Applications Manager helps to actively monitor all aspects of a Docker monitor like health, availability, running stats, etc., and helps take informed decisions in case of downtimes. Docker Containers Container Metrics: Overall Health: S.No Parameters Description Current state of the Container. Possible states are ''Running'', ''Paused'', ''Restarting'', 1 State ''OOMKilled'', ''Dead''. 2 Exit Code Last exit code of Docker Container. 3 Error Error message. 4 Started At Latest start time of the Container. 5 Finished At Last time the Container had stopped. Restart 6 Number of times the container has restarted. Count CPU and Memory Usage: S.No Parameters Description The percentage of CPU utilized. In multi core machines, CPU utilization''s value can be 1 CPU Utilization greater than 100. Memory 2 The percentage of memory utilized. Utilization Processor 3 Total number of processors available. Count 4 Memory Usage Total memory used by the Container (in MB). 5 Memory Limit Memory limit of the Container (in MB). Network Stats: S.No Parameters Description 1 Bytes Received Total number of bytes received by the Container interfaces.2 Bytes Transmitted Total number of bytes transmitted by the Container interfaces. 3 I/O Read Number of IOs read to/from the disk by the Container. 4 I/O write Number of IOs written to/from the disk by the Container. 5 I/O Total Number of IOs completed to/from the disk by the Container. 6 tx-packets Dropped Packets dropped while transmitting data. 7 rx-packets Dropped Packets dropped while receiving data. Memory Stats:  S.No Parameters Description 1 Active File Cache memory that has been identified as active by the kernel. InActive 2 Cache memory that has been identified as inactive by the kernel. File Active 3 The amount of anonymous memory that has been identified as active by the kernel. Anonymous Inactive 4 The amount of anonymous memory that has been identified as inactive by the kernel. Anonymous 5 Cache The amount of memory used by the processes of this control group. The amount of memory that cannot be reclaimed; generally, it will account for memory that 6 Inevictable has been locked with mlock. It is often used by crypto frameworks to make sure that secret keys and other sensitive material never gets swapped out to disk. 7 Page Fault Total number of page faults of the system. Page Major 8 Total number of major page faults of the system. Fault 9 Page In Each time a page is "charged" (added to the accounting) to a cgroup, pgpin increases. 1o Page Out When a page is “uncharged” (no longer “billed” to a cgroup), pgpgout increases. Configuration Metrics: S.No Parameters Description 1  Container Name  Name of the Container. 2  Container Id  Unique Id used to represent the Container. 3 Image Base image used to create the Container. 4 Host Name ''Hostname to use for the Container.'' 5 Process Id Process Id mapped to the Container. 6 Ip Address Assigned IP address of the Container. 7 Mac Address Assigned Mac address of the Container. 8. User User associated with the Container. 9 Created At Time when the Container was created. 10 Command Command used while running the Container. 11 Path Path where the command will be executed. 12 Ports Details of all the ports exposed by the Container. 13 Port Binding Details of all the ports exposed by the Container and their mappings with the host. XenApp Monitoring Overview Creating a new monitor Monitored Parameters Overview XenApp is Citrix''s solution for application and desktop delivery, with over 100 million users worldwide. XenApp extends Microsoft Remote Desktop Sessions and applications to users through the Citrix HDX protocol, enablingsecure, remote access to Windows applications and server desktops from any device, over any network. Applications Manager helps quickly drill down to the root cause of a problem in XenApp and resolve slowness in an application running on a XenApp server. Track the performance of Broker Services, client and server sessions and diagnose issues like server overload using our Citrix XenApp monitoring solution. Creating a new monitor Supported versions of XenApp Server: XenApp 7.6 and 6.5 Prerequisites for adding the monitor: You should have .NET 3.5 framework installed in Applications Manager. Applications Manager connect with XenApp Server and used to determine the Performance of various services and components of XenApp Server. Follow the steps given below to create a new XenApp monitor: Click on New Monitor link. Select XenApp under Virtualization category. Specify the Display Name of the XenApp Server. Enter the Host Name (Delivery Controller) or IP Address of the host where the XenApp server runs. Select the Version number from the drop-down menu. If you choose the Use Below Credentials option, then enter the credentials - UserName and Password of the XenApp Server Host Machine. UserName- Name of the User who has the permission to execute WMI Queries for the respective Versions on the following namespaces in Delivery Controller machine. NameSpaces For Version 7.6: root\cimv2 root\citrix\euem root\citrix\profiles\metrics NameSpaces For Version 6.5: root\cimv2 root\citrix Password - Password of the above user who has the permissions to execute WMI Queries. If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Select Enable Event Log Monitoring if you wish to monitor event logs. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the XenApp to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the XenApp from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on XenApp under the Virtualization Table. Displayed is the XenApp bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the tabs listed below to view the corresponding metrics monitored for different versions of XenApp: XenApp Version 7.6 XenApp Version 6.5 Performance Overview Services Performance Overview Web Interface End-User Experience IMA and ICA Session Performance Zones and Servers Profile Server Applications Event Logs Sessions and Clients Event Log Monitored Parameters for XenApp Version 7.6Performance Overview Parameter Description Performance of Broker Services Average Transaction Time The time on average taken to process an XML transaction in Citrix Broker Service. (in Seconds) Concurrent The number of concurrent XML transactions being processed in the Broker Service. Transactions Transactions/Sec The number of XML transactions being processed per second. Services The name of the service. Note that the display name and the service name (which is stored in Service Name the registry) are not always the same. The Start mode of the service. The different start modes are: Boot - The device driver is started by the operating system loader (valid only for driver services). System - The device driver started by the operating system initialization process. This value is valid only for driver services. Auto - The service to be started automatically by the service control manager during Start Mode system startup. Auto services are started even if a user does not log on. Manual - The service to be started by the Service Control Manager when a process calls the StartService method. These services do not start unless a user logs on and starts them. Disabled - The service that cannot be started until its StartMode is changed to either Auto or Manual. The current status of the object. Both operational and nonoperational statuses can be Status defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" etc. Non-operational statuses include: "Error", "Starting", "Stopping", and "Service" etc. The current state of the base service. Possible values are: Stopped Start Pending Stop Pending State Running Continue Pending Pause Pending Paused Unknown End User Experience Parameter Description Server Session Start-Up Durations Session ID The unique ID for each user session. Client IP The IP address of the device connecting to a XenApp / Presentation Server. Client Machine The name of a device connecting to a XenApp / Presentation Server. Name Logon Client The name of the user who is connecting to the XenApp / Presentation Server and accessing User Name published application. Credentials The Credentials Authentication Server Duration (CASD) is the time the application server spends Authentication authenticating the user''s credentials against the authentication provider, which may be (in ms) Kerberos, Active Directory, or a Security Support Provider Interface. Credentials The Credentials Obtention Server Duration (COSD) is the time taken for the server to obtain the Obtention (in user credentials. Because this metric may be artificially inflated if a user fails to provide ms) credentials in a timely manner, it is not included in the Session Start-up Server Duration (SSD). Drive Mapping The Drive Mapping Server Duration (DMSD) is the time needed for the server to map the user''s(in ms) client drives, devices and ports. The Printer Creation Server Duration (PCSD) is the time required for the server to synchronously Printer map the user’s client printers. If the configuration is set such that printer creation is performed Creation (in asynchronously, no value is recorded for PCSD as it is does not impact completion of the session ms) start-up. Profile Load The Profile Load Server Duration (PLSD) is the time required for the server to load the user’s (in ms) profile. Session The Session Creation Server Duration (SCSD) is the time the server spends creating the session. Creation (in This should not be confused with the overall SSD. ms) The Session Startup Server Duration (SSSD) is the high-level server-side connection start-up metric that encompasses the time XenApp takes to perform the entire start-up operation. When Session an application starts in a shared session, this metric is normally much smaller than when Startup (in ms) starting a new session, which involves potentially high-cost tasks such as profile loading and login script execution. Client Session Startup Durations Session ID The unique ID for each user session. Client IP The IP address of the device connecting to a XenApp / Presentation Server. Client Machine The name of a device connecting to a XenApp / Presentation Server. Name Logon Client The name of the user who is connecting to the XenApp / Presentation Server and accessing User Name published application. Application The name of the application user request to get session. Name Application The Application Enumeration Client Duration measures the time needed to retrieve the list of Enumeration applications from the Web Interface service. Application enumeration is one of the issues (in ms) slowing down session start times. The BackUp URL Client Count (BUCC) is a recording of the number of back-up URL retries before a successful launch. This is the only start-up metric that is a measure of attempts, rather than Back-Up URL time duration. If this metric has a value higher than 1, it indicates the Web Interface server is Client Count unavailable and the XenApp Plugin (formerly known as Program Neighborhood Agent) is attempting to connect to back-up Web Interface servers to launch the application. The Credentials Obtention Client Duration (COCD) is the time it takes to obtain user credentials. Credentials Note: COCD is only measured when the credentials are entered manually by the user. Because Obtention (in this metric may be artificially inflated if a user fails to provide credentials in a timely manner, it ms) is subtracted from the Startup Client Duration (SCD). This consideration is especially important if the metric is to be used for threshold alerting. Configuration The Configuration File Download Client Duration (CFDCD) is the time it takes to get the File Download configuration file from the XML server. (in ms) The ICA File Download Duration (IFDCD) is the time it takes for the plugin (client) to download the ICA file from the server. Note: The overall process involved in downloading the ICA file is: The user clicks on application icon. The user’s browser requests the Web Interface launch page. The Web Interface launch page receives the request and starts to process the launch, ICA File communicating with XenApp server and potentially other components such as Secure Download (in Ticket Authority (STA). ms) The Web Interface generates ICA file data. The Web Interface sends the ICA file data back to the user’s browser. The browser passes ICA file data to the plugin (client). IFDCD metrics represents the time it takes for the complete process (step 1 to 6). Metric stops counting time when the client receives the ICA file data. Launch Page The Launch Page Web Server Duration (LPWD) metric is only used when Web Interface is the Web Server (in application launch mechanism. If LPWD is slow, there is a bottleneck on the Web Interface ms) server.Process under this: 1. The Web Interface launch page receives the request and starts to process the launch, communicating with XenApp server and potentially other components such as Secure Ticket Authority (STA).2. The Web Interface generates ICA file data. The Session Look Up Client Duration (SLCD) represents the time it takes to query every session to Session Look- host the requested published application. The check is performed on the client to determine Up (in ms) whether an existing session can handle the application launch request. The method used depends on whether the session is new or shared. Session The Session Creation Client Duration (SCCD) is the time it takes to create a new session, from the Creation (in moment wfica32.exe is launched to when the connection is established. ms) The Startup Client Duration (SCD) is a high-level client connection startup metric. It starts as close as possible to the time of the request (mouse click) and ends when the ICA connection Startup Client between the client device and server running the XenApp / Presentation Server has been (in ms) established. In the case of a shared session, this duration will normally be much smaller, as many of the setup costs associated with the creation of a new connection to the server are not incurred. Session Performance Parameter Description ICA Sessions Round Trip Metrics SessionID The unique ID for each user session. Client IP The IP address of the device connecting to a XenApp / Presentation Server. Client Machine The name of a device connecting to a XenApp / Presentation Server. Name Logon Client The name of the user who is connecting to the XenApp / Presentation Server and accessing User Name published application. Network The detected network latency between the XenApp / Presentation Server Client device and the Latency (in server running XenApp / Presentation Server. Seconds) The time interval measured at the client between the first step (user action) and the last step Round Trip (graphical response displayed). This metric can be thought of as a measurement of the screen lag Time (in that a user experiences while interacting with an application hosted in a session on a server Seconds) running XenApp / Presentation Server. Input Bandwidth The bandwidth available on the network ( XenApp / Presentation Server Client to XenApp / Available (in Presentation Server) in bits per second. bits/sec) Output Bandwidth The bandwidth available on the network ( XenApp / Presentation Server to XenApp / Presentation Available (in Server Client) in bits per second. A value of 0 indicates that no data is available. bits/sec) Frame Send Round Trip The time from the start of the frame until the completion of sending frame data to the client. Duration (in Seconds) Profile Server Parameter Description Logon Timings Session ID The unique ID for each user session. Time Taken for The profile load time for the given session. It is calculated as: Profile Loaded (Time at which the Loading Profile profile finished loading) - Profile Load Start (Time at which the profile started to load). (in Seconds) Time Taken for The logon script execution duration which is displayed in the Director console. It is calculated Logon Script as: LogonScriptComplete (Time at which Start-up script is completed) + LogonScriptStartup Execution (in (Start time of the start-up logon) Seconds) Logoff Timings Session ID The unique ID for each user sessionTime Taken for The registry processing duration. The registry values for the current user are processed and Processing saved to the profile store. It is calculated as: Registry Registry processing duration = Registry Processing complete (Registry processing finish time) -- Registry Processing Start (Registry processing start time). The time taken for file synchronization and file system processing. It is calculated as: Time Taken for File System File System Processing = File System Processing complete (File synchronization and related file Processing system processing finish time) - File System Processing Start (File synchronization and related file system processing start time). The Cross Platform Setting (CPS) processing duration. It is calculated as: Time Taken for CPS Cross Platform Setting (CPS) processing duration = CPS Processing Complete (Cross-platform Processing settings processing finish time) - CPS Processing Start (Cross-platform settings processing start time). The logoff processing duration. It is calculated as: Time Taken for Logoff Logoff processing duration = Logoff completed (Time at which logoff process finished) - Logoff start (Logoff process start time) Diagnostics Session ID The Unique ID for each user session. Users can create their own profiles in XenApp Server. Whenever a user logs in or logs out from a session, the profile server is used to authenticate the user, to check accessibility of resources for each user etc. The Network Latency metric indicates if the profile server is online or offline. Network Possible values are: Latency -1 = Offline, no network connection and no active sync enabled 1 = Online Disk Usage The total bytes consumed by the user of this session. The name of the redirected special folder or the name of the profile store folder in the profile Folder Name store path. Event Logs Parameter Description Rule Name The name of the event log rule Log File The Log File Type - Application, system, security, file replication service, DNS Server or directory Type service. Source The Application which created the event. Event Id The Event ID associated with the Event Log File. The Event Type - Error, Warning, Information or Event of Any Type. In case of Security Events, the Type types would vary between Success Audit and Failure Audit. User Name The system component or User account that was running the process which caused the event. Description A description of the event. Generated The time when the event entry was submitted. Time Monitored Parameters for XenApp Version 6.5 Performance Overview Parameter Description SERVER DETAILS Server Name The name of the XenApp Server. IP Address The IP Address of the XenApp Server. Farm Name The name of the Farm under which XenApp Server is Configured. Zone Name> The name of the Zone to which the XenApp Server belongs. Zone Ranking specifies the ranking of server in the Zone. Possible ranks are Most Preferred, Zone Ranking Preferred, Default Preference, Not Preferred and Unknown.Domain Name The Domain Name of the XenApp Server. Server Type The type of the Server - Windows server or not. XenApp SERVER PERFORMANCE DataStore The number of minutes that the XenApp server has been disconnected from the data store. Connection Failure Threshold should take into account events such as reboots and scheduled maintenance. Number of XML The number of threads allocated to service Web-based sessions. Threads The number of XML threads currently being processed. There are 16 worker threads in the Busy XML Threads Citrix XML Service. A count of 16 or more shows that XML requests are not being processed in a timely manner. Resolution Work The number of resolution work items (related to application launches) that are ready to be Item Queue Ready executed. A value above 0 indicates that requests are being queued while IMA handles Count other requests. The number of work items that are ready to be executed. A value above 0 indicates that Work Item Queue requests are being queued while IMA handles other requests. This counter should not be Ready Count over 1 for an extended period of time. Number of Zone The number of zone elections. This value starts at zero each time the IMA Service starts Elections and is incremented each time a zone election takes place. Zone Elections The number of times a server triggers a zone election. Triggered Active Sessions The number of active user sessions. Disconnected The number of disconnected user sessions. Sessions Total number of The total number of user sessions ( active and disconnected). Sessions TRACKING XenApp GROWTH Application The time in milliseconds that a resolution took to complete. This is also the time required Resolution Time to determine the “least-loaded” server during an application launch. Application The number of non-XML-based enumerations (requests for application lists) per second. Enumerations/Sec Application The number of resolutions (applicable launch requests) per second. Resolutions/Sec Filtered Application The number of XML-based enumerations (requests for application lists) per second Enumerations/Sec LICENSE SERVER CONNECTION FAILURE License Server The number of minutes that the XenApp server has been disconnected from the License Performance Server. Average License Check-In Response The average license check-in response time in milliseconds. Time Average License Check-Out The average license check-out response time in milliseconds. Response Time Last Recorded License Check-In The last recorded license check-in response time in milliseconds Response Time Last Recorded The last recorded license check-out response time in milliseconds. A value of more than License Check-Out 5000 milliseconds indicates a performance issue at the license server. Response Time CPU UTILIZATION The percentage of CPU resource consumed by a user at a given time, averaged over a few CPU Usage seconds The percentage of CPU resource that Citrix CPU Utilization Management makes available CPU Entitlement to a user at a given time The percentage of total computer CPU resource reserved for a user, should that user CPU Reservation require it CPU Shares The proportion of CPU resource assigned to a userLong Term CPU The percentage of CPU resource consumed by a user, averaged over a longer period than Usage the CPU Usage counter Services Parameter Description SERVICES Service Name Name of the Services in XenApp Start Mode Represent the starting mode(like Auto/Manual/Disabled) of the Services State Represent the state(like Running/Stopped/Paused) of the Services Web Interface Parameter Description WEB INTERFACE PERFORMANCE Service Name Name of the Services in XenApp Queued Request The number of requests waiting to be processed Count Rejected Request The number of requests rejected because the request queue was full Count TRACKING WEB INTERFACE GROWTH Request The number of milliseconds that it took to execute the most recent request Execution Time Current Request The current number of requests, including those that are queued, currently executing, or Count waiting to be written to the client IMA and ICA (Independent Computing Architecture and Independent Management Architecture) Parameter Description CITRIX IMA NETWORKING Server Name Name of the XenApp Server with IMA Service. Network Connections The number of active IMA network connections to other IMA servers. Bytes Received/Sec The inbound bytes in bytes per second. Bytes Sent/Sec The outbound bytes in bytes per second. ICA SESSION STATS The name of the Client connected with XenApp Server along with it''s Session Client Name Name. Average of Session''s Latency The average client latency over the lifetime of a session. The difference between the minimum and maximum measured latency values Deviation in Latency for a session. Input Session Bandwidth The bandwidth, measured in bits per second, used from client to server for a (bits/sec) session. Output Session Bandwidth The bandwidth, measured in bits per second, used from server to client for a (bits/sec) session. ICA ROUND TRIP LATENCY Median of ICA Round Trip The median time of ICA roundtrip latency for all sessions on the server. Latency Zones and Servers Parameter Description ZONE STATS Zone Name The name of the Zone to which XenApp Server belongs. Data Collector The one Server in a Zone is elected as the data collector for the other servers. Number of The number of XenApp servers in each Zone. Servers SERVERS IN ZONESServer Name The name of the XenApp Server. IP Address The IP Address of the XenApp Server. Farm Name The name of the Farm under which XenApp Server is Configured. Zone Name The name of the Zone in which XenApp Server belongs to. The ranking of server(like Most Preferred, Preferred, Default Preference, Not Preferred) in the Zone Ranking Zone. Domain Name The domain name to which XenApp Server belongs. Applications Parameter Description PUBLISHED APPLICATIONS Application The name of the Published Application. Name Application The Application ID is a number that uniquely identifies the application even if the application name ID changed. Server The name of the XenApp Server in which the application get published / deployed. Name Farm Name The name of the Farm in which application get published. Permissions The value of the application Read Only flag. Values are Read Only, Read/Write Folder The client''s Program Neighborhood folder. Name The value of the ''Enable application'' flag. When you publish an application, it is enabled by default. Application Enabled applications are then available to the users specified when the application was published. Status Disabled applications are not available to users. Sessions and Clients Parameter Description SESSION DETAILS Session ID The unique ID for each session created in XenApp Server. Session The name of the Session Name Session The name of the user who is running the Session User The Current state of the Session: userLoggedOn, connectedToClient, connectingToClient, Session shadowingOtherSession, loggedOnButNoClient, waitingForConnection, listeningForConnection, State resetInProgress, downDueToError, initializing. Client Name The session client name. The session client name is usually the client device name Number of The number of applications in Session Applications LogOn Time The session logon time Connect The connect time of the session Time Current The current time of the session Time Last Input the session''s last input time. Time Disconnect The last session disconnect time. If the session is connected, the time is 0 for all the values. Time ICA CLIENT DETAILS Client Name The session client name is usually the client device name. Client The network address of the client. Address ICA Buffer The ICA buffer length of the session. LengthEvent Log Parameter Description Rule Name The name of the event log rule Log File The Log File Type - Application, system, security, file replication service, DNS Server or directory Type service. Source The Application which created the event. Event Id The Event ID associated with the Event Log File. The Event Type - Error, Warning, Information or Event of Any Type. In case of Security Events, the Type types would vary between Success Audit and Failure Audit. User Name The system component or User account that was running the process which caused the event. Description A description of the event. Generated The time when the event entry was submitted. Time VMware Horizon View Monitoring Applications Manager lets you auto-discover, monitor and manage your VMware Horizon View environments. Applications Manager collects data from your managed virtual desktops and multiple Horizon View instances, spread across one or more datacenters. This data is then presented in preconfigured dashboards for real-time performance analysis. Applications Manager supports multiple Horizon View instances and provides you with a single intuitive dashboard that allows you to view all VMware Horizon View components, status of services used by the View and underlying infrastructure as well. While configuring the VMware Horizon View, Applications Manager discovers the following components as different monitors associates them to Monitor Group for Horizon View: VMware Horizon View Connection Broker Active Directory vCenter MsSQL or ORacle DB used for Events Query Monitor with events query Create a new VMware Horizon View Monitor : Click on New Monitor Group link. Select VMware Horizon View from the drop-down list. Specify the Display Name of the VMware Horizon View. Enter the Connection Broker Hostname or IP Address of the host where the Connection Broker is running. Enter User Name and Password for authentication. Specify the Polling Interval in minutes. Click Fetch Horizon View Components. This discovers the VMware Horizon View Components namely vCenter Servers, Active Directory, MsSQL or Oracle DB used for Events and Query Monitor with events query from the network and starts monitoring it. Note : Check out the Prerequisite for adding the Connection Broker monitor & the APM host. Create a new VMware Horizon View Connection Broker monitor: Click on New Monitor link. Select VMware Horizon View Connection Broker under the Virtualization category. Specify the Display Name of the VMware Horizon View. Enter the Connection Broker Hostname or IP Address of the host where the Connection Broker is running. Enter User Name and Password for authentication. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the VMware ESX server to, from the combo box (optional). Click Add Monitor(s). This discovers the VMware ESX/ESXi server from the network and starts monitoring it.Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on VMware Horizon View Connection Broker under the Virtualization Table. Displayed is the VMware Horizon View bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Connection Broker View Pool VM Details Session Details vCenter Details Composer Domain Details Events DB Details License Details Connection Broker Parameters Description Connection Broker Configuration Connection Broker ID The ID of the View connection broker. Name The name of the View connection broker. DNS Name The domain''s DNS name. NetBIOS Name The domain''s NetBIOS name of the connection broker server. IP Address The IP address of the connection broker server. Version VMware View Version. Build VMware View Buiild. Activation Activation Status. Is Alive Indicates whether the broker component is up. Last Backup Time The time during which the last View LDAP backup was performed. Type The internal monitoring type. External URL URL throught whichh other modules connects. Connection Broker Stats Total Sessions The total number of desktop sessions. Maximum Session The highest recorded number of current VDM sessions. Total SVI Sessions The current number of VDM SVI sessions. Maximum SVI Sessions The highest recorded number of current VDM SVI sessions. Total Checked Out VMs The current number of checked out VDM VMs. Maximum Checked Out VMs The highest recorded number of current checked out VDM VMs. View Pool Parameters Description Horizon View Pool Configuration Pool ID This indicates the View desktop pool ID. Spaces are not allowed when specifying the pool ID. Name The name of the desktop poolDatastore Path This specifies which datastores to use for provisioning full-clone desktops. This indicates the path to the resource pool that will contain the virtual desktops. If resource Resource Pool Path pools are not being used, simply specify the vSphere cluster. VM Folder Path This specifies the vCenter folder in which we have to create the virtual machines. Parent VM Path Indicates the full path to the parent VM used to export the network label data. Parent VM Snapshot Path Indicates the path to the parent VM snapshot, Composer Domain Your View Composer servers and the domains they are attached to. Indicates if the Hosted Virtual Desktop delivery model is automatically provisioned into View Delivery Model pools. Indicates if the provisioning of VM for VDM is enabled or not. Provision Enabled   Protocol This specifies the default display protocol from either RDP or PCoIP Horizon View Pool Stats This indicates the minimum number of linked-clone desktops that should be provisioned and Minimum Provisioned Desktops available during View Composer maintenance operations. This value must be smaller than the MinimumCount value. Head Room Count This specifies the minimum number of desktops to have powered on and available at all times. Maximum Count This specifies the maximum number of desktops to create. This specifies that desktops should be provisioned on demand, in amounts equal to the number Minimum Count provided. To provision all desktops up front, use the same value specified for MaximumCount. VM Details Parameters Description Horizon View VM Details Hostname The hostname of the virtual machine. IP Address The IP address of the virtual machine. VM Name The machine name of the virtual machine to be added to the pool. Guest Full Name The name of the guest machine. This retrieves desktops based on whether or not they are in a Is In Pool desktop pool. Options are true or false. Pool ID This indicates the desktop pool ID. This retrieves desktops based on whether or not they are a linked clone. Options are true or Is Linked Clone false. Machine ID The Physical machine ID used to identify the physical desktop. vCenter ID The vCenter Server ID. Path The full path to the parent virtual machine. Session Details Parameters Description Remote Sessions Details Session Indicates the View session ID for remote VMs. DNS Name Indicates the DNS name of the Virtual Desktop for remote VMs. Pool ID Indicates the desktop pool ID for remote VMs. Start Time Indicates the time the session was started including the day, time, time zone, and year. State Indicates the state of the desktop (Connected or Disconnected). Protocol Indicates the protocol being used in session (PCoIP or RDP).Duration Indicates the duration of the session. Local Sessions Details Session Indicates the View session ID for local VMs DNS Name Indicates the DNS name of the Virtual Desktop for local VMs Pool ID Indicates the desktop pool ID for local VMs Start Time Indicates the time the session was started including the day, time, time zone, and year. State Indicates the state of the desktop (Connected or Disconnected). Protocol Indicates the protocol being used in session (PCoIP or RDP). Duration Indicates the duration of the session. vCenter Details Parameters Description vCenter Configuration Hostname Hostname of the vCenter Server. Port This indicates the port to use with vCenter Server. Server URL The  URL of the vCenter via which the View connects. Composer URL The View Composer server URL. AD Configuration The Active directory configuration. Version The version of the vCenter server. Composer Enabled Indicates whether the View composer is enabled. Broker Entry The Connection Broker details. Create Ramp Factor This indicates the maximum concurrent vCenter desktop provisioning operations. Delete Ramp Factor This indicates the maximum concurrent desktop power operations. State The state of the vCenter. vCenter Certificate Details Hostname The hostname of the vCenter server. Certificate Valid The SSL certificate Validity. Validity Start Date The SSL certificate Validity start date. Validity Expiry Date The SSL certificate Validity expiry date. Reason The  resason for any SSL error. Certificate About To Expire The flag  to the certificate about to expire. Certificate Thumb print Matched The SSL certificate Thumb print matched or not. Composer Domain Details Parameters Description Domain The Active Directory Domain used for Vieew Set up. Username The administrator Username. vCenter ID The vCenter ID to which the set up is linked. Domains Domains and sum domain details Is Problem Health status of the Composer domain Events DB Details Parameters Description Server The database hostname. Port The database Port.Server Type The database type (MsSQL /Oracle DB). DB Name The database name of the Alerts & Events. Table Prefix The table prefix for alerts or events tables. State The health of the Events DB. Connected Indicates whether the database is connected. Connected Node The components that are connected. Error Error. License Details Parameters Description License Expiry Date The expiry date of the VMware View license. Local Mode Enabled Determines whether users can check out desktops for local use. View Composer Enabled Indicates whether users can use View Composer. OpenShift Monitoring OpenShift - Overview OpenShift is a powerful and flexible open source container application orchestrated and managed by Kubernetes. They’re complex to set up, monitor and maintain. To outmaneuver the operational challenges faced when dealing with OpenShift containers, round-the-clock OpenShift monitoring is necessary. Applications Manager''s OpenShift monitoring capabilities helps you to simplify application maintenance and ensures that OpenShift performance is up to par. Creating a new OpenShift monitor Using the REST API to add a new OpenShift monitor: Click here Follow the steps given below to create a new OpenShift monitor: Click on New Monitor link. Select Openshift under Virtualization category. Specify the Display Name of the OpenShift Server. Enter the Hostname of the server on which OpenShift is running.   If you choose the Use Below Credentials option, then enter basic authentication details used to connect with System using SSH. Check Public Key Authentication option if you use SSH2. Prompt - Specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. SSH Port - Enter the SSH Port. By default, it is 22. Enable the Collect major metrics using REST API option to collect the major metrics of Openshift environment through REST API. After enabling this option, enter the following information: Websocket Port: Port of the OpenShift application. By default, port number is 8443. Service Account Token: Service account token of the OpenShift cluster administrator user. Note: For the Service Account Token, the user should ensure that "Cluster Administrator Permission" is assigned. Click here to learn how to obtain the service account token Enter the OpenShift authentication details (OpenShift User Name and OpenShift Password) used to connect with cluster. If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Enable the Monitor Specific Project(s) option if you wish to monitor only specific project(s) in the OpenShift environment. After enabling, specify the following details: Filter Condition: Select the filtering condition to include or exclude monitoring of specific project(s) in the OpenShift environment. Project Name(s): Specify the name of the project(s) to be included/excluded while monitoring. You can enter multiple project names as comma-separated values. Specify the Timeout in seconds.Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the OpenShift to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the OpenShift from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on OpenShift under the Virtualization table. Displayed is the OpenShift bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the OpenShift monitor dashboard. It has 9 tabs- Overview Node Pods Containers Services Replica Jobs Persistent Volume Claims Overview Parameter Description CLUSTER USAGE DETAILS   Average Cluster CPU Usage  Average CPU used by the cluster in %. Average Cluster Memory Usage  Average memory used by the cluster in %. CLUSTER DETAILS - PODS   Pod Utilization  Number of pods used in %. Used Pod Count  Number of pods used. Maximum Pod Count  Total number of pods available. Project Details   Project Name  Name of the project. Project Display Name  Name given by the user. Project Requester  Name of the user who requested the project. Project Status  Status of the project. Project Description  Description of the project. Project Created Time  Time at which the project was created. Top 5 Nodes by Used Pod Count  Graph of top 5 nodes by used pod count. NODE DETAILS   Master Node Count  Number of Master nodes present. Worker Node Count Number of Worker nodes present. Component Details   Component Name  Name of the component. Status  Health of the component. Component Message  Message shown when the component status is unhealthy. Node Parameter Description Top 5 Nodes by CPU Usage  Graph of top 5 nodes by CPU Usage. Top 5 Nodes by Memory Usage  Graph of top 5 nodes by Memory Usage Node Memory & CPU Details   Name  Name of the Node Allocatable CPU Processor Count  Number of CPU processors that can be allocated in the node. CPU Limit(%)  CPU limit of the node in %. CPU Request(%)  Amount of CPU requested in %. Allocatable Memory(GiB)  Amount of memory allocatable in GiB. Memory Limit(%)  Memory limit of the node in %. Memory Request(%)  Amount of memory requested in %. Node Pod Details   Name  Name of the node.  Amount of pods used- Green represent free pods and red represents used Pod Usage Details pods. Used Pod Count  Number of pods used. Allocatable Pod Count  Number of pods allocatable. Pod Utilization(%)  Number of pods used in %. Image Count  Number of container images. Node Details   Name  Name of the node. Hostname  Name of the machine it is hosted on. Internal IP  IP address of the machine. OS  OS of the machine.  Type  Type of the machine. Allocatable Ephemeral  Amount of allocatable ephemeral storage in GiB. Storage(GiB)  You can perform the following action- Action Describe Instance-Detailed information about the instance is shown in a new tab. Pods Parameter Description Pod Details   Pod Name  Name of the pod.  Project Name  Name of the project in which the pod is created. Pod Node Name  Name of the node in which the pod resides. Pod Application  Name of the pod application. Pod Type  Type of the pod.  Pod IP  IP address of the pod.  Pod Status  Status of the pod. Pod Start Time  Time at which the pod was started. Pod Created Time  Time at which the pod was created.  Top 10 Pods by CPU Usage  Graph of top 10 pods by CPU Usage. Top 10 Pods by Memory Usage  Graph of top 10 pods by Memory Usage. Pod Memory & CPU Details   Pod Name  Name of the pod. Number of Containers  Number of containers in the pod. Pod CPU Limit(%)  CPU limit of the pod in %. Pod CPU Request (%)  Amount of CPU requested in %.  Pod Memory Limit(%)  Memory limit of the pod in %. Pod Memory Request(%)  Amount of memory requested in %. Pod Persistent Volumes Claim  Name of persistent volume claim of the pod. Containers  Parameter Description Top 5 Containers by Restart count  Graph of top 5 nodes by Restart count Container Details   Container Name  Name of the container. Container Image  Image of the container. Pod Name  Name of the pod which has the container. Container Status  Status of the container.  Container Restart Count  Number of times the container was restarted. Container Start Time  Time at which the container was started. Services Parameter Description Services Details   Name  Name of the service. Project Name  Name of the project in which the service is created. Application  Name of the application it is used in. Service Type  Type of the service. Cluster IP  IP address of the cluster.  Service Ports  Number of service ports.  Created Time  Time at which the service was created.  Deployment Details   Name  Name of the deployment.  Project Name   Name of the project in which the deployment is created. Replica Set  Name of the replica set. Desired Replica  Desired Replica specifies the number of pods that needs to be replicated. Running Replica  Running Replica displays the number of replicas that are currently running.  Available replica specifes the number of application replicas that are available to your Available Replica users. Deployment  States whether the deploymet is availablle or not. Availability  You can perform 2 actions- Actions Describe Instance - Detailed information about the instance is shown in a new tab. Delete Instance -  Deletes the instance from OpenShift environment. Replica Parameter Description Replication Controller   Details Name  Name of the Replication Controller. Project Name  Name of the project in which the replication controller is created.Desired Replica Desired Replica specifies the number of pods that needs to be replicated. Running Replica  Running Replica displays the number of replicas that are currently running.  Available replica specifes the number of application replicas that are available to Available Replica your users.  You can perform 2 actions- Describe Instance-Detailed information about the instance is shown in a new Actions tab. Delete Instance- Deletes the instance from OpenShift environment. Replication Set Details   Name  Name of the Replication Set. Project Name  Name of the project in which the replication set is created. Desired Replica  Desired Replica specifies the number of pods that needs to be replicated. Running Replica  Running Replica displays the number of replicas that are currently running.  Available replica specifes the number of application replicas that are available to Available Replica your users. You can perform 2 actions- Describe Instance - Detailed information about the instance is shown in a new Actions tab. Delete Instance - Deletes the instance from OpenShift environment. Jobs Parameter Description Name  Name of the job. Project Name  Name of the project in which the job is created. Parallelism  Parallelism Replica specifies the number of pod replicas running in parallel that should Replica execute a job.  Desired replica specifies the number of concurrently running pods that should execute a Desired Replica job. Successful  Displays the number of successful pod count Replica You can perform 2 actions- Actions Describe Instance-Detailed information about the instance is shown in a new tab. Delete Instance- Deletes the instance from OpenShift environment. Job Start Time  Time at which the job was started. Job  Time taken to complete the job. Completion(Min) Persistent Volume Claims Parameter Description PVC Name  Name of the PVC. Project Name  Name of the project in which the persistent volume claim is created. PVC Access Mode  Mode through which PVC can be accessed. PVC Storage Class  Mode of storage - Automatic or Manual. PVC Status  Status of the PVC. PV Name  Name of the persistent volume. PVC Request(GiB)  Amount of PVC requested in GiB.  PV Capacity(GiB)  Total capacity of PV in GiB.  PVC Created Time  Time at which the PVC was created. Kubernetes Monitor Kubernetes - An Overview Monitoring Kubernetes Clusters - What We do Adding a new Kubernetes monitor Monitored Parameters Kubernetes - An Overview Kubernetes (or k8s) is an open-source container orchestration system for automating deployment, scaling and management of application containers across clusters of hosts. Kubernetes clusters can span hosts across public, private, or hybrid clouds. K8s orchestration allows users to build application services across multiple containers, schedule those containers across a cluster, scale those containers, and manage the health of those containers over time. Monitoring Kubernetes Clusters - What We do Applications Manager''s Kubernetes monitoring lets administrators adapt monitoring strategies to account for the new infrastructure layers introduced (when adopting containers and the container orchestration) with a distributed Kubernetes environment. Auto-discover the parts and map relationships between objects in the cluster- Kubernetes nodes, namespaces, deployments, replica sets, pods, and containers. Track the capacity and resource utilization of your cluster and be able to drill into specific parts of the cluster. Identify if you have enough nodes in your cluster and resource allocations to existing nodes is sufficient for deployed applications. Ensure all nodes on the cluster are healthy - monitor the CPU and memory for Kubernetes nodes (workers and masters). Ensure all desired pods in a deployment are running and not in a restart loop. Set up alerts for Container restarts to identify issues with either a container or its host that affect performance of their applications. Monitor the performance outliers of the Kubernetes-hosted applications running inside your cluster and track down any individual errors. View the status of Kubernetes Master and Node components – API Server, the Etcd key/value store, Scheduler and Controller. Monitor the Persistent Volume storage that a pod might consume and the Persistent Volume Claim that grants exclusive usage to a pod for storage. Adding a new Kubernetes monitor Prerequisites for setting up Kubernetes monitoring: kubectl should be installed on the machine where Kubernetes is installed. Using the REST API to add a new Kubernetes monitor: Click here Follow the steps given below to create a new Kubernetes monitor: Click on New Monitor link.  Select Kubernetes under Virtualization category. Specify the Display Name of the Kubernetes Server. Enter the Cluster hostname/ IP address of the server where Kubernetes is running.  Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. Check the box to enable Public Key Authentication (Supported for SSH2 only), the SSH Key for SSH authentication. Specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. Enter the SSH port. Default SSH port used is 22. Enable the Monitor Specific Namespace(s)option if you wish to monitor only specific namespace(s) in the Kubernetes environment. After enabling, specify the following details:Filter Condition: Select the filtering condition to include or exclude monitoring of specific namespace(s) in the Kubernetes environment. Namespace Name(s): Specify the name of the namespace(s) to be included/excluded while monitoring. You can enter multiple namespaces as comma-separated values. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Kubernetes to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Kubernetes from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Kubernetes under the Virtualization table. Displayed is the Kubernetes bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Kubernetes monitor dashboard. It has five tabs - Overview Node Pods Services Persistent Volumes Overview Parameter Description NAMESPACE DETAILS Namespace Name Name of Namespace Resource Version The version number of Namespace Namespace Availability Availability of Namespace Namespace CreatedTime Time at which the Namespace was created PODS Used Pods Count Number of pods used Maximum Pods Count Maximum number of pods Used Pods Count per Node Number of pods in a single node CLUSTER USAGE DETAILS Average Cluster CPU Usage Average CPU used by the cluster Average Cluster Memory Usage Average memory used by the cluster NODE Master Node Count Number of master nodes Worker Node Count Number of worker nodes CLUSTER DETAILS Contains detailed information about the cluster COMPONENT DETAILS Contains detailed information about the component Node Parameter Description NODE MEMORY DETAILS Node Memory Limit Maximum limit of Node memory in GiB Node Memory Requests Number of memory requestsNODE CPU DETAILS Node CPU Limit Maximum limit of CPU Node CPU Request Number of CPU requests NODE MEMORY AND CPU DETAILS Name Name of the node Allocatable Memory(GiB) The CPU resources of a node that are available for scheduling in GiB Memory Limit(%) The maximum limit of memory resource which can be used Memory Request(%) Number of memory requests in % Allocatable CPU Processor Count The number of CPU processes that are available CPU Limit(%) The maximum limit of CPU resource which can be used CPU Request(%) Number of CPU requests in % NODE POD DETAILS Name Name of the pod Pod Usage Details Total number of pods available with used and free pods split-up. Kube-system Pod Count Number of Kube state pods Non-Kube-system Pod Count Number of non-Kube state pods Image Count Number of images in the node Used Pod Count Total num of pods present in Kubernetes Allocatable Pod Count Number of pods that are available NODE DETAILS Name Name of the node OSImage OSImage name OS Name of the OS in which the container is deployed Architecture Architecture details Type Type of node Kubelet Version The version of Kubelet used Allocatable Ephemeral Storage(GiB) Size of temporary memory available in GiB Created Time Time at which the node was created Pods Parameter Description POD DETAILS Pod Name Name of the pod Pod Namespace Namespace in which the pod resides Pod Node Name Name of the pod-node Pod Application Name of the pod application. Pod Type Type of pod. Pod created The means by which the pod was created. Pod Running Status Status of the pod. Pod Start Time The start time of the pod. Pod Created Time Time at which the pod was created. POD MEMORY DETAILS Pods Memory Limit Maximum limit of memory. Pods Memory Request The number of memory requests. POD MEMORY AND CPU DETAILS Pod Name Name of the pod. Number of Containers The number of containers run by the pod. Pod CPU Limit(%) The maximum limit of CPU resource which can be used.Pod CPU Request (%) The number of CPU requests by pod in %. Pod Memory Limit(%) The maximum limit of memory resource that can be used. Pod Memory Request(%) The number of memory requested in %. Pod created The means by which the pod was created. Pod Persistent Volumes Claim Name of the Claim through which a pod can access the persistent volume. CONTAINER DETAILS Container Name Name of the container. Container Image Name of the container image. Container Pod Name Name of the container pod. Container Restart Count The number of times the container has restarted. Container Running Status Status of the container. Container Start Time Start time of the container. Services Parameter Description SERVICE DETAILS Services Name Name of the service. Services Namespace Name of the Namespace in which the service resides. Services Application Name of the Service application. Service Type Type of the service. Service Protocol Name of the service protocol. Service Target Port Name of the port that connects with the service. Service Created Time Creation time of the service. DEPLOYMENT DETAILS Deployment Name Name of the deployment. Deployment Namespace Namespace where the deployment exists. Deployment Replica Count The number of replicas in a deployment. Deployment Available Replica Count Number of available replicas in a deployment. Deployment Availability Availability of the deployment. Persistent Volumes Parameter Description PERSISTENT VOLUMES DETAILS PV Name Name of the Persistent Volume. PV Status Status of the Persistent Volume. PV Claim Name of the Persistent Volume Claim. PV Access Mode The mode through which you can access the Persistent Volume. PV Storage Class Name of the Persistent Volume storage class. PV Capacity(GiB) The capacity of the Persistent Volume in GiB. PV Created Time Creation time of the Persistent Volume. PERSISTENT VOLUMES CLAIM DETAILS PVC Name Name of the Persistent Volume Claim. PVC Namespace Name of the Namespace in which the Claim exists. PVC Status Status of the Persistent Volume Claim. PVC Volume Volume of the Persistent Volume Claim. PV Access Mode The mode through which you can access the Persistent Volume. PV Storage Class Name of the Persistent Volume storage class.PVC Requests(GiB) Number of Persistent Volume Claim requests in GiB. PVC Created Time Creation time of Persistent Volume Claim. Citrix Virtual Apps and Desktops Monitoring Overview Citrix Virtual Apps and Desktops are the industry’s leading solutions for application and desktop delivery, with over 100 million users worldwide. Citrix Virtual Apps and Desktops enable secure, remote access to Windows applications and desktops as well as Linux, web and SaaS applications from any device, over any network. It is widely used in Healthcare, Finance, Government, Manufacturing and Education. Applications Manager provides monitoring support and virtual machine management of your Citrix Virtual Virtual Apps and Desktop Infrastructure with a comprehensive view into individual components. With the aid of our Citrix Virtual apps and desktops monitoring solution, you can monitor key metrics such as Desktop Groups, Machines, Applications and Sessions of your Citrix Virtual Apps and Desktop environments for easier management and to detect performance problems. Creating a new Citrix Virtual Apps and Desktops monitor Using the REST API to add a new Citrix Virtual Apps and Desktop monitors: Click here Follow the steps given below to create a new Citrix Virtual Apps and Desktop monitors: Click on New Monitor link. Select Citrix Virtual Apps and Desktop under Virtualization category. Specify the Display Name of the Citrix Virtual Apps and Desktop. Enter the Host Name of the host where the MS SQL server for Citrix Virtual Apps and Desktop runs. Enter the Port where the MS SQL server for Citrix Virtual Apps and Desktop service runs. The default port is 1443. Provide the User Name and Password of user who has permission to access the MS SQL database. The user name specified for collecting the data from MS SQL Server should have either System Administrator role or the user should be the db_owner or db_datareader for master database. Alternatively, you can provide the Windows Authentication details also (by entering the User Name like \ ). Specify the Database Name used. Choose Force Encryption option if the server is configured for encrypted connections. If the server is in Non- SSL mode or if it is configured to support TLS, then this option should be disabled. If you want to connect using a Named Instance, enable the Connect using Named Instance checkbox and specify the Instance name. Choose jTDS JDBC Driver or Microsoft JDBC Driver option in Driver for SQL Server Connection field to choose the required driver for connecting to the database for data collection. Specify the Polling Interval in minutes. Choose the Monitor Group from the combo box with which you want to associate Citrix Virtual Apps and Desktop monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Citrix Virtual Apps and Desktop from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Citrix Virtual Apps and Desktop under the Virtualization table. Displayed is the Citrix Virtual Apps and Desktop bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the tabs listed below to view the corresponding metrics monitored: Overview Desktop Group Machine Resource Utilization Applications SessionsOverview Parameter Description MACHINE DETAILS No. of Machines Number of machine in the Citrix Virtual Apps and Desktop. Machines in Running State Number of machines in Running state Machines in Failure State Number of machines in Failure state. DESKTOP GROUP DETAILS No. of Desktop Groups Total number of desktop groups in Citrix Virtual Apps and Desktop. Desktop Group in Non Maintenance Number of desktop groups in non maintenance mode. Mode Desktop Group in Maintenance Mode Number of desktop groups in maintenance mode. APPLICATION DETAILS Number of applications present in the Citrix Virtual Apps and No. of Applications Desktop. Applications in Fault State Number of applications in Fault state. Applications in Error State Number of applications in Error state. SESSION DETAILS No. of Sessions Total number of sessions running in the last 2 hours. Active Sessions Number of sessions that are active. Disconnected Sessions Number of sessions that are disconnected in the last 2 hours. Failure Sessions Number of sessions that are failed in the last 2 hours. Desktop Group Parameter Description Top 5 Desktop Group by Associated Machine Count - Displays a graphical representation of the top 5 Desktop Groups with respect to the number of machines associated. Top 5 Desktop Group by Associated Application Count - Displays a graphical representation of the top 5 Desktop Groups with respect to the number of applications associated. Desktop Group Session Details Desktop Group Name Name of the desktop group. Connected Session Number of sessions that are connected. Disconnected Session Number of sessions that are disconnected. Concurrent Session Number of sessions that are concurrent. Total LogOn Duration (min) Total amount of logon duration (in minutes). Total LogOn Total number of LogOns seen in the desktop group. Desktop Group Config Details Desktop Group Name Name of the desktop group. Remote PC Indicates whether the desktop group is in remote PC. (True or False) Desktop Kind Indicates whether the desktop group is in Desktop type. (True or False) Maintenance Mode Indicates whether the desktop group is in maintenance mode. (True or False) Associated Machine Number of machines associated for this desktop group. Associated Application Number of applications associated for this desktop group. Created Date Timestamp at which the desktop group was created. Machine Parameter Description Machine Status DetailsMachine Name Name of the machine. Maintenance Mode Indicates whether the machine is in maintenance mode. (True or False) Machine Status Status of the machine. (Running or Fault) Failure Date Timestamp at which the machine went into Fault state. Machine Config Details Machine Name Name of the machine. IP Address IP address of the machine. OS Type Type of OS installed. Desktop Group Name Name of the desktop group to which this machine is associated. Created Date Timestamp at which the machine was created. Resource Utilization Parameter Description Top 10 Machine by CPU Usage - Displays a graphical representation of the top 10 machines with respect to the percentage of CPU utilized. Machine Resource Utilization Details Machine Name Name of the machine. CPU Usage Amount of CPU utilized by the machine (in percentage). Total Memory(GiB) Total amount of memory allocated for the machine (in GiB). Used Memory(GiB) Total amount of memory utilized by the machine (in GiB). Current Session Number of live session that are currently running in the machine. Machine IOps Machine Input/Output per second (in IOps). Latency Latency of the machine. Machine Associated Details Machine Name The name of the machine. Assigned Indicates whether the machine is assigned to any user. (True or False) Pending Update Indicates whether the machine having any update pending. (True or False) Associated Users Count Number of users that are associated to this machine. Associated Users Displays the list of users that are associated to this machine. Applications Parameter Description Top 10 Application by Instance Count - Displays a graphical representation of the top 10 applications with respect to the number of instances available. Application Status Details Application Name Name of the application. Instance Count Number of instances present in the application. Status Status of the application. (Enabled or Disabled) Application Type Type of the application running. Application Config Details Application Name Name of the application. Published Name Display name of the application. Path Directory path in which the application is located. Browser Name Name of the browser that is running the application. Created Date Timestamp at which the application was created. Modified Date Timestamp at which the application was modified. SessionsParameter Description Top 10 Machine by Session Count - Displays a graphical representation of the top 10 machines with respect to the number of sessions running. Active Session Details Session ID ID of the session. User ID ID of the user that has initiated the session. Machine Name Name of the machine. Login Duration Time duration of the login session (in minutes). ICA RTT ICA Round Trip Time (in ms). Start Date Timestamp at which the session was started. Failure Session Details (last 2 hours) Session ID ID of the session. User ID ID of the user that has initiated the session. Machine Name Name of the machine. Session Duration Time duration of the session (in minutes). ICA RTT ICA Round Trip Time (in ms). Start Date Timestamp at which the session was started. Failure Date Timestamp at which the session was failed. Converged Infrastructure Below are the list of Converged Infrastructure tools that are monitored in Applications Manager: Nutanix Cisco UCS Browse through the different HCI servers that provide server information and their parameters being monitored. Nutanix Monitoring Creating a new Nutanix monitor Follow the steps given below to create a new Nutanix monitor: Click on New Monitor link. Select Nutanix under Converged Infrastructure category. Specify the Display Name of the Nutanix Server. Enter the Cluster Hostname / IP address of the server on which Nutanix is running.   Specify the Port at which Nutanix web service is running. The Default Port is 9440. If you choose the Use Below Credentials option, then enter the credentials - UserName and Password of the Nutanix Host Machine. UserName - Name of the User who has the permission.   Password - Password of the above user. If you choose the Select from credential list option, then select the respective credential from preconfigured credential list. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Nutanix to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Nutanix from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Nutanix under the Converged Infrastructure table. Displayed is the Nutanix bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days.List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Nutanix monitor dashboard. It has 5 tabs: Overview Host IO Storage Alerts/Events To find out about the metrics monitored in VMs discovered in Nutanix, click here. Overview Parameter Description CPU Cluster CPU Usage CPU used by cluster in % Memory Cluster Memory Usage Memory used by cluster in % Cluster Details Cluster Name Name of the cluster Cluster Version Version number of the cluster Cloud Cluster If the cluster is a cloud cluster, the value shows "true", else "false". Multi Cluster If the cluster is a multi cluster, the value shows "true", else "false". Hardware Details Number of Hosts Number of hosts in the hardware. Number of Blocks Number of blocks in the hardware. Hypervisor Name of the hypervisor. Number of VMs Number of VMs in the hardware. Memory Details Total Physical Memory Total physical memory in % Used Physical Memory Total memory used by cluster in % Free Physical Memory Total memory unused in % Number of VMs per Host Number of VMs per host Virtual Machines Virtual Machine Name of the virtual machine. Host Name Name of the host. VM State State of VM - On/Off CPU Usage(%) CPU used by VM in % Memory Usage (%) Memory used by VM in % Host Parameter Description Host CPU Usage CPU used by host in % Host Memory Usage Memory used by host in % Host CPU and Memory Details Host Name Name of the host CPU Usage (%) CPU used by host in % CPU Capacity (GHz) Total capacity of CPU in GHz Memory Usage (%) Memory used by host in %Parameter Description Memory Usage (GiB) Memory used by host in GiB Memory Capacity (GiB) Memory capacity in GiB Host Disk Details Disk Usage(GiB) Disk used in GiB Disk Capacity (GiB) Disk capacity in GiB Disk IOPS (IOps) Disk IOPS in IOps Disk IO Bandwidth (MBps) Disk IO Bandwidth in MBps Disk IO Latency (ms) Disk IO Latency in ms Host Configuration Details Host Name Name of the host Hypervisor IP address IP address of the Hypervisor Number of VMs Number of VMs Hypervisor Type Type of Hypervisor Hypervisor State State of Hypervisor IO Parameter Description Cluster IOPS Total Cluster IOPS in IOps Cluster Read IOPS Cluster read IOPS in IOps Cluster Write IOPS Cluster write IOPS in IOps Cluster Bandwidth Total Cluster Bandwidth in MBps Cluster Read Bandwidth Cluster read Bandwidth in MBps Cluster Write Cluster write Bandwidth in MBps Cluster Latency Total Cluster Latency in ms Cluster Read Latency Cluster read Latency in ms Cluster Write Latency Cluster write Latency in ms Storage Parameter Description Disk Details Disk ID Disk ID Name Name of the disk Type Disk type Status Status of the disk Path The path at which the disk resides Capacity (GiB) Capacity of disk in GiB Free (GiB) Free disk in GiB Used (GiB) Used disk in GiB Storage Container Details Name Name of the Storage Container Replica factor Replica factor of storage container Capacity (GiB) Capacity of storage container in GiB Free (GiB) Amount of storage free in GiB Used (GiB) Amount of used in GiB Alerts/EventsParameter Description Alert Details Alert ID Alert ID Issue Issue for which alert was generated Severity Severity of the alert Affected Entities in Alert Entities which were affected because of the alert Resolved Shows whether the issue was resolved or not Resolved Time Shows the time at which it was resolved AutoResolved Shows whether it was automatically resolved Acknowledged User Shows the user who acknowledged it Acknowledged Time Shows the time at which the user acknowledged it Event Details Event ID Event ID Message Event message Affected Entities in Event Entities which were affected because of the event Event Created Time Creation time of the Event Acknowledged User Shows the user who acknowledged it Acknowledged Time Shows the time at which the user acknowledged it Nutanix VM monitoring Applications Manager monitors the virtual machines configured in the Nutanix server. It gives the ability to manage VMs (Start/Stop/Restart) from the Applications Manager web client in case of any performance problems. VM On clicking child VMs, you will be taken to the VM monitor dashboard. It has the following tabs: Overview Storage IO Processes Overview Parameter   Description  CPU Usage  CPU used by VM in %  Memory Usage  Memory used by VM in %  Number of VCPUs  Number of processors in VM  VM memory  VM memory capacity  VM State  State of VM- On/Off  VM IP Address  IP address of the VM  Host Name  Name of the host Storage Parameter   Description  Disk Details   Disk ID   Disk ID  Capacity (MiB)  Capacity of the disk in MiB  Used (MiB)  Amount of Disk used in MiBParameter   Description  Free (MiB)  Amount of Disk free in MiB IO Parameter   Description  Controller IOPS  Total Cluster IOPS in IOps  Controller Read IOPS  Controller read IOPS in IOps  Controller Write IOPS  Controller write IOPS in IOps  Controller Bandwidth  Total Controller Bandwidth in MBps  Controller Read Bandwidth  Controller read Bandwidth in MBps  Controller Write   Controller write Bandwidth in MBps  Controller Latency  Total Controller Latency in ms  Controller Read Latency  Controller read Latency in ms  Controller Write Latency  Controller write Latency in ms Processes Parameter   Description  Process Details  Name   Name of the process  Process   Process type  No Of Instances  Number of instances   CPU (%)  CPU consumed by the process in % Mem(%)  Memory consumed by the process in % CISCO UCS Monitoring Overview Creating a new monitor Monitored Parameters Overview The Cisco Unified Computing System (CISCO UCS) is a next-generation data center platform that unites compute, network, storage access, and virtualization into a cohesive system designed to reduce total cost of ownership (TCO) and increase business agility. Applications Manager offers monitoring for Cisco UCS environments, where you can monitor and track various KPIs of the applications and the system. It collects real-time Cisco UCS''s data to present it in a dashboard that is easy to understand and helps you to identify the reason why your system has deviated from the ideal performance. Creating a new monitor Follow the steps given below to create a new Cisco UCS monitor: Click on New Monitor link. Select Cisco UCS under Converged Infrastructure category. Specify the Display Name. Enter the Hostname / IP address of the server on which Cisco UCS Manager is running. Specify the Port at which Cisco UCS Manager is running. The default port is 80. Choose SSL is enabled option, if Cisco UCS Manager is to be accessed via SSL port. Enter the credential details like username and password of the Cisco UCS Manager for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. Specify the Timeout value in seconds. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Cisco UCS Manager to, from the combo box (optional). You can choose multiple groups to associate your monitor.Click Add Monitor(s). This discovers the Cisco UCS Manager from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Cisco UCS under the Converged Infrastructure table. Displayed is the Cisco UCS bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Cisco UCS monitor dashboard. It has 9 tabs - Overview Chassis Rack Mount Fabric Interconnect Processors Fans I/O Modules Ports Faults Overview This tab provides details about the overall count of all the components present in the UCS system. Parameter Description Server Response Time: Response time The response time of the Cisco UCS Manager. (ms) Components: Total number of Chassis Servers The total number of Chassis servers in the UCS system. Total number of Rack Mount Servers The total number of Rack Mount servers in the UCS system. Total number of Fabric Extenders The total number of fabric extenders in the UCS system. Total number of Fabric Interconnects The total number of fabric interconnects in the UCS system. Total number of Processor Units The total number of processor units in the UCS system. Total number of Adaptor Units The total number of adaptor units in the UCS system. Total number of I/O Modules The total number of input-output modules in the UCS system. Chassis This tab provides details about the performance metrics of various chassis available in the UCS system. Parameter Description Chassis: Chassis Name The name of the chassis. Chassis Server Count The number of Chassis servers present in the chassis. I/O Module Count The number of input-output modules present in the chassis. Fan Count The number of fans available in the chassis. Power Unit Count The number of power units (PSU) available for the chassis. Chassis Operational The operational status of the chassis. ( Operable / Degraded ) Status Chassis Server: Name The name of the blade server. Chassis Name The name of the chassis.Parameter Description Model The model name of the blade server. Operablility Denotes the operability condition of the blade server. Power The power state of the blade server. (On / Off) Adaptor count The number of adaptors available. Network Interface Cards The number of Network Interface Cards present. Memory and CPU: Name The name of the blade server. Chassis Name The name of the chassis. Core count The number of CPU cores available. Core Enabled The number of CPU cores that are enabled. CPU count The number of CPUs available. Thread count The total number of threads available in the CPUs. Available Memory The amount of memory available in the server. (GB) Total Memory The total amount of memory allocated to the server. (GB) Available Memory % The amount of memory available in the server. (%) Utilized Memory % The amount of memory utilized by the server. (%) Motherboard Power: Name The name of the blade server. Chassis Name The name of the chassis. Power Consumed The amount of power currently being consumed by the motherboard. ( Watts ) Max Power Consumed The maximum amount of power consumed by the motherboard. ( Watts ) Min Power Consumed The minimum amount of power consumed by the motherboard. ( Watts ) Input Current The amount of input current flowing to the motherboard currently. ( Ampere ) Max Input Current The maximum amount of input current received by the motherboard. ( Ampere ) Min Input Current The minimum amount of input current received by the motherboard. ( Ampere ) Input Voltage The amount of input voltage currently being fed to the motherboard. ( Voltage ) Max Input Voltage The maximum amount of voltage received by the motherboard. ( Voltage ) Min Input Voltage The minimum amount of voltage received by the motherboard. ( Voltage ) Motherboard Temperature: Name The name of the blade server. Chassis Name The name of the chassis. Front Temperature The temperature value indicated by the front-panel temperature sensor. ( Celsius ) Rear Temperature The temperature value indicated by the rear-panel temperature sensor. ( Celsius ) The temperature value indicated by the left rear-panel temperature sensor. ( Celsius Rear Temperature Left ) Rack Mount This tab provides details about the performance metrics of various rack mount servers available in the UCS system. Parameter Description Rack Mount Server: Name The name of the blade server. Model The model name of the rack server. Operability Denotes the operational condition of the blade server. Power The power state of the blade server. (On / Off) Adaptor count The number of adaptors available. Network Interface Cards The number of Network Interface Cards available.Parameter Description Memory and CPU: Name The name of the rack server. Core Count The number of CPU cores available. Core Enabled The number of CPU cores enabled. CPU Count The number of CPUs available. Thread Count The total number of threads available in the CPUs. Available Memory The amount of memory available in the server. (GB) Total Memory The total amount of memory allocated to the server. (GB) Available Memory % The amount of memory available in the server. (%) Utilized Memory % The amount of memory utilized by the server. (%) Motherboard Power: Name The name of the rack server. Power Consumed The amount of power currently being consumed by the motherboard. ( Watts ) Max Power Consumed The maximum amount of power consumed by the motherboard. ( Watts ) Min Power Consumed The minimum amount of power consumed by the motherboard. ( Watts ) Input Current The amount of input current flowing to the motherboard currently. ( Ampere ) Max Input Current The maximum amount of input current received by the motherboard. ( Ampere ) Min Input Current The minimum amount of input current received by the motherboard. ( Ampere ) Input Voltage The amount of input voltage currently being fed to the motherboard. ( Voltage ) Max Input Voltage The maximum amount of voltage received by the motherboard. ( Voltage ) Min Input Voltage The minimum amount of voltage received by the motherboard. ( Voltage ) Motherboard Temperature: Name The name of the rack server. Front Temperature The temperature value indicated by the front- panel temperature sensor. ( Celsius ) Rear Temperature The temperature value indicated by the rear - panel temperature sensor. ( Celsius ) Ambient Temperature The ambient temperature value of the motherboard. ( Celsius ) IO Hub1 Temperature Right The temperature value of I/O Hub1. ( Celsius ) IO Hub2 Temperature Right The temperature value of I/O Hub2. ( Celsius ) Fabric Interconnect This tab provides details about the performance metrics of various Fabric Interconnects available in the UCS system. Parameter Description Fabric Interconnect: Name The name of the Fabric Interconnect ( FI ). Fan The number of fans associated with the FI. Power Supply Unit Count The number of Power Supply Units (PSU) available in the FI. Fabric Interconnect Software: Name Name of the Fabric interconnect ( FI ) Available Memory The amount of memory available in the server. (GB) Total Memory The total amount of memory allocated to the server. (GB) Cached Memory The amount of cached memory of the server. (GB) Available Memory % The amount of memory available in the server. (%) CPU utilization % The current CPU utilization of the server. (%) Fabric Interconnect Power Unit (PSU): Name The name of the PSU.Parameter Description Fabric Interconnect The name of the Fabric Interconnect ( FI ). Power Consumed The amount of power currently being consumed by the PSU. ( Watts ) Max Power Consumed The maximum amount of power consumed by the PSU. ( Watts ) Min Power Consumed The minimum amount of power consumed by the PSU. ( Watts ) Input Current The amount of input current flowing to the PSU currently. ( Ampere ) Max Input Current The maximum amount of input current received by the PSU. ( Ampere ) Min Input Current The minimum amount of input current received by the PSU. ( Ampere ) Input Voltage The amount of input voltage currently being fed to the PSU. ( Voltage ) Max Input Voltage The maximum amount of voltage received by the PSU. ( Voltage ) Min Input Voltage The minimum amount voltage received by the PSU. ( Voltage ) Fabric Extender: Name The name of the Fabric Extender ( FEX ). Fan The number of fans associated with the FEX. I/O Module The number of I/O modules present in the FEX. Power Supply Unit Count The number of Power Supply Units (PSU) present in the FEX. Processors This tab provides details about the performance metrics of various processors available in the UCS system. Parameter Description Processors Name The name of the processor. Equipment The equipment at which the processor is present. Model The model name of the processor. Speed The speed of the processor. Core Count The number of cores available. Core Enabled The number of cores enabled. Thread Count The number of threads available. CPU Temperature The current temperature value of the CPU. CPU Input current The current input current value of the CPU. Fans This tab provides details about the performance metrics of various fans available in the UCS system. Parameter Description Fan Module: Name The name of the fan module. Equipment The equipment at which the fan module is present. Fans The number of fans available in the module. Thermal Condition The thermal condition of the fan module. Fan Module Power The power state of the fan module. (On/Off) Fan Module Operability Denotes the operability of the fan module. Fans: Name The name of the fan. Fan Module The name of the fan module. Equipment The equipment at which the fan module is present. Model The model name of the fan. Thermal Condition The thermal condition of the fan.Parameter Description Fan Power The power state of the fan. (On/Off) Fan Operability Denotes the operability of the fan. Drive Percentage The drive performance of the fan. (%) Speed The speed of the fan. (RPM) Max Speed The maximum speed of the fan. (RPM) Min Speed The minimum speed of the fan. (RPM) I/O Module This tab provides details about the performance metrics of various I/O modules available in the UCS system. Parameter Description I/O Module: Name The name of the I/O module. Equipment The equipment at which the I/O module is present. Model The model name of the I/O module. Thermal Condition The thermal condition of the I/O module. Operability Denotes the operability of the I/O module. Ports This tab provides details about the performance metrics of various ports available in the UCS system. Parameter Description Ethernet ports: Name The name of the Ethernet port. Equipment The equipment at which the Ethernet port is present. Mac Address The MAC address of the Ethernet port. Interface Role The interface role of the Ethernet port. Interface Type The interface type of the Ethernet port. Ethernet port status The operability status of the Ethernet port. Ethernet Admin State The admin state of the Ethernet port. Slot ID The slot ID associated with the Ethernet port. Operational Speed The operational speed of the Ethernet port. Backplane ports: Name The name of the backplane port. Equipment The equipment at which the backplane port is present. Slot ID The slot ID associated with the backplane port. Mac Address The MAC address of the backplane port. Interface Role The interface role of the backplane port. Interface Type The interface type of the backplane port. BackPlane Port status The operability status of the backplane port. BackPlane Admin State The admin state of the backplane port. Fabric ports: Name The name of the fabric port. Equipment The equipment at which the fabric port is present. Slot ID The slot ID associated with the fabric port. Mac Address The MAC address of the fabric port. Interface Role The interface role of the fabric port. Interface Type The interface type of the fabric port.Parameter Description Fabric Port status The operability status of the fabric port. Fabric Admin State The admin state of the fabric port. Faults This tab provides details about the faults that are available in the UCS system. Parameter Description Fault Statistics: Critical Faults The number of faults that are of Critical severity. Major Faults The number of faults that are of Major severity. Minor Faults The number of faults that are of Minor severity. Warning Faults The number of faults that are of Warning severity. Faults between consecutive polls: Fault Code The fault code which describes the fault. Fault Id The ID of the fault occurred. Type The severity type of the fault occurred. (Critical/Major/Minor/Warning) Fault Affected object The hardware object that was affected by the fault.  Fault Cause The cause for the fault to occur. Fault Created Time The time at which the fault was created. Last transition Time The time at which the state of fault was changed. Fault Description The description of the fault occurred. Show All Faults Displays all the faults that are currently present in the system. Web Server / Services Applications Manager supports monitoring of the following Web Services to check their status : Apache Server IIS Server Nginx Server Real Browser Monitor PHP SSL Certificate Monitor Web Server Web Services HTTP - URLs and HTTP - URL Sequence (Record and Playback) REST API It performs the following checks to ensure its availability and represents the information in the form of graphs. Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed to view the following information. Apache Server Prerequisites: Refer to the Prerequisites that are needed for Apache Web Server monitoring. Using the REST API to add a new Apache server monitor: Click here To create an Apache monitor, follow the steps given below:Click on New Monitor link. Choose Apache Server. Enter the hostname or IP Address (IPv4/IPv6) of the host in which the monitor is running. Enter the SubNetMask of the network. Provide the port number in which the monitor is running. Choose SSL option, if SSL is enabled in Apache Server. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Enter the Apache User Name and Password if the Apache Server is authenticated. Modify the Apache Server Status URL if required. The default Server Status URL through which the data transfer details, access details, etc., are collected is http:// server-status?auto. You can now modify the server status URL using this option, if the server status URL is different. Choose the Monitor Group from the combo box with which you want to associate Apache Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Apache from the network and starts monitoring them. Following are the list of metrics that are monitored in Apache Web Server monitoring: Service Checks Type Connects to the Apache and checks its availability and response time. When Server Status and Extended Status are enabled, then the following data can be obtained. Parameters Description Response Time The time taken for the apache server to respond while monitoring in milliseconds. CPU Load Specifies the percentage of load on the machine. Requests/Minute The average number of requests received by the server in one minute. Bytes/Request The number of bytes transferred per request. Busy Servers Number of workers currently busy. Idle Servers Number of workers currently idle. Bytes per Sec The number of bytes transferred per second. To Enable the Server Status, follow the steps given below: 1. In Apache''s httpd.conf file, locate "Location /server-status" tag. If you are not able to locate the server-status tag, do the following. 2. Remove the comment in the Location/Server-status tag, to Enable SetHandler server-status 3. Change the attribute "Deny from All"  to "Allow from "  (Replace with the IP address of the Applications Manager server). Apache 4. Remove the comment in "LoadModule status_module modules/mod_status.so". Server 5. Save the conf file and restart the Apache Server To enable the Extended-status, follow the steps given below: 1. Locate "ExtendedStatus" Attribute in httpd.conf file.  2. Remove the comment to enable the status.  3. Save the conf file and restart the Apache Server Note: For Apache 2.2.3 and above, make the following changes in the /opt/apache-httpd-2.2.3/conf/httpd.conf file. Add the following lines at the end of the file, SetHandler server-status Order deny,allow Allow from ExtendedStatus On Then restart the Apache server, try to connect to http:// /server-status and then you should be able to view the server status. Note: Click here for more information about the configurationNginx Server To create a Nginx Monitor, follow the steps given below: Click on New Monitor link. Choose Nginx Server. Enter Display Name of the server. Enter the IP Address or hostname of the host in which the monitor is running. Provide the port number in which the monitor is running. Choose SSL option, if SSL is enabled in Nginx Server. Enter the Nginx User Name and Password if the Nginx Server is authenticated. Modify the Nginx Server Status URI if required. This is for getting the server status. The default Server Status URI is nginx_status. You can modify the server status URI using this option, if the server status URI is different. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Nginx Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Nginx Server from the network and starts monitoring them. To Enable the Server Status, follow the steps given below: Configure the location /server_status method in nginx.conf file, to enable server_status. The value of stub_status attribute should be "on". Change the attribute "deny all" to "Allow all". Save the conf file and restart the Nginx Server. Connects to the Nginx server and checks its availability. Active Connections: Refers to connections that are active currently. Requests Per Second: Refers to number of requests received per second. Nginx Server Requests in Reading State: Refers to number of requests in reading state currently. Requests in Writing State: Refers to number of requests in writing state currently. Requests in Waiting State: Refers to number of requests in waiting state currently. PHP To create a PHP Monitor, follow the steps given below: Find the phpstats.php file that''s bundled with Applications Manager. The file is located at: AppManager_Home folder -> Working\resources folder -> phpstats.php. Place the phpstats.php file in the webserver''s document root to start monitoring. Applications Manager connects to the server and retrives PHP and checks its availability. Click on New Monitor link. Select PHP Monitoring. Enter the IP Address or hostname of the host in which the Monitor is running. Enter the SubNetMask of the network. Provide the port number in which the monitor is running. Choose SSL option, if SSL is enabled in PHP.Enter the path to be connected. By default, '' /phpstats.php '' is shown. http://hostname:portNo/"path to be connected" will be used for connection Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate PHP Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the PHP Service from the network and starts monitoring them. Connects to the server and retrives PHP and checks its availability. PHP Monitors response time and updates the status based on a given threshold. Monitoring In Linux, Page fault of the system in which the PHP is hosted is also shown. We can configure the alarm and actions based on the threshold condition. SSL Certificate Monitor To create a SSL Certificate Monitor, follow the steps given below: Click on New Monitor link. Choose SSL Certificate Monitor. Provide an appropriate Display Name for the SSL Certificate monitor. Enter the Domain name for which SSL certificate is required to be monitored. Provide the port in which the server is running [Default port is 443]. Check the box Need proxy to connect to the domain if the server is connected through proxy. In such cases you should also configure proxy server settings through the ''Configure Proxy'' option available in the ''Admin'' tab. Enable the Ignore invalid root and intermediate certificate checkbox if you wish to ignore invalid/expired root or intermediate certificates while accessing a website. This option is enabled by default. Enter the Timeout value in seconds. Provide the polling interval in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate the SSL Certificate Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the SSL Certificate from the server and starts monitoring it. Connects to the server and retrieves the details pertaining to the validity and authenticity of the SSL Certificate. Monitors the availability and response time of the domain being added. Issued To: Displays the details of the organization for which the certificate is issued. SSL Certificate Monitoring Issued By: Displays the details about the Certification Authority of your domain. Validity: Specifies details such as the issue date and expiry date of the SSL Certificate and also the number of days left for expiry. Threshold can be set to configure alarms which will alert you before your certificate expires. Web Server To create a Web Server Monitor, follow the steps given below: Click on New Monitor link. Choose Web Server. Enter the IP Address or hostname of the host in which the Monitor is running. Enter the SubNetMask of the network. Provide the port number in which the monitor is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Web Server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Web server from the network and starts monitoring them.If you have added Monitors and not associated them with a Monitor Group, you can do this manually anytime. For information on associating a Monitor with a Monitor Group, refer to Associating Monitor with Monitor Groups topic. Connects to the web server and checks its availability. Web Server Monitors response time and updates the status based on a given threshold. Web Services Web Service Monitoring Web Services is an XML-based technology that allow applications to communicate with each other, regardless of the environment, by exchanging messages in a standardized format (XML) via web interfaces (SOAP and WSDL APIs). ManageEngine Applications Manager provides a flexible approach to manage a SOA that uses SOAP Web Services. It helps business managers configure SLAs and track high level availablity of the Web Service. Application admins can monitor the performance of these Web Services by configuring Applications Manager to execute ''Operations'' published by the Web Service. By specifying the WSDL, a simple wizard helps you configure operations that need to be invoked and gives the ability to specify arguments to the operation. In addition to this, there is out-of-the-box support for configuring thresholds on individual operation execution times and user- defined XSLT parameters. To create Web Services Monitor, follow the steps given below: Note: If you want to access Web Services through Proxy , Kindly go to Admin > Configure Proxy Settings > Check if Proxy is configured, else configure the same. For hosts that don''t require Proxy, add them to the No Proxy list. Click on New Monitor link. Choose Web Services. Enter the WSDL URL. Select the checkbox if proxy is required for connection to the WSDL URL. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Enter the Timeout. Give the User Name and Password, if it is required to invoke the webservice operation. Add a Header: You can use our pre-defined headers or create your own custom headers to invoke operations. Use ''#'' to seperate multiple headers.Use '':'' to sepearate individual keys and values. For Example- Content- Type:text/application+xop;charset=UTF-9#Pragma:no-cache During monitor creation, provide the token for extracting a specific value from the SOAP Response for sequential execution. The token is of the format OperationName_SEP_TagToBeExtracted. Choose the Monitor Group from the combo box with which you want to associate Web Services Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s).  If you have added Monitors and not associated them with a Monitor Group, you can do this manually anytime. For information on associating a Monitor with a Monitor Group, refer to Associating Monitor with Monitor Groups topic. After creation of Web Services monitor, you can proceed to add the required operations and configure the thresholds and alarms for the same. Adding Operations You can add Operations to the Web Service for monitoring. Operations are abstract descriptions of actions supported by the service. Follow the steps given below to add operations: Click the Add Operation link present on the right-hand side of the web services monitor screen. This displays the Add Operation screen. The operations configured in the web service will be listed in the Select Operation drop-down list box. You can either choose any of these operations or choose custom operation. If you select a pre-configured operation, the SOAP Action and SOAP Request values for the operation will be automatically displayed. Replace the ''?'' in the SOAP request with your input value. The Operation Name has to be specified for pre-defined operations too. If you choose the custom operation, you have to specify the Operation Name, SOAP Action and SOAP Request values. (Click to know about Adding XSLT segment.) You can use the Test Operation option to check the output before adding the operation for monitoring. Click Save button to add the operation. Click Save and Configure Another button to add the operation and configure another operation.The Operations thus added, will be listed in the details page under the Operation Statistics section. In this section, you can view the details of the operation such as Operation Name, SOAP Request, SOAP Response, status and execution time. Applications Manager provides a link in the Alert Email for SOAP Action, to view the SOAP response for the specific operation. You can also configure thresholds and alarms for all the operations. The Web Service Functions are used to give dynamic input for each SOAP Request. You have to replace the input value with the function specified in the above format. Function Description Usage This function will ${random(100,1000)} ${random(MinValue,MaxValue)} generate Random This will generate a random number between 100 numbers as input. and 1000 E.g. 446. This method will generate current date ${time(yyyy-MM-dd(HH:mm:SSS))} ${time(TimeFormat)} and time as input. You This will generate the date and time in this can specify your own format2015-09-21(16:49:717). Date and Time Format. This method will generate custom ${time(yyyy-MM-dd(HH:mm:SSS))#(5d,2m,-1y)} year,date and time as ${time(TimeFormat)#(1d,-1y)} This will generate the date and time in this input. You can specify format2014-11-26(16:49:717). your own Date and Time Format. This method will replace ${passAuthToken(authtoken)} token/access key which This will generate token node in this is already derived from ${passAuthToken(authtoken)} format ${passAuthToken(authtoken)} SOAP Response . Tag name is just an mentioned in example, it could be anything actually. ''''Authentication Token''''. This method will ${nonce()} generate a random This will generate a random base64 encoded,16- ${nonce()} base64 encoded,16-byte byte nonce value to prevent request duplication. Ex nonce value. : NGMzb05BeHF6V1dHNTNuNQ== Adding XSLT input How to use XSLT for a particular SOAP Operation? When adding a particular operation, click ''Add XSL Transformation'' button and provide the necessary formatting input. To return mulitple values, ensure that: The output format is set to text. This can be done by adding the XSLT code using the output tag. Ex : . Provide the output in key-value pairs. For example, to add an attribute for checking the temperature, make sure that the XSLT output is of the format "Temperature:100". The key-value pairs should be separated by a new line entry. Key1 : Value1 Key2 : Value2 Key3: Value3 The keys should be unique within a particular SOAP Operation. They can be duplicated across operations.   How to add XSLT input to existing operations ? Click Manage operations and select edit and add the necessary changes. Click Update. Click on the operation details. Select the SOAP Request tab and add the changes and click Update.Where to view the attributes created using XSLT ? Under the Operation Statistics table, select the operation for which you wish to view the XSLT data. This opens the SOAP Response tab under which the attributes are listed in a tabular format with functionality to add thresholds and view reports. For numeric data, the graphic data is displayed after the table. How do I enable reports for the attributes? Go to the Reports tab and select Enable reports. Select Web Services type Check the attributes for which you wish to generate reports. Click Update. Wait for data archival to occur to view the reports. Editing Arguments Click the Manage Operation link under the ''Operation Statistics'' section to go to the ''Manage Operation'' page. In this page, click the   icon to edit the Operation Display name as well as the Arguments including SOAP Action and SOAP Request values. How to add XSLT input to existing operations ? Click Manage operations and select edit and add the necessary changes. Click Update. Click on the operation details. Select the SOAP Request tab and add the changes and click Update. Where to view the attributes created using XSLT ? Under the Operation Statistics table, select the operation for which you wish to view the XSLT data. This opens the SOAP Response tab under which the attributes are listed in a tabular format with functionality to add thresholds and view reports. For numeric data, the graphic data is displayed after the table. How do I enable reports for the attributes? You can enable reports for the attributes in the following two ways: From the SOAP Response Page: In the SOAP Response Page, the details of all the XSLT attributes are listed in a table. The check boxes provided in the table allow the user to enable / disable reports for the attributes at the Operation level. Select the attributes from the table and select either enable reports or disable reports option present at the bottom of the table to perform the required action. From the Reports Tab: Go to the Reports tab and select Enable reports. Select Web Services type. Check the attributes for which you wish to generate reports. Click Update.Wait for data archival to occur to view the reports. Connects to the web service and checks its availability. Monitors WSDL URL response time and updates the status based on a given threshold. Web Service Monitors Web Service Operation Execution time. Monitors the values of the user defined XSLT attributes.   Note: Sequential execution of SOAP Operations Create a sequence of SOAP Operations wherein the output obtained from one SOAP Response is used as the input for the next SOAP Request. Procedure: During monitor creation, provide the token for extracting a specific value from the SOAP Response. The token is of the format OperationName_SEP_TagToBeExtracted. For example, the SOAP Operation GetCitiesByCountry returns the list of cities present in a particular country. Each city is specified within tag in the SOAP Response. To extract the first city from the SOAP Response the Authentication token would be GetCitiesByCountry_SEP_City. After monitor creation, add the operations. For the operations where the input is taken from the response of another operation, call the function passAuthToken. Syntax : ${passAuthToken(authtoken)}. Example : ${passAuthToken(GetCitiesByCountry_SEP_City)} IIS Server Monitoring Overview Internet Information Services (IIS) is a flexible, secure and extensible web server from Microsoft that helps you host anything on the web. Since it is capable of handling most demanding tasks, from media streaming to web applications, monitoring its performance and response time becomes vital. IIS web server performance monitoring capabilities from Applications Manager helps you to proactively monitor your IIS servers by providing complete visibility into the performance of your websites and web application pools that are running within. It keeps tracks of various key web server metrics such as response time, connection statistics, data and file transaction rate, along with the list of anonymous users that are currently using the website at regular intervals. In this help document, you will learn how to get started with IIS web server performance monitoring using Applications Manager''s IIS traffic monitor. Creating a new IIS server monitor Prerequisites for monitoring IIS server metrics: Click here Using the REST API to add a new IIS server monitor: Click here To create an IIS traffic monitor, follow the steps given below: Click on New Monitor link. Choose IIS Server. Enter the IP Address or hostname of the host in which the Monitor is running. Enable the Do not resolve DNS name checkbox if you have multiple system IP addresses configured with single DNS name. Provide the port number in which the monitor is running. Choose SSL option, if SSL is enabled in IIS Server.Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list by enabling the Select from Credential list option. Enable Response Header Check to check whether the IIS keyword is present in the response header. By default, it is enabled. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate IIS Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the IIS Server from the network and starts monitoring them. Note: To collect data for Website Statistics and Application Pools, the host where the IIS Server is running should be monitored in WMI mode. (Applicable only for Applications Manager versions 15110 and below) Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on IIS Server under the Web Server / Services category. Displayed is the IIS Server monitor bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. Applications Manager''s IIS traffic monitor provide complete visibility into your IIS web server environments altogether in a single window based on the following metrics: Overview Performance Overview Parameter Description RESPONSE TIME Response Time Amount of time taken to connect to the server and provide response (in ms). Performance Parameter Description Website Statistics Website Name Name of the website hosted by the IIS server. Current Connections Number of connections that are currently established with the IIS server. Maximum Connections Maximum number of connections that have been established with the IIS server. Bytes Sent/sec Amount of bytes sent from the website per second. Bytes Received/sec Amount of bytes received by the website per second. Bytes Transferred/sec Amount of bytes transferred from the website per second. Files Sent/sec Number of files sent from the website per second. Files Received/sec Number of files received by the website per second. Files Transferred/sec Number of files transferred from the website per second. Current Anonymous Users Number of anonymous users that are currently connected to the website. Anonymous Users/sec Number of anonymous users that are connected to the website per second. Current Non-Anonymous Users Number of non-anonymous users that are currently connected to the website. Non-Anonymous Users/sec Number of non-anonymous users that are connected to the website per second. Application Pools Application Pool Name Name of the application pool. CPU Usage Amount of CPU utilized by the application pool (in percentage). Memory Usage Amount of memory utilized by the application pool (in percentage). No of Worker Process The number of worker processes (different programs) assigned to a pool.Parameter Description Queue Length Length of the HTTP.sys request queue of an application pool. In addition to the above metrics, following are the list of graphs that are shown in this tab: Top Websites by Current Connections - Shows a graphical representation of the websites that have the highest number of current connections established. Top Websites by Bytes transferred - Shows a graphical representation of the websites that have the highest number of bytes transferred per second. Top Websites by Files transferred - Shows a graphical representation of the websites that have the highest number of files transferred per second. Top Websites by Anonymous users - Shows a graphical representation of the websites that have the highest number of anonymous users connected per second. Top Websites by Non-Anonymous users - Shows a graphical representation of the websites that have the highest number of non-anonymous users connected per second. Web Transaction Recorder How do I record a new URL Sequence/Web Script using the Web Application Browser Recorder tool? The Web Transaction recorder tool can be used to record two kinds of transactions: For Real-Browser Monitoring: Records web transactions and plays back the recorded sequence in a browser from remote locations to mimic user behavior and collect performance metrics. For URL Sequence Monitoring: Records all user transactions on your site and captures HTTP request URLs in their exact sequence. Users can perform response code configuration, detect and be notified of bad response code. Click the following like to know how you can: Create a URL Sequence Monitor and Update the Sequence Monitor Create a Real Browser Monitor Filter and Delete URLs Use Recorder Actions To create a URL Sequence Monitor Here are the steps to record a new URL Sequence: Recording a New Transaction In the Select Monitor window, click “create URL Sequence Monitor”. To start a recording, click the Record New button, enter your URL in the address bar and click Enter. Alternatively, you can also enter the URL of the Web Application you wish to monitor in the URL bar of the Recorder tool. Perform the transactions that you wish to record. After you have completed the sequence, click Preview & Save. In the Preview and Savewindow, you can configure the: Sequence name: Edit the name of the sequence. Poll interval: Poll interval is the time in minutes between two consecutive attempts to check for each recorded URL. Connection Timeout: The URL connection timeout. Check the Associate with Monitor Group checkbox to associate the monitor to a group. Add Real Browser Monitor for this Recording:For a more unified approach to web transaction monitoring, you can add a Real Browser Monitor along with the existing URL Sequence Monitor. Enter the: Monitor Name – A monitor name. Poll Frequency – The polling interval of the monitor. Page load timeout – The amount of time to wait for a page load to complete.Select agents from the list of available agents. For each agent selected, a new monitor is added to Applications Manager. Check the Associate with Monitor Group checkbox to associate a monitor group. Choose the Monitor Group(s) to associate from the drop-down list. Select the following checkboxes as per your requirement: Accept Untrusted Certificates - The Agent will state that a website certificate is untrusted if that certificate has not been signed by a trusted Certificate Authority. Check this box if you want the Agent to accept Untrusted Certificates. Show Performance Metrics – This checkbox lets you specify if you wish to display additional performance metrics like page rendering time, download time, block time etc of your Web Application in Applications Manager. If your applications contain sensitive data, you can uncheck the option and data will not be displayed. Show Screenshots - RBM Recorder captures screenshots of your transaction providing better insights, especially during downtime. If your transaction contains sensitive data that you would not like to take a screenshot of, disable the screenshots by unchecking the ''Show Screenshots'' checkbox Click Next. You can view the URL sequence of your transaction and make basic and advanced configurations: Basic – You can edit basic URL details like URL link, Display name, header and post data. Advanced– Alert Configuration: You can configure the recorder such that alerts are generated when specific keywords are present/not present. Enter the keywords in the text boxes provided. Basic Authentication Details: Enter Authentication details like username and password. Response Code Configuration: You can configure the recorder to generate alerts if response time is greater than, equal to, not equal to, less than, less than or equal to a specified value. After making all the required changes, click Create URL Sequence Monitor. If the Add Real Browser Monitor for this Recording checkbox is checked to specify that you want to add a Real Browser Monitor, you will be taken to a Preview and Save screen to preview the Real Browser Monitor configuration. The following operations are possible in the RBM Steps Previewwindow: Verify the operations you have performed (like mouse over, drop down, radio button etc.) during the recording. Add content check or verify text operation in a web page. Add words which, when present in the web page, should notify you in the Generate alert if following keywords are present text box. Similarly, you can also add words which should not be present in the web page in Generate alert if following keywords are NOT present text box. After configuration, click Create Real Browser Monitor to proceed. This sends the recorded web script to the Applications Manager server to do a test playback. Filter and Delete URLs Filtering URLs: In the Preview and Save screen, click the Filter link on the top right corner to open a URL Filter list. URLs can be filtered based on the following three categories: File Type / URL Extensions -- The captured URLs can be filtered based on their extensions. For example, .gif, png, jpg etc. for images, .js for scripts and more. Content Type / MIME Type -- URLs can be filtered based on the MIME type like image, video, audio, text and application. Domain Components -- You can also filter URLs based on the domains from which they originate. You have the option to include / exclude websites from a particular domain in the Domain Filter list. These domains are not stored for future references. You have to re-enter such preferences if you re-start the tool. You can add a new Extension, Content Type or Domain Component to the URL filter using the ADD button at the bottom of each list. Deleting URLs: Click on a URL from the list of transactions and click the Delete URL link on the top right corner to delete it.Update the Sequence Monitor You can update the Sequence Monitor and re-record/update the the URLs that you have previously recorded. Record a new transaction as explained here, then: Click the Update the Sequence Monitor button. The page displays the URLs recorded for this Transaction. You can preview the URL sequence, filter and delete the urls as per your requirements, and perform the following basic and advanced configurations: Basic – You can edit basic URL details like URL link, Display name, header and post data. Advanced – Alert Configuration: You can configure the recorder such that alerts are generated when specific keywords are present/not present. Enter the keywords in the text boxes provided. Basic Authentication Details: Enter Authentication details like username and password. Response Code Configuration: You can configure the recorder to generate alerts if response time is greater than, equal to, not equal to, less than, less than or equal to a specified value. Click Select Monitor to select the monitor that you wish to update the URLs to from a drop-down list of URL Sequence monitor names. When you select a monitor name from the drop-down list, the page displays a list of existing URLs and the list of new URLs that you just recorded. Preview the lists and click on Update Sequence Monitor to replace the existing URLs of the monitor with newly recorded URLs. The Monitor will be updated with the new URL sequence. Recorder Actions Click on Actions link on the top left corner of the page to: Logout – Log out from the recorder Create New Web Script – Create a new recording. Open an Existing Web Script – Open an already recorder and saved web script. Save your web script locally – Save your recording locally. Preview and Save – Preview the steps in the application. Change Monitor Type – Switch between URL Sequence Monitoring and Real Browser Monitoring. Change Proxy Settings – Configure proxy to access the internet Change Preferences– Set the Page load time, Think time, Screen resolution and Preferred Test playback location: Page load time: The time taken to load the entire web page. The Page load time can have a value between 0 to 30 seconds Think time: The time interval between two subsequent requests to the server, while monitoring. After page load, the monitor will populate any form data and wait till the think time interval before initiating another request to the server. The Think time can have a value between 0 to 10 seconds Screen resolution: The display resolution in which the website loads best. Test playback location: The preferred location from where the Test playback should be done. You can choose the location closest to your server location for best results. To create a Real Browser Monitor Here are the steps to record a new web script: In the Select Monitor window, click “Create Real Browser Monitor”. To start a recording, click the Record New button, enter your URL in the address bar and click Enter. Alternatively, you can also enter the URL of the Web Application you wish to monitor in the URL bar of the Recorder tool. Follow the sequence of steps that you wish to monitor. You can add a content check by keyword. Click Preview and Save, once you have browsed through the required steps in the application. The Monitor Details window will be displayed. In the Monitor Details page, configure values for:Monitor Name – A monitor name. Poll Frequency – The polling interval of the monitor. Page load timeout – The amount of time to wait for a page load to complete. Select agents & the browser type from the list of available agents. For each agent selected, a new monitor is added to Applications Manager. Check the Associate with Monitor Group checkbox to associate a monitor group. Choose the Monitor Group(s) to associate from the drop-down list. Select the following checkboxes as per your requirement: Accept Untrusted Certificates - The Agent will state that a website certificate is untrusted if that certificate has not been signed by a trusted Certificate Authority. Check this box if you want the Agent to accept Untrusted Certificates. Show Performance Metrics – This checkbox lets you specify if you wish to display additional performance metrics like page rendering time, download time, block time etc of your Web Application in Applications Manager. If your applications contain sensitive data, you can uncheck the option and data will not be displayed. Show Screenshots - RBM Recorder captures screenshots of your transaction providing better insights, especially during downtime. If your transaction contains sensitive data that you would not like to take a screenshot of, disable the screenshots by unchecking the ''Show Screenshots'' checkbox. Add URL Sequence Monitor for this Recording. For a more unified approach to web transaction monitoring, you can add a URL Sequence Monitor along with the existing Real Browser Monitor. If this box is checked, enter the: Sequence name: Edit the name of the sequence. Poll interval: Poll interval is the time in minutes between two consecutive attempts to check for each recorded URL. Connection Timeout: The URL connection timeout. Check the Associate with Monitor Group checkbox to associate a monitor group. Choose the Monitor Group(s) to associate from the drop-down list. Click Next. The following operations are possible in the RBM Steps Preview window: Verify the operations you have performed (like submitting a form or logging into an application) during the recording. Add words which, when present in the web page, should notify you in the Generate alert if following keywords are present text box. Similarly, you can also add words which should be but are not present in the web page in Generate alert if following keywords are NOT present text box. Clicking on Perform Test Playback sends the recorded web script to the selected agent to do a test playback. Playback results are displayed, if the playback is initiated manually. After configuration, click Create Real Browser Monitor to proceed with creation of the monitor(s). If the Add URL Sequence Monitor for this Recording checkbox is checked to specify that you want to add a URL Sequence Monitor, you will be taken to a Preview and Save screen to preview the URL Sequence Monitor configuration. You can view the URL sequence of your transaction and make basic and advanced configurations: Basic – You can edit basic URL details like URL link, Display name, header and post data. Advanced– Alert Configuration: You can configure the recorder such that alerts are generated when specific keywords are present/not present. Enter the keywords in the text boxes provided. Basic Authentication Details: Enter Authentication details like username and password. Response Code Configuration: You can configure the recorder to generate alerts if response time is greater than, equal to, not equal to, less than, less than or equal to a specified value. Click Create URL Sequence Monitor. HTTP URL MonitoringIn an environment, where the downtime of any website applications and services can cause a negative impact on the business performance, problems must be accurately identified and solved. Applications Manager acts as a continuous URL monitoring service that keeps constant watch over a specified URL or website page. They test the website applications and web services to ensure that they are functioning properly. URL monitors verify the availability of specified, addressable, standard HTTP and HTTPS URLs. They scan the HTTP and HTTPS pages looking for a predefined keyword to check whether the website is available. HTTP(s)-URLs HTTP(s)-URL Sequence The difference between the two types of monitoring is that URL Monitoring monitors single HTTP and HTTPS URL, whereas URL sequence monitors a set of HTTP and HTTPS URLs in sequence. Also, any HTTP and HTTPS URL can be monitored using URL Monitoring.Please go through the following sections to know about the configuration details. HTTP-URLs To configure for URL monitoring, follow the given steps: Select New Monitor. Choose HTTP-URLs. Provide any display name for the HTTP-URL monitoring. Provide the HTTP/HTTPS URL address you want to monitor. Enter any keyword as match content. The URL monitoring searches the keyword in the content of the URL page to check the availability of the URL. This is optional. Note: The content search is case-sensitive. If you provide 2 words, the content match is performed for the words separately. For example, if you specify the content as applications manager, the match is found for applications and manager separately. If you need the content match to be performed for the complete text, specify the 2 words in quotes, example "applications manager". Space character will be acting as the delimiter. Regex content check is supported only for "Should contain" field. The "Should not contain" field supports only plain text match. Limitation for content check is subject to 250 characters. Provide the polling interval for which Applications Manager updates the status of the monitor. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose between the POST and GET, which are the two types of Form Submission Method for any HTTP/HTTPS URL. If you choose POST, select URL Payload Type for ''POST'' form submission. Click Add URL Monitor to initiate monitoring of the specified URL. Apart from the basic URL Monitoring, Applications Manager also provides you with advanced options that furnish effective and more flexible URL Monitoring. This is optional and you need to choose these options only if the HTTP/ HTTPS URL requires Form-based authentication. Provide the request parameters, if any. The request parameters must be provided as name=value pairs for POST and GET methods. For example, if you want to monitor a URL like, http://appmanager:9090/showresource.do?haid=1&type=UrlMonitor&method=getMonitorForm, then provide "?haid=1&type=UrlMonitor&method=getMonitorForm" as request parameter. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. (To add new credentials under Credential Manager, refer here.) Enter a keyword which when matches with the content in the URL must be notified of error in Error If Match field. Note: The search is case sensitive. Multiple keywords should be put within quotes. Otherwise, it will be treated as ''Any'' one of the multiple keywords. Enter the Response Code details by choosing them from the combo box. By default, it is greater than 200. Hence the error will be notified once the criteria mentioned are met. Enter the time, in minutes, for which the URL monitor should wait for a page to complete downloading before timing out in Timeout field. Check "If monitor detects error, re-try immediately to verify error", where the monitoring is automatically performed when it detects an error, i.e. when an error is detected, the monitor will immediately be scheduled to run again once. Sometimes you may want to customize the default HTTP request header. You have the option to customize the "User-Agent" field. Check the Custom HTTP Headers and User Agent checkbox and enter the HTTP Header and User Agent in the text boxes. You may add multiple HTTP Headers and User Agents. HTTP(s)-URL SequenceThe purpose of URL Sequence is to monitor multiple web pages of an online application. It checks pages with dynamically generated information enhancing interactive transactions such as logging into a login page, creating an account using a web form, instructing the application to perform some action, etc. URL Sequencing starts with a specific URL such as the Login page and then followed by additional links/URL in it. The URL Sequence monitoring thus performs end-to-end verification of particular transactions helping you to troubleshoot any problems while monitoring. Note: If you are connecting to an URL using a proxy server, then you must configure proxy to initiate the URL sequence monitoring. Refer to the Configuring Proxy section of Performing Admin Activities, for further details. To create an HTTP(s) URL Sequence monitor, follow the steps given below: Go to New Monitor and click Add New Monitor. Select HTTP(s) URL Sequence Monitor under Web Server/Services category. Here you can create a URL Sequence monitor using any one of the following methods: Import HAR File Use Web Transaction Recorder To modify an existing URL Sequence monitor, refer here. Import HAR File On selecting this option, you will be taken to the page where you have to import HAR file. To create a URL sequence monitor by importing HAR file, the user must generate a HAR file comprising of the required URL Sequence. 1. Import HAR file and view URL(s) recorded Generate a HAR file. Click here to learn about generating HAR file Enter a display name for your URL Sequence monitor. Upload the generated HAR file. Maximum file size allowed is 60 MB. Enter the required Poll Interval value in minutes. Default value is 10 minutes. Click Upload File. This will take you to a page where you can see all the URLs recorded and modify them as required. 2. View and modify recorded URL(s) Display Name field contains the monitor name that was provided while uploading the HAR file. File Name contains the name of the file which was uploaded. Connection Timeout is the value of timeout for connection for each URL in the sequence. URL Listsection lists all the URLs that have been recorded. To delete URL(s), Select the check boxes corresponding to them in the URL list. Click on the Delete button on the right side below the list. URL Details section contains the information such as URL, display name, headers, HTTP Request method, etc., for the URL currently selected or clicked upon. It has two tabs - Basic and Advanced, present as a radio button below the URL List. Note: All changes done here will affect only the selected URL, not all URLs listed. Basic: URL field has the URL which is current selected. You can modify this if required. Display Name is the name that will displayed for the URL in the list of the URLs in the URL Sequence monitor. Headers field has the headers that are used by this URL for communication. Applications Manager will also be sending the same URLs while making a request to this URL. HTTP request methodshows the URL request method, whether it is GET or POST. (PUT, PATCH, HEAD, DELETE URLs are not monitored) If the URL request method is of type GET, then the request params used for the URL will be shown in the Request Parameters section. The content can be modified to include any extra data if required.If the URL is of type POST, then the post data will be shown under the Payload section in FORM, TEXT, XML, or JSON format. All the sections can be modified to include any extra data if required. Advanced: Alert Configuration- You can add content check for a URL if required. Generate Alert if following keywords are present: If the keywords added here are present in the URL’s web page then the monitor’s status will be made down and an alert will be generated. So the keywords here are usually the keywords that one would like the website not to contain. Generate Alert if following keywords are not present: If the keywords added here are not present in the URL’s webpage then the monitor’s status will be made down and an alert will be generated. So the keywords here are usually the keywords that one would like the website to contain. Basic authentication - The basic authentication details, if present in a URL will be automatically captured by Applications Manager. If you still wish to add authentication details, you can enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option for URL monitor. (To add new credentials under Credential Manager, refer here) Response Code configuration - Configures the response code and the condition that you would like to be alerted for. By default you will be alerted for all URLs that return a response code above 200. You can modify them if required. Filter URLssection filters the URLs based on the following categories: URL Extension (File Type) -- Filters the captured URLs based on the extension of the file type. By default, URL(s) will be filtered based on default file extension filters like .css, .js, .tff, etc. Domain Components -- Filters the captured URLs based on the domains from which they originate (like abc.com or example.com). Content Components -- Filters the captured URLs based on the “Content-Type” header in the response headers like image, video, audio, text and application. You can add new filter(s) to each of the above categories (URL Extension, Domain Component or Content Component) using the Add button at the bottom of each category list. Associate monitor to a monitor group: Choose the Monitor Group from the combo box with which you want to associate the URL Sequence monitor (optional). You can choose multiple groups to associate your monitor. After performing all the above steps, click on “Add Monitor” to create the URL Sequence monitor. Note: Only 25 URLs are allowed to be recorded. If the URLs exceed more than 25, then the monitor will be created with the first 25 URLs. Alternatively, you can also delete the URLs that are unnecessary using the Delete functionality explained earlier. Use Web Transaction Recorder Applications Manager''s Web Transaction Recorder tool records all user online transactions in their exact sequence. These transactions will then be replayed at regular intervals of time and notifications will be sent when any error is detected. Browse through the following topics to use the Transaction Recorder tool: Getting Started Hardware/Software Requirements Download and Installation Recording a New Transaction Recording a Sequence Editing captured URL''s Saving a transaction Modify an existing Transaction Monitoring URLs with Dynamic ParametersNote: We have set a limit of 25 URLs per URL Sequence monitor. Getting Started You must download and install the recorder tool to record the sequence of user transactions. Every step of the transaction will be captured and recorded. You also can modify or edit your transactions. Hardware/Software Requirements The Transaction Recorder is developed using the Microsoft .NET Platform version 2.0. This is the minimum software requirement. A minimum of 2 MB of disk space is also required for installing the software. Download and Installation Download the Web Transaction Recorder and start the installation process. The installation wizard takes you through a four step process after which the Recorder will be started: A welcome screen is displayed, after which you will be asked for confirmation of the license requirements. Click Yes. After confirmation, a screen to Chose Destination Location is displayed. The user is allowed to select the drive and directory where he wishes to install the Transaction Recorder. Click Browse and select the installation destination. Click Next. Review the settings in the confirmation dialog and click Back if you wish to make changes. If not, click Next. The Recorder will be installed in your machine. After the installation is completed, click Finish. Make sure the "Start Transaction Recorder" option is checked, if you would like to start the tool automatically after the installation is complete. Recording a New Transaction After installing, the Transaction Recorder can be accessed under All Programs in Windows Start Menu. You can record a new transaction following these steps: Record the Sequence. Click on the New button to start a new recording. Enter the URL of the application you wish to monitor then press enter to load the corresponding web page. Follow the sequence of steps that you wish to monitor. Edit the captured URL''s After you have completed the sequence, click Preview & Save. A Login Credentials dialog box is displayed. Provide the login credentials - Host Name, Port Number, User Name and Password. Check the Show Password checkbox to see the password Click on Next to open the Preview Transactions screen. Here the user can view the recorded URLs and configure monitoring settings for each URL individually. In the Preview Transactions screen, click the Filter URLlink on the top right corner to open a URL Filter Screen. URLs can be filtered based on the following three categories: File Type / URL Extensions -- The captured URLs can be filtered based on their extensions. For example, .gif, png, jpg etc. for images, .js for scripts and more. Content Type / MIME Type -- URLs can be filtered based on the MIME type like image, video, audio, text and application. Domain Components -- You can also filter URLs based on the domains from which they originate. You have the option to include / exclude websites from a particular domain in the Domain Filter list. Note: These domains are not stored for future references. You have to re-enter such preferences if you re-start the tool. You can add a new Extension, Content Type or Domain Component to the URL filter using the ADD button at the bottom of each list. Delete URL: Click on a URL from the list of transactions and click the Delete URL link on the top right corner to delete it.Basic Configuration: You can edit basic URL details like URL link, Display name, header and post data by selecting settings Basic option at the bottom of the list of recorded URLs. Advanced Configuration: Alert Configuration: You can configure the recorder such that alerts are generated when specific keywords are present/not present. Enter the keywords in the text boxes provided. Basic Authentication Details: Enter Authentication details like username and password. Response Code Configuration: You can configure the recorder to generate alerts if response time is greater than, equal to, not equal to, less than, less than or equal to a specified value. After making all the required changes, click next to go to the save transactions screen. Saving the transaction: In the save transactions screen, you can configure or edit the following fields: URL sequence name: The wizard generates a sequence name. You can edit the default sequence name. Poll interval: Poll interval is the time in minutes between two consecutive attempts to check for each recorded URL. Host name Port number Username and Password. (The username and password used for Applications Manager with administrative privilege should be used). Click Save to save the changes. Modify an existing transaction You can modify an existing transaction Click Re-record. Record the Sequence. Edit the captured URLs Select the transaction which needs to be modified from the drop-down menu and the click Fetch URLs. Click next to perform a side-by-side comparison of the list of old URL''s and the list of newly recorded URL''s. Click Update to update the existing transaction with the currently recorded sequence in the server. Note: If you would like to set User Agent for monitoring URL sequence, add the following key in AMServer.Properties file located in your Applications Manager installation folder. am.httpclient.useragent= Example: am.httpclient.useragent=Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; Q312461; SV1) Save the file and restart Applications Manager for the changes to take effect. Monitoring Dynamic URLs: Suppose your login page has hidden parameters that needs to be submitted while logging into your application and the value for the hidden parameter is different for each login request. In this case, the hidden parameter value in the login page needs to be fetched dynamically and passed to the subsequent URL. For monitoring these kind of dynamic URL Sequences, you can use $ [eg., $sessionID = 12] in the Request Parameter text box of the URL. So, while monitoring the URL Sequence, $< Parameter name> will fetch the dynamic values and pass it to the next URL in the sequence. While using the Recorder tool, you cannot specify the parameters in the Request Parameter text box, so instead, after adding the URL Sequence, go to corresponding URL''s ''Edit Monitor'' page and enter the parameters. Consider the following URL Sequence : URL 1 : http://api.appmanager.com/oauth/token? client_id=32faff282a68a03c2eb0f41aeca63a88&grant_type=client_credentials&client_secret=9de7337627ab85f3 URL 2 : http://api.appmanager.com/bestoffer/97232/354992/offers.xml? access_token=fcdee0e94da9b934a4cef6c2dee70384/li> URL 3 : http://api.appmanager.com/selectoffer/97232/3549/offers.xml? access_token=fcdee0e94da9b934a4cef6c2dee70384 ... ... URL N : ...In the above example access_token is a dynamic parameter whose value changes every time we login. In order to monitor the above sequence, follow the below mentioned steps : Download the Transaction Recorder tool and record a new transaction sequence. The recorder tool will have recorded all the steps along with dynamic request parameter for that session. After adding the URL Sequence, click ''Edit Monitor'' for the corresponding URL to enter the parameters. In the Edit Monitor page, for the field ''Request Parameters (if any)'' provide the dynamic request parameter as $parameter=TEXT:-: :-: For Eg - In URL 1: The ''parameter'' is ''access_token'' and ''parameter_name'' is ''access_token=''. So, for the text box correponding to the ''Request Parameters'' provide $access_token=TEXT:-:access_token=:-: and save the page Click ''Edit Monitor'' for the second URL, remove the dynamic request parameter from the ''URL address'' field and use the same parameter to fill the ''Request Parameters (if any)'' field For Eg - In URL 2: Edit http://api.appmanager.com/bestoffer/97232/354992/offers.xml? access_token=fcdee0e94da9b934a4cef6c2dee70384, remove the dynamic request parameter (access_token) and change the ''URL address'' to http://api.appmanager.com/bestoffer/97232/354992/offers.xml?. Provide the ''Request Parameters'' as $access_token=fcdee0e94da9b934a4cef6c2dee70384 Repeat the above steps for the rest of the URLs in the sequence where the dynamic parameter is present So for every polling interval Applications Manager will search for this dynamically generated parameter and it will replace it. Applications Manager acts as a continuous URL monitoring service that keeps a constant watch over the specified URL or web site pages. URL monitors verify the availability of specified, addressable, standard HTTP and HTTPS URLs. They scan the HTTP and HTTPS pages looking for a predefined keyword to check whether the web site is available. There are two ways of URL monitoring provided by Applications Manager. URL Monitoring URL Sequence (Record & Playback) In URL Sequence, click on the individual URL listed, to view its monitored parameters. Monitored Parameters Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information. Parameter Description Monitor Information Health Specifies the health of the monitor based on its dependencies. Type Type of Monitoring URL Specifies the URL being monitored address Match The string that is searched in the resulting html page. Content Request The request method sent to the HTTP/ HTTPS URL (Get or Post) Method Monitored Parameters Availability The current status of the URL / URL Sequence- whether it is up or down. Response The response time for accessing an URL or total response time of URL Sequence (takes into account Time the response time of the individual URLs in the Sequence) Current Current status of the response time. Click on the icon to know its RCA details. Status Current The current page size of the URL in bytes (only in URL monitoring)Page Size % Change The percentage change between the current page size and the previous page size. (only in URL in Page monitoring) Size Response Time Split Up The time that it takes to resolve the website’s hostname to a certain IP address. If the DNS lookup DNS Time time is high, it means that you or your hosting provider has a problem with their DNS servers. Once the URL has been resolved to an IP address, the connection time shows how long it takes to Connection establish a connection to your server. The connection time helps in discovering network latency, Time routing issues, and server bandwidth problems. The first byte shows how long it takes from the moment the connection was created until the first First Byte byte is about to be transferred. The time to perform any negotiations with the server and the time Time needed for the server to calculate the result are also included. Once the first byte of HTML has been received, the Web server continues to send the HTML that Last Byte represents the layout of the Web page, including CSS and Java Script. Last byte time includes time Time till the last byte for all documents with the HTML to load. Also commonly referred to as the "Download Time" or "HTML Content Time". Generate HAR Files HTTP Archives (HAR) capture records the requests and responses that the browser makes with the web application. Applications Manager allows you to create a HTTP(s) URL Sequence monitor with the help of the HAR file exported from the browser. All the URLs associated with the transaction are captured in the HAR file and will be recorded separately in the HTTP(s) URL Sequence monitor. Note: Only files with .har extension will be accepted. Steps to generate HAR file Click on the required browser listed below to find out the steps for generating HAR file: Chrome Firefox Safari Internet Explorer Microsoft Edge Opera Brave Vivaldi Chrome In Chrome, go to the page where the HTTP(s) URL Sequence needs to be monitored. At the top-right of your browser window, click the Chrome menu ( ) and select More Tools → Developer Tools, or simply press the F12 button. The Developer Tools window opens as a docked panel at the side or bottom of Chrome. Click the Network tab. Enable Preserve log. You will see a red circle ( ) on the top-left side of the Network tab. This means the capture has started. If the circle is black ( ), click the black circle to start the recording activity in your browser. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, right click on any row of the activity pane and select Save all as HAR with Content or click the Export HAR ( ) icon to download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Firefox In Firefox, go to the page where the HTTP(s) URL Sequence needs to be monitored.Click the Firefox menu ( ) available at the top-right of your browser window and select Web Developer → Network, or simply press the F12 button. The Developer Tools window opens as a docked panel at the side or bottom of Firefox. Click the Network tab. Click over the cog ( ) icon and enable Persist Logs. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, right click on any row of the activity pane and select Save all as HAR or click the cog [ ] icon and select Save all as HAR to download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Safari In Safari, go to the page where the HTTP(s) URL Sequence needs to be monitored. In the menu bar at the top, click Develop and select Show Web Inspector. Click the Network tab and enable Preserve Logs. Go to the Network tab. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, click on the Export button available on top-right corner and download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Internet Explorer (IE11.7) In Internet Explorer, go to the page where the HTTP(s) URL Sequence needs to be monitored. Click the menu ( ) icon on the top-right of your browser window and select F12 Developer Tools, or simply press the F12 button. The Developer Tools window opens as a docked panel at the side or bottom of Internet Explorer. Click the Network tab. Deselect the Clear entries on navigate ( ) option, which is selected by default. The green play ( ) button (Start Profiling Session), should be selected by default. This means the capture function is running. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, click the Export as HAR ( ) icon and download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Microsoft Edge In Microsoft Edge, go to the page where the HTTP(s) URL Sequence needs to be monitored. At the top-right of your browser window, click the Edge menu ( ) and select More Tools → Developer Tools, or simply press the F12 button. The Developer Tools window opens as a docked panel at the side or bottom of Chrome. Click the Network tab. Enable Preserve log. You will see a red circle ( ) on the top-left side of the Network tab. This means the capture has started. If the circle is black ( ), click the black circle to start the recording activity in your browser. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, right click on any row of the activity pane and select Save all as HAR with Content or click the Export HAR ( ) icon to download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Opera In Opera, go to the page where the HTTP(s) URL Sequence needs to be monitored. At the top-left of your browser window, click the Opera menu ( ) icon and select Developer → Developer Tools, or simply press the F12 button. The Developer Tools window opens as a docked panel at the side or bottom of Opera. Click the Network tab. Enable Preserve log.You will see a red circle ( ) on the top-left side of the Network tab. This means the capture has started. If the circle is black ( ), click the black circle to start the recording activity in your browser. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, right click on any row of the activity pane and select Save all as HAR with Content or click the Export HAR ( ) icon to download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Brave In Brave, go to the page where the HTTP(s) URL Sequence needs to be monitored. Click the Brave menu ( ) at the top-right of your browser window and select More Tools → Developer Tools, or simply press the F12 button. The Developer Tools window opens as a docked panel at the side or bottom of Brave. Click the Network tab. Enable Preserve log. You will see a red circle ( ) on the top-left side of the Network tab. This means the capture has started. If the circle is black ( ), click the black circle to start the recording activity in your browser. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, right click on any row of the activity pane and select Save all as HAR with Content or click the Export HAR ( ) icon to download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Vivaldi In Vivaldi, go to the page where the HTTP(s) URL Sequence needs to be monitored. At the top-left of your browser window, click the Vivaldi menu ( ) icon and select Tools → Developer Tools, or simply press the F12 button. The Developer Tools window opens as a docked panel at the side or bottom of Opera. Click the Network tab. Enable Preserve log. You will see a red circle ( ) on the top-left side of the Network tab. This means the capture has started. If the circle is black ( ), click the black circle to start the recording activity in your browser. Now refresh the page and perform the necessary website transaction activity that needs to be monitored. After successfully performing the web transaction activity, right click on any row of the activity pane and select Save all as HAR with Content or click the Export HAR ( ) icon to download the HAR file. Now upload this HAR file in the Import HAR file page of Applications Manager to create the HTTP(s) URL Sequence monitor. Real Browser Monitoring Overview Real Browser Monitor (RBM) provides live end-user experience measurement. RBM launches a browser and monitors a web application, mimicing the user''s interaction with the site. Applications Manager uses behavioral scripts to describe the path that would be taken by a end-user on the site. These paths are monitored periodically to obtain performance metrics such as the availability and response time. We support playback from different geographical locations. Note: Real Browser Monitor supports the following list of browsers for playback: Mozilla Firefox Microsoft Edge Google Chrome Why Applications Manager''s Real Browser Monitoring? Applications Manager uses a web browser to collect metrics, taking into consideration aspects such as the network latency content check and availability of web element. This results in greater accuracy than synthetic monitoring which simply emulates a web browser rather than launching an actual browser. Actual rendering of a web page does not occur in the traditional web monitoring. In RBM, we render the webpage, build the DOM and even execute the JavaScript in the web browser. Response time of the webpage includes CSS, images, links loaded from third party websites etc.Assume you have users logging in to your application from different locations around the world like the UK, US, Germany, Australia, etc. You can monitor their experience from the central Applications Manager Server. You could have the Applications Manager running in a data center in India and have the Real Browser Monitor agents deployed in other geographical locations and have it report Web Application Performance data to the central site. Browse through the following topics to understand Real Browser Monitoring in Applications Manager: Working of Real Browser Monitor Real Browser Monitoring using Mozilla Firefox Deployment architecture & System Requirements. Real Browser Monitoring using Microsoft Edge Deployment architecture & System Requirements Real Browser Monitoring using Google Chrome Deployment architecture & System Requirements Adding Monitor using Web Transaction Recorder Importing Selenium IDE testcases as Monitor Adding Monitor using Browser Extension RBM Dashboards Monitored Parameters FAQ Working of Real Browser Monitor EUM agents register to ManageEngine Applications Manager on startup. You need to specify the "host and Web Client Port" of Applications Manager the first time the agent is installed and running. The agents get listed automatically. Real Browser monitor is created in Applications Manager server by recording the web transaction and specifying the agent(s) where the playback should occur. Each EUM agent will periodically check Applications Manager Server if RBM monitor has been configured for it and replay the actions in the browser. Once the playback is complete, EUM agent will update the results of the playback [response time, response code, etc] in Applications Manager. The availability and performance of the websites are monitored in real time by using the Real Browser monitor. If the health of the URLs is critical, then alarms can be generated. Based on the alarms, the admin can fix the issue. Real Browser Monitoring using Mozilla Firefox Deployment architecture & System Requirements Components of RBM - Web Transaction Recorder, EUM agent to be installed from where the playback has to be performed and Applications Manager Server. The EUM Agent version should be 11.0.0 or higher. EUM agents (separate .exe downloads) have to be installed in the client locations on a dedicated Windows Machine - 256 MB RAM, 1 GB HD, with Mozilla Firefox v81. Firefox is bundled with our EUM Agent so users needn''t worry about ensuring that the right version of Firefox is installed on their machine. However, Applications Manager can be installed on Windows or Linux. This works with the Professional Edition and Enterprise Edition (with Managed Server). Click here to know the system requirements for Mozilla Firefox version 81.  Real Browser Monitoring using Microsoft Edge Note: Playback using Microsoft Edge WebDriver is supported only in the End User Monitoring Agent installed on Windows Server with Microsoft Edge (versions 17 & above) support. Deployment architecture & System Requirements Components of RBM - Web Transaction Recorder, EUM agent (with Edge Support) to be installed from where the playback has to be performed and Applications Manager Server. The EUM Agentversion should be 15.0.0 or higher. EUM agents (separate .exe downloads) have to be installed in the client locations on a dedicated Windows Machine which has Microsoft Edge Browser (versions 17 & above) installed in it. This works with the Professional Edition and Enterprise Edition (with Managed Server). Along with this Microsoft Edge WebDriver need to installed on the Windows machine where the EUM agent is installed. Click here to know the corresponding WebDriver version and the steps to install the same. Please note that there are different drivers required for different versions of Microsoft Edge browser. To find the version of Edge browser: Open Edge browser → More options → Settings → Scroll down to find the version. Once the WebDriver is downloaded, update the Microsoft Edge WebDriver Path in the EUM agent settings page and restart the EUM Agent once for the changes to take effect. Learn more Real Browser Monitoring using Google Chrome Deployment architecture & System Requirements Components of RBM - Web Transaction Recorder, EUM agent to be installed from where the playback has to be performed and Applications Manager server. The EUM Agent version should be 17.0.0 or higher. EUM agents have to be installed in the client locations on a dedicated machine which has Google Chrome (versions 65 & above) installed in it. This works with the Professional Edition and Enterprise Edition (with Managed Server). In addition, Chrome WebDriver needs to be installed on the machine where the EUM agent is installed. To know the corresponding WebDriver version and the steps to install the same, click here. Please note that there are different drivers required for different versions of Google Chrome browser. To find the version of Chrome browser, Open Google Chrome → Settings → About Chrome → Find Chrome version. Once the WebDriver is downloaded, update the Google Chrome WebDriver Path in the EUM agent settings page and restart the EUM Agent once for the changes to take effect. Learn more Web Transaction Recorder For Real Browser Monitoring we use the Web Transaction Recorder to record all user online transactions in their exact sequence. The Recorder is used to record the transactions which get stored as webscripts. These transactions will then be replayed at regular intervals of time and notifications will be sent when error is detected. We support simultaneous playback of transactions in Firefox based EUM Agent. Multiple browsers can open at the same time and playback different transactions in Firefox based EUM Agent. The recorded actions will be replayed in the browser. Once the playback is complete, EUM agent will update the results of the playback [response time, response code, etc] in Applications Manager. Alternatively, you can use the browser extension of the Web Transaction Recorder to record web transactions. To know more, refer here. Browse through the following topics to use the Web Transaction Recorder tool: Getting Started Hardware/Software Requirements Download and Installation Recording a New Transaction Getting Started You must download and install the recorder tool to record the sequence of user transactions. Every step of the transaction will be captured and recorded. You also can modify or edit your transactions.Hardware/Software Requirements A minimum of at least 45MB of disk space is required for installing the software. Download and Installation Download the new Recorder and start the installation process. The installation wizard takes you through a four-step process after which the Recorder will be started: A welcome screen is displayed, after which you will be asked for confirmation of the license requirements. Click Yes. After confirmation, a Choose Destination Location screen is displayed. The user is allowed to select the drive and directory where he wishes to install the Real Browser Recorder. Click Browse and select the Destination Location. The default location is "C:\Program Files (x86)\ManageEngine\RealBrowserRecorder". Click Next. Choose the language in which to install the recorder. Click Next. Review the settings in the confirmation dialog and click Back if you wish to make changes. If not, click Next. The Recorder will be installed in your machine. After the installation is completed, click Finish. Make sure the "Launch Real Browser Recorder now" option is checked, if you would like to start the tool automatically after the installation is complete. Recording a New Transaction After installing, the Real Browser Recorder can be accessed under All Programs in Windows Start Menu. You can record a new transaction following these steps: The user has to login first. Enter the hostname and SSL port. Support for APM Plugin is provided. If you are an APM Plugin user, check the Is APM Plugin checkbox. In the login screen, specify the username and password. Only admin and delegated admin users have the authorization to use the recorder. Record the Sequence. Click on the Record New button to start a new recording. Enter the URL of the application you wish to monitor then press enter to load the corresponding web page. Follow the sequence of steps that you wish to monitor. After recording the sequence, click Preview & Save. A Preview & Save screen will be displayed with a list of transaction steps, their corresponding URLs and the actions performed in each page. You can delete the actions which are not required, if necessary, and apply keyword checks and edit the step name. Once you are done, click next to go to the save monitor page. An optional test playback can be carried out by clicking on the "Perform Test Playback" button: This takes you to the Select Agent page which lists out all the existing agents. The agents that are not compatible with the recorder are grayed out. Agents that are not currently running are shown in red. Select the agent & the browser type where you want the test playback to take place. Click Next. After successful playback, the test playback result page is shown where the result of the keyword checks placed earlier on are also displayed. Click next to go to the save monitor page. In the save monitor page, provide basic details such as the monitor name, polling frequency, association with a monitor group etc. The user should also select the browser type & agent locations from which he wants to monitor the transactions. After providing the necessary details, click Save to create the monitor. Repeat the process to create more monitors. If you wish to add existing scripts, use the Import from Selenium IDE option. Edit the captured URL''s You can edit the scripts once the monitor has been created. This can be done by selecting Edit Playback Script from the monitor actions drop down in the monitor details page. Note: Only admin and delegated admin users have the authorization to use the recorder. Importing Selenium IDE Test cases for RBM. The user can import previously recorded HTML test cases from the Selenium IDE and create monitors automatically instead of recording them all over again. Here is how you can import a test case: Click on New Monitor link. Select Real Browser Monitoring under Add EUM Monitor category.In the RBM page, click on the Create Selenium IDE Testcases option to import existing test cases from the Selenium IDE Firefox plugin. In the ensuing form, fill in the display name and polling interval. Click on the Browse button to import a Selenium IDE testcase from your local machine. Select the location agents from the agents displayed where the current testcase has to be replayed periodically. Click the Test button to perform a rudimentary test playback to see if Applications Manager has accepted the script and it is successfully executed. In case of failure, Applications Manager informs you of the reason for failure. Performing a test playback is recommended as it helps detect the errors in the testcase before data collection. Click on the Save button to create a new Real Browser monitor. Note: Currently, we support importing of HTML test cases only.  RBM Dashboard The RBM dashboard provides an overview of the status of your webscripts or transactions from multiple locations. If you click on the individual scripts listed, it will take you to a page which shows the following metrics: This section provides a graphical representation of the total Transaction time of transactions across the different locations where the webscript is running. This section provides a tabular representation of the current status and response time (in milliseconds) of the webscript from the locations where the script is running. The location showing maximum response time will be highlighted on the page. This indicates you the location from where the transaction is responding slow. This section provides a good indication of how each individual URL present within a transaction performs from different geographical locations. This section lists all the URLs of the transaction and shows the response time of each URL from multiple locations. The location from which the URL has the maximum response time value will be highlighted. Click on any of the response time values listed to navigate to the ''Monitor Information'' page of that particular URL. Transaction time of transactions across each location(agent): Current status and response time of the transaction across each location: Response time of the individual URLs in the transaction: Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Real Browser Monitoring under the Web Server/Services Table. The RBM bulk configuration view is displayed distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Monitor Information Parameter Description Name The name of the monitor Health The health (Clear, Warning, Critical) of the monitor based on its dependencies. Polling Interval The time set as the polling interval Agent The name of the EUM agent Script The name of the Webscript Availability The current status of the monitor - whether up or down The results of the functions - Content Check, Element check will be updated for each URL: Validation Content Check - You can validate a specific content in the page. Element Check - You can validate a specific element like Hyperlink in the page. Performance - Last One hour Parameter Description Transaction time The time taken for the entire transaction, i.e, all the URLs, to load.Response Time The average response time for the entire Web transaction. Step page load time The time taken for an individual page, in the transaction, to load. Web Page Analysis: Displays the screenshot of a webpage and performance information such as the load time and size of various components on this webpage like images, css, javascript,etc. This information can be used to optimize the website and reduce the page''s loading time. The screenshots and metrics are displayed by default. This can be altered in the Edit Monitor page under Monitor Actions menu in the Monitor Details page. FAQ: 1. How does Real Browser monitor differ from URL Sequence monitor?   URL Sequence Monitoring Real Browser Monitoring Monitor the availability and performance of Monitors the availability and performance of multi-step web transactions using a real multi-step web transactions, such as online What does it browser, such as online shopping cart. RBM shopping cart. The URL sequence monitor Monitor? supports playback from different supports only the recording of URL sequences geographical locations unlike a URL and not the actions performed in the URLs. sequence monitor. Ideal for Ideal for monitoring web application response Ideal for monitoring web applications that Monitoring time. contain form fillings and AJAX content. How does it Monitors via server side programs without Monitors via a real browser with actual Monitor? actual rendering of a web page. rendering of the web page. Analyses multi-step Web Applications. Analyses server response time of the web Captures response time of the webpage Metrics captured application sequence. Only the response time which includes CSS, images, links loaded of the actual HTML content is only considered. from third party websites etc.  2. The Firefox browser does not launch for EUM agents installed on a Linux server Each version of Mozilla Firefox comes with a set of system requirements to ensure the proper functioning of the web browser. For Real Browser Monitoring, we use Mozilla Firefox version 81. The system requirements for Real Browser Monitoring can be found here. If the Linux environment meets all the requirements mentioned yet the browser doesn''t launch, check if both the 32-bit and 64-bit versions of the libraries are present. In some 64-bit Linux instances, the 32-bit libraries may not be installed by default. To install the 32-bit libraries needed for the proper functioning of Mozilla Firefox version 81, perform the following steps : i. Activate support for the installation of 32-bit applications in your 64-bit system sudo dpkg --add-architecture i386 ii. Update the APT database sudo apt-get update iii. Install the 32-bit libraries required by Mozilla Firefox sudo apt-get install libdbus-glib-1.2:i386 libxt6:i386 libxcomposite1:i386 libstdc++6:i386 libgtk2.0.0:i386 libasound2:i386 -y --reinstall Once the libraries have been installed successfully, the Firefox browser should launch as expected and the RBM monitoring should proceed without any further complications. 3. What are the steps to enable the Playback using Microsoft Edge in an EUM Agent? Download the Microsoft Webdriver for the corresponding version of the Edge installed in the Windows server Please visit here to download Webdriver for Microsoft Edge versions 17 & below To install Microsoft WebDriver for Microsoft Edge versions 17 & above run the following in an elevated command prompt (Administrator mode) DISM.exe /Online /Add-Capability /CapabilityName:Microsoft.WebDriver~~~~0.0.1.0 Note: Playback using Microsoft Edge WebDriver is supported only in the End User Monitoring Agent installed on Windows Server with Microsoft Edge (versions 17 & above) support.4. What are the steps to enable the Playback using Google Chrome in an EUM Agent? To enable playback for Google Chrome, download and install the Chrome Webdriver for the corresponding version of the Chrome installed in the server. To download Webdriver for Google Chrome, click here. Browser Extension for Real Browser Monitoring (RBM) What is Web Transaction Recorder Extension? It is a browser extension which will allow you to record your actions on a website or a web application and monitor them using Real Browser Monitor. The extension is supported for Google Chrome browser. Minimum Requirements: Google Chrome Browser v74 and above Applications Manager v14870 and above Adding the extension to your browser Go to the link and click on Add to Chrome, this will add the extension to your Chrome browser. Alternatively, you can go to Chrome Web Store and search for "Applications Manager Web Transaction Recorder" and click on "Add to Chrome". You can verify that the extension is installed by going to the Extension Management page using chrome://extensions/ link or by navigating to Settings → Extensions. Logging into the extension At the top right corner, click Extensions ( ). Click on Applications Manager Web Transaction Recorder. A new window prompting you to log in will open up. Enter Application Manager''s hostname, port and admin user''s API key in the login window. Only admin and delegated admins are allowed to create a monitor through this extension. Hence, logging in with any other user''s API key will not be successful. On entering the hostname and port, an option to Fetch API Key will be shown above the login button, that option will take you to Applications Manager to fetch the API key. Check the Connect over HTTPS option if you''ve entered the SSL port of your Application Manager''s instance. After entering the details, click on Login. Note: Monitors from the extension will get created in the Application Manager''s instance that you use to log into the extension. Creating a new monitor After successfully logging into the extension, you will see a popup asking "What would you like to do?". Choose any of the following actions which you want to perform:Record a new transaction: Allows you to create a new recording. If you are a first time user, you can use this option. On choosing this option, You will be asked to enter the URL to start recording, this URL will be the "Base URL" of the transaction. You are expected to enter the full URL. For example, https://www.appmanager.com/ Click Start Recording to begin the recording and this will launch a new browser window. Perform the transaction in this window. When you''re done, close this window. After closing the window, click on the ( ) icon on the top right to stop the recording. You will now see all the steps recorded in the window. From here, you can click on Playback and Save to continue with the monitor creation process. Open a recorded transaction: Allows you to open a recorded transaction if you have used this extension earlier to create a recording and have saved it locally. You will be prompted to choose the existing recording from your local storage. On choosing this option, You will be prompted to choose the recording from your files. Choose the recording you want to load. The steps in the selected recording will show up in the recording window. From here, you can click on Playback and Save to continue with the monitor creation process. Import a Selenium Script: Allows you to import an existing selenium script. On choosing this option, You will be prompted to choose the Selenium script from your files. Choose the script you want to load. The steps in the selected script will show up in the recording window. From here, you can click on Playback and Save to continue with the monitor creation process. Clicking on Next takes you to the Preferences page. If you want to configure settings for a test playback, you can do them here. However, test playback is not mandatory to create a monitor, so you can click on Next to proceed to skip test playback and proceed with monitor creation directly. Jump to how to create a monitor Performing test playback: To perform test playback, follow the below steps: In the Preferences page, configure the following details: Page Load Timeout: This is the maximum amount of time in seconds it should take to load a webpage completely. Delay Between Requests (Think Time): It is the time to wait before initiating the next step in the transaction while running the test. This is useful if your page needs extra time to get all components to load correctly. Select Browser For Test Playback: The selected browser will be used for test playback. Select Agent for Test Playback: Select agent in which the Test playback should be performed. Block Domains: Domains which have to be blocked while loading the Web Page. Provide a comma separated value. For example, sampledomain.com, testdomain.in Accept Untrusted Certificate: Enabling this option will ignore any certificate error while doing playback in browser. After configuring these details, click on Do Test Playback. This will start the test playback in the selected agent. Upon completion of playback, you will be shown the playback status (Success/Failure). A successful playback means that all the configurations are correct. A failed playback means that some configuration needs to be modified. You can determine that based on the error message displayed. For example, if the playback failure error message says page load timeout, then you need to increase the page load timeout value in the preferences. After the completion of playback, click on Next to create the monitor. Creating the monitor: Clicking on Next will open the Save Real Browser Monitor page where in you can configure the settings for monitor and its playback. All values will be pre-selected for you. However, you can modify the following: Monitor Name: The name with which the monitor should be created in Applications Manager. Poll Interval: Frequency with which the monitor should do data collection. Default value is 10 mins. Select Browser For Monitoring: The selected browser will be used for playback while doing data collection. Select Agent: Select agent(s) in which the data collection should be performed. Associate with Monitor Group: Select the monitor group with which the monitor should be associated. Show Screenshots: Enabling this option will show screenshots taken during the data collection playback. If your transaction contains sensitive data that you do not want to screenshot then uncheck this option.Show Performance Metrics: Enabling this option will show network performance metrics collected during data collection like the waterfall graph, resource type graph etc. Click on Save Monitor to create the monitor in Applications Manager. Working with the recorder extension Start a new recording: Click on the ( ) icon on the top left to start a new recording. If a recording is in progress, you will be asked for confirmation to discard the recording and start a new one. Open an existing recording: Click on the ( ) icon on the top left to open an existing recording. This will open a selection window for choosing a Selenium script. Save the current recording locally: Click on the ( ) icon on the top left to save an on-going recording locally. This will open a window for choosing the location to save the recording as a selenium script of the format .SIDE. Cancel a recording: At any time, you can click on the ( ) icon on the top left to cancel the recording. Web User Experience Monitoring Applications Manager delivers real-time and trending data about your web application''s performance and the level of satisfaction that your end users experience. Get user satisfactions details at a glance. Track Web transactions response time like where is the most time being spent and which transactions are the slowest. Use Apdex scores to know customers'' satisfaction details at your website and identify trends in across different locations. Know how many users had quick pageload times, how many experienced moderate latency, and how many were frustrated by the experience. Guage error rate and throughput for a particular time period. Know the impact of various browsers and devices on the performance of your webpage. With Applications Manager''s Web User Experience Monitoring dashboard, you get end-to-end Web User Experience monitoring with a variety of color-coded charts and reports to visualizes your data. Adding a new monitor Prerequisties for adding a WUE monitor - The client needs to have a Site24x7 account with the necessary license for using the RUM feature in Site24x7. Steps to set up a Web User Experience Dashboard: Specify a Web Application Name. This will be the name of dashboard created too. Enter the Apdex Threshold (Response time (in milliseconds) threshold for calculating the apdex score. All the responses which are handled within this threshold are considered to satisfy the user). Enter your Site24x7 user ID. If the client is adding an account for the first time, in APM, the AuthToken field is shown for authentication. (Site24x7 User IDs Authtoken which can be generated using details available in https://www.site24x7.com/help/admin/developer/api.html.) Enter the Injection Script (The JavaScript snippet which collects the web user metrics). Once the AuthToken has been generated successfully, a new JavaScript Script is generated for the web application. Copy this JavaScript snippet and insert it into the headers or footers of the pages for which you want to see these metrics. Choose the Monitor Group from the combo box with which you want to associate Web User Experience Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). Monitored ParametersGo to the Monitors Category View by clicking the Monitors tab. Click on Web User Experience under the Web Server/Services Table. Displayed is the Web User Experience bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. List of metrics captured during data collection : Overview Geographic Details Browser Details Device Details ISP Details Web Transaction Details Error Details Overview Parameter Description Summary Report - World View Apdex is a measure of response time against a set threshold. It measures the ratio of satisfactory response times to unsatisfactory response times. The Apdex Score is calculated using the following formula: Apdex Score Unique The number of unique users/visitors actively running an application/url. Users Total Page The total number of page views per user session. Views Components And Response Times Total The total response time is defined as the time between issuing a web page request to the system Response until the page is visible to the user (or the time taken for an application to complete an activity) Time Network The network latency time for the request. Time Redirection The measurement of how long it takes the site to redirect from one URL to another before the page Time is fetched. DNS Resolution The time taken to resolve the URL domain name to the IP address. Time Server Connection Time is the interval between the time that a user initiates a request and the start Connection of fetching the response document from the server. This includes time spent on redirects, domain Time lookups, TCP connects and SSL handshakes. Server The server request processing time. Time Frontend The front-end network time is the time span that is consumed for sending data from/to the front end Time Document Download The time for the browser to download the complete HTML document content. Time Document Processing The time for the browser to build the Document Object Model (DOM). Time Page The total time between opening a page (opening a new URL, clicking a link, opening a newRendering workflow or refreshing a page) and the availability of a page on the browser. Time Geographic Details Parameter Description Location The monitoring location. Apdex is a measure of response time against a set threshold. It measures the ratio of Apdex Score satisfactory response times to unsatisfactory response times. Average The average response time is defined as the time between issuing a web page request to the Response Time In system until the page is visible to the user Ms Total Page Views The total number of page views per user session. Throughput The amount of work the system is doing per unit time. Browser Details Parameter Description Response Time By The average response time sorted by browser type. Browser Browser Usage The graph of browser usage split-up. Split-Up Browser Name The name of the browser used for the session. Total Page Views The total number of page views per user session. Average Response The average response time is defined as the time between issuing a web page request to Time In Ms the system until the page is visible to the user. Throughput The amount of work the system is doing per unit time. Device Details Parameter Description Response Time By The average response time sorted by device type. Device Device Usage Split The graph of device usage split-up. Up Device Name The name of the device used for the session. Total Page Views The total number of page views per user session. Average Response The average response time is defined as the time between issuing a web page request to Time In MS the system until the page is visible to the user. Throughput The amount of work the system is doing per unit time. ISP Details Parameter Description Response Time The response time sorted by ISP type. By ISP Browser Usage The graph of browser usage split-up. Split Up ISP Name The name of the Internet service provider. Total Page The total number of page views per user session. Views Average Time in The average response time is defined as the time between issuing a web page request to the MS system until the page is visible to the user. Throughput The amount of work the system is doing per unit time.Web Transaction Details Parameter Description Transaction Name The name of the transaction for which the current metric data is collected. Average Response The average response time is defined as the time between issuing a web page request to Time in MS the system until the page is visible to the user. Total Page Views The total number of page views per user session. Throughput The amount of work the system is doing per unit time. Error Details Parameter Description JavaScript Errors The type of JavaScript Errors, the URL location of the error and the time of occurance. Total Error Count The number of errors. Click on the JavaScript Errors to get details about the error like File Name, Line Number where the error exists, Column Number and a graph of the Error count. Webpage Analyzer Overview Webpage Analyzer monitors performance of the web page. It helps to analyze all individual components of the page like HTML, CSS, JavaScript, images, etc. Webpage Analyzer helps to optimize the web page performance using PageSpeed rules and suggestions. Creating a new Webpage Analyzer monitor Prerequisites for monitoring Webpage Analyzer metrics: Click here Using the REST API to add a new Webpage Analyzer monitor: Click here Follow the steps given below to create a new Webpage Analyzer monitor: Click on New Monitor link. Select Webpage Analyzer under Web Server/Services category. Specify the Display Name of the Webpage Analyzer monitor. Enter the Webpage URL to be monitored. Enter the maximum time (in seconds) for the page to load in Page Load Timeout field. Enter the time (in seconds) to wait after page load in Wait after load field. Select the HTTP Method to be used for connecting to the website. If POST method is selected, enter the request Pay Load. Use _sep_ to separate the request param name and value. For specifying multiple params, separate them using # symbol. Example: username_sep_admin#password_sep_admin Specify Custom HTTP(S) Header to modify request headers. Use _sep_ to separate the header name and value. For specifying multiple headers, separate them using # symbol. Example: User-Agent_sep_Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36#Accept-Charset_sep_utf-8 Enter the Username and Password for authentication, if required. (Basic Authentication) Enter Domains to block from monitoring separated by "|". Example: adshost2.com|ad.turn.com Enable the Add content check for response checkbox if you wish to perform content check in the page response. Note: Make sure that the content you try to match is present in the page source of the URL. The content search is case-sensitive. If you provide two or more words, the content match is performed for the words separately. Space character will be acting as the delimiter. For example, if you specify the content as ''applications manager''", the match is found for ''applications'' and ''manager'' separately. If you need the content match to be performed for the complete text, specify the two words in quotes, like "applications manager". Enable SSL Certificate monitoring if you wish to monitor SSL certificates in the webpage. After enabling this option, specify the following details:Enter the Domain Name for which SSL certificate is required to be monitored. Make sure to specify the domain name without any protocol such as http or https. Example: www.zoho.com Enter the Port in which the server is running. Select the SSL Version to be used while connecting to the site. The default option Auto tries to connect with all the protocols. Enable the Need proxy to connect the domain checkbox if the server is connected through proxy. In such cases, you should also Configure Proxy through the option available in the Admin tab. Enable the Ignore SSL Certificate name mismatch error checkbox if you want to ignore mismatch error in SSL certificate name. Enable the Ignore invalid root and intermediate certificate checkbox if you wish to ignore invalid root and intermedite certificates. Enter the Timeout value in seconds. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the monitor (optional). Click Add Monitor(s). This discovers Webpage Analyzer from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Webpage Analyzer under the Web Server/Services table. Displayed is the Webpage Analyzer bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Webpage Analyzer monitor dashboard. It has 5 tabs - Overview Network Log SSL Certificate Details Resource Details PageSpeed Insights Overview Parameter Description WEBPAGE SUMMARY Webpage URL URL of the webpage that is monitored. Time taken to load all the contents of the webpage and display them in the browser window Page Load Time (in milliseconds). Total Requests Total number of requests sent for loading the webpage. Page Size Total size of the webpage (in kilobytes). Days for SSL Number of days remaining for the SSL certificate to expire. Certificate Expiry PageSpeed score given (in percentage) based on Page Load Time, Total Requests and Page Page Score Size. RESPONSE TIME SUMMARY DNS Time Amount of time spent for resolving domain name for the request (in milliseconds). Amount of time spent for establishing TCP connection with server (in milliseconds). It Connection Time includes both TCP handshakes/retries and SSL time. Amount of time taken from when the connection to the server established until the first First Byte Time response starts coming in for the base page (in milliseconds). Start Render Amount of time taken for first visible changes to appear in browser screen (in milliseconds). Document Amount of time taken for all resource of the page to be downloaded (in milliseconds). Complete Page Load Time Time taken to load all the contents of the webpage and display them in the browser window(in milliseconds). DOMAIN SUMMARY Domain Name Name of the domain for which the request has been sent. IP Address IP address of each domain. No of Requests Total number of requests sent per domain. Size Amount of data transferred from each domain (in kilobytes). Average Average time taken to send complete response for a request per domain (in milliseconds). Response Time Average Rate at which data is transferred from the domain in response time (in kilobytes per second) Throughput Network Log This tab displays the timing details for all the individual components of the webpage (like HTML, JavaScript, CSS, images etc.) in the form of a Waterfall chart. Parameter Description Resource Name of the resource. Name Status Code The HTTP response status code of the resource. Size Size of the resource (in kilobytes). Content Type Indicates the type of content available in each resource. Total Total number of requests sent for loading the webpage. Requests Page Size Total size of the webpage (in kilobytes). Page Load Time taken to load all the contents of the webpage and display them in the browser window (in Time milliseconds). SSL Certificate Details This tab consists of SSL certificate details about both the issuer and the buyer. Parameter Description ISSUED TO Common Name (CN) Name of the host or domain to which the SSL certificate is issued. Organization (O) Name of the organization to which the SSL certificate is issued. Organization Unit (OU) Name of the organization unit making the request. ISSUED BY Common Name (CN) Name of the host or domain that issues the SSL certificate. Organization (O) Name of the organization that issues the SSL certificate. Organization Unit (OU) Name of the organization unit making the request. VALIDITY Issued On Date at which the SSL Certificate was issued. Expires On Date at which the SSL certificate will expire. Days for SSL Certificate expiry Number of days remaining for the SSL certificate to expire. Resource Details Parameter Description REQUEST SUMMARY Request Type Type of request sent by the resource. No of Requests Number of requests sent for each type in a resource. Size Amount of data transferred for each type in a resource (in kilobytes). Screenshots - Displays the screenshot of the webpage along with performance information such as the size andcount of various components on this webpage in the form of pie charts. Resource Size % Total size of the resource (in percentage). Resource count % Total count of the resource (in percentage). PageSpeed Insights PageSpeed Insights analyzes the webpage contents and generates suggestions to make page faster. It analyzes page with certain rules and provides score for each rule based on performance of the webpage. This tab displays the PageSpeed insight details along with the PageSpeed score that can help in optimizing webpage performance. Parameter Description PAGESPEED SCORE Rule Indicates the PageSpeed rule. For more information, refer here. Score Indicates the score obtained for each rule by the webpage. Grade Indicates the grade obtained for the score for each rule. PageSpeed Insight Rules Following are the list of PageSpeed rules that are used to analyze webpage performance in Applications Manager: Avoid bad requests - Indicates that the broken links or requests that result in 404/410 errors can be removed to avoids wasteful requests. Avoid CSS @import - Indicates that the use of CSS @import in an external stylesheet can be avoided to reduce additional delays during the loading of a web page. Defer parsing of JavaScript - Indicates that the amount of JavaScript used in the webpage can be minimized or deferred to reduce additional delays during the loading of a web page. Enable compression - Indicates that the size of files sent from your webpage can be compressed (using gzip) to reduce the webpage size and to increase the speed to which they are transferred to the browser. Enable Keep-Alive - Indicates that the HTTP Keep-Alive or HTTP persistent connections can be enabled to reduce the webpage latency by allowing the same TCP connection to send and receive multiple HTTP requests. Leverage browser caching - Indicates that the resources of your webpage can be cached and reused by leveraging browser caching to reduce the page load times for users revisiting your webpages. Make landing page redirects cacheable - Indicates that the redirects of your webpage can be cached by the browser to reduce page load times for repeat visitors to your webpage. Minify CSS - Indicates that the CSS code of your webpage can be minimized and condensed to save data and to speed up downloading, parsing, and execution time. Minify HTML - Indicates that the HTML code (including inline JavaScript and CSS code) of your webpage can be minimized and condensed to save data and to speed up downloading, parsing, and execution time. Minify JavaScript - Indicates that the Javascript code of your webpage can be minimized and condensed to save data and to speed up downloading, parsing, and execution time. Minimize redirects - Indicates that the HTTP redirects from your webpage can be minimized to reduce additional RTT latency and wait time for users. Optimize images - Indicates that the images on your webpage can be optimized to minimize page load times by loading appropriately sized images. Remove query strings from static resources - Indicates that the query strings can be removed from references to static resources in your webpage for better caching. Serve resources from a consistent URL - Indicates that the resources used in your webpage can be served from a unique URL to eliminate duplicate download bytes and additional RTTs. Specify a cache validator - Indicates that a cache validator (such as Last-Modifier or ETag headers) can be specified to all the static resources of your webpage for better caching by the browsers. Specify a ''Vary: Accept-Encoding'' header - Indicates that the HTTP header "Vary: Accept-Encoding" can be specified in your webpage to store both compressed and uncompressed version of the resource for better performance. Specify a character set - Indicates that the character set can be specified in the HTTP response headers of your webpage for faster browser processing and to reduce page load times. Monitoring Apache SolrApache Solr - An Overview Monitoring Apache Solr - What we do. Creating a new Apache Solr monitor Monitored Parameters Apache Solr - An Overview Solr is a popular, open source enterprise search platform built on Apache Lucene. Providing distributed search and index replication, Solr is designed for scalability and Fault tolerance. With load-balanced querying, automated failover and recovery, Solr drives the search and navigation features of many of the world''s largest internet sites. Monitoring Apache Solr - What we do Let’s take a look at what you need to see to monitor Solr, the performance metrics to gather and how you can ensure that your Solr search server is up and operating as expected with Applications Manager: Resource utilization details - Applications manager automatically discovers Solr servers, monitors memory and CPU and notifies you of changes in resource consumption. Thread and JVM usage - Track thread usage in Solr by monitoring the status of the threads such as blocked, waiting, etc. Ensure open threads don’t overload Solr server''s memory. Core and Replication Statistics - Monitor the cores and their replicase with details like health and overall index size. Know if a core is a master or a slave node and its replication enabled status. Query and update stats, cache level details and search times - Make sure Solr''s query handler is processing incoming requests properly with metrics like the number of search requests, search errors, search timeouts and Luke requests per minute. Know cache level details like lookups, hit ration, evictions, and cache size. Understand how the update handler is handling update by looking at the number of commits, rollbacks and documents added/deleted/pending. Find out how long it takes for searcher or caches to load. Fix performance problems faster - Get instant notifications when there are performance issues with the components of Apache Solr. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Creating a new Apache Solr monitor Supported versions : Apache Solr 7.5 and lower versions. Using the REST API to add a new Apache Solr monitor: Click here To create an Apache Solr Monitor, follow the steps given below: Click on New Monitor link. Choose Apache Solr. Enter Display Name of the monitor. Enter the IP Address or hostname of the host in which the Solr instance is running. Provide the port number in which the Solr instance is running. Enable SSL option, if SSL is enabled in Apache Solr Server. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Apache Solr Server Choose the Monitor Group from the combo box with which you want to associate Apache Solr Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Apache Solr from the network and starts monitoring. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Apache Solr under the Web Server/Services Table. Displayed is the Apache Solr bulk configuration view distributed into three tabs: Availability tab  displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Core Details JVMCore Statistics Configuration Core Details Parameter Description Core Details The total number of Solr cores on a single Solr instance. (A Solr core is an Total number of cores index and associated transaction log and configuration files. An installation can have multiple cores.) The total number of active Solr cores, i.e a core that is in active state for Active cores querying, on the Solr instance. Lead Cores The total number of active leader Solr cores. Cores Core Name The name of the Solr core on the instance. Host Name The host name of the machine running Solr. Number of Docs / Min The number of documents added into a collection per minute. The maximum number of documents that can be added to a collection per Max Docs / Min minute. Deleted Docs / Min The number of documents deleted from the collection per minute. The state of corresponding core, whether it is active or inactive. This is State referred in turn for querying. Searcher Warmup Time The warmup time taken by searcher in between the query processing. Average Search Time The average time taken for processing the query and searching. Replication Core Name The name of the Solr core on the instance. Master Node Specifies if a replication instance of Solr is a master. Slave Node Specifies if a replication instance of Solr is a slave. Index Size Specifies the index size of the individual cores. Replications Enabled Specifies if you have master/slave replication enabled. JVM Parameter Description Thread Details Thread State - A thread that is waiting indefinitely for another thread to WAITING Threads perform a particular action. Thread State - A thread that is waiting for another thread to perform an action TIMED_WAITING Threads for up to a specified waiting time. RUNNABLE Threads Thread State - A thread executing in the Java virtual machine. BLOCKED Threads Thread State - A thread that is blocked waiting for a monitor lock. TERMINATED Threads Thread State - A thread that has exited. Memory Usage Core Name The name of the Solr core on the instance. Used Memory (MB) The space that is currently occupied. Free Memory (MB) The total free memory available to the JVM. Committed Virtual Memory Size The total size of virtual memory that is currently occupied by the (MB) corresponding Solr cores. Free Physical Memory Size (MB) The total size of physical memory that is free and available for the Solr cores. The total size of the swap space that is free and available for swapping when Free Swap Space Size (MB) the virtual memory reaches the limit. ProcessCPUTime (sec) The total CPU time taken by the corresponding Solr cores, for executing theinstructions. Used Memory (%) The percentage of space that is currently occupied. Free Memory (%) The percentage of free memory available to the JVM. Memory Utilization The total size of physical memory that is available for the Solr for its Total Physical Memory Size operations and storage. The total size of the swap space that is available for swapping when the virtual Total Swap Space Size memory reaches the limit. Total Heap Memory The total heap memory available for the Solr instance. Max Heap Memory The maximum heap memory that the Solr instance can use. Core Statistics Parameter Description Query Handler Core Name The name of the Solr core on the instance. Search Requests / Min The total search requests handled by the corresponding Solr cores per minute. The total errors that occur during the search requests handled by the Search Errors / Min corresponding Solr cores per minute. The total timeouts that occur during the search requests handled by the Search Timeouts / Min corresponding Solr cores per minute. The average time taken for handling the each search requests handled by the Average Search Time corresponding Solr cores per minute. The total replication requests handled by the corresponding Solr cores per Replication Requests / Min minute. The total update requests handled by the corresponding Solr cores per Update Requests / Min minute. Luke Requests / Min The total Luke requests handled by the corresponding Solr cores per minute. Cache Core Name The name of the Solr core on the instance. Cache Name The name of your application cache. Lookups / Min Number of Solr query cache lookups per minute. Hits / Min Number of query hits per minute. The percentage of requests that are satisfied by entries already in the cache Hit Ratio / Min per minute. Evictions / Min The number of entries removed from the cache per minute. Cache Size (Bytes) The size of the field value cache. Update Handler Core Name The name of the Solr core on the instance. The number of commits per minute. (A commit writes all loaded documents to Commits / Min one or more segment files on the disk.) The number of rollbacks per minute. (The rollback reverts all add and deletes Rollbacks / Min made to the index since the last commit.) Docs Add / Min The number of documents added per minute. Docs Deleted by Query / Min The number of documents deleted by Query per minute. Docs Deleted by ID / Min The number of documents deleted by ID per minute. Docs Pending The number of documents pending commit. Errors / Min The number of errors occurred per minute. Optimizations / Min The number of optimizations done per minute. Number of Transaction Logs The total number of the transaction logs. Transaction Logs size (Bytes) The total size of the transaction logs.Configuration Parameter Description OS Name The name of the operating system used in the running machine. Architecture The architecture of the machine where the instance is running. Available Processors The total available processors of the machine where the instance is running. The home directory where the java instance used by Apache Solr is installed Java Installation Directory on the machine. Java Version The version of the java instance used by Apache Solr installed in the machine. Java Vendor The vendor of the Java instance used by Apache Solr installed in the machine. Jetty Home The home directory where the jetty server is installed in the machine. Controller Port The port where the jetty server is currently running in the machine. Client Name The current machine name. User Directory The home directory where the Solr is installed. Solr Version The version of the Solr installed. Lucene Version The version of the Lucene installed. Deployment Mode The current deployment mode of the Solr (Cloud or Standalone). Cluster Client TimeOut The maximum timeout set for the connection establishment with zookeeper.   Elasticsearch Monitoring Elasticsearch - An Overview Monitoring Elasticsearch - What we do Creating a new Elasticsearch monitor (How to demo) Monitored Parameters Elasticsearch - An Overview Elasticsearch is a highly scalable, distributed, open source RESTful search and analytics engine. It is multitenant- capable with an HTTP web interface and schema-free JSON documents. Based on Apache Lucene, Elasticsearch is one of the most popular enterprise search engines today and is capable of solving a growing number of use cases like log analytics, real-time application monitoring, and click stream analytics. Monitoring Elasticsearch - What we do Let’s take a look at what you need to see to monitor Elasticsearch, the performance metrics to gather and how you can ensure that your search server is up and operating as expected with Applications Manager''s Elasticsearch monitoring: Resource Utilization Details - Applications Manager automatically discovers Elasticsearch servers, monitors memory and CPU and notifies you of changes in resource consumption of thread pool queues. Real-Time Data - You get up-to-the-second insight into cluster runtime metrics, individual cluster nodes, real- time threads and configurations. Cluster and Node Monitoring - Stay on top of your cluster and node health in real-time with fine-grained statistics of performance from Disk I/O Java to Memory usage metrics. Search and Indexing Performance - Gain complete control of your indexes and mappings. Monitor query latency, file system cache usage and request rates and take action if it surpasses a threshold. Fix Performance Problems Faster - Get instant notifications when there are performance issues. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Creating a new Elasticsearch monitor Using the REST API to add a new Elasticsearch monitor: Click here To create an Elasticsearch Monitor, follow the steps given below:Click on New Monitor link. Choose ElasticsearchCluster. Specify the Display Name of the Elasticsearch monitor. Enter the HostName or IP Address of the host where Elasticsearch Cluster runs. Enter the Port of the Elasticsearch Cluster. By default, it will be 9200. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Elasticsearch server. Choose the Monitor Group from the combo box with which you want to associate Elasticsearch Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Elasticsearch from the network and starts monitoring. Demo Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Elasticsearch and ElasticsearchCluster monitors under the Web Server/Services Table. Displayed is the Elasticsearch or the ElasticsearchCluster bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Elasticsearch Cluster Overview Cluster Details Indices Configuration Elasticsearch Overview Memory Details I/O Details Thread Pools Network Configuration Elasticsearch ClusterOverview Parameter Description Node Details Cluster Name The name of the cluster in which the node is located. Node Name The name of the node The type of the node (Client or Data or Master-Eligible or Master- Node Type Data) The first phase of search operation is Query. The time taken to Avg Query Time process the query in all shards The second phase of search operation is Fetch. The time taken to Avg Fetch Time retrieve the query result, only from the shards which have the requested data. CLUSTER OVERVIEW Cluster Status The status of the cluster depending on the replicas of the cluster. Total Nodes The total number of nodes in the cluster. Total Indices The total number of indices in the cluster. Total Shards The total number of shards in the cluster. Total Docs The total number of documents present in the cluster. Total Pending Tasks The total number of pending tasks in the cluster. Cluster Details Parameter Description NODES SPLITUP Client Node The total number of Client Nodes in the cluster. Data Node The total number of Data Nodes in the cluster. Master Node The total number of Master Eligible Nodes in the cluster. The total number of Data Nodes, which also acts as Master Eligible Data-Master Node Nodes in the cluster. SHARDS COUNT Active Shards The number of Active Shards present in the cluster. Active Primary Shards The number of Primary Shards that are Active in the cluster. Relocating Shards The number of Relocating Shards present in the cluster. Initializing Shards The number of Initializing Shards present in the cluster. Unassigned Shards The number of Unassigned Shards present in the cluster. Delayed Unassigned Shards The number of Delayed Unassigned Shards present in the cluster. Total Shards The number of Shards present in the cluster. Active Shards Percent The percentage of Active Shards Active Primary Shards Percent The percentage of Active Primary Shards Shards Relocating Shards Percent The percentage of Relocating Shards Initializing Shards Percent The percentage of Initializing Shards Unassigned Shards Percent The percentage of Unassigned Shards Delayed Unassigned Shards Percent The percentage of Delayed Unassigned Shards PENDING TASKS Insert Order The order of the task in which it is inserted into the queue Priority The priority assigned for the particular Task Source The Source for the Pending Task Time in Queue The total waiting time of the Task in that queue. IndicesPARAMETER DESCRIPTION Indices Overview Index Name The name of the index representing a collection of documents. Indicates the number of documents that are available in the Documents particular index. Amount of time taken to index a document in the particular index Indexing Latency (in millisecond). Indexing Rate The number of documents that are indexed per second. Amount of time taken to process the query in the particular index Query Latency (in millisecond). Query Rate The number of queries that are processed by the index per second. Amount of time taken to run the query and retrieve the data in the Fetch Latency particular index (in millisecond). The number of queries that are run and retrieved data by the index Fetch Rate per second. Indicates the number of merges that have occurred in the Current Merges particular index. Amount of time taken to merge segments in the particular index (in Merge Time millisecond). Amount of time taken to flush one or more indices to disk (in Flush Time millisecond). Refresh Time Amount of time taken to refresh an index (in millisecond). Configuration PARAMETER DESCRIPTION CONFIGURATION DETAILS Cluster Name The name of the cluster. Cluster Status The status of the cluster. Total Nodes The total number of nodes in the cluster. Master Node Name The name of the Master Node in the cluster. Master Node Port The port on which the Master node of Elasticsearch runs. Master Node IP The IP address in which the Master Node runs. Publish Port The publish port of the cluster. Elasticsearch Overview PARAMETER DESCRIPTION AVERAGE SYSTEM LOAD Avg. System The average value of the amount of load that is being processed by the system (in the last 1 Load minute, 5 minutes, and 15 minutes). CPU UTILIZATION CPU Amount of CPU currently being utilized by the node (in %).  Utilization SEARCH TIME Average The first phase of search operation is Query. The time taken to process the query in all shards Query Time Average The second phase of search operation is Fetch. The time taken to retrieve the query result, only Fetch Time from the shards which have the requested data. SEGMENT TIME Average The average time taken for segment merging in a node. (A shard in elasticsearch is a Lucene Merge Time index, broken down into segments. Segments are, periodically, merged into larger segments tokeep the index size at bay and expunge deletes.) Average The average time spent in refreshing an index. (Refresh time increases with the number of file Refresh Time operations for the Lucene index). INDEXING TIME Average The average time taken to index a document. (Documents are indexed i.e stored and made Index Time searchable.) Average The average time taken to delete an existing index. Delete Time Indexed The number of documents indexed. Count Deleted The number of deleted documents. Count Indexing The number of documents that are indexed per second. Rate GET TIME Average Get The average time taken to retrieve information about one or more indexes Time Existing The number of get requests that were present. Count Missing The number of get requests that were missing. Count FLUSH TIME The average time taken to flush one or more indices to disk. (The flush process of an index Average basically frees memory from the index by flushing data to the index storage and clearing the Flush Time internal transaction log.) WARMER TIME Average The average time taken to perform a warmup search on an index. (Index warming allows to run Warmer Time registered search requests to warm up the index before it is available for search.) PERCOLATE TIME The average time spent running percolator queries. (One of Elasticsearch''s core feature is the Average ability to do search in reverse with the percolator. The percolator automatically indexes the query Percolate terms with the percolator queries. This allows the percolator to percolate documents more Time quickly.) Memory Details The total space used in the Direct Buffer pool. PARAMETER DESCRIPTION HEAP MEMORY Used Heap Percent The percentage of JVM heap currently in use. Free Heap Percent The percentage of JVM heap currently free NON-HEAP MEMORY Used Non-Heap Percent The percentage of non-heap memory currently in use. Free Non-Heap Percent The percentage of non-heap memory currently free. GARBAGE COLLECTION GC Time - Young The total time spent on young-generation garbage collections. GC Time - Old The total time spent on old-generation garbage collections. GC Count - Young The total number of young-generation garbage collections. GC Count - Old The total number of old-generation garbage collections. BUFFER POOLS Direct Buffer Space Used The total space used in the Direct Buffer pool. Mapped Buffer Space Used The total space used in the Mapped Buffer pool. Direct Buffer Connection Count The total connections to Direct Buffer pool.Mapped Buffer Connection Count The total connections to Mapped Buffer pool. I/O Details PARAMETER DESCRIPTION DISK I/O COUNT Disk Read Count The number of read ( from the disk) requests by Elasticsearch. Disk Write Count The number of write ( to the disk) requests by Elasticsearch. DISK I/O SIZE Disk Read Size The total size of read requests ( from the disk) by Elasticsearch. Disk Write Size The total size of write requests ( to the disk) by Elasticsearch. CACHE DETAILS Cache Name The name of the cache. Total Size (MB) The size of the cache. Evictions The number of evictions from the filter cache. BREAKER DETAILS The name of the Circuit Breaker. (Circuit breakers are designed to deal with situations when request processing needs more memory Breaker Name than available. This would mean OOM (OutOfMemoryException). So sometimes it is better to fail a query instead of getting OOM, because when OOM appears JVM becomes not responsive.) Limit Size (MB) The limit size of the particular Breaker. Used Size (MB) The used size of the particular Breaker. Tripped The total number of times the breaker circuit tripped. Thread Pools PARAMETER DESCRIPTION THREAD DETAILS Thread Name The name of the thread. Configured Threads The number of threads of current configured type. Queue The number of thread of current type in queue. Active The number of active threads of current type. Rejected The number of rejected threads of current type. Largest The number of largest threads of current type. Network PARAMETER DESCRIPTION TRANSPORT The number of bytes sent by the network. (Transport metrics about Transmitted Bytes cluster communication) The number of bytes received by the network. (Transport metrics Received Bytes about cluster communication) The number of data packets sent by the network. (Transport Transmitted Packets metrics about cluster communication) The number of data packets received by the network. (Transport Received Packets metrics about cluster communication) TCP CONNECTOR Active Connections The number of active TCP connections. Passive Connections The number of passive TCP connections. HTTP CONNECTORCurrent Connections The number of http connections currently active. Total Connections The total number of http connections. Configuration PARAMETER DESCRIPTION CONFIGURATION DETAILS Cluster Name The name of the cluster. Node Name The name of the node in the cluster. Node Type The type of the node (Client/Data/Master-Eligible/Data-Master). Host The IP address of the Host. ElasticSearch Version The version of the installed Elasticsearch. Port The port in which Elasticsearch runs. ElasticSearch Home The home directory of Elasticsearch. Total Processors The total number of processors in the current node Java Version The version of Java running in the node. Java Vendor The Java vendor. ManageEngine OpManager Monitoring Overview ManageEngine OpManager is a comprehensive network  management software for heterogeneous, multi-vendor enterprise IT networks. It offers advanced fault and performance management functionality across critical IT resources viz. network devices, WAN or VoIP links, servers, virtual servers, Domain controllers, MS Exchange, MS SQL and other IT infrastructure components. Applications Manager provides you with critical information (like CPU and memory usage, thread count and PGSQL database details) essential to track the performance of OpManager. Get instant notifications when there are performance issues. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Creating a new ManageEngine OpManager monitor Monitored Parameters ManageEngine OpManager - Creating a new monitor Mode of Monitoring: Remote JMX For PGSQL DB, statistics will be collected by connecting to the database. Prerequisites for monitoring ManageEngine OpManager: Click here Using the REST API to add a new OpManager monitor: Click here To create an ManageEngine OpManager Monitor, follow the steps given below: Specify the Display Name of the ManageEngine OpManager monitor. Enter the HostName or IP Address of the host where OpManager is running. Enter the JMX Port where OpManager is running. By default, it will be 8080. Enter the credential details like user name, password and JNDIPath or select credentials from a Credential Manager list. Click Monitor PGSQL Database for PGSQL stats. (Enter DataBase Name, DataBasePort, UserName and Password). Enter the polling interval time in minutes. Choose the Monitor Group from the combo box with which you want to associate ME OpManager Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers OpManager from the network and starts monitoring. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP]Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on ME OpManager under the Web Server/ ServicesTable. Displayed is the OpManager bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. List of metrics captured during data collection: Performance Overview Parameter Description Thread Details The total number of threads created and also started since the Java virtual machine Thread Count started. Threads in Running The total number of threads executing in the Java virtual machine in running state. State Threads in Waiting The total number of threads in the Java virtual machine in waiting state. State Blocked Threads A thread that is blocked waiting for a monitor lock is in this state. Timed Waiting A thread that is waiting for another thread to perform an action, for up to a specified Threads waiting time is in this state. Deadlock Threads The number of threads that are in deadlock waiting to acquire object monitors. Memory Details Name The Heap Memory/ Non- Heap Memory usage in MB. Commited Memory The current allocated memory in MB. Total Memory The total allocated memory in MB. Used Memory The current used memory in MB. Free Memory The current free memory in MB. CPU Details CPU Usage  This indicates the CPU usage of the JVM on the server. MSSQL DataBase Statistics ATTRIBUTE NAME DESCRIPTION MEMORY USAGE Total Memory The total amount of dynamic memory the server is currently consuming. SQL Cache Memory The total  amount of dynamic memory the server is using for the dynamic SQL cache. Lock Memory The total  amount of dynamic memory the server is using for locks. Optimizer Memory The total amount of dynamic memory the server is using for query optimization. Connection Memory The total amount of dynamic memory the server is using for maintaining connections. Granted WorkSpace The total amount of memory granted to executing processes. This memory is used for Memory hash, sort and create index operations. Memory Grants The current number of processes waiting for a workspace memory grant. Pending Memory Grants The current number of processes that have successfully acquired a workspace memory Success grant. BUFFER MANAGER STATISTICS The percentage of pages that were found in the buffer pool without having to incur a read Buffer Hit Ratio from disk. Page LookUps/Min The number of requests to find a page in the buffer pool.ATTRIBUTE NAME DESCRIPTION Page Reads/Min The number of physical database page reads issued. Page Writes/Min The number of physical database page writes issued. Total Pages The number of pages in the buffer pool (includes database, free, and stolen). Database Pages The number of pages in the buffer pool with database content. Free Pages The total number of pages on all free lists. Page Life The number of seconds a page will stay in the buffer pool without references. Expectancy CONNECTION STATISTICS Connection Time The time taken to get connected to the MS SQL database server. Active Connections The number of users connected to the system. Logins/Min The total number of logins started per minute. Logouts/Min The total number of logouts started per minute. CACHE DETAILS Cache Hit Ratio The ratio between cache hits and lookups Cache Used/Min The times each type of cache object has been used Cache Count The number of cache objects in the cache Cache Pages The number of 8k pages used by cache objects LOCK DETAILS Lock Requests/Min The number of new locks and lock conversions requested from the lock manager. Lock Waits/Min The total wait time for locks in the last minute. The number of lock requests that timed out. This includes internal requests for NOWAIT Lock Timeouts/Min locks. Deadlocks/Min The number of lock requests that resulted in a deadlock. Average Lock Wait The average amount of wait time for each lock request that resulted in a wait. Time SQL STATISTICS Batch Requests/Min The number of SQL batch requests received by server. SQL The number of SQL compilations. Compilations/Min SQL The number of SQL re-compiles. Recompilations/Min AutoParams/Min The number of auto-parameterization attempts. Failed The number of failed auto-parameterizations. AutoParams/Min LATCH DETAILS The number of latch requests that could not be granted immediately and had to wait Latch Waits/Min before being granted. Average Latch Wait The average latch wait time for latch requests that had to wait. Time TOP SLOW RUNNING QUERIES Avg. Execution Time The average time taken for complete execution of this query. Maximum Execution The maximum elapsed time for any complete execution of this query. Time Minimum Execution The minimum elapsed time for any complete execution of this query. Time No of Executions The number of times that the query has been executed since the plan was last compiled. Query The SQL query text. Last Execution Time The last time at which the query started executing. TOP QUERIES BY MOST FREQUENTLY EXECUTED Execution Count The number of times that the query has been executed since the plan was last compiled.ATTRIBUTE NAME DESCRIPTION Query The SQL query text. The Database against which this query has been executed (will be empty for ad hoc and DB Name prepared batches). Last Execution Time The last time at which the query started executing. Average Execution The average time taken to execute an individual query. Time TOP QUERIES BY MOST FREQUENTLY BLOCKED Average Time The average amount of time the query was blocked. Blocked Total Time Blocked The cumulative total amount of time for which the query was blocked. Query The SQL query text. DB Name The Database against which this query has been executed. Last Execution Time The last time at which the query started executing. Average Execution The average time taken to execute an individual query. Time PGSQL STATISTICS ATTRIBUTE NAME DESCRIPTION CONNECTION STATISTICS Active Connections The number of currently active connections to the database. LOCK STATISTICS Locks Held The number of locks held by the indicated session Locks Wait The number of locks waiting in the database BUFFER STATISTICS The total buffer hits (i.e., block read requests avoided by finding the block already in buffer Buffer Hits/min cache) per minute Block Reads/Min The total disk blocks read per minute Cache Hit Ratio The current ratio of buffer cache hits to total requests DISK USAGE DETAILS Disk Usage The size of the on-disk representation of all tables in the database in MB Index Scan Ratio The current ratio of index scans to total scans(index scan+sque scan) TRANSACTION DETAILS Total Commits The total transactions commited. Total Rollbacks The total transactions rolled back Commits/Min The total transactions committed per minute Rollbacks/Min The total transactions rolled back per minute PRIMARY DATATBASE OBJECTS STATISTICS Size of the Largest The size of the largest table in the database server Table Largest Table(s) The largest table in the database server DATABASE DETAILS Database Name The name of the database DB Size The size of the database LONG RUNNING QUERY DETAILS Database Name The name of the database where the Query is running for longer time. Username The username of the database. Runtime The amount of time the query ran. Query The query that is running for longer time in the database.(more than 2 mins)ATTRIBUTE NAME DESCRIPTION TOP 50 TABLE ROW DETAILS Tablename The name of the table No.of Rows The total no.of rows in the table Table size The size of the Table Configuration Parameter Description Configuration Details  Available Processors  The number of processors available to the JVM. Uptime The uptime of the Java virtual machine. Start Time The start time of the Java virtual machine in milliseconds. Free Physical Memory The amount of free physical memory in Megabytes. Total Physical Memory Total amount of physical memory in Megabytes. Total Swap Space Total amount of swap space in Megabytes. Free Swap Space The amount of free swap space in Megabytes. Committed Virtual The amount of virtual memory that is guaranteed to be available to the running process Memory in Megabytes. HAProxy Monitoring HAProxy - An Overview Monitoring HAProxy - What we do Creating a new HAProxy monitor Monitored Parameters HAProxy - An Overview HAProxy (stands for High Availability Proxy) is a popular open source TCP/HTTP Load Balancing software and proxying solution for TCP and HTTP-based applications. It is fast, reliable and particularly suited for very high traffic web sites and powers quite a number of the world''s most visited ones. Monitoring HAProxy - What we do As HAProxy is most commonly used to improve the performance and reliability of a server environment by distributing the workload across multiple servers (e.g. web, application, database), the best way to ensure proper HAProxy performance and operation is by monitoring its key metrics of the Listener, Frontend, Backend and Server. Applications Manager''s HAProxy Monitoring provides you with: Frontend metrics such as client connections and requests. Backend metrics such as availability and health of backend servers. Health metrics that reflect the state of your HAProxy setup. You can correlate frontend metrics with backend metrics for a more comprehensive view of your infrastructure and quickly identify potential hotspots. Applications Manager helps you become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Creating a new HAProxy monitor Prerequisites for monitoring HAProxy metrics : Click here Rest API to add a new HAProxy monitor : Click here To add a HAProxy Monitor, follow the steps given below: Go to New Monitor and click on Add New Monitor link. Select HAProxy. Specify the Display Name of the HAProxy monitor.Enter the HostName or IP Address of the host where stats of the HAProxy runs. Enter the Port where stats of the HAProxy are displayed. By default, it will be 8080. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the HAProxy Monitor (optional). Click Add Monitor(s). This discovers HAProxy servers from the network and starts monitoring them. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on HAProxy under the Web Server/Services Table. Displayed is the HAProxy bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Listener Frontend Backend Server Configuration Overview PARAMETER DESCRIPTION HAPROXY UTILIZATION DETAILS HAProxy Utilization Percentage HAProxy''s CPU utilization in percentage. Running Tasks Total number of tasks currenlty running in HAProxy CONNECTION RATE Connections per Second HAProxy''s client connections per second. CONNECTION DETAILS Current Connections The number of current connections. PIPE DETAILS Current Pipes The number of current pipes open. Listener PARAMETER DESCRIPTION SESSION UTILIZATION Utilized Sessions The number of sessions used. Free Sessions The number of inactive sessions. TRANSACTION DETAILS Denied Requests The number of requests denied due to security concerns (ACL-restricted). Denied Responses The number of responses denied due to security concerns (ACL-restricted). Request Errors The number of requests whose responses yielded an error. OVERVIEW Current Sessions The current number of sessions being used to issue requests. Utilized Sessions  (%) The percentage of sessions used. Bytes In  (KB) The number of bytes received by the listener. Bytes Out  (KB) The number of bytes sent by the listener. The http address of the listener (host:port or "unix". IPV6 has brackets around the Address address)PARAMETER DESCRIPTION Mode Mode of the proxy (tcp, http, etc.) Status The service status (UP/DOWN/NOLB/MAINT/MAINT(via)/MAINT(resolution)...) TRANSACTION DETAILS Denied Requests The number of requests denied due to security concerns (ACL-restricted). Denied Responses The number of responses denied due to security concerns (ACL-restricted). Request Errors The number of requests whose responses yielded an error. Request Denied by The number of requests denied by a connection. Connection Request Denied by Session The number of requests denied by a session. Frontend Frontend metrics provide information about the client’s interaction with the load balancer itself. PARAMETER DESCRIPTION SESSION UTILIZATION Utilized Sessions The number of sessions used. Free Sessions The number of inactive sessions. TRANSACTION DETAILS Denied Requests The number of requests denied due to security concerns (ACL-restricted). Denied Responses The number of responses denied due to security concerns (ACL-restricted). Request Errors The number of requests whose responses yielded an error. OVERVIEW The service name (FRONTEND for frontend, BACKEND for backend, any name for Service Name server/listener). Current Sessions The current number of sessions being used to issue requests. Utilized Sessions  (%) The percentage of sessions used. Session Rate The number of sessions created per second. Max Session Rate   The maximum number of new sessions per second. Bytes In  (KB) The number of bytes received by the frontend. Bytes Out  (KB) The number of bytes sent by the frontend. Mode Mode of the proxy (tcp, http, etc.) Status The frontend status (UP/DOWN/NOLB/MAINT/MAINT(via)/MAINT(resolution)...) TRANSACTION DETAILS The service name (FRONTEND for frontend, BACKEND for backend, any name for Service Name server/listener). Denied Requests The number of requests denied due to security concerns (ACL-restricted). Denied Responses The number of responses denied due to security concerns (ACL-restricted). Request Errors The number of requests whose responses yielded an error. Total Requests The total number of HTTP requests. Request Denied by The number of requests denied by "tcp-request connection" rules. Connection Request Denied by Session The number of requests denied by "tcp-request session" rules Request Rate The rate of HTTP requests per second. Max Request Rate The maximum number of HTTP requests per second Connections per Second The number of connections over the last elapsed second. HTTP RESPONSE COUNT The service name (FRONTEND for frontend, BACKEND for backend, any name for Service Name server/listener).PARAMETER DESCRIPTION HAProxy exposes the number of responses by HTTP status code - 1xx, 2xx, 3xx, 4xx, Total HTTP Responses 5xx and other codes. Ideally, all responses forwarded by HAProxy would be class 2xx codes. COMPRESSION DETAILS Bytes into Compressor The number of HTTP response bytes fed to the compressor. Bytes from Compressor The number of HTTP response bytes emitted by the compressor. Bytes bypassed Compressor The number of bytes that bypassed the HTTP compressor. Responses Compressed   The number of HTTP responses that were compressed. Backend PARAMETER DESCRIPTION QUEUE UTILIZATION Utilized Queue The currently queued requests. Free Queue The number of free queued requests. SESSION DETAILS Utilized Sessions The number of sessions used. Free Sessions The number of inactive sessions. OVERVIEW Servers can be assigned a weight parameter to manipulate how frequently the Total Weight server is selected. The total downtime in seconds. The value for the backend is the downtime for the Total Downtime  (sec) whole backend, not the sum of the server downtime. Downtime Percentage The total downtime in percentage. This is calculated with the uptime of HAProxy. Active Servers The number of active servers. Backup Servers The number of backup servers The total number of times a server was selected, either for new sessions, or when No. times Server selected re-dispatching. The server counter is the number of times that server was selected. Mode Mode of the proxy (tcp, http, etc.) Status The frontend status (UP/DOWN/NOLB/MAINT/MAINT(via)/MAINT(resolution)...) SESSION DETAILS Current Queue Size The sum of total queue size of all the backend servers. Utilized Queue  (%) The percentage of queues used. Current Sessions The current number of sessions being used to issue requests. Utilized Sessions  (%) The percentage of sessions used. Session Rate Session rate is the number of new sessions per second. Max No.of new Sessions The maximum number of new sessions that can be created per second. Time Since Last Session The seconds since last session assigned to server/backend. Assigned  (sec) TRANSACTION DETAILS Bytes In  (KB) The Rate of bytes in on backend hosts. Bytes Out  (KB) The Rate of bytes in on backend hosts. Denied Requests The requests denied by "tcp-request connection" rules. Denied Responses The requests denied by "tcp-request session" rules. The number of requests that encountered an error trying to connect to a backend Connection Errors server. Response Errors The number of response errors generated by your backends. RESPONSE SUMMARYPARAMETER DESCRIPTION HAProxy exposes the number of responses by HTTP status code - 1xx, 2xx, 3xx, 4xx, Total HTTP Responses 5xx and other codes. Ideally, all responses forwarded by HAProxy would be class 2xx codes. Average Session Time (ms) The average time taken for the sessions. Average Response Time The sum of average queue, connect and response time. (ms) Multi-process configurations involving source port ranges may cause random failures under high loads (because more than one process may try to use the same Connection Retries source port to connect to the same server). The system will report an error and a retry will happen, picking another port. A high value in the "retries" parameter comes with increased CPU usage and processing time. The number of times a request was redispatched to another server. The server Requests Redispatched value counts the number of times that server was switched away from. Client Aborts The number of data transfers aborted by the client. Server Aborts The number of data transfers aborted by the server. COMPRESSOR DETAILS Bytes into Compressor The number of HTTP response bytes fed to the compressor. Bytes from Compressor The number of HTTP response bytes emitted by the compressor. Bytes bypassed Compressor The number of bytes that bypassed the HTTP compressor. Responses Compressed  The number of HTTP responses that were compressed. Server PARAMETER DESCRIPTION QUEUE UTILIZATION Utilized Queue The currently queued requests. Free Queue The number of free queued requests. SESSION DETAILS Utilized Queue The number of sessions used. Free Queue The number of inactive sessions. OVERVIEW The total server weight. The "weight" parameter is used to adjust the server''s weight relative to other servers. All servers will receive a load proportional to their Server Weight weight relative to the sum of all weights, so the higher the weight, the higher the load. Total Downtime  (sec) The total server downtime (in seconds). Downtime Percentage The total downtime in percentage. This is calculated with the uptime of HAProxy. Active Server The number of active servers. Backup Server The number of backup servers. The total number of times a server was selected, either for new sessions, or when No. times Server selected re-dispatching. Address The Server IP address. Mode Mode of the proxy (tcp, http, etc.) Status The frontend status (UP/DOWN/NOLB/MAINT/MAINT(via)/MAINT(resolution)...) SESSION DETAILS Current Queue Size The sum of total queue size of all the servers. Utilized Queue  (%) The percentage of queues used. Current Sessions The current number of sessions being used to issue requests. Utilized Sessions  (%) The percentage of sessions used. Session Rate Session rate is the number of new sessions per second. Max No.of new Sessions The maximum number of new sessions that can be created per second.PARAMETER DESCRIPTION Time Since Last Session The seconds since last session assigned to server/backend. Assigned  (sec) TRANSACTION DETAILS Bytes In  (KB) The total number of bytes recieved by the server in the last second from the client. Bytes Out  (KB) The total number of bytes sent by the server in the last second. Denied Responses The number of requests denied due to security restrictions. Connection Errors The number of requests that encountered an error trying to connect to a server. Response Errors The number of response errors generated by your server. The throttle percentage for the server, when slowstart is active, or no value if not in Throttle Percentage slowstart. RESPONSE SUMMARY HAProxy exposes the number of responses by HTTP status code - 1xx, 2xx, 3xx, 4xx, Total HTTP Responses 5xx and other codes. Ideally, all responses forwarded by HAProxy would be class 2xx codes. Average Session Time (ms) The average time taken for the sessions. Average Response Time The sum of average queue, connect and response time. (ms) Multi-process configurations involving source port ranges may cause random failures under high loads (because more than one process may try to use the same Connection Retries source port to connect to the same server). The system will report an error and a retry will happen, picking another port. A high value in the "retries" parameter comes with increased CPU usage and processing time. The number of times a request was redispatched to another server. The server Requests Redispatched value counts the number of times that server was switched away from. Client Aborts The number of data transfers aborted by the client. Server Aborts The number of data transfers aborted by the server. HEALTH CHECKS Failed Checks The number of failed checks (Only counts checks failed when the server is up.) Failed Health Checks The number of failed health checks. Health Check Response The Response Code of the failed health check. Code Health Check Content, Health Check Description, The failed health checks details. Health Check Description, Health Check Duration in ms Agent Check Response Code, Agent Check Content, The last agent check details. Agent Check Description, Agent Check Duration in ms Configuration PARAMETER DESCRIPTION CONFIGURATION DETAILS Process ID The process id of HAProxy assigned by the system. Server Start Time The time when the server is last restarted. Version The version of HAProxy. Maximum Memory Maximum allowed memory for HAProxy. Maximum Sockets Maximum number sockets allowed to create. The maximum number of connections HAProxy can handle is limited by your Maximum Connections configuration and platform Maximum Pipes Maximum number of pipes allowed to create for tranferring information Maximum File descriptors Maximum number of file descriptors allowed to open.Nginx Plus Overview The best way to ensure your NGINX Plus servers are healthy and stable is to set up a robust NGINX Plus monitor which can provide thorough monitoring and swift alerting services. Applications Manager''s NGINX Plus monitoring tool collects important metric data and interprets it in visual and tabular formats for easy understanding. Its monitoring capability is not limited only to web servers and websites; it can monitor your entire IT infrastructure. Adding an NGINX Plus monitor: To monitor a Nginx Plus instance follow the steps given below: Go to New Monitor ---> Nginx Plus (under Web server/services). Enter the Display Name of the Nginx Plus monitor. Enter the Host Name or IP Address of the host where Nginx Plus instance is running. Enter the port of the Nginx Plus instance. By default, it will be 443. If the Nginx Plus instance should be accessed over an HTTP(s) connection only, check SSL is enabled checkbox. For HTTP connections, uncheck the checkbox. It will be checked by default. You can enter credentials(user name and password) and click Test Credential. Or if you have predefined credential details, click Select from Credential List and select the desired credentials. This is not mandatory. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Nginx Plus monitor (optional). You can also create a new monitor group and add this monitor under it. Click Add Monitor to save. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Nginx Plus under the Web Server/Services Table. Click on the desired Nginx Plus monitor to view the attribute data. Nginx Plus monitor displays 6 metric tabs excluding the Monitor Information tab. They are: Overview Server Zones Upstreams Caches TCP/UDP Zones  TCP/UDP Upstreams Overview Parameter  Description  Connection Details Connections Accepted Number of connections accepted. Connections Dropped Number of connections dropped. Percentage of connections dropped Number of connections dropped in percentage. Active connections Number of active connections. Idle connections Number of idle connections. SSL Connections SSL connections established Number of SSL connections established. HTTP Requests HTTP requests received Number of HTTP requests received. HTTP request rate Rate of HTTP requests received in number of requests/ minute. Current HTTP requests Number of HTTP requests currently being handled. Server ZonesParameter Description Zones Overview Zone Name of the Upstream zone. Requests received Number of requests received. Requests in process Number of requests in process. Requests discarded  Number of requests discarded. Response Code 1xx Number of Information response codes. Response Code 2xx  Number of Successful response codes. Response Code 3xx Number of Redirection message response codes. Response Code 4xx Number of Client Error response codes. Response Code 5xx Number of Server Error response codes. Bytes Received Rate(KB/Min) Rate of bytes received in KB/minute. Bytes Sent Rate(KB/Min) Rate of bytes sent in KB/ minute. Upstreams Parameter Description Zones Zone Name of the server zone. HTTP requests received Number of HTTP requests received. Response Code 1xx   Number of Information response codes. Response Code 2xx   Number of Successful response codes. Response Code 3xx Number of Redirection message response codes. Response Code 4xx  Number of Client Error response codes. Response Code 5xx Number of Server Error response codes. Bytes Received Rate(KB/Min) Rate of bytes received in KB/minute. Bytes Sent Rate(KB/Min) Rate of bytes sent in KB/ minute. Upstream Servers Server Name Name of the server. Host Name of the host. Port Port Number Zone Name of the zone.  Response Time(ms) Time taken to respond in ms. Health Checks Failed(%) Number of health checks failed in %.  HTTP requests received Number of HTTP requests received. Response Code 1xx Number of Information response codes. Response Code 2xx Number of Successful response codes. Response Code 3xx Number of Redirection message response codes. Response Code 4xx Number of Client Error response codes. Response Code 5xx Number of Server Error response codes. Bytes Received Rate(KB/Min) Rate of bytes received in KB/minute. Bytes Sent Rate(KB/Min) Rate of bytes sent in KB/ minute. Caches Parameter Description Cache Overview Cache Name     Name of the cache State     State of the cacheParameter Description Current Size(MB) Current size of the cache memory in MB Max Size(MB) Maximum size of the cache memory in MB Hit Ratio(%) Cache hit ratio in percentage  Valid Responses Read Number of valid responses read Expired Responses Read Number of expired responses read Responses Read Total number of responses read Responses missing in cache Number of responses missing in cache Expired Responses present in cache Number of expired responses which are present in the cache and not read haven''t been read Responses not looked in cache (Proxy Number of reponses sent without involvement of the cache memory Bypass) Responses not read Number of responses which weren''t read Responses Written Number of responses written TCP/UDP Zones Parameter Description Overview Zone Name of the server zone Current Connections Number of connections currently made Connections Received Number of connections received Response Code 2xx   Number of Successful response codes Response Code 4xx  Number of Client Error response codes Response Code 5xx Number of Server Error response codes Requests discarded Number of requests discarded Bytes Received Rate(KB/Min) Rate of bytes received in KB/minute Bytes Sent Rate(KB/Min) Rate of bytes sent in KB/ minute TCP/UDP Upstreams Parameter Description TCP/UDP Zones Zone Name of the Upstream zone. Current Connections Number of connections currently made. Connections received Number of connections received. Bytes Received Rate(KB/Min) Rate of bytes received in KB/minute. Bytes Sent Rate(KB/Min) Rate of bytes sent in KB/ minute. TCP/UDP Servers Server Name Name of the server. Host Name of the host. Port Port Number. Zone Name of the zone. Response Time(ms) Time taken to respond in ms. Health Checks Failed(%) Number of health checks failed in %. Current Connections Number of connections currently made. Connection Received Number of connections received. Bytes Received Rate(KB/Min) Rate of bytes received in KB/minute. Bytes Sent Rate(KB/Min) Rate of bytes sent in KB/ minute.  ME ServiceDesk Plus Monitoring Overview ManageEngine ServiceDesk Plus is a web-based Help Desk and Asset Management Software. It offers an integrated package with Incident management(Trouble Ticketing), Asset Tracking, Purchasing, Contract Management, Self-Service Portal and Knowledge Base. It provides great visibility and central control in dealing with IT issues to ensure that businesses suffer no downtime. Applications Manager provides you with critical information (like CPU and memory usage, thread count, mail fetch and database details) essential to track the performance of ServiceDesk Plus. Get instant notifications when there are performance issues. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Creating a new SDP monitor Monitored Parameters ServiceDesk Plus - Creating a new monitor Supported versions: ServiceDesk Plus MSP 9202, ServiceDesk Plus 9228 Prerequisites to monitor ServiceDesk Plus monitor: Click here Using the REST API to add a new ServiceDesk Plus monitor: Click here To create an ServiceDesk Plus Monitor, follow the steps given below:  Specify the Display Name of the ServiceDesk Plus monitor. Enter the HostName or IP Address of the host where ServiceDesk Plus is running. Enter the Port where ServiceDesk Plus is running. By default, it will be 8080. Enable the SSL is enabled option if SSL is enabled. Specify the RestAPI Key of ServiceDesk Plus. Check the Monitor Database checkbox to select the type of database. Enter the DBHostname and the Database name. Check the is SSL enabled option if SSL is enabled. Specify the Database Port of ServiceDesk Plus. Enter the username and password for accessing the database. Enter the polling interval time in minutes. Choose the Monitor Group from the combo box with which you want to associate ServiceDesk Plus Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers ServiceDesk Plus from the network and starts monitoring. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on ServiceDesk Plus under the Web Server/ Services Table. Displayed is the ServiceDesk Plus bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. List of metrics captured during data collection : Parameter Description MAIL FETCHING DETAILS Portal Name of the portal. The fetching status for incoming and outgoing mail in SeviceDesk Plus. The possible values are: Mail Fetching Running Status StoppedThis specifies if the task is performed by a user or by the admin. The possible values are: Task Administrator Performed By System  The fetching status of the last mail in SeviceDesk Plus. The possible values are: Last Mail Fetch Run Success status Failed Mail Fetch Error The relevant error message of the failed mail fetch run. Message DATABASE DETAILS The status of the connection between SeviceDesk Plus and the database. The possible values DB are: Connection Success Status Failed  DB Connection The relevant error message of the failed database connection run. Status Message BACKUP SCHEDULING DETAILS The status of the scheduled backup. The possible values are: Backup Scheduling Enabled Status Disabled Successful Backup taken The time when the last successful backup was performed. at No.of Days since Backup The number of days since successful backup was performed. taken The status of the Last Backup Scheduled. The possible values are: Last Backup Success Status Failed Last Backup Scheduled The time for which the last backup was scheduled. Time Backup Scheduling The relevant error message of the a failed scheduled backup process. Error Message THREADS Total Thread The total number of threads created and started since the JVM started. Count Thread Count The current number of live threads . Blocked Thread State - The number of threads blocked waiting for a monitor lock. Thread Count The number of threads that are blocked in the JVM. (A deadlock is a state where two, or more, Deadlock threads are blocked waiting for the other blocked waiting thread (or threads) to finish; thus none Thread Count of the threads will ever complete.) MEMORY USAGE The type of memory. The possible values are: Type Heap Non-HeapMax Memory The maximum allocated memory in MB. (MB) Used Memory The space that is currently occupied by Java objects. (MB) Free Memory The total free memory available to the JVM for new objects. (MB) Used Memory The percentage of used memory by the JVM. (%) Free Memory The percentage of free memory not being used by the JVM. (%) CPU USAGE CPU Usage The percentage of CPU usage of the JVM. (%) PGSQL Statistics Parameter Description Connection Statistics Active Connections Number of currently active connections to the database Lock Statistics Locks Held Number of locks held by the indicated session Locks Wait Number of locks waiting in the database Buffer Statistics  Total buffer hits (i.e., block read requests avoided by finding the block already in buffer Buffer Hits/min cache) per minute Block Reads/Min Total disk blocks read per minute Cache Hit Ratio The current ratio of buffer cache hits to total requests Disk Usage Details Disk Usage Size of the on-disk representation of all tables in the database in MB Index Scan Ratio The current ratio of index scans to total scans(index scan+sque scan) Transaction Details Total Commits Total transactions committed Total Rollbacks Total transactions rolled back Commits/Min Total transactions committed per minute Rollbacks/Min Total transactions rolled back per minute Primary Database Object Statistics Size of the Largest Size of the largest table in the database server Table Largest Table(s) Largest table in the database server Database Details Database Name Name of the database DB Size Size of the database Long Running Query Details Database Name Name of the database where the Query is running for longer time. Username Username of the database Runtime Time for how long the query ran. Query Query that is running for longer time in the database.(more than 2 mins) Top 50 Table Row Details Tablename Name of the table No.of Rows Total no.of rows in the table Table size Size of the TableME ADManager Plus Monitoring Overview ManageEngine ADManager Plus is an easy-to-use Windows Active Directory Management and Reporting Solution that helps AD Administrators and Help Desk Technicians with their day-to-day activities. With a centralized and Intuitive web-based UI, the software handles a variety of complex tasks like Bulk Management of User accounts and other AD objects, delegates Role-based access to Help Desk Technicians, and generates an exhaustive list of AD Reports, some of which are an essential requirement to satisfy Compliance Audits. This Active Directory tool also offers mobile AD apps that empower you to perform important user management tasks right from your mobile devices. Applications Manager provides you with critical information (like CPU and memory usage, thread count and PGSQL / MSSQL database details) essential to track the performance of ADManager Plus. Get instant notifications when there are performance issues. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Creating a new ManageEngine ADManager Plus monitor Monitored Parameters ME ADManager Plus - Creating a new monitor Supported versions: ADManager Plus 6.5 Mode of Monitoring: Remote JMX Prerequisites for monitoring ManageEngine ADManager Plus: Click here Using the REST API to add a new ADManager Plus monitor: Click here To create an ADManager Plus Monitor, follow the steps given below:  Specify the Display Name of the ADManager Plus monitor. Enter the HostName or IP Address of the host where ADManager Plus is running. Enter the JMX Port where ADManager Plus is running. By default, it will be 8080. Check the Monitor Database checkbox to select the type of database. Enter the DBHostname and the Database name. Check the is SSL enabled option if SSL is enabled. Specify the Database Port of ADManager Plus. Enter the username and password for accessing the database. Enter the polling interval time in minutes. Choose the Monitor Group from the combo box with which you want to associate ADManager Plus Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers ADManager Plus from the network and starts monitoring. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on ADManager Plus under the Web Server/ ServicesTable. Displayed is the ADManager Plus bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. List of metrics captured during data collection: Performance Overview MSSQL DataBase Statistics PGSQL Statistics Configuration Performance Overview ATTRIBUTE NAME DESCRIPTIONATTRIBUTE NAME DESCRIPTION THREAD DETAILS The total number of threads created and also started since the Java virtual machine Thread Count started. Threads in Running The total number of threads executing in the Java virtual machine in running state. State Threads in Waiting The total number of threads in the Java virtual machine in waiting state. State Blocked Threads The threads blocked and waiting for a monitor lock. Timed Waiting The threads waiting for another thread to perform an action, for up to a specified Threads waiting time. Deadlock Threads The number of threads that are in deadlock waiting to acquire object monitors. CPU DETAILS CPU Usage  The CPU usage of the JVM on the server. MEMORY DETAILS Name The heap memory/ non-heap memory usage in MB. Commited   The current allocated memory in MB. Max   The maximum allocated memory in MB. Used  The currently used memory in MB. Free   The currently free memory in MB. Free % The percentage of currently free memory. Used %  The percentage of currently used memory. MSSQL DataBase Statistics ATTRIBUTE NAME DESCRIPTION MEMORY USAGE Total Memory The total amount of dynamic memory the server is currently consuming. SQL Cache Memory The total  amount of dynamic memory the server is using for the dynamic SQL cache. Lock Memory The total  amount of dynamic memory the server is using for locks. Optimizer Memory The total amount of dynamic memory the server is using for query optimization. Connection Memory The total amount of dynamic memory the server is using for maintaining connections. Granted WorkSpace The total amount of memory granted to executing processes. This memory is used for Memory hash, sort and create index operations. Memory Grants The current number of processes waiting for a workspace memory grant. Pending Memory Grants The current number of processes that have successfully acquired a workspace memory Success grant. BUFFER MANAGER STATISTICS The percentage of pages that were found in the buffer pool without having to incur a read Buffer Hit Ratio from disk. Page LookUps/Min The number of requests to find a page in the buffer pool. Page Reads/Min The number of physical database page reads issued. Page Writes/Min The number of physical database page writes issued. Total Pages The number of pages in the buffer pool (includes database, free, and stolen). Database Pages The number of pages in the buffer pool with database content. Free Pages The total number of pages on all free lists. Page Life The number of seconds a page will stay in the buffer pool without references. Expectancy CONNECTION STATISTICS Connection Time The time taken to get connected to the MS SQL database server.ATTRIBUTE NAME DESCRIPTION Active Connections The number of users connected to the system. Logins/Min The total number of logins started per minute. Logouts/Min The total number of logouts started per minute. CACHE DETAILS Cache Hit Ratio The ratio between cache hits and lookups Cache Used/Min The times each type of cache object has been used Cache Count The number of cache objects in the cache Cache Pages The number of 8k pages used by cache objects LOCK DETAILS Lock Requests/Min The number of new locks and lock conversions requested from the lock manager. Lock Waits/Min The total wait time for locks in the last minute. The number of lock requests that timed out. This includes internal requests for NOWAIT Lock Timeouts/Min locks. Deadlocks/Min The number of lock requests that resulted in a deadlock. Average Lock Wait The average amount of wait time for each lock request that resulted in a wait. Time SQL STATISTICS Batch Requests/Min The number of SQL batch requests received by server. SQL The number of SQL compilations. Compilations/Min SQL The number of SQL re-compiles. Recompilations/Min AutoParams/Min The number of auto-parameterization attempts. Failed The number of failed auto-parameterizations. AutoParams/Min LATCH DETAILS The number of latch requests that could not be granted immediately and had to wait Latch Waits/Min before being granted. Average Latch Wait The average latch wait time for latch requests that had to wait. Time TOP SLOW RUNNING QUERIES Avg. Execution Time The average time taken for complete execution of this query. Maximum Execution The maximum elapsed time for any complete execution of this query. Time Minimum Execution The minimum elapsed time for any complete execution of this query. Time No of Executions The number of times that the query has been executed since the plan was last compiled. Query The SQL query text. Last Execution Time The last time at which the query started executing. TOP QUERIES BY MOST FREQUENTLY EXECUTED Execution Count The number of times that the query has been executed since the plan was last compiled. Query The SQL query text. The Database against which this query has been executed (will be empty for ad hoc and DB Name prepared batches). Last Execution Time The last time at which the query started executing. Average Execution The average time taken to execute an individual query. Time TOP QUERIES BY MOST FREQUENTLY BLOCKED Average Time The average amount of time the query was blocked. BlockedATTRIBUTE NAME DESCRIPTION Total Time Blocked The cumulative total amount of time for which the query was blocked. Query The SQL query text. DB Name The Database against which this query has been executed. Last Execution Time The last time at which the query started executing. Average Execution The average time taken to execute an individual query. Time PGSQL STATISTICS ATTRIBUTE NAME DESCRIPTION CONNECTION STATISTICS Active Connections The number of currently active connections to the database. LOCK STATISTICS Locks Held The number of locks held by the indicated session Locks Wait The number of locks waiting in the database BUFFER STATISTICS The total buffer hits (i.e., block read requests avoided by finding the block already in buffer Buffer Hits/min cache) per minute Block Reads/Min The total disk blocks read per minute Cache Hit Ratio The current ratio of buffer cache hits to total requests DISK USAGE DETAILS Disk Usage The size of the on-disk representation of all tables in the database in MB Index Scan Ratio The current ratio of index scans to total scans(index scan+sque scan) TRANSACTION DETAILS Total Commits The total transactions commited. Total Rollbacks The total transactions rolled back Commits/Min The total transactions committed per minute Rollbacks/Min The total transactions rolled back per minute PRIMARY DATATBASE OBJECTS STATISTICS Size of the Largest The size of the largest table in the database server Table Largest Table(s) The largest table in the database server DATABASE DETAILS Database Name The name of the database DB Size The size of the database LONG RUNNING QUERY DETAILS Database Name The name of the database where the Query is running for longer time. Username The username of the database. Runtime The amount of time the query ran. Query The query that is running for longer time in the database.(more than 2 mins) TOP 50 TABLE ROW DETAILS Tablename The name of the table No.of Rows The total no.of rows in the table Table size The size of the Table Configurations Details ATTRIBUTE NAME DESCRIPTION Available Processors  The number of processors available to the JVM.ATTRIBUTE NAME DESCRIPTION Uptime The uptime of the Java virtual machine. Start Time The start time of the Java virtual machine in milliseconds. Free Physical Memory The amount of free physical memory in Megabytes. Total Physical Memory The total amount of physical memory in Megabytes. Total Swap Space The total amount of swap space in Megabytes. Free Swap Space The amount of free swap space in Megabytes. Committed Virtual The amount of virtual memory that is guaranteed to be available to the running process Memory in Megabytes. Website Content Monitoring Website Defacement - An Overview Monitoring Website Content - What we do. Creating a new Website Content Monitor Monitored Parameters Website Defacement - An Overview Website defacement, a great threat to any online business, refers to unauthorized hacks on your website. It includes modifying or altering a website with insertion of potentially hazardous content, images, malicious code, or even deletion of the same and in some cases, instances like code injections. A defaced web page can thus inflict severe damage to your business reputation and reliability. Monitoring Website Content - What we do Website monitoring tools like Applications Manager lets you monitor your websites for defacement, modification and malicious insertions and be notified promptly during a hack detection. The Website Content monitoring feature from Applications Manager allows you to monitor six basic HTML elements namely Text, Script, Image, Anchor, Iframe and Link. It detects website hack and any change in website content and reports before it can affect your customer. The altered content is displayed in separate tabs. The tabs (hidden by default) are shown only when there is a content modification or defacement. Our standard defacement monitoring includes tracking for unauthorized addition or modification of the following HTML elements: Text Defacement - Identify content changes concerning the visible content in the rendered web page. Script Defacement - Identify changes in the scripts embedded and detect any ''src'' attribute changes for the external script. Image Defacement - Identify ''src'' attribute changes in the images present in the web page. Alert if there is any image displayed from a new domain other than the captured domains. Anchor Defacement - Identify ''href'' attribute changes in the anchor links present in the web page. Alert if there is a link to a new domain other than the captured domains. Iframe Defacement - Identify ''src'' attribute changes in the iframe elements and notify if there is a change in the domain name in the configured URL. Link Defacement - Identify ''href'' attribute changes in the link elements of the web page. In this help document, you will learn how to enhance your website monitoring capabilities by safeguarding your webpages from defacement using Applications Manager''s Website Content monitoring. Creating a new Website Content Monitor To create a new Website Content monitor, follow the steps given below: Click on New Monitor link. Select Website Content Monitor under Web Server/Services category. Specify the Display Name of the Website Content Monitor. Enter the complete URL of the Website which you want to monitor. Check the Auto overwrite the defaced content, if you want to overwrite the original web content with the web content fetched during the particular poll. This overwrite will happen only when the defacement persists for 1 hour.Enter the Username and Password, if you have enabled it for the website. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Monitor (optional). Click on Get Webpages to fetch the webpages present in the current website. Select the monitors which you want to add as child monitors. A maximum of 10 child monitors can be selected. Edit the Threshold percentage or Display names of the webpages listed. Click on Add Monitor to add the monitors. How to add Website Content Monitor Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Website Content Monitor under the Web Server/Services table. Displayed is the Website Content monitor''s bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Website Content Monitor dashboard, where you can view the list of monitored webpage URLs and their current status. Following are the list of metrics that are monitored in Website Content monitor: Website Content Monitoring Overview Webpage Content Monitoring Overview Defaced Script Elements Defaced Text Elements Other Elements Defaced Website Content Monitoring Overview Parameter Description WEBPAGE DETAILS Webpage URL The URL of the webpage. Defaced Script The percentage change in the current script against the original script. Percent (%)Parameter Description Defaced Text The percentage change in the current text against the original text. Percent (%) The current page size. This metric helps you validate the current web page size and the Page Size (KB) percentage change in present page size to earlier page dimension. Webpage Content Monitoring Overview Parameter Description PAGE SIZE The current page size. This metric helps you validate the current web page size and the Page Size percentage change in present page size to earlier page dimension. DEFACEMENT PERCENTAGE DETAILS Defaced Script The percentage change in the current script against the original script. Percent Defaced Text The percentage change in the current text against the original text. Percent RESPONSE TIME Response The response time of the website. Time Defaced Script Elements Parameter Description DEFACED SCRIPT DETAILS Original & The current and original script to help you identify changes with respect to the scripts Modified embedded and detect any ''src'' attribute change for the external script. Content Defaced Text Elements Parameter Description DEFACED TEXT DETAILS Original & The current and original text to help you identify any content changes with respect to the Modified Content visible content in the rendered website page. Other Elements Defaced Parameter Description DEFACED ANCHOR DETAILS Original & The current and original content to help you identify ''href'' attribute changes in the anchor links Modified present in the website page. You can also identify ''src'' attribute changes in the iframe element and Content notify if there is a change in the domain name in the configured URL. REST API Monitoring REST API - An Overview REST (REpresentational State Transfer) is a design concept (architecture) for managing state information which defines how data communication is to be done using HTTP protocols. The API calls which adhere to the REST definition (pretty much most of them!) are called REST APIs. Monitoring REST API - What we do Monitor the availability and response time of your REST API endpoints. Get insight into the response time of mobile and web applications that use your API. Verify that the APIs are returning the correct data in the response details tab.Get notification when key API transactions fail. Detect downtime and fix critical issues before customers are affected. REST API monitoring - Adding a new REST API monitor Using the REST API to add a new RESTAPI monitor: Click here To configure RESTAPI monitor, follow the steps mentioned below: Click on New Monitor link. Select REST API. Enter Display Name of the monitor. Enter REST API URL i.e the API call to be monitored. Enter Timeout in Seconds - the amount of time spent by APM to establish a connection with the server hosting the API service. Select the Form Submission method used to access the API. Enter the credential details for User Authentication like user name and password if required or select credentials from a Credential Manager list. If no authentication is required, then leave the fields blank. Configure the HTTP(s) Headers required to establish a connection with the API server. Use _sep_ to separate the header name and value. For specifying multiple headers, use the separator #. Example: User-Agent_sep_Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36#Accept-Charset_sep_utf-8 Specify the type of response to be expected. For XML and JSON response, user can define specific response values to monitor in the Response Details tab in the Monitor Details page. Make sure the proxy settings configured in Applications Manager matches with the proxy settings in the browser. Bypassing the local addresses and subnet mask are required based on the API being monitored. Make sure that the content you try to match is present in the API response. Click Test Credentials button, to make sure the API service is accessible from the Applications Manager installed machine. Choose the Monitor Group from the combo box with which you want to associate REST API Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the REST API service from the network and starts monitoring. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on REST API under the Web Server/Services table. Displayed is the REST API bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Parameter Description It is the total time taken to get a REST API response. The response time of a RESTAPI monitor is calculated as the sum of DNS lookup time, connection time and the time contracted to receive the response in JSON, text or XML. Response Time Response Time Domain Name Resolution Time Connection Time Request Processing Time Download Time The size of the response in bytes along with the percentage change in size between consecutive Response polls. Content Page Size Details Page Size Change Custom Attributes Based on the response obtained, the user can define their own attributes for monitoring specific values in the API response. If the response is of type XML - Using the XSLT transformation the user can define specific values to be monitored. Ensure that the following criteria are met :The output method should be of type ''text''. Syntax : The final output should be of the format AttrName::AttrVal. Example : Days: would create an attribute ''Name'' whose value will be the value of the tag present in the API Response. If the response if of type JSON - The JSON schema can be used to configure user-defined attributes. Ensure that the following criteria are met : The attribute should be defined as AttrName::AttrValue. Example: Temperature::response.weather.temperature. This will create an attribute name ''Temperature'' containing the value of the temperature variable returned Multiple JSON Schemas can be defined by using new line as the delimiter. If the JSON key itself contains a dot(.) then please replace it with ''_sep_''. This should be done for all the individual keys which contain a dot(.) in it. In the above example, say the last key ''temperature'' was defined as ''temperature.celsius''. Then the format should be Temperature::response.weather.temperature_sep_celsius. REST API Sequence Monitoring Overview Modern web applications are built with an complex mix of HTML and API calls ie. applications are highly dependent on REST API calls to retrieve the data or perform an actions. When an API call fails, it can affect complete workflow of the application. Therefore, it is important to monitor each API call. REST API Sequence monitor is meant to monitor the complete workflow of REST-based mobile and web applications. Creating a new REST API Sequence monitor To configure REST API monitor, follow the steps mentioned below: Click on Add New Monitor link under New Monitor. Select REST API Sequence. Enter Display Name of the monitor. Specify the polling interval for which the status of the monitor should be updated (in minutes). Provide the transaction steps that are to be monitored. Each step represents an API call in your application''s workflow. Transaction steps can be added by choosing any one of the following options: Import Steps: This option allows you to add the transaction steps by importing the recorded API transactions from the HAR file generated by the web browser. Click here to learn about generating HAR file Add Step: This options lets you to add the transaction steps manually into the monitor. After selecting this option, enter the following details: Specify the step name that is to be added. Enter the Endpoint URL of the REST API to be monitored. The URL must be in HTTP/HTTPS. Enable the Stop on error option to make the monitor down when the step fails and stop further execution of steps. Specify the Timeout in seconds. Select the Form Submission Method used to access the API request using any one of the following HTTP methods: GET, POST, PUT, or DELETE. If you select POST or PUT method, you will be asked to choose the Request Body Type from the following options: FORM: If you select this, enter the Request body in a line-by-line format Text: If you select this, enter the Request body in text format XML: If you select this, enter the Request body in XML format JSON: If you select this, enter the Request body in JSON format Configure the HTTP Request Headers required to establish a connection with the API server. Enter the credential details for user authentication, if required. or select credentials from a Credential Manager list. Choose None if no authentication is required. You can choose any of the following options: Basic authentication: Authenticates the REST API endpoint using basic credentials such as username and password. Credential Manager: Authenticates the REST API endpoint by selecting credentials from Credential Manager.OAuth Token: Authenticates the REST API endpoint using an OAuth token. Web Token: Authenticates the REST API endpoint using a Web Token. Specify the list of success status code(s) that indicate successful response, separated by commas. Example: 202,200 You can also provide the status code range separated with a colon. Example: 200:250 Specify the Response Type to be expected. For XML and JSON response, user can define specific response values to monitor in the Response Details tab in the Monitor Details page. Enable the Add content check for response checkbox if you wish to perform content check in the API response. Once enabled, perform the following steps: Specify the contents that should contain and/or should not contain while performing the check in the API response. Enable the Do case sensitive keyword search checkbox if you wish to perform a content check for case-sensitive character strings. Enable the Regular Expression checkbox if you wish to perform a content check based on regular expressions. (Refer Regex Guide for more info) Note: Make sure that the content you try to match is present in the API response. The content search is case-sensitive. If you provide two or more words, the content match is performed for the words separately. Space character will be acting as the delimiter. For example, if you specify the content as ''applications manager''", the match is found for ''applications'' and ''manager'' separately. If you need the content match to be performed for the complete text, specify the two words in quotes, like "applications manager". Select Response Format based on which values are to be extracted for parameter forwarding. Individual values from responses can be extracted using regular expressions, JSONPath expressions or XPath expressions for parameter forwarding. (Text, XML, or JSON) Provide additional parameters required to fetch the values from the API response, in the form of ''name-value'' pair. The value should be provided based on the API response type. ie. For TEXT, provide value as regular expression. For JSON, provide value as JSONPath expression. For XML provide value as XPath expression. Refer Parameter Forwarding to know more. Provide response headers required to fetch the values from the API response, in the form of ''name- value'' pair. The value should be provided as a regular expression. After entering all the above details, click Save. Choose the Monitor Group from the combo box with which you want to associate REST API Sequence monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the REST API sequence from the network and starts monitoring. Note: A maximum of 25 steps are only allowed to be added in a monitor. Parameter Forwarding Parameter forwarding can be used to pass data and test data validation between chained requests. Individual values from API response are extracted using XPath, JSONPath, or Regular expressions and can be saved as custom parameters. Also, values can be extracted from response headers using a regular expression. These parameters can then be used to build custom query strings or POST data for subsequent steps. Based on your selection of Text, XML or JSON-based response data format, you can build custom Regex-based expressions, XPath expressions, or JSONPath based expression assertions. Upon invoking ${Parameter} argument into the HTTP requests of your successive steps, the output value of the invoked expression assertion will be used in these steps for various step validation scenarios.Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on REST API Sequence under the Web Server/Services section. Displayed is the REST API Sequence Monitor''s bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Following are the list of metrics shown in the REST API Sequence Monitor in their corresponding tabs: Performance Overview Response Details Performance Overview Parameter Description Average Response Time Average time taken to obtain complete response of all the APIs in the sequence (in ms). Transaction Time Total time taken to complete all the transactions in the sequence (in ms). Step Response Time Total time taken to obtain response of the API in a recorded step (in ms). Page Size Total response size of the API in a recorded step (in bytes). Response Details Parameter Description REST API Sequence Step Name Name of the recorded step. Response Time taken to obtain response of the API in a recorded step (in ms). Time DNS Time Amount of time spent for resolving domain name for the request (in ms). Connection Amount of time spent for establishing TCP connection with server (in ms). TimeParameter Description First Byte Amount of time taken from when the connection to the server established until the first response Time starts coming in for the API (in ms). Download Amount of time taken for receiving last byte of the response for the API (in ms). Time Page Size Total response size of the API in a recorded step (in bytes). Displays the response of the API obtained in the recorded step. You can also monitor specific values Response by defining custom attributes in the API response. Learn more Custom attributes in API response Based on the response obtained, the user can define their own attributes for monitoring specific values in the API response. If the response is of XML type: Using the XSLT transformation, the user can define specific values to be monitored. Ensure that the following criterias are met: The output method should be of type ''text''. Syntax: The final output should be of the format AttrName::AttrVal. Example: Days: would create an attribute ''Name'' whose value will be the value of the tag present in the API Response. If the response is of JSON type: The JSON schema can be used to configure user-defined attributes. Ensure that the following criterias are met : The attribute should be defined as AttrName::AttrValue. Example: Temperature::response.weather.temperature will create an attribute name ''Temperature'' containing the value of the temperature variable returned. Multiple JSON Schemas can be defined by using new line as the delimiter. If the JSON key itself contains a dot (.), then replace it with ''_sep_''. This should be done for all the individual keys which contain a dot(.) in it. In the above example, say the last key ''temperature'' was defined as ''temperature.celsius''. Then the format should be Temperature::response.weather.temperature_sep_celsius. Brand Reputation Monitoring Overview Web Risk list is a repository maintained by Google that comprises of a list of URLs that are suspected to contain malicious code, i.e, malware, untrusted software, and social engineering tactics, such as phishing and other forms of deception. Applications Manager''s Brand Reputation monitoring helps you to continuously monitor all the URLs of your website and notifies you whether the monitored website is affected/suspected with malicious contents as per the constantly-updated Web Risk list from Google. Creating a new Brand Reputation monitor Follow the steps given below to create a new Brand Reputation monitor: Click on New Monitor link. Select Brand Reputation under Web Server/Services category. Specify the Display Name of the Brand Reputation monitor. Enter the Webpage URL for which the risk status has to be monitored. Then click on any of the following links to list the URLs that have to be added for monitoring. Discover Webpages: Discovers all the URLs that are present on the webpage specified in the Webpage URL field and lists them. You can choose the URLs to be added for monitoring. Add this Webpage: Includes the specified webpage URL to the list of URLs that are to be added for monitoring. Click on Check Connecitivity to check whether the Google''s Web Risk API is reachable from the Applications Manager server so that the monitor can perform data collection.Choose the Monitor Group with which you want to associate the Brand Reputation monitor (optional). Click Add Monitor(s). This discovers Brand Reputation monitor from the network and starts monitoring it. Note: Polling interval for Brand Reputation monitor is 24 hours by default. This cannot be customized. Brand Reputation monitor cannot be added when Applications Manager-installed servers are in locations where Google services are inaccessible. List of counties where Google services are available Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Brand Reputation under the Web Server/Services table. Displayed is the Brand Reputation monitor''s bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Note: Bulk import and REST API import of monitors is not supported for Brand Reputation monitoring. On clicking a monitor from the list, you''ll be taken to the Brand Reputation monitor dashboard, where you can view the list of monitored URLs and their current status. Following are the list of metrics that are monitored in Brand Reputation monitor: Brand Reputation Count Brand Reputation Details Overview Brand Reputation Count This section displays the number of webpages/URLs based on the type of malicious contents suspected. Parameter Description BRAND REPUTATION COUNT Malware Count Number of webpages that are suspected as Malware. Phishing/Deceptive Count Number of webpages that are suspected as Phishing/Deceptive. Unwanted Software Count Number of webpages that are suspected as Unwanted Software. Brand Reputation Details This section displays the list of all the monitored URLs and their current statuses based on the type of malicious contents suspected. Any URL that is suspected to have malware, deceptive contents, phishing attacks or an unwanted software update will be marked in red after verifying with the advisory from Google''s Web Risk list. Parameter Description BRAND REPUTATION DETAILS Display Name Display name of the webpage. Webpage URL The URL of the webpage monitored. Suspected as Malware Indicates whether the webpage is suspected to have malware contents. Suspected as Indicates whether the webpage is suspected to have phishing/deceptive Phishing/Deceptive contents. Suspected as Unwanted Indicates whether the webpage is suspected to have unwanted software Software updates. Real User Monitoring (RUM) Overview Real User Monitoring (RUM) is a type of performance monitoring technology that captures and analyzes the digital user experiences of a website or application in real-time. It gives complete visibility into the real-timeperformance of a web application and provides accurate insight into the end-user experience by recording and analyzing all user interactions. RUM provides deep insight into key performance metrics right from the initiation of the URL until the request is served back to the browser all of which helps the developers enhance the application to make it easy to use for the end users. Applications Manager''s Real User Monitoring aids you in providing a complete digital user experience monitoring solution for your web applications by obtaining real-time visibility into their performance behind-the-scene. It visualizes application interaction patterns and gives an in-depth understanding of problems that are affecting real-time users while accessing websites and applications. You also get to analyze application performance from every aspect like browser, platform, geography, ISP, etc., making it easier to identify and resolve problems/errors occurring in your application at the earliest. In this help document, you will learn how to perform complete Real User Monitoring with the help of Applications Manager''s Real User Monitor. Browse through the following topics to understand Real User Monitoring (RUM) better: How does Real User Monitoring work? Setting up Real User Monitoring Creating a new Real User Monitor RUM Dashboard How does Real User Monitoring (RUM) work? In Real User Monitoring, keeping track of all the actual user interactions of a website or an application in real-time is essential for operators to determine whether the users are being served instantaneously without any errors. To perform this, RUM includes a remote monitoring agent to be deployed into your server where the web application is hosted and takes care of collecting and reporting the data. Users need to place a small JavaScript snippet generated by Applications Manager in the header or footer part of the HTML code of the web application that needs to be tracked. Upon loading, the web application interacts with the RUM agent and transmits the performance data constantly to the RUM agent, which is then captured and presented in the Applications Manager web client. Learn how to configure Real User Monitoring in Applications Manager Setting up Real User Monitoring To configure RUM monitors, you have to download RUM agent, install it in the required location where the web applications are hosted, and then install Applications Manager server. Once the agent is enabled, it will collect performance data from the end users and transmit them to the central Applications Manager server. This data will then be processed by Applications Manager and used for measuring the digital user experience of the web applications in Real User Monitor.Browse through the following topics to learn more about configuring RUM: System Requirements Installing RUM agent Uninstalling RUM agent Creating a new Real User Monitor System Requirements RUM Agent have to be installed on a dedicated Windows / Linux machine - 16 GB RAM. RUM Agent can work with the Professional Edition and Enterprise Edition (with Managed Server) of Applications Manager. Installing RUM agent To start Real User Monitoring, you have to install the RUM agent. Please note that the RUM agent will work only if the Applications Manager server is running. Windows Linux Windows Follow the steps given below to install the RUM agent in Windows systems: Download the RUM Agent (.exe) file for Windows. Execute the downloaded file. The installshield wizard will open up. Click Next to continue. Read the license agreement and click the Next button. Specify the details of your Applications Manager instance such as Hostname, SSL port, and RUM API Key (which is available under Admin → REST API → Real User Monitor). Click Next to proceed. Provide the location where the RUM Agent should be installed in your machine and click Next. Click Browse if you want to provide a different location of installation. Specify the name of the folder to be placed in Programs folder and click Next. Default name and location is ManageEngine\RUMAgent. If you want to install RUM Agent as a service, select the Install Real User Monitoring Agent as Service option and click Next. Please note that you need to have administrative privileges to install the RUM agent as a service. Click Finish to complete the installation process. Now open command terminal from the newly-installed RUM Agent Home directory. (Eg: C:\Program File\ManageEngine\RUMAgent) Run the StartServer.bat command in the terminal to start the RUM Agent. Finally, check whether the RUM Agent is started or not by acccessing the following URL from the browser: :// : where, - Encryption protocol to establish connection with RUM Agent. (http or https) - Hostname of the machine where RUM Agent is installed. - Port in which the RUM Agent is running. Default port is 8080. To change RUM agent default port, refer here. Note: In case you want to change Application Manager instance details in RUM Agent after installation, refer here. Linux Follow the steps given below to install the RUM agent in Linux systems: Download the RUM Agent (.bin) file for Linux. Execute the downloaded file. The installshield wizard will open up. Click Next to continue. Read the license agreement and click the Next button. Specify the details of your Applications Manager instance such as Hostname, SSL port, and RUM API Key (which is available under Admin → REST API → Real User Monitor). Click Next to proceed. Provide the location where the RUM Agent should be installed in your machine and click Next. Click Browse if you want to provide a different location of installation. Click Finish to complete the installation process.Now open terminal from the newly-installed RUM Agent Home directory. (Eg: /home/test/ManageEngine/RUMAgent) Run the sh StartServer.sh command in the terminal to start the RUM Agent. Finally, check whether the RUM Agent is started or not by acccessing the following URL from the browser: :// : where, - Encryption protocol to establish connection with RUM Agent. (http or https) - Hostname of the machine where RUM Agent is installed. - Port in which the RUM Agent is running. Default port is 8080. To change RUM agent default port, refer here. Note: In case you want to change Application Manager instance details in RUM Agent after installation, refer here. Note: End users accessing the website monitored in Applications Manager should have access to RUM Agent. RUM Agent should be available on the internet and should be able to communicate with Applications Manager. For RUM agent v1, whenever new RUM monitor is added or existing RUM monitor is updated in Applications Manager, RUM Agent should be restarted ie. Stop RUM Agent and execute the StartServer.bat or StartServer.sh again in terminal from directory. Any configuration change in RUM Agent also requires a RUM agent restart. Uninstalling RUM agent Windows Linux Note: Before uninstalling, exit out of the command prompt and close all the files and folders opened in the directory. If the RUM agent is running, you should stop the agent before uninstalling it to remove all files completely. Windows If the RUM agent is running, you should stop the agent before uninstalling it. You can stop the agent by executing the StopServer.bat -force command from command prompt. Open Control Panel → Uninstall Program → right click on Applications Manager - RUM Agent → Click Uninstall. Then follow the instructions shown on screen to uninstall the agent. Linux If the RUM agent is running, you should stop the agent before uninstalling it. You can stop the agent by executing the sh StopServer.sh -force command from command terminal. Open terminal from /_Applications Manager - RUM Agent_installation directory and execute "./Change\ Applications\ Manager\ -\ RUM\ Agent\ Installation" and follow the process. Creating a new Real User Monitor Follow the steps given below to create a new Real User Monitor: Click on Add New Monitor link under New Monitor. Select Real User Monitor under Web Server/Services category. Enter the display name of the web application. Enter the Website URL to be monitored. Enter the Apdex Threshold response time (in milliseconds) used for calculating Apdex score and determining user experience. Select the Application Framework Type of the web application to be monitored. (Traditional or Single Page Application) Enable the Track Ajax calls checkbox to monitor the performance of Ajax calls.Enable the Track cross-domain Ajax calls checkbox to monitor the performance of Ajax calls to domains other than parent domain (external domains). Enter the domain names wherein you do not want to track or monitor your website''s performance under Domains to exclude. You can add multiple domains, if required. (Eg: zoho.com) Specify the User agents to exclude by entering the Browser name, OS or the complete string mentioned in the following format: Examples: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36 Enable the Track Resource Performance checkbox to capture individual resources and group them as first party, third party and CDN resources. By default, Applications Manager does not capture website resources. Enable the Affect monitor availability in idle state checkbox for the monitor availability to be affected when the monitor has not polled data for more than the idle time value specified in the option Real User Monitor allowed idle time under Admin → Availability Settings. Choose the Monitor Group from the combo box with which you want to associate Real User Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). A script code will be generated in the Monitor Dashboard page under Copy Script tab. Copy and paste the script code to the header or footer of the index page or a common page of your application or website which you would like to monitor. In the copied script, (http or https), then replace the and with RUM agent''s host and port. :// : /RUMScript.js? appKey='',''apmr'',''oY3zeVg61GSpN0TMKaeRxyLfub2Ih9sG10000234) Save the changes and start/restart the RUM agent. The RUM monitor you added will appear on the main RUM dashboard and data collection will begin when the website is accessed. Learn more about the metrics shown in RUM monitor dashboard Note: For users with RUM Agent v1, a restart of the agent will be required in the following cases: Any change in Application Framework Type, Track Ajax calls, Track cross-domain Ajax calls, Domains to exclude, User agents to exclude, and Track resource performance values. Whenever RUM monitor is added or updated in Applications Manager. RUM Dashboard Applications Manager''s RUM dashboards help you understand your user interactions in your web applications at a single glance. You can obtain a holistic view about the status of your RUM applications using our customizable dashboard. RUM dashboard lists all your active, inactive applications along with the ones that are in Critical, Warning or Clear state. Details of every aspect of your web applications can be assessed using various tabs in the page. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Real User Monitor under the Web Server/Services table. Displayed is the Real User Monitor bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Following are the list of metrics shown in the Real User Monitor in their corresponding tabs: Summary Geographic ISP BrowserDevice Type Web Pages User Sessions Resources Ajax Calls Errors Note: Real User Monitor does not show ISP details by default. A third-party geolocation API needs to be purchased and configured in RUM agent to obtain ISP data. Learn more Summary Parameter Description Summary Report - World View - Displays a graphical representation of application response time, apdex score, page views and errors globally in real time. Apdex is a measure of response time against a set threshold. It measures the ratio of satisfactory response times to unsatisfactory response times. The Apdex Score is calculated using the following formula: Apdex Score Avg. The average response time is defined as the time between issuing a web page request to the Response system until the page is visible to the user (in ms). Time Page Views Number of times the users have visited the web page. Throughput The number of requests served per minute for the chosen time frame (in cpm). Errors Total number of errors occurred in the webpage. Response Time Redirection The measurement of how long it takes the site to redirect from one URL to another before the page Time is fetched. DNS Time The time taken to resolve the URL domain name to the IP address. Server Connection Time is the interval between the time that a user initiates a request and the start Connection of fetching the response document from the server. This includes time spent on redirects, domain Time lookups, TCP connects and SSL handshakes. Server The server request processing time. Time Frontend The front-end network time is the time span that is consumed for sending data from/to the front end Time Document Download The time for the browser to download the complete HTML document content. Time Page The total time between opening a page (opening a new URL, clicking a link, opening a new Rendering workflow or refreshing a page) and the availability of a page on the browser. Time Document Rendering The time for the browser to build the Document Object Model (DOM). Time Overall The total response time is defined as the time between issuing a web page request to the system Response until the page is visible to the user (or the time taken for an application to complete an activity) Time Geographic Parameter Description Summary Report - World View - Displays a graphical representation of application response time, apdex score, page views and errors globally in real time.Geographic Summary Location Location of the End User/Client. Apdex is a measure of response time against a set threshold. It measures the ratio of satisfactory Apdex Score response times to unsatisfactory response times. Avg. Response Average time taken by the application to respond to the request from the location (in ms). Time Page Views Number of times the users have visited the web page from the location. Throughput The number of requests served per minute for the chosen time frame (in cpm). Click on the location name to view the graphical representation of the response time and the throughput for that location. ISP Parameter Description Response Time By ISP - Displays a graphical representation of the list of ISPs with respect to their response times. ISP Summary ISP Name The name of the Internet service provider. Avg. Response Time Average time taken by the application to respond to the request from the ISP (in ms). Total Count Number of times users have visited the web page from the ISP. Throughput The number of requests served per minute for the chosen time frame (in cpm). Browser Parameter Description Response Time By Browser - Displays a graphical representation of the list of browsers with respect to their response times. Browser Usage Split Up - Displays a graphical representation of the list of browsers with respect to their usage. Browser Summary Browser Name The name of the browser. Avg. Response Time Average time taken by the application to respond to the request from the browser (in ms). Total Count Number of times users have visited the web page from the browser. Throughput The number of requests served per minute for the chosen time frame (in cpm). Click on the browser name to view the graphical representation of the response time and the throughput for that browser along with its version details. Device Type Parameter Description Response time by Device - Displays a graphical representation of the list of devices with respect to their response times. Device Usage Split Up - Displays a graphical representation of the list of devices with respect to their usage. Top Viewport Visual area of the webpage on a browser. Connection Type Type of connection used to establish connection with the server. Device Memory Amount of memory present in the device (in GiB). Device Summary Device Name The name of the device. Avg. Response Time Average time taken by the application to respond to the request from the device (in ms). Total Count Number of times users have visited the web page from the device. Throughput The number of requests served per minute for the chosen time frame (in cpm).Click on the device name to view the graphical representation of the response time and the throughput for that device. Web Pages Parameter Description Web Transactions Transaction Name The name of the transaction. Avg. Response Time Average time taken by the application to respond to the request (in ms). Total Count Number of times users have visited the web page. Throughput The number of requests served per minute for the chosen time frame (in cpm). Avg. Page Size Average size of the webpage (in kB). Click on the transaction name to view the summary of the key performance metrics (like Apdex score, Response Time, Page Views, and Throughput) for that transaction along with the details of their corresponding Ajax calls. User Sessions Parameter Description Avg. Pages Navigated Average number of pages that were navigated during the session. Avg. Viewing Time Average amount of time for which the pages were viewed during the session (in ms). Total Users Total number of unique users visited the web page. Total Sessions Total number of sessions that are established. User Sessions Start Time Timestamp at which the session was started. User Name Name of the user establishing the session. Browser Name Name of the browser from which the session was established. Device Name Name of the device from which the session was established. Country Name of the country from which the session was established. Pages Navigated Number of pages that were navigated during the session. Viewing Time Amount of time for which the pages were viewed during the session (in ms). Click on the session to view the summary of the session details (such as User Name, Start Time, and User Experience Status) and the list of transactions present in that session along with their corresponding response time split-ups. Resources Parameter Description First Party / Third Party / CDN Resources Domain Name Name of the domain for which the request has been sent. Avg. Resource Size Average size of the resource (in kB). Avg. Response Time Average time taken for the domain to respond (in ms). Total Count Total number of resources present in that domain. Click on the arrow adjacent to the domain name to view the graphical representation of the response times and the total count for the different types of resources available in that domain. Ajax Calls Parameter Description Ajax Calls Transaction Name Name of the transaction. Avg. Response Time Average time taken by the application to respond to the request (in ms). Total Count Number of times users have visited the web page.Throughput The number of requests served per minute for the chosen time frame (in cpm). Avg. Resource Size Average size of the resource (in kB). 1xx Number of Information responses. 2xx Number of Successful responses. 3xx Number of Redirection messages. 4xx Number of Client Error responses. 5xx Number of Server Error responses. Click on the transaction name to view the summary of the key performance metrics (like Apdex score, Response Time, Page Views, and Throughput) for that Ajax transaction. JavaScript Errors Parameter Description Errors vs Affected Users Graph - Displays a graphical representation of users and the corresponding errors with respect to their total counts. JavaScript Errors Displays complete details about type of JavaScript errors, the URL location of the error and the Errors timestamp of its last occurance along with their count. Type Displays the list of error types occurred along with their error count. File Displays the list of files in which the error has occurred along with their error count. Page Displays the list of pages in which the error has occurred along with their error count. Browser Displays the list of browsers in which the error has occurred along with their error count. User Displays the list of affected users for which the error has occurred along with their error count. Domains Displays the list of domains in which the error has occurred along with their error count. Click on the JavaScript Errors to get details about the error like the list of files, pages, browsers, devices, and users where the error exists, along with their corresponding timestamps. Real User Monitoring (RUM) Agent - Release Notes RUM Agent v2 Release Date: 28-03-2022 Enhancements Support for installing RUM agent as a service in Windows.   Release Date: 24-03-2022 Enhancements Support for unmanage and schedule maintenance in Real User Monitor. RUM Agent v1 Release Date: 04-03-2022 Issues fixed Log 4j files are removed.   Release Date: 26-10-2021Details Baseline release of RUM Agent to support Real User Monitoring. Services Monitoring Applications Manager supports monitoring of the following Services to check their status: JMX Applications Ping Monitor / Ping Monitor (EUM) Service Monitoring SNMP Telnet / Telnet (EUM) UDP Port Active Directory DNS Monitor FTP/SFTP Monitor LDAP Monitor Ceph Storage Monitor Hadoop Monitor Oracle Coherence Monitor Apache Zookeeper Apache Spark Network Policy Server (Radius Server) Hazelcast Istio Service Monitoring (TCP Ports) JMX Applications Prerequisites for monitoring JMX Application metrics: Refer to the Prerequisites Section for configuration details. Using the REST API to add a new JMX Applications monitor: Click here To create a MX4J RMI Connector monitor, follow the given steps: Click on New Monitor link. Choose JMX Applications. Enter the IP Address or hostname of the host in which the Monitor is running. Enter the SubNetMask of the network. Provide the port number in which RMI Adapter is running. Also, you can provide multiple ports separated by commas. You can enter your own credential details or select preconfigured credentials details in Credentials Manager. If you wish to enter your own credentials, specify username and password details for this monitor. Enter the JNDI name. For example, /jmxconnector. To enable customized JMX URL, check the Enable JMX URL checkbox and enter the JMX URL. ( The URL should be of the format service:jmx:rmi:///jndi/rmi://HOST:PORT/jmxrmi. For example, a jboss customized jmx URL can be - service:jmx:remoting-jmx://HOST:PORT and a websphere customized jmx URL - service:jmx:wsrmi://HOST:PORT/) If Authentication is enabled, enter the Username and password. Enter thepolling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitor from the network and starts monitoring them. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] JMXApplications Connects to the MX4J-JMX agent to check availability and response time of RMI Connector. You can also view the custom attributes of the MX4J-JMX agent in the same page. Further, alarms can be generated for JMX notifications through JMX Notification Listener. For information on adding Custom Monitors, refer to Custom Monitors topic. Ping Monitor / Ping Monitor (EUM) To create a Ping monitor, follow the steps given below: Click on New Monitor link. Choose Ping Monitor / Ping Monitor (EUM) under ''Services'' category. Provide Host Name / IP Address. Enter the Timeout value for the monitor in seconds. Specify the Polling Interval for the monitor in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Select the Monitor Group with which you want to associate the monitor to, from the combo box (optional). You can choose multiple groups to associate your monitor. Associate the monitor instance to the agent. * Enable Run on Server option to run the ping monitor in the local instance of Applications Manager. Enable Run on Agent option to run the ping monitor from multiple locations. Select the necessary agents from where you want this monitor to be executed. This option will be available only if you enable the EUM add-on. Click Add Monitor(s). This adds the ping monitor and the monitoring will be started as per the polling interval configured. Note: * This is only for Ping Monitor (EUM) servers.  In some cases, Applications Manager may not provide the expected metrics output due to incorrect responses for non-English OS. To get the expected output, regex support is available for Ping Monitor. The user needs to customize the output in a property file based on the language. The user can define ping response for metrics like Packet Stats and Round Trip Time for different languages. Create a properties files called ping.properties and place it under AppManager/conf directrory (or under the EUMAgent/conf in case of Agent based Ping monitor). The user can understand the response pattern of the ping request and he can customize it by using the same patterns as in the properties file. This is a sample Italian ping.properties file: ################################ Windows properties ##################################### #Windows Status poll matcher String. ReplyFrom=Risposta da bytes=byte #Windows ResponseTime String. Ex: Minimum or Maximum or Average. Windows_ResponseTime=Medio #Windows Packet Sent matcher String. Windows_PacketSent=Trasmessi #Windows Packet Received matcher String. Windows_PacketReceived=Ricevuti #Windows Packet Loss matcher String(case sensitive). Windows_PacketLoss=persi   Ping Applications Manager uses Ping Monitor to track if the particular host / IP address is accessible or Monitor not. It checks for availability of a device, server or network device The parameters that are monitored are Packet Statistics: Packet Loss (%): Packet loss gives the percentage of packets that fail to reach the destination. Packets Sent: No. of Packets sent.Packet Received: No. of Packets received. Round Trip Time: Time taken for each packet exchange. Ping places a timestamp in each packet, which is echoed back and is used to compute how long each packet exchange took Service Monitoring To create a Service Monitoring Monitor, follow the steps given below: Click on New Monitor link. Choose Service Monitoring. Enter the IP Address or hostname in which the Monitor is running. Enter the SubNetMask of the network. Enter the port number in which the service you want to monitor is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Enter the command that will be executed after connecting to the port mentioned above. For example, if the port added is where your web server is running , then you can give the command as GET / HTTP1.0 . This will get the index page of the web server. Enter the string that has to be searched after executing  the command. Choose the Monitor Group from the combo box with which you want to associate Service Monitoring Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Service and starts monitoring them. Monitors different services running in particular/default ports such as FTP-21, Telnet-23 etc running in the network. Service Connects to the server configured for monitoring. Monitoring Checks availability and the response time of the service. Here, the response time is the time taken to connect to the port, execute the given command and search the string. SNMP To create a SNMP Monitor, follow the steps given below: From the Admin tab, select New Monitor from the Discovery and Data Collection panel. Choose the ''SNMP/Network Device'' option from ''Add Monitor of type'' drop down list. Enter the Display Name & IP Address/hostname of the system where the monitor is running. Enter the SubNetMask of the network. In case of multiple system IP addresses configured with single DNS name , then select the check-box in the Advanced option. Enter the polling intervall time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Enter the timeout value in seconds. Provide the port number in which SNMP service is running in the host (default port number is 161). Choose SNMP version V1/V2c or V3. To associate Monitor Instance to Monitor Group you select a monitor group from the default list or make a new monitor group by clicking "Create New Monitor Group". For SNMP Version V1/V2c: Enter the Community String (''public'' by default). To test the validity of the credentials entered for a particular host name click on ''Test Credentials''. For SNMP Version V3: Select one of the three Security Levels in the drop-down list: NoAuthNoPriv - Messages can be sent unauthenticated and unencrypted. Enter a UserName and Context Name. AuthNoPriv - Messages can be sent authenticated but unencrypted. Enter a UserName, Context Name and an Authentication Password. You can select an Authentication Protocol like MD5 or SHA from the drop-down list. AuthPriv - Messages can be sent authenticated and encrypted. Enter a UserName, Context Name,an Authentication Password and a Privacy Password. You can select an Authentication Protocol like MD5 or SHA from the drop-down list. By default ''DES'' encryption technique will be used. Note: SMUX (tcp 199 port) is the snmp multiplexing protocol (RFC 1227). It can be used by an snmp agent to query variables maintained by another user-level process. For monitoring user-processes like kernel relateddetails using the SNMP agent, you must install SMUX and register the mibs. If SMUX is implemented, by default, tcp port 199 should be open for connection. Connects to SNMP agent running in an application and monitors the availability and performance of SNMP the service. You can also view the custom attributes of the SNMP agent in the same page. For information on adding Custom Monitors, refer to Custom Monitors topic. Telnet / Telnet (EUM) Using the REST API to add a new Telnet monitor: Click here To create a Telnet monitor, follow the steps given below: Click on Add New Monitor link under New Monitor. Choose Telnet / Telnet (EUM) under Services category. Enter the display name for the monitor. Enter the IP Address or hostname of the host in which the monitor is running. Provide the port number in which the monitor is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate Telnet monitor (optional). You can choose multiple groups to associate your monitor. Associate the monitor instance to the agent. Enable Run on Server option to run the Telnet monitor in the local instance of Applications Manager. Enable Run on Agent option to run the Telnet monitor from multiple locations. Select the necessary agents from where you want this monitor to be executed. This option will be available only if you enable the EUM add-on. Click Add Monitor(s). This discovers the Telnet from the network and starts monitoring them. Connects to Telnet port (default: 23) and checks its availability. Telnet Monitors response time and updates the status based on a given threshold. UDP Port Using the REST API to add a new UDP Port monitor: Click here To create a UDP Port monitor, follow the steps given below: Click on Add New Monitor link under New Monitor. Select UDP Port under Services category. Specify the display name for the monitor. Specify the IP Address or hostname of the host in which the application service is running. Specify the UDP Port number in which the service is running. Specify the Wait Time/Timeout in seconds. Specify the Command to be executed after connecting to the service through the UDP Port given. Note: Only text format command type is supported. Specify the Match Content/String to be searched in the response after executing the command. Ensure that the content you try to match is present in the response. Specify the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate the UDP Port monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This will add the UDP Port monitor and the monitoring will start based on the polling interval configured. UDP Port UDP Port Monitor tracks the availability of services running on the UDP Port and its response time. FTP/SFTP Monitor To create an FTP/SFTP Monitor, follow the given steps: Click on New Monitor link. Choose FTP/SFTP under Services. Enter the Display Name for the Monitor. Enter the Target Address to connect FTP/SFTP.If Authentication is enabled, enter the Username and Password. Enter Port No. (Default port number for FTP is 21 and 22 for SFTP) Enter Time Out value. Select the option YES or NO to indicate whether FTP is secure or not. If you would like to monitor the downloads (mget) through FTP/SFTP while simulateneously downloading the file, select the option YES else select NO. If the above option is YES, then enter the Remote Src. FileName (Remote Source FileName) located in the target address. Enter the Local Dest. FileName (Local Desitnation FileName) with full path. The file will download in the given path where the Applications Manager is running. If you would like to upload a file to target address, Select Upload File option as YES else select NO. If YES, enter the Local Src. FileName (Local Source FileName) with full path. The file must be available where the Applications Manager is running. Enter the Remote Dest. FileName (Remote Destination FileName) with full path where the file will be downloaded in the target address. Provide the Polling interval for monitoring the FTP/SFTP montior. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitor from the network and starts monitoring them. Monitors the availability and performance of FTP/SFTP monitor. In addition, it monitors Connection Time, Login Time, File Transfer, File Transfer Speed, Full Transaction and Files & Directories located in the Home Directory. Connection Time: Time taken by Applications Manager to connect to FTP server. Login Time: Time taken by Applications Manager to login to FTP server. FTP/SFTP File Transfer: It is the time taken for a file to either upload (mput) or download (mget) to a FTP server. Monitor In addition, the file size is also monitored while being uploaded or downloaded. File Transfer Speed: It is the time taken by a particular file transfered to (mput) or from (mget) a FTP server. Full Transaction: This provides the number of uploads/downloads that was completed correctly. Files & Directory (Home Directory): This provides the number of files and directories that were present in the FTP server. LDAP Monitor To create an LDAP Monitor, follow the given steps: Click on New Monitor link. Choose LDAP under Services. Enter the Display Name for the monitor. Enter the LDAP Server and LDAP Server Port of the server wherein the services are running. If Authentication is enabled, enter the Username and Password. If no username and password is provided, then it will connect to LDAP server as anonymous login. Enter the Searchbase value. Enter the Searchfilter value. Select the Matching Attribute from the pull down menu. Select the Filter Condition from the pull down menu. Enter the Search Result string value which will match with search results. Enter the Timeout period which will be used to establish connection with the LDAP server. Click YES or NO option to check if the connection is secured. If YES (to enable SSL mode), then import the certificate of LDAP server into Applications Manager. Please follow the steps (given below) provided to import the LDAP certificate into Applications Manager Truststore.truststore. Once the procedure is complete, restart Applications Manager. Provide the Polling interval for monitoring the LDAP montior. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitor from the network and starts monitoring them. Note: To import certificate into Applications Manager, execute the following command: /working/jre/bin/keytool -import -keystore /working/conf/Truststore.truststore -storepass appmanager -trustcacerts -alias -file - Applications Manager installed home directory - Provide an alias name for the LDAP certificate - Provide absolute path to the LDAP certificate appmanager - This is the password for the LDAP certificate. Ensure that you do not change the password.. LDAP Monitor monitors the availability and performance of LDAP server. It monitors the Login Time attribute - the time taken for a user to log in to the LDAP server. In addition, it also monitors Search Details and Search Results Details. The ''Search Details'' section displays the time taken for a search to execute and the total response time. The total response timeis the login time plus the time taken for a search in the LDAP server. The ''Search Results Details'' displays the search result row count which displays the total rows returned after a search was executed and the search result matching details which displays whether it was a success or a failure. Active Directory Prerequisites for monitoring Active Directory metrics: Click here Using the REST API to add a new Active Directory monitor: Click here To create a new Active Directory monitor, follow the steps given below: Click on New Monitor link. Choose Active Directory under Services . Enter the DisplayName of the host in which the Monitor is running. Enter the HostName on which the monitor is running. Enable the Use CredSSP Authentication option only when the monitored AD Server is a non-primary Domain Controller and is present in a different domain other than that of the Applications Manager server domain. CredSSP delegates the users credentials from one computer to another remote computer. Click here for the steps to enable CredSSP If Authentication is enabled, enter the Username and Password. Select the Enable Kerberos Authentication checkbox if you want to monitor Active Directory server through Kerberos authentication. Provide the Timeout period for running the datacollection scripts. By default, it is 300 seconds. Provide the Polling interval for monitoring the Active Directory montior. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitor from the network and starts monitoring them. Note: Kindly ensure that for User accounts, relevant privileges must be provided before creating Active Directory monitor. If you have added Monitors and not associated them with a Monitor Group, you can do this manually anytime. For information on associating a Monitor with a Monitor Group, refer to Associating Monitor with Monitor Groups topic. Active Directory Monitor  connects to the Active Directory server and checks its availability. Active Directory Counters that are monitored by Applications Manager are given below: Performance Overview Replication Statistics Connectivity Diagnostic Tests Performance Overview Parameters Description Time Synchronization * Primary DC Name of the Primary Domain Controller in the domain. Time Offset from Primary DC Offset time from the Primary Domain Controller. Network Monitors AB Client Sessions AB Client Sessions is the number of connected Address Book client sessions. The number of pending update notifications that have been queued, but not DS Notify Queue Size yet transmitted to clients Database Monitors Shows the total usable space on the selected logical disk drive that was free Database Disk Free Space (in MB).Database File Size Shows the Database File Size (in MB). Database Disk Total Size Shows the Total Size of the disk drive (in MB). NTFRS Process Monitors Percentage of elapsed time that all of the threads of NTFRS process used the processor to execute instructions. An instruction is the basic unit of execution NTFRS CPU Usage in a computer, a thread is the object that executes instructions, and a process is the object created when a program is run. Code executed to handle some hardware interrupts and trap conditions is included in this count. Total number of handles the NTFRS process has open. This number is the sum NTFRS Handle Count of the handles currently open by each thread in the process. Rate at which the NTFRS process is reading bytes from I/O operations. This NTFRS Process File Reads property counts all I/O activity generated by the NTFRS process to include file, network, and device I/Os. Rate at which the NTFRS process is writing bytes to I/O operations. This NTFRS Process File Writes property counts all I/O activity generated by the NTFRS process to include file, network, and device I/Os Amount of memory in bytes that a NTFRS process needs to execute efficiently —for an operating system that uses page-based memory management. If the NTFRS Process Memory system does not have enough memory (less than the working set size), thrashing occurs. If the size of the working set is not known, use NULL or 0 (zero). DFSR Process Monitors Percentage of elapsed time that all of the threads of DFSR process used the processor to execute instructions. An instruction is the basic unit of execution DFSR CPU Usage in a computer, a thread is the object that executes instructions, and a process is the object created when a program is run. Code executed to handle some hardware interrupts and trap conditions is included in this count. Total number of handles the DFSR process has open. This number is the sum DFSR Handle Count of the handles currently open by each thread in the process. Rate at which the DRSR process is reading bytes from I/O operations. This DFSR Process File Reads property counts all I/O activity generated by the DRSR process to include file, network, and device I/Os. Rate at which the DFSR process is writing bytes to I/O operations. This DFSR Process File Writes property counts all I/O activity generated by the DFSR process to include file, network, and device I/Os. Amount of memory in bytes that a DFSR process needs to execute efficiently— for an operating system that uses page-based memory management. If the DFSR Process Memory system does not have enough memory (less than the working set size), thrashing occurs. If the size of the working set is not known, use NULL or 0. System Monitors Percentage of time that the processor is executing a non-idle thread. This property was designed as a primary indicator of processor activity. It is CPU Utilization calculated by measuring the time that the processor spends executing the thread of the idle process in each sample interval and subtracting that value from 100%. It is calculted as follows ((size-freesize)/size)*100 where Disk Utilization size - It is the total Size of the disk drive on Logical Disk freesize - Space, in bytes, available on the logical disk Memory Utilization It is calculated as follows ((TotalVisibleMemorySize- FreePhysicalMemory)/TotalVisibleMemorySize)*100 where TotalVisibleMemorySize - Total amount, in kilobytes, of physical memory available to the operating system. This value does not necessarily indicate the true amount of physical memory, but what is reported to the operating system as available to it.FreePhysicalMemory - Number, in kilobytes, of physical memory currently unused and available. Number of process contexts currently loaded or running on the operating Number of Processes system. Number of threads in the processor queue. There is a single queue for OS Processor Queue Length processor time even on computers with multiple processors. Unlike the disk counters, this property counts ready threads only, not threads that are running. Performance Counter Monitors Shows the number of Ntdsapi.dll binds per second serviced by this domain DS Client Binds controller. Shows the number of domain controller–to–domain controller binds per DS Server Binds Per Sec second that are serviced by this domain controller. Directory Reads Per Sec Shows the number of directory reads per second. Directory Writes Per Sec Shows the number of directory writes per second. Shows the number of NTLM authentications per second serviced by this NTLM Authentications domain controller. Shows the number of times per second that clients use a ticket to this domain Kerberos Authentications controller to authenticate to this domain controller. LSASS Process Monitors Percentage of elapsed time that all of the threads of LSASS process used the processor to execute instructions. An instruction is the basic unit of execution LSASS CPU Usage in a computer, a thread is the object that executes instructions, and a process is the object created when a program is run. Code executed to handle some hardware interrupts and trap conditions is included in this count. Total number of handles the LSASS process has open. This number is the sum LSASS Handle Count of the handles currently open by each thread in the LSASS process. Rate at which the LSASS process is reading bytes from I/O operations. This LSASS Process File Reads property counts all I/O activity generated by the LSASS process to include file, network, and device I/Os. Rate at which the LSASS process is writing bytes to I/O operations. This LSASS Process File Writes property counts all I/O activity generated by the LSASS process to include file, network, and device I/Os Amount of memory in bytes that a LSASS process needs to execute efficiently —for an operating system that uses page-based memory management. If the LSASS Process Memory system does not have enough memory (less than the working set size), thrashing occurs. If the size of the working set is not known, use NULL or 0 (zero). LDAP Stats Shows the current number of threads in use by the LDAP subsystem of the LDAP Active Threads local directory service. LDAP Bind Time Shows the time, in milliseconds, taken for the last successful LDAP bind. LDAP Client Sessions Shows the number of currently connected LDAP client sessions LDAP Searches Per Sec Shows the rate at which LDAP clients perform search operations Shows the number of User Datagram Protocol (UDP) operations that the LDAP LDAP UDP operations Per Sec server is processing per second. LDAP Writes Per Sec Shows the rate at which LDAP clients perform write operations. Replication Stats Shows the rate at which replication updates received from replication Replication Objects Applied Per partners are applied by the local directory service. This counter excludes Sec changes that are received but not applied Shows the number of object updates received in the current directory Replication Objects Remaining replication update packet that have not yet been applied to the local server. Shows the number of objects received from neighbors through inbound Total Replication Objects In replication. A neighbor is a domain controller from which the local domain /Sec controller replicates locally. Total Replication Objects Out Shows the number of objects replicated out. /SecShows the total number of bytes replicated in. This counter is the sum of the Replication Traffic In number of uncompressed bytes (never compressed) and the number of compressed bytes (after compression). Shows the total number of bytes replicated out. This counter is the sum of the Replication Traffic Out number of uncompressed bytes (never compressed) and the number of compressed bytes (after compression) Active Directory Services The Kerberos Key Distribution Center (KDC) is a network service that supplies Kerberos Key Distribution Center session tickets and temporary session keys to users and computers within an Service Active Directory domain. The KDC runs on each domain controller as part of Active Directory Domain Services (AD DS). . This service enables the computer to connect to other computers on the Server Service network based on the SMB protocol This service supports pass-through authentication of account logon events for Net Logon Service computers in a domain This service enables the computer to connect to other computers on the Workstation Service network based on the SMB protocol. Remote Procedure Call (RPC) This service provides the name services for RPC clients. Service Security Accounts Manager This service signals other services that the Security Accounts Manager Service subsystem is ready to accept requests. This service maintains file synchronization of file directory contents among File Replication Service multiple servers DNS Client Service This service resolves and caches (Domain Name Server) DNS names. This service is used for mail-based replication between sites. Active Directory Intersite Messaging Service includes support for replication between sites by using SMTP over IP transport. The service synchronizes the time between domain controllers, which Windows Time service prevents time skews from occurring. Active Directory Domain Service of the Active Directory Domain Controller. Services Service that provides Web Service interface to instances of the directory Active Directory Web Services service (AD DS and AD LDS) that are running locally on the server. * Time Synchronization data is available only if the monitored AD server is a Secondary Domain Controller. These metrics are mapped under Admin → Performance Polling Replication Statistics Replication is the process of sending update information for data that has changed in the directory to other domain controllers. It is important to have a firm understanding of replication and how it takes place, both within the domain and in multiple-site environments. Monitoring for Active Directory Replication - If there are two or more domain controllers,that are replicating changes to each other, the replication statistics information will be displayed in the Replication Statistics tab. In a Single-Domain-controller setup,no replication stats will be shown. Parameters Description Domain Controller Domain Controller Site The Site that the host domain controller resides in. Provides a value of true / false. True,if the domain controller is a global catalog Is Global Catalog Server server. Percent of RIDs Left The percentage of Relative Identifiers left in RID Pool. Pending Replication Operations The count of Pending Replication Operations. Replication Partners Partition Name DN of the Naming Context(Partition) for which the partners replicate. CN of directory system agent (DSA) that represents the source domain Source DC  controller (DC).Source DC Domain The canonical name of the domain of the replicated NC. Source DC Site The site that contains the source DC. Time of Last Sync Attempt The timestamp for the last replication attempt. Time of Last Sync Success The timestamp for the last successful replication attempt. Consecutive Failure Count The number of consecutive failed replication attempts. Last Sync Result Values can be Success or Failed. Pending Replications The X.500 path of the naming context (NC) that is associated with this Partition Name operation. CN of directory system agent (DSA) that represents the source domain Source DC controller (DC). Time Enqueued The time at which this operation was added to the queue. Operation Start Time The time when the operation was started.NULL if operation is still in Queue. Position in Queue The position of this operation in the queue. Connectivity Parameters Description Port Connectivity * Port Name The name of the port monitored. Port Number The port number specified for that port. Connectivity Status Specifies if the connection is UP / DOWN. Response Time(ms) The time taken to check the connectivity status in milliseconds. Network Interface Name The display name of the network connector Speed (MBps) The interface''s current bandwidth in megabits per second (MBps). Input Traffic (MBps) The rate at which bytes are received on the interface, including framing characters. Output Traffic (MBps) The rate at which bytes are sent on the interface, including framing characters. * Metrics for Port Connectivity are mapped under Admin → Performance Polling Follow these steps to add, remove or edit the ports monitored: Go to \working\conf\application\script\powershell folder and open ActiveDirectoryPorts.ps1 file in an editor. To add new port to be monitored, add the port name and port number in the below format along with the other ports: " : "  Example: "DNS:53" To remove any ports which are monitored, comment the respective line by using ''#'' in the beginning of the line. Example: # "DNS:53" If any ports have been changed from the default port number in the server, please edit the respective port numbers. Save the file after the changes are done. Changes will be effective from the next poll in the monitor. Diagnostic Tests * Basic Tests Connectivity Check - Tests whether DSAs(Directory System Agent) are DNS registered, pingeable, and have LDAP/RPCAdvertising Status Check - Checks whether each DSA is advertising itself, and whether it is advertising itself as having the capabilities of a DSA. SYSVOL Status Check - This test checks that the SYSVOL is ready. Knowledge Consistency Check - This test checks that the Knowledge Consistency Checker is completing without errors. RID Master Accessibility Check - Check to see if RID master is accessable and to see if it contains the proper information. Machine Account Information Check - Check to see if the Machine Account has the proper information. Global Role-holders Locator Check - Checks that global role-holders are known, can be located, and are responding. Replication Tests File Replication System Check - This test checks to see if there are any operation errors in the file replication system (FRS). Failing replication of the SYSVOL share, can cause Policy problems. Distributed File System Check - This test checks to see if there are any operation errors in the DFS(Distributed File System). Logon Priviledges (NetLogons) Check - Checks that the appropriate logon priviledges allow replication to proceed. Object Replication Check - Check that Machine Account (AD only) and DSA objects have replicated. Verify References for FRS and Replication Infrastructure - This test verifies that certain system references are intact for the FRS and Replication infrastructure. Intersite Replication Error Check - Checks for failures that would prevent or temporarily hold up intersite replication. Cross Reference Check Tests CrossRefValidation - This test looks for cross-refs that are in some way invalid. DomainDnsZones CrossRefValidation ForestDnsZones CrossRefValidation Configuration CrossRefValidation Schema CrossRefValidation CrossRefValidation Security Descriptor Reference Check Tests CheckSDRefDom - This test checks that all application directory partitions have appropriate security descriptor reference domains. DomainDnsZones CheckSDRefDom ForestDnsZones CheckSDRefDom Configuration CheckSDRefDom Schema CheckSDRefDom CheckSDRefDom * Metrics for Diagnostic Tests are mapped under Admin → Performance Polling Service Monitoring Creating a new monitor Using the REST API to add a new monitor: Click here To create a new Service monitor, follow the steps given below: Click on New Monitor link. Choose Service Monitoring. Enter the IP Address or hostname in which the monitor is running. Enter the SubNetMask of the network.Enter the port number in which the service you want to monitor is running. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Enter the command that will be executed after connecting to the service mentioned above. For example, if the port added is where your web server is running , then you can give the command as GET / HTTP1.0 . This will get the index page of the web server. Enter the string that has to be searched after executing the command. Choose the Monitor Group from the combo box with which you want to associate Service Monitoring Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the service from the server and starts monitoring them. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Service Monitoring (TCP Ports) monitor instance available in the Services section. Displayed is the TCP monitor''s bulk configuration view distributed into three tabs: Availability tab gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. Below are the list of metrics that are monitored in Applications Manager''s TCP monitor: Parameter Description Connects to the server configured for monitoring and retrieves the details pertaining to the Availability validity and authenticity of the service port. CPU Amount of CPU utilized by the port (in %). Utilization Memory Amount of memory utilized by the port (in %). Utilization Disk Amount of disk space utilized by the port (in %). Utilization RESPONSE TIME Response Amount of time taken to connect to the port, execute the given command, search the string and Time provide response (in ms). DNS Monitoring Overview Domain Name System (DNS) is a hierarchical and decentralized naming system that translates human-readable domain names to machine-readable IP addresses and vice-versa, using which computers identify each other on the network. It serves as the Internet''s phone book by maintaining the domain name hierarchy and managing the mapping between domain names and their respective IP addresses. Since DNS servers play a predominant role in helping users to connect to a website, keeping your company''s DNS infrastructure stable is the first thing you must do. Any issues in the functioning of your DNS servers can can result in downtime and performance interruptions affecting your overall end user experience. Thus, having a robust DNS monitoring software becomes essential to troubleshoot issues and optimize performance. DNS server monitoring tools like Applications Manager''s DNS monitoring serves the purpose by constantly examining the performance and availability of your DNS servers in real-time. It provides in-depth DNS server monitoring by keeping track of various key performance metrics such as response time, record type, search value along with their availability status, and immediately notifies you in the event of downtime or performance bottlenecks. In this help document, you will learn how to get started with DNS server monitoring with the help of Applications Manager''s DNS monitoring tool. Creating a new DNS server monitor Using the REST API to add a new DNS monitor: Click here To create a new DNS server monitor, follow the steps given below:Click on New Monitor link. Choose DNS Monitor under Services category. Enter the DisplayName of the host in which the monitor is running. Enter the Target Address. Enter the Lookup Address. Enter Timeout value in seconds. Select the Record Type from the pull down menu. Select the Search Field from the drop-down box. Enter Search Value. Enter the polling interval for monitoring the DNS server. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate DNS Monitor (optional). You can choose multiple groups to associate your monitor. Associate the monitor instance to the agent. Enable Run on Server option to run the DNS monitor in the local instance of Applications Manager. Enable Run on Agent option to run the DNS monitor from multiple locations. Select the necessary agents from where you want this monitor to be executed. This option will be available only if you enable the EUM add-on. Click Add Monitor(s). This discovers the DNS server monitor from the network and starts monitoring them. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on DNS Monitor under the Services category. Displayed is the DNS Server monitor bulk configuration view distributed into three tabs: Availability tab displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. DNS monitoring software like Applications Manager provide complete visibility into your DNS server infrastructure altogether in a single window based on the following metrics: Monitors the availability and performance of DNS monitors. It also monitors individual attribute of DNS DNS monitor such as Response Time, Record Type, Record Available, Search Field, Search Value, Search Server Value Status and Search Time. Apache Zookeeper Monitoring Apache Zookeeper - An Overview Monitoring Apache Zookeeper - What we do. Adding a new Apache Zookeeper monitor Monitored Parameters Apache Zookeeper - An Overview Apache Zookeeper is an open-source server that reliably coordinates distributed processes and applications. It allows distributed processes to coordinate with each other through a shared hierarchal namespace which is organized similarly to a standard file system. ZooKeeper server maintains configuration information, naming, providing distributed synchronization, and providing group services, used by distributed applications. Monitoring Apache Zookeeper - What we do. Apache Zookeeper provides a hierarchical file system (with ZNodes as the system files) that helps with the discovery, registration, configuration, locking, leader selection, queueing, etc of services working in different machines. Applications Manager aims to help administrators manage their Zookeeper server, collect all the metrics that can help when troubleshooting and be alerted automatically of potential issues. Let’s take a look at what you need to see to monitor Zookeeper and the performance metrics to gather with Applications Manager: Resource utilization details - Automatically discover Zookeeper Clusters, monitor memory (heap and non- heap) on the znode get alerts of changes in resource consumption. Thread and JVM usage - Track thread usage with metrics like Daemon, Peak and Live Thread Count. Ensure that started threads don’t overload the server''s memory.Performance Statistics - Gauge the amount of time it takes for the server to respond to a client request, queued requests and connections in the server and performance degradation due to network usage (client packets sent and recieved). Cluster and Configuration details - Track the number of Znodes, the watcher setup over the nodes and the number of followers within the ensemble. Keep an eye on the leader selection stats and client session times. Fix Performance Problems Faster - Get instant notifications when there are performance issues with the components of Apache Zookeeper. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Apache Zookeeper - Adding a new monitor Supported versions: 3.4.9 Prerequisites for monitoring Apache Zookeeper metrics: Click here Using the REST API to add a new Apache Zookeeper monitor: Click here To create an Apache Zookeeper Monitor, follow the steps given below: Click on New Monitor link. Choose Apache Zookeeper. Enter Display Name of the monitor. Enter the IP Address or hostname of the host where zookeeper server runs. Enter the JMX Port of the Zookeeper server. By default, it will be 7199. Or Check in zkServer.sh file for the JMX_PORT. To discover only this node and not all nodes in the cluster disable the option Discover all nodes in the Cluster. By default, it is enabled which means all the nodes in the cluster are discovered by default. Enter the credential details like user name, password and JNDIPath or select credentials from a Credential Manager list. Check Is Authentication Required field to give the jmx credentials to be used to connect to the Zookeeper server.. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Apache Zookeeper Server. Choose the Monitor Group from the combo box with which you want to associate Apache Zookeeper Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Apache Zookeeper from the network and starts monitoring.  Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Apache Zookeeper under the Services Table. Displayed is the Apache Zookeeper bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Overview Performance InMemory Data Tree Cluster Details Configurations Overview PARAMETER DESCRIPTION LEADER ELECTION STATUS Replica Name The shard replica name.PARAMETER DESCRIPTION The serving mode: leader, follower,Leader Election or standalone if not running in an State ensemble. Election in Progress Indicates whether election is in progress or not. Values can be YES or NO. Election Start Time The time of start of leader elections. MEMORY DETAILS The total size of physical memory that is available for the Zookeeper for its Total Physical Memory Size operations and storage. The total size of physical memory that is free and available for the Zookeeper Free Physical Memory Size clusters and nodes. Committed Virtual The total size of virtual memory that is currently occupied by the corresponding Memory Size Zookeeper nodes. The total size of the swap space that is available for swapping when the virtual Total Swap Space Size memory reaches the limit. The free swap space size that is available for swapping when the virtual memory Free Swap Space Size reaches the limit. THREAD DETAILS The number of daemon threads that are running. A daemon thread is a thread that Daemon Thread Count does not prevent the JVM from exiting when the program finishes, even if the thread is still running. Peak Thread Count The maximum thread count since JVM start. Live Thread Count The current number of live threads (daemon and non-daemon) on the node. Total Started Thread Count The total number of started threads. HEAP MEMORY DETAILS Committed Heap Memory The total amount of committed heap memory. Initial Heap Memory The Minimum heap memory allocated. Maximum Heap Memory The maximum heap memory that the Zookeeper can use. Used Heap Memory The total used heap memory. NON-HEAP MEMORY DETAILS Committed Non-Heap The total amount of committed non-heap memory. Memory Initial Non-Heap Memory The Minimum Non-Heap memory allocated. Maximum Non-Heap The maximum non-heap memory that the Zookeeper can use. Memory Used Non-Heap Memory The total used non-heap memory. Performance PARAMETERS DESCRIPTION PACKETS STATISTICS Packets Received/Min The number of packets received. (Rate per minute) Packets Sent/Min The number of packets sent. (Rate per minute) LATENCY The minimum amount of time it takes for the server to respond to a client request Minimum Request Latency (since the server was started). The unit of the time is milliseconds. The average time it takes for the server to respond to a client request (since the Average Request Latency server was started). The unit of the time is milliseconds. The maximum amount of time it takes for the server to respond to a client request Maximum Request Latency (since the server was started). The unit of the time is milliseconds. NUMBER OF CONNECTIONS ALIVE Number of Connections The number of live connections. Alive NUMBER OF OUTSTANDING REQUESTSPARAMETERS DESCRIPTION No of Outstanding The number of queued requests in the server. This goes up when the server receives Requests more requests than it can process. InMemory Data Tree PARAMETER DESCRIPTION NODE COUNT Node Count The number of nodes in the Zookeeper. WATCH COUNT Watch Count The number of watchers setup over Zookeeper nodes. EPHEMERAL NODE COUNT Ephemeral Node Count The number of Ephemerals nodes. APPROXIMATE DATA SIZE Approximate Data Size The size of the data used. (in bytes). Cluster Details PARAMETER DESCRIPTION NODE COUNT Node Count The number of znodes in the Zookeeper cluster. WATCH COUNT Watch Count The number of watchers setup over Zookeeper nodes. EPHEMERAL NODE COUNT The number of ephemeral nodes. (Ephemeral nodes in Apache ZooKeeper are great Ephemeral Node Count for transient data: These znodes exists as long as the session that created the znode is active.) APPROXIMATE DATA SIZE Approximate Data Size  size of the data used. (in bytes). Configuration PARAMETER DESCRIPTION ZOOKEEPER CONFIGURATION DETAILS Replica Name   State   Client Port The port to listen for client connections. The amount of time, in ticks (see Tick Time), to allow followers to connect and sync Init Limit to a leader. Increased this value as needed, if the amount of data managed by ZooKeeper is large. Max Client Connections Per The maximum number of concurrent connections (at the socket level) that a single Host client, identified by IP address. The maximum session timeout in milliseconds that the server will allow the client to Max Session Timeout negotiate. Defaults to 20 times the Tick time. The minimum session timeout in milliseconds that the server will allow the client to Min Session Timeout negotiate. Defaults to 2 times the Tick Time. A replicated group of servers in the same application is called a quorum, and in Quorum Address replicated mode, all servers having quorum address to contact the each other. Zookeeper Start Time The time of start of the Zookeeper. The amount of time, in ticks (see Tick Time), to allow followers to sync with Sync Limit ZooKeeper. If followers fall too far behind a leader, they will be dropped. The length of a single tick, which is the basic time unit used by ZooKeeper, as Tick measured in milliseconds.PARAMETER DESCRIPTION The length of a single tick, which is the basic time unit used by ZooKeeper, as Tick Time measured in milliseconds. It is used to regulate heartbeats, and timeouts. For example, the minimum session timeout will be two ticks. Version The version of the zookeeper installed. CONFIGURATION DETAILS VM Name The Java virtual machine name. The boot class path that is used by the bootstrap class loader to search for class Boot Class Path files. VM Vendor The Java virtual machine implementation vendor. Class Path The Java class path that is used by the system class loader to search for class files. Spec Vendor The vendor of the JMX specification implemented by this product. Spec Version The version of the JMX specification implemented by this product. Ceph Storage Monitoring Ceph Storage Monitoring - An Overview Ceph is an open source software platform designed to provide highly scalable object, block and file-based storage from a single distributed computer cluster. Ceph''s main goals are to be completely distributed without a single point of failure, scalable to the exabyte level, and freely-available. Applications Manager''s Ceph storage monitor helps to monitor the performance and to maintain the overall health of your distributed Ceph cluster, ensures the availability of OSD nodes, proactively tracks the status of Placement Groups and storage availability. Creating a new Ceph Storage monitor Ceph Storage Versions Supported: v0.66 and above, Luminous version 12.2.0 onwards (We use Ceph status command and get the output in JSON format. Returning the output in JSON is supported from Ceph release v0.66) Prerequisites for monitoring Ceph Storage Clusters: To collect performance stats of Ceph Storage Monitor a user should be given read privileage to ceph.keyring file. Read more Using the REST API to add a new Ceph Storage monitor: Click here To create a Ceph Storage monitor, follow the steps given below: Specify the Display Name of the Ceph Storage monitor. Enter the HostName or IP Address of the host where the Ceph storage cluster runs. Select the Mode of Monitering you want (Telnet and SSH based). For SSH, provide the port number (22 by default), username and password information of the server. You also have the option to give Public Key Authentication (User name and Public Key). Under Credential Details, if you opt the "Use below Credential" option, provide credentials as per the mode selected. If you opt to fetch the details from the preconfigured credential details in Credentials Manager, select the option "Select from Credential list". Specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. Enter the Username and Password Provide the Polling interval for monitoring the Ceph Storage montior. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box to which you want to associate the Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the monitor from the network and starts monitoring them. Ceph Server - Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Ceph Storage under the Services Table. Displayed is the Ceph Storage bulk configuration view distributed into three tabs: Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations.Click on the monitor name to see all the server details listed under the following tabs: Performance Overview Monitor Details Storage Availability OSD Details (For Luminous versions) Performance Overview Parameter Description PG Status PGS (Placement groups) The number of Placement Group. The total number of Active Placement Groups. (Ceph processes requests to the Active PGs placement group.) The total number of Active and Clean Placement Groups. Active PGs - Ceph processes requests to the placement group. Active+Clean PGs Clean PGs - Ceph replicates all objects in the placement group the correct number of times. The total number of Active and Remapped Placement Groups. Active PGs - Ceph processes requests to the placement group. Active+Remapped PGs Remapped PGs - The placement group is temporarily mapped to a different set of OSDs from what CRUSH specified. The total number of Active and Degraded Placement Groups. Active PGs - Ceph processes requests to the placement group. Active+Degraded PGs Degraded PGs - Ceph has not replicated some objects in the placement group the correct number of times yet. The total number of Down, Remapped and Peering Placement Groups. Down PGs - A replica with necessary data is down, so the placement group is offline. Down+Remapped+Peering Remapped PGs - The placement group is temporarily mapped to a different set of OSDs from what CRUSH specified. Peering PGs - The placement group is undergoing the peering process. The total number of Active, Clean, Scrubbing and Deep Placement Groups. Active PGs - Ceph processes requests to the placement group. Clean PGs - Ceph replicates all objects in the placement group the correct number of times. Active+Clean+Scrubbing+Deep Scrubbing PGs - Ceph is checking the placement group for inconsistencies. Deep PGs - Ceph automatically takes care of deep-scrubbing all placement groups periodically. The number of replica placement groups where the necessary data is down, so Down the placement group is offline. The number of placement groups, that has not replicated some objects in the Degraded placement group the correct number of times. Peering The number of placement groups undergoing the peering process. The number of placement groups in Incomplete state i.e PGs with missing Incomplete information about writes that may have occurred, or does not have any healthy copies. The number of placement groups in an unknown state - the monitors have not Stale received an update for it since the placement group mapping changed. OSD Status OSDS Number of OSDS Present.OSDUP Number of OSDs up and running. OSDIN Number of OSDs in the cluster. OSDOUT Number of OSDs out of the cluster. If an OSD is down and in, there is a problem and the cluster will not be in a OSDs In and Down healthy state.This attribute will capture the number os OSDs In and Down FULL Is the OSD Full. NEARFULL Is the OSD reaching near full. Time Checks Monitor Name The name of the monitor in the cluster. Severity The health severity message of the monitor. Monitor Details Parameter Description Monitor Health Summary Monitor Name of the monitor. Name Total (GB) The total disk memory in GB. Used  (GB) The total used memory in GB. Available(GB) The available free memory in GB. Available In  The percentage of available free memory. (%) Last Updated The last time of Monitor status updated. Severity The health severity of the monitor. Rank of the Ceph monitor in the Cluster. Ranks are (re)calculated whenever you add or remove a monitor (Lower the value, higher the rank). Ceph monitor with lowest value will be the lead or Rank admin, clients will try to connect to the lead first and when lead is down, clients connect to the next rank monitor. Monitor The address required for monitors to discover each other using the monitor map. address Storage Availability Parameter Description Read Bytes The rate of bytes read per sec. Write Bytes The rate of bytes written per sec. Data Size The total storage data size in GB. Total Bytes The total storage space available in GB. Available The total free storage space available in GB. Used The total amount of used storage space in GB. Available % The percentage of free storage space. Used % The percentage of used storage space. OSD Details (For Luminous versions) Parameter Description OSD Storage Information Id Monitor ID. OSD Monitor Name The OSD Monitor name. Disk Usage Graphical representation of the disk storage used. Used Storage (GB) The disk storage used in GB.Parameter Description Available Storage(GB) The free memory available in GB Total Storage(GB) The total disk memory in GB Available Storage (%) The percentage of free memory available. Last Down Time Last time and date at which OSD status went down. Hadoop Monitoring Overview Hadoop is an open source software framework designed for distributed storage and distributed processing of big data (very large data sets). Hadoop''s primary architecture mainly consists of a storage part and a processing part. Hadoop splits files into large blocks and distributes them amongst the nodes in the cluster. The processor part of Hadoop transfers tasks to nodes for processing in parallel, thus taking advantage of data locality (nodes manipulating data they have on hand), for faster and efficient processing. Applications Manager''s Hadoop Monitor provides monitoring for both versions of Hadoop i.e. Hadoop 1.x and Hadoop 2.x and helps you maintain the overall health of your distributed Hadoop cluster, ensures their availability and processes tasks faster and accurately. Creating a new Hadoop monitor Prerequisites for monitoring Hadoop metrics: Click here Using the REST API to add a new Hadoop monitor: Click here To create a Hadoop monitor, follow the steps given below: Click on New Monitor link and select Hadoop under Services. Enter a Display Name for the monitor. Choose the Mode of Monitoring. (REST API or JMX) For REST API mode: Specify the Version of Hadoop to be monitored. Specify the host of the NameNode. Specify the web port of the NameNode. Choose YES or NO to ensure SSL is enabled or not. Select Authentication type. If you select Simple Authentication, specify a username. Specify the name of the ResourceManager host. Specify the name of the ResourceManager web port. Again, choose YES or NO to ensure SSL is enabled or not. Again, select Authentication type. If you select Simple Authentication, specify a username. Specify a duration for Polling Interval. Choose the Monitor Group from the combo box to which you want to associate the Monitor(optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitor from the network and starts monitoring them. For JMX mode: Specify the Version of Hadoop to be monitored. Specify the host of the NameNode. Specify the JMX port of the NameNode. Enter a Username and Password. Enter a JNDIPath for the NameNode. Specify the name of the ResourceManager host. Specify the name of the ResourceManager JMX port. Enter a Username and set a Password. Set a ResourceManager JNDIPath. Set the duration for Polling Interval. Choose the Monitor Group from the combo box to which you want to associate the Monitor(optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Monitor from the network and starts monitoring them. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP]Hadoop Server - Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Hadoop under the Services table. Displayed is the Hadoop bulk configuration view distributed into three tabs: Availability tab, gives the availability history for the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs. Hadoop Version 1.x Hadoop Version 2.x Overview Overview HDFS HDFS Mapreduce YARN Job Applications Hadoop 1.x Overview: SAFEMODE   Safemode status Possible values: Safemode status -Operational -Safemode DFS   Total DFS Capacity (in GB) Total capacity of the HDFS . NonDFS Used Space (in GB) Used memory of the HDFS which is not done using DFS commands. DFS Used Space (in GB) Used memory of the HDFS which is done using DFS commands. DFS Used (in %) Percentage of HDFS memory used.  DFS Free Space (in GB) Free memory of the HDFS. DFS Free (in %) Percentage of free memory in HDFS. BLOCKS   Block Capacity Total block capacity of Hadoop. Total Blocks Total number of blocks in Hadoop. Missing Blocks Number of missing blocks in Hadoop. Corrupt Blocks Number of corrupt blocks in Hadoop. Excess Blocks Number of excess blocks in Hadoop. UnderReplicated Blocks Number of under replicated blocks in Hadoop. Pending Deletion Blocks Number of pending deletion blocks in Hadoop. Pending Replication Blocks Number of pending replication blocks in Hadoop. FILES   Total Files and Directories Total number of file and directories in HDFS. Files and Directories created per sec Number of files and directories created per sec. LOAD   Total Load Total load over the Hadoop service. HDFS: NameNode JVM  NonHeap Memory Committed Total nonheap memory committed for usage currently. NonHeap Memory Used Currently used nonheap memory.  Heap Memory Commited Total heap memory committed for usage currently. Heap Memory Used Currently used heap memory.  Namenode OS   Total Physical Memory (in GB)  Total RAM of namenode. Free Physical Memory (in GB) Free RAM of namenode. Total Swap Space (in GB) Total swap space available in namenode OS. Free Swap Space (in GB) Free swap space available in namenode OS. Maximum File Descriptor Count Total  file descriptor capacity. Open File Descriptor Count Number of file descriptor in open state. Average System Load Average load in namenode OS. DataNodes   Node Name Name of the datanode Current state of namenode: Live State Dead Decommissioned Used Space (in GB) Used space in HDFS. MapReduce: Tracker Summary   Total TaskTracker Total number of tasktracker. Alive Tasktracker Number of tasktracker in alive state. Blacklisted TaskTracker Number of tasktracker in blacklisted state. Graylisted TaskTracker Number of tasktracker in graylisted state. Total Number of Jobs Total number of job executed in mapreduce. Slots Summary   Total Map Slots Total map slots capacity in mapreduce. Used Map Slots Number of map slots used currently. Total Reduce Slots Total reduce slots capacity in mapreduce. Used Reduce Slots Number of reduce slots used currently. TaskTrackers   TaskTracker Name Name of the tasktracker Current state of tasktracker: Alive State Blacklisted Graylisted Dead Current health state of tasktracker: Health OK Failure Count Number of failure in tasktracker. Queue   Queue Name Name of the queue. State Current state of queue. Info Any error information that is thrown from queue. Job:   Jobs Summary Jobs Submitted Number of jobs in submitted state. Jobs Preparing Number of jobs in preparing state. Jobs Running Number of jobs in running state. Jobs Failed Number of jobs in failed state. Jobs Killed Number of jobs in killed state. Jobs Completed Number of jobs in completed state. Completed Percent (in %) Percentage of completed jobs. Killed Percent (in %) Percentage of killed jobs. Failed Percent (in %) Percentage of failed jobs. Jobs Stats (in last pillong interval)   Submitted jobs count Number of jobs submitted in last polling interval. Failed jobs count Number of jobs failed in last polling interval. Killed jobs count Number of jobs killed in last polling interval. Completed jobs count Number of jobs completed in last polling interval. Hadoop 2.x Overview: SAFEMODE   Safemode status Possible values: Safemode status -Operational -Safemode DFS   Total DFS Capacity (in GB) Total capacity of the HDFS . NonDFS Used Space (in GB) Used memory of the HDFS which is not done using DFS commands. DFS Used Space (in GB) Used memory of the HDFS which is done using DFS commands. DFS Used (in %) Percentage of HDFS memory used.  DFS Free Space (in GB) Free memory of the HDFS. DFS Free (in %) Percentage of free memory in HDFS. BLOCKS   Block Capacity Total block capacity of Hadoop. Total Blocks Total number of blocks in Hadoop. Missing Blocks Number of missing blocks in Hadoop. Corrupt Blocks Number of corrupt blocks in Hadoop. Excess Blocks Number of excess blocks in Hadoop. UnderReplicated Blocks Number of under replicated blocks in Hadoop. Pending Deletion Blocks Number of pending deletion blocks in Hadoop. Pending Replication Blocks Number of pending replication blocks in Hadoop. FILES   Total Files and Directories Total number of file and directories in HDFS. Files and Directories created per sec Number of files and directories created per sec. LOAD   Total Load Total load over the Hadoop service.HDFS: DataNode Summary   Live Datanodes Number of datanode in live state. Dead Datanodes Number of datanode in dead state. Live-Decommissioned Datanodes Number of datanode in live but decommissioned. Dead-Decommissioed Datanodes Number of datanode in dead and decommissioned. Decommissioning Datanodes Numer of datanode in decommissioned state. Stale Datanodes Number of datanode in stale state. Live Datanode Percent (in %) Percentage of datanode in live state. Dead Datanode Percent (in %) Percentage of datanode in dead state. DataNodes   Node Name Name of datanode. Current state of the datanode: Live Decommission In Progress State Live - Decommissioned Dead - Decommissioned Dead Total Capacity (in GB) Total capacity of the HDFS. NonDFS Used (in GB) Amount of memory used in HDFS by non- HDFS commands. DFS Used (in GB) Amount of memory used in HDFS by HDFS commands. DFS Used Percent (in %) Percentage of memory used in HDFS by HDFS commands DFS Free (in GB) Amount of memory free in HDFS. DFS Free Percent (in GB) Percentage of memory free in HDFS. YARN: NodeManger Summary   Active NodeManagers Number of nodemanagers in active state. Decommissioned NodeManagers Number of nodemanagers in decommissioned state. Lost NodeManagers Number of nodemanagers in lost state. UnHealthy NodeManagers Number of nodemanagers in unhealthy state. Rebooted NodeManagers Number of nodemanagers in rebooted state. Active NodeManager Percent (in %) Percentage of nodemanager in active state. Lost NodeManager Percent (in %) Percentage of nodemanager in lost state. UnHealthy NodeManager Percent (in %) Percentage of nodemanager in unhealthy state. NodeManager   HostName Hostname of nodemanager. Rack Rack to which this nodemanager belongs. Current state of nodemanager. State Running Unhealthy Dead Memory used (in %) Percentage of main memory used by nodemanager. Version Version of nodemanager. Applications: Applications  Apps Submitted Number of applications in submitted state. Apps Completed Number of applications in completed state. Apps Pending Number of applications in pending state. Apps Running Number of applications in running state. Apps Failed Number of applications in failed state. Apps Killed Number of applications in killed state. Percent Completed (in %) Percentage of completed applications. Percent Killed (in %) Percentage of killed applications. Percent Failed (in %) Percentage of failed applications. Applications stat (in last polling interval)   Submitted apps count Number of applications submitted in last polling interval. Failed apps count Number of applications failed in last polling interval. Killed apps count Number of applications killed in last polling interval. Completed apps count Number of applications completed in last polling interval. Hazelcast Monitoring Hazelcast - Overview Creating a new Hazelcast monitor Monitored Parameters Hazelcast - Overview Hazelcast is an open source in-memory data grid based on Java that provides central, predictable scaling of applications through faster in-memory access to frequently used data which helps in reducing the query load on databases and improves speed. In a Hazelcast grid, data is evenly distributed among the nodes of a cluster, allowing for horizontal scaling both in terms of available storage space and processing power. Applications Manager aids you in monitoring your Hazelcast environment by keeping track over various key performance metrics of your Hazelcast servers in real-time. It helps you to monitor important metrics such as memory details, thread details, cluster and its associated node details along with various distributed implementation of interfaces such as Maps, Multi Maps, Queues, Topics, etc. which overall plays a crucial role in determining how your applications are performing in a Hazelcast environment. Creating a new Hazelcast monitor Follow the steps given below to create a new Hazelcast monitor: Click on New Monitor link. Select Hazelcast under Services category. Specify the Display Name. Enter the Host Name of the server on which the Hazelcast cluster is running. Specify the JMX Port. For default installations of Hazelcast, the JMX port number is 1099. In the Additional JMX Port field, specify the ports separated by commas if JMX is enabled in any other JMX ports of the machine that is running the Hazelcast cluster. Enter the credential details like username and password of the Hazelcast server for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. If no authentication is required, then leave the fields blank. Specify the JNDI Path. For default installations of Hazelcast, the JNDI path is /jmxrmi. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Hazelcast server to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers the Hazelcast server from the network and starts monitoring it. Note: In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Monitored ParametersGo to the Monitors Category view by clicking the Monitors tab. Click on Hazelcast under the Services category. Displayed is the Hazelcast server bulk configuration view distributed into three tabs: Availability tab gives the availability history of the Hazelcast server in the past 24 hours or 30 days. Performance tab gives the health status and events for the past 24 hours or 30 days, some key performance indicators of the Hazelcast server such as CPU Utilization and Memory Utilization along with heat charts for these attributes. List view enables you to perform bulk admin configuration. Click on the monitor listed to view detailed performance metrics of the Hazelcast server. These metrics are categorized into eight different tabs for easy understanding.  Overview Cluster Details Maps Replicated Maps Multi Maps Queues Topics Configuration Overview Parameter Description MEMORY DETAILS Total Physical Total amount of physical memory allocated to the machine (in GB). Free Physical Amount of physical memory that is free (in GB). Committed Virtual Amount of virtual memory committed (in GB). Total Swap Space Total amount of swap space available in the machine (in GB). Free Swap Space Amount of swap space that is free (in GB). THREAD DETAILS Daemon Number of Daemon threads available. Peak Number of Peak threads available. Thread Count Number of Live Threads available. Total Started Total number of threads started. HEAP MEMORY DETAILS Committed Heap Amount of heap memory committed (in GB). Initial Heap Amount of initial heap memory (in GB). Maximum Heap Amount of maximum heap memory (in GB). Used Heap Amount of heap memory used (in GB). NON HEAP MEMORY DETAILS Committed Non Heap Amount of non heap memory committed (in GB). Initial Non Heap Amount of initial non heap memory (in GB). Maximum Non Heap Amount of maximum non heap memory (in GB). Used Non Heap Amount of non heap memory used (in GB). Connection Details Active Connections Number of active connections including member or a client. Client Connections Number of active client connections. Client Endpoint Number of clients connected. Total Connections Count Total number of connections available. Event Details Event Queue Capacity Maximum capacity of the event queue.Event Queue Size Current size of the event queue. Event Threads Number of threads currently used by the event queue. Response Queue Size Current size of the response queue. Operation Details Executed Operations Total number of operations executed. Operation Threads Number of threads currently used to execute operations. Remote Operation Number of operations executed by remote process. Running Operations Total number of operations that are currently running. Partition Details Total Partition Total number of partitions available. Active Partition Number of partitions that are currently active. Cluster Details Parameter Description CLUSTER STATE Master Address Current master address of the Hazelcast cluster. Cluster Safe Indicated whether all the data is safe when any of the node in the cluster fails. Local Member Safe Indicated whether all the data is safe when the currently connected node in the cluster fails. MEMBER DETAILS Proxies Number of client side proxy implementations. Members Total number of members available in the cluster. Port The port of currently connected node in the Hazelcast network. Currently connected Nodes Node Name Network details of all the nodes in cluster. Maps Parameter Description Map Details Name Name of the map. Backup Number of backups present. Backup Entry Number of backup entries present. Backup Memory Cost Size of the backup memory (in bytes). Dirty Entries Number of dirty entries present. Event Operations Number of event operations occurred. Get Operations Number of Get operations occurred. Heap Cost Heap cost of the map (in bytes). Hits Number of hits occurred. Locked Entries Number of locked entries present. Owned Entries Number of owned entries present. Owned Memory Cost Size of the owned memory (in bytes). Put Operations Number of put operations occurred. Remove Operations Number of Remove operations occurred. Size Total number of owned and backup entries present. Replicated Maps Parameter Description Replicated Map DetailsName Name of the replicated map. Event Operations Number of event operations occurred. Get Operations Number of Get Operations occurred. Hits Number of hits occurred. Owned Entries Number of owned entries present. Put Operations Number of put operations occurred. Remove Operations Number of Remove operations occurred. Size Total number of owned and backup entries present. Multi Maps Parameter Description Multi Map Details Name Name of the multi map. Backups Count Number of backups present. Backup Entries Count Number of Backup entries present. Backup Entry Memory Cost Size of the backup memory (in bytes). Dirty Entries Number of dirty entries present. Event Operations Number of event operations occurred. Get Operations Number of Get Operations occurred. Hits Number of hits occurred. Locked Entries Number of locked entries present. Owned Entries Number of owned entries present. Owned Entries Memory Size of the owned memory (in bytes). Put Operations Number of put operations occurred. Size Total number of owned and backup entries present. Queues Parameter Description Queue Details Name Name of the queue. Backup Items Number of backup queues present. Empty Poll Operations Number of empty operations occurred without any output. Event Operations Number of event operations occurred. Offer Operations Number of offer/put/add operations occurred. Rejected Offer Operations Number of rejected offer operations occurred. Topics Parameter Description Topic Details Name Name of the topic. Publish Operations Total number of published operations in this topic. Receive Operations Total number of received operations in this topic. Configuration Parameter Description Configuration Details Spec Vendor Name of the Java specification vendor.Spec Version Version of the Java specification vendor. JVM Name Name of the Java Virtual Machine (JVM). JVM Vendor Name of the JVM offering vendor. Address Current master address of the Hazelcast cluster. Group Name Name of the cluster group. Instance Name Name of the Cluster instance. Status Status of the JVM running. Version Version of the Hazelcast cluster. Oracle Coherence Servers Monitoring Overview Creating a new Oracle Coherence Monitor Prerequisites Monitored Parameters Overview Applications Manager provides out-of-the-box performance metrics and helps you visualize the health and availability of an Oracle coherence server farm. Database administrators can login to the web client and visualize the status and Oracle coherence performance metrics. Creating a new Oracle Coherence Monitor Prerequisites for monitoring Oracle Coherence metrics: Ensure that you enable JMX for Oracle Coherence monitoring. For you to create a new Oracle Coherence monitor, you should have admin privileges. Using the REST API to add a new Oracle Coherence monitor: Click here Click on New Monitor link. Select Oracle Coherence. Enter the Display Name of the monitor Enter the IP Address or hostname of the host. Enter the JMX Port in which the JMX is running. Enter the Additional JMX Port in which the JMX is already running in any of the other machine of the same cluster. Choose the Credential Details either use below credentials or select from credential list Enter the Username and Password. Enter JNDI Path (eg.) /jmxrmi Enter the polling interval time in minutes. Choose the Monitor Group from the combo box with which you want to associate Oracle database server Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Oracle database server from the network and starts monitoring them. Note: To create a new Oracle Coherence monitor, you should have admin privileges. Jconsole can also be used to access the Mbeans. In case you are unable to add the monitor even after enabling JMX, try providing the below argument: -Djava.rmi.server.hostname=[YOUR_IP] Monitored Parameters Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the individual monitors listed, to view the following information. Cluster DetailsAttribute Name Description ClusterName Name of Cluster Cluste Size Size of Cluster LocalMemberID (Management ID) Member ID of the Node to which the JMX gets Connected OldestMemberID The Node ID that is Running at First MemberDepartureCount Number of nodes that gets Departed Version Version of Oracle Coherence LicenseMode License Mode Either Development or Production or Evaluation DistributedServiceCount Number of Distributed Service that is Configured NonDistributedServiceCount Number of Replicated Based Service that is Configured ExtendServiceConnection Extend Service Connection Count Partition Assignment Attribute Name Description CoordinatorId OwnerShip Distribution Co-Ordinator ServiceMachineCount (Storage Machine Count) Number of Service Machine ServiceNodeCount Number of Service Node StrategyName Strategy Name HAStatus Status of Storage Backups Service Name Name of Service Distributed and Replicated Services Attribute Name Description StorageEnabled Whether Storage enabled or not MessagesLocal (Number of Messages) Number of Local Messages in Node MessagesReceived Number of Messages Received MessagesSent Number of Messages Sent PartitionsAll Partition All PartitionsEndangered Endangered Partitions PartitionsVulnerable Vulnerable Partitions ServiceName Name of Service StatusHA Status of Node Type Type of Service Unicast Unicast address Extend Connection Manager Attribute Name Description ConnectionTimeMillis Amount of milliseconds of Connection TotalMessagesReceived Total Messages Received TotalMessagesSent Total Messages Sent TotalBytesReceived Total Bytes Received TotalBytesSent Total Bytes Sent RemoteAddress Remote Address Timestamp Time of Connection Establishment ExtendTcpProxyServiceAttribute Name Description ConnectionCount Number of Connection UnauthorizedConnectionAttempts Unauthorized Connection Attempts TotalMessagesSent Total Messages Sent TotalMessagesReceived Total Messages received TotalBytesReceived Total Bytes Received TotalBytesSent Total Bytes Sent HostIP Host IP NodeGeneralDetails Attribute Name Description Id Id of Node UnicastAddress Unicast Address WeakestChannel Weakest Channel PacketsSent Packets Sent PacketsReceived Packets Received PublisherSuccessRate Publisher Success rate ReceiverSuccessRate Receiver Success rate MemoryAvailableMB Memory Available MemoryMaxMB Memory Maximum Apache Spark Monitoring Apache Spark - An Overview Monitoring Apache Spark - What we do Adding a new Apache Spark monitor Monitored Parameters  Apache Spark- An Overview Apache Spark is an open source big data processing framework built for speed, with built-in modules for streaming, SQL, machine learning and graph processing. Apache Spark has an advanced DAG execution engine that supports acyclic data flow and in-memory computing. Spark runs on Hadoop, Mesos, standalone, or in the cloud. It can access diverse data sources including HDFS, Cassandra, HBase, and S3.  Monitoring Apache Spark  - What we do Let’s take a look at what you need to get real-time operational visibility into Spark applications, the performance metrics to gather and how you can ensure that your search server is up and operating as expected with Applications Manager''s Apache Spark Monitoring: Resource Utilization Details - Applications Manager automatically discovers your Spark components and shows key metrics of Apache Spark clusters (master and worker nodes), monitors memory and CPU and notifies you of changes in resource consumption of memory pool. Real-Time Data - Track garbage collection and memory across the cluster on each component, specifically, the executors and the driver. Get useful information about the application and cores. Fix Performance Problems Faster - Get instant notifications when there are performance issues. Become aware of performance bottlenecks and take quick remedial actions before your end users experience issues. Apache Spark - Adding a new monitor Using the REST API to add a new Apache Spark monitor: Click here To create an Apache Spark monitor, follow the steps given below:  Click on New Monitor link. Choose Apache Spark.Specify the Display Name of the Apache Spark monitor. Enter the HostName or IP Address of the host where Apache Spark Master runs. Enter the Port of the Apache Spark Master. By default, it will be 8080. Enter the polling interval time in minutes. Click Test Credentials button, if you want to test the access to Spark server. Choose the Monitor Group from the combo box with which you want to associate Spark Monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Spark from the network and starts monitoring. Note: Uncomment the following lines in the file SPARK_HOME/conf/metrics.properties.template and save it as metrics.properties and restart the Apache Spark instances to collect the metrics: master.source.jvm.class=org.apache.spark.metrics.source.JvmSource worker.source.jvm.class=org.apache.spark.metrics.source.JvmSource driver.source.jvm.class=org.apache.spark.metrics.source.JvmSource executor.source.jvm.class=org.apache.spark.metrics.source.JvmSource You can monitor the Worker Nodes under the given Apache Spark Master by checking the option Discover All Nodes. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on the Apache Spark Master or Apache Spark Worker monitors under the Web Server/Services Table. Displayed is the Apache Spark bulk configuration view distributed into three tabs: Availability tab  displays the Availability history for the past 24 hours or 30 days. Performance tab displays the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. Click on the monitor name to see all the server details listed under the following tabs: Apache Spark Master Overview Workers Applications Memory RDD Details Configuration Apache Spark Worker Overview Executors Memory RDD Details Configuration Apache Spark Master Overview Parameter Description NODE DETAILS Node Name The name of the Apache Spark worker node. Used Memory  (%) The percentage of total memory that the Spark worker node uses on the machine. Free Memory (%) The percentage of total free memory on the machine. MEMORY UTILIZATION Used Memory The percentage of total memory that the Spark Master node uses on the machine. Free Memory The percentage of total free memory of the Spark Master node.Parameter Description Total Memory The total amount of memory to allow Spark applications to use on the machine Used Memory The total amount of memory used by Spark applications. MASTER OVERVIEW The number of alive workers in the Spark cluster. A worker in the ALIVE state can accept Alive Workers applications. Active Applications The number of active applications  that run on the Spark infrastructure. Waiting Applications The number of waiting applications. Completed The number of completed applications. Applications Used Cores The number of used CPU cores on the Apache Spark Master. Workers In standalone mode, the workers are processes running on individual nodes that manage resource allocation requests for that node and also monitor the executors. The number of CPU cores used by the particular Worker node. Parameter Description WORKER DETAILS The URL of the worker''s Web UI. The Web UI  is the web interface of a running Spark Web UI Address application to monitor and inspect Spark job executions in a web browser. ID The ID of the particular worker node, to uniquely identify them. Cores Used    Cores Free The number of free CPU cores, which are unused. Used Memory  (GB) The total memory used by the Worker Node. Free Memory  (GB) The total free memory in the Worker node. Used Memory (%) Percentage of memory used by the Worker node. Time Since Last The time elapsed since last heart beat (i.e.) The last time when the Worker node contacted Heart Beat  the Master Node. (seconds) State The current state of the Worker node, say, ALIVE or DEAD. Applications Parameter Description APPLICATION DETAILS Application Name The name of your application. ID The application is referenced by its application ID. User The user associated with the particular application. Memory Allocated Per Slave  (GB) The amount of memory allocated for each worker. Running Duration  (min) The total running duration of the application, since it is started. State The current state of the particular Application, say, WAITING or RUNNING Memory The maximum heap memory that the Spark can use. Parameter Description HEAP MEMORY Used Heap The percentage of total used heap memory. Free Heap The percentage of free heap memory. Max Heap SizeParameter Description Init Heap Size The minimum heap memory allocated. Committed Heap Size The total amount of committed heap memory. Used Heap Size The total used heap memory. NON HEAP MEMORY Used Non Heap The percentage of total used non-heap memory. Free Non Heap The percentage of free non-heap memory. Max Non Heap Size The maximum non-heap memory that the Spark can use. Initial Non Heap Size The minimum non-heap memory allocated. Committed Non Heap The total amount of committed non-heap memory. Size Used Non Heap Size The total used non-heap memory. JVM   Used JVM The amount of used JVM memory, in MB. Free JVM The amount of memory available for the JVM, in MB Max JVM Size The maximum amount of heap that can be used for memory management in GB. The amount of heap that the Java virtual machine initially requests from the operating Initial JVM Size system in MB. Committed JVM Size The total amount of committed JVM memory. Used JVM Size The total amount of used JVM memory. MARKSWEEP AND SCAVENGE MarkSweep Count The number of times garbage collection have occurred in the Marksweep GC. MarkSweep Time The time taken for garbage collection that have occurred in the Marksweep GC. Scavenge Count The number of times garbage collection have occurred in the Scavenge GC. Scavenge Time The time taken for garbage collection that have occurred in the Scavenge GC. MEMORY POOL DETAILS Memory Pool The memory pool name Maximum  (MB) The maximum pool memory allocated in MB. Committed  (MB) The total amount of committed pool memory. Initial  (MB) The pool memory initially requests from the operating system in MB. Used  (MB) The total amount of used pool memory. Utilization  (%) The percentage of used pool memory. RDD Details Parameter Description COMPILATION DETAILS Compilation Time (Mean) The time it took to compile source code text. Compilation Count The total number compilations occurred while loading the files. COMPILATION DETAILS Generated Class Size (Mean) The size of the class generated. Generated Method Size The size of each method in classes generated. (Mean) Source Code Size (Mean) The time it took to compile source code text. Generated Class Count The number of classes generated. Generated Method Count The number of methods in classes generated. The total number of source code files, that were loaded into the node for Source Code Count compilation. COUNTERS File Cache Hits The total number of file level cache hits occurred.Parameter Description Files Discovered The total number of files discovered. Hive Client Calls The total number of client calls sent to Hive for query processing. Parallel Listing Job Count The total number of jobs running in parallel. Partitions Fetched The total number of partitions fetched. Configuration Parameter Description CONFIGURATION DETAILS Master URL The URL of the master node. Total Workers The total number of workers provisioned in the cluster. Available Cores The number of CPU cores to allow Spark applications to use on the machine. Total Memory Total memory allocated for the Spark Master node. Apache Spark Worker Overview Parameter Description MEMORY UTILIZATION Used Memory The percentage of total memory that the Spark worker node uses on the machine. Percentage Free Memory The percentage of total free memory on the machine. Percentage Used Memory The total memory used by the Worker node, from the available memory. Free Memory The total free memory available for the Worker node. WORKER OVERVIEW Active Executors Number of active executors Number of finished executors (Spark executor exits either on failure or when the associated Finished Executors application has also exited.) Free Cores The total number of cores free and available for the particular Worker. Used Cores The total number of cores used by the particular Worker. Executors Parameter Description EXECUTOR DETAILS Executor ID The unique ID for the particular Executor. Executor Memory  (GB) The total memory available for the particular Executor. Application ID The unique ID for the application associated with the Executor. Application Name The name of the particular Application. User The user associated with the particular Application. Memory Allocated Per Slave  (GB) The amount of memory allocated for each worker. Memory Parameter Description HEAP MEMORY Used Heap The percentage of total used heap memory. Free Heap The percentage of free heap memory. Max Heap Size The maximum heap memory that the Spark can use.Parameter Description Init Heap Size The minimum heap memory allocated. Committed Heap Size The total amount of committed heap memory. Used Heap Size The total used heap memory. NON-HEAP MEMORY Used Non Heap The percentage of total used non-heap memory. Free Non Heap The percentage of free non-heap memory. Max Non Heap Size The maximum non-heap memory that the Spark can use. Initial Non Heap Size The minimum non-heap memory allocated. Committed Non Heap The total amount of committed non-heap memory. Size Used Non Heap Size The total used non-heap memory. JVM Used JVM The amount of used JVM memory, in MB. Free JVM The amount of memory available for the JVM, in MB. Max JVM Size The maximum amount of heap that can be used for memory management in GB. The amount of heap that the Java virtual machine initially requests from the operating Initial JVM Size system in MB. Committed JVM Size The total amount of committed JVM memory. Used JVM Size The total amount of used JVM memory. MARKSWEEP AND SCAVENGE MarkSweep Count The number of times garbage collection have occurred in the Marksweep GC. MarkSweep Time The time taken for garbage collection that have occurred in the Marksweep GC. Scavenge Count The number of times garbage collection have occurred in the Scavenge GC. Scavenge Time The time taken for garbage collection that have occurred in the Scavenge GC. MEMORY POOL DETAILS Maximum  (MB) The maximum pool memory allocated in MB. Initial  (MB) The pool memory initially requests from the operating system in MB. Committed  (MB) The total amount of committed pool memory. Used  (MB) The total amount of used pool memory. Utilization  (%) The percentage of used pool memory. RDD Details Parameter Description COMPILATION DETAILS Compilation Time (Mean) The time it took to compile source code text. Compilation Count The total number compilations occurred while loading the files. COMPILATION DETAILS Generated Class Size (Mean) The size of the class generated. Generated Method Size The size of each method in classes generated. (Mean) Source Code Size (Mean) The size of the compiled source code text. Generated Class Count The number of classes generated. Generated Method Count The number of methods in classes generated. The total number of source code files, that were loaded into the node for Source Code Count compilation. COUNTERS File Cache Hits The total number of file level cache hits occurred. Files Discovered The total number of files discovered.Parameter Description Hive Client Calls The total number of client calls sent to Hive for query processing. Parallel Listing Job Count The total number of jobs running in parallel. Partitions Fetched The total number of partitions fetched. Configuration Parameter Description CONFIGURATION DETAILS Worker ID The worker is referenced by its worker ID. Master URL The URL of the master node. Master Web UI URL The URL of the master node''s Web UI. Total Memory The total memory allocated and available for the particular Worker node. Network Policy Server (Radius Server) Monitoring Network Policy Server (Radius Server) - An Overview Network Policy Server (NPS) is the Microsoft implementation of a Remote Authentication Dial-in User Service (RADIUS) server and proxy. As a RADIUS server, NPS performs authentication, authorization, and accounting for wireless, authenticating switch, and remote access dial-up and virtual private network (VPN) connections. NPS allows you to centrally configure and manage network access authentication, authorization, and accounting. NPS can be implemented as RADIUS Server or RADIUS Proxy or both. RADIUS Server: NPS performs centralized authentication, authorization, and accounting for wireless, authenticating switch, remote access dial-up and virtual private network (VPN) connections. When you use NPS as a RADIUS server, you configure network access servers, such as wireless access points and VPN servers, as RADIUS clients in NPS. You also configure network policies that NPS uses to authorize connection requests, and you can configure RADIUS accounting so that NPS logs accounting information to log files on the local hard disk or in a Microsoft SQL Server database. RADIUS Proxy: When you use NPS as a RADIUS proxy, you configure connection request policies that tell the NPS which connection requests to forward to other RADIUS servers and to which RADIUS servers you want to forward connection requests. You can also configure NPS to forward accounting data to be logged by one or more computers in a remote RADIUS server group. Creating a new NPS Radius server monitor Prerequisites for monitoring NPS Radius server metrics: Click here Using the REST API to add a new NPS Radius server monitor: Click here To create a new NPS Radius server monitor, follow the steps given below: Go to New Monitor and click on Add New Monitor link. Select Network Policy Server (Radius Server) under Services category. Enter the Display name of the monitor to be created. Enter the Hostname of the host where Network Policy Server runs. Choose the Roles that you want to monitor in the server. (Radius Server and Radius Proxy) Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. Enter the polling interval time in minutes. If you are adding a new monitor from an Admin Server, select a Managed Server. Choose the Monitor Group from the combo box with which you want to associate NPS Radius server monitor (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers NPS Radius server from the network and starts monitoring them. Monitored ParametersGo to the Monitors Category View by clicking the Monitors tab. Click on Network Policy Server (Radius Server) under the Services table. Displayed is the Network Policy Server (Radius Server) bulk configuration view distributed into three tabs: Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view tab enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the NPS Radius server monitor dashboard. It has 3 tabs - Performance Overview Radius Server Radius Proxy Performance Overview Parameter Description SYSTEM MONITORS CPU Utilization Amount of CPU utilized by the NPS Radius server (in percentage). Memory Utilization Amount of memory utilized by the NPS Radius server (in percentage). POLICY ENGINE The time interval between the most recent request to the policy engine and its Last Round Trip Time response (in ms). Matched Remote Access The average number of remote access policies that have been matched per Policies/sec second. The number of requests that have entered the policy engine but have not yet Pending Requests completed the process. Network Interface Name Name of the network interface. Speed Speed of the network interface (in MBps). Input Traffic Rate at which data is received by the network interface (in MBps). Output Traffic Rate at which data is transmitted from the network interface (in MBps). Services Display Name Name of the service. (Network Policy Server or Active Directory Domain Service) Start Mode Indicates the start mode of the service. State Indicates the status of the service. Radius Server Parameter Description ACCOUNTING Server - Accounting The average number of RADIUS Accounting-Requests received per second on the Requests/sec accounting port. Server - Accounting The average number of RADIUS Accounting-Responses sent per second. Responses/sec AUTHENTICATION Server - Access The average number of RADIUS Access-Request packets sent per second. Requests/sec Server - Access The average number of RADIUS Access-Challenge packets sent per second. Challenges/sec Server - Access The average number of RADIUS Access-Accept packets sent per second. Accepts/sec Server - Access The average number of RADIUS Access-Reject packets sent per second. Rejects/secACCOUNTING FAILURES Server Accounting - Bad The average number of RADIUS packets per second that contain an invalid Message Authenticators / Sec Authenticator attribute. Server Accounting - The average number of incoming packets per second that are silently discarded for a Dropped Packets / Sec reason other than "malformed", "invalid Message Authenticator", or "unknown type". Server Accounting - The average number of RADIUS packets from unknown clients or remote RADIUS Invalid Requests / Sec servers received per second. Server Accounting - Malformed Packets / The average number of packets containing malformed data received per second. Sec Server Accounting - The average number of unknown type (non-RADIUS) packets received per second. Unknown Type / Sec AUTHENTICATION FAILURES Server Authentication - The average number of RADIUS packets per second that contain an invalid Message Bad Authenticators / Authenticator attribute. Sec Server Authentication - The average number of incoming packets per second that are silently discarded for a Dropped Packets / Sec reason other than "malformed", "invalid Message Authenticator", or "unknown type". Server Authentication - The average number of RADIUS packets from unknown clients or remote RADIUS Invalid Requests / Sec servers received per second. Server Authentication - Malformed Packets / The average number of packets containing malformed data received per second. Sec Server Authentication - The average number of unknown type (non-RADIUS) packets received per second. Unknown Type / Sec Radius Proxy Parameter Description ACCOUNTING Proxy - Accounting The average number of RADIUS Accounting-Request packets sent per second to the Requests/sec accounting port. Proxy - Accounting The average number of RADIUS Accounting-Response packets received per second on Responses/sec the accounting port. AUTHENTICATION Proxy - Access The average number of RADIUS Access-Request packets per second sent to this server. Requests/sec Proxy - Access The average number of RADIUS Access-Challenge packets per second received from Challenges/sec this server. Proxy - Access The average number of RADIUS Access-Accept packets per second received from this Accepts/sec server. Proxy - Access The average number of RADIUS Access-Reject packets per second received from this Rejects/sec server. ACCOUNTING FAILURES Proxy Accounting - Bad The average number of RADIUS packets per second that contain an invalid Message Authenticators / Sec Authenticator attribute. Proxy Accounting - The average number of incoming packets per second that are silently discarded for a Dropped Packets / Sec reason other than "malformed", "invalid Message Authenticator", or "unknown type". Proxy Accounting - The average number of packets per second received from unknown addresses. Invalid Addresses / Sec Proxy Accounting - Malformed Packets / The average number of packets containing malformed data received per second. Sec Proxy Accounting - The average number of request timeouts per second to this server. Request Timeouts / Sec Proxy Accounting - The average number of requests retransmitted per second to this server. Retransmissions / SecProxy Accounting - The average number of unknown type (non-RADIUS) packets received per second. Unknown Type / Sec AUTHENTICATION FAILURES Proxy Authentication - The average number of RADIUS packets per second that contain an invalid Message Bad Authenticators / Authenticator attribute. Sec Proxy Authentication - The average number of incoming packets per second that are silently discarded for a Dropped Packets / Sec reason other than "malformed", "invalid Message Authenticator", or "unknown type". Proxy Authentication - The average number of packets per second received from unknown addresses. Invalid Addresses / Sec Proxy Authentication - Malformed Packets / The average number of packets containing malformed data received per second. Sec Proxy Authentication - The average number of request timeouts per second to this server. Request Timeouts / Sec Proxy Authentication - The average number of requests retransmitted per second to this server. Retransmissions / Sec Proxy Authentication - The average number of unknown type (non-RADIUS) packets received per second. Unknown Type / Sec Istio Monitoring Overview Creating a new Istio monitor Monitored Parameters Overview Istio is an open source independent service mesh that provides the fundamentals you need to successfully run a distributed microservice architecture. As organizations increasingly adopt cloud platforms, developers have to architect for portability using microservices, while operators have to manage large distributed deployments that span hybrid and multi-cloud deployments. Istio reduces complexity of managing microservice deployments by providing a uniform way to secure, connect, and monitor microservices. Creating a new Istio monitor Prerequisites for monitoring Istio metrics: Click here Using the REST API to add a new Istio monitor: Click here Follow the steps given below to create a new Istio monitor: Click on New Monitor link. Select Istio under Services category. Specify the Display Name of the Istio server. Enter the Cluster Host Name/IP address of the server where Istio is running. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. Check the box to enable Public Key Authentication (Supported for SSH2 only), the SSH Key for SSH authentication. Specify the command prompt value, which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. Enter the SSH port. Default SSH port used is 22. Specify the Timeout in seconds. Default value is 40 seconds. Specify the Polling Interval in minutes. Choose the Monitor Group with which you want to associate the Istio to, from the combo box (optional). You can choose multiple groups to associate your monitor. Click Add Monitor(s). This discovers Istio from the network and starts monitoring it. Monitored Parameters Go to the Monitors Category View by clicking the Monitors tab. Click on Istio under the Services table. Displayed is the Istio bulk configuration view distributed into three tabs:Availability tab gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view enables you to perform bulk admin configurations. On clicking a monitor from the list, you''ll be taken to the Istio monitor dashboard. It has 8 tabs - Overview Citadel Galley Mixer * Pilot Go Stats Processes Services Note: Tabs/Metrics marked with an * will be shown only for Istio versions below 1.5.0. Overview Parameter Description ISTIO DETAILS Namespace Namespace of the Istio server. Status Status of the Istio namespace. (Active or Inactive) No. of Istio Pods Number of pods running under Istio namespace. Version Version of the Istio namespace. ISTIO COMPONENT DETAILS * Citadel Count Number of Citadel instances running per component. Galley Count Number of Galley instances running per component. Mixer Count Number of Mixer instances running per component. Pilot Count Number of Pilot instances running per component. ISTIOD COMPONENT DETAILS Istiod count Number of instances (replicas) running per component. Istio Pod Details Pod Name Name of Istio pod. Pod Type Type of the Istio pod. Pod status Status of the Istio pod. Deployed Node Node (host) of the deployed Istio pod. ISTIO MCP RECONNECTIONS Avg. sink reconnections Number of times the sink has reconnected. ISTIO MCP RECEIVE FAILURES Receive Failures in Source Number of mesh connection receive failures in the source. ISTIO MCP RECEIVED ACKS Request acks. received by source No. of request acknowledgments received by the source. Citadel Parameter Description Citadel Certificate Details Pod Name Name of Istio pod. Certificates created for service account Number of certificates created for service account creation. creationRoot Cert. Expiry Date and time at which the root certificate will expire. Days to expire Number of days remaining for the certificate to expire. Number of Certificate Signing Requests (CSR) made by the CSR Count certificate. gRPC Response Handled gRPC Code Error status codes raised by the gRPC. Response Handled Number of response types handled by the gRPC. Galley Parameter Description Galley Instances * Instance URL The URL of the instance. Instances per URL Number of instances running per URL. Webhook Configuration and Validation Details Pod Name Name of Istio pod. Webhook Cert. Updates Number of Webhook certificate updates received. Config. loads Number of Webhook configuration loads tried. Config. updates Number of Webhook configuration updates applied. Config. errors Number of Webhook configuration errors obtained while applying. Passed Validation Number of user configuration validation that has been passed. Failed Validation Number of user configuration validation that has been failed. Galley Runtime Details Pod Name Name of Istio pod. Events processed Number of events that have been processed. Timer Resets Number of times the timer has been reset. Successful Event Handles Number of times a Kubernetes source has successfully handled an event. OnChange called Number of configuration changes called by a Galley strategy. Snapshots published Number of snapshots published by a Galley strategy. Mixer * Parameter Description Mixer Configurations * Pod Name Name of Istio pod. Number of known adapters encountered during processing of the adapter info Known Adapter Configs. configuration. Number of known instance encountered during processing of the instance Known Instance Configs. configuration. Known Rule Configs. Number of known rules encountered during processing of the rule configuration. Number of known template encountered during processing of the template Known Template Config. configuration. Number of known handler encountered during processing of the handler Known Handler Configs. configuration. Mixer Config. Errors * Pod Name Name of Istio pod. Adapter Config. Errors Number of errors encountered during processing of the adapter info configuration. Instance Config. Errors Number of errors encountered during processing of the instance configuration. Template Config. Errors Number of errors encountered during processing of the template configuration. Reused Handlers Number of handlers that were reused. Handler Validation Errors Number of errors encountered because handler validation returned error.Mixer Handlers * Pod Name Name of Istio pod. Total Mixer Handler Total number of Mixer handler daemons available. Daemons Handlers failed at creation Number of handlers that were failed at creation. Handlers failed at closing Number of handlers that were failed at closing. Newly Created Handlers Number of handlers that were newly created. Reused Handlers Number of handlers that were reused. Pilot Parameter Description Inbound Listener Conflict Details Pod Name Name of Istio pod. Inbound Listener Conflicts Number of inbound port conflicts found. Outbound Listener Conflict Details Pod Name Name of Istio pod. HTTP over current TCP Number of conflicting wildcard HTTP listeners with current wildcard TCP listener. HTTP over HTTPS Number of conflicting HTTP listeners with well-known HTTPS ports. TCP over current HTTP Number of conflicting wildcard TCP listeners with current wildcard HTTP listener. TCP over current TCP Number of conflicting TCP listeners with current TCP listener. Pilot Service Details Pod Name Name of Istio pod. Pilot services known Number of services known to Pilot. Virtual services known Number of virtual services known to Pilot. Services with duplicated Number of virtual services with duplicated domains. domains Endpoints Connected Number of endpoints connected to Pilot using xDS protocol. using XDS PILOT XDS PUSHES Cluster Discovery Service Number of configuration pushes for Cluster discovery services. Endpoint Discovery Number of configuration pushes for Endpoint discovery services. Service Listener Discovery Service Number of configuration pushes for Listener discovery services. Route Discovery Service Number of configuration pushes for Route discovery services. AVG PROXY CONVERGENCE DELAY Avg. delay between Avg. delay between a configuration change and a proxy receiving all required config. change configuration (in milliseconds). Clusters and Endpoint Details Pod Name Name of Istio pod. Duplicate Envoy Clusters Number of Duplicate envoy clusters caused by service entries with same host name. Cluster without instances Number of clusters without instances. Unready endpoints Number of endpoints found in unready state. Go Stats Parameter Description Go Memory Details Pod Name Name of Istio pod. Allocated Memory Amount of memory allocated for an Istio pod (in MB). Heap Available Amount of heap memory available for use (in MB).Heap In Use Amount of heap memory currently in use (in MB). Cache Available Amount of cache memory available for use (in KB). Cache In Use Amount of cache memory currently in use (in KB). Go Routines Number of Go Routines that are running. Go Threads Number of OS Threads that are created. Memory used for GC Amount of memory used for Garbage Collection (in MB) Memory targeted for next GC Amount of memory targeted for next Garbage Collection (in MB) Last Garbage Collection Date and time at which Garbage Collection was last performed. Processes Parameter Description Process Details Pod Name Name of Istio pod. Opened File Descriptors Number of open file descriptors in use. Maximum File Descriptors Maximum number of file descriptors available. Free File Descriptors Number of file descriptors that are unused. Virtual Memory Size Amount of virtual memory available (in MB). Process Start Time Date and time at which the process was started. Total Running days Total number of the days for which the process was running. Services Parameter Description Incoming Traffic Details Workload name Name of the workload. Request count Number of requests received between two intervals. Failed requests Number of failed requests received by the workload. Avg. Request size Avg. size of request received by the workload (in KB). Avg. Response size Avg. size of response sent by a workload (in KB). Avg. Request duration Avg. duration between a request and response (in seconds). Alarms What is an Alarm? Alarms are notifications generated based on some condition or criteria, helping to detect problems when any of the servers running in the network is experiencing it. This improves the fault management ensuring productive application monitoring There are three severity levels for the Alarms and they are Critical Warning Clear Alarms are generated for the following type of attributes: Availability of a Monitor. When the availability of the Monitor is down, the severity is represented as and when it is up, the severity is represented as . Health of a Monitor. Attributes of a Monitor. Alarms will be generated, if the threshold profile condition set for these attributes is met. Note:The availability of a Monitor requires no configurations from your side. Alarms are also generated based on dependencies configured to the attributes. Refer to Configuring Dependencies section for more details. The Alarms screen displays a table provides the following: Severity - Click on the severity of an alarm to view a Root Cause Analysis pop-up window. Alarm Message - Click on the Alarm Message for individual alarms to display the Alarm Details. Monitor Name - Click on the monitor name to view the monitor details. Monitor Type - Displays the monitor type. Technician - The technician who attended on the Alarm. Click on the technician name to pick up the alarm. Date / Time - The Date and Time when the alarm was added. You can generate alarms and perform actions based on your configuration. Go through the following sections to know more about the Alarms tab: Filtering Alarms Creating Threshold Profile Creating Actions Associating Threshold and Action with Attributes Alarm Escalation Bulk Alarm Configuration Configuring Dependencies and Alarm Rules Configuring Consecutive Polls Search Alarm Views: This is an option to view the alarms based on a particular Monitor Group or Monitor Type by selecting them from the respective combo box. Alarms for traps: Traps received via SNMP Trap Listener can be seen here. Also, the other unsolicitated traps can be viewed here. JMX Notifications: You can view the JMX Notifications received. Note: Bulk Alarms Configuration is also possible. Refer Bulk Alarm Configuration Filtering Alarms Go to the Alarms Tab to view all the alarms configured in Applications Manager along with their severity, type, date and the technician to whom the alarm is assigned. You can sort the alarms by clicking on the parameter type at the top of the table. You can view all alarms or filter the Critical , Warning and Clear alarms or sort between Configured Traps, Unsolicited Traps or JMX Notification by clicking on the respective buttons. You can also fillter alarms by: Alarm Actions You can perform bulk alarm actions by checking the check-boxes of the alarms and selecting the action you require from the Alarm Actions drop-down menu at the top of the table. You can perform actions like: Set the alarm as clear. Acknowledge the alarm. Assign a Technician to take care of the alarm. Generate a PDF report showing the History Report of the alarm. Generate an Excel report showing the History Report of the alarm. Selected TimeYou can filter alarms to show alarms generated in a specific period or a specific day by selecting the time you require from the Select Time drop-down menu at the top of the table. You can filter alarms generated by Last One Hour, Last 2 hours, Last 4 hours, Last 6 hours, Last 12 hours, Last 24 hours, Today or Yesterday Selected Monitor Group You can filter alarms to show only alarms associated with monitor groups or only with monitors. You can do this by selecting the option you require from the Select Monitor Group drop-down menu at the top of the table. Selected Monitor Type You can filter alarms to show only alarms associated with a particulat monitor type. Select the monitor type that you require from the Select Monitor Type drop-down menu at the top of the table and click Go.   Search You can search through alarms by clicking the search button at the top of the alarms table. When you click the button text boxes appear in the alarms table under the parameter names. You can search for alarms by typing the alarm message, alarm name, type, or technician to whom the alarm is assigned and then clickingSubmit. Alarm Details Under Alarms tab, the alarm details for each alarm is displayed by clicking on the ''Alarm Message'' for individual alarms. Under the Alarm Details page, you can view: The Monitor to which the alarm is associated and an "At a Glance Report". The Attribute for which the alarm is configured. The Time of Creation of the alarm. The Last Updated Time of the alarm. The Current & Previous Severity of the alarm Dependency Rule Configuration The technician who attended on the Alarm. The Root Cause Analysis (RCA) messages Custom Fields Annotations can be added to describe the details of the alarm. The Anomaly Dashboard for troubleshooting. Root Cause Analysis (RCA) Based on the threshold and dependencies associated with the attributes of Monitor, the severity of the Monitor and Monitor Group is determined. You can view the Root Cause Analysis report by clicking the status icon of the attributes (Refer to the Icon Representation section to know the different status icons). Expand the nodes to view the actual cause of the problem.  The following are the details that can be viewed in Alarms page. Options Description Lists all the alarms based on Alarm Views where there are options to choose a particular or all All Monitor Groups and Monitor Types. Last One Lists all the alarms generated for the last one hour. Hour Last One Lists all the alarms generated for the last one day. Day Note: Check out the blog post to know more about RCA Messages.Alarms Health and Availability History Alarm history gives you the history of the changes in the status of Health and Availability of an alarm over a period of one week. The history table displays: Severity: Indicates the severity status of the monitor based on its pre-defined threshold. Date/Time: Date and Time at which the alarm was generated. Message: Refers to the problem that caused the alarm. Click on the message to know more about the alarm details. Also view the Alarm History that gives you a detailed idea on generation of the alarm and its status. Monitor Name: Name of the Monitor that created the alarm. Other Attributes History Attribute history gives you the history of changes seen in the severity status of the attribute for an alarm over a period of one week. The Attributes History table displays the following information: Severity: Indicates the severity status of the attribute based on its pre-defined threshold. Date/Time: Date and Time at which the alarm was generated. Message: Refers to the problem that caused the alarm for the attribute. It comprises of detailed information on the attribute''s severity and its corresponding RCA message along with its threshold details configured. To view the attribute history details, select the monitor name and the corresponding attribute name from their respective dropdowns. Viewing and Configuring Alarms Globally through Alarm Templates The purpose of Global Alarm Configuration is that you can associate thresholds and actions to Monitors/ Monitor Groups/ Monitor Types directly rather than from their individual screens. Additionally, you can view all the thresholds and actions associated with the attributes of a Monitor Type/ Monitor Group / Monitor in a singlescreen. How to Demos: Have a look at our demo on configuring Alarms in our website. You can perform the following functions in the screen: Create and associate a threshold for an attribute by clicking ''Associate'' link. It opens the ''Configure Alarms'' page, herein you can create a new threshold or apply an existing threshold for the attribute. Edit already existing thresholds by clicking on the threshold name. Configure Alarms for: Monitors Monitor Groups Monitor Types Monitors: Select the Monitor Type from the list. Select the specific Monitor for which you want to configure alarms. Select from the list of attributes given and associate thresholds. Monitor Groups: Select the Monitor Group from the list. Select Action Type: Individual or Template. For Individual, Select the desired attributes listed for each Monitor and associate thresholds. For Template, Select Monitor Type.Select from the list of attributes given and associate thresholds. For information about "Override existing Threshold Configuration" option, see below. Monitor Types: Select the Monitor Type from the list. Select from the list of attributes given and associate thresholds. For information about "Override existing Threshold Configuration" option, see below. Known Limitations: Overriding existing Threshold Configuration. For Monitor Groups and Monitor Types, while associating thresholds, an option, "Override existing Threshold Configuration"is displayed. Checking this option will override the threshold configurations of Monitors whose thresholds were configured individually(not from templates) with the threshold configurations of the current Monitor Group/ Type. If left unchecked, the existing threshold configuration of the Monitor(s) is maintained and the new threshold configurations are applied to all other Monitors of the Group/ Type. Monitor Group templates are given priority over Monitor Type templates. For example, If a monitor of a given Monitor Type belongs to a Monitor Group and the thresholds are configured for the Monitor Group as well the Monitor Type of this monitor, the Monitor Group configurations will take precedence over Monitor Type configurations. Also if a Monitor has a preciously applied Monitor Type template and it is newly associated to a Monitor group with a Group template, the thresholds/actions of the Monitor Group template are applied to the Monitor. Configuring Thresholds when a Monitor belongs to two Monitor Groups.It is not recommended to configure two different thresholds for a given attribute of a Monitor belonging to two Monitor Groups. When tried, an error message is generated for the same. In the case where a monitor belonging to two monitor groups with different thresholds/actions configured via Monitor Group Template for the same attributes, the thresholds/actions pertaining to the Monitor group template that was first applied is maintained. Different Actions for various severities configured at Monitor / Monitor Type / Monitor Group level cannot be merged together. Any of the Monitor / Monitor Type / Monitor Group level action-severity configuration is possible. For best practices it s advisable to use separate thresholds/actions for Monitor Group/ Monitor Type template level configuration and for Monitor level configuration For more information, refer to the Associating Threshold and Action with Attributes section. Note: You can also view the Global Alarm Configuration screen by clicking ''Configure Alarms'' under Admin tab, Alarm / Action settings. Creating Threshold Profile Thresholds let you define the status of an attribute based on specific conditions. A threshold is a predefined set of values associated to an attribute, based on which an Alarm can be generated. For example, you can define a threshold to show the status of the webserver as critical, if the response time exceeds 100 seconds. Likewise, you can define a threshold to show the status as clear, if the MBean''s attribute - Active is equal to true. To define a threshold, follow the steps given below: Click New Threshold. This opens the Create New Threshold Profile screen. You can create new Threshold Profiles for Numeric, String or Float values. Select the value type from the New Threshold Profile drop-down menu. Select the Threshold Profile Type : Standard or Adaptive. Threshold Profile Type – You can select if you are creating a profile for Standard or Adaptive Thresholds: Standard Thresholds - You can set the profile for Critical, Warning or Clear severity with two conditions supported for every severity.Adaptive Thresholds - Adaptive threshold has two categories - "Baseline" and "Custom expression" : Baseline: You can set a fixed Baseline Date Range from the drop-down menu. Check the checkbox to specify Baseline as %. If the box is unchecked, you can enter hard-coded values instead of the percentage. Custom expression: Users can define their own expression from the available system options provided by the Applications Manager. Here are the Available System Variables: Use this option for Expressions Description $10D_MVA Ten Days Moving Average $30D_MVA Thirty Days Moving Average $6H_MVA Six Hours Moving Average $7D_MVA Seven Days Moving Average $LastHourValue Last Hour Average $10H_MVA Ten Hours Moving Average Specify the Threshold Name. You can set the profile for Critical, Warning or Clear severity. We provide two condition support for every severity when creating Threshold Profiles. You can set the monitored value of a particular severity to be > (greater than), < (lesser than), = (equal to), != (not equal to), <= (lesser than or equal to), >= (greater than or equal to) to a customizable Threshold Limit. You can even set multiple conditions when defining your threshold limit for each severity by clicking on the More link at the right-hand corner of the Create New Threshold Profile table. You can also specify a message that has to be appended to the alarm. By default, you can configure Critical severity, By clicking on advanced, you can configure Warning and Clear severity. Specify the number of polls that can be scheduled before reporting an error. If you do not want to generate an alarm for the very first time the threshold condition is crossed, you can set Applications Manager to examine a certain X number of polls from a Y number of consecutive polls (both numbers are customizable), before generating an alarm. For e.g., If you want an email alarm to be generated only if the CPU Disk utilization is above 100%, consecutively for more than three polls out of five polls, then you can configure the number of polls to be examined out of a number consecutive polls before generating an alarm. By default, it takes the value from Global Settings. Refer Configuring Consecutive Polls for setting configurations for individual monitors. If you wish to apply the threshold only during specific time periods in a day/week, enable the Apply Threshold based on Business Hours option and select the Business Hour during which the threshold has to be applied. Click Create Threshold Profile to add the threshold after defining all the conditions. Choose the View Threshold option available on the top menu to view the threshold. The Threshold Profile screen lists all the default thresholds and newly created thresholds. Note: You can also edit the threshold created using the edit ( ) icon. The thresholds thus defined can be associated with the attributes for determining the status of the attributes of the Monitor Group. You can also associate thresholds and actions directly through Global Alarm Configuration instead of the individual Monitor screen.   Adaptive Thresholds You can use New Threshold Profiles to apply Adaptive thresholds broadly across targets within your environment. For a Standard Threshold Profile, raw data will be assessed to the threshold limit and alert will be generated in every poll. For Anomaly Threshold Profiles, hourly average data is compared with the past archived data (this should be configured by the user). Adaptive thresholds are a combination of both standard and anomaly thresholds and has two categories - Baseline and Custom expression. Adaptive Baseline Threshold compares raw data values with past archived data at every poll. Adaptive Custom Expression contains some configured expressions (Need to configure by the user from UI) and it calculates the value for that expression and compares it with raw data at every poll. Refer to Associating Threshold and Action with Attributes for more details.  Threshold & Action Profile CSVApplications Manager gives you the ability to create a Threshold & Action profile report in .csv format. This report shows the threshold creation time, Monitor Group, Type, Threshold Profile, Threshold Status, Critical, Warning, and Clear Actions and more for catagorized and uncatagorized monitors. Here''s how you can create the report: Click on View Threshold Profiles under the Threshold Profiles tab. Click the Threshold & Action Profile CSV button at the right- corner of the Threshold Details page. Select the checkbox for the kind of thresholds you want to create a report for. You can create a report for all thresholds, particular groups or unassociated monitors alone. Click Create CSV. A notification appears at the top of the page informing you that the "Threshold & Action profile report was successfully created. Download" Click download to download the CSV file. Threshold Profiles in the Enterprise Edition You can create Threshold Profiles from the Admin Server in Applications Manager, the same as in the Professional Edition, and the profiles created automatically syncs with the Managed Servers. However, although these profiles can only be used and cannot be edited from the Managed Servers. Anomaly Detection Overview How does Anomaly Detection Work? Associating Anomaly Profile Anomaly Dashboard Anomaly detection using Machine Learning Overview Anomaly detection helps you know if there is gradual performance degradation by defining Anomaly Profiles on performance metrics. By creating Anomaly profiles, you can define rules wherein the current data is compared with previously reported best data. For eg., if the load on the server increases over a period of time, response time will gradually be affected. By using Anomaly detection, you would be able to detect this performance problem. How does Anomaly Detection Work? Anomaly profiles can be created based on: Baseline Values Custom Expressions Anomaly Dashboard: This dashboard facilitates viewing through all the performance metrics and helps in easy troubleshooting.Baseline Values Anomaly happens when the current set of values don''t conform to the baseline range values. Current Attribute values are compared against the reported data in a particular week [baseline week]. Define baseline- Baseline week can be calculated based on Fixed Value: The week where the system has performed very well [there has been less number of alarms] will be chosen as reference/ baseline data range. After choosing the week for baseline comparison, then each day''s value will be compared with the corresponding day of the baseline week. For eg. If you choose week 1 of August as baseline week, then every Monday''s data will be compared with August week1''s Monday values. Another usecase can be for festive time load. Anomaly profiles can be created for Christmas Holiday weekend and the performance metrics can be compared to know how effectively the system has performed. Moving Value: Instead of fixing a baseline week, Previous week''s reported data can be selected for comparison. Here, the baseline value will be changing according to the previous week''s data. Specify the anomaly criteria - Set the upper limit and lower limit range to compare the current data with the baseline values. Baseline data range will be formed based on the upper limit and lower limit values .These values can be used as % or as hard coded values. Eg, if the baseline value is 70 and if you had provided 10% as criteria for both upper and lower limits then the base line range will be between 64 to 77. Likewise if you had provided the criteria as 10 then the range will be between 60 to 80. Working- After comparing with the baseline data, if the current hour value does not come between the upper limit and lower limit configured, then alarms will be generated. Lets set Aug 1st week of 2009 as the baseline data range. Anomaly range is defined as 10% upper limit and 10% lower limit. The deviation is calculated based on hourly values. So at 11 A.M, Tuesday of the Second Week, the Memory Utilization value will be compared with the values present at 11 AM, Tuesday of the Ist week. If the value deviates from the upper limit or lower limit, then an alarm will be generated. After creating Anomaly profile, you have to associate the anomaly profile to the concerned attributes. To create Anomaly Profile based on baseline values: Click on Anomaly Profile link. Click on New Profile In the Anomaly profile page, Give the Name for the new Anomaly profile you want to create. For baseline calculation, select the Baseline data range: You can choose between fixed baseline value [the appropriate week] or moving baseline value which is based on previous week''s data. Define the allowed deviation from baseline. Alarms can be generated either based on percentage of upper limit, lower limit value or straightaway on hard coded comparison values. The generated Alarm will be cleared if the value falls in the baseline range [that is checked every hour]. Alarm can be critical or warning. Select the comparison method. The recommended method would be to Compare last hour value directly with baseline value. Here, While comparing, hourly value will be taken into consideration and compared with the baseline valuedirectly.For eg: Say if current time is 10:00 AM , Monday and if baseline date range is week 2. Then week 2 , Monday 10:00 AM value will be taken for comparison and upper and lower limits will be applied as per the user configuration. The other method would be to Compare values based on the corresponding difference with the previous hour. While comparing, the corresponding difference in hourly values would be taken into consideration. For eg: If current time is 10:00 AM, we will take the difference between the values at 10:00 AM and 9:00 AM for comparison. A similar approach will be used for getting the baseline values. Finally, click ''Create Anomaly profile''. Custom Expressions Anomaly is detected when current data doesn''t conform to the user defined rules [based on system variables]. For eg., you can create a rule like Anomaly is to be detected when the current Last Hour Average Value is greater than twice the Six Hours Moving Average Value. Critical and Warning alarms can be set accordingly. The system variables that can be used for forming custom expressions are: Expressions Meaning $10D_MVA Ten Days Moving Average $LastHourValue Last Hour Average $6H_MVA Six Hours Moving Average $30D_MVA Thirty Days Moving Average $10H_MVA Ten Hours Moving Average $7D_MVA Seven Days Moving Average To Create Anomaly Profile based on Custom Expressions: After choosing to create anomaly profile based on Custom Expressions, enter the profile name for the new anomaly profile. Critical Alarm : Create an expression like $LastHourValue > 10*$7D_MVA+(5+$30D_MVA). Then select the critical alarm from dropdown. Warning Alarm : Create an expression like $LastHourValue <= 25*$6H_MVA+(5+$10D_MVA). Then select the warning alarm from dropdown Save the Anomaly Profile. Associating Anomaly Profile To associate anomaly profile, follow the steps given below: Go to the respective monitor details page. Choose the attributes for which you want to configure alarms. Click on Configure Alarms link. Threshold Details and Anomaly Details will be listed. Click on Anomaly Details tab. From the drop down box, Choose the appropriate attributes and associate them to the corresponding anomaly profiles. Save the alarm configuration Note: A particular monitor''s health will be made critical and EMail notification will be sent only if the user had associated EMail action to the health of the dependant attribute. Anomaly Dashboard This dashboard facilitates viewing through all the performance metrics. It helps the user to intuitively scan through the hundreds of performance metrics with ease. If the health of any attribute / Monitor Group / Monitor has turned critical or if the availability is down, click on the icon for seeing the root cause analysis. Click on Use Anomaly Dashboard for troubleshooting to access the Anomaly Dashboard. You can access Anomaly Dashboard from Alarms tab too. In Alarms tab, all alarms whose health have turned critical are listed.Click on alarm message, it goes to Alarm Details page. In Alarm history table, you can find the Anomaly Dashboard icon In Anomaly Dashboard, You can choose to list only critical monitors or all monitors. Note: Critical state is based on the Anomaly profile associated to the attribute of the monitor. Base Metrics shows response time details and all other metrics by using current time but you can customize it using the change link. You can change the attribute and time. Note: The chosen time is used in all other calculation such as last hour value, 12 hour average etc. Graphs: Last polled is last hour value. 12 hour is last 12 hour average values in graphical format [ SparkSeries]. 7day segmented hour is shown as bar graph [Sparkline]. You can click through the columns to view the detailed reports. After associating anomaly profile to an attribute of a monitor, if the profile rule is violated, the monitor becomes critical and background of 12 hour graph will be red in color. By clicking on the column, you can see the detailed report like when anomaly value was reached, etc. Anomaly detection using Machine Learning Applications Manager allows you to configure alarms by associating thresholds based on anomaly detection with the help of Machine Learning. In ''Configure Alarms'' page, you can choose to associate thresholds using Machine Learning techniques to detect anomalies. It makes use of RPCA algorithm to determine the anomaly which helps in identifying sudden or unusual spikes in the data immediately upon occurrence and triggers alerts accordingly. Once enabled and configured, a history of data is collected for the attribute of the monitor to understand its characteristic and behavior. After a few hours of data collection, it is then compared with the current data to check if there are any abnormalities and raises an alarm in case of anomalies. If an abnormal value is detected for the attribute, alerts would be generated with ''Critical'' severity and will be shown in the RCA message for that attribute. The RCA message would contain the anomaly details for the attribute that caused the alarm by displaying the amount of deviation found between the expected and actual values. In case the collected value does not have any anomalies, then the alarms would be cleared with ''Clear'' severity. Note: Machine Learning based anomaly detection is applicable only to Numeric attributes and are not supported for the following types of attributes: Health Availability String attributes Configuration Numeric attributes Configuration String attributes See Also: Associating Threshold and Action with Attributes Creating Actions Applications Manager provides the flexibility in fault management by triggering actions, such as sending e-mail, SMS, trap, and executing a command, to notify you of the alarms generated while monitoring the applications. These corrective actions make fault detection easier and faster enhancing Monitor Group management. To trigger such corrective actions, you should have defined the action, which can then be associated with an attribute. Applications manager supports the following actions: Sending E-mail Sending SMS Executing Program Sending Trap Execute MBean Operation Log a Ticket Perform Java Action Cloud ActionVirtual Machine Action Replaceable Tags Container Actions SQL Job Action Webhook/REST API Action Note: Have a look at Creating actions - How to Demos in website. These special characters [ - % '' " !] will not be accepted in Action Names. Sending E-mail This action will send e-mail to the specified persons in the event of an alarm. To create an e-mail action, follow the steps given below: Click the New Action link at the top menu. It opens Send Email screen, by default. Note: If the mail server is not configured already, you will see the Configure Mail Server screen initially. Specify mail server details and continue to configure Send E-mail action. Specify the following details: Any display name for the action. The from and to e-mail addresses. The subject and message of the e-mail. Choose the format of the message: HTML, Plain Text or Both. Choose whether to append the alarm information generated by Applications Manager to the Email. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click Create Action to finish. This will list the e-mail action name and its details along with the other actions configured. Click Add New for creating more e-mail actions or Delete (on selecting the respective action''s check box) to delete the action. After creating an e-mail action, you can edit or execute that action. These two tasks can be performed from the View Actions page. To edit the action, click the Edit [ ] icon. You can also have a trial execution of the action. To do so, click the Execute [ ] icon of that action. Note: The subject and message of the e-mail action can be further enhanced by using Replaceable Tags. Further, you can edit the Email template by changing file present in the /working/conf directory. Restart Applications Manager on changing the file. E-mail Action in the Enterprise Edition You can create e-mail actions from the Admin Server in Applications Manager, the same as in the Professional Edition, and the actions created automatically sync with the Managed Servers. However, although these actions can be used in the Managed Servers. They cannot be edited from the Managed Servers. Sending SMS This action can be used to send SMS (Short Message Service) to specific users in the event of the alarm. To create an SMS action, follow the steps given below: Select the New Action link from the top menu. Click Send SMS from the Actions menu in the left frame and specify the following details:Any display name for the action. Choose the mode of SMS - Either through EMail or through Modem. In case of EMail, enter the from and to addresses. In case of Modem (Available in Windows only), enter the mobile number to which the message has to be sent. You should have configured the SMS Server beforehand to use this facility. To know more about sending SMS through modem, refer Admin - Configure SMS Server The message for the SMS. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click Create Action to finish. This will list the SMS action name and its details along with the other actions configured. Click Add New for creating more SMS actions or Delete (on selecting the respective action''s check box) to delete the action. Also refer "Add complete Information to SMS" section under Admin > Action-Alarm-Settings. After creating an SMS action, you can edit or execute that action. These two tasks can be performed from the "View Actions" page. To edit the action, click the Edit [ ]icon. You can also have a trial execution of the action. To do so, click the Execute [ ] icon of that action. Note: The Message of the SMS action can be further enhanced by using Replaceable Tags Executing Program You can configure Applications Manager to automatically trigger scripts/programs/server commands when an alarm is generated. This will help minimize manual intervention in resolving system/application issues. This document covers: Configuring Execute Program Action View/Edit Execute Program Action Execute Program Usage Securing Execute Program Action Configuring Execute Program Action To execute a program, follow these steps: Select the New Action link from the top menu. Click Execute Program from the Actions in the left frame and specify the following details: Enter the Display Name for the action. Choose whether the program to be executed is from the local server or from a remote server. If the program is in a remote server, specify the Target Hosts on which these actions are to be executed. There are three options available here: Auto-select Hosts: This option will automatically detect and trigger Execute Program action based on the associated monitor. For example, if the action is associated with a host, the action will be triggered for that particular host. If the action is associated with a Tomcat monitor, this action will be triggered for the host of the Tomcat server. Selected Hosts: This option lets you specify the exact hosts on which the action will be triggered. You can select the hosts from the ones listed. All Hosts in the selected Monitor Group: This option lets the action to be triggered on the server monitor''s hosts present in the Monitor Groups. You can select the Monitor Group from the ones listed. Additionally, you can also choose to add a new host. For configuring a new host, enter the following details - Host Name / IP Address, Execution Mode (Telnet/SSH/Powershell), User Name and Password of the host, port number (Default Telnet port no: 23, SSH port no: 22) and then specify the command promptvalue (for Telnet/SSH), which is the last character in your command prompt. Default value is $ and possible values are >, #, etc. Enter the Program to be executed. Use the Upload Files/Binaries option to upload the script file . Enter the directory path from which the script should be executed. You can use the Notify after action execution option to receive response for both success or failure conditions of an action either by selecting an existing email address or by defining a new email address using the New Action link. The Abort after field is used to specify the timeout value for the program. Specify the time after which the program should be terminated. Note: It is important to provide the required time for aborting the command execution since the alarm processing is held up by the program execution. That is, while executing the program, the command runs synchronously in the mail alarm processing thread. This will delay all the alarms, following the alarms being processed, until the program execution is completed or terminated. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click Create Action to finish. This will list the Execute Program action name and its details along with the other actions configured. View/Edit Execute Program Action You can view and edit an existing Execute Program or execute that action from Admin tab > Actions page. To edit the action, click the Edit [ ] icon. You can also have a trial execution of the action. To do so, click the Execute icon [ ] of that action. Execute Program Usage Pointers to where you can use Execute Program action Integrate a .vbs script to be executed by writing a simple .bat file. With this you can restart a remote service, reboot a machine etc. Execute custom actions like calling a python script or Java class etc. Invoke a .wav file to make some alarm noise on the server. Execute a script on a remote server. Trigger actions like cleaning up a hard disk when the usage exceeds some threshold limit. Note: Passing arguments to custom scripts can be further enhanced by using . Securing Execute Program Action Execute Program Action option is designed to help users handle application problems and let them accomplish mundane tasks quickly, allowing them to reduce the impact of outages. It helps users rectify problems easily and efficiently.  Execute Program Action has the integrated ability to run scripts (incl. Powershell scripts) and server commands based on the user privilege that runs Applications Manager. Caution must be exercised with their usage. Some additional security features built to assist users are: Only users with Administrator privilege are allowed to create or use Execute Program action. Create / Edit / Delete of Execute Program Action will be audited and details regarding the same will be available in Admin tab > Audit Logs page. An option to blacklist certain commands is available (in AppManager_Home\conf\BlackListCommands.properties file). These commands cannot be used in Execute Program Action. Details regarding the same is available here. An option is available to disable uploading of Scripts in Applications Manager under Admin tab > Server Settings > Enable file Upload.Be sure to validate the accuracy of scripts before running them and confirm if they are from a trusted source to prevent unintended script execution. Sending Trap There are some circumstances where some Manager Applications also need to be intimated about occurrence of fault in the servers or applications being monitored. In such case, the alarms can be sent as traps to the manager applications and they can be viewed by any standard SNMP Manager such as Trap Viewer, HP Openview, IBM Tivoli etc. The supported versions of SNMP Trap are SNMPv1, SNMPv2c and SNMPv3. To configure an alarm as a trap and send it as an action, follow these steps: Select the New Action link from the top menu. Click Send Trap under the Actions menu in the left frame. This opens the Create Action: Send Trap of SNMP action screen. Select the SNMP trap version (v1 / v2c / v3) from the combo box. Specify the following details: Any display name for the action. The destination or the manager application host name to which the trap has to be sent. The port number, where the manager host is running. The OID (Object Identifier) of the management object of a MIB. The community for the trap. The message, which will be sent as trap varbinds. The message can be enhanced by using Replaceable Tags. Note : Multiple Varbinds can be specified by having multiple ObjectIDs and their values as comma separated in "ObjectID" and " Message (Varbinds) " field respectively. For e.g., you can give ObjID1, ObjID2, ObjID3 in the ObjectID field to represent 3 Object IDs and correspondingly give ObjValue1, $RCAMESSAGE (the root cause message will be passed through the replaceable tag - $RCAMESSAGE), ObjValue3 etc., in the varbinds field to specify the values. ObjID1 and ObjValue1 will be passed as varbinds, same is the case with the other varbinds. Choose the Message Format (Plain Text/HTML) for the trap. For SNMP Version v3, select one of the three Security Levels: No Auth, No Priv - Messages can be sent unauthenticated and unencrypted. Enter a UserName, Context Name, and Engine ID. Auth, No Priv - Messages can be sent authenticated but unencrypted. Enter a UserName, Context Name, Engine ID, and an Authentication Password. You can select an Authentication Protocol (like MD5 or SHA) from the drop-down list. Auth, Priv - Messages can be sent authenticated and encrypted. Enter a UserName, Context Name, Engine ID, an Authentication Password, and a Privacy Password. You can select an Authentication Protocol (like MD5 or SHA) and a Privacy Protocol (like DES or AES_128) from their respective drop- down lists. Select the Generic type of trap PDU from the combo box. Specify the Enterprise OID for the trap You can also use the MIB Browser to provide the OID. In case, you want to upload a new MIB, then use the Upload Files/Binaries option. In case of SNMP v2c and v3 traps, mention the SNMP Trap OID. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click Create Action to complete the configurations. This will list the trap action name and its details along with the other actions configured. Click Add New for creating more trap actions or Delete (on selecting the respective action''s check box) to delete the action. After creating an send trap action, you can edit or execute that action. These two tasks can be performed from the "View Actions" page. To edit the action, click the Edit icon [ ]. You can also have a trial execution of the action. To do so, click the Execute icon [ ] of that action. Note: You can configure alarm actions (for eg., EMails to be sent) for unsolicited traps. Refer FAQ. Execute MBean OperationActions of type Execute MBean Operation can be created to invoke operations on MBeans of JMX Compliant Resources. The JMX compliant resources that are supported by Applications Manager are : WebLogic, WebSphere, JBoss, AdventNet RMI Adapter and JMX agents (JDK1.5 / MX4J). Creating a MBean Operation would be helpful if you want to monitor the value of any custom attribute and do any action based on its value. For Eg, When you want to shut down your JBoss server when the number of threads running in it goes above a specified value, you can add the necessary code to shutdown the server on the JBoss Montor side as a MBean operation and invoke this as a MBean Operation action from the Applications Manager. To configure an Execute MBean , follow these steps: Select the New Action link from the top menu. Click Execute MBean under the Actions menu in the left frame. This opens the Create New MBean Operation Action screen. By following a simple set of 4 steps you can create a MBean Operation. First Step : If you have a JMX compliant monitor already configured, it will be listed in the Combo box. Provide a name for the action and select any one of the resources for which you create a MBean Operation. If you donot have any monitor configured, use the link given the page to discover a new monitor. Click on the Show Domains Button to go to the next step. Secondly, The list of domains present in the agent you have selected are displayed. Select any of the Domains and click on the button Show MBeans. In the third Step, Select any one of the MBeans for which you want to create the action and click Show Operations. All the MBean Operations are listed in this screen with varying return types and arguments. Click Create Action button for the operation for which you want to create this action. A success message that you have created this action would be displayed and the newly created action will be listed under the head Execute MBean Operations Action(s) Note: You can give multiple values to the operation arguments as comma separated values. For an operation with multiple arguments, the combinations of the values supplied, can also be executed. This is done in order to ensure that we need not create separate actions to represent different combinations of argument values. For Example, if you want to create actions for the logging level of a product, the operation change logginLevel may take two arguments as, "User" and "Level". You can supply, admin and operator as values for User and debug and info for Level respectively. You can execute the operation manually by choosing any of the combinations using the "Manual Execution" option. By default the first values given will be taken to execute the action, as Admin and debug in the above example. Passing multiple values can be further enhanced by using  . After creating an MBean Operation action, you can test the execution of that action in two ways: You can have a trial execution of the action. To do so, click the Execute icon    of that action. You can also manually execute the action, click on     This opens a popup with the operation details. Select the options from the list and click Execute Actionbutton. The action would be called with the given values and return value will be given in the UI. Note: There is a link Fetch data now in the corresponding monitor details page, which will fetch the data from the server, after you have executed the action. This will help you to see the value of the custom attribute without waiting for the next polling interval. Log a Ticket This action will send a Trouble Ticket to the configured help desk, in the event of an alarm. To create a Ticket action, follow the steps given below: Select the New Action link from the top menu Click Log a Ticket under the Actions menu in the left frame. This opens the Configure Ticket Details screen Enter the name of the ticket If ServiceDesk Plus is configured, choose log a ticket action based on REST API Key or Credential. If SDP is above version 9, then REST API is recommended. If ServiceDesk Plus MSP is configured, choosing the Account and Site are mandatory in order to choose the other fields. Choose the fields to be tagged in the help desk for the tickets generated. If no fields are assigned to the ticket action, the default template for the ticket to be generated in the helpdesk will be used. For ServiceDesk Plus, If another incident template is chosen, according to the Advanced Settings "Over-write the request template with the fields selected in the action profile" the other fields are displayed or hidden.Note: If an incident template is not available in the list but has been added in ServiceDesk Plus, please make sure that the technician used to integrate has access to this template in ServiceDesk Plus console. In case if the template chosen has mandatory fields set in Servicedesk Plus, and they are different from the fields given in the form, then click on the Custom Fields - Incident template and provide the field name as given in Servicedesk Plus and the value to be added. If the fields Category, Sub Category, Item, Group or Technician is made mandatory then it is recommended to set the Advanced Settings "Over-write the request template with the fields selected in the action profile" as Yes, and to use the values from the form itself. For ServiceNow, additional fields to be sent to ServiceNow in the ticket generated can be added using the Custom Fields - Incident template. If Caller ID needs to be set in the form, please add the Name with the full name of the user that you need to assign the ticket to. Enter the title of the ticket, the title supports the usage of replaceable tags. You can add alarm variables to the title, by selecting those from the combo box Give the description of the mail content. The description also supports passing alarm variables as replaceable tags Choose the format of the message: HTML, Plain Text, or Both You can choose whether to append the alarm message that was generated, to the trouble ticket. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click the Log a Ticket button to finish logging and creating the Ticket action. Once the ticket is created, you can test its execution by clicking the Execute action [ ] button from the list view. Note: If the Create a new ticket action page displays an error message that Applications Manager is unable to connect to ServiceDesk Plus, please check whether the technician has sufficient privilege in Servicedesk Plus console. In case this does not resolve the issue, please create a Support Information File and upload it using the Create Support file option in the Support tab. Perform Java Action This action will perform Java actions such as generating thread dump, heap dump or garbage collection in the event of an alarm. To create a Java action, follow the steps given below: Select the Java Heap Dump/Thread Dump/GC option from the Actions menu. Enter the Display Name of the action. Choose the Action Type to be performed in the event of an alarm. You can choose either ''Thread Dump'', ''Heap Dump'' or ''Perform GC'' option. If you choose the ''Thread Dump'' option, specify the Number of thread dumps to be performed and the Delay between thread dumps in seconds. If you choose the ''Heap Dump'' option, specify the Number of heap dumps to be performed and the Delay between heap dumps in seconds. If you choose the ''Perform GC'' option, specify the Number of GCs to be performed and the Delay between GCs in seconds. Select the email action to be associated with this Java action using Associate Email Action. You can either select an existing email action from the drop-down box or create a new email action by clicking the ''New Action'' link. Select Target JRE for this action from the drop-down box. The available options include Auto-select JRE, All JREs in the selected monitor group, Specific host and Specific JRE. If you select Auto-select JRE, Applications Manager will automatically detect and trigger Java actions based on the associated monitor. For example, if the action is associated with a host, this will trigger thread dump for the JREs available in the host. Or if the action is associated with a Tomcat/JRE monitor, this will trigger thread dump for the JREs present in the host of Tomcat server or JRE. If you select All JREs in the selected monitor group, this will trigger java actions for all the JREs present in that monitor group. If you select Specific host option, this will trigger java actions for all the JREs present in the selected host. Selecting a Specific JRE will trigger java actions for that JRE.If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click the Create Action button to finish creating the Java action. After creating the Java action, you can test its execution by clicking the Execute icon   of that action. Perform Cloud Action This action can be used to start/stop/restart Cloud resources (EC2 instances/Azure VMs) in the event of an alarm. To create a Cloud action, follow the steps given below: Select the Cloud Action option from the Actions menu. Enter the Display Name of the action. Select the Monitor Type on which the action has to be performed in the event of an alarm. You can choose either Amazon or Azure. Choose the Action Type to be performed in the event of an alarm. You can choose to either Start, Stop, or Restart resources. (Instances/VMs) Use the Select Target Resource option to associate the action to specific resource(s) (EC2 instances/Azure VMs). There are three ways of selecting the target resource(s). All resources in the selected monitor group: This triggers the action for all the resources (EC2 instances/Azure VMs) present in the selected monitor group. All resources in the selected host monitor: Trigger Cloud actions for all the resources (EC2 Instances/Azure VMs) present in the selected monitor host type. (Amazon/Azure) Specific resource: This triggers the action for the selected resource (EC2 instance/Azure VM) alone. You can use the Notify after action executes option to receive an email notification once the action is successfully executed. You can either select an existing email address or define new email addresses using the New Action option. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click the Create Action button to finish creating the Cloud action for the required resources. (EC2 Instances/Azure VMs) After creating the Cloud action, you can test its execution by clicking the Execute [ ] icon of that action. Perform Virtual Machine Action This action can be used to start/stop/restart virtual machines of VMware ESX, Hyper-V, Citrix Hypervisor, KVM, OVM, or Nutanix servers in the event of an alarm. To create a virtual machine action, follow the steps given below: Select the Virtual Machine Action option from the Actions menu. Enter the Display Name of the action. Choose the Host Type on which the action has to be performed in the event of an alarm. You can choose either VMware, Hyper-V, Citrix Hypervisor, KVM, OVM or Nutanix. Choose the Action Type to be performed in the event of an alarm. You can choose either Start VM, Stop VM or Restart VM options. Use the Select Target Virtual Machine option to associate the action to a virtual machine. There are three ways of selecting the target virtual machine(s). All VMs in the selected monitor group: This triggers the action for all the virtual machines present in the selected monitor group. All VMs in the selected host type: This triggers the action for all the virtual machines present in the selected VMware/Hyper-V/Citrix Hypervisor/KVM/OVM/Nutanix host. Specific Virtual Machine: This triggers the action for the selected virtual machine alone. Specify the Maximum time for action execution in seconds. This is the time limit within which the action has to be executed or else the action will be cancelled. You can use the Notify after action executes option to receive an email notification once the action is successfully executed. You can either select an existing email address or define new email addresses using the New Action option.If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click the Create Action button to finish creating the Virtual Machine action. After creating the Virtual Machine action, you can test its execution by clicking the Execute icon [  ] of that action. Replaceable Tags Alarm Configuration can be further enhanced by ''Replaceable Tags''. An email action is configured, if, for e.g., Tomcat Server goes down. While creating the E-Mail action, you can specify the "Message" as "This resource is running $HOSTNAME at port $PORT. If the Tomcat Server goes down, then email action is triggered with a message that contains the actual name of the Host and Port Number. Hereby the Dollar Tags are replaced with the host in which the tomcat server is running and the exact port of the tomcat server. Further, if you want Applications Manager to pass arguments to Custom Scripts, which would be invoked as part of ''Execute Program Action'', you can make use of Replaceable Tags. For e.g., in ''Execute Program Action'' , you can give the value for ''Program To Execute'' to be If the action is invoked then the $tags would be replaced with the then actual values say Find below the dollar tag parameters that can be associated with their probable values. Tag Description $MONITORNAME Name of the Monitor $MONITORGROUP Name of the monitor group/ sub group/ web application group. $ATTRIBUTE Various Attributes like Health, Availability, etc., Value of the attribute (eg., response time, memory usage,etc.,) that triggered $ATTRIBUTEVALUE the alarm. 1 (Critical/Down) $SEVERITYASNUMBER 4 (Warning) 5 (Clear/Up) $SEVERITY Critical, Warning, Clear, Up and Down $HOSTIP The IP Address of the Host Various Monitor Types like Tomcat-server, MYSQL-DB-server, Script Monitor, $MONITORTYPE etc., $OBJECTNAME MBean Object name when associated to Custom Monitor attributes $HOSTNAME Name of the Host $PORT Port Number $DATE Date and time at which the alarm was generated. $OID SNMP OID Root Cause Message like Average Response Time of SQS_Tomcat-server_9095 is critical because its $RCAMESSAGE value 652 > 10ms. [Threshold Details : Critical if value > 10, Warning if value = 10, Clear if value < 10] $SHORT_MESSAGE Displays the first 150 characters of the message from $RCAMESSAGE. Displays the value of the column name specified for a tabular metric in a custom monitor. To use this tag, replace {COLUMN_NAME} with the exact (case- sensitive) column name of the tabular metric in the custom monitor. Example: $CUSTOM_name, $CUSTOM_AGE, where name and AGE are the $CUSTOM_{COLUMN_NAME} column names of the custom monitor. Note: This tag is supported only for Script / Custom Monitor and Database Query Monitor.Tag Description The message specified by the user for the different severity levels in Threshold $THRESHOLDMESSAGE Profile. $URL The URL of the monitor from where the action is triggered. $TECHNICIAN The user who acknowledges the alarm generated. $ANNOTATION Use the $ANNOTATION tag to add more details on a particular alarm $STATUSFROM Shows the time value in which the attribute''s last status occurred $Label Custom Fields tag for the label of a resource. $Configuration Item Id Custom Fields tag for the Configuration Item ID of a resource. $Department Custom Fields tag for the department of a resource $Description Custom Fields tag giving the description of a resource. Custom Fields tag for Location Details like Name, Floor, Building, City, State, $Location Country and Postal code $User / Owner Custom Fields tag for the user or owner assigned. Unique identifier for each monitoring object in Applications Manager. $ENTITY Will be in $RESOURCEID_$ATTRIBUTEID format, where RESOURCEID is unique for each monitor and ATTRIBUTEID is unique for each metric. List the hierarchy of monitor groups for a particular monitor/monitor group. Will $GROUPHIERARCHY work for all monitors and monitor groups Root Cause Message without any html content like: Average Response Time of SQS_Tomcat-server_9095 is critical because its value 652 > 10ms. $RCAMSG_PLAINTEXT [Threshold Details : Critical if value > 10, Warning if value = 10, Clear if value < 10] You can use it in the Program to Execute field in the Execute Program action. Limitation of Dollar tags $ATTRIBUTE $DATE $MONITORNAME $MONITORGROUP These attributes will work for all the monitors / monitor groups $MONITORTYPE $RCAMESSAGE $SEVERITY $SEVERITYASNUMBER $HOSTIP These attributes will not work for Monitor groups / URL / URL sequence monitor / $HOSTNAME Script Monitor / WMI counters / Web Services. $PORT $OBJECTNAME This will work only for JMX custom attributes. $OID This will work only for SNMP custom attributes. $URL This will work only for URL monitor. $HOSTIP, $HOSTNAME These will not work for Ping monitor and File monitor.   Note The $ tags will not be replaced when you execute the actions manually and not supported in Alarm Escalation. Container Actions This action can be used to start/stop/restart a Container of Docker in the event of an alarm. To create a Container action, follow the steps given below: Select the Container option from the Actions menu. Enter the Display Name of the action. Choose the Action Type to be performed in the event of an alarm. You can choose either Start Container, Stop Container or Restart Container options. Use the Select Target Container option to associate the action to a Container. There are three ways of selecting the target container(s).All Containers in the selected monitor group: This triggers the action for all the Containers present in the selected monitor group. All Containers in the selected Docker: This triggers the action for all the Containers present in the selected Docker. Specific Container: This triggers the action for the selected Container alone. Specify the Maximum time for action execution in seconds. This is the time limit within which the action has to be executed or else the action will be cancelled. You can use the Notify after action executes option to receive an email notification once the action is successfully executed. You can either select an existing email address or define new email addresses using the New Action option. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click the Create Action button to finish creating the Container action. After creating the Container action, you can test its execution by clicking the Execute icon   of that action.   Windows Services Action This action can be used to start/stop/restart Windows services in the event of an alarm. To create a Windows Services action, follow the steps given below: Select the Windows Services Action option from the Actions menu. Enter the Display Name of the action. Choose the Action Type to be performed in the event of an alarm. You can choose either Start Services, Stop Services or Restart Services options. Use the Select Windows Services option to add windows services. Click the Add Services link. The Add Windows Services window will pop up. From this window, you can select Windows services using any of the methods described below: Select from Windows Servers: The Windows servers configured in your Applications Manager will be listed in the screen. Select the monitor type and the monitor from the respective drop-down boxes, and click Show Service link. This will list all the Windows services along with their current statuses. You can choose the services you want to add from this list. Select from Windows Services Template: If you select this option, the services associated with the Windows services templates configured in Applications Manager will be displayed on screen. Select the necessary services from this list and click the Add Services button to add the services. Specify the Target Servers on which these actions are to be executed. There are three options available here: Auto-select Servers: This option will automatically detect and trigger Windows Services action based on the associated monitor. For example, if the action is associated with a host, the action will be triggered for that particular host. If the action is associated with a Tomcat monitor, this action will be triggered for the host of the Tomcat server. Selected Servers: This option lets you specify the exact servers on which the action will be triggered. You can select the servers from the ones listed. All Servers in the Selected Monitor Group: This option lets you specify the exact servers on which the action will be triggered. You can select the servers from the ones listed. You can use the Notify after action executes option to receive an email notification once the action is successfully executed. You can either select an existing email address or define new email addresses using the New Action option. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click the Create Action button to finish creating the Windows Services action. After creating the Virtual Machine action, you can test its execution by clicking the Execute icon   of that action. Webhook / REST API ActionOverview Webhook / REST API action serves as a medium to interact and perform events on any third-party applications through the configured URL. Any alerts generated by the Applications Manager will trigger the Webhook / REST API actions to send the required event details, and allows you to streamline and manage your critical alarms, incidents or messages in any third-party application. Creating a new Webhook / REST API action To create a new Webhook / RestAPI action, follow the steps given below: Select the RestAPI Action option from the Actions menu. Enter the Display Name for the action. Enter the HTTP(s) URL for which the REST API action should be triggered. Choose the Form Submission Method using any one of the following HTTP methods: GET, POST, PUT, DELETE or PATCH. Choose the PayLoad Type to send data requests through FORM, Text, XML or JSON. Enter the Custom Parameters that are to be sent in the Key and Value text boxes accordingly.  You can add / remove multiple custom parameters using the (+ / -) buttons. Enter the Request Headers (HTTP Header Requests) that are required to be sent to request for specific pages/data from the HTTP URL. You can add / remove multiple header request parameters using the (+ / -) buttons. Enter the User Agent details of the requesting software from which the HTTP requests are being sent. You can choose the required User-Agent string details from the list shown while entering the value in the text box. Choose the Authentication Method required, if any, by choosing any one of the following authentication methods: No Auth: This option lets you access the HTTP URL without any authentication. Basic / NTLM: This option lets you access the HTTP URL with a basic authentication method (NTLM Protocol). This can be configured by entering the username and password required to access the URL. OAuth: This option lets you access the HTTP URL using OAuth (Open Authorization). This can be configured either by selecting the OAuth provider required to access the URL, from the drop down list. Also, you can create a new OAuth provider by clicking on the Add Oauth Provider link. (Refer Oauth Provider)You can use the Notify after action execution option for both success or failure conditions of an action either by selecting an existing email address or by defining a new email addresses using the New Action link. Under success condition, you can choose to receive success API response through mail using any one of the following options: Link: This option sends the URL response as a web link to your mail. Inline: This option sends the URL response by loading it within the mail itself. Note: If the Inline option is chosen and the API response exceeds the mail size limit, then the response will be sent as a web link. The mail size limit value can be specified in the Admin --> Product Settings --> Global Settings tab. Enter the Timeout value within which a connection has to be established with the URL. Click the Create Action button to finish creating the Rest API action. After creating the Webhook / Rest API action, you can test its execution by clicking the Execute icon of that action. Webhook Integrations Refer to the following links to learn how to integrate respective products using Webhook: Telegram Microsoft Teams PagerDuty Jira Service Management (On-Premise) Jira Service Management (Cloud) SQL Job ActionThis action can be used to start / stop / restart SQL Jobs in the event of an alarm. To create an SQL Job action, follow the steps given below: Select the SQL Job action from Actions menu. Enter the Display Name of the action. Choose the Action Type to be performed in the event of an alarm. You can choose either to Start Job(s), Stop Job(s) or Restart Job(s). Use the Select Sql Job option to add SQL Jobs. Click the Add Jobs link. A window where you can add SQL Jobs will pop up. Here''s how you add SQL jobs: Select SQL Jobs from selected resources: The window displays a list of SQL servers that is currently monitored by Applications Manager. Select the SQL Server from the respective drop-down boxes, and click Show Job link. This will list all the SQL Jobs. You can choose the SQL Job you want to add from this list. You can also add a new Job right from this window by clicking on ''Add Job'' button. Specify the Target Servers on which these actions are to be executed. There are three options available here: Auto-select Servers: This option will automatically detect and trigger SQL Jobs action based on the associated monitor. For example, if the action is associated with a particular SQL server, the action will be triggered for that particular SQL server. Selected Servers: This option lets you specify the exact SQL servers on which the action will be triggered. You can select the servers from the ones listed. All Servers in the Selected Monitor Group: This option lets you specify the exact SQL servers on which the action will be triggered. You can select the SQL servers from the ones listed. You can use the Notify after action executes option to receive an email notification once the action is successfully executed. You can either select an existing email address or define new email addresses using the New Action option. If you want to execute the action during specific time periods, enable the Execute Action based on Business Hours option and select the Business Hour during which the action has to be executed. The action can be configured such that it is executed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click the Create Action button to finish creating the SQL Job action. After creating the SQL Job action, you can test its execution by clicking the Execute [ ] icon. Associating Threshold and Action with Attributes The next step after creating the thresholds and actions is to associate them with the appropriate attributes of Monitor for generation of alarms. Follow the steps given below to associate a threshold and actions with an attribute: Note: Have a look at Associating Threshold & Action with attributes - How to Demos in website. Select the Home tab from the client. Click the Monitor Group. This lists the Monitors in it. Click the Monitor to whose attributes, threshold and actions must be associated. Click Configure Alarm from the respective attributes. The attribute name is listed in the combo box. You can either associate threshold or action or both. Select the mode through which thresholds need to be associated under Associate Threshold option. It comprises of 2 modes: Threshold Profile: Allows you to associate thresholds using Threshold Profiles. After choosing this option, select the threshold to be configured from the Threshold Profile combo box. If no threshold is configured, select New Threshold to create new threshold profile. Machine Learning: Allows you to associate thresholds using machine learning techniques based on anomaly detection. Note: By selecting ''Apply to selected monitors'', the threshold for this attribute is applied to the selected monitors. Enable the Configure actions at Attribute level checkbox if you wish to associate actions for ''Critical'', ''Warning'', and ''Clear'' severities individually. To associate actions, select the action you want to perform from Available actions and move it to the Associated Actions list box for each severity. Click View Actions to view details about the selected action. If no action is configured, click New Action.Note: Actions can be configured only for ''Critical'' and ''Clear'' severities while associating actions through Machine Learning. Click Save to save the configurations. You can also associate threshold and actions from Global Alarm Configuration screen. The threshold and/ or actions are now associated with the attribute. Based on this, alarms will be generated and action will be performed for that attribute. Note: Thresholds are configured and associated to attributes. You cannot associate threshold with attributes such as Availability and Health. Also in case of health, you must configure dependencies to generate alarms. Remove Configurations You also have an option to delete/ remove the above configurations using the Remove Configurations option. This will remove all the configurations and alarms. Bulk Alarm Configuration After configuring alarm for a particular monitor, if the same configuration holds good for all other monitors of the same type, then by using Alarm Template functionality you can do Bulk Alarm Configuration. Currently, Threshold and Action configurations are supported. It is very useful in cases where you want to configure identical Thresholds/Actions for a huge number of similar monitors. For e.g., If there are ten Tomcat servers and you want to configure an email action, if the response time for Tomcat exceeds 100 seconds. The alarm (Threshold and Action) is configured for one Tomcat server and by using Alarm Template this configuration can be applied to all the other Tomcat servers. Usage of Alarm Template is illustrated below: Click on the Alarm Template link under ''Snapshot'' of the particular monitor. A popup opens up with two choices: Overwrite existing Threshold Configuration and Overwrite existing Action Configuration If you choose to overwrite the existing Threshold Configuration, then Thresholds already associated would be overwritten with the new configuration, otherwise the old setting is retained. If you choose to Overwrite existing Action Configuration, then actions already associated, are removed and the new configuration added. Otherwise new configuration is appended to the existing configuration. Under the Advanced option, you can choose the monitors to which alarm template can be applied. On clicking on Apply, the alarm configuration is applied across all monitors of the same Monitor Type. Limitation: In Enterprise Edition, When a Monitor is removed from a monitor group, the associated Monitor Group template''s thresholds/actions are not removed from the monitor, in the Managed Server. Associate Actions, Dependent Devices and Define Alarm Rules Configuring Dependencies Defining Alarm Rules Dependent Devices Dependent Monitor Group Configuring Dependencies for Monitors You have the option to associate multiple dependent devices across managed servers. Dependencies determine the health availability of a Monitor. This includes dependent parameters of the Monitor based on which the severity of the health and availability are determined. By configuring dependencies, you can specify whether the health or availability depends on all or few dependencies. The severity is also determined by order of severity which is given below: Critical Warning ClearFor example, If there are 9 dependencies in a Monitor Group where three are critical, three are warning, and three are clear and the severity of Health of Monitor Group is based on any three selected dependencies, then the severity will be Critical as per the order of severity. To configure dependencies for the Monitor, do the following steps: Select the Home tab that lists all the Monitor Groups. Click on the Monitor Group that lists the Monitor. Click on the Configure Alarm icon   of the respective Monitor. This opens the Configure Alarm screen. Choose Health or Availability from the combo box. The dependent attributes will be shown in the list box under dependencies. Select and move the required attributes from the left box to the right box using >> button. By default, all the dependencies for the attributes of the monitors are added in the right box. You can also remove the default settings using the Action / Alarm Settings option. Specify whether the rule for determining the severity for health or availability. Depends on all selected parameters: The severity of health depends on the severity of all the selected parameters. Depends on any "n" selected parameters: The severity of health depends on only ''n'' selected parameters. The number of parameter, n has to be selected from the combo box. Click Save All to complete configuring dependencies. Define Alarm Rules Configuring Alarm Rules for Monitors / Monitor Groups: By configuring Alarm Rules, you can specify how the health or availability depends on the constituent Monitors in that Monitor Group. For eg., using Alarm Rules, you can say Health of the Monitor Group is Critical if the health of any two monitors in the monitor group is critical or Availability of the Monitor Group is Critical if health of any one of the monitors is critical. To configure alarm rules for the Monitor Group, do the following steps: Select the Home tab that lists all the Monitor Groups. Click on the Monitor Group you want to configure alarm rules. Click on the Configure Alarm icon   of the Monitor Group [under Today''s Availability]. This opens the Configure Alarm screen. Click the Health or Availability button to select the status you wish to alarm on. For Availability Alarm Rule Action - Configure an Alarm Action. The action will be executed when the alarm is generated. Refer Action / Alarm Settings. Define Alarm Rules (For Monitor Groups) - Create rules for Alarm, Rules enable users to specify the conditions that must be met for the alarm to be generated. The alarm will generated when any one of the rule is matched. You can Configure Alarm Rule to show the Monitor Group as Down depending on the health/ avalability of Any of the monitors - You can set the number of monitors on which the health of the monitor group depends. All of the monitors Selected monitors - Click the+symbol to select Associated / Non-Associated Monitors & Monitor Groups. You can select the attributes of the selected monitors on which the health of the monitor group depends. Percentage of monitors - You can set the percentage of monitors on which the health of the monitor group depends. Dependent Device - Monitor Group can have a device where Child Monitors Availability status will depend on the Device Availability. For Health Alarm Rule Action - Configure an Alarm Action. The action will be executed when the alarm is generated. Refer Action / Alarm Settings. Define Alarm Rules (For Monitor Groups) - Create rules for Alarm, Rules enable users to specify the conditions that must be met for the alarm to be generated. The alarm will generated when any one of the rule is matched. You can Configure Alarm Rule to show the Monitor Group as Down depending on the health/ avalability ofAny of the monitors - You can set the number of monitors on which the health of the monitor group depends. All of the monitors Selected monitors - Click the+symbol to select Associated / Non-Associated Monitors & Monitor Groups. You can select the attributes of the selected monitors on which the health of the monitor group depends. Percentage of monitors - You can set the percentage of monitors on which the health of the monitor group depends. Dependent Device - Monitor Group can have a device where Child Monitors Availability status will depend on the Device Availability. You have the option of setting any number of rules. For eg., it can be Monitor Group''s Availability is down if any one of the monitor''s availability is down or if the health of any one of the monitor is critical. Likewise, you can have your customized set of Alarm Rules. Note :In Alarm rules Rule processing order will be Down, Critical and Warning i.e., Applications Manager will first process Down rules followed by Critical and Warning. Processing rules will be stopped at any condition if rules is matched, further it won''t proceed to process rules. In ''Selected'' rule type, Monitor Group status will depend on all the selected monitors severity. Dependent Devices You can configure a dependent device in such a manner that if the availability of the dependent device is down, the concerned Monitors/Monitor Group''s availability will be down. You can configure the dependent device for a Monitor Group or individual monitor to suppress false downtime alarms caused by the dependent device being down. Configuring Dependent Device To configure dependent device for the Monitor Group, do the following steps: Select the Admin tab. Click on the Configure Alarms link, found under Alarm / Action settings. Select the monitor or monitor group for which you want to configure dependent device Under Availability, click on Configure Availability. Then select Dependent Device tab. It opens up the Configure Dependent Device screen. From the list of monitors, select the monitor you wish to assign as Dependent Device. You also have the option of supressing the alarms generated from the Dependent Device. Note:  Sub Group will override MG Group Dependent Device Configuration. Monitor level configuration will override all the Dependent Group(Monitor Group and Sub Group) level Dependency configuration. Configuring Dependent device at monitor group level is like configuring dependent device for each device under monitor group. Dependent Monitor Group You can configure a dependent monitor group in such a manner that if the availability or health of that dependent monitor group is affected, the corresponding monitor group''s availability or health will also be affected. Configuring a Dependent Monitor Group To configure a dependent Monitor Group, do the following steps: Select the Admin tab. Click on the Configure Alarms link, found under Alarm / Action settings. Select the Monitor group for which you want to configure dependent group Click on Configure Availability or Configure Health button. Then select Dependent Monitor Group tab. It opens up the Configure Dependent Monitor Group screen. From the list of monitor groups, Select the groups that you wish to assign as Dependent Groups.Cyclic Dependencies:  Cyclic Dependencies sometimes arise when multiple dependent devices are associated across managed servers to form a loop, resulting in infinite recursions. As it is a rather tedious task to track errors caused by circular dependencies, it is important to consider how your device dependencies are configured and to try to keep all of the dependencies acyclic. This means that if device A depends on device B, and device B depends on device C, we don’t want device C to depend on device A. Monitor Group Dependencies Here are a few scenarios of monitor dependencies and the state of the parent group after adding the dependency: Monitor Group 1 Monitor Group 2 State of group 1 After Adding Group 2 as Dependency Down Down Down -  As both Group 1 and Group 2 are down. Down Up Down -  As Group 1 is down. Up Down Down - As dependant Group 2 is down. Up Up Up Suppress Alert for Dependent Monitor Groups Users can suppress Alerts For Dependent Monitor Groups. The suppress alert feature works the same for both Dependent Monitor and Dependent Monitor Group. If a user chooses to suppress alerts for a Dependent Monitor then alerts are suppressed for the parent Monitor Group too. Here are possible scenarios: Monitor Monitor Monitor Suppress State of Group 1 After Adding Dependency of Both Group 1 Group 2 1  Alerts ? Group 2 and Monitor 1 Down Down Down No Down -  As all Group 1, Group 2 and Monitor 1 are down Down Down Up No Down - As Group 1 and Group 2  are down Down Up Down No Down -  As Group 1 and Monitor 1 are down Down Up Up No Down - As Group 1 is down. Up Down Down No Up Up Down Up No Up Up Up Down No Up Up Up Up No Up Health-Critical -  As all Group 1, Group 2 and Monitor 1 are down. Down Down Down Yes Availability-UP -  Alert is Cleared due to Dependent Monitor Configuration Health-Critical - As Group 1 and Group 2  are down. Down Down Up Yes Availability-UP - Alert is Cleared due to Dependent Monitor Configuration Health-Critical - As Group 1 and Monitor 1 are down Down Up Down Yes Availability-UP - Alert is Cleared due to Dependent Monitor Configuration Down Up Up Yes Down - As Group 1 is down. Up Down Down Yes Up Up Down Up Yes Up Up Up Down Yes Up Up Up Up Yes Up Configuring Consecutive Polls If you do not want Applications Manager to generate alarm for the first time the threshold condition is crossed, then you can use this option to specify the number of consecutive polls before generating an alarm. For e.g., If you want an email alarm to be generated only if the CPU Disk utilization is above 100%, consecutively for more than two polls, then you can configure the number of consecutive polls before reporting an error as two. In Action / Alarm Settings , you can have a common setting for all the monitors. If you want to overwrite the common settings, you can also configure the polls before reporting an error on availability and threshold of individual monitors. To Configure Polls on Availability for Individual monitorsClick on Configure Alarm lcon, in the ''Today''s availability'' graph of the selected monitor. You can configure the number of times consecutive polling should take place before reporting that the monitor is up or down. You can also click on the Configure Alarm Link in the Snapshot view of the monitor, and by clicking on the Configure Alarm icon, for availability attribute, you can configure the consecutive polls. You can enter the number of times consecutive polling needs be done before reporting that the availability is up or down. You can leave the ''Polls before reporting an error'' field empty to have the action / alarm settings for consecutive polls take effect. To Configure Polls on Threshold for Individual monitors ClickNew Threshold Profile. This opens the Create new Threshold Profile screen. Create New Threshold Profile, as per details found in Creating Threshold Profile. Note: Specify the number of polls that can be scheduled before reporting an error. By default, it takes the value from action / alarm settings. For e.g., if you have created a threshold for web server to be critical if the response time crosses 100 seconds. And you wish to receive an email alarm only if the web server becomes critical after two polls and not at the first poll itself. Then configure the number of polls before reporting an error as two. You can leave the ''Polls before reporting an error'' field empty to have the action / alarm settings for consecutive polls to take effect. Alarm Escalation Using this option, you can escalate if any alarm has not been attended to for a given time period. You can configure rules to send Escalation EMails or send SMS or to Execute Program about unattended alarms to the Admin or to the superior. Alarm Escalation Configuration: Under the Admin Tab, click on Alarm Escalation icon. Set the rule. For eg., Send Escalation EMail if the critical alarms of all monitors are not cleared within 2 hours. You can set rules for alarms in individual monitor groups too. Select the option to Send EMail/ SMS/ Execute Program Actions. These actions have to be created earlier from the Actions drop-down at the top band. Execute Program Action will trigger a specific batch file or script, whereas Send EMail and SMS will send notifications to the mail id and mobile number provided, on the escalation of an alarm. For more on creating action, refer this section. Set the time period for which the rule should be executed repeatedly. By choosing not to receive duplicate escalation for the same alarm, you opt for optimizing the number of escalation EMails/ SMS sent and Program Action executions. For eg., If there are five critical alarms that were escalated in the first execution run (say 10 minutes), only if there is an addition of new alarm or deletion of alarm, the next set of alarms will be escalated in the second run. If there is no change in the environment in the next 10 minutes, ie., if the five critical alarms still remain the same, escalation EMail will not be sent. Note Replaceable tags are not supported in Alarm Escalation Rule. Reports An important aspect of all management tasks is that you can analyze the trend over time and evaluate the performance. The analysis is also useful in making calculated predictions and taking corrective actions as necessary. These calculated predictions allows you to plan for any future impact on performance for various services. To view these reports, you can follow either of the given steps: Click the Reports module tab. This opens the index page that lists all the reports generated dynamically by Applications Manager. (OR) Click on the Monitor Group and select Application Report Link in the left frame. By default, it takes you to the Availability report of the Monitor Group. By default, the graph for the attribute reports will be depicted for top 10 monitors. Browse through the following topics to know about the various reports that are generated in Applications Manager: Grouping of Reports Capacity Planning ReportsForecast Reports Inventory Reports 7/30 Reports Functionalities of Reports The reports generated by Applications Manager depicts the availability, health, response time and alarms of the application over a specified period of time. The reporting function enables you to analyze your servers / applications / databases/ web servers / web applications / services even across months and all this even without having to make any additional configuration changes. The reports are generated dynamically, which means that you only see reports for monitors that you have created in Applications Manager. Before proceeding, please ensure that you have enabled reports for all the monitors. The generated reports has 7 / 30 report details which enables you to understand the behaviour of your applications under various business hours or during a particular period of the week/month. This feature allows you to make predictive calculations on future impact. Some of the common functionalities of reports are as follows: Options to view 10/20/50/All reports by choosing them from the Top N Reports field. They are enabled by default for all availability and health reports. Note: This is not applicable to reports generated for Monitor Groups. Options to schedule reports or enable reports can be done quickly by clicking on ''Schedule Reports | Enable Reports'' link. Option to view Custom Time Period reports for Availability and Attributes, i.e, the time period for which the reports are needed can be selected. Additionally, you have the option to set the Business Hours during which you want the reports. Option to view Custom Attribute Reports and Downtime Summary Report configuration. Click here for detailed information. Option to save the reports in CSV format by clicking on   icon , PDF format by clicking on   icon and also save in Excel format (available only for Monitor Group - Availability & Health Snapshot - Current Snapshot, Critical Snapshot, History report, Outage Comparison Report, Availability Trend Report) for each individual report under reports tab. And also, you can mail these particular report to yourself by clicking on   icon, fill out the email address and click Send. Option to delete known Down Time reports. You can delete known downtime reports from the database by clicking the   icon in the Availability Report. For eg, go to Application Server and select Weblogic from the pull down menu in the top. Now click on Availability of Application Servers. Now click on the monitor''s Total Downtime. Select the known downtime from the Monitor Downtime detail*. This will delete this known downtime report from the database. Downtime History: Gives the downtime/uptime chart for ''today''''s period and also the downtime history for that particular monitor across all time periods. You can also assign Groups as well as Sub-Groups to downtime scheduler and generate reports. In Downtime history report, you can view the summary details of Scheduled Downtimes and Unmanaged time. This will give you more clarity in knowing the monitor''s exact downtime. You can also add notes on why the monitor was down for that particular time period. Summary Report of Monitor : Gives the summary of all the reports for that particular monitor. Comparison Reports: You can compare the attribute reports of various monitors within a particular monitor group. For eg., to compare the response time between monitors, click on Response Time Reports attribute link; from the list, select the monitors for which you need comparison. You can either select the time period for which the comparision is required or select the particular Business Hours for which the comparison is required. Currently, availability and health comparison reports are not supported. At a Glance Reports: The performance of top 10 monitors within the monitor group can be compared in a single view. For eg, in server monitor group, you can compare the performance of top 10 servers within the group. By clicking on the bars in the report, you can see all the attributes of the monitor in a single view. Further, you can drill down to see the individual attribute reports. Note: Scheduling of reports is possible by using Schedule Reports under Settings tab.   7 / 30 Reports The 7/30 Reports is available for various attributes/resource of a particular monitor. The 7/30 reports, apart from displaying availability for the past 7 days or 30 days, they also display the following reports for each attribute/resource. These reports can be exported into PDF formats.History Report Hour of Day Report Day of Week Report Statistical Report Heat Chart History Report History Report in Applications Manager provides detailed history of the particular attribute of a monitor. You can also generate history trend across business hours for a particular attribute. This provides you with an understanding to the amount of resources that has been utilized by the particular attribute over a period of time (week/month/year). Archiving: All the data are archived and stored every one hour. Eg. Data from 10 AM to 11 AM are archived and marked as 11 AM when stored. If the monitor instance is completely down during the archiving interval of one hour, archiving will not take place for that hour. Minimum value: It represents the lowest value from the collected values in an hour. Eg. 6 on Sep 01, 2008 - 14:00 hours represents the lowest value ''6'' collected on Sep 01, 2008 between 13:00 and 14:00 hours. Maximum value: It represents the highest value from the collected values in an hour. Eg. 12 on Sep 01, 2008 - 14:00 hours represents the highest value ''12'' collected on Sep 01, 2008 between 13:00 and 14:00 hours. Hourly Average: It represents the average value from the collected values in an hour. Eg. 9 on Sep 01, 2008 - 14:00 hours represents the average value ''9'' collected on Sep 01, 2008 between 13:00 and 14:00 hours. Hour of Day Report A sample Hour of Day Report is shown below. This report generates hour''s average for a particular time period (week/month/year) for the particular attribute. For example, if you have selected last 7 days data, the report generates hour''s minimum, maximum and hourly average. This report helps you visualize the various bottlenecks that appear for this attribute / resource during a particular time period. This allows you to plan future impact of bottleneck on this attribute / resource. Minimum value: It represents the lowest value among the collected values in a particular hour of the day over a period of time. Eg. The lowest value ''41'' represents the data collected between 13:00 - 14:00 hours from Dec 4, 2008 3:55 PM to Dec 11, 2008 3:55 PM. Maximum value: It represents the highest value among the collected values in a particular hour of the day over a period of time. Eg. The highest value ''81'' represents the data collected between 13:00 - 14:00 hours from Dec 4, 2008 3:55 PM to Dec 11, 2008 3:55 PM.Hourly Average: It represents the average value of the collected values in a particular hour of the day over a period of time. Eg. The average value ''62'' represents the data collected between 13:00 - 14:00 hours from Dec 4, 2008 3:55 PM to Dec 11, 2008 3:55 PM. Day of Week Report A sample of Day of Week Report is shown below. This report generates average of a day for a particular time period (week/month/year) for the particular attribute. For example, if you have selected last 7 days data, the report generates everyday''s minimum, maximum and hourly average and is shown below in this report. As shown in the graph below, the connection time for Oracle DB server has been highest for Wednesday and lowest for Monday. This implies that the traffic on Wednesday has been high when compared to rest of the days during the week. This would allow you to ensure that the connection time of Oracle DB server remains low for that particular day and help you troubleshoot performance issue quickly. Minimum value: It represents the lowest value among the collected values in a particular day of the week over a period of time. Eg. The lowest value ''41'' represents the data collected on Wednesdays from Nov 11, 2008 3:55 PM to Dec 11, 2008 3:55 PM. Maximum value: It represents the highest value among the collected values in a particular day of the week over a period of time. Eg. The highest value ''81'' represents the data collected on Wednesdays from Nov 11, 2008 3:55 PM to Dec 11, 2008 3:55 PM. Hourly Average: It represents the average value of the collected values in a particular day of the week over a period of time. Eg. The average value ''62'' represents the data collected on Wednesdays from Nov 11, 2008 3:55 PM to Dec 11, 2008 3:55 PM. Statistical Report A sample Statistical Report is shown below. This report represents the standard deviation of this attribute over a period of time. For eg. lets consider CPU utilization attribute over a period of time. X-axis represents CPU Utilization range in percentage and Y-axis represents Count in percentage. Lets consider peak value of Count percentage to be 55% and is within the range of 70% - 80%. This means that for 55% of the polled value is within the range of 70% and 80%. This data can be used to re-allocate or organize resources for the server accordingly. Heat Report A sample Heat Report is shown below. This report is largely useful to compare the similar types of monitors and to check their performance of each monitor with other monitors. These heat charts are plotted based on how the attribute of the particular monitor type performs according to the threshold configured for that particular monitor. If a threshold is configured for the attribute of a particular monitor, then the threshold is taken and heat chart is plotted. There are three colors by which heat chart is plotted.Red color indicates critical breach in threshold, Orange color indicates warning, and Green color is clear. If the threshold is breached, then the color of the heat chart changes accordingly. This implies drop in performance, thus providing clear understanding of various monitors performance of the same type. If the threshold value for each attribute for that particular monitor is not set, then the common threshold value is automatically assumed and this heat chart is generated. The ''Edit'' option provided in this chart will facilitate the user to view the heat chart in any other threshold definition on the fly. Please note that by editing threshold the view won''t affect the original threshold configured for the attribute.  Capacity Planning Reports Capacity planning helps IT enterprises balance hardware costs with computing needs. The major objectives of effective capacity management are: Making efficient use of existing capacity. Minimizing wastage of computing resources. To view capacity planning reports generated by Applications Manager: Click the Reports module tab to open the index page that lists all the reports generated by Applications Manager. Click on the Capacity Planning link in the list of reports at the left side of the page. These reports render resources like CPU and Memory utilization for both Physical and Virtual Servers. Before proceeding, make sure that you have enabled reports for all the monitors. You can get reports over various customized time periods. The capacity planning reports can be exported in .pdf, excel, CSV and e-mail formats. The reports are classified into three types: Undersized Servers/Machines Oversized Servers/Machines Idle Servers/Machines Note: You can schedule Capacity Planning reports from the Schedule Reports page under Reporting in the Settings tab. Undersized Monitors/Machines These are servers that consistently use nearly all of their configured capacity. For a given amount of time, if the average CPU or Memory utilization of a server are very high, the resources allotted to the server is undersized. The server need to be right-sized so that workloads running within the virtual machine can get sufficient resource capacity. Oversized Monitors/Machines These are servers that consistently use less resources than their configured capacity. For a given amount of time, if the average CPU or Memory utilization of a server are very low, the resources allotted to the server is oversized. The server needs to be right-sizeddown to a lower capacity that is sufficient for the workloads running within the virtual machine. Idle Monitors/Machines With Applications Manager capacity planning reports you can also view individual resource utilization details of a particular monitor for a specific time interval configured by the user. These are monitors that show an insignificant level of capacity usage on one or more resources most of the time. For example, say the average CPU utilization is very low over most hours of day. This analysis is to identify servers that are not being used, for example, users are no longer running workloads.Rightsizing Virtual Machines Applications Manager analyzes oversized and undersized machines using CPU and memory utilization metrics. A utilization threshold is configured for a specific metric like CPU or Memory. If a machine uses resources capacity less than this threshold, the machine is oversized. The degree to which a virtual machine is oversized is calculated along with the the amount of time a machine spends in an overutilized state. Similarly, if a machine uses resources capacity more than this threshold, the machine is undersized. The degree to which a virtual machine is undersized is calculated along with the the amount of time a machine spends in an underutilized state. You can view the reports for selected servers from the Select Server drop-down list. You can also select a particular Monitor group from the Select Monitor Group drop-down. Click on the server type to generate reports for the specified time period and threshold limit. You can set the conditions to be satisfied for a server to be undersized, oversized or idle. Click on one of the server types (undersized, oversized or idle servers). A new window is opened to display a capacity planning report with server details like: Monitor Name - Name of the Monitor Undersized/ oversized/ idle - The state of the server. CPU Utilization - Percentage of CPU Utilized Memory Utilization - Percentage of Memory Utilized User Notes - The user can add and save notes which will appear in the report. The attribute column is RED or GREEN and the undersized column has values YES or NO respectively, depending upon the condition specified. By default the table shows all the monitors for the day. You can click on the Show Undersized/ Oversized/ Idle Servers Today button to show only the respective servers for the day. Click on the YES or NO under the Undersized/ Oversized/ Idle column in the capacity planning table to view a Utilization Summary and an Hourly Utilization Details Report. Click on any of the attributes under the CPU Utilization or Memory Utilization column to get an indepth history data for that particular attribute (Disk Utilization History Report, Hour of Day Report, Day of Week Report, Statistical Report and Heat Chart). You can select required attributes from the drop down menu in the right-hand corner of the page. Configure settings for diagnosis Configure the following details for the server. To change values of attributes used in diagnosis, click on Change settings Used in Diagnosis button and update respective values: Select Rule: Name of the rule for which the conditions are configured for the diagnosis of Undersized/Oversized/Idle Servers. You can also add/remove multiple rules for diagnosis, if required. Servers are Undersized/Oversized/Idle if Percentage of Time: The time for which CPU & Memory Utilization value should be more or less than the configured value. Conditions used in diagnosis of Undersized/Oversized/Idle Server: You can select any one or all of the conditions configured. Monitor Type Attribute CPU Utilization Servers Memory Utilization CPU Utilization Memory Utilization VMWare ESX/ESXis Disk Usage in kbps Network Usage in kbps Total CPU Utilization Hyper-V-Servers Physical Memory Utilization Total CPU Utilization Citrix Hypervisor Physical Memory Utilization Virtual Machines (VMware ESX/ESXi) CPU Utilization Memory Utilization Disk I/O Utilization in kbpsNetwork Utilization CPU Utilization Virtual Machines (Hyper-V Server) Total Memory CPU Utilization Virtual Machines (Citrix Hypervisor) Memory Utilization Cluster CPU Usage Virtual Machines (Nutanix) Cluster Memory Usage CPU Utilization Azure Virtual Machines Physical Memory Utilization Note: To disable any attribute used in diagnosis, click on Change Settings used in Diagnosis button. Click on the Disable link for the respective attribute. Save settings. Forecast Reports Forecasting helps IT enterprises to predict future disk utilization based on current utilization trends and balance hardware costs with computing needs. The major objectives of effective forecasting are: Staying informed about current disk usage trends. Plan future disk utilization requirement based on forecast reports. To view Forecast Reports generated by Applications Manager: Click the Reports module tab to open the index page that lists all the reports generated by Applications Manager. Click on the Forecast Reports link from the list of reports at the left side of the page. Forecast Reports can be attained for a number of attributes of all servers. Before proceeding, make sure that you have enabled Reports for all the monitors. Forecast Reports uses hourly archiving to collect data for ''''today, yesterday, this week, last week'''' and daily archiving to collect data for ''''this month, last month, this quarter, this year and last one year.'''' You can get Reports over various customized time periods. The Forecast Reports can be exported in CSV format. The Reports are classified into two types: Forecast by growth trend Forecast by growth trend generates Reports based on current utilization statististics and predicts the growth in utilization in the future based on present statistics. This Report is generated for all attributes monitored by ManageEngine Applications Manager. Variations in growth for every day can also be viewed by clicking on the individual monitors. Forecast by utilization Similar to growth trend, Forecast by utilization generates Reports based on current utilization statistics but, it also notifies when the utilization level reaches an extreme high (80%-90%, 90%-100%), allowing to take appropriate actions. This Report is generated only for attributes measured in the percentage (%) scale. Enable Machine-Learning In the Report page, you can use the Toggle switch to "Enable Machine learning" checkbox to use Machine Learning techniques for more reliable Forecast Reporting.  Note: You can also schedule Forecast Reports for a future date and get notified via email regarding the same. It is recommended that you provide Applications Manager at least a few months of Day-wise Archived data to develop a reliable forecast for a date the same number of months into the future. For example, it takes 2 months of Day-wise Archived data to develop a reliable forecast for a date 2 months into the future." Grouping Reports The Reports page contains a list of reports, generated using Applications Manager, by grouping them with respect to Monitor Groups and Monitor Type. The reports are grouped for easier report analysis and for providing more flexibility in report generation. They are grouped as follows: Monitor Group Custom Monitor Reports Trend Analysis Reports Server Reports Application Servers Database Servers Web Services Reports Web Servers Reports URLs/Web Apps Reports Middleware/Portal Reports Services Reports Mail Server Reports Java / Transactions Reports ERP Reports Custom Types EUM Reports Note : The details available for each attribute of the Monitor Type (except Monitor Groups) are shown in descending order. For example, in Availability report of a Monitor Type, the Monitor with the poorest availability is displayed first. Monitor Group Reports This generates reports for all the Monitor Groups created using Applications Manager. Choose the Monitor Group from the Select Application combo box. The following are the different Report types that are generated for the Monitor Group. Report Types Details Current Snapshot: The overall Availability and Health snapshot of the Monitor Group and the respective monitors, services, processes and databases in the Monitor Group. Availability & Health Critical Snapshot: The Availability and Health snapshot of monitors, services, processes and databases which are in Critical / Warning State in the Monitor Group. History: Availability and Health Outage reports for Monitor Group with details of Monitors that are in down state Availability Reports Percentage: The overall availability of the Monitor Group and the availability details for the respective monitors, services, processes and MS SQL databases in the Monitor Group. Outage Comparison Report: With this report, you can compare the outages for current & past week / month. You would be able to find the details of how many times (count) outages have happened and also the duration of theoutage. Also, you have the option to select the business hours for which you want the metrics to be calculated. You can define your custom business hours by using the Business Hours tool under Settings tab. Availability Trend Report: You have the history of 12 days, 12 weeks, 12 months availability report. Using this, you can follow the trend that is happening. Also, you have the option to select the business hours for which you want the metrics to be calculated. You can define your custom business hours by using the Business Hours tool under Settings tab. Availability and Downtime Trend Report: This section shows three reports - the availability of the monitor group in percentage, the downtime count, and the total downtime of the monitor group for the specified time period. The availability in percentage values are compared against the target availability to give you an idea of the availability trend of the specified monitor group. These information is also summarized in a table that shows the availability percentage, downtime count and the total downtime for the respective time periods. You can generate these reports for the last 12 days, last 12 weeks or the last 12 months. You can also generate these reports based on the business hour chosen. The business hours have to be defined using the ''Business Hours'' tool under the Settings tab. The reports thus generated can be exported as Microsoft Excel files (.xls). Percentage: The overall health of Monitor Group and the health details for the Health Reports respective monitors in the Monitor Group. The performance of top 10 monitors within this monitor group can be compared in a single view. By clicking on the bars in the report, you can see At a Glance Report all the attributes of the monitor in a single view. Further, you can drill down to see the individual attribute reports. Alarm Occurrences for the application, attributes grouped in the application, and monitors, with graphical representation. Alarm Summary Additionally, a graph representing the split up of total critical alarm occurrences in application by most critical monitors is also generated. Monitor Group Attribute Report The attribute report of the constituent monitors in the Monitor Group Custom Monitor Reports This generates report for all the numerical attributes of the Custom Monitors created using Applications Manager. The list of all the scalar numerical attributes available in the Custom Monitor will be listed with the reports and the agent name. The following are the parameters in the report details of any attribute for which the report generation is enabled. Parameters Details This contains the following details: Name of the attribute. The agent from which the attributes were added to the Custom Monitor. The port at which the agent is running. Attribute Details The type of the service or resource through which the JMX or SNMP agents are monitored. The minimum value obtained for every polling interval. The maximum value obtained for every polling interval. The average value of the attribute obtained for every polling interval. Average Value (Graph) Graphical representation that depicts the relationship between the average value andtime of the attribute. Tabular representation that shows the relationship between the average value and time Average Value (Table) of the attribute. If the custom monitor is created and the attributes are not listed, then you can click on the link provided in the Custom Monitor Reports to enable or disable the same. Trend Analysis Reports This generates reports for the individual monitors. The following are the different Report types that are generated. Report Types Details Gives the downtime/uptime chart for ''today''''s period and also the downtime history for that particular monitor across all time periods. Also, you can view the summary details of Scheduled Downtimes and Downtime History Unmanaged time. This will give you more clarity in knowing the monitor''s exact downtime. You can also add notes on why the monitor was down for that particular time period. Summary Report Gives the summary of all the reports for that particular monitor. The performance of the selected monitors can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of At a Glance Report the monitor in a single view. Further, you can drill down to see the individual attribute reports. Application Servers Reports This generates reports for the Application Server Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Application Server Monitor Type from the combo box). The following are the different Report types that are generated for the Application Server. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Application server Monitors being monitored by the Applications Manager. Health The health of all the monitors in the Applications Manager server. The performance of top 10 Application servers can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of At a Glance Report the monitor in a single view. Further, you can drill down to see the individual attribute reports. The minimum, maximum, and average response time of all the Application Response Time server monitors, in milliseconds. (not for .NET) The minimum, maximum, and average JVM usage by all the Application Memory Usage server monitors, in bytes. (not for Oracle AS, .NET) The minimum, maximum, and average JDBC Connections of Application JDBC Connection Usage server monitors (not for Oracle AS, .NET, Tomcat) The minimum, maximum, and average number of threads spawned by Thread Application server monitors (not for Oracle AS, JBoss)Session Details The minimum, maximum, and average HTTP Sessions of Application server monitors (not for .NET, Tomcat, JBoss) Request Throughput of Number of requests processed per unit of time in the server. (not for .NET, Application Servers Tomcat, Websphere, JBoss, WLI, Weblogic) Web Application Throughput of Number of requests processed per unit of time in the web application (not Application Servers for .NET, Tomcat, Websphere, JBoss, WLI, Weblogic) Database Reports This generates reports for the Database Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Database Monitor Type from the combo box). The following are the different Report types that are generated for the Database monitor. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Database Monitors being monitored by the Applications Manager. Health The health of all the monitors in the Applications Manager server. The performance of top 10 database servers can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of At a Glance Report the monitor in a single view. Further, you can drill down to see the individual attribute reports. The minimum, maximum, and average time taken to connect to the Response Time database server by the Applications Manager server, in milliseconds. Buffer Hit Ratio The minimum, maximum, and average Buffer Hit Ratio of the database Cache Hit Ratio The minimum, maximum, and average Cache Hit Ratio of the database Service Reports This generates reports for the Service Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Service Monitor Type from the combo box). The following are the different Report types that are generated for the Service Monitor Type. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Service Monitors being monitored by the Applications Manager. Health The health of all the monitors in the Applications Manager server. The performance of top 10 services can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of the At a Glance Report monitor in a single view. Further, you can drill down to see the individual attribute reports. The minimum, maximum, and average response time of all the Service Response Time monitors, in milliseconds. Mail Server ReportsThis generates reports for the Mail Server monitor type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Mail Server Monitor Type from the combo box). The following are the different Report types that are generated for the Mail Server Monitor Type. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Mail Server Monitors being monitored by the Applications Manager. The health of all the monitors in the Applications Manager Mail Server Health Group. The performance of top 10 mailservers can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of the At a Glance Report monitor in a single view. Further, you can drill down to see the individual attribute reports. The minimum, maximum, and average response time of all the Mail Server Response Time monitors, in milliseconds. Server Reports This generates reports for the Server Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Server Monitor Type from the combo box). The following are the different Report types that are generated for the Server Monitor Type. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Server Monitor Types such as Linux and Windows being monitored by the Applications Manager. Health The health of all the monitors in the Applications Manager server. The performance of top 10 servers can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of the At a Glance Report monitor in a single view. Further, you can drill down to see the individual attribute reports. The minimum, maximum, and average response time of all the Server Response Time Monitors, in milliseconds. The minimum, maximum, and average amount of CPU utilized by the CPU Usage Server Monitor. The minimum, maximum, and average amount of memory utilized by the Memory Usage Server Monitor. The minimum, maximum, and average amount of Disk space utilized by Disk Usage the Server Monitor. Web Service ReportsThis generates reports for the Web Service Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Web Service Monitor Type from the combo box). The following are the different Report types that are generated for the Web Service Monitor Type. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Web Service Monitors being monitored by the Applications Manager. The performance of top 10 webservices can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of the At a Glance Report monitor in a single view. Further, you can drill down to see the individual attribute reports. Health The health of all the monitors in the Applications Manager server. The minimum, maximum, and average response time of all the Web Service Response Time monitors, in milliseconds. Operation Execution Time The time taken for getting response from the Service. Web Server Reports This generates reports for the Web Server Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Web Server Monitor Type from the combo box). The following are the different Report types that are generated for the Web Server Monitor Type. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Web Server Monitors being monitored by the Applications Manager. The performance of top 10 webserver can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of the At a Glance Report monitor in a single view. Further, you can drill down to see the individual attribute reports. Health The health of all the monitors in the Applications Manager server. The minimum, maximum, and average response time of all the Web Server Response Time monitors, in milliseconds. URLs/ Web Apps Reports This generates reports for the URLs/ Web Apps Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of URLs/ Web Apps Monitor Type from the combo box). The following are the different Report types that are generated for the URLs/ Web Apps Monitor Type. Report Types Details Availability The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between thefailures (MTBF), and average Uptime percentage for all the Web Service Monitors being monitored by the Applications Manager. The performance of top 10 webservices can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of the At a Glance Report monitor in a single view. Further, you can drill down to see the individual attribute reports. Health The health of all the monitors in the Applications Manager server. The minimum, maximum, and average response time of all the Web Service Response Time monitors, in milliseconds. Middleware/Portal Reports This generates reports for the Middleware/Portal Monitor Type created using Applications Manager. The reports can be generated either for all the Monitor Types (by choosing ALL from the combo box) or for any specific Monitor Type (by choosing the respective type of Middleware/Portal Monitor Type from the combo box). The following are the different Report types that are generated for the Middleware/Portal Monitor Type. Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Web Service Monitors being monitored by the Applications Manager. The performance of top 10 webservices can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of the At a Glance Report monitor in a single view. Further, you can drill down to see the individual attribute reports. Health The health of all the monitors in the Applications Manager server. The minimum, maximum, and average response time of all the Web Service Response Time monitors, in milliseconds. JVM Usage The minimum, maximum, and average JVM usage by the monitors Connection Pool Usage The minimum, maximum, and average JDBC Connections of the monitors The minimum, maximum, and average number of threads spawned by the Thread Details monitors Session Details Time The minimum, maximum, and average HTTP Sessions of the monitors Java / Transactions Reports This generates reports for the Java Runtime Monitor created using Applications Manager. The following are the different Report types that are generated: Report Types Details Availability The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between thefailures (MTBF), and average Uptime percentage for all the Web Service Monitors being monitored by the Applications Manager. Health The health of all the monitors in the Applications Manager server. The performance of top 10 java runtime monitors can be compared in a single view. By clicking on the bars in the report, you can see all the At a Glance Report attributes of the monitor in a single view. Further, you can drill down to see the individual attribute reports. The minimum, maximum, and average time taken to connect, in Response Time milliseconds. Memory Usage The minimum, maximum, and average amount of memory utilized CPU Usage The minimum, maximum, and average amount of CPU utilized ERP Reports This generates reports for the SAP Monitor created using Applications Manager. The following are the different Report types that are generated: Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the Web Service Monitors being monitored by the Applications Manager. Health The health of all the monitors in the Applications Manager server. The minimum, maximum, and average time taken to connect, in CPU Utlilization milliseconds. Memory Utlilization The minimum, maximum, and average amount of memory utilized Disk Utlilization The minimum, maximum, and average amount of disk utilized PageIn Rate The Average number of page-ins per second PageOut Rate The Average number of page-outs per second Spool Utilization Utilization of the spool work processes as a percentage Background Utilization Percentage of the background processing capacity currently utilized; Average time that a user waits at the front end for the processing the Front End Response Time request Enqueue Requests Number of lock requests The minimum, maximum, and average time taken to connect, in Connection Time milliseconds. Custom Types This generates reports for the Custom Monitors types created using Applications Manager. The following are the different Report types that are generated: Report Types Details The availability details that include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability failures (MTBF), and average Uptime percentage for all the monitors in the custom monitor type being monitored by the Applications Manager.Health The health of all the monitors in the custom monitor type. The performance of top 10 custom monitors can be compared in a single view. By clicking on the bars in the report, you can see all the attributes of At a Glance Report the monitor in a single view. Further, you can drill down to see the individual attribute reports. The minimum, maximum, and average response time of all the custom Response Time monitors, in milliseconds. EUM Reports You can view comprehensive reports about the health, availability, downtime and response time of web applications or website across all locations. Report Types Details The At a Glance Report displays the availability information of the EUM At a Glance Report Monitors and agents, average Transaction Time and Outage stats by Location. This report displays the average Response Time, Availability and Downtime Location Agent Report at different locations. The availability details include total down time in hours and minutes, average time taken to repair the failure (MTTR), average time between the Availability Reports failures (MTBF), and average Uptime percentage for all the EUM Monitors in Applications Manager. Health Reports The state of health of all the EUM Monitors in Applications Manager. EUM At a Glance Report At a Glance Report of a particular EUM Monitor across locations. EUM Summary Report The summary Report of a particular EUM Monitor across locations. Inventory Reports Applications Manager gives you the ability to generate comprehensive custom reports of all your resources. You can export the reports to PDF or Excel formats or print it out for future reference. These reports render resources over various categories. To view inventory reports generated by Applications Manager, follow the steps given below: Click the Reports module tab to open the index page that lists all the reports generated by Applications Manager. Click on the Inventory link in the list of reports at the left side of the page. Select the category of monitors for which you wish to generate reports from the drop-down list. Select the columns that you wish to include in the report from the list as shown below: Resource ID Display Name Resource Name Type Category Poll Interval State Creation Time Note: Certain columns will be disabled depending on the category that you select. Click on Generate Report to view the report in a new pop-up window.Click on the PDF or Excel buttons to download the report in the respective formats. You can view the following resource-specific details by expanding the resources shown in the report: User Name Port Associated Monitor Groups Server Uptime (in days) Server configuration details You have filtering options in the report based on Category and Monitor Type, so that it is quicker to find the report of the resource you are looking for. The page includes a search bar that lets users find reports based on values. Note : In an Enterprise Edition Admin Server, the report will display a column with the Managed server (in place of the ''Polling interval'' column) to which the resource is associated. Applications Manager Settings Applications Manager enhances effective business management allowing system operators and administrators to configure any activity with ease. The Settings tab (formerly Admin tab) in the client lists all the administrative functions that can be performed with the product. The following are the group of activities performed by the system administrators to monitor their system/ service/ application running in the network through Applications Manager. Click on the respective topics to know the details. Discovery and Data Collection: Bulk adding of Monitors Credential Settings Custom Monitor Types Downtime Scheduler Network Discovery OAuth Provider Performance Polling Server Process Templates Windows Service Templates Alarm/Action: Action / Alarm Settings Alarm Escalation Availability Settings Configure Alarms Event Log Rules Global Trap Action SNMP Trap Listener Product Settings: Add-On/Product Settings Business Hours Configure Mail Server Configure Proxy Configure SMS Server Enable Reports Global Settings Personalize Web ClientProduct License Reports Settings REST API User Administration World Map Tools: Audit Logs Schedule Reports Upload Files/Binaries Admin Activities: Data Backup Production Environment Server Settings   Discovery and Data Collection Browse through the below topics to learn more about Discovery and Data Collection, available under Settings tab in Applications Manager: Credential Settings Template Library Add/Discover Custom Monitor Type Performance Polling Downtime Scheduler OAuth Provider APM Insight Agent Configuration Profile Web Token Credential Manager Credential Manager in Applications Manager will help you to store the various credentials like password/ snmp community, port, etc., for all type of monitors in a common place. This preconfiguration of credentials in a central location will help in avoiding the need to edit every monitor when a password or SNMP/ SSH info changes. For instance, you can create a credential for type MySQL monitors. Consider the name of the credential is SampleMySQL. This SampleMySQL contains parameters for MySQL monitor, username, password and database name. When you want to add a MySQL monitor, credentials of type MySQL alone will be displayed. On selecting the name SampleMySQL, the parameter for this credential will be associated internally to this monitor and it gets added. You need not give the user and database name separately. When more monitors, say 20 monitors for MySQL type is added with the same Credential Name (SampleMySQL), it is easier for a user to maintain all of these in a single place. Any change in this credential, will be reflected to all the monitors associated with the credential. The credential manager support is available for servers, databases and application server monitors. In the Settings tab, click Credential Manager. Click Add Credential. Select the Credential Type. When a type is selected, fields associated to that type is displayed. You need to create a profile based on the type required.Provide a Credential Name. This name is used to associate credentials to monitors during discovery of monitors. When this name is mentioned, all the properties associated to this name will be associated to the monitor. Provide other details like the Username and Password. More fields are displayed as per the credential type selected. Click Save to add the credentials. You can edit or delete these credentials from the details page by clicking on the respective icons on mouse hover of a particular credential name. Credential Management in the Enterprise Edition You can add, edit or delete a credential from the Admin Server in Applications Manager, the same as in the Professional Edition, and the credentials get automatically synced with the Managed Servers. However, these credentials cannot be edited from the Managed Servers. Template Library Browse through the below topics to learn more about Template Library, available under Settings tab in Applications Manager: Server Process Templates Windows Service Templates Server Process Templates A server process template is a pre-defined reusable collection of processes. It provides an easy way to add multiple processes for monitoring across a group of servers. For example, if you want to monitor the ''init'' process in all your Linux servers, you can configure a server process template for this process and apply the template across all your Linux servers. This is better than manually adding the ''init'' process in your Linux servers one by one. Steps to Add a New Server Process Template: Under the Settings tab, click the Template Library option under the Discovery and Data collection table. Under Process Templates, you can find Server Process Templates option. Click on Add New to create a new template. Specify Template Name and Description. Click Add Process link to add processes for monitoring. You can either Manually Enter the Process Details or Choose Process Details from Available Servers. If you opt for the first option, specify the Process Name and Arguments. You can use Regular expressions while entering the Process Name and the Arguments by checking the Use Regular Expressions checkbox. (Regex Guide). If you opt for the second option, select the appropriate monitor type and the monitor(s), and click the Show Process link. All the processes running in the servers will be listed. Select the necessary process from the list and click OK. If you want to receive notifications when the threshold values of the process attributes are violated, you have to Configure Alarms for Attributes. The attributes of the process will be listed on the left-hand side. Click the Associate link corresponding to the attribute to open the Configure Alarms screen. Select the necessary threshold from the Associate Threshold list box. You can also Associate Actions for the thresholds if necessary. Choose the necessary action from the Available Actions list and add them to the Associated Actions list. By default, you can associate action for critical severity. If you want to associate actions for warning and clear severities, click theShow Advanced Options checkbox, and select the appropriate actions from the list. Click Add to Template button once you have configured the thresholds and actions.You can apply your process and threshold configuration under the Associate Configuration to Monitors section. You can either apply the configuration to monitor types or choose from a list of monitors or apply to specific monitor groups. To apply the configuration to specific monitor types, choose the Apply to Monitor Types option. The server types available in your Applications Manager installation will be listed below. Choose the required server type to apply the template to all servers of that type. To apply the template to individual monitors, choose the Apply to Monitors option and choose the necessary monitor(s) from the list. To apply the template to monitor groups, choose the Apply to Monitor Groups option and select from the monitor groups listed. Click Save Template to complete your server process template configuration. Note: Command & Arguments: F:\MySQL\mysql\bin\mysqld-nt.exe Applications Manager will check if the process is running and whether the command and arguments are same as that was being added initially. If the arguments change often then you can retain the command and remove the argument. You can also update the command & argument field with certain path which will not change throughout the lifecycle of the process. Example One: Process Name: java Command & Arguments: java/root/jdk1.5.0_07/bin/java -server -Xms128m -Xmx128m - Dprogram.name=run.sh -Dcom.sun.management.jmxremote - Dcom.sun.management.jmxremote.port=1999 -Dcom.sun.management.jmxremote.ssl=false - Dcom.sun.management.jmxremote.authenticate=false -Djava.endorsed.dirs=/root/JBoss/jboss- 4.0.2/lib/endorsed -classpath /root/JBoss/jboss-4.0.2/bin/run.jar:/root/jdk1.5.0_07/lib/tools.jar org.jboss.Main Example Two: Process Name: mysqld-nt.exe Command & Arguments: F:\MySQL\mysql\bin\mysqld-nt.exe mysqld-nt --defaults-file=..\my.ini -u root -b .. --tmpdir=..\temp --standalone --port=13326 --default-character-set=latin1 If the port or any other property changes often, you can just monitor the process using its name and command. Look at the command and arguments below for our recommendation w.r.t. the two examples above: Process Name: java Command & Arguments: /root/jdk1.5.0_07/bin/java Process Name: mysqld-nt.exe At present, there is no support for pattern matching in process monitoring. Adding a Server Process Template from the Admin Server (Enterprise Edition) You can create a new Server Process Template, associate services and configure alarms for attributes from the Admin Server using the same steps as in the Managed Server. However, templates configured in the Admin Server can be applied to different monitor types and monitor groups, not to individual monitors. Windows Service Templates A Windows service template is a pre-defined reusable collection of Windows services. It provides an easy way to add multiple services for monitoring across a group of Windows servers. For example, if you want to monitor the ''EventLog'' service in all your Windows XP servers, you can configure a Windows service template for this service and apply the template across all your XP servers at once. This is better than manually adding the ''EventLog'' service in your Windows XP servers one by one. Steps to add a new Windows Service TemplateUnder Settings tab, go to Discovery & Data Collection → Template Library → Service Templates and click on Add New. Specify Template Name and Description. Click Add Service link to add services for monitoring. You can either Manually Enter the Service Details or Choose Service Details from Available Servers. If you opt for the first option, specify the Service Display Name and Service Name. If you opt for the second option, select the appropriate monitor type and the monitor(s), and click the Show Service link. All the services running in the servers will be listed. Select the necessary service from the list and click OK. If you want to receive notifications when the threshold values of the service attributes are violated, you have to Configure Alarms for Attributes. The attributes of the service will be listed on the left-hand side. Click the Associate link corresponding to the attribute to open the Configure Alarms screen. Select the necessary threshold from the Associate Threshold list box. You can also Associate Actions for the thresholds if necessary. Choose the necessary action from the Available Actions list and add them to the Associated Actions list. By default, you can associate action for critical severity. If you want to associate actions for warning and clear severities, click the Show Advanced Options checkbox, and select the appropriate actions from the list. Click Add to Template button once you have configured the thresholds and actions. You can apply your service and threshold configuration under the Associate Configuration to Monitors section. You can either apply the configuration to monitor types or choose from a list of monitors or apply to specific monitor groups. To apply the configuration to specific monitor types, choose the Apply to Monitor Types option. The server types available in your Applications Manager installation will be listed below. Choose the required server type to apply the template to all servers of that type. To apply the template to individual monitors, choose the Apply to Monitors option and choose the necessary monitor(s) from the list. To apply the template to monitor groups, choose the Apply to Monitor Groups option and select from the monitor groups listed. Click Save Template to complete your Windows service template configuration. Adding a Windows Service Template from the Admin Server (Enterprise Edition) You can create a new Windows Service Template, associate services and configure alarms for attributes from the Admin Server using the same steps as in the Managed Server. However, templates configured in the Admin Server can be applied to different monitor types and monitor groups, not to individual monitors. Add / Discovery The Add / Discovery section consists of the following tabs: Add Bulk Import Discovery Network Discovery Dependency Map Global Settings options for ADDM Frequently Asked Questions (FAQs) Add In the Add tab, you can create a new monitor (i.e) discover the Monitor from the network and start collecting monitoring data. Learn how to create a new monitor Bulk Import Using the Bulk Import capability, you can add monitors of the same type in bulk. Bulk import of monitors is performed by using a .csv file which contains all the configuration details of the monitor you wish to add. Learn how to perform Bulk Import of monitorsDiscovery Network Discovery is the process of discovering all Monitors in a specified network. It discovers monitors running in the default port only. Prerequisites: Provided credentials should have the admin/root privileges. To discover all the monitors in a network: Click the Settings tab. Click Add/Discover under Discovery & Datacollection from the Settings tab. This opens the Add/Discover screen. Go to Discovery tab. This opens the Add New Discovery page. Enter the display name for the discovery to be created. Select the required credentials from the Credential List either from the existing credential details using Credential Manager or by adding new credentials. Select the Type with which the network IP Address should be entered for discovery. IP Address Range - Enter the From and To IP Address range within which the discovery should be performed. You can also provide multiple IP Address ranges (up to 10) for discovery by clicking the [+] button. CIDR - Enter the network address under which the discovery should be performed. You can use an IPv4 or IPv6 Address to add your network. VMWare - Allows you to discover the VMWare hosts from the vCenter infrastructure. Enter details such as hostname/IP address, Port, username, password and TLS Version of the vCenter. Also, you can choose to create a Virtual Infrastructure View of all the hosts and VMs associated to the vCenter infrastructure. Enter the SubNetMask of the network. Configure the port details for the services to be scanned during the discovery. You can either go with these default values or edit the ports. You can also specify multiple ports for each application separated by comma. After performing the above steps, click on one of the following buttons: Discover: Discovers all the possible monitors available within the mentioned network. Clicking this button will display the list of all the possible resources discovered within the network, from which required monitors can be selected and added using the Add Selected Devices button. Discover & Add: Discovers all the monitors available within the network and add them. Network Discovery The Network Discovery tab is displayed once the discovery process is completed. Here you can view the list of various devices (servers & applications) that have been discovered in Applications Manager. Also, there is an option to View Application Dependency Maps. In View Application Dependency Map page, you can create a monitor group among the applications discovered through the ADDM by enabling the ''Use Application Dependency Mapping (ADM)'' option. If disabled, you can create a monitor group by associating monitors manually to it. You can perform various operations to the required discovery profiles by selecting appropriate options given below from the Network Discovery table: View Discovered Details: Displays the list of all the servers and applications that were discovered from the network. Here, you can select the required monitors and add them using the Add Selected Devices option. Edit: Allows you to edit/modify the details entered in the discovery profile. View Report Page: Displays the list of servers and associated applications that were discovered and added in the discovery profile. Also, there is a ''Debug'' link available in the right-hand corner that shows the list of IP addresses for which credentials have not passed during discovery along with its error message. Delete: Allows you to delete the required discovery profile. You can delete the discovery profile by choosing either of the below two options: Delete discovery profile alone: Deletes only the discovery profile and excludes the monitors associated with it. Delete monitors from this discovery: Allows you to delete the selected monitors associated with the discovery profile. Here you can select the required monitors that need to be deleted and clicking on the Delete button will delete the monitors. Also, there is an option to delete the discovery profile, enabling which will delete the discovery profile. You can also delete the vCenter Infrastructure associated with the profile, enabling which will delete the vCenter Infrastructure along with the ESXi hosts associated with it. Schedule discovery: Allows you to schedule discovery in Daily, Weekly, or Monthly basis.Rediscover: While selecting ''Rediscover Now'' icon, discovery will get started using the configured details in the profile. Dependency Map Besides the Network Discovery table, you can view Dependency Maps created with the discovered resources under the Dependency Map table. This table shows the list of various dependency maps created along with the number of servers and applications added to this map view. On clicking the map name, you can find a visual map view of all the servers and their associated applications that are available and connected to each other. There are two types of dependency maps that can be viewed: Graph View: Show a visual representation of all the servers and their associated applications connected in the form of graphs. Tree View: Shows a visual representation of all the applications connected in the form of flowchart. You can obtain this view by disabling the Enable ADDM Dependency View option under Settings → Global Settings. Also, you can create a new map view by clicking over the Add New link. Global Settings options for ADDM Following are the list of options that can be found in Global Settings page: Show servers in Application Dependency Mapping - By selecting this option, servers will be included in application dependency map view. Discover unknown devices during ADDM discovery - Enabling this option will result in Applications Manager adding servers and applications for which credentials have not passed. Restart failed discoveries on startup - Enabling this option will restart failed discoveries during startup. Enable ADDM dependency view - On enabling this option, the Create Business view option in the Discovery reports page directs to create new dependency map option. On disabiling it, it redirects to Business view option. Frequently Asked Questions (FAQs) Question 1: How does "Network Discovery" function work? How to discover the network? Eg.Through what mode?Initially, Applications Manager gets all the Ip addresses in the given domain and then Applications Manager discovers them by using ping test. If the ping test succeeds and if SNMP agent is running on that machine, Applications Manager will try to add it to the appropriate category ( i.e., windows / linux / solaris ) and collect data, otherwise Applications Manager will add that server to unknown category. Question 2: If I add a new "Network Discovery", does it only discover once or discover at regular intervals? Because there are only "Add New" and "Disable Network Discovery" buttons, I don''t know when it will start to discover and when it will complete discovery. When you add Network Discovery, it will rediscover the network every time you restart Applications Manager and also it will do rediscovery once in every 24 hours. Once you start network discovery, it will start discovering the servers in the network. It will wait for 20 seconds interval between discovering servers. Question 3: I find "Network Discovery" can find a small part of the monitors in the network only, there are lots of monitors that can''t be found. In the professional trial version of Applications Manager, only 50 servers are discovered using Network Discovery. Question 4: I don''t want to monitor a certain monitor, I delete it manually; but I don''t disable network discovery, will it be discovered and monitored again? Yes, it will discover that monitor again in the next rediscovery which takes place after 24 hours. Services - Using this option, you can choose which of the services needs to monitored by default. The services are listed down along with their default ports. For eg., if you had already added a Windows Server monitor, by using this option, you can choose the services (that are running in that windows server) to be monitored. You choose to monitor all the tomcats & IIS servers that are running in the windows server. Data Collection does not happen for services that are not enabled, thereby increasing the efficiency of monitoring in general. By using the edit option, you can edit the port number. If there are multiple ports, enter the ports as comma separated. Custom Monitor Type By using this option, you can define your own monitor types apart from the monitor types that are available by default. This feature allows to associate a monitor type to the inhouse scripts that might be used for monitoring your own applications. For eg., if you are using various scripts to monitor Siebel CRM, you can now associate these scripts and model Siebel as one of the monitor types. Thereby having robust out of the box support for monitoring Forum Software, build Business Intelligence Dashboards, monitor Custom Application Log Files on multiple servers etc. Custom Monitor Demo: Have a look at the demo that helps you to add a new Custom Monitor Type WorkFlow Step1) The custom monitor type helps you create and define metrics / attributes that will be tracked. Step 2) Then specify a script (Linux Shell Script / Windows Batch File) that needs to be executed to get the data and provide it to Applications Manager in the appropriate format. In these scripts users can use any mechanism to get the data. For example users can : Invoke a Java Program, PHP, Python Scripts etc and make database calls to pull data and feed it to Applications Manager Can make native calls to other programs and pipe the data to the output file Parse Log Files and give a summary of metrics as the input to Applications Manager Creating New Monitor Types: You can create new monitor type by clicking on the ''New Monitor Type'' link inside the New Monitor link or by clicking on the Custom Monitor Types icon under Admintab.Enter the Monitor Type name Select Base type - Currently, scripts are the base to build new monitor type. Select the Monitor Type Category - For eg., If you are monitoring postgresql using in-house scripts, you can add postgresql monitor type and you can place it under Database category Define the attributes you want to monitor Enter the String Attributes that you want to monitor - Enter the attributes line by line. Enter the Numeric Attributes that you want to monitor - Enter the attributes line by line. You can monitor the output in a table format, enter the Table Name, Numeric attributes, Sting attributes, Unique column and Column delimiter. More help. Click on Create Monitor Type to finish the configuration of new monitor type. Now, you have defined a custom Monitor type. The next step would be to create instances & associate them to the new monitor type defined. [Script Monitor Overview: Based on the polling interval, Applications Manager executes the script to be monitored. The script will transfer its output to another specific Output File configured. The output of the script should be in a Key=Value format where ''='' can be any delimiter. Applications Manager parses the Output File and executes the actions configured] Adding Custom Monitors: In the User Created Monitor Type screen, the newly created monitor types are listed down. Click on the Add New icon to add the monitors Add New monitor screen opens up, Select the custom monitor type from Monitor Types drop down box. [ For eg., Siebel] Enter the Display Name. Choose the location of script that you want to monitor - Local or Remote. Specify the absolute path of the script. Specify the absolute path of the execution directory. Specify the absolute path of the Output File Enter the arguments that needs to be passed. Enter the polling interval and timeout. Click Add Monitor(s) You have already given the attributes to be monitored as common to all monitors under custom Monitor Type. So there is no need to give input attributes to be monitored again Upon adding the custom monitors, you can see the performance attributes in the monitor details page.Usage Scenario 1: Creating New Siebel Monitor Type One customer had 6 Siebel applications running in 6 different machines. As, out of the box support for Siebel Application is not available, he uses the Script Monitoring feature of ManageEngine Applications Manager to monitor his applications. He has identical scripts running in the 6 machines and they produce the same output in the output file in the respective machines. Now he configures them as six Script Monitors. This gives him an opportunity to monitor his Siebel applications. Using Script Monitor facility, he monitors the following attributes transaction Router server request processor transaction processor There are few disadvantages in his usage. 1. He has to give the same Output details while specifying the same six applications. 2. If he has to edit / add / delete the attributes , then he has to do so in all the 6 Script Monitors. 3. Further he would like to see them as 6 Siebel Monitors rather than 6 Script Monitors. Here comes the usage of New Monitor Type, that would avoid all the above inconveniences. 1. Output Settings can be specified only once. You could specify the Scalar String / Numeric attributes and tabular settings only once while defining the type, say Siebel. 2. You could create any number of monitor instances for that particular type , just like any other in-built type say SAP / Weblogic / Oracle monitors in Applications Manager. While doing so, you just need to specify the Hostname and the corresponding Scripts 3. Adding / Deleting / Modifying attributes of some particular monitor type commonly will affect all the monitors of that monitor type. 4. Now you will be seeing 6 Siebel monitors rather than 6 Script Monitors. 5. Reports can be enabled for this type like any other type. The same concept can be applied to any other application say for monitoring People Soft applications. Usage Scenario 2: Business Intelligence Dashboard Users can build custom Business Intelligence dashboards and have it reported and alerted on. Some possible metrics could be Call Volume in the last one Month Time taken to finish a call Number of simultaneous Calls Usage Scenario 3: Custom Application Log Files Some metrics that you can add with a little bit of coding are : Number of security breaches Number of Errors During Login etc. Managing Custom Monitor Types: You can edit the configuration of the Monitor types by clicking on the Custom Monitor Type link under Admin Tab. It opens up to list all the User created Monitor Types. From here you add new monitors to the custom monitor types, edit the configuration and more importantly enable or disable reports of these custom monitor types. Performance PollingUnder the Performance polling tab, you can see performance data collection options like: Data Collection Servers Database Servers MS SQL MySQL WebLogic SNMP HTTP(s) URLs Amazon Web Services Ping Monitor Optimize Data Collection Data Collection Using this option, Performance Data collection can be scheduled for the given number of polls. Except for Availability check and health, other performance parameters like memory usage data can be collected at the scheduled number of polls. This would be helpful in decreasing the load on the system of the users who want to monitor availability and health alone. For eg., If the polling interval of a particular server monitor is one minute and the performance data is scheduled to be collected once in five pollings. In this case, the availability of the server is checked every minute whereas the performance data like CPU Memory is collected every five minutes. Servers Disk I/O Statistics Monitoring: Using this option, Disk IO Stats can be Enabled or Disabled for the servers. On enabling the option, Data Collection will happen for Disk IO stats and you can see the details of Disk IO Stats in the Server details page. If it is not enabled, Data Collection will be stopped for Disk IO Stats. Note: This option is available for Windows, IBM AIX, Linux and Solaris servers. Disk Monitoring: Windows Disk Monitoring option can be used to enable or disable monitoring of Local Disk, Network Mapped Drives and Volume Mount Points. By default, Local Disk monitoring is enabled for all Windows servers. Delete Server Disk: You can use this option to enable or disable monitoring of Windows Network Mapped Drives, and Windows Volume Mount Points. By default, Local Disk monitoring is enabled for all servers and Hyper-V virtual machines. Ignore specific disks : You can set Applications Manager to ignore data collection of specified disks. You can specify multiple comma-separated disks. Note: Details associated with Windows Network Mapped drives and Windows Volume Mount Points will not be collected in SNMP mode. Memory Utilization: You can use this option to enable/disable monitoring of memory utilization for specific servers if required. Skip buffer and cache from monitoring: This option can be used to exclude buffer and cache memory values from physical memory calculations. You can also choose to skip monitoring for the required servers by specifying their hostnames in the textbox, if required. Note: All the servers will have memory utilization monitoring enabled by default. Inode Monitoring: You can use this option to enable or disable Disk Inode Monitoring. However, Inode statistics will not be collected in the SNMP mode. Note: This option is available for Linux and IBM AIX servers. Process & Service monitors availability: You can also set the Process & Service monitors availability to show process and server monitors as down when the server is down.Server Error Alert Settings: Server Error Alert settings option will allow you to select the severity levels of server error at which you want to get alerted. Hardware Health monitoring: Server Hardware Health monitoring can be used to enable or disable hardware monitoring in servers. You can also opt the various hardware components (like power, fan, disk,etc.,) to be monitored by checking the options given. This will globally configure the hardware monitoring status.You can do the same for individual monitors in the respective monitor details page. Hardware Device level configuration: Hardware Configuration option is also available under Host Details on the right hand side of the details page, will allow you to opt for the various hardware components you want to monitor. You can also use this option to change the globally configured hardware status for a particular server. You can customize alerts for hardware device monitoring. If the status of the device matches with the values defined in the severity text box, then the device status is displayed as the corresponding severity. For example, the nonCriticalLower status need not be defined as a ''Warning'' status, it can also be defined as ''Clear'' according to user requirement. The alarm severities are: Critical Severity: If the status matches with any of the values defined in the Critical Severity text box, then APM displays the status of the hardware device as Critical. The values defined by default are failed, error, failure, nonRecoverable, criticalUpper, criticalLower, nonRecoverableLower and critical. Warning Severity: If the status matches with any of the values defined in the Warning Severity text box, then APM displays the status of the hardware device as ''Warning''. The values defined by default are degraded, warning, nonCritical, nonCriticalUpper, nonRecoverableUpper and nonCriticalLower. Clear Severity: If the status matches with any of the values defined in the Clear Severity text box, then APM displays the status of the hardware device as ''Clear''. The value defined by default is ok. Note: If the status of the device does not match with any of the values defined in the severity text box, the device status is displayed as ''unknown''. Status values defined within the severity text boxes are comma- separated and case-insensitive. Database Servers Enable MySQL Database Monitoring - By default, the data collection for MySQL database tables takes place for every polling. You can customize it, such that the data collection for databases takes place only once in a day or to never collect data. Enable Sybase Database Monitoring - By default, the data collection for Sybase database tables takes place for every polling. You can customize it, such that the data collection for databases takes place only once in a day or to never collect data. Rediscover instance of Mongo DB, Cassandra and Redis - By default, rediscovering instances of Mongo database, Cassandraand Redis happens in 60 minutes. You can customize the time interval which instance of Mongo database, Cassandra and Redis are rediscovered. Oracle Monitoring - By default, only failed backup jobs of Oracle will be monitored. WebLogic Using this option, You can Enable or Disable Data Collection for Web Applications, EJBs and Servlet Statistics for Weblogic servers. The list of Weblogic servers are displayed by selecting the checkbox. Data Collection will happen for the Weblogic components that are displayed under the corresponding Enable listbox. By default, EJB and Servlet Data Collection are disabled. You can enable Data Collection for EJB and Servlet by selecting the Weblogic server from Disable list box and move it to the Enable listbox and save the configuration. MS SQL Enable data collection By Default, the data collection for MS SQL scheduled jobs will be disabled. You can enable it by checking the Start collecting data for MS SQL scheduled jobs checkbox. Check the Delete MSSQL jobs checkbox to delete jobs from the monitor details page. To enable Secure Connection (SSL), check the Connect with SSL Encryption checkbox. To monitor Data/Log file, DBCC CHECKDB & DBCC INDEX Command Status, and VLF Details, Applications Manager establishes connections to each database in the respective SQL Server and fetches the required metrics. If you do not want to allow this, check the Disable connections to database(s) option to disable the monitoring of the mentioned components. AvailabilityWhen connectivity problems occur, try connecting again(after 10 seconds) before showing the Monitor''s Availability as down: When a monitor is down due to intermittent network connectivity, you can make sure that the SQL monitor is not completely down by checking this option to check the connection one more time before throwing an alert. Database Metrics Collect SQL Data File / Log file details once in an hour: Select the "Collect SQL Data File / Log file details once in an hour" option to enable the collection of Data / Log file & VLF related metrics once every hour. If this option is deselected, data will be collected during each poll. Collect VLF details once in a day: Enable "Collect VLF details once in a day" option to collect VLF details once a day. Jobs Start collecting data for MS SQL scheduled jobs: By default, the data collection of MS SQL scheduled jobs will be disabled. You can enable or disable it here. When you select this option, the following will be monitored: Job status, Next Scheduled time, Time Taken and Retry count. Enable SQL-Jobs History: Select the "Enable SQL-Jobs History" checkbox to keep the execution history of each job for the given period of time- which you can specify. Delete jobs from Applications Manager when it is removed from SQL Server: Select "Delete jobs from Applications Manager when it is removed from SQL Server" checkbox to delete the scheduled jobs automatically from the monitor details page when deleted from the SQL Server. Alert Skipped Jobs: Check the "Alert Skipped Jobs" checkbox to get an alert when a job''s execution is skipped from its schedule. Backup Delete backup entries from APM when its database is removed: Select "Delete backup entries from Applications Manager when It''s database is removed" option to delete the backup entries corresponding to the SQL server that has been removed from Applications Manager; although the backup files will exist on the server. You can also mention the number of days for which you want the backup details to be stored. Replications Enable SQL-Replications: To collect and monitor replication details of a SQL server, select the "Enable SQL- Replications" option. Enable SQL-Replications Failed History: Select this option to keep the history of failed replications. You can also mention the number of days for which you want the replication agent history to be maintained. Applications Manager allows you to enable/disable data collection of the SQL Server Performance metrics listed here. Once enabled, you can also customize the polling interval of these metrics. Note: The customized time interval should be greater than or equal to the polling interval of the monitor. MySQL Enable data collection for database: Using this option, you can enable or disable data collection for database tables, to takes place Once in a Day. By default, the data collection takes place for every polling. You can enable/disable datacollection for Database Tables by selecting the "Collect Database tables information once in Day" checkbox and save the configuration. SNMP SNMP Version: Using this option, you can choose different SNMP versions (v1/v2c) to monitor the SNMP devices/servers in SNMP mode. SNMP Trap Storm: You can configure to disable your trap listeners whenever trap storm occurs. Disable all trap listeners when total trap storm occurs: Using this option, you can disable all trap listeners when the total incoming traps rate exceeds the configured value. Disable specific trap listener when individual trap storm occurs: Using this option, you can disable the specific trap listener when the incoming identical traps rate exceeds the configured value.By configuring the above settings, SNMP trap listeners will be disabled temporarily for the configured duration. Note: Changing the time duration / restarting Applications Manager will enable the temporarily-disabled SNMP trap listener(s). HTTP(s)-URLs Under the HTTP(s)-URLs tab, you can change the following settings: Enable logging of Responses for the Http(s) Urls and Http(s)-Url Sequences monitoring in Applications Manager - Enabling this option allows you to log the responses of the HTTP(s) URLs or HTTP(s) Sequences in \working\Debug-Info\URL Directory. Send Responses of the Http(s) Urls and Http(s)-Url Sequences along with configured alarms when the availability is down - This option allows Applications Manager to send the alarms along with the link to the responses of the HTTP(s) URLs Sequences that you have logged. This response will be send whenever the availability of the HTTP(s) URLs goes down. Amazon Amazon Data Collection - Settings Here are the data collection settings that you can configure: You can set the Unique Identifier for EC2 instances to be either the instance ID or a tag name. Caution: Once set, changing the Unique Identifier will result in the existing monitors being deleted. If a new instance with Tag name of an already terminated instance is launched, it will be merged with the former instance. Enable the Alert for Terminated EC2 Instance option to receive notification when an instance is stopped. Enabling the Remove terminated EC2 Instances option completely removes terminated EC2 Instances from the Applications Manager console in the next poll. By default, this option is disabled. Enable it if you find a terminated EC2 instance in the Applications Manager console, after it was removed from the AWS console (If a user terminates an EC2 instance it will be removed from the AWS console after 60 minutes.) Web Services Under the Web Services Operation - Settings tab, you can set the Operation''s Execution time beyond which to enable logging of responses for the Web Service''s Operation in Applications Manager. The responses of the web services operations are logged in the following directory: working\Debug-Info\WebService Directory. Ping Monitor Applications Manager allows you to configure packets to be sent for ping monitoring. Optimize Data Collection Applications Manager allows you to enable/disable data collection of the metrics listed in the Optimize Data Collection tab. Once enabled, you can also customize the polling interval of these metrics. Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. The Optimize Data Collection option works as follows for the following monitor types: Java Runtime Tomcat Server Amazon Script Monitor File/Directory Monitor Database Query Monitor PostgreSQL Oracle SAP HANAExchange Server IBM Websphere MQ RabbitMQ FTP/SFTP Monitor JMX Applications VMware ESX/ESXi XenServer Oracle Cloud Elasticsearch Cluster Java Runtime Applications Manager allows you to update the number of days to retain Thread dumps of JRE Monitorwithout restart. The number of days is 30 by default. Tomcat Server You can enable/disable data collection of the metrics listed here: Web Applications Details Servlets Details DataSource Connection Pool Details Thread Pool Details Global Request Processor Details Memory Pool Details Garbage Collector Details Stuck Threads Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. Amazon You can enable/disable data collection of the S3 Bucket metrics. Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. Script Monitor Applications Manager allows you to Enable Script Row Deletion. For example, consider the script monitor''s tabular data. If the Enable Script Row Deletion option is enabled, each time a new row is created , the previously configured thresholds and actions will be removed. If the option is disabled, all the configurations will be retained. You can also configure health severity based on exceptions occurred in Script/Custom monitor types with the help of ''Affect health when exception occurs'' option. Using this option, you can change the health status (and not Availability) of the monitor based on specified exception types for each severity (Critical, Warning, and Clear).After enabling, you can configure by entering the required exceptions for each severity (Critical, Warning, and Clear) in their respective textbox. File/Directory Monitor You can set the File contentCheck string count and the default units used to measure the Directory size and File size. Database Query Monitor You can set the Query monitor row count and the Query execution timeout in seconds. PostgreSQL You can enable/disable data collection for the following metrics: Database details, Long Running Query Details, Top 50 Table Row Details, Session Details, and Top Queries by CPU. Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. Oracle You can enable/disable data collection of the metrics listed here: Lock and Wait Statistics Top 10 Queries by Disk Reads Top 10 Queries by Buffer Gets Average Executions for database instance Backup Jobs and Blocks Corrupted. Objects Approaching Max Extents Log Apply Gap details in Primary Servers Archive Log Destination Monitoring Log Apply Lag details in Standby Server ASM details Oracle Scheduled Jobs TableSpace Statistics Recovery Area Usage Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. SAP HANA You can enable/disable data collection of the metrics listed here: Expensive Statements Long Running Jobs System AlertsBackup Catalog Blocked Transactions Caches Schema Details Disk Usage Disk Volume Volume IO Statistics Memory Used by Tables Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. Exchange Server You can enable/disable data collection of the metrics listed here: Top Mailboxes By Size Inactive Mailbox Users Server Component States Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. The customized time interval should be greater than or equal to the polling interval of the monitor. IBM Websphere MQ You can enable/disable data collection of the metrics listed here: Listener Statistics Service Statistics Channel Statistics Queue Statistics Performance Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. The customized time interval should be greater than or equal to the polling interval of the monitor. RabbitMQ You can enable/disable data collection of the metrics listed here:Exchanges Connections Queues Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. You can configure polling status by: Monitor Type: This will be the default polling status, for any new monitor added. All the monitors of this type, will have the default polling status, until any exclusive customization is done for the monitor. Monitors: Use this option to change the polling status of any particular monitor(s). Note : Changing the polling status of the ''Monitor Type'', will also change any customizations done for its monitors. The customized time interval should be greater than or equal to the polling interval of the monitor. FTP/SFTP Monitor You can set the FTP file size in MB. The Value is 10 by default. The update will take effect without restart. JMX Applications You can set the MBeans list size. The Value is 250 by default. The update will take effect without restart. VMware ESX/ESXi You can set the VMWare read timeout and the VMWare API connection timeout in seconds. Both Values are 18 0 by default. The update will take effect without restart. XenServer Applications Manager allows you to enable the discovery of your Xenserver resource-pools. The update will take effect without restart. Oracle Cloud Under the Optimize Data Collection tab, select the monitor type and the metric name that you want to enable/disable from the respective drop-down menus. Enable faster data collection - Enabling this option will make the data collection faster by using multiple threads. Elasticsearch Cluster Applications Manager allows you to configure the maximum number of indices that are to be displayed in the Elasticsearch Cluster based on the number of documents available for each index in decreasing order. You can configure the maximum number of indices up to 250. Downtime Scheduler Scheduled downtimes for planned outages IT-operations distinguish between two types of outages: planned and unplanned. Planned Outages are necessary to carry out essential maintenance. But the monitoring system initially cannot know if a detected outage was planned or not. If a monitor/ service is removed from the network, or rebooted, for maintenance, then you will see unnecessary alarms indicating that the monitor or application is unavailable when polled for status. With the concept of scheduled downtimes in Applications Manager, the system can be informed of planned outages by a host or service by defining a scheduled downtime for the corresponding object. To prevent the monitors/services from being monitored for status during maintenance, you can schedule a maintenance task for such monitors. Downtime Scheduler OverviewGo to the Settings tab. Click on the Downtime Scheduler view. The Downtime Schedules page displays 4 tabs: Downtime Schedules (How to create a new schedule) Downtime Scheduler Settings Monitors currently under maintenance Monitor Groups currently under maintenance   Creating a new downtime schedule The Downtime Scheduler provides you with the option to schedule a time period for which monitoring can be paused. You can choose between time periods of recurrence — Daily, Weekly, Monthly or Once. You can add a new Schedule and view it from the Settings tab. Follow the given steps to add a schedule: Click Add New. It takes you to ''New Schedule'' page. Enter the Task Name. Enter the Description of the Task. By default, the Status would be ''Enable''. Under Recurrence Details, choose the time period for which monitoring is not needed. The schedule can be Daily, Weekly, Monthly or Once. (You can use the Edit option to modify the time period later). If you select Daily, specify the Start Time and Completion Time of the schedule. You can also choose the starting date for the schedule. If you choose Weekly, you can specify upto 7 schedules for the week. Specify the Start Time and Completion Time of the schedule and press More to create another schedule. If you choose Monthly, specify the frequency of the schedules — all months, alternate even/odd months, quaterly, triannual, custom and biannual. If Custom is selected, you''ll have to choose the Months and choose whether you want to specify the schedule by date or week depending upon which, you''ll have to provide the Start Time and Completion Time. If date is chosen, select the date and enter the time for start time. To choose the day of the month in reverse order, check the Last option. You can choose upto the 7th day from end of the month. If week is chosen, select the week number and the day of the week, and enter the time for start time. Enter the span in number of days and the time of the day for Completion time. You can add upto 5 schedules in monthly. If you choose Once, provide the Start Time, End Time along with the date of the schedule. Press More to create another schedule. You can add upto 5 schedules in once.By enabling the Select Timezone checkbox you can select the required timezone from the drop-down list. In the Monitors Details table, you can associate the downtime scheduler task to your monitors and process monitors for which monitoring is not needed. You can either associate the task to the existing list of monitors listed or to the monitor groups available. Select the Monitors for which monitoring is not needed. On saving, the chosen Monitors would have their Maintenance Tasks scheduled. Note: After creating a new downtime schedule, it takes about 10 to 15 minutes to sync the data from the Admin server to Managed servers. If you want to add downtime schedules for processes and/or Windows services, you should select the Enable downtime scheduling for processes/Windows Services option under the Downtime Scheduler Settings tab. Downtime Scheduler Settings You can change the following settings under the Downtime Scheduler Settings tab by enabling the checkboxes respectively: Show the status of a monitor as up when under Downtime Schedule. Clear the health alert during Maintenance Period. Automatically revert unmanaged monitors to unmanaged state after scheduled maintenance. Enable Downtime Scheduling for Processes/Windows Services. Monitors and Groups Under Maintenance Monitors currently under maintenance The Monitors currently under maintenance tab displays a list of all monitors currently under maintenance. You can select the option to either: Show all monitors under maintenance or Show individual monitors under maintenance The Table displays the following details about the monitors under maintenance: The name of the monitor The monitor type Monitor Groups to which the monitor is associated. The maintenance schedule name. Maintenance Start and End Time Monitor Groups currently under maintenance The Monitors groups currently under maintenance tab displays a list of all monitors groups currently under maintenance. The Table displays the following details about the monitors under maintenance:The name of the monitor group The maintenance schedule name. Maintenance Start and End Time Creating a new downtime schedule The Downtime Schedules table displays: The Schedule Name Status of the schedule Occurrence Periods Next schedule time i.e the start time, end time and the corresponding time zone. Edit  and delete options are available in the table to modify the schedule or delete it. Creating a new schedule The Downtime Scheduler provides you with the option to schedule a time period for which monitoring can be paused. You can choose between time periods of recurrence - Daily, Weekly or Once.  You can add a new Schedule and view it from the Settings tab. Follow the given steps to add a schedule: Click Add New. It takes you to ''New Schedule'' page. Enter the Task Name. Enter the Description of the Task. By default, the Status would be ''Enable''. Under Recurrence Details, choose the time period for which monitoring is not needed. The schedule can be Daily, Weekly or Once. (You can use the Edit option to modify the time period later.) By checking the Select Timezone checkbox you can select the required timezone from the drop-down list. Set the Start and Completion time. In the Monitors Details table, you can associate the downtime scheduler task to your monitors and process monitors for which monitoring is not needed. You can either associate the task to the existing list of monitors listed or to the monitor groups available. Select the Monitors for which monitoring is not needed. On saving, the chosen Monitors would have their Maintenance Tasks scheduled. Note: If you want to add downtime schedules for processes and/or Windows services, you should select the Enable downtime scheduling for processes/Windows Services option under ''Downtime Scheduler Settings'' tab. Downtime Scheduler Settings You can change the following settings under the Downtime Scheduler Settings tab by checking the checkboxes respectively: Show the status of a monitor as up when under Downtime Schedule. Clear the health alert during Maintenance Period. Automatically revert unmanaged monitors to unmanaged state after scheduled maintenance. Enable Downtime Scheduling for Processes/Windows Services. Monitors and Groups Under Maintenance Monitors currently under maintenanceThe Monitors currently under maintenance tab displays a list of all monitors currently under maintenance. You can select the option to either: Show all monitors under maintenance or Show individual monitors under maintenance The Table displays the following details about the monitors under maintenance: The name of the monitor The monitor type Monitor Groups to which the monitor is associated. The maintenance schedule name. Maintenance Start and End Time Monitor Groups currently under maintenance The Monitors groups currently under maintenance tab displays a list of all monitors groups currently under maintenance. The Table displays the following details about the monitors under maintenance: The name of the monitor group The maintenance schedule name. Maintenance Start and End Time OAuth Provider OAuth 2.0 support for Rest API authentication OAuth 2.0 is the industry-standard protocol for authorization. OAuth Provider profiles can be set up here. Adding an OAuth Provider in Applications Manager will generate an Access Token that can be used to authenticate an API endpoint secured by OAuth 2.0 in Rest API Monitor. Three types of grants are supported: Authorization Code Grant Client Credentials grant Resource Owner Credentials Grant If the REST API endpoint is authenticated using an OAuth token, you can configure an OAuth provider from : The Add new OAuth Provider link in the new monitor page - Click the "Add new OAuth Provider" after choosing Use OAuth in the Add new Rest API monitor screen. The OAuth Provider link under the Settings tab - Provider profiles can be set up here. Once a OAuth Provider profile is set up, the Provider table displays the following information: Provider Name - The name of your OAuth Application provider. Access Token - String or a JSON web token used by an application to access the API. Refresh Token - Credentials that can be used to acquire new access tokens. Access Token Expiration Time - The date and time that the token will expire. Add new OAuth Provider Visit the OAuth Provider page where Applications Manager has been registered as a client. Refer to the Client ID and Client Secret and fill in the following details in the Applicarions Manager client to add the new provider: Enter the Provider Name - the name of your OAuth Application provider. Enter the Client ID & Client Secret- The unique alphanumeric string that you received from the OAuth provider while registering Applications Manager as a client. Specify the OAuth Flow based on the authorization flow supported by the REST API Authorization Code Grant Type: Authorization endpoint URL: The API Authorization Endpoint of the OAuth providerScope: Specify the OAuth scope that Applications Manager might need to request for the access of the REST API resource. You can provide multiple scopes depending on the level of access you need while monitoring. Query parameters: Additional query parameters "name-value pair" that needs to be appended to the authorization endpoint URL along with the standard params like: redirect_uri and response_type. Note: The parameters client_id, client_secret & grant_type need not be added explicitly, as they are sent by default. Redirect URI: The Applications Manager URL to which the redirection happens after a successful authorization. This will be auto-populated and can''t be modified by the user. Client Credentials Grant Resource Owner Credentials Grant Type: a. Username & Password: The credentials the application being accessed by the REST API Enter the Token endpoint URL of the OAuth Provider from where the Access Token is retrieved. Specify the Token Request Method - the Method to send the client ID and Secret in the request to get the Access Token. Basic authentication sends the data as Authorization header, while Post Request Body will send them as POST payload. Enter the Request body with any other parameters to be sent in the request POST payload. ( All data will be sent as form payload type.) Specify the Authenticated request method used to submit access tokens to this OAuth provider. Note: Use the following values to configure OAuth setup for SDP Cloud: Authorization endpoint URL : https://accounts.zoho.com/oauth/v2/auth Scope : SDPOnDemand.requests.ALL SDPOnDemand.setup.ALL SDPOnDemand.general.ALL Query Parameters : Name - access_type Value - offline Token endpoint URL : https://accounts.zoho.com/oauth/v2/token Choose Post request body for Token Request Method.   Use the following values to configure OAuth setup for Site24x7: Authorization endpoint URL : https://accounts.zoho.com/oauth/v2/auth Scope : Site24x7.Admin.Read Site24x7.Reports.Read Query Parameters : Name - access_type Value - offline Token endpoint URL : https://accounts.zoho.com/oauth/v2/token APM Insight Agent Configuration Profile You can fine-tune your application monitoring by modifying the APM Insight agent configuration profile. The APM Insight agent configuration profile enables you to set threshold values for key parameters for web and background transactions. Adding an agent configuration profile Editing an agent configuration profile Configuration profiles - Parameters and default values Note: Changes to the APM agent configuration profile are applied at the application level, not the instance level. If your application has many instances, changes in the configuration profile are applied to the application as a whole, and will be reflected across all respective instances. Adding an agent configuration profile To create an APM Insight agent configuration profile, follow the steps given below:Log in to your Applications Manager account. Navigate to Settings → Discovery & Data Collection → APM Insight Agent Configuration Profile → Add New. Enter your Profile Name and choose your agent type. Configure other parameters. Click Save.   Note: In general, the default configuration profile (with default parameter values) will be assigned to your applications. Any changes made to the default configuration profile will be automatically reflected across all applicable agents. You can also clone configuration profiles with custom parameter values, and apply it to your respective applications. Editing the agent configuration profile Navigate to APM Insight → Your application → Edit APM Insight Application Configuration icon. Go to Configuration Profile → APM Insight Agent Configuration Profile. Click on the drop-down menu to access profiles for the respective agent type. Choose the concerned profile and click Save.   Configuration profiles - Parameters and default values The APM agent configuration profile is categorized into three parts—basic configuration profiles, web transaction configurations, and background transaction configurations. Click on the following links to view the parameters with respect to various agent profiles supported: JAVA Configuration profile DOTNET Configuration profile DOTNET SERVICE Configuration profile DOTNET DESKTOP Configuration profileDOTNET CORE Configuration profile PHP Configuration profile PHP WINDOWS Configuration profile NODEJS Configuration profile RUBY Configuration profile Configurations available only in apminsight.conf file (common for all agent) JAVA Configuration Profile Basic Configuration Profiles: Name Key Description Default value Enabling this option will listen to all SQL Capture Queries which gets executed. If this database sql.capture.enabled True option is disabled, no Database Metrics SQL Queries will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true). Obfuscate Disabling this option will give you the SQL transaction.trace.sql.parametrize True real query (with parameters). It is Parameters recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will collect the threshold for stacktrace whenever any sql query SQLs in transaction.trace.sql.stacktrace.threshold 3(seconds) executed above this threshold time transaction value. trace Display Port number of application instances will Instance show.instance.port.number True be shown, if this option is enabled. Port number The log level at which the APM Insight Logging agent should record information. apminsight.log.level INFO level Supported levels are SEVERE, WARNING, INFO and FINE. Web transactions of the specified URL List of URL patterns will be skipped while tracking. *.css, *.js, extensions Use comma (,) to separate multiple *.gif, *.jpg, to be entries *.jpeg, transaction.skip.listening skipped Example: *.bmp, from transaction.skip.listening=*.jpeg, will *.png, tracking skip listening to transactions ending with *.ico .jpeg List of exceptions to be Enter the list of exceptions that need not exceptions.ignore None skipped be tracked. from tracking Provide regex patterns or transaction Skip names that can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Web Transactions Configurations: Name Key Description Default value Apdex apdex.threshold Application Performance Index (simply 0.5Threshold called Apdex) is measurement of an (seconds) Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transaction.tracking.request.interval transactions. If set to 5, APM Insight tracks 1 (request) factor only 1 in 5 requests of the same kind. Enabling this option will construct Trace Enable for Slow Transactions. You can view the transaction transaction.trace.enabled True traces collected in APM Insight Page by tracing selecting Traces tab. Trace of any transaction whose response time scoring above the specified Transaction threshold value will be collected, provided tracing transaction.trace.threshold 2 (seconds) if transaction.trace.enabled is set to true. threshold The trace can be used to analyze, troubleshoot the transaction working. Capture Trace snapshot will be taken for all HTTP trace if request(s) which has total external external webtransaction.trace.external.components.count.threshold components (like MYSQL, MEMCACHED, 50 (Count) calls etc) call count equal or higher than the exceeds configured number. Capture CPU time Record CPU time for every HTTP request, if webtransaction.record.cputime.enabled True per enabled. transaction? Capture Memory When enabled, memory allocations for all allocation webtransaction.record.memory.allocation.enabled 2 (seconds) web transactions will be captured. per transaction? Enabling this option captures parameters of all GET & POST web requests To skip capturing specific parameters use Capture webtransaction.trace.input.params.ignore HTTP webtransaction.trace.input.params.record False key parameters? Captured parameters can be viewed by selecting the required transaction in Traces tab To skip capturing specific web request password, parameters like password, PIN or any pswd, confidential values, specify those pass, parameter names for this key List of HTTP authKey, parameters webtransaction.trace.input.params.ignore Use comma(,) to separate multiple entries. parentId, to ignore Values specified for this key are case- parentID, sensitive resourceId, resourceID, If no value is specified, all request id, ID parameters will be recordedList of HTTP http.errors.ignore This is the list of HTTP error codes, like None error codes 400, 401, and 500, that will not be to be tracked. ignored from tracking Capture Captures Bytes in and out in network capture.http.network.bytes True HTTP Bytes requests, if this option is enabled. Background Transactions Configurations: Name Key Description Default value Enabling this option, APM Insight agent starts tracking Track background transactions background bgtransaction.tracking.enabled True transactions All transactions other than HTTP are considered as background transactions Enabling this option, the agent collects traces for slow Capture background transactions, bgtransaction.trace.enabled True traces provided bgtransaction.tracking.enabled is set to true Traces will be collected for background transactions whose Transaction response time have crossed the 5 trace bgtransaction.trace.threshold specified threshold value, (seconds) threshold provided bgtransaction.trace.enabled is set to true Trace snapshot will be taken for Capture background transactions which trace if has total external components 50 external  bgtransaction.trace.external.components.count.threshold (like MYSQL, MEMCACHED, etc) (Count) calls call count equal or higher than exceeds the configured number. Capture Record CPU time for every CPU time bgtransaction.record.cputime.enabled background transaction, if False per enabled. transaction? Capture Memory allocated for Memory background transactions will allocation bgtransaction.record.memory.allocation.enabled False be captured, if this option is per enabled. transaction? Sampling factor for background transactions Sampling 1 bgtransaction.tracking.request.interval If value is set to 1, agent tracks factor (Request) every transaction. If value is set to n, agent tracks 1 in n transactions of same kind DOTNET Configuration profile Basic Configuration Profiles: Name Key Description Default valueCapture sql.capture.enabled Enabling this option will listen to all True database SQL SQL Queries which gets executed. Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate SQL transaction.trace.sql.parametrize Disabling this option will give you True Parameters the real query (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will collect the threshold for stacktrace whenever any sql query transaction.trace.sql.stacktrace.threshold 3(seconds) SQLs in executed above this threshold time transaction trace value. Port number of application instances Display Instance show.instance.port.number will be shown, if this option is True Port number enabled. The log level at which the APM Insight agent should record Logging level apminsight.log.level information. CRITICAL Supported levels are SEVERE,WARNING, INFO and FINE. Web transactions of the specified URL patterns will be skipped while tracking *.css, *.js, List of URL *.gif, *.jpg, extensions to be Use comma(,) to separate multiple *.jpeg, transaction.skip.listening skipped from entries *.bmp, tracking Example: *.png, transaction.skip.listening=*.jpeg, *.ico will skip listening to transactions ending with .jpeg List of exceptions to be Enter the list of exceptions that need exceptions.ignore None skipped from not be tracked. tracking Provide regex patterns or transaction Skip names that can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Web Transactions Configurations: Name Key Description Default value Apdex apdex.threshold Application Performance Index (simply 0.5 Threshold called Apdex) is measurement of an (seconds)Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 5 transaction.tracking.request.interval factor (request) If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace Enable for Slow Transactions. transaction transaction.trace.enabled True tracing You can view the traces collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified Transaction threshold value will be collected, provided 2 tracing transaction.trace.threshold if transaction.trace.enabled is set to true. (seconds) threshold The trace can be used to analyze, troubleshoot the transaction working. Capture Trace snapshot will be taken for all HTTP trace if request(s) which has total external external component.trace.threshold components (like MYSQL, MEMCACHED, 30 (Count) calls etc) call count equal or higher than the exceeds configured number. Enabling this option captures parameters of all GET & POST web requests To skip capturing specific parameters use Capture webtransaction.trace.input.params.ignore HTTP webtransaction.trace.input.params.record False key parameters? Captured parameters can be viewed by selecting the required transaction in Traces tab To skip capturing specific web request parameters like password, PIN or any confidential values, specify those parameter names for this key List of HTTP password, parameters webtransaction.trace.input.params.ignore Use comma(,) to separate multiple entries. authKey to ignore Values specified for this key are case- sensitive If no value is specified, all request parameters will be recorded Capture webtransaction.trace.request.headers.record Captures the parameters sent in the False HTTP http(s) headers (both GET & POST), if thisheaders?  option is enabled. The values of these parameters in the List of http(s) headers (both GET & POST) will be Request webtransaction.trace.request.headers.ignore ignored from tracking. Sensitive and None headers to confidential keys like Cookie, Host and ignore others should be mentioned here. Capture Captures the Custom parameters which Custom custom.parameters.record are defined in your application code, if this False Parameters? option is enabled. Capture Record CPU time for every HTTP request, if cputime.capture.enabled False CPU Time? enabled. cpu time will get collected whenever any CPU Time cputime.threshold transaction cpu consumes above this 60% threshold threshold value Background Transaction Configurations Name Key Description Default value Enabling this option, APM Insight agent Track starts tracking background transactions background bgtransaction.tracking.enabled True transactions All transactions other than HTTP are considered as background transactions Enabling this option, the agent collects Capture traces for slow background transactions, bgtransaction.trace.enabled True traces provided bgtransaction.tracking.enabled is set to true Traces will be collected for background Transaction transactions whose response time have 2 trace bgtransaction.trace.threshold crossed the specified threshold value, (seconds) threshold provided bgtransaction.trace.enabled is set to true Sampling factor for background transactions Sampling 5 bgtransaction.tracking.request.interval factor If value is set to 1, agent tracks every (Request) transaction. If value is set to n, agent tracks 1 in n transactions of same kind Track Web Enabling this option will collect background Services as bgtransaction.enable.web.services False web service transaction background DOTNET SERVICE Configuration Profile Basic Configuration Profiles: Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Obfuscate transaction.trace.sql.parametrize Enabling this option will True SQL parameterize all SQLParameters Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Disabling this option will give you the real query (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will threshold for collect the stacktrace SQLs in transaction.trace.sql.stacktrace.threshold whenever any sql query 3(seconds) transaction executed above this trace threshold time value. Port number of Display application instances will Instance show.instance.port.number True be shown, if this option is Port number enabled. The log level at which the APM Insight agent should Logging record information. apminsight.log.level CRITICAL level Supported levels are SEVERE,WARNING, INFO and FINE. List of exceptions Enter the list of to be exceptions.ignore exceptions that need not None skipped be tracked. from tracking Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Sampling factor helps in tracking sampled Sampling transactions. transaction.tracking.request.interval 5(request) factor If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enable transaction.trace.enabled True Enabling this option will transaction construct Trace for Slow tracing Transactions. You can view the traces collected in APM InsightPage by selecting Traces tab. Trace of any transaction whose response time scoring above the specified threshold value Transaction will be collected, 2 tracing webtransaction.trace.external.components.count.threshold provided if (seconds) threshold transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. Trace snapshot will be taken for all HTTP Capture request(s) which has total trace, if external components (like component.trace.threshold 30 external call MYSQL, MEMCACHED, exceeds etc) call count equal or higher than the configured number. Capture CPU Record CPU time for every cputime.capture.enabled False Time? HTTP request, if enabled. cpu time will get collected whenever any CPU Time cputime.threshold transaction cpu 60% Threshold consumes above this threshold value DOTNET DESKTOP Configuration profile Basic Configuration Profiles: Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace transaction.trace.sql.stacktrace.threshold Enabling this option will 3(seconds)threshold for collect the stacktrace SQLs in whenever any sql query transaction executed above this trace threshold time value. Port number of Display application instances will Instance show.instance.port.number True be shown, if this option is Port number enabled. The log level at which the APM Insight agent should Logging record information. apminsight.log.level CRITICAL level Supported levels are SEVERE,WARNING, INFO and FINE. List of exceptions Enter the list of to be exceptions.ignore exceptions that need not None skipped be tracked. from tracking Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Sampling factor helps in tracking sampled Sampling transactions. transaction.tracking.request.interval 5(requests) factor If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified threshold value Transaction will be collected, 2 tracing webtransaction.trace.external.components.count.threshold provided if (seconds) threshold transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. Capture component.trace.threshold Trace snapshot will be 30 trace, if taken for all HTTP external call request(s) which has total exceeds external components (like MYSQL, MEMCACHED, etc) call count equal orhigher than the configured number. Capture CPU Record CPU time for every cputime.capture.enabled False Time? HTTP request, if enabled. cpu time will get collected whenever any CPU Time cputime.threshold transaction cpu 60% Threshold consumes above this threshold value DOTNET CORE Configuration profile Basic Configuration Profiles: Name Key Description Default value Enabling this option will listen to all Capture SQL Queries which gets executed. database SQL sql.capture.enabled True Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate SQL transaction.trace.sql.parametrize Disabling this option will give you True Parameters the real query (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will collect the threshold for stacktrace whenever any sql query transaction.trace.sql.stacktrace.threshold 3(seconds) SQLs in executed above this threshold time transaction trace value. Port number of application Display Instance show.instance.port.number instances will be shown, if this True Port number option is enabled. The log level at which the APM Insight agent should record Logging level apminsight.log.level information. CRITICAL Supported levels are SEVERE,WARNING, INFO and FINE. List of exceptions to be Enter the list of exceptions that need exceptions.ignore None skipped from not be tracked. tracking Provide regex patterns or transaction names that can be Skip transaction.skip.patterns skipped from tracking. Multiple None Transactions entries should be comma separated values.Web Transactions Configurations: Name Key Description Default value Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores Apdex 0.5 apdex.threshold values below the apdex.threshold value, Threshold (seconds) the transaction is labeled as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 5 transaction.tracking.request.interval factor (requests) If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace Enable for Slow Transactions. transaction transaction.trace.enabled True tracing You can view the traces collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified Transaction threshold value will be collected, provided 2 tracing transaction.trace.threshold if transaction.trace.enabled is set to true. (seconds) threshold The trace can be used to analyze, troubleshoot the transaction working. Capture Trace snapshot will be taken for all HTTP trace if request(s) which has total external external component.trace.threshold components (like MYSQL, MEMCACHED, 30 (Count) calls etc) call count equal or higher than the exceeds configured number. Enabling this option captures parameters of all GET & POST web requests To skip capturing specific parameters use Capture webtransaction.trace.input.params.ignore HTTP webtransaction.trace.input.params.record False key parameters? Captured parameters can be viewed by selecting the required transaction in Traces tab List of HTTP webtransaction.trace.input.params.ignore To skip capturing specific web request password, parameters parameters like password, PIN or any authKey to ignore confidential values, specify those parameter names for this keyUse comma(,) to separate multiple entries. Values specified for this key are case- sensitive If no value is specified, all request parameters will be recorded Capture Record CPU time for every HTTP request, if cputime.capture.enabled False CPU Time? enabled. CPU time will get collected whenever any CPU Time cputime.threshold transaction CPU consumes above this 60% threshold threshold value Background Transactions Configurations: Name Key Description Default value Enabling this option, APM Insight agent starts Track tracking background transactions background bgtransaction.tracking.enabled True transactions All transactions other than HTTP are considered as background transactions Enabling this option, the agent collects traces Capture traces bgtransaction.trace.enabled for slow background transactions, provided True bgtransaction.tracking.enabled is set to true Track Web Enabling this option will collect background Services as bgtransaction.enable.web.services False web service transaction background PHP Configuration profile Basic Configuration Profiles: Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.Display show.instance.port.number Port number of True Instance application instances will Port number be shown, if this option is enabled. The log level at which the APM Insight agent should Logging record information. apminsight.log.level WARNING level Supported levels are SEVERE,WARNING, INFO and FINE. Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the Apdex apdex.threshold value, 0.5 apdex.threshold Threshold the transaction is labeled (seconds) as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. transaction.tracking.request.interval 3(requests) factor If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Transaction webtransaction.trace.external.components.count.threshold Trace of any transaction 2tracing whose response time (seconds) threshold scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. PHP - WINDOWS Configuration profile Basic Configuration Profiles: Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Port number of Display application instances will Instance show.instance.port.number True be shown, if this option is Port number enabled. The log level at which the APM Insight agent should Logging record information. apminsight.log.level WARNING level Supported levels are SEVERE,WARNING, INFO and FINE. Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Apdex apdex.threshold 0.5Threshold Application Performance (seconds) Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 3 transaction.tracking.request.interval factor (requests) If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified threshold value Transaction will be collected, 2 tracing webtransaction.trace.external.components.count.threshold provided if (seconds) threshold transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. NODEJS Configuration profile Basic Configuration Profiles: Name Key Description Default value Capture sql.capture.enabled Enabling this option will listen to all True database SQL SQL Queries which gets executed. QueriesIf this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate SQL transaction.trace.sql.parametrize Disabling this option will give you True Parameters the real query (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will collect the threshold for stacktrace whenever any sql query transaction.trace.sql.stacktrace.threshold 3(seconds) SQLs in executed above this threshold time transaction trace value. Port number of application instances Display Instance show.instance.port.number will be shown, if this option is True Port number enabled. The log level at which the APM Insight agent should record Logging level apminsight.log.level information. CRITICAL Supported levels are SEVERE,WARNING, INFO and FINE. Web transactions of the specified URL patterns will be skipped while tracking *.css, *.js, List of URL *.gif, *.jpg, extensions to be Use comma(,) to separate multiple *.jpeg, transaction.skip.listening skipped from entries *.bmp, tracking Example: *.png, transaction.skip.listening=*.jpeg, *.ico will skip listening to transactions ending with .jpeg Provide regex patterns or transaction Skip names that can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Web Transactions Configurations: Name Key Description Default value Apdex apdex.threshold Application Performance 0.5 Threshold Index (simply called (seconds) Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.orgIf any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 1 transaction.tracking.request.interval factor (request) If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified threshold value Transaction will be collected, 2 tracing transaction.trace.threshold provided if threshold transaction.trace.enabled (seconds) is set to true. The trace can be used to analyze, troubleshoot the transaction working. Trace snapshot will be taken for all HTTP Capture request(s) which has total trace if external components (like 30 external webtransaction.trace.external.components.count.threshold MYSQL, MEMCACHED, (Count) calls etc) call count equal or exceeds higher than the configured number. Web transaction Trackers with resp time tracker webtransaction.tracker.drop.threshold less than this threshold 10(ms) drop will be dropped threshold Background Transactions Configurations:Name Key Description Default value Enabling this option, APM Insight agent starts Track tracking background transactions background bgtransaction.tracking.enabled True transactions All transactions other than HTTP are considered as background transactions Enabling this option, the agent collects traces for Capture bgtransaction.trace.enabled slow background transactions, provided True traces bgtransaction.tracking.enabled is set to true Traces will be collected for background transactions Transaction whose response time have crossed the specified 5 trace bgtransaction.trace.threshold threshold value, provided (seconds) threshold bgtransaction.trace.enabled is set to true RUBY Configuration profile Basic Configuration Profiles: Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will threshold for collect the stacktrace SQLs in transaction.trace.sql.stacktrace.threshold whenever any sql query 3(seconds) transaction executed above this trace threshold time value. Port number of Display application instances will Instance show.instance.port.number True be shown, if this option is Port number enabled. List of exceptions.ignore Enter the list of *.css, *.js,exceptions exceptions that need not *.gif, *.jpg, to be be tracked. *.jpeg, skipped *.bmp, from *.png, *.ico tracking Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the Apdex apdex.threshold value, 0.5 apdex.threshold Threshold the transaction is labeled (seconds) as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 1 transaction.tracking.request.interval factor Transaction If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Transaction webtransaction.trace.external.components.count.threshold Trace of any transaction 2 (seconds) tracing whose response time threshold scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.The trace can be used to analyze, troubleshoot the transaction working. Configurations available only in apminsight.conf file (common for all agent) Certain configuration files cannot be modified from the client. These settings can be configured in apminsight.conf file. Name Key Description Default value Specify the desired Application''s Name to show in Applications Manager. Application application.name If there are multiple instances of your application and you would like True Name to group them, then specify the same application name in all installed APM Insight Agent Configuration files. Example: myonlineshopping.com The API Key for the corresponding user. Capture This will be available in the APM Insight home page, after login. license.key* none traces Copy and Paste the Key as value for this parameter. This key is user specific. Do not share with anyone else. Specify whether the Agent installed Application Server is under a proxy network. If set True, Proxy credential information should be given in order to send the metric data from the agent to Applications Manager. Configure If behind.proxy is set to true, specify values for the following keys: behind.proxy False Proxy proxy.server.host: Host name of the proxy server proxy.server.port: Proxy server''s port proxy.auth.username: User name of the proxy server proxy.auth.password: password for the proxy server Specify the port number in which your application is running on the Agent server. agent.server.port* 80 Server Port Each port number ios treated as an individual instance and will be grouped under the same application name. Web Tokens Web tokens enable two parties to transfer information securely. Applications Manager enables you to configure web tokens globally which can be used by the monitors for data collection. Creating a Web Token Add Web Token Token Request Configuration Token Request Extraction Configure Token Response Path JSON XML Header TextCreating a Web Token: Navigate to Settings -> Discovery & Data Collection -> Web Token -> Add New Web Token. Add Web Token: Specify token details. Web Token name: Specify the name of the Web Token. Web Token endpoint URL: Specify the URL of the endpoint of authentication server. Refresh Interval:Specify the time interval in which the Web Token should be refreshed to fetch a new Web Token. Token Request Configuration: Specify the configuration for requesting the token. HTTP Method: Specify the method to be used for connecting with the webpage: POST or GET. Use the radio buttons to configure the form submission method and appropriate body type for the POST HTTP method. HTTP Request Headers: Specify any additional headers required for the token request. Credentials: Specify the username and password for URLs requiring Basic/NTLM-based authentication. Client Certificate: Specify the client certificate required to fetch the token. Only PKCS#12(.p12) is supported. Token Request Extraction: The token value in the response is extracted and can be further used to customize request parameters, headers, and more for other monitor types where authentication is needed in the request URI. Response format: Specify the format in which you want to extract values from the Web Token (regular expressions, JSONPath expressions, or XPath expressions) Note: Values present in response headers can also be read. Token Response Path: Specify the regular expressions, JSONPath expressions XPath expressions or response header name that contains the token. Token Configuration for Monitor DataCollection: DataCollection Request Method: Choose the method used to submit Web Tokens for authenticating API endpoints in monitors. You can use customized nomenclatures in the parameter fields. The web token value is substituted in place of ${WebToken} in the value field. Basic Authentication:The Web Token is sent as the request header. The bearer token must be sent in the following name-value syntax: Authorization: Bearer ${WebToken} URI query parameter: Web token is sent in the URI query parameter. The following syntax must be used: token=${WebToken} Configure Token Response Path: Given below are the various response formats you can expect from token endpoint. Note: Token response path is the path to extract the token and Response refers to the response from the token Endpoint URL. JSON: Sample: { "access_token":"XXXXXXX", "token_type":"bearer", "expires_in":4289, "issued":"Mon, 20 Jun 2021 09:39:44 GMT", "list":[ {"tokenName":"StudentAuth", "tokenValue":"3q898sejhg" }, { "tokenName":"ProfAuth", "tokenValue":"$97q3ekh" }, { "tokenName":"StaffAuth", "tokenValue":"93&3jhiudz" } ] } Following are few example JSON response paths and their respective values extracted for the above sample JSON data: Response Path Web Token Value access_token XXXXXXX token_type bearer "list":[ { "tokenName":"StudentAuth", "tokenValue":"3q898sejhg" }, { "tokenName":"ProfAuth", list "tokenValue":"$97q3ekh" }, { "tokenName":"StaffAuth", "tokenValue":"93&3jhiudz" } ] list[1].tokenValue 3q898sejhg list[0].tokenName StudentAuth list[2].tokenValue 3jhiudz XML: Sample XML: Dog Richie 8 Cat Sky 4 Snow 5 Ray 7 Following are few example xpath expressions and results for the above sample xml data: XPath Expression Description Result The output will be same as the xml / Select the document node content given as input Dog Richie 8 Select all the ''pet'' elements, which are /petstore/animals/pet the direct children of ''animals'' node Cat Sky 4 Richie Select all the ''name'' elements with ''no'' Sky //name[@no] attribute Snow Ray Ray /petstore//bird[last()] Select the last bird element 7 sum(//age) Select the sum of age element values 24 string- Select the length of the first ''pet'' 6 length(//pet[1]/name) element''s name value Select the textual value of first ''pet'' //pet[1]/name/text() Richie element''s name count(/petstore//pet) Select the count of ''pet'' elements 2 Header: The given header name in the token path is the token. Example: Response Path: tokenvalue tokenvalue: ebfb7ff0-b2f6-41c8-bef3-4fba17be410c Note: If two headers of the same name are present, then the last one is considered. Text: The entire response is considered as the token.   Availability Settings This section explains the availability settings that can be made in Applications Manager. To access availability Settings, click the Settings tab and click Availability Settings. Trigger E-mail alert when RUM Agent goes down Using this option, you can send shutdown notification mail to admin user by triggering e-mail alert whenever RUM Agent goes down. However, SMTP server and e-mail ID needs to be configured to admin user in order to send e- mail notification. Allowed idle time for Real User MonitorUse this option to specify the maximum allowed idle time (in minutes) for which the Real User Monitor can be without data collection. In case the monitor has not polled the data (due to webpages not receiving any views) for more than the allowed idle time specified, the availability of the monitor will be affected, provided the option Affect monitor availability in idle state is enabled in the RUM''s Add/Edit Monitor page. Trigger E-mail alert when EUM Agent goes down Using this option, you can send shutdown notification mail to admin user by triggering e-mail alert whenever EUM Agent goes down. However, SMTP server and e-mail ID needs to be configured to admin user in order to send e- mail notification. Modify availability status of EUM based monitors when EUM Agent goes down Usually, when an EUM agent goes down, previous availability state will be retained for all the EUM-based monitors. Using this option, you can now modify the availability status of EUM-based monitors whenever the EUM agent goes down. Show Monitor Status as Up during Maintenance Using Downtime Scheduler, you have the option to schedule a time period for which monitoring is not needed. If you want to show the availabilty of monitors under maintenance as Up, irrespective of their previous state, select this option. Clear Health Alert during Maintenance Period When you schedule a downtime or unmanage a monitor, it will show the last health status. If the monitor is down before a downtime or maintenance, it will be displayed as ''Down''. If you choose this option, then Applications Manager will clear the last health status of the monitor. Check for Network Availability When Applications Manager is out of the network or is not connected to the network, the status of all the Monitors that are currently been monitored will be shown as ''Down''. You can avoid this by enabling the ''Check for Network Availability'' option. When this option is enabled, Applications Manager will generate alarms for the unavailability of resources only if the specified host is reachable in the network. For example, let us assume that the system/host which runs the Applications Manager has been isolated from the network. Enable this option and specify a hostname in the network (preferably not the hostname where Applications Manager runs). Now, Applications Manager tries to ping that machine for its availability in the network. If not available, alarms are not generated and resources are not shown as down. You can also specify the IP of your routers, gateways, etc., to check the system/host which runs the Applications Manager is present in the network. Check for URL Availability When the Applications Manager is out of the network or if external proxy settings are not configured, the status of all the URLs that are currently been monitored will be shown as ''Down''. You can avoid this (and false alarms) by enabling the ''Check URL Availability'' option. When this option is enabled, Applications Manager will generate alarms for the unavailability of URL only if the other specified URL - reference URL is not down. For eg, let us assume that the system/host which runs the Applications Manager has been isolated from the network. Enable this option and specify another URL say for eg., google.com which is expected to be up always. Now, Applications Manager tries to monitor URL for its availability. If not available, it checks reference URL, if the reference URL is available the alarms are generated. If the reference URL itself is not available (meaning the machine is out of network or any such case) false alarms are not generated and URL is not shown as down. Further a mail is sent to the configured mail address intimating the same.  Availability Timeout Check Using this option, you can set timeout for checking availability globally. Action / Alarm SettingsThis section explains the Action and Alarm Settings that can be made in Applications Manager. To access the Action / Alarm Settings page, click the Settings tab and go to the Action / Alarm Settings link. You can change the following settings: General Settings Repeat Action Executions Settings EMail Settings Error Mail Monitoring Settings Settings for Date Format for $DATE replacable tag in Alarm SMS Settings Consecutive Polls Count Settings General: Enable Actions When alarms are generated, actions are triggered for those alarms (if you have configured any). If you do not want the actions to be executed in spite of the alarms, deselect this option. Execute Actions Repeatedly Using this functionality you can trigger an action continuously during every poll, till an alarm changes from critical/warning to clear or you can restrict the number of action executions for the same threshold. The three types of recursive actions that are involved are: Availability - If a Monitor is down, you can execute actions repeatedly till the Monitor is up. Health- If the Health of the monitor is in a Critical or Warning state, you can choose to do one of the following: Execute actions repeatedly till the Health is clear, if the Health is critical/warning. You can also restrict the executions to a certain number of times by setting a value (1 is the default value and blank for unrestricted executions). Execute actions associated to the health of the monitor repeatedly, until it is Acknowledged/Picked Up. Attribute Level - If the attribute status is critical/warning, you can execute actions repeatedly till the attribute status is clear. EMail Settings Under Email settings, you have the option to: Send a Server Snapshot as inline attachment to an email if the health is Critical. You can also select the Content Transfer Encoding for email action from a drop-down menu. Send one email when multiple Email actions are configured for an alarm. Monitor Error Mail Under the Error Mail Monitoring Settings, you can choose to send emails in case of any fatal monitor error like data collection being performed. This mail will be sent to the email address specified in the ''admin'' user account. If no email address is specified, the mail will be sent to the email address specified in the ''Mail Server'' settings. Furthermore, you can specify the number of times the error has to occur before email is triggered in the Check for consecutive polls before sending error box. Date Format Under Date Format for $DATE replacable tag in Alarm settings, you can set the required date format in the Email alarms. It can set to either: Day Mon dd HH:mm:ss IST yyyy (Default) - Thu Feb 22 12:02:40 IST 2007 or MM/dd//yyyy HH:mm:ss - 02/22//2007 12:02:40. See Replaceable tags for usage of $Date. SMS:By default , the complete information that you configure while adding SMS Action is sent via an SMS. Some SMS service providers restrict the length of characters sent through the SMS. This could result in truncated message delivery. If you would want to send only information on the Monitor, Attribute, and its Severity, deselect this option. For E.g., "Health of JBoss Server is critical" will be the SMS format that is received. (This is in addition to the message provided when creating the SMS action.) Consecutive Polls before Reporting an Error: The Critical, Warning, and Clear alarms are generated based on attributes that you have configured. You have control over the alarms that are being generated. Simply specify the number times after which the alarm should actually be generated. It would eradicate false alarms. You can set the number of Consecutive Polls Count that should be checked before reporting: A service is down or an attribute is in a critical state. An attribute is in warning state. A service is up or an attribute is in clear state. If you want to Applications Manager to check 3 out of 5 Consecutive Polls before reporting that a system (or any Monitor) is down or an attribute is critical, specify the value as 3 in the first and 5 in the second text box. Similarly, you can change the remaining four text boxes (warning, Clear) also. If you have set the poll as 2 out of 5 times before reporting a service is up, for the first time of polling, the service will be shown as Unknown. Only on the second poll, if the service is running, the status would be shown as ''Up''. Changes made will be reflected across all the monitors. Apart from Action / Alarm settings, Polls before reporting an error, can be configured for threshold and availability of individual monitors. Refer Configuring Consecutive Polls. Event Log Rules By using this option, you can monitor the various Windows and Windows Azure events. The events received will be displayed in the Windows Monitor details page. Also, you can generate alarms in Applications Manager based on the configured rule. For e.g., when an event of type Error occurs in System Log, you can generate a critical alarm which will in turn affect the health of the Windows or Azure Monitor. Browse through the following topics to understand Event Log Configuration: Event Logs Rules Configuration Adding a new event log | Adding a new event log from the Admin Server (Enterprise Edition) Deleting an event log Adding a new event log rule Windows Azure Logs Rules Configuration Adding a new Trace Log rule Adding a new Diagnostic Infrastructure Log rule Note: Event Log Monitoring is available in Windows Installations and only in WMI mode of monitoring only. Event Logs Rules Configuration: For receiving windows events, you have to configure Event Log Rules. You can get notified by the events from the following Log Files: Application (By default Event Log rule is configured for any Application Error) System Security (By default Event Log rule is configured for any Security Failure) File Replication Service DNS Server Directory Service Adding a new Event Log FileTo add new event log file other than what are available by default, click the option "Add New Event Log" in the right hand bottom corner of the web client. Adding a new event log from the Admin Server (Enterprise Edition) Event Logs created in the Admin Server in your Enterprise setup is automatically synced to all the respective Managed Servers. Deleting an Event Log Click on the Delete Event log button at the top right corner of the event log box, to delete an event log that you have created. Adding a new Event Log rule Under Settings tab, click on Log Rules Click on ''New Rule'' for the required Log File type Enter the Rule Name of your choice Enter the Event ID associated with the Event Log File (not mandatory) By clicking the Advanced Options checkbox, you can formulate the rule more specifically by associating: Source - Application which created the event. Category - Task Category which contains more information about the event. User Name - System component or User account that was running the process which caused the event. Description contains word or matches Regex: The description content of the incoming event, and if the Description contains a particular word. You can perform content check for regular expressions by checking the Regular Expressions checkbox. For e.g., select Log File as [System] and Event Type as [Error] , to get all events of type Error from System Log File. The number of its occurrences in a poll. Select the Log File Type (application, system, security, file replication service, DNS Server, directory service). Choose the Event Type - Error, Warning, Information or Event of Any Type . In case of Security Events, the types would vary between Success Audit and Failure Audit. Alarm severity can be set to ''Critical'' or ''Warning'' based on the following conditions : Depending on the severity of the incoming event and when the event matches a certain number of consecutive polls The matching event is not generated in the given time window Alarm severity can be set to ''Clear'' based on the following conditions : If no matching event found for certain number of consecutive polls If a matching event is generated At the outset, you can Enable or Disable the rule. You can set the rule to be applicable to: All Monitors - All the monitors. Specific Monitor Types - For e.g., Windows XP, Windows 7, Windows 8 and so on Selected Monitors - You can select the monitors from a drop down menu or search for the required monitor to which the new rule must me applicable. The new rule will be displayed in the LogFile rule window. You can also enable, disable and delete one or more rules by selecting the rule(s) and clicking the Enable, Disable or Delete button. Note: The event logs added by default cannot be deleted. Windows Azure Logs Rules Configuration: You can monitor Windows Azure Trace logs and Diagnostic Infrastructure logs using Applications Manager. You must first configure Trace Log or Diagnostic Infrastructure log rules. The logs received will be displayed in thedetails page of the Windows Azure Role Instances. You can also generate alarms in Applications Manager based on the configured rule. For e.g., when an event of type Error occurs in the System Log, you can generate a critical alarm. This alarm will, in turn, affect the Health of the Windows Azure Role Instance. Here is how you can configure a new rule for Windows Azure: Trace Logs Click on New Rule at the right hand corner of the Trace Logs box. In the Add New Rule for Windows Azure Trace Logs page, enter the name of the rule that you wish to create. Enter the event id of the rule that you are creating Enter the string that the message contains. Select the event type: Any Type, Error, Warning or Information You also have the option to set the severity of the alarm as critical or warning. You can enable or disable the rule status. Click on the Create Rule button. The new rule wil be displayed in the Trace Logs. You can edit the rules by clicking on the Edit Rule icon. You can also enable, disable and delete one or more rules by selecting the rule(s) and clicking the Enable, Disable or Delete button. Diagnostic Infrastructure Logs Click on New Rule at the right hand corner of the Diagnostic Infrastructure Logs box. In the Add New Rule for Diagnostic Infrastructure Logs page, enter the name of the rule that you wish to create. Enter the Error Code of the rule that you are creating. Enter the string that the message contains. Enter the string that the Error Message contains. Select the event type: Any Type, Error, Warning or Information. You also have the option to set the severity of the alarm as critical or warning. You can enable or disable the rule status. Click on the Create Rule button. The new rule will be displayed in the Diagnostic Infrastructure Logs. You can edit the rules by clicking on the Edit Rule icon. You can also enable, disable and delete one or more rules by selecting the rule(s) and clicking the Enable, Disable or Delete button. Alarm Escalation Applications Manager provides an option to configure rules which ensure that any alarm that lies unattended for a while is brought to the notice of the IT administrator. You can escalate the alarm if it has not been attended to for a given time period. This ensures that all critical alarms are taken care of before it gets late. You can configure rules to send Escalation EMails or send SMS or to Execute Program about unattended alarms to the Admin or to the superior. Alarm Escalation Configuration: Under the Settings tab, click on Alarm Escalation icon. Click on New Rule to create a new rule. Add a Rule name. You can set an alarm to escalate a Critical/ Warning alarm for All your Monitors SelectedMonitor Groups Selected MonitorsSpecific Monitors in a Monitor Groups Set the rule. For eg., Send Escalation EMail if the critical alarms of all monitors are not cleared within 2 hours. You can set rules for alarms in individual monitor groups too. Select the option to Send EMail/ SMS/ Execute Program Actions. These actions have to be created earlier from the Actions drop-down at the top band. Execute Program Action will trigger a specific batch file or script, whereas Send EMail and SMS will send notifications to the mail id and mobile number provided, on the escalation of an alarm. For more on creating action, refer this section. Set the time period for which the rule should be executed repeatedly. By choosing not to receive duplicate escalation for the same alarm, you opt for optimizing the number of escalation EMails/ SMS sent and Program Action executions. For eg., If there are five critical alarms that were escalated in the first execution run (say 10 minutes), only if there is an addition of new alarm or deletion of alarm, the next set of alarms will be escalated in the second run. If there is no change in the environment in the next 10 minutes, ie., if the five critical alarms still remain the same, escalation EMail will not be sent. Configure Global SNMP Trap Global SNMP Trap action supports the sending of alerts generated by Applications Manager as SNMP Traps to your Trap Listeners. You can configure Global SNMP Trap action in Applications Manager to send alerts to SNMP trap listeners. The alerts generated can be viewed from SNMP trap listeners at the corresponding destination address and port. Follow the steps given below to create a global SNMP Trap action: Click ''Global Trap Action'' under Settings → Traps → Global Trap Action. It takes you to ''Create Global Trap Action'' page. Select the SNMP Trap Version from the drop-down box. You can select either v1,v2c or v3. Enable or disable the action by choosing the appropriate radio button under Status. By default, the ''disable'' button is selected. Specify the hostname where the SNMP Trap listener is running under Destination Address. Specify the port at which traps are received in the Destination Port field. For SNMP V1 and V2C: Enter the Community String of the trap. The default value is ''public''. For SNMP V3: Enter the UserName and Context Name. Select a Security Level : NoAuthNoPriv, AuthNoPriv or AuthPriv. Select the Filter By All Monitors & Monitor Groups option to send traps for every alerts generated in all Monitors/Monitor Types/Monitor Groups. If unselected, you can provide filters based on the following: Monitor: Select the monitors for which you want to send traps. Monitor Type: Select the monitor types for which you want to send traps. Monitor Groups: Select the monitor groups for which you want to send traps. Select the Severities based on which traps should be sent. (Critical, Warning, Clear, Unknown) Select the Attribute types for which you want to send traps. (Health, Availability, Others) Finally, click on Save to complete the configuration. Once you have configured the global trap action, traps will be sent to the configured destination address and port whenever an alert is generated . The trap will be received in the SNMP listener as OID as mentioned in the below table. To receive trap, the following Applications Manager MIBs should be downloaded from \working\mibs directory : APPLICATION-MANAGER-MIB SNMPv2-TC RFC1213-MIB SNMPv2-SMI Attribute Trap Varbinds Subject APPLICATION-MANAGER-MIB::trapMessage (.1.3.6.1.4.1.2162.1.1.2.1) Monitor Name APPLICATION-MANAGER-MIB::monitorname (.1.3.6.1.4.1.2162.1.1.2.2) Type APPLICATION-MANAGER-MIB::monitortype (.1.3.6.1.4.1.2162.1.1.2.3) Host APPLICATION-MANAGER-MIB::hostname (.1.3.6.1.4.1.2162.1.1.2.4) Attribute APPLICATION-MANAGER-MIB::attribute (.1.3.6.1.4.1.2162.1.1.2.5)Severity APPLICATION-MANAGER-MIB::severity (.1.3.6.1.4.1.2162.1.1.2.6) Generated Time APPLICATION-MANAGER-MIB::createdtime (.1.3.6.1.4.1.2162.1.1.2.7) RCA Message APPLICATION-MANAGER-MIB::rcaMessage (.1.3.6.1.4.1.2162.1.1.2.8)   Note: To receive trap from Applications Manager, the following MIBs from  \working\mibs directory should be added to corresponding SNMP Trap receiver: APPLICATION-MANAGER-MIB SNMPv2-TC RFC1213-MIB SNMPv2-SMI SNMP Trap Listener SNMP Trap Listener can be configured in such a way that, if a particular trap is received, actions can be configured and alarms will be generated accordingly. For e.g., you can configure a trap listener for system shutdown, you can assign the severity as critical and also associate an email action through SNMP Trap Listener. If the trap is received, then the severity becomes critical and an email alarm is generated. The default port through which the traps are received is 1620. The default port can be changed by modifying property in under AppManager Home/Conf directory. Restart the server for the changes to take effect. Follow the steps given below to add a SNMP Trap Listener. Click the Add New option in SNMP Trap Listener under the Settings tab. This will take you to the Add SNMP Trap Listeners page. Enter the Trap Listener Name. Choose the Status of the trap. The Status is ''enable'' by default. Select the SNMP Trap version - V1, V2C or V3 If you select v1, select the Generic Type. The various generic types are coldStart, warmStart, linkDown, linkUp, authenticationFailure, egpNeighborLoss, and enterpriseSpecific. If you select enterpriseSpecific type, you can also provide wildcard symbol '' * '' or numeric value for Specific Type field. Enter the Enterprise OID. The Enterprise OID can configured as either exact OID or part of an OID. You can use the MibBrowser to get the Object ID. If you select a Parent OID from the MibBrowser, all child OIDs will also be automatically listened. If the version is v2c, then enter the Trap OID. The Trap OID can configured as either exact trapoid or part of trapoid which ends with ''.*'' . You can use the MibBrowser to get the Object ID. V3 also requires the Username of the host from which the trap should be received. The Trap OID can configured in APM as exact Trap OID. By enabling the Filter based on variable bindings checkbox, you can filter out SNMP traps at a variable binding level. You can configure various conditions by mentioning required Varbind Index values and entering specific trap message string values that match for its corresponding SNMP Object Instance. Check the Customize Message (Varbinds) checkbox to customize the trap message. Enter the message. Message (Varbinds) can be defined using: $* $1, $2, $3,...,$N Any user defined message with selected variables {eg. $4 configuration changed in $2. Changed By: $5 } Select the Severity. It can be Critical, Warning, Clear or Based on Variable Bindings. If you select the ''Based on Variable Bindings'' option, you can specify various conditions based on variable binding values. By default, you can configure the condition for Critical severity. Enable the ''Advanced'' checkbox to configure for Warning and Clear severities as well. You can associate a trap severity with server health. The trap can be received from any Host or you can specify the Host from which the trap can be received. You can also associate the trap to Monitor Groups by selecting the required ones from the list. Associate Actions that need to be executed when the trap is received. The actions can be chosen from the list of actions configured. If you have selected the ''Based on Variable Binding'' option under Severity, you have to associate the actions for all the severities defined. (Critical, Warning, and Clear) Save the Trap Listener.You can view the Traps by clicking on ''View'' from the Settings tab. It opens up to the ''View SNMP Trap Listeners'' page, in which details about the trap listeners are given. Edit option is available to modify the traps listeners. Also, the alarms configured for the traps received can be viewed from the Alarms tab. Note: Dell OpenManage can be integrated with ManageEngine Applications Manager via the SNMP Trap Listener. More in Applications Manager''s blog. Enterprise Edition - Monitor Group Rules In Applications Manager''s Enterprise Edition, you can configure rules for associating a Monitor to a monitor group from the Admin Server. Here is how you can create a new Monitor Group rule: Under the Settings tab, click Monitor Group Rules in the Alarm/Action table. This opens a new Add New Rule window. Click Add New Rule to open a new Add Monitor Group Rule pop-up window. Enter a Rule Name and give your Description of the rule. Select the Monitor Group to which you wish to associate the rule from the drop-down list. You can also set up multiple filter criteria like name or type to a monitor group rule. For eg. You can set multiple rules to associate only monitors whose name is Win and Monitor Type is Windows XP. You can set multiple rules to associate only monitors whose name contains 192.168.27 or 192.168.26 This will automatically assign monitors created in managed server to monitor groups created in admin server based on the corresponding rules. You can edit or delete the Monitor Group Rule from the Add New Rule window by clicking on the edit or delete icon displayed near the rule name. Note: New Rules created will be applied to groups in the Managed Servers only after the rules have been synced with the Managed Servers. However, these rules cannot be edited from the Managed Servers. Product Settings Browse through the below topics to learn more about product settings, available under Settings tab in Applications Manager: SMS Gateway Global Settings Configure Mail Server Configure SMS Server Configure Proxy User Administration Logging Personalize Web Client Server Settings Privacy Settings Security Settings Enterprise Edition Settings Product Integration SMS Gateway You can send alerts via SMS using SMS servers and SMS gateways. Configuring an SMS Gateway enables a computer to send and receive SMS text messages to a mobile device over a telecommunications network. When you set up Applications Manager to perform the Send SMS action in the event of an alarm, make sure the SMS GATEWAY is configured. Prerequisites Before adding an SMS gateway, check for the following prerequisites: An account in the SMS Gateway portal.SMS gateway API URL should be reachable from Applications Manager installed server. Must have enough credits to send SMS. Note: Please refer your respective SMS gateway''s HTTP API documents for more details. Setting up an SMS Gateway To set up an SMS Gateway, follow the steps given below: Go to Settings → Product Settings → Global Connectivity → SMS Gateway. Choose the required vendor from the SMS Provider dropdown and provide respective credentials given by the vendor. Following are the details to be provided for respective SMS Provider vendors: Clickatell: Specify the Account Type, User Name, Password or API Key of the Clickatell account. SMSEagle: Enter the Server Name/IP Address, Username, and Password of the SMSEagle account. Twilio: Specify the Account SID, Auth Token, and Phone Number of the Twilio account. Choose ''Custom'' if you wish to provide custom network credentials to configure SMS Gateway. After selecting this option, follow the steps given below (from Step 3 onwards). Enter the HTTP(S) URL of your SMS gateway provider. You can choose between HTTP and HTTPS from the drop down menu, depending on the URL of your provider.This field does not include URL parameters. (Example: www.smsserver.com/sendsms; api.clickatell.com/http/sendmsg) Select whether you want to use POST or GET form submission method for sending SMS and enter the request parameters. If you select POST method, you will be asked to choose the PayLoad Type from the following options: FORM: If you select this, enter the Request Parameter in a line-by-line format Text: If you select this, enter the Request Parameter in text format XML: If you select this, enter the Request Parameter in XML format JSON: If you select this, enter the Request Parameter in JSON format Enable the Individual API request for each number checkbox to send individual API request for each number during the action execution. Choose the Authentication Method required, if any, by choosing any one of the following authentication methods: No Auth: This option lets you access the HTTP URL without any authentication. Basic authentication: This option lets you access the HTTP URL with a basic authentication method (NTLM Protocol). This can be configured by entering the username and password required to access the URL. OAuth: This option lets you access the HTTP URL using OAuth (Open Authorization). This can be configured either by selecting the OAuth provider required to access the URL, from the drop down list. Also, you can create a new OAuth provider by clicking on the Add Oauth Provider link. (Refer Oauth Provider) Enter the URL’s Request Headers. This is optional, based on the gateway providers. You can add or delete headers using the [ ] and [ ] icons given at the side. Provide message to be displayed for Success and Failure Response, if required. Specify the Timeout value, in seconds. Click Save to complete the configuration. Note: Format for Request Parameters: apiKey=xxx&toNumber=~mobileno~&content=~message~ Global Settings This section explains the global settings that can be made in Applications Manager. To access Global Settings, click the Settings tab and click Global Settings. On performing any of the configurations, click Update Global Settings button provided at the bottom of the page. General Show Intro Tab - When you login into the Web Client, an Introduction page is diaplayed to helps novice users to get started and to understand the terms used in the product. If you want the Introduction page to be displayed every time you login, select this option.Do not redirect logout page to external website www.manageengine.com - By selecting this option, logout page will not be redirected to external website www.manageengine.com. Do not hide Advanced configuration in Alarm Configuration - By selecting this option, you can always have all the advanced options expanded by default in the "Configure Alarms" and "New Threshold" screens. By default, while configuring actions at attribute level, only the ''Critical Severity'' actions can be associated with the Health of the attribute. Associations of Warning and Clear severity actions are hidden. Likewise, by default, while creating new Thresholds, only the critical threshold is set. Warning and clear thresholds are hidden. This is to aid customers who require only the critical configurations and they may not be interested in fine grained configuration of thresholds & alarms. Add Host as a Monitor when you associate a service running in it to the monitor group - By default, when you associate a Monitor (service or server running in particular host) with a Monitor Group, the host (in which the Monitor runs) is also associated with the Monitor Group. If you do not require the host to be associated with the Monitor Group, deselect this option. For example, if you are add and associate a monitor (say WebSphere) with a Monitor Group, Applications Manager will add and associate the host (say Windows) also in which the WebSphere runs with that Monitor Group. Note: This host will be monitored only if you have provided the required configuration information. Add Host also when you add a new service - While adding a service as monitor, by selecting this option, the host on which the service runs will also be added. Restart the product in case of serious server error - By selecting this option, you can restart Applications Manager automatically, incase any serious server error like out of memory error occurs.Note: This host will be monitored only if you have provided the required configuration information. Send automated mails to admin user Email from Applications Manager - By selecting this option, the admin user will receive automated mails like license expiry notification, weekly report for availability of servers and applications etc. Easy Upgrade Option - If this option is checked, Applications Manager performs auto upgrade of the PPM without user intervention. Enterprise Edition Settings You can convert the standalone professional server to Managed Server by giving the Admin Server Host name and SSL port. Note: This option is available only if you have installed the full build and does not work for upgrades through PPM. Collect Usage Statistics Applications Manager collects statistical data associated with quality, stability, and usability of the product.By checking the Enabled option you grant permission to collect this data. Collect Cloud Usage Statistics: Applications Manager collects environment inventory count data for Amazon, Azure, OCI, and GCP cloud accounts to enhance the product and improve user experience. Note: The data collected will remain confidential and be used during analysis. Configure Mail Server Mail servers are configured to send e-mails to desired destinations. For instance, when you perform an action to send e-mail for some alarms, you need to configure mail server through which mails are sent. You can configure the mail server using two different connection protocols. You can choose any one based on your requirement. Configuring the Mail Server using SMTP protocol: In the Applications Manager console, navigate to Settings → Product Settings → Connectivity → Mail Server and proceed to Configure Mail Server. Choose SMTP Connection Protocol. Choose the Authentication Type. If you choose Basic Authentication type: Provide the SMTP Server name  and the SMTP Server Port number. Provide the EMail Address . It will be used as the Sender address when configuring actions. Provide the Username and Password, if the SMTP server requires authentication details (Select the checkbox).If you choose OAuth Authentication type: Provide the SMTP Server name  and the SMTP Server Port number. Provide the EMail Address . It will be used as the Sender address when configuring actions. Choose the OAuth Provider. Note: Click here for steps to configure OAuth for for G-Suite. For TLS Support in the mail server configuration, select TLS Authentication Enabled option. To enable Secure Connection(SSL), check the Secure Connection(SSL) Enabled checkbox. If the chosen mail server is down for some reasons, you have an option to configure a Secondary Mail Server that functions as a back up mail server. Check the Configure Secondary Mail Server checkbox and configure it by following the same steps given above. When configuring Mail Server in the Enterprise edition, you can allow the mail server configuration performed in the Admin server to propogate to all your Managed Servers. To enable this, check the Use same mail settings for all managed servers checkbox. You can click on the Test Connectivity button to verify if all the details entered are correct and if Applications Manager is able to send an e-mail using the details given. Click Save to save the configuration. The SMTP server is configured and all the e-mails will be sent through this server. Note: To verify SMTP access for Gmail from your Applications Manager installed system, you will need to run a telnet test, which will check that your computer can contact gmail SMTP servers. Enter telnet smtp.gmail.com 465 (or 587) and check for any response.In case you fail to receive a response, we recommend contacting your system administrator to get the access.   Configuring the Mail Server using EWS (Exchange Web Services) protocol: In the Applications Manager console, navigate to Settings → Product Settings → Connectivity → Mail Server and proceed to Configure Mail Server. Choose EWS Connection Protocol. Choose OAuth Authentication Type. Provide the Connect URL. Provide the EMail Address . It will be used as the Sender address when configuring actions. Choose the OAuth Provider. Note: Click here for steps to configure OAuth for for EWS Server. If the chosen mail server is down for some reasons, you have an option to configure a Secondary Mail Server that functions as a back up mail server. Check the Configure Secondary Mail Server checkbox and configure it by following the same steps given above. You can click on the Test Connectivity button to verify if all the details entered are correct and if Applications Manager is able to send an e-mail using the details given. Click Save to save the configuration. The EWS server is configured and all the e-mails will be sent through this server. Configure SMS Server SMS Server should be configured for sending SMS alarms via Modem. Available in Windows only. SMS Servers Settings: Prerequisites: Connect your GSM Modem to the Serial Communication Port. Know the Modems that are supported - Link (Can’t find the modem that you''re looking for?) Only a serial cable must be used for connectivity Enter the Port Number to which Modem is connected: For eg. COM3 . To find the Port Number - Click on My Computer->right click Properties->Hardware->Device Manager->Ports (COM & LPT) under ->Prolific USB-to-Serial Comm Port (COM3).The Modem Status details that would be displayed are Details: Modem Manufacturer Modem Model Battery Status Signal Status Status Configure Proxy If your environment requires the use of a proxy server to access external Websites, requests must be routed through an HTTP proxy server. Such URL monitoring can be performed by setting the proxy configuration. For eg., to access websites from your browser, you should configure an HTTP Proxy (In Internet Explorer, Click on Tools >Internet Options > Connections > LAN Settings). Follow the steps given below to configure a proxy server: Open the Applications Manager web client and click on the Settings tab. Click Configure Proxy. Select Automatically detect settings, if the proxy is to be detected automatically. To specify the proxy settings manually, select Use a proxy serverand specify the following details: Host and port number of the proxy server. Username and password of the user to access the Internet. Specify if you want to use the proxy server for all local (intranet) addresses. Because a proxy server acts as a security barrier between your internal network (intranet) and the Internet, you could need extra permissions from your system administrator to gain access to web pages through a proxy server. You might be able to gain access to local addresses easier and faster if you do not use the proxy server. Specify the Internet addresses you want to connect to without using a proxy server. For example, you might not want to use the proxy server to contact other computers on your local network. Use semicolon (;) to specify multiple IPs. The entries may be any of the following: a complete host name (e.g. "www.zohocorp.com") a domain name; domain names must begin with a dot (e.g. ".zohocorp.com") an IP-address (e.g. "12.34.56.78") an IP-subnet, specified as an IP-address and a netmask separated by a "/" (e.g. "34.56.78/255.255.255.192"); a 0 bit in the netmask means that that bit won''t be used in the comparison (i.e. the addresses are AND''ed with the netmask before comparison). Click Save. All request to the Internet will then be routed through the proxy server. User Administration Applications Manager permits five different roles to work with the product apart from the default admin role. The different roles are Normal Admin, Delegated Admin, User, Operator and Manager. Default / Super Admin : The system Super Administrators are allowed to perform all admin activities. The Super Administrator role also has the privilege to configure user administration. The Super Admin role is the default admin user and it cannot be deleted or renamed. Normal Admin : Normal Administrators are allowed to perform all default admin activities except the following : Access query tool and DB status from Support under Tools in Settings tab. Shut down the Applications Manager service from within the product. Access Account Policy tab in User Management under Product Settings in Settings tab. Access all Admin permissions in Permissions tab in User Management under Product Settings in Settings tab.Delegated Admin : The delegated administration role is used to assign limited administrative privileges to users in your organization who aren''t default administrators. More information on Delegated Admin role and how to enable Delegated Admin Preferences can be viewed here. User : A system user will have read-only access to all components of the product. Users will not have the privilege to access, configure or edit the different components of the product. Operator: The system operators have read-only access to only those components of the product that the default administrator assigns to the operator. The operator role does not have the privilege to access, configure or edit the different components of the product. If an operator is part of a Monitor Group, then the restrictions will be in effect only for the operator and not others. Manager: The Manager has an integrated high-level view of the Business Infrastructure. Service Level Agreements (SLAs) can be created and associated with various business applications and servers. More information on Manager role can be viewed here. In the Settings page, click User Administration under Global Configurations to browse through the following tabs: Profiles User Groups Domains Permissions Views Account Policy Two-Factor Authentication (TFA) Note: User management is not supported for the Applications Manager plugin build over OpManager. At present, there are only two types of roles available for plugin users - Administrator and Read-Only User. Operator, Delegated Admin and Manager role is not supported. Applications Manager Plugin users cannot assign monitors to the any specific users in the Apps tab. They can view all the default monitors only. Profiles Applications Manager provides you with the ability to manage users and roles for your enterprise, with roles assigned to users and different permissions associated to each role. This is achieved by first adding users and associating the users with the roles. You can also import users from Active Directory or LDAP. This functionality is implemented as a more convenient method to add a large number of users and to ease the user administration in Applications Manager. You can import users and perform role configuration for LDAP and Active Directory users and groups in Applications Manager. Adding new users to Applications Manager Importing users from domain Importing users from a new domain Deleting users Add new users to Applications Manager The system administrators are allowed to perform all admin activities as explained in Performing Admin Activities. The admin role also has the privilege to configure user administration as explained below. In Settings page, click User Administration under Global Configurations. This lists the User Profile(s) that consists of the User name and the role. To add a new user, click Add new. This opens the ''New User'' screen. Specify a unique user name and provide a password. Note: Username field containing any of the following special characters will not be accepted: / \ [ ] : ; | = , * ? < > " '' ` % -- $$ Provide a description and an e-mail for the user. Assign a role to the user (User/ Operator/ Administrator/ Manager ). Check the delegated admin checkbox if you wish to assign delegated administration privileges. You can upload a profile photo for the user in jpg, gif, png or jpeg format(optional). A file size less than 100 KB is preferred.You can select user groups to give a group of users the same privileges as the new user. (Not applicable to users without Operator, Administrator or Manager roles). Select the monitor group to which the new user or users must be granted privileges.(Not applicable to users without Operator, Administrator or Manager roles). If you want to configure the user login during specific time periods, enable the User Account Login based on Business Hours option and select the Business Hour during which the login has to be allowed for the user account. The user account login can be configured such that it is allowed during or outside the selected Business Hours. Use the drop-down menu to select your time window or click on ''Add New Business Hour'' to create a new time window. Click Create User. The new user or user groups will be displayed in the User Profile(s) table displaying the status, description, e-mail address,role and the monitor groups assigned. Note : The default user access of Applications Manager is admin (Administrator). All users log into Applications Manager as Admin users and are given all the administrative privileges to work with the tool.  You can also assign the owners for the Monitor Groups while creating the Monitor Groups or while editing the existing Monitor Groups Importing users from domain You can import users and perform role configuration for LDAP, Active Directory and JumpCloud users and groups in Applications Manager. Users imported from the Active Directory, LDAP, or JumpCloud can login into Applications Manager using their Active Directory/LDAP/JumpCloud credentials. Since user authentication is done in the Domain Controller all the account policy regulations of the company/domain is automatically inherited to Applications Manager credentials also. In Settings page, click User Administration under Global Configurations. This lists the User Profile(s) that consists of the User name and the role. Click the Import Users from domain link under the list of user profile Select a domain name from the drop-down list. Adding a New Domain You can select an already added domain from the drop-down list or add a new domain. You can also edit the existing Domain controller settings in the same manner. Select the Add New Domain option from the Domain Name drop-down list. Enter the following details: Domain Name: Name of the domain from where the users need to be imported. Domain Controller: The hostname or the IP address of the DNS server for the domain. Domain Port: The port of the DNS server. Authentication Type: The authentication type of the domain user. (LDAP, Active Directory, or JumpCloud) Base DN: JumpCloud Base Distinguished Name (DN) of the user. Eg. For JumpCloud, ou=users,o= ,dc=jumpcloud, dc=com Username: Active Directory / OpenLDAP / JumpCloud username of the domain user. The active directory username of the domain user should be provided in DOMAIN\username format. The LDAP user name should be provided in cn=user,dc=domain,dc=name format. The JumpCloud user name should be provided in uid= ,ou=users,o= ,dc=jumpcloud,dc=com format. Password : Active Directory / OpenLDAP /JumpCloud password of the domain user. Search Filter: To filter out search result you can use characters followed by * as well as the role criterion in OpenLDAP search filter format. For users imported from Active Directory / OpenLDAP / JumpCloud, Enforce strong password rules settings will not be applicable. Click on the Fetch Users button to import users from the domain. When the list of existing users is displayed select the user(s) to be added, assign roles and click on Add Users to add the users.In the new Import Users tab from the pop-up window select the users that you wish to add from the drop- down list. Note: Username field containing any of the following special characters will not be accepted: / \ [ ] : ; | = , * ? < > " '' ` % -- $$ Assign a role - Operator,User,Administrator or Manager to each of the users. Click on the Add User button to import the user to Applications Manager or click on Add Users And Configure Another to add more users. You can edit User Profiles from the list of users.   Delete a user In Settings page, click User Administration under Global Configurations. Select the user(s) to be deleted. Click Delete User Groups You can create User Groups in Applications Manager with roles assigned to users or import user groups from Active Directory, LDAP, or JumpCloud. Adding new user groups to Applications Manager Importing user groups from domain Importing user groups from a new domain Deleting user groups Add new user groups to Applications Manager In Settings page, click User Administration under Global Configurations. Click the User Groups tab. This lists down the User Groups in Applications Manager. To add a new user group, click Add new. This opens the ''New User Group'' screen. Specify a User Group name. Choose the users to be added to the group. Select the monitor group to which the new users must be granted privileges. Click Create User Group. The new user groups will be displayed in the User Groups table. Importing user groups from domain Users in the groups imported from the Active Directory, LDAP, or JumpCloud can login into Applications Manager using their Active Directory/LDAP/JumpCloud credentials. Since user authentication is done in the Domain Controller all the account policy regulations of the company/domain is automatically inherited to Applications Manager credentials also. In Settings page, click User Administration under Global Configurations. Click the User Groups tab. Click the Import User Groups from domain link under the list of user profile Select a domain name from the drop-down list. The users in groups imported from Active Directory/LDAP/JumpCloud will be associated automatically to that particular usergroup during login. For Active Directory Users, the admin can import their group and use this feature in permissions tab (Create a new user account if the user logs in with domain authentication.) Adding a New Domain You can select an already added domain from the drop-down list or add a new domain. You can also edit the existing Domain controller settings in the same manner.Select the Add New Domain option from the Domain Name drop-down list. Enter the following details: Domain Name: Name of the domain from where the users need to be imported. Domain Controller: The hostname or the IP address of the DNS server for the domain. Domain Port: The port of the DNS server. Authentication Type: The authentication type of the domain user. (LDAP, Active Directory, or JumpCloud) Base DN: JumpCloud Base Distinguished Name (DN) of the user. Eg. For JumpCloud, ou=users,o= ,dc=jumpcloud, dc=com Username: Active Directory / OpenLDAP / JumpCloud username of the domain user. The active directory username of the domain user should be provided in DOMAIN\username format. The LDAP user name should be provided in cn=user,dc=domain,dc=name format. The JumpCloud user name should be provided in uid= ,ou=users,o= ,dc=jumpcloud,dc=com format. Password : Active Directory / OpenLDAP /JumpCloud password of the domain user. Search Filter: To filter out search result you can use characters followed by * as well as the role criterion in LDAP search filter format. These search filters use one of the following formats =( ) or ( ). For example: "(&(objectCategory=person)(objectClass=user)(!cn=andy))"- All user objects but "andy". Click on the Fetch User Groups button to import user groups from the active directory, LDAP, or JumpCloud. When the list of existing users is displayed select the user(s) to be added, assign roles and click on Add User Groups to add the users. You can also edit User Profiles from the list of users. Delete a user group In Settings page, click User Administration under Global Configurations. Click the User Groups tab. Select the user groups to be deleted. Click Delete. Domains You can import multiple users from other domains like Active Directory, OpenLDAP, and JumpCloud to Applications Manager. Configure the following details: Domain Name : The fully qualified name of the domain from which the users are to be imported. Aliases are not supported. Domain Controller : The hostname or the IP address of the DNS server for the domain. Domain Port : The port of the DNS server. Directory Service : OpenLDAP, Active Directory or JumpCloud. SSL is enabled : Checks if SSL is enabled in the domain. Note: This option enables LDAPS and secures your LDAP server connection between client and server application to encrypt the communication. Save Domain User Password : Saves encrypted domain user password in Applications Manager database and uses it for authentication when domain is unreachable. User Permissions : The permission level for this domain. Read Only - All users logged in through this domain will have read-only access. Full Control - Users logged in will behave according to their roles specified. After entering all the necessary details, click Add Domain. Associating Users and User Groups to Multiple Domains:You can associate users and user groups to multiple domains: Click on Import Users from Active Directory / OpenLDAP / JumpCloud or Import User Groups from Active Directory / OpenLDAP / JumpCloud and import users/user groups from the directory. Go to Profiles or User Groups and click on a user or group. The domain to which the user or group belongs will be displayed in the Domain Name field. To add another domain, click in Domain Name text box and a drop-down list with other domains will be listed. Choose the domain you wish to add. Click Update User/User Group. If the ''Create a new user account if the user logs in with domain authentication'' checkbox in the Permissions tab is checked, users are created automatically based on their role in the user group. Permissions Operator Permissions: Using the Permissions options, you can allow Operators to manage / unmanage monitors, reset the status of monitors, edit display names, execute actions, start/stop/restart services, update IP Addresses, use Command Shell and clear Alarms. The operator role can also be granted permission to configure the Downtime Schedule and view Downtime Schedules. If you''ve chosen the option "Allow operator to configure Downtime Schedule", you will only see the Downtime Schedules configured by this user and you can schedule new downtimes to Monitors and Monitor Groups associated to you. If you''d like the user to view all the Downtime Schedules then please make sure you also choose the option "Allow operator to view all Downtime Schedules". The Downtime Scheduler option will be available as link in the Bulk Configuration view under the Monitor tab since the Settings tab is not available for the Operators. You can also allow the "Jump to link" option to be displayed for operators (Jump to link refers to access Add-On Products (like OpManager, Service Desk) and Managed Servers). In addition, you can also allow the user to view Managed servers by enabling the ''Allow operator to view Managed servers'' option for Enterprise Edition Admin server. Admin Permissions: You can allow admin to use Command Shell and to stop/start/restart Windows services. You can give permission to an administrator to Enable Delegated Admin Preferences. The admin can also be granted permission to create a new user account if the user logs in with domain authentication. The new user account will be created only when the Usergroup to which the user belongs is already imported from the same domain IBM i Permissions: IBM i Permissions allow you to permit Operators to execute IBM i Admin activities like controlling Message and Logging, Network Attributes, Date and Time, System Control, Library List, Storage, Allocation, Security, Jobs, Spool, Subsystem and using Non-Interactive Commands. By default, Applications Manager allows admin user(s) to execute IBM i operations but the option can be disabled. Views This is for Operator only. Using View option, you can define how to represent your subgroup in the webclient.You can either show the associated subgroups directly in the home tab itself or from the corresponding top level Monitor Group.  Account Policy To enhance Web Client security, Account Policies can be configured. You can define the number of continuous failed login attempts to lock user account and Idle session timeout. You can enforce single user session and strong password rules. Following are the password rules implemented in Applications Manager by default: Password cannot be same/part of your Login name Password length should not be less than 8 characters Password length should not be greater than 255 characters Password should contain at least 1 numeric characterPassword should contain at least 1 special character Password should contain both uppercase and lowercase character Password should not be same as your last 4 password(s) (Applicable only when the option ''Enforce strong password rules for users'' is enabled) Moreover, you can enforce password change for users that are logging in for the first time and for users that update the password manually under Admin → User Management → Profiles. Also, you can enforce password expiry by specifying the number of days after which password is to be expired for the user accounts. In addition, you can also restrict user management operations (such as create, update or delete) to user profiles, user groups, and domains for all administrator accounts, if required. You can also choose to enable business hours preferences for user accounts login. Note: For SSO-enabled Enterprise Edition setup, both the options and their associated values specified in the Admin server should be the same as that of Managed servers. Configuring Active Directory / LDAP with the configuration file You can import users and perform role configuration for LDAP users and groups in Applications Manager. Users and groups are fetched into Applications Manager from different domains, based on the entry in the authentication.conf file found in the following location. For LDAP configuration, you can edit theldapauthentication.conf file found in the location: ManageEngine/AppManager_Home/conf. Ldap Configuration ldap.group.commonNameAttribute=cn ldap.group.primaryAttribute=cn ldap.group.displayNameAttribute=cn ldap.group.objectCategory=group ldap.group.objectClass=posixGroup;groupOfNames ldap.group.memberAttribute=member;memberUid ldap.group.memberofAttribute= ldap.group.groupTokenAttribute=gidNumber ldap.user.commonNameAttribute=cn ldap.user.primaryAttribute=uid ldap.user.displayNameAttribute=cn ldap.user.objectCategory=person ldap.user.objectClass=person;posixAccount ldap.user.memberofAttribute= ldap.user.groupidAttribute=gidNumber Active Directory Configuration ad.group.commonNameAttribute=cn ad.group.primaryAttribute=sAMAccountName ad.group.displayNameAttribute=cn ad.group.objectCategory=group ad.group.objectClass=group ad.group.memberAttribute=member ad.group.memberofAttribute=memberOf ad.group.groupTokenAttribute=primaryGroupToken ad.user.commonNameAttribute=cn ad.user.primaryAttribute=sAMAccountName ad.user.displayNameAttribute=displayname ad.user.objectCategory=person ad.user.objectClass= ad.user.memberofAttribute=memberOf ad.user.groupidAttribute=primaryGroupID Note : If you have changes in LdapConfiguration.conf and later want to retain the initial configuration, simply rename the file (for example, rename it to LdapConfiguration_old.conf) or move the file to different location and restart Applications Manager. Delegated Admin PreferencesThe delegated administration role is used to assign limited administrative privileges to users in your organization who aren''t administrators. By delegating administration, you can assign a range of administrative tasks to the appropriate users and let operators take more control of their local network resources. Enabling Delegated Admin Preferences: In the Settings page, click User Administration under Applications Manager Server Settings Navigate to the Permissions tab. In the Admin Permissions table, check the Enable Delegated Admin Preferences. Once this checkbox is checked, when an administrator adds a new user to Applications Manager, he is asked to specify by a checkbox if he wishes to add the new user as a Delegated Admin. You can also perform the enable the following actions from the Admin Permissions table: Allow Delegated Admin to view/use thresholds and anomaly profiles created by administrators (non- delegated administrators) and other delegated administrators in the same user group. Allow Delegated Admin to view/use all actions created by administrators (non-delegated administrators) and other delegated administrators in the same user group. Delegated Administrator Privileges The following table lists the User Privileges of the Delegated Admin role in various scenarios: Scenario Delegated Administrator User Privileges Permission to create profiles and to edit and delete profiles which he has Credential Manager created. Permission to create new actions and to edit and delete actions which he has Action created. Additionally he can also view the actions associated to the monitors for which he has ownership. New Monitor and Monitor Permission to create new monitors and monitor groups, and to edit and delete Group new monitors and monitor groups for which he has ownership. Permission to create new profiles and to edit and delete profiles which he has Threshold and Anomaly Profiles created. Additionally he can also view the profiles associated to the monitors for which he has ownership. Permission to create reports and to edit and delete reports which he has Schedule Report created. Downtime Scheduler Permission to schedule the time period for which monitoring is not required. Alarm Escalation Permission to escalate an alarm and configure rules for alarm escalation. Configure Alarms Permission to configure alarms by monitor groups for which he has ownership. Permission to add and apply new process template to monitor groups and Process and Service Template selected monitors alone. Permission to configure Event Log Rules applicable only to monitor groups and Event Log Rules selected monitors. Permission to create dashboards and view default dashboards in Read-Only Dashboards / Widgets mode. Performance Polling, Global Trap, SNMP Trap Listener, User Administration, Data Retention, Not supported for Delegated Admin Role Managed Server   Administration, SLA, World Map View, Product License, Action Alarm Settings Logging By default, the debug prints are added to log files and are placed under  /logs directory. You can configure the logging mechanism using the following Logging Settings. Stop logging: If this option is selected, debug prints are not added to the log files. Print Fatal errors only: If this option is selected, the debug prints are added to the log files only when there are fatal or critical errors in the functioning of Applications Manager.Print Warning errors only: If this option is selected, only the warning level debug prints are added to the log files. Print Detailed debug errors: This is the default setting. All debug prints are added to the logs generated by Applications Manager. Print all logs: All logs generated by Applications Manager are printed. Personalize Web Client You can personalize the Applications Manager web client to suit your tastes. There are options to change the web client skin and layout, set the auto-refresh time for web client and customize the tabs. Select the Personalize Web Client option from the Settings tab. A pop-up window with 3 tabs named Skin, Web Client and Customize Tabs will be displayed . To Change Web Client Skin and Layout From the Skin tab, select the color of your choice. The colors available are blue, green, brown and orange. Select the layout of your choice. The options available are Classic and Simple. The Simple layout will be similar to the Classic layout, except for the absence of links on the left hand side and the top band. The monitoring data gets more prominence in the Simple layout. Click the Apply button. This changes the color and layout of the client''s look and feel. Auto-Refresh Web Client Using this option, you can set the time interval for auto refreshing the web client. This option is available under the Web Client tab. Customize Tabs The default order of tabs in the Applications Manager web client is Intro, Home, Monitors, Cloud, APM, User Experience, Alarms, Settings, and Reports. You can re-arrange the order in which the tabs are displayed as well as select new tabs for displaying.  Just select the necessary tab options from the respective drop-down boxes and click the Save button. If you want to remove a tab, choose the ‘Not Selected’ option from the drop-down box against the necessary tab order. This option is available from the fourth tab onwards. Server Settings AMServer Properties file General Settings Availability Settings Threads Configuration Database Params Configuration JVM Params Configuration List of keys moved to DB AMServer Properties file By editing AMServer.Properties file and AvailabilityTests.conf file (available under /conf/ directory), you can change the default server settings used in ManageEngine Applications Manager. Key Description This is the web server port used by Applications Manager to connect to the am.webserver.port browser. am.ssl.port Keys to enable SSL (https) and this will be enabled by default. Backend database type. Possible values : pgsql, mysql, mssql. If key not am.dbserver.type present, it will use mysql backend. am.db.port / am.mysql.port Port used by the database. am.mysql.port was used before 11am.tomcat.shutdown.port Tomcat ports for Applications Manager. If any of these ports is occupied when Applications Manager starts, it will be changed automatically. In builds before am.webcontainer.port 11, am.tomcat.shutdown.port will not change automatically even if it is am.rmiregistry.port occupied and it has to be changed manually am.shutdown.port Port in which Applications Manager will listen and receive traps from other am.traplistener.port device Key for zipping of support file. Not used by Applications Manager. Only used am.createSupportZipFile by IT360 While starting up, Applications Manager will check if the DB port mentioned in am.db.port / am.mysql.port is already occupied. If the ports are occupied, it will automatically change am.db.port / am.mysql.port to next unoccupied am.dbport.check port and start DB server in that port. This will be done for mysql and pgsql backend. By default these key(s) are true. If customer is using his own pgsql / mysql, these key(s) needs to be set to false. am.mysqlport.check was used before 11 While starting up, Applications Manager will check if the web server port am.webserverport.check mentioned in am.webserver.port is already occupied. If the ports are occupied, it will alert user and shutdown Applications Manager. Socket test timeout value in seconds used by various monitors like MySQL, MsSQL, DB2, JBoss, Oracle, Service monitor etc. This value can be also am.sockettest.timeout changed from Admin > Availability Settings > Availability Check: Timeout value These keys determine the language of Applications Manager. Default values am.server.language are am.server.language=en and am.server.country=US. Possible values are : English ( en / US ), Chinese ( zh / CN ), German ( de / DE ), Spanish ( es / ES ), French ( fr / FR ), Hungarian ( hu / HU ), Japanese ( ja / jp ), Korean ( ko / KR ), am.server.country Taiwanese ( zh / TW ), Vietnamese ( vi / VN ) Key to see if its Professional edition / Enterprise Edition. Possible values are : am.server.type NORM, AAM, MAS am.edition.type   For Enterprise Edition managed server this will have the host name of admin am.adminserver.host server For Enterprise Edition managed server this will have the SSL port of admin am.adminserver.port server The resourceid range for this Applications Manager. For Enterprise Edition this am.server.startresidrange will be in range according to serverid. am.failover.preferredstandby   Fully qualified Hostname of Applications Manager is required for monitoring am.ntlm.hostname URLs with windows NTLM authentication. If this field does not have FQHN, we need to update it manually for proper URL NTLM monitoring This has the domain name of Applications Manager server which is required am.ntlm.hostdomainname for monitoring URLs with windows NTLM authentication. For Enterprise Edition, admin server will report that managed server is down am.adminpollstry.count according to polls to try set in this key. By default value is 1. Hostname of Applications Manager which is used in alert mail, alarm am.appmanager.hostname escalation mail, report mails sent by Applications Manager. If Applications Manager is in DMZ or behind firewall and has an Internal and am.external.hostname External Hostname/IP, we can set External hostname / Ip here so that when users access JRE Thread dumps, MySQL and Ingres Process list. Key for changing location of logs directory. Not used by Applications Manager. am.log.dir Only used by IT360 am.scheduleReports.enableSSL   am.user.resource.enabled   am.sso.enabled   am.wmi.encoding Encoding to be used for parsing vbscripts output in WMI mode Under Settings tab, click on Server Settings under Product Settings. Here is a list of keys that can be configured from the UI:General Settings Option Description Maximum Subgroup level Number of levels of subgroups that can be created in a monitor group. Time period (in hours) of raw data stored in database for all non-conf monitor''s Raw data cleanuptime (hours) * attributes can be changed by using this key. Maximum time period allowed to retain the raw data is 24 hours. Conf data cleanup interval To change the clean interval of data stored in conf monitors, this key value is (days) changed. Week Start Day of MG outage For Monitor group outage comparison week report, the week starts from comparison Report Sunday. OutOfMemoryException If 20 (am.oomexception.count) out of memory error occurs in less than 30 duration (mins) minutes (am.oomexception.duration), Applications Manager restarts OutOfMemoryException count No of retries out of Memory errors occurred. Default set to 20. Maximum threads for Max threads allowed for Scheduler Task. scheduler * Generate heap dump for free If free JVM memory is less than 20 MB, a heap dump for Applications Manager JVM memory (MB) is generated. Debug-Info directory size limit Old files in AppManagerworkingDebug-Info directory are cleared, once it (MB) reaches 80% of this key value. Command size in Execute Changing the key value will increase the size limit of 400 characters, for program action commands in execute program. Enable SSL * This key enables SSL (HTTPS) and will be enabled by default. If Enabled, displays subgroups in Alarms, Reports and New Monitor page''s Enable Subgroups view Monitor Group. Enable Subgroups in SLA view Lists sub groups in SLA page, if enabled along with ''Enable subgroups view''. Admin receives email,if data collection for monitor(s) doesn''t occur for more Send mail on datacollection than an hour or if there are out Of memory errors or if data collection stops for failure 50% of monitors. Disable datacleanup in business Enabling this key ,ensures that data cleanup doesn''t happen between 8:00 am hours to 6:00 pm. If enabled, the browser automatically opens when Applications Manager Open browser on Startup * starts. Send Monitor Error Mail Sends a mail if data collection stopped for any monitor. Enable file Upload Enables file uploads option in Settings tab -> Upload Files/Binaries Delete Synced SQL files in Disabling this will ensure .sql files(sent from managed server to Admin server Admin Server * for syncing data) are not deleted in admin server, after syncing data. If any monitor error continuously occurs poll count times then error mail will be Error poll count sent to admin id. Maximum polling load factor to Represents Managed server maximum polling load factor to add monitor add monitor * Maximum database load factor Represents Managed server maximum database load factor to add monitor to add monitor * Managed server maximum Maximum no.of monitors allowed per Managed server. monitor count * If enabled, it cleans up stray entries on Saturdays whenever Applications Enable weekly stray entries Manager is restarted. After the first cleanup is done, subsequent cleanups will cleanup take place on first Saturday of every month. Configures the time limit (in days) within which data should be polled. By default, poll value is restricted to 3 days (4320 minutes). Poll limit (in days) Note: Poll limit value should not exceed more than 365 days. Availability SettingsOption Description Enable NativePing Enables Native Ping to determine server monitor availability. Enable PortTest Enables port test for Server monitoring. Ports to test Ports mentioned here will be used for port test. PortTest timeout in seconds Timeout value for checking the ports. Number of retries to execute the ping command in case of failure to check the Ping retries availability of server. Tomcat, Apache, PHP, WebSphere monitor''s connection time out value in Application Server timeout minutes. Threads Configuration Option Description Main * This thread is used for JMX/SNMP Dashboard,Schedule Reports Monitors like HTTP(s) URLs,HTTP(s)-URL Sequence,SAP-CCMS uses this URLMonitor Thread * thread for data collection. Monitors like Active Directory Amazon,Cassandra,Ceph Storage,DNS KeyValueMonitor Thread* Monitor,Database Query Monitor,Exchange Server,Script Monitor etc. uses this thread for data collection. RBMMonitor Thread * Real Browser Monitoring uses this thread for data collection. MQSeriesMonitor Thread * IBM Websphere MQ monitor uses this thread for data collection This thread is used for datacollection of monitors like DataCollection Thread * AIX,AS400/iSeries,Apache Server,DB2,FreeBSD / OpenBSD,HP-UX / Tru64 UNIX,IIS Server etc. This thread used for dataCollection of Custom Attributes for monitors like CustomMonitor Thread  * RMI,WEBLOGIC-server,JBOSS-server,WebSphere-server,JMX1.2-MX4J-RMI. WebServiceMonitor Thread * This thread is used for WebServices. QueryMonitor Thread * This thread is used for Query Monitors. Database Params Configuration Option Description This key is used to configure the no.of non transaction connections to be No. of Database Connections * established with the database. JVM Params Configuration Option Description Maximum Java Heap Size (MB) * Maximum memory allocated for Applications Manager. Maximum Permgen Size (MB) * Maximum Permgen size allocated for Applications Manager. * - Indicates changes will take effect only after restart of APM. * - Enterprise Edition List of Keys that were moved to DB Key Option to Configure in GUI am.host.deleteDisk Settings → Performance Polling → Servers am.cli.telnet.passwordprompt am.cli.telnet.loginprompt am.cli.bulkcmd.exec.responsetimeout am.server.cli.match.category.index am.server.command.responsetimeout am.cli.command.bulk.execute am.cli.loginprefixKey Option to Configure in GUI am.cliSession.caching am.disks.ignore am.spacecheck.warning am.telnet.loginTimeOut am.wmi.encoding am.server.windows.resend.vbscripts am.rawdata.enabled am.processinstance.equals am.nosql.rediscover.interval am.mssql.deleteJobs Settings → Performance Polling → Database Servers am.htmldata.mysql.daystoretain am.pingtest.command Settings → Performance Polling → Ping Monitor am.repoll.interval Settings → Performance Polling → HTTP(s) URLs Settings → Performance Polling → Optimize Data Collection am.cam.mbeanslistsize → JMX Application am.dirsize.unit Settings → Performance Polling → Optimize Data Collection am.filesize.unit → File/Directory Monitor am.file.contentcheckcount Settings → Performance Polling → Optimize Data Collection am.ftp.filesize → FTP/SFTP Monitor Settings → Performance Polling → Optimize Data Collection am.htmldata.jre.daystoretain → JavaRuntime Monitor am.mqseries.ccsid Settings → Performance Polling → Optimize Data Collection am.mqdelrow.enabled → WebSphere Server Settings → Performance Polling → Optimize Data Collection am.script.deleterow → Script Monitor am.querymonitor.rowcount Settings → Performance Polling → Optimize Data Collection am.query.timeout → Database Query Monitor am.vsphere.connection.timeout Settings → Performance Polling → Optimize Data Collection am.vsphere.read.timeout → VMware ESX/ESXi Monitor Settings → Performance Polling → Optimize Data Collection am.xen.resourcepool.discovery.enable → XenServer am.ssl.enabled Settings → Server Setting → General Settings am.subgroups.enabled am.slasubgroups.enabled am.senddcstoppedmail.enabled am.detailview.show - (MAS & Prof)-hidden am.server.deleteMonitor.comparing.csvToCmdb - hidden am.server.defaultDiscovery.enabled - hidden am.upload.enabled am.userresource.onLogin.update - Hidden am.admin.mgstatusview.enabled am.querytracker.enable - Hidden am.simple.theme.enabled - Hidden am.startmonthread.enabled - Hidden am.monitorGroup.rules.enable - remove am.standalonesdp.enabledKey Option to Configure in GUI am.cleanup.nonbusinesshours am.expandWidgets - need to check.. am.adminserver.deletesql am.spacecheck.warning - remove key and related code am.sendmonerrormail.enabled am.browser.startup am.dbconnection.refresh - Hidden am.push.userconfig.details - remove am.useresource.operations.concurrent.update - Hidden cmdb.xml.path am.api.response.timeout am.triggerheapdump.freememorymbst am.mas.polling.max.loadfactor am.mas.database.max.loadfactor am.executeaction.size am.errorpoll.count am.rawdata.value - move to servers tab am.report.weekStartDay am.userResUpdateThread.schedule.interval - Hidden am.subgrouplevels.count am.html.dirsize am.server.maximum.thread.schedulerTask - restart am.oomexception.duration am.oomexception.count am.confdata.cleanupinterval am.rawdata.cleanuptime am.enablenativeping am.porttestenabled am.portstotest Settings >Server Setting > Availability Settings am.tomcattimeout am.porttest.timeout.seconds am.ping.retries Note: Log clean-up in Applications Manager is an automatic process and logs are cleared without any changes in settings. To make changes in clean-up intervals refer to the table above. Privacy Settings Consent For Add on products integrations, whenever the configuration is saved, the consent details are updated accordingly and audited. The consent details can be viewed under Settings → General → Privacy Settings. Allow pushing tickets to ServiceDeskPlus / ServiceDeskPlus MSP / ServiceDeskPlus On-Demand Allow automatic sync of resources into ServiceDeskPlus CMDB Allow automatic sync of incidents in ServiceNow Collect Usage StatisticsAlarmsOne Integration Security Settings This section explains the security settings that can be made in Applications Manager. This can be accessed by clicking the Settings tab and selecting Security Settings under Product Settings section. This page will display how secure your Applications Manager instance is, in terms of percentage graph. Following are the list of options that are available in the Security Settings page: User Management Enforce strong password rules for users: Allows you to enforce strong password rules for users accounts in Applications Manager. Learn more Enforce account lockout: Allows you to enforce account locks in case of consecutive failed login attempts. Learn more Server Port and Protocol Configuration Disable HTTP port in Applications Manager: By default, Applications Manager can be accessed via both HTTP and HTTPS ports. Choose this option to disable HTTP access. Learn more Use Third Party SSL Certificate: Applications Manager comes with a self-signed SSL certificate for HTTPS to work. Use this option to configure and apply your own CA signed SSL certificate. Learn more Disable TLSv1 and TLSv1.1 protocols for HTTPS port: Applications Manager supports TLSv1, TLSv1.1 and TLS v1.2 by default. Use this option to disable old TLS v1/1.1 protocols. Learn more Others Reports Settings - Export Data Protection: Allows you to configure a password for Data Protection in PDF Schedule Reports. Learn more Enable security response headers: These headers are an added layer of security that helps browsers to detect and mitigate certain types of attacks. Content-Security-Policy: Configures frame-ancestors directive to combat click-jacking. Learn more X-XSS-Protection: Stops pages from loading when browsers detect reflected cross-site scripting (XSS) attacks. X-Content-Type-Options: Prevents MIME type sniffing attacks. Disable file upload: Allows you to disable the Upload Files / Binaries option in Settings tab. Enable read-only database user connection for Query Tool: When enabled, Applications Manager uses read-only user database connection to execute queries in the Query Tool page under Support → Database Summary   Enterprise Edition Settings This section explains the Enterprise Edition settings that can be made in Applications Manager. This can be accessed by clicking the Settings tab and selecting Enterprise Edition Settings under Product Settings section. On performing any of the configurations, click the Save button provided at the bottom of the page to implement the configured settings. Following are the list of options that are available in the Enterprise Edition Settings page: Show Admin server status: Enabling this option allows you to display the status of Admin server in all the corresponding Managed servers. However, this option is applicable only for Managed Servers. Proxy Managed Server request through Admin Server: By enabling this option, the graphs and images displayed for a monitor are retrieved directly from the corresponding Managed server and will be shown in the Admin console. This option will be applicable only for Admin server. For more information, refer here. Delete Synced SQL files in Admin Server: Disabling this option will ensure that .sql files (sent from Managed servers to Admin server for syncing data) are not deleted in Admin server after syncing data.Probe Key Regeneration interval (days): Time interval set to regenerate the Probe Registration Key in the Admin server (in days). Value entered should be greater than 0. Enable managed server(s) report data sync with Admin server: Enabling this option will sync report data of Managed server(s) with the Admin server. Send email when managed server goes down: Allows you to send email alerts whenever the Managed server goes down. After enabling this option, you can configure to send the mail based on the number of times for the Managed server has went down consecutively by specifying the value for the same. Send Mail Alert from Admin for Selected Managed Servers: Allows you to send mail alerts for the selected Managed servers from Admin server. Integration with Portals Browse through the below topics to learn more about Integration with Portals, available under Settings tab in Applications Manager: REST API JSON Feed Dashboards World Map Business View REST API Applications Manager provides REST-style APIs for fetching data from Applications Manager and integrating them into an internal portal or a third-party system management software. These data can be inserted to your own database or put in any format that you need. To start using our APIs, you need a valid Applications Manager user account and an API key. For complete information on how to use our REST APIs, please refer this section. JSON Feed JSON feeds are used as an alternative for using XML for asynchronously transmitting structured information between client and server. It is a lightweight text-based open standard designed for human-readable data interchange. Using JSON Feed, you can integrate Applications Manager’s data in your intranet web page. URL request for fetching JSON Feed would look like this: http:// : /jsonfeed.do?method= [JSONFeedName]&requestParameterName=requestParameterValue API''s available under JSON Feed in Applications Manager are listed below: Name Description Request Parameters To get information on the Monitor group''s createMonitorGroupFeed method createMonitorGroupFeed status and Monitor''s status Example : http:// : /jsonfeed.do?method=createMonitorGroupFeed To get information on getMonitorsJSONFeed method getMonitorsJSONFeed the Monitor''s status Example : http:// : /jsonfeed.do?method=getMonitorsJSONFeed getParentGroups To know the Parent method getParentGroups Monitor group''s information for the haid The id of the monitor group. In the Applications given Monitor Sub- Manager, you can find the group ID of a monitor group using the following method: group ID Click on the Group Name in the monitor groups table. This will open the Monitor Group details pageThe URL of the Monitor Group details page will be in the following format:http://app- windows:9090/showapplication.do? &method=showApplication&haid=10000040 The haid in the URL is the Group ID that you require, in this case, 10000040. Example : http:// : /jsonfeed.do?method=getParentGroups&haid=10000040 method getMonitorCount The id of the monitor group. In the Applications To get the number of Manager, you can find the group ID of a monitor monitors associated group using the following method: with the given monitor group. Click on the Group Name in the monitor groups table. This will open the Monitor getMonitorCount Sample Output: Group details page {"APP":["5"],"SYS": haid The URL of the Monitor Group details page ["1"],"NWD":["0"]} will be in the following format:http://app- windows:9090/showapplication.do? NWD - Network &method=showApplication&haid=10000040 Devices The haid in the URL is the Group ID that you require, in this case, 10000040. Example : http:// : /jsonfeed.do?method=getMonitorCount&haid=10000040 This API provides below options To get all Monitor group''s method getConsoleJSONFeed information allMGResource - To get all Monitor group''s To get the list of information server monitors allMonInMG - To get the list of server monitors available inside toReturn for given Monitor group ID given Monitor getConsoleJSONFeed OpManResource - To get the list of monitors group added using OpManager integration To get the list of mgId monitors added The id of the monitor group (Optional) using OpManager (Complete list or monType Category of the OpManager resource for a given (Optional) monitor group or for given category type) Example : http:// : /jsonfeed.do? method=getConsoleJSONFeed&toReturn=allMonInMG &mgId=10000040 Dashboards Applications Manager monitors over 50 applications and servers out-of-the-box and tracks a variety of performance indicators for each application or server monitored. In a typical IT environment however, there are certain servers and metrics that are more business critical than others. Therefore, you might want to provide more importance to those servers and their metrics. Dashboards are an easy way to put together such business-critical applications and view their performance and alerts at one place. Applications Manager provides 4 dashboards by default - default dashboard, business view, Availability and Qos Worldwide. In addition, you can create custom dashboards such as ones that capture the status of all web applications deployed in a Tomcat server or status view of all databases and so on. For more information on dashboards, refer this section. World Map Business View World Map Business View in Applications Manager enables network administrators to get a comprehensive understanding of how distributed their network really is.You can represent a monitor group in the World Map. Monitor Groups are a logical group of one or more monitors that provides a holistic view of your business environment. You can visually represent the status of all your monitor groups across the globe. The root cause analysis (RCA) data is available in the map. To represent Monitor Groups in World Map, follow the steps given below: While creating a new monitor group, you can associate the monitor group to the location chosen from the list. Else, click on Advanced and then Add Location, it opens up a world map. From the map, you can select and add custom locations. You can also delete or edit the added location, if required. However, these options are applicable only for Admin users. In additon, you can also save the zoom level, as per your need, by clicking on the option, “Save current zoom level” present in the right top corner of the web client. World Map Settings You can add, edit or delete location from the ''Manage Location'' drop down box. You can click Add Location, it opens up a world map. To navigate to a location, use the controls on the top left of the map. Select a location in the map by clicking it with the mouse. You will see an image indicating your selection. Add a name for the location in the ''Location Name'' field and click Add Selected Location. You can also customize the Height and Width of the World Map. Reporting Browse through the below topics to learn more about reporting, available under Settings tab in Applications Manager: Report Settings Enable Reports Schedule Reports | Report types in Schedule Reports Business Hours Manage SLA Report types in Schedule Reports Applications Manager has the following report types under Schedule Reports:  Report type  Description   Sends the alarm report details of selected monitors over a period of time. It shows alarm occurrences for the application, attributes grouped in the Alarm application, and monitors, with graphical representation. You can choose the monitor, the period, and also resources for which you want the report to be generated. Sends the performance of the monitors within the selected monitor group. You At a Glance Report can choose the monitor/monitor group/type, the period, and also resources for which you want the report to be generated. Sends the attribute report details of selected monitors over a period of time. You can choose the monitor group/type, the period, and also resources for Attribute which you want the report to be generated. In addition to that, associate specific attributes and business rules, and filter them by custom fields. Sends the availability report of selected monitors over a period of time. You can choose the monitor group/type, the period, and also resources for which Availability you want the report to be generated. In case you choose monitor group, a valid business rule needs to be associated to it. Sends the critical availability and health snapshot of selected monitors over a Availability & Health Critical period of time. You can choose the period for which you want the report to be Snapshot generated and filter them by custom fields. Availability & Health Current Sends the current availability and health snapshot of selected monitors over a Snapshot period of time. You can choose the period for which you want the report to begenerated and filter them by custom fields. Sends the health and availability history of selected monitors over a period of time. You can choose the period for which you want the report to be generated Availability & Health History and filter them by custom fields. A valid business rule needs to be associated to it. Sends the availability trend details of selected monitors over a period of time. Availability Trend You can choose the period for which you want the report to be generated and filter them by custom fields. A valid business rule needs to be associated to it. Sends the availability and downtime trend details of selected monitors over a period of time. You can choose the period for which you want the report to be Availability and Downtime Trend generated and filter them by custom fields. A valid business rule needs to be associated to it. Sends the capacity planning reports for the selected monitors. Select the Capacity Planning server type (Undersized Servers/Oversized Servers/Idle Servers), monitor groups and servers for which you want to generate a report. Sends the custom attribute details of selected monitors over a period of time. Custom Attributes You can choose the period for which you want the report to be generated and filter them by custom fields. Dashboard Report Sends the details of all the selected dashboards. Sends the details of all the database users in selected databases. Currently, Database Users Report only MS SQL and Oracle databases are supported. Sends the downtime summary for all monitor groups and also the downtime history for specified number of monitors, in the order of least availability, Downtime History across all time periods. Select the report period and the number of monitors for which you want the report to be generated. At a Glance Report of a particular EUM Monitor across locations. You can Downtime Summary Report choose the period and resource types for which you want the report to be generated and filter them by custom fields. At a Glance Report of a particular EUM Monitor across locations. You can EUM At a Glance Report choose the period and resource types for which you want the report to be generated and filter them by custom fields. The summary Report of a particular EUM Monitor across locations. You can EUM Summary Report choose the period for which you want the report to be generated and filter (across locations) them by custom fields. Forecast Report Sends the forecast report of selected attribute. Sends the health report of selected monitors over a period of time. You can Health choose the monitor group/type, the period, and also resources for which you want the report to be generated. Sends the history report of SQL jobs. This option is available only in managed MS SQL Job History Report servers and professional editions. MS SQL Failed Job History Sends the history report of SQL jobs that have failed in the last 24 hours. This Report option is available only in managed servers and professional editions. Sends the performance report of MS SQL database. Choose the performance MS SQL Performance Report type, report period and the resources for which you need a report. Sends the outage comparison details of selected monitors over a period of time. You can choose the period for which you want the report to be generated Outage Comparison and filter them by custom fields. A valid business rule needs to be associated to it. Sends the query output of selected database query monitor tables. This option Query Results Report is not available in admin servers, it''s only available in managed servers and professional editions. Sends the overall server utilization report (comprising of CPU, Memory and Server Utilization Report Disk Utilization in percentage) for the selected monitors over a period of time. Sends the details of SLAs of selected monitors. You can choose the period and SLA which SLA resources for which you want the report to be generated. Sends the summary of all the reports for that particular monitor. You can Summary choose the period and resource types for which you want the report to be generated. Threshold and Action Profile Sends the details of all the thresholds and action profiles of the selected CSV monitors in CSV format. You can choose whether to generate a report forMonitors not associated to any Monitor Groups or Monitors do not have Threshold/Action association ot all monitors. Reports Settings This section explains the report settings that can be configured in Applications Manager as well as data retention settings. To access this section, click the Report Settings link under the Settings tab. The section consists of the following inner tabs: Reports Settings Data Retention Logo Settings Customize the logo in Applications Manager’s dashboard Export Data Protection Reports Settings Availability Reporting: Treat Monitor Groups as Application Cluster (Availability based on default calculation) : By default, the Monitor Group availability will be shown as down (0%) if any one of the monitors in the Monitor Group is down. Treat Monitor Groups as Services Group: By selecting this option, you can calculate Monitor Group availability based on the services availability. For eg., if there are 5 monitors in a Monitor Group and one monitor is down, Monitor Group availability is calculated as 80% available (one monitor - 20%). Do not include Scheduled Maintenance and Unmanaged state in availability reporting: If you select this option, you can exclude scheduled maintenance and unmanaged state data from availability reports. Attributes Reporting: Plot attributes report with Bar chart: If you select this option, you can view the attributes report in the form of bar charts. Plot attributes report with Line Graph: If you select this option, you can view the attributes report in the form of line graphs. Show Plot shape in graph: By selecting this option, you can see the dots / blobs in the line graphs. Moving Average: A simple moving average is the unweighted mean of the previous n data points. For example, a 10-day simple moving average of attribute value like CPU utilization is the mean of the previous 10 days'' CPU Utilization value. By selecting this option, you can add moving average graph in the 7, 30 graphs of the various monitors. Data Retention To plot graphs and generate reports, Applications Manager collects data from the monitors at regular intervals. By default, Applications Manager aggregates the performance data into hourly data at the end of each hour. The hourly data thus calculated will be aggregated into daily data at the end of each day. The aggregated data will be used in graphs and reports. Applications Manager allows you to maintain the database with the required data. By default, the detailed data will be maintained for six hours max, the hourly data for 90 days and the daily data for 365 days. After the specified period, the database will be cleaned up automatically. To configure your own settings for database retention, follow the steps given below: Click on the Settings tab. Under ''Reports Settings'' section, click Data Retention tab. Enter the number of days for which hourly statistics should be maintained. Enter the number of days for which daily statistics should be maintained. Enter the number of recent alarms that should be maintained in the alarm database. Enter the number of days for which hourly statistics of disk and servlet attributes should be maintained. By default, it will be maintained for 30 days. Enter the number of days for which the health history data should be maintained. Enter the number of days for which the downtime history data should be maintained.Enter the number of days for which the event count data should be maintained. Save the changes. Note: Unsolicited traps will be maintained for a default value of the last 5 Hours. Logo Settings Click on the Logo Settings Tab to configure the report logo settings. By default, presentation reports display the ManageEngine Applications Manager Logo in the upper left corner. Click on Change to change the logo. Click on the Browse button and select an Image. Click on Save to set the logo. The user can change Logo in pdf and Excel Report. The ideal image size should be about 262*54 Dimensions and not more than 100KB. You can upload any file in gif/jpg/png formats. Customize the logo in Applications Manager’s dashboard To update the Applications Manager dashboard with your company’s logo, please follow these steps: Create a file called OEM.txt and add following entries in that file. am.header.logo=am_logo.gif am.loginpage.logo=/images/new_login-logo.png Copy the OEM.txt file to \working\conf\ folder. Create two image of your company’s logo as per your requirement and rename it am_logo.gif and am_logo.png. Take a backup of the existing am_logo.gif and new_login-logo.png outside Applications Manager directory and remove the two files. Paste the images you have created to \working\images folder and restart the product. Now check the dashboard to see if the Applications Manager logo has been replaced with your company’s logo. Note: Please ensure that while changing the key values, no spaces are included, as that will affect the functioning of the product. Export Data Protection You can enable password protection for reports sent as PDF attachments or published as report links (configured via Schedule Reports) by selecting ''Enable'' for the PDF Password or File Access Password options respectively. Click Modify Password to configure a password and select where the updated password should be sent to: All users - Updated Password should be sent to all admin users and the list of emails which where configured while scheduling reports. Admin users - Updated Password should be sent to all admin users only. No users - Password will be updated in database and mail with the password will not be sent to any user. However, as always, during Report Scheduleing, the scheduled reports mail and a password mail will be sent to users assoicated with that specific Report Schedule. Clicking Save will send out the password to the selected users. Enable Reports Using this option, you can generate reports with additional performance metrics for selected resource(s)/monitor(s) apart from already available performance metrics. To Enable Reports Click on theSettings tab. Click on Enable Reports under Reporting.Now you can configure Custom Monitors and Downtime Summary Report by following the steps given below. Custom Monitors Under Custom Reports tab, you will be able to select the required resource and associated performance metrics. Select the tick box besides the performance metric that needs to be included in the reports. Click Save button below and the selected performance metric will be added automatically in your reports and in your scheduled reports. Downtime Summary Report The Downtime Summary Report is enabled by default. This option sends out a downtime summary for all resources that are monitored. The email will be sent in html format to the specified email id. To configure new email action, click New Action and provide the email address and click Save . This report will provide you the top 20 downtime summary of all individual monitors. Another method to Enable Reports: Click on Reports tab. You can enable reports by clicking on Enable Reports link above the Monitor Group. Follow the steps prescribed above to select the required attributes. If email actions are already configured, select the email to which the reports need to be sent else you can configure new email action. Click Save to create the reports schedule. Schedule Reports Applications Manager generates many reports that help you to analyze the performance over a period of time. Using this option, you can schedule the time at which the reports need to be generated. Creating a new schedule of reports Click on the Settings tab. Under Reporting, click on Schedule Reports. If reports have been already scheduled, the schedule details would be listed. Else, it would prompt you to create new schedule. Give a name for the schedule Enter the description of the schedule By default, the schedule for the report is enabled. Choose the Report Type like Availability report, Downtime history report. Select the Report period. Choose whether you want report for monitor types, monitor groups or for individual monitors. Accordingly, the resources will be listed down. Select the resource for which the report is expected. Set the time for the reports to be delivered. For eg., If you want the health report of database servers to be delivered for every 2 hours, choose the ''Hourly'' option and set the number of hours as ''2'' from the dropdown. By doing this, the report will be delivered for every 2 hours starting from 00.00 hours (i.e.) report will be delivered at 02.00, 04.00, 06.00 hours and so on. If you want the report to be delivered everyday at 10.00 a.m, choose ''Daily'' option and set the time as ''10.00''. You can also configure multiple time schedules (upto 10) if required. If you want the report to be delivered every monday at 10.00 a.m, choose ''Weekly'' option, set time as ''10.00'' and choose ''Monday'' option. If you want the report to be delivered every month on 15th day at 10.00 a.m, choose ''Monthly'' option, set time as ''10.00'', choose ''15'' from the day list and select all for the report to be delivered every month. (You can select individual months also) Select whether you want to receive the report as PDF files, CSV format or as URL links. If email actions are already configured, select the email to which the reports need to be sent else you can configure new email action. Click Save to create the reports schedule. To know about the report types under Schedule Reports, click here. Note: Reportadmin user is used to generate Email, PDF and Schedule Reports feature. The password is generateddynamically for each and every user, hence no one can access the webclient using this username and password as it is secured.   Business Hours Business hours is a pre-determined set of hours which helps you to view reports for the particular hours during the day. Instead of viewing data for the entire 24 hour period, you can now view reports for the particular business hour you have set. It helps you identify the critical issue which may have arised during business hour for a particular application or resource. To create a business hour, follow the instructions given below: Click on Settings tab. Click on Business Hour under Reporting. Click the New Business Hour link. Provide Name for the business hour (Eg. Office Hours). Provide Description for that business hour. Now select which day(s) do you want to view reports for. Then select the time period for which you would like to view the reports for. Refer to the screenshot for reference: Click Save. Once the business hour is created, you can now generate various reports for the particular business hours you have created. Setting Business Hours in the Enterprise Edition You can set Business Hours from the Admin Server and the Managed Servers in the Enterprise Edition of Applications Manager. The business hours set in the Admin Server automatically syncs with the Managed Servers. However, the hours set in the Admin Server can only be reused and cannot be edited from the Managed Servers. SLA Management Console For Managers SLA Management Console would essentially help the Manager to have an integrated high-level view of the Business Infrastructure. Here, monitor groups form Business Application units. The manager can create service level agreements (SLAs), the violation of which can be escalated by Email. By default, if the Manager is not explicitly associated to a Monitor Group, the Manager will be able to access all the Monitor Groups in the Manager Console. If the Manager is associated to a certain Monitor Groups, only those Monitor Groups will be shown in Manager Console - More SLA Management Console gives the overall status of the various Business Applications that are associated with the system. You can view the availability statistics graph of the Business Applications for various time periods like ''Today'', ''Yesterday'', ''Last Week'', ''This month'', etc. Server SLA Events Creation of New Service Level Agreements The Service Level Agreement (SLA) statistics table lists all the Business Applications & their SLAs and indicates whether the SLAs have been met or not. You can view the Availability % (clicking on the availability value will help you view the overall availability report of the Monitor Group and also the availability reports of the individual Monitors in the Monitor Group), Mean Time To Repair (MTTR), MTBF (Mean Time Between Failures). Mean Time To Repair (MTTR): The average time to repair a device or a system back to acceptable operating conditions. The term can also mean, the time spent to restore a machine to operating condition after failure.This must be as low as possible. Mean Time Between Failures (MTBF): The average time that a device or a system worked without failure. The term can also mean the length of time a user may reasonably expect a device or system to work before an incapacitating fault occurs. This must be as high as possible. Server SLA: Upon clicking the Server SLA tab, you can view the SLA details for all the servers associated. Server Availability statistics is shown as a pie chart. By default, the least availability statistics for ''Today'' is shown. A maximum of availability details of 12 servers would be shown as pie chart. You have an option to view the availability statistics for other time periods like ''Yesterday'', ''Last Week'', ''Last month'', etc., The server availability statistics - uptime % table, clearly lists down all the Servers associated with the different types of SLAs and it indicates whether the Servers have met the SLAs or not. If there is a SLA violation, the corresponding statistics is highlighted in red. The other details that can be viewed are Total Downtime, Availability %, MTBR, MTBF along with the trouble tickets associated with it. You can view the Server availability report for the past seven days by clicking on the 7 Icon. Events: Upon clicking the Events tab, you can view the SLA details for all the Events associated. Events Volume statistics is shown as a bar graph. By default, the volume statistics for ''Today'' is shown. A maximum of Events volume details of 12 business applications would be shown as bar graph. You have an option to view the Events volume statistics for other time periods like ''Yesterday'', ''Last Week'', ''Last month'', etc., The Events Volume table, clearly lists down all the Business Applications associated with the different types of SLAs and it indicates whether events volume has met the SLAs or not. If there is a SLA violation, the corresponding statistics is highlighted in red. Across the various time periods, you can compare the trends in the volume of Events Creation of New Service Level Agreements Click on the New SLA link Enter the SLA Name Enter the SLA Description Choose whether to use the SLA for Business Application or for Server Then you go on to define the SLA Rules The Service Level Objectives provided are Availability and Events To meet the SLA, Availability can be set as equal to, greater than, or greater than equal to a percentage value. By default it is 99.9 % To meet the SLA, the Events Volume can be set as less than, equal to or less than equal to a particular number of Events per month. The next step is to associate the SLA to the Business Applications or the servers as per the initial choice. From the available list, Select the Business Applications / Servers that you want to monitor using the SLAs. You have an option to escalate SLA violation through Email. Enter the From address, to address, subject, and message of the escalation Email. The mail will be sent to the recipient(s) with the root cause message of the SLA violation. Click on ''save'' to create a new SLA. Note: E-Mail escalation of SLA violation is always calculated for last 30 days. You can go to SLA reports and select period as last 30 days and see the SLA violations.  Tools Browse through the below topics to learn more about Tools, available under Settings tab in Applications Manager: Audit Logs Self Monitoring Upload Files/Binaries Manage Certificates Self Help Tools Backup Schedule Audit LogsOverview How to view Audit Logs Displayed Parameters Operations audited Overview Audit Logs are documents that record changes or actions occurring in a system. Applications Manager lets you view Audit Log information, where you can keep track of all the events occurring in your account, and aids you to identify the changes made in your profile within specified periods of time. It documents the list of actions performed by the user along with the timestamps. How to view Audit Logs Login into your Applications Manager account. Go to Settings tab and click on Audit Logs. Here you can view the list of all the past actions that have been done in your account, segregated based on the type of action occurred, the name of the user along with its Hostname/IP address and the log message description for that action along with its timestamp. Furthermore, you can filter audit logs based on the required action type and time range of your choice. This can be done by Selecting the required list of actions and the required user names from the respective drop-downs Entering the number of days within which the logs have been recorded Click on the Filter button. Displayed Parameters Parameter Description Action Type The type of action performed by the user.  User Name The name of the user who triggered the action. Host Name / IP Address The host name / IP address of the user that issued the action. Description Displays the log message generated after executing that action. Date and Time The date and time of that action performed.   Note: Additionally, you can generate reports in various formats like pdf, csv, xls, etc. by clicking on their respective icons available at the top right side of the audit log table.  Operations audited Following are the list of operations that are audited under Audit Logs in Applications Manager: User Administration and Management REST API Key regeneration Actions related to monitoring and management of resources from Applications Manager such as Start, Stop, Reboot actions of Virtual Machines as well as Cloud resources management Certificate upload and management Configuring third party Add-ons OAuth Configuration for third party application monitoring and integration Configuring Actions from Applications Manager such as Email, SMS as well as Execute Programs File upload to Applications Manager MS SQL Management from Applications Manager Alarm template configuration changes Stop/Restart of Applications Manager from GUI Management of probe registration key regeneration and authentication keys in Enterprise Edition communication Self-MonitoringSelf-monitoring functionality helps you detect issues across all the components of Applications Manager''s services and ensures their health and performance to provide uninterrupted monitoring support. You are provided with critical information about the occurred problem to help you drill down to the root cause and thus prevent possible service outages. Currently, Applications Manager performs a periodic checkup for the health of the following components: Server Monitoring (APM service running host machine) Database Monitoring (SQL servers being used as backend of APM service) JVM Monitoring Load-specific performance attribute monitoring. Diagnostic Detail Configuration User can modify the poll interval, consecutive poll count and threshold value for each attributes as follows: Under Settings tab, click on Self Monitoring under Tools. A Diagnostic Details table is displayed with a description of the diagnostic. You can configure the Poll Interval, Consecutive Polls and Threshold Value by clicking on the edit icon ( ). Diagnostics Alerts Diagnostics Alerts and their current status are displayed in a band at the top of the Applications Manager window. You can also view the list of alerts under the Alarms Tab - click on Diagnostics Alert button to view a list of diagnostic alerts, their status, time of generation and description. Click on the alert message to view the message history and add comments. All users with ADMIN role will receive mail notifications whenever a problem is raised and cleared/discarded. When a problem is detected, it is shown in Error state [red]. When a corrective action is taken, manually or automatically, the Error state moves [automatically or manually] to a Clear state [Green]. List of attributes supported are categorized and described below : Server Monitoring Attribute Description name This will monitor the CPU utilization of Applications Manager''s server. By default, we will alert the user CPU when the CPU usage exceeds threshold value 90% for the last 15 minutes (polling interval 5 minutes & Usage consecutive polls count 3) with Top 10 process which are consuming more CPU. This will monitor the Memory utilization of the APM running server. By default, we will alert the user Memory when the memory usage exceeds threshold value 90% for the last 15 minutes (polling interval 5 Usage minutes & consecutive polls count 3) with Top 10 process which are consuming more memory. This will monitor the Disk (where APM is installed) utilization of the APM running server. By default, we Disk will alert the user when the disk usage exceeds threshold value 90% for the last 60 minutes (polling Usage interval 60 minutes & consecutive polls count 1). This will monitor the Disk busy time of the physical disk (where APM is installed). By default, we will Disk I/O alert the user when the disk busy time exceeds threshold value 90% for the last 15 minutes (polling Usage interval 5 minutes & consecutive polls count 3). Database Monitoring (currently supported for MSSQL only) Attribute Description name Database This will monitor the DB Connectivity. Status For DB Connectivity, alerts cannot be raised since DB Connection itself is lost. Diagnostic message will be there in Logs ( /logs/diagnostics/selfdiagnostics.txt). This attribute will not be shown in Diagnostic configuration details page. Default setting is that ,If DB is down for 2 minutes. Entry is made in logs.Database This will monitor the DB File size, By default, if file size exceeds 90% of the total size, alert is raised. File Size Database This will monitor the DB Log size. By default, if log size exceeds 90% of the total size, alert is raised. Log Size Note: If total size of DB File & Log is infinite in MSSQL v12 & above, DB installed disk''s total size is considered, and alert is raised if used size of the disk exceeds threshold (By Default 90%). JVM Monitoring Attribute Description name JVM This will monitor the JVM Memory Usage. By default, we will alert the user when the JVM Memory Memory usage exceeds threshold value 90% for the last 15 minutes (polling interval 5 minutes and consecutive Usage polls count 3). JVM This will monitor the JVM Thread Blocked details. By default, we will alert the user when the JVM Thread Thread block exceeds threshold value 50% for the last 15 minutes (polling interval 5 minutes and Blocked consecutive polls count 3). Load-specific performance attributes Attribute Description name This is based on load factor calculation. We will take top 50 server monitors which takes more time for Polling datacollection, and then find the last 1 hour polled values based on the polling interval. If that polled Delay vales are less than 70 % then we alert that there is some delay in the polling interval for that particular monitor. This will happen after 1 hour when the build has started. Polling This will alert when the polling has stopped for the past 1 hour for a particuar monitor. This check will Stops happen after 1 hour when the build has started. Syncing When a particular managed server is not syncing data for the past 30 mins by default we alert in the Delay Admin Server. This parameter will alert as warning when Id Usage crosses the set threshold value for tables (AM_ManagedObject,AM_PARENTCHILDMAPPER,Alert,Event) and as critical when Id Usage crosses Id Usage the allocated range for the managed server. It will also automatically prompt the Admin to disable sync for the managed server since Id is out of range. This check will happen 1 hour after the build starts. diagnosticconfig.properties - This properties file is used to add the diagnostics entry in AM_DIAGNOSTICS_CONF table. Upload Files/Binaries This is an option to upload the required files such as zip, MIB, and scripts (batch and shell) into Applications Manager directory, without much of manual effort. You just have to provide the file by browsing it from your local machine and it gets automatically uploaded to the required directory of Applications Manager. Note: By default, the Upload Files/Binaries page is enabled in the Web Client. As an administrator, if you wish to disable this option, navigate to Settings → Security Settings and enable the checkbox for Disable file upload and save. Follow the steps given below to upload a file: In Settings tab, select Upload Files/Binaries. Click Browse to locate the file to be uploaded in your local machine.  Note: The file to be uploaded must be present in your local machine. Choose the type of Upload such as ZIP/MIB/Script. The purpose of choosing the type is to upload the files in the directories mentioned for each type of upload. Click Upload to upload the files to the desired directory of Applications Manager Home. You can also see the Applications Manager Home directory below the File Upload table.The uploaded files will be available under the specified directory of Applications Manager and can be used for other operations. The following files can be uploaded to the Applications Manager using the Upload Files/Binaries option. MIB file for Sending Trap Action Script file for Executing Program Action MIB file for adding SNMP OID attributes in Custom Monitors The user can alternatively Put the MIBs in mibs folder eg : \working\mibs directory. Scripts for execution in the \working\ or \resources folder and then give the path appropriately with respect to \working folder. Technical Support and Product Information Accessing the Support option under Settings tab -> Tools provides you the following information. Applications Manager Support User Forum Discussions Applications Manager Team Blog Testimonials Product Information Applications Manager Installation Information JVM Memory Information Database Connection Time Database Request Statistics System CPU Utilization System Response Time  Applications Manager Support Request Technical Support Clicking this link takes you to an online support form. Describe the problem, specify your name, e-mail ID, telephone number, and additional information if any and click Submit. Alternatively, you can simply send an e-mail to appmanager-support@manageengine.com.  Support Information File For the Applications Manager Technical Center to resolve problems quickly, you need to send the log files that are being generated. To do so, click Support Information File link. The log files are zipped in a file and placed under /working/support directory. File creation takes some time based on the log file size.  To create Support Information File via command prompt, execute the following command: createSupportFile After generating the support information file, e-mail it to appmanager-support@manageengine.com  If the support information file is large in size and our mail server blocks the same, then you can upload the file in our FTP site.  You will be provided details of the FTP service usage when you connect to our FTP server using "ftp ftp.zohocorp.com" Server Name = ftp.zohocorp.com user account = anonymous password = "your email address" Mail us the location of the file and the folder in which it is placed in case you are using ftp to upload the file. Troubleshooting Tips Clicking this link takes you to the online Troubleshooting page which is a quick stop to get your problems resolved by yourself. This page quotes the common problems faced by users and provides a quick solution.  Toll Free Number You can call the Toll Free Number +1-925-924-9500 and ask for assistance from the Applications Manager Technical Center.  Need Features? If you would like to see more new features in Applications Manager, click the Need Features link. This takes you to an online form where you can specify the feature and its description.  User Forums Clicking this link will take you to the Online user forums where you can discuss about Applications Manager with other users. Five latest discussion topics will be displayed  Applications Manager Team Blog Clicking this link will take you to the Online Applications Manager Team Blog where you can view interesting information about the team, tips on handling Applications Manager and many more. Five latest blogs will be displayed.  Testimonials Clicking this link will take you to the online Testimonial form, wherein you can leave your feedback about Applications Manager.  Product Information This sections provides the following information. Product: Name of the product. Build Number: Build number of the product currently installed in your machine. Service Pack: The service pack that has been currently installed over the product. License Type: Type of license that you are currently using (Free, Evaluation, Paid) and the number of days remaining if it is an evaluation edition. Buy/Evaluate: ''Buy'' option is available if you are using an Evaluation edition. Click ''Buy'' to go to the online store and purchase Applications Manager product license. ''Evaluate'' option is available if you are using a Free Edition. Click ''Evaluate'' to switch from Free edition to Evaluation edition (30 days).  Applications Manager Installation Information This section provides information about the system where you have installed the product. Host Name: Host name where the server is running. OS Type & Version: Type and version of operating system of the host. Working Directory: Your working directory or Applications Manager Home (where the product is installed). Start Time: Time the server was started. Server port: Port in which Applications Manager is running Number of Monitors: Current number of monitors configured Named Users: Current number of users configured Installation Type: Type can be Standalone, Managed Server or Admin Server Load Factor: The load factor follows the format ''x.y'', where ''x'' represents load on Applications Manager Server, while ''y'' represents the load on the Database used by Applications Manager. A value of zero represents least loaded, while a value of nine represents the most loaded. Applications Manager Server Load (x) : Once in every 30 minutes Applications Manager will select 50 random monitors (mostly Servers / SQLs) andfind their corresponding Polling Intervals, their last Data Collection time and the number of times data collection has happened in the last 1 hour for that monitor. Then it will calculate the expected number of Polls that should have occurred in one hour for that monitor. Using these values it will calculate the polling delay % (100 * Number of Times Acutally Polled / Number of Times it should have Polled) for each monitor. Then it will find the average polling delay for these 50 monitors and server load factor value (x) will be calculated based on the information below :  Poll Delay % Load Factor  Less than 97%  0  Greater than 97% and less than 93%  1  Greater than 93% and less than 90%  2  Greater than 90% and less than 86%  4  Greater than 86% and less than 82%  6  Greater than 82% and less than 70%  8  Greater than 70%  9 Applications Manager Database Load (Y) : This value is calculated based on the number of Transactions/Min (commitsPerMin + rollbacksPerMin happening in PgSQL / Transactions/sec for Microsoft SQL) happening in the Applications Manager''s Database based on the information below : Transactions/Min* Load Factor  Less than 600  0  Greater than 600 and less than 1200  1  Greater than 1200 and less than 1800  2  Greater than 1800 and less than 2400  3  Greater than 2400 and less than 3000  4  Greater than 3000 and less than 3600  5  Greater than 3600 and less than 4200  6  Greater than 4200 and less than 4800  7  Greater than 4800 and less than 5400  8  Greater than 5400  9 *For Microsoft SQL servers 2008 and above, Transactions/Min factor will be updated based on the available system memory. JVM Memory Information This section provides information on the JVM Memory usage. Total JVM Heap Size: Total heap size occupied by JVM. Used JVM Heap Size: Heap size used by JVM. Free JVM Heap Size: Heap size that is free without JVM usage. View Thread Dump Information: Thread status in the JVM can be viewed here. View Monitor Errors: Error messages of monitors can be viewed here. You can see, if data collection has happened successfully or not at one go.  Database Connection Time This graph provides information on the Applications Manager database connection time for the last one hour.  Database Request Statistics This graph provides information on the Applications Manager database request statistics for the last one hour.  System CPU UtilizationThis graph provides information on the system''s (where Applications Manager is installed) CPU Utilization pattern for the last one hour.  System Response Time This graph provides information on the system''s (where Applications Manager is installed) Response Time pattern for the last one hour. Manage Certificates To import / manage certificates, go to Settings → Tools → Manage Certificates. Once you enter, details of the "Certificate currently being used by Applications Manager" will be displayed under SSL configuration tab. If you want to import a new SSL certificate, click "Import new SSL certificate" button. You will be prompted to choose whether you want to Generate CSR or Import certificate. In case you choose Generate CSR, the following details need to be entered. Name Description Common Enter the fully qualified domain name that clients/browsers will use to reach your server. name Subject Alternative Name: If you are requesting a Multi-Domain (SAN) Certificate, enter SAN any SANs that you want to include with comma(,) as delimiter. Organization The unit or division of the company / organization managing the certificate. Unit The exact legal name of your organization. If you do not have a legal registered Organization organization name, you can enter your own full name here. City Enter your city name. State Enter your state name. Country Enter your country name. KeyPair size Choose your KeyPair size. (2048 or 4096)After entering the details, click Generate to generate the certificate. If you want to reset the details you''ve entered, click Reset. On clicking the Generate button your CSR and private key files will be downloaded as a ZIP. Extract the file and use the "AppManager.csr" file to get a signed certificate from a CA of your choice. If you already have a valid certificate and key files (or) a keystore or a PFX file with the certificate, choose Import certificate and click choose file.  Select the appropriate certificate and the key file. Verify the details and choose Import.  If the certificate cannot be validated with trusted sources, you will be asked to provide the intermediate certificates and root certificate files. On successful import, you will be prompted to restart Applications Manager. If you are using a Keystore or a PFX file, you will be prompted to input the password for opening the file. On clicking Fetch, you will be provided with a list of Key-entries present in the keystore. Choose a specific alias which is to be used to enable SSL in Applications Manager. You will be shown a preview of the certificate information, verify and click on Import for using the certificate. Finally you will be prompted to restart Applications Manager for the changes to take effect. If you want to import Trust Certificates, click on the "Trust Certificates" tab. Here you have 3 options to import certificates into trusted sources.Fetch certificate from a URL reachable from Applications Manager server: If you choose URL and provide the url of the service you want to trust, you will be prompted to verify and import the fetched certificate. Choose the SSL version from the drop-down menu. By default, it is set as auto. Click Import and it will be added to the trusted sources. Directly upload certificates from a Keystore/Truststore: If you choose this option, then you will have to browse and select the appropriate keystore/truststore/pfx file. Input the password and click Fetch. You will be shown a list of aliases availale in the truststore you can choose the ones you want and click Import. Directly upload certificates as files: Choose the necessary file. On clicking Import, it will be added to Applications Manager''s trust store. Click List certificates tab to view the Keystore Password and List of certificates. Self Help Tools Applications Manager provides you with some of the self help tools to perform required operations within the console and without the need to access an external tool separately. Following are the list of tools that are supported in Applications Manager: WMI Query Tool URL Debug Tool WMI Query Tool WMI Query Tool can be used to execute WMI Queries through Applications Manager UI and to test the output of the existing Applications Manager VB scripts. Using this tool, Users can query the existing monitor or new monitors also. Users can execute their own WMI queries. Users can obtain the output for the available metrics. Appropriate error messages will be shown when something goes wrong. Output results can be exported by copying to clipboard, generating PDF file, or directly sending it to Applications Manager support. Note: WMI Query tool is supported for the following Microsoft-based monitor types: Active Directory, Exchange Server, MS Office SharePoint, Microsoft Dynamics CRM/365 (On-Premise), IIS Server, Microsoft Dynamics AX,Microsoft MQ (MSMQ), Microsoft Skype for Business, Microsoft BizTalk, Network Policy Server (Radius Server), and Windows. Configuring WMI Query tool Follow the steps given below to configure the WMI Query tool: Under Settings tab, click on Self Help Tools under Tools section. Choose the host for which the WMI queries/scripts need to be executed. In case of new host, follow the below steps: Enter the hostname/IP address of the Windows host for which the WMI queries/scripts need to be executed. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential list option. Enable the Kerberos Authentication checkbox if you want to query the existing monitor or remote server through Kerberos authentication. Select the Type for which the results have to be checked. They are of 2 types: Monitor Type and Namespace. Monitor Type: Allows you to obtain the output for the metrics available in Applications Manager based on the monitor type selected from the dropdown. After selecting the monitor type, select the metrics for which the output has to be checked from the dropdown. Namespace: Allows you to obtain the output for the metrics of your choice based on the namespace and the WMI query entered. It is an alternative to the WMI Tester tool used in Windows, obtained by executing the wbemtest command. Specify the Timeout value, in seconds. Default value is 300 seconds. Click Execute. On clicking the Execute button, the results for the required query/script will be displayed along with its execution time (in milliseconds) under WMI Tool Response table. You can choose to export the results by copying to clipboard, generating PDF file, or directly sending it to Applications Manager support. URL Debug Tool Overview Applications Manager''s URL Debug Tool helps in debugging the URLs and monitors, and displays the performance of each and every components in the webpage. It executes the URL and collects the response, which is then displayed on a result page containing the results of the APIs or URL which contains the required performance metrics. Supported monitors Following are the list of monitors supported in the URL Debug Tool: S.No. Monitor Supported APIs Collected metrics types Admin cores Apache Solr availability and details of the cores. 1 Apache Solr Admin thread information Thread details and count of threads in different states. Admin properties information Configuration details of Solr. API Status Node details, Memory utilization, master overview. Apache 2 Spark master Worker details, Application details, Memory details, Monitor metrics RDD Details, Configuration details. API Status Memory utilization, Worker overview. Apache 3 Spark worker Executors, Memory details, RDD Details, Monitor metrics Configuration details. 4 ElasticSearch Cluster health details, shard details, Memory details, Cluster name cluster Core details. Cluster health Cluster health details, Node counts, shard details. Cluster status, count of indices, Cluster health details, shard details, Memory details, count of docs in the indices Core details. All the node''s host, IP addesss, http and attribute HTTP Nodes details.CAT Master Master node''s ID, host, bound IP address, name. CAT Nodes Cluster node details. Stats Stats related to the shards. Cluster health details, shard details, Memory details, Count of nodes Core details. Nodes Complete node details of a cluster. Details of Queue, Session rate, Sessions, bytes, 5 HAProxy Custom API denied, Errors, Warnings, Server. 6 IIS Server --- Webpage content 7 Nginx Nginx status Active connections, Server request handling details. Connection Connection stats. SSL SSL details (Handshake details). Requests Request details (Total requests, current requests). HTTP Server zone details (Requests, responses by HTTP Zones response codes). 8 Nginx Plus HTTP Upstream details (Demo-backend, trac- HTTP Upstreams backend, hg-backend,lxr-backend). Caches Cache details. TCP/UDP Zones details (postgresql loadbalancer, dns TCP/UDP Zones loadbalancer). TCP/UDP Upstream details (postgresql backends, TCP/UDP Upstreams dns_udp_backends, unused_tcp_backends). REST API 9 Any URL Response of the API. Monitor Webpage 10 Any URL Webpage content analyzer Website 11 Content Any URL Webpage content Monitor 12 URL Monitor Any URL Webpage content Configuring URL Debug tool Follow the steps given below to execute URLs in the URL debug tool: Under Settings tab, click on Self Help Tools under Tools section. Click on URL Debug link. The URL Debug tool page will be displayed. Choose the Monitor Name from the dropdown. In case you want to try new monitors/URLs, select New Monitor from the dropdown. Choose the Monitor Type for which the debug should be performed. After selecting the Monitor Type, specify the required details that are to be entered with respect to the monitor type chosen. If the selected monitor type is HTTP(s) URLs, then HTTP(s) URL monitor form will be displayed along with the selected monitors data (including client certificate file). If the selected monitor is URL-based like Webpage Analyzer, then a form with the corresponding monitor''s URL address will be displayed. If the selected monitor is API-based like ElasticSearch or Apache Solr, the corresponding form will be displayed for the selected monitor type along with the monitor''s hostname, port and the list of APIs used for data collection (if any). If the particular monitor type allows customizable APIs, then an option to add custom APIs will be given. Note: A maximum number of 15 custom APIs can only be executed in the URL Debug tool. Based on the monitor selected, further options will be displayed. After entering all the required details, click Execute. On clicking Execute, data collection will occur based on the specified data and the result page will be displayed. This page comprises of details such as,Metric name / URL address Connectivity status Response code Response time (in milliseconds) Webpage content and its size (in bytes) Detailed response time split up You can also view and copy the webpage contents (in HTML form) by clicking over the respective icons. Additionally, you can download the complete debug report in the form of PDF using the Export option. Also, you can make use of the Send to support option to send the report to the support via mail, which comprises of the mail subject, request details and the PDF Report of the collected response. Backup Schedule This section explains the database backup scheduling that can be performed in Applications Manager. Here you can perform instant database backup from Applications Manager and also schedule for database backup. The backup schedule settings comprises of 3 major configurations: Backup Settings: Used for scheduling a backup of the database in Applications Manager. By default, database backup will be performed every month. Cleanup Settings: Used to configure cleanup schedule, based on which old backup files and their logs will be removed. Backup Execution: Used to perform backup execution instantly based on the type of data. Scheduling backup and cleanup To schedule database backup and cleanup, follow the steps given below: Schedule the backup by enabling/disabling under Scheduled Backup option. Choose the backup type. There are 3 types of backup: Full Database: Takes complete database and CONFIG files as backup. Config Data: All monitors configuration data alone taken as backup Config & Reports Data: All monitors configuration data and report data taken as backup Configure the Time Settings for which the backup must be scheduled. You can choose from the following options: Weekly: Choose a day in week to run backup schedule. Monthly: Choose a date in month to run backup schedule. Configure the cleanup type based on which cleanup should be performed, under Cleanup based on option. You can choose from any of the 2 options: Days: Cleanup based on number of days backup file is older. Number of files: Cleanup based on maximum number of backup files to be kept. Click Save to schedule the backup and cleanup operations. Also, you can view the list of backups that have already been scheduled by clicking the Last Backup icon on top right corner. Backup Execution You can also choose to perform instant database backup by configuring the Backup Execution settings. To do so, follow the steps given below. Choose the Backup Execution Type with which you want to execute the backup. You can choose from the following options: Full Database: Takes complete database and CONFIG files as backup. Config Data: All monitors configuration data alone taken as backup Config & Reports Data: All monitors configuration data and report data taken as backup Reports Data: Report data of all monitorsClick Execute Now to perform the backup operation instantly. Note: Backup Execution is applicable only for PostgreSQL databases. Database backup and cleanup will be performed only once in every month by default. Full database backup alone can be performed for MySQL and MS SQL databases. For MySQL databases, only backup and cleanup scheduling can be performed. For MS SQL databases, backup scheduling alone can be performed. Data Backup and Restore You can take a backup of Applications Manager data and restore them back by executing the scripts BackupPGSQLDB.bat/.sh and RestorePGSQLDB.bat/.sh respectively available under /bin directory. Backup To take a back up of Applications Manager data, execute the following commands in the command prompt: BackupPGSQLDB.bat/.sh After executing the above command, the output (backup data) would be added in a ZIP file under \working\backup\ directory in the following format: ...\APM_backupzip_ _ _ \APM_backupzip_ _ _ _ .zip For example, the ZIP file of the backup would be added under C:\Program Files\ManageEngine\AppManager14\working\backup\APM_backupzip_all_dumpDB_pgsql_NORM_14550_Mar_10_ 2020_17_16_21\APM_backupzip_all_dumpDB_pgsql_NORM_14550_Mar_10_2020_17_16_21.zip file. Restore To restore the backed up data, execute the following command in command prompt: RestorePGSQLDB.bat/.sh " " Example: RestorePGSQLDB.bat/.sh "C:\Program Files\ManageEngine\AppManager14\working\backup\APM_backupzip_all_dumpDB_pgsql_NORM_1455 0_Mar_10_2020_17_16_21\APM_backupzip_all_dumpDB_pgsql_NORM_14550_Mar_10_2020_17_16_21.zip" Note: Database backup can be taken both in running or shutdown states of Applications Manager. Filtering data for backup You can also choose to filter out specific data while taking backup of Applications Manager using the command given below: BackupPGSQLDB.bat By using specific runtime commands, you can choose to take backup for the required data and filter out unnecessary ones. Below are the list of data and their corresponding runtime commands: Backup Data Runtime Command Complete database alone --database Only Configuration files --confiles Only Report tables --reportsBackup Data Runtime Command Only Configuration tables --configtables Exclude Report tables --exclude-reports Exclude Poll Data tables --exclude-raw Example: To take backup of report data, command should be executed as follows: BackupPGSQLDB.bat --reports Note: In Enterprise Edition, backup of report or configuration data (like --reports, --configtables, --exclude- reports, --exclude-raw) taken from one server should not be restored in another server. Configuring a backup task You can configure a backup task with Task Scheduler as follows: Program/Scripts: \bin\BackupPGSQLDB.bat Start In: \bin\ Configure the triggers and other information in the Task Scheduler. Please make sure you choose the option "Run whether the User is Logged On or Not" so that the Task runs irrespective of the fact that the user is logged on or not. In the Actions, please configure it as follows Program/Scripts: \bin\BackupPGSQLDB.bat Start In: \bin\ Then save the task and test it to know if it works. For Microsoft SQL Server backend: For Database Backup: Connect to the SQL Management Studio tool & backup the complete AMDB database. Click here to know how to backup SQL database. For Database Restore: Connect to SQL Management Studio tool & restore the complete AMDB database backup. Click here to know how to restore the SQL database backup. Applications Manager should not be running during database restore. Refer the below link for more detailed information about SQL database backup & restore steps: https://docs.microsoft.com/en-us/sql/relational- databases/backup-restore/back-up-and-restore-of-sql-server-databases Note: Users should not use the SQL Server Import and Export Wizard to perform backup or restore of Applications Manager database. Bulk Configuration of MonitorsSelecting this option, would enable you to perform bulk administrative operations on Monitors. Clicking on this link, will take you to the Monitors Bulk Configuration View - where all monitors are listed. Availability tab, gives the Availability history for the past 24 hours or 30 days. Performance tab gives the Health Status and events for the past 24 hours or 30 days. List view tab lists all the servers monitored by Applications Manager along with their overall availability and health status You can also perform bulk admin configurations. Click on the individual monitors listed to view detailed performance metrics. You can perform the following Monitor Admin Operations from the List View tab: Assign Custom Fields Delete Edit Display Names Manage and Unmanage Monitors Unmanage & Reset Status Update Username/Password Update Polling Interval Copy and Paste Monitor Update Hostname/IP Edit Display Names This option enables you to bulk edit the Display Names of the Monitors. Manage/Unmanage Monitors This option enables you to choose the monitors that you want to monitor or not. Under Monitors tab, select ''Bulk Config'' view, here all the monitors discovered are listed. Select the monitors for which data collection needs to be done and then click on Manage link, likewise select the monitors for which you do not want data collection to happen and then click on Unmanage link. For license information, the count of the ''number of monitors'' would be based on the number of Managed Monitors. Update Username/Password This option enables you to bulk update usernames and passwords across monitor types. For eg., if you have five tomcat servers running, you can select all the five tomcat servers from the list. Click on Update Username/Password. Your selection would be listed and you can enter the username and password that is common across all the five tomcat servers. Update Polling Interval This option enables you to bulk update poll intervals across monitor types. For eg., if you have five apache servers running, you can select all the five apache servers from the list. Click on Update Polling Interval link. Your selection would be listed and you can enter the desired poll interval. Copy and Paste Monitors This option enables you to copy and paste the configuration of one monitor to create new monitors of the same type. For eg., if you want to monitor the apaches running in 10 different servers, then you can configure the monitoring parameters of one apache in Host1 and copy those configurations to the other apaches in Host2 , Host3 ..to..Host10 On clicking copy and paste icon, you need to enter the host names of the servers to which the configurations have to be pasted (the host names can be given comma separated). Enter the SubNet mask too. Note: If you want to copy and paste the configurations of server monitor, then you can choose to copy the configuration of the services running inside the server or only the server configuration. Currently we do not support the copy and paste function for the following monitors: Custom Monitors Java RuntimePHP HTTP URLs HTTP URL Sequence Web Services Web Server JMX Application Ping Monitor Glassfish Silverstream IBM WebSphere MQ Office Sharepoint Update Hostname/IP You can update the hostname/IP address of a host. Using the Update Hostname/IP option, you can also perform the following operations: Update Hostname and IP: Replaces the existing hostname and IP address with the given resource information. Refresh and Update Hostname: Resolves the existing IP address to fetch and update the latest hostname. Refresh and Update IP: Resolves the existing hostname to fetch and update the latest IP address. Update all the resources of this host: Enabling this option allows you to update the latest hostname/IP address for all the resources running in this host server. A shortcut to edit the host name or IP Address: Log in to Applications Manager Select the resources for which the Hostname/IP address needs to be updated. After selecting the required resources, choose ''Update Hostname/IP'' from the ''Action'' drop down menu. In the pop-up window, select any one of the required options: ''Update Hostname and IP'', ''Refresh and Update Hostname'' or ''Refresh and Update IP''. Enable the ''Update all the resources of this host'' checkbox, if you wish to update the latest hostname/IP address for all the resources running in the given host server. Click Update. Check if the Hostname/IP Address has been changed. Note: This option is supported only for the following monitors: MSSQL, MySQL, DB2, SYBASE, APACHE, .NET, ORACLE AS, JDK 1.5, SAP, WebLogic Server, SNMP, JMX, WINDOWS, LINUX, Solaris, AIX, AS400, NOVELL, MAC, and FREEBSD. Production Environment This document covers configuration details that you need to take care of when moving Applications Manager into Production: User Accounts (OS User / Applications Manager Web Client User) Note OS User will be referred to as OS User. A user login account to the Applications Manager Web Client will be referred to as Web Client User. Refer User Administration document for more information on users. Make sure you change the password for the default "admin" Web Client User within Applications Manager. Have a dedicated OS User (System) account for installing Applications Manager. This OS user account needs full permissions on all folders and sub-folders in the installation root of Applications Manager only. Also make sure this OS User account is fully secure. It is NOT necessary to install Applications Manager in a root (in Linux) or administrator (windows) OS User account. But make sure the whole installation is done using the same OS user account. Do not install using root and try to run using an OS user account. That will fail. If you want to give full "Read-Only" priviledges to certain Web Client Users in your organisation, then make sure you create a client login with "USER" role. If you want to give restricted "Read-Only" privileges to certain Web Client Users in your organisation, then make sure you create a client login with "Operator" role. "Operator" can view only servers that they own.Other General Guidelines Refer the Security/Firewall Requirements document to understand what changes are required in the firewall. You can install Applications Manager as a Windows Service or configure a cron job on Linux to start on server start up. If you are planning to use the Enterprise Edition, fully understand the EE architecture. By default, uploading binaries, MIBs, scripts are allowed in Applications Manager. This may be required in the intial stages while using Applications Manager for uploading MIBs, action scripts etc. However while going in to production, it is strongly recommended to disable this Are you getting false alarms for server availabilty? This could be because, your production servers are taking too long to respond. You can set higher timeouts. To change the default HTTP port used by Applications Manager, refer the Server Settings document . You can refer to this document on other settings that you can modify. For eg., whenever Applications Manager starts, if you do not want the browser to open automatically, you need to modify the entry Backup the Applications Manager configuration and data. From a security point of view, the following are done : All passwords are encrypted The encryption keys are uniquely generated for each customer environment. Note: Kindly inform appmanager-support@manageengine.com, if you feel that some more information can be added. Integrating with ServiceDesk Plus (SDP) Cloud Overview About the integration Logging trouble tickets Integrating ServiceDesk Plus Cloud with Applications Manager Ticket Settings Reopen Settings Update Settings Accessing from Applications Manager Overview About the integration ManageEngine ServiceDesk Plus Cloud (formerly ServiceDesk Plus On-Demand) is an online help desk software built on the ITIL framework with integrated asset management capability. Logging trouble tickets Applications Manager has the ability to automatically log trouble tickets for a specific alarms and to notify the concerned technician when a particular process exceeds the set threshold point. Along with the provision to e- mail, SMS, and other notifications, alarms can also be tracked by automatically logging trouble tickets to ServiceDesk Plus. Applications Manager takes care of the two way synching of Alerts & Tickets status from SDP. For example, you can automatically log a ticket when an alarm is raised, reopen the ticket whenever an alarm is reoccured or close the ticket if the alarm is cleared. Integrating ServiceDesk Plus Cloud with Applications Manager Setting up Applications Manager Ticket Settings Setting up Applications ManagerGo to Settings → Add-on Settings → Helpdesk and click on Add. Now, choose ServiceDesk Plus Cloud from the SDP Product option. You can add an ServiceDesk Plus Cloud instance using OAuth:  If you choose to add an SDP Cloud instance via OAuth, enter the URL and select the OAuth provider from the drop-down menu.   If you want to add a new OAuth provider, click on Add OAuth Provider. Check Advanced Settings and Enable Ticketing option to configure Ticket settings. Ticket Settings You can configure the following settings: Reopen Settings Update Settings Accessing from Applications Manager Reopen Settings Set Applications Manager to perform one of the following actions when an alarm is raised again for a closed ticket: To reopen the ticket whenever an alarm is reoccured. To reopen the ticket within a certain number of days from the closed time. If the ticket is not reopened, a new ticket is automatically created. (To reopen the ticket whenever an alarm is reoccured within a certain number of days else open a new ticket.) To create a new ticket or to open a new ticket whenever an alarm has re-occured. Set Applications Manager to perform one of the following actions when an alarm is raised again for a resolved ticket: To reopen the ticket whenever an alarm is re-occured. To reopen the ticket within a certain number of days from the closed time. If the ticket is not reopened, a new ticket is automatically created. (To reopen the ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To create a new ticket or to open a new ticket whenever an alarm has re-occured. Set Applications Manager to perform one of the following actions when an alarm is raised for an entity that was previously clear and if the existing ticket in HelpDesk is not closed/resolved: To update the existing ticket whenever an alarm is re-occured. To update the existing ticket within a certain number of days from the clear alert. If the ticket is not updated, a new ticket is automatically created. (To update the existing ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To update the notes associated with that ticket. To create a new ticket or to open a new ticket whenever an alarm has re-occured. Enable on-demand ticket generation using : Raise a ticket action, so that you can raise a ticket on demand using a ticket action from alarms page. The new on-demand tickets are mapped to the respective configuration items. Request Form, so that you can raise a ticket on demand using the request form from alarms page. The new on-demand tickets are mapped to the respective configuration items. Update Settings Set Applications Manager to perform one of the following actions when the severity of an alarm is changed / RCA of the alarm is updated for an already created ticket: To update the ticket. To update the notes associated with that ticket. Set Applications Manager to perform one of the following actions when an alarm is cleared for a ticket: To close the ticket. To update the notes associated with that ticket.Set Applications Manager to perform one of the following actions when a monitor or a ticket action or a metric is deleted for a ticket: To close the ticket. To update the notes associated with that ticket. Update the ticket only if there is a status change in the alarm. If enabled, action is triggered only when there is a status change in alarm. Add notes for the ticket whenever an annotation is made for the alarm. Accessing from Applications Manager Access ticket details from Application Manager. User can access the ticket details from the ticket details link in the alert details page. Launch Read-only ticket. When selected, the ticket details launched from Applications Manager would be read only. Over-write the request template with the fields selected in the action profile. This option is disabled by default. In Log a ticket action, on selecting the Incident template, the other fields will be hidden. The default values of the Incident template chosen would be used to log the trouble ticket in ServiceDesk Plus. If enabled, the other fields will become visible, thereby, allowing the user to modify the default fields of the Incident template. Integrating with ServiceDesk Plus (SDP) MSP Overview About the integration Logging trouble tickets Version Compatibility Configuring ServiceDesk Plus in Applications Manager Prerequisites Steps to configure Ticket Settings Reopen Settings Update Settings Accessing from Applications Manager Overview About the integration ServiceDesk Plus - MSP help-desk software is specifically built for managed service providers. ServiceDesk Plus - MSP helps service providers. With the integrated Applications Manager and ServiceDesk Plus management solution, service providers like can get end-to-end visibility of your client''s IT infrastructure. Logging trouble tickets Applications Manager has the ability to automatically log trouble tickets for a specific alarms and to notify the concerned technician when a particular process exceeds the set threshold point. Along with the provision to e- mail, SMS, and other notifications, alarms can also be tracked by automatically logging trouble tickets to ServiceDesk Plus. Applications Manager takes care of the two way synching of Alerts & Tickets status from SDP. For example, you can automatically log a ticket when an alarm is raised, reopen the ticket whenever an alarm reoccurs or close the ticket if the alarm is cleared. Version Compatibility Below is the version compatibility of Applications Manager with ServiceDesk Plus MSP (SDP MSP):Applications Manager Version SDP MSP Version 15510 and above 10600 and above 15500 and below Below 10600 Configuring ServiceDesk Plus in Applications Manager This section describes the method in which ServiceDesk Plus Settings are to be configured in Applications Manager: Prerequisites ServiceDesk Plus must be reachable from Applications Manager The technician used to integrate ServiceDesk Plus MSP with Applications Manager must have SDAdmin privilege. This is to allow access to the form data from ServiceDesk Plus MSP so that it can be loaded in the Create a new ticket action page in Applications Manager. It is mandatory to have the Sample Account and Sample Site for successful integration. In case these are deleted, a sample ticket cannot be executed during Test and Save configuration in Applications Manager Steps to configure Under Settings tab, click on Add-On under Product Settings. An Add-on Settings table is displayed. Click on Add action for Service Desk. This takes you to the ManageEngine ServiceDesk Plus Server Details page. Configuring ServiceDesk Plus Settings in Applications Manager can be done in two ways: Using REST APIs or Using Credentials. Using REST APIs: This feature supports Applications Manager with ServiceDesk Plus integration using SDP REST API Keys and automatic closing of tickets. Follow the steps below to configure ServiceDesk Plus Settings in Applications Manager: Under the Use Rest API tab, enter the ServiceDesk Plus Server Details, specify the product that you wish to add - ServiceDesk Plus or ServiceDesk Plus - MSP. Name of the server and port number where ServiceDesk Plus is running Enter the REST API key. (While a ticket action is created, and a technician is assigned from the Log a Ticket form, the technician must have an SDAdmin privilege in SDP. Make sure that the technician whose key you are using has SDAdmin privilege in SDP.) Select one of the given protocols: http or https(SSL). Check the Enable Mail Notification for Connectivity Failure checkbox if you wish to trigger mail notifications in case of connectivity failures. After enabling this option, enter the following details: Configure the email to which the notification has to be sent. You can configure either by choosing Admin email (Mail address configured for the admin user or the mail address in SMTP configuration) or by selecting email actions to be triggered for the selected email from the dropdown. Enable the Append Custom Message checkbox if you want to append customized text messages along with the mail notifcation. Enable the Repeat mails until successful connection checkbox to repeat mail notifications until connection is established successfully. After enabling, specify the Repeat Interval (in minutes) after which mail notification has to be repeated. By checking the Advanced Settings checkbox, you have the option to enable ticketing where you configure the necessary Ticket Settings. Test if the connection is working and save the settings. Using Credentials (deprecated if using SDP version above 9101): Under Admin tab, click on ServiceDesk Settings Enter the ServiceDesk Plus Server Details Enter the Name of the server where ServiceDesk Plus is running. Enter the Port Number of that server. Enter the Authentication Details of the ServiceDesk Plus Server - Login and Password.Enter the Email Address configured in ServiceDesk Plus. All the trouble tickets generated would be sent to that Email ID. Enter the Email Address from which the trouble tickets should be sent. Test if the connection is working and save the settings. Ticket Settings You can configure the following settings: Reopen Settings Update Settings Accessing from Applications Manager Reopen Settings Set Applications Manager to perform one of the following actions when an alarm is raised again for a closed ticket: To reopen the ticket whenever an alarm is reoccured. To reopen the ticket within a certain number of days from the closed time. If the ticket is not reopened, a new ticket is automatically created. (To reopen the ticket whenever an alarm is reoccured within a certain number of days else open a new ticket.) To create a new ticket or to open a new ticket whenever an alarm has re-occured. Set Applications Manager to perform one of the following actions when an alarm is raised again for a resolved ticket: To reopen the ticket whenever an alarm is re-occured. To reopen the ticket within a certain number of days from the closed time. If the ticket is not reopened, a new ticket is automatically created. (To reopen the ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To create a new ticket or to open a new ticket whenever an alarm has re-occured. Set Applications Manager to perform one of the following actions when an alarm is raised for an entity that was previously clear and if the existing ticket in HelpDesk is not closed/resolved: To update the existing ticket whenever an alarm is re-occured. To update the existing ticket within a certain number of days from the clear alert. If the ticket is not updated, a new ticket is automatically created. (To update the existing ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To update the notes associated with that ticket. To create a new ticket or to open a new ticket whenever an alarm has re-occured. Enable on-demand ticket generation using : Raise a ticket action, so that you can raise a ticket on demand using a ticket action from alarms page. The new on-demand tickets are mapped to the respective configuration items. Request Form, so that you can raise a ticket on demand using the request form from alarms page. The new on-demand tickets are mapped to the respective configuration items. Update Settings Set Applications Manager to perform one of the following actions when the severity of an alarm is changed / RCA of the alarm is updated for an already created ticket: To update the ticket. To update the notes associated with that ticket. Set Applications Manager to perform one of the following actions when an alarm is cleared for a ticket: To close the ticket. To update the notes associated with that ticket. Set Applications Manager to perform one of the following actions when a monitor or a ticket action or a metric is deleted for a ticket:To close the ticket. To update the notes associated with that ticket. Update the ticket only if there is a status change in the alarm. If enabled, action is triggered only when there is a status change in alarm. Add notes for the ticket whenever an annotation is made for the alarm. Accessing from Applications Manager Access ticket details from Application Manager. User can access the ticket details from the ticket details link in the alert details page. Launch Read-only ticket. When selected, the ticket details launched from Applications Manager would be read only. Over-write the request template with the fields selected in the action profile. This option is disabled by default. In Log a ticket action, on selecting the Incident template, the other fields will be hidden. The default values of the Incident template chosen would be used to log the trouble ticket in ServiceDesk Plus. If enabled, the other fields will become visible, thereby, allowing the user to modify the default fields of the Incident template. Note: CI Sync is not supported in ServiceDesk Plus - MSP, so you will not be able to use the CMDB modules. It is mandatory to have sample account and site if you are using SDP-MSP as add-on product. In case, if the sample account and site are deleted from SDP-MSP, tickets action will not get executed during Add on Configuration.   Integrating with ServiceDesk Plus (SDP) On- premise Overview About the integration Logging trouble tickets Configuration Management Database Version Compatibility Configuring ServiceDesk Plus in Applications Manager Prerequisites Steps to configure Ticket Settings Reopen Settings Update Settings Accessing from Applications Manager Configuration Item Details and Relationship Mapping Frequently Asked Questions (FAQs) Overview About the integration ServiceDesk Plus is a web-based Help Desk and Asset Management software, offered by ManageEngine. With ServiceDesk Plus installed in your network, you can automatically log trouble tickets for specific alarms andmaintain a Configuration Management Database (CMDB) that allows you to plot out your IT infrastructure from Applications Manager. Logging trouble tickets Applications Manager has the ability to automatically log trouble tickets for a specific alarms and to notify the concerned technician when a particular process exceeds the set threshold point. Along with the provision to e- mail, SMS, and other notifications, alarms can also be tracked by automatically logging trouble tickets to ServiceDesk Plus. Applications Manager takes care of the two way synching of Alerts & Tickets status from SDP. For example, you can automatically log a ticket when an alarm is raised, reopen the ticket whenever an alarm reoccurs or close the ticket if the alarm is cleared. Configuration Management Database (CMDB) From a CMDB perspective, all the components monitored in Applications Manager are referred to as Configuration Items (CI). With the ServiceDesk Plus integration in Applications Manager, you can: Identify CIs in your IT environment and Enable CI Sync to create CIs in Servicedesk Plus Map the relationship between the CIs and Use the relationships to predict the impact of CIs before performing any change. Track of all the pending requests, problems and changes raised for the CI Type. You can track of all the pending requests, problems and change raised for the CI Type. Once a problem ticket is logged you can also assign a technician for the ticket. Any impact cause by the malfunctioning of these CIs and other CI details can be identified with Relationship Mapping, and specific measures can be adapted to minimize the effect. Version Compatibility Below is the version compatibility of Applications Manager with ServiceDesk Plus (SDP): Applications Manager Version SDP Version 15050 and above 11138 and above  15000 to 15040, or 11117 to 11137 Hotfix 15001 and above 14390 to 14911 11000 to 11116  14380 and below 9102 to 10515 Hotfix 14783 and above, or 11117 to 11136 Hotfix 14843 and above Note: The above-mentioned version compatibility is applicable for APM Plugin installations also. To find out the version compatibility of APM Plugin with OpManager, refer here. Configuring ServiceDesk Plus in Applications Manager This section describes the method in which ServiceDesk Plus Settings are to be configured in Applications Manager: Prerequisites Servicedesk Plus must be reachable from Applications Manager The technician used to integrate Servicedesk Plus with Applications Manager must have SDAdmin privilege. This is to allow access to the form data from ServiceDesk Plus so that it can be loaded in the Create a new ticket action page in Applications Manager. The Default Request template should not have any mandatory fields in ServiceDesk Plus because a sample ticket cannot be executed during Test and Save configuration in Applications Manager. Steps to configure Under Settings tab, click on Add-On Settings under Product Settings. An Add-on Settings table is displayed.Click on Add action for Service Desk. This takes you to the ManageEngine ServiceDesk Plus Server Details page. Configuring ServiceDesk Plus Settings in Applications Manager can be done in two ways: Using REST APIs or Using Credentials. Using REST APIs: This feature supports Applications Manager with ServiceDesk Plus integration using SDP REST API Keys and automatic closing of tickets. Follow the steps below to configure ServiceDesk Plus Settings in Applications Manager: Under the Use Rest API tab, enter the ServiceDesk Plus Server Details, specify the product that you wish to add - ServiceDesk Plus or ServiceDesk Plus - MSP. Name of the server and port number where ServiceDesk Plus is running Enter the REST API key. ( While a ticket action is created, and a technician is assigned from the Log a Ticket form, the technician must have an SDAdmin privilege in SDP. Make sure that the technician whose key you are using has SDAdmin privilege in SDP.) Select one of the given protocols: http or https(SSL). Check the Enable Mail Notification for Connectivity Failure checkbox if you wish to trigger mail notifications in case of connectivity failures. After enabling this option, enter the following details: Configure the email to which the notification has to be sent. You can configure either by choosing Admin email (Mail address configured for the admin user or the mail address in SMTP configuration) or by selecting email actions to be triggered for the selected email from the dropdown. Enable the Append Custom Message checkbox if you want to append customized text messages along with the mail notifcation. Enable the Repeat mails until successful connection checkbox to repeat mail notifications until connection is established successfully. After enabling, specify the Repeat Interval (in minutes) after which mail notification has to be repeated. By checking the Advanced Settings checkbox you have the option to configure Enable Ticketing - Ticket Settings Enable Configuration Item (CI) sync - Configuration Item Settings (only if you have selected ServiceDesk Plus and not ServiceDesk Plus - MSP) Test if the connection is working and save the settings. Using Credentials (deprecated in SDP 9101): Under Admin Tab, click on ServiceDesk Settings Enter the ServiceDesk Plus Server Details Enter the Name of the server where ServiceDesk Plus is running. Enter the Port Number of that server. Enter the Authentication Details of the ServiceDesk Plus Server - Login and Password. Enter the Email Address configured in ServiceDesk Plus. All the trouble tickets generated would be sent to that Email ID. Enter the Email Address from which the trouble tickets should be sent. Test if the connection is working and save the settings. Ticket Settings You can configure the following settings: Reopen Settings Update Settings Accessing from Applications Manager Reopen Settings Set Applications Manager to perform one of the following actions when an alarm is raised again for a closed ticket: To reopen the ticket whenever an alarm is reoccured.To reopen the ticket within a certain number of days from the closed time. If the ticket is not reopened, a new ticket is automatically created. (To reopen the ticket whenever an alarm is reoccured within a certain number of days else open a new ticket.) To create a new ticket or to open a new ticket whenever an alarm has re-occured. Set Applications Manager to perform one of the following actions when an alarm is raised again for a resolved ticket: To reopen the ticket whenever an alarm is re-occured. To reopen the ticket within a certain number of days from the closed time. If the ticket is not reopened, a new ticket is automatically created. (To reopen the ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To create a new ticket or to open a new ticket whenever an alarm has re-occured. Set Applications Manager to perform one of the following actions when an alarm is raised for an entity that was previously clear and if the existing ticket in HelpDesk is not closed/resolved: To update the existing ticket whenever an alarm is re-occured. To update the existing ticket within a certain number of days from the clear alert. If the ticket is not updated, a new ticket is automatically created. (To update the existing ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To update the notes associated with that ticket. To create a new ticket or to open a new ticket whenever an alarm has re-occured. Enable on-demand ticket generation using : Raise a ticket action, so that you can raise a ticket on demand using a ticket action from alarms page. The new on-demand tickets are mapped to the respective configuration items. Request Form, so that you can raise a ticket on demand using the request form from alarms page. The new on-demand tickets are mapped to the respective configuration items. Update Settings Set Applications Manager to perform one of the following actions when the severity of an alarm is changed / RCA of the alarm is updated for an already created ticket: To update the ticket. To update the notes associated with that ticket. Set Applications Manager to perform one of the following actions when an alarm is cleared for a ticket: To close the ticket. To update the notes associated with that ticket. Set Applications Manager to perform one of the following actions when a monitor or a ticket action or a metric is deleted for a ticket: To close the ticket. To update the notes associated with that ticket. Update the ticket only if there is a status change in the alarm. If enabled, action is triggered only when there is a status change in alarm. Add notes for the ticket whenever an annotation is made for the alarm. Accessing from Applications Manager Access ticket details from Application Manager. User can access the ticket details from the ticket details link in the alert details page. Launch Read-only ticket. When selected, the ticket details launched from Applications Manager would be read only. Over-write the request template with the fields selected in the action profile. This option is disabled by default. In Log a ticket action, on selecting the Incident template, the other fields will be hidden. The default values of the Incident template chosen would be used to log the trouble ticket in ServiceDesk Plus. If enabled, the other fields will become visible, thereby, allowing the user to modify the default fields of the Incident template.Configuration Item Details and Relationship Mapping Once the ServiceDesk Plus Settings are configured, Applications Manager identifies all the monitors (unless you have configured to exclude a monitor(s) or a selected monitor type(s)) and adds them as Configuration Items in ServiceDesk Plus CMDB. You can change the following Configuration Item Settings by clicking on the Advanced Settings checkbox and then enabling the Enable Configuration Item (CI) sync option. Delete the CI if the corresponding monitor is deleted Exclude the monitor(s) of the selected monitor type(s). Users can select the monitors types that they wish to exclude from the list provided to be added as CI(s). Select the monitors that you wish to exclude from the first list and move it to the second list. Configure custom fields of the monitor as attributes of a configuration item. The new custom field need not get added in Service Desk Plus. Users can access configuration item and relationship details from Application Manager in the monitor snapshot page. To view the details of a Configuration Item and view Relationship Maps: Go to the Monitors tab. From the Select View list, choose the Bulk Configuration View. Open the List View which will give you a list of all the monitors. In the list, click on the   icon near a monitor to view the CI Details. Click on the   icon to view the Relationship Map. Frequently Asked Questions (FAQs) How can I map an asset to a ticket? An asset gets added from Applications Manager when a Server monitor is added as a CI in ServiceDesk Plus during the CI Sync. Any trouble ticket associated to the Server and its child monitors would get tagged with the corresponding asset provided it is successfully synced. Integrating with ServiceNow Overview ServiceNow is a web-based Help Desk and Asset Management software. With ServiceNow, you can automatically log trouble tickets for specific alarms and manage incidents from Applications Manager. Logging trouble tickets Applications Manager has the ability to automatically log trouble tickets for a specific alarms and to notify the concerned technician when a particular process exceeds the set threshold point. Along with the provision to e- mail, SMS, and other notifications, alarms can also be tracked by automatically logging trouble tickets to a help desk software. Applications Manager takes care of the two way synching of Alerts & Tickets status from ServiceNow. For example, you can automatically log a ticket when an alarm is raised, reopen the ticket whenever an alarm is re-occurred or close the ticket if the alarm is cleared. Configuring ServiceNow in Applications Manager Under Settings tab, click on Product Settings → Add-On Settings. Add-on Settings - Product Settings page is displayed. Click on Add action for HelpDesk. This takes you to the ManageEngine ServiceDesk Plus Server Details page with a choice to Select HelpDesk Product. Choose ServiceNow. Provide the Instance name (e.g.: [instancename].service-now.com) , User name and Password. Secure connection will be used by default while connecting to ServiceNow and so the protocol must not be specified in the Instance field. PrerequisitesThe user in ServiceNow should have itil, itil_admin and personalize_choices roles assigned for successful integration in Applications Manager. Log in to ServiceNow as an admin user and perform the following: Go to System Definition and then Tables. Search for "Incident". Click on the entry that has the Label as "Incident". This will load the Incident table. Now, select Controls tab. Enable "Create access controls" and type itil_admin in the "User role" field. Save this table. Configuring ServiceNow in Applications Manager Under Settings tab, click on Add-On Settings under Product Settings.  An Add-on Settings table is displayed.  Click on Add action for HelpDesk. This takes you to the ManageEngine ServiceDesk Plus Server Details page with a choice to Select HelpDesk Product. Choose ServiceNow.  Provide the Instance name (e.g.: [instancename].service-now.com), Username and Password. Secure connection will be used by default while connecting to ServiceNow and so the protocol must not be specified in the Instance field. Check the Enable Mail Notification for Connectivity Failure checkbox if you wish to trigger mail notifications in case of connectivity failures. After enabling this option, enter the following details: Configure the email to which the notification has to be sent. You can configure either by choosing Admin email (Mail address configured for the admin user or the mail address in SMTP configuration) or by selecting email actions to be triggered for the selected email from the dropdown. Enable the Append Custom Message checkbox if you want to append customized text messages along with the mail notifcation. Enable the Repeat mails until successful connection checkbox to repeat mail notifications until connection is established successfully. After enabling, specify the Repeat Interval (in minutes) afterwhich mail notification has to be repeated. By checking the Advanced Settings checkbox, you have the option to configure Ticket Settings which can be performed after checking the Enable Ticketing checkbox. Test if the connection is working and save the settings. Ticket Settings You can configure the following settings: Reopen Settings Set Applications Manager to perform one of the following actions when an alarm is raised again for a closed ticket: To reopen the ticket whenever an alarm re-occurrs To reopen the ticket within a certain number of days from the closed time. If the ticket cannot reopened, a new ticket is automatically created To create a new ticket or to open a new ticket whenever an alarm has re-occurred. Set Applications Manager to perform one of the following actions when an alarm is raised again for a resolved ticket: To reopen the ticket whenever an alarm is re-occured. To reopen the ticket within a certain number of days from the closed time. If the ticket is not reopened, a new ticket is automatically created. (To reopen the ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To create a new ticket or to open a new ticket whenever an alarm has re-occured. Set Applications Manager to perform one of the following actions when an alarm is raised for an entity that was previously clear and if the existing ticket in HelpDesk is not closed/resolved: To update the existing ticket whenever an alarm is re-occured. To update the existing ticket within a certain number of days from the clear alert. If the ticket is not updated, a new ticket is automatically created. (To update the existing ticket whenever an alarm is reoccured within a certain number of days, else open a new ticket.) To update the notes associated with that ticket. To create a new ticket or to open a new ticket whenever an alarm has re-occured. Enable on-demand ticket generation using : Raise a ticket action, so that you can raise a ticket on demand using a ticket action from alarms page. The new on-demand tickets are mapped to the respective configuration items Request Form, so that you can raise a ticket on demand using the request form from alarms page. The new on-demand tickets are mapped to the respective configuration items Update Settings Set Applications Manager to perform one of the following actions when the severity of an alarm is changed / RCA of the alarm is updated for an already created ticket: To update the ticket. To update the notes associated with that ticket. Set Applications Manager to perform one of the following actions when an alarm is cleared for a ticket: To close the ticket To update the notes associated with that ticket Set Applications Manager to perform one of the following actions when a monitor or a ticket action or a metric is deleted for a ticket: To close the ticket. To update the notes associated with that ticket. Update the ticket only if there is a status change in the alarm If enabled, action is triggered only when there is a status change in alarm Add notes for the ticket whenever an annotation is made for the alarmAccessing from Applications Manager Access ticket details from Application Manager. User can access the ticket details from the ticket details link in the alert details page Launch Read-only ticket. When selected, the ticket details launched from Applications Manager would be read only APIs used in APM for incident management in ServiceNow Purpose Method URL with Input data Fetching https://instance.service-now.com/api/now/table/sys_choice? GET Category sysparm_fields=label,value&element=category&name=incident https://instance.service-now.com/api/now/table/sys_choice? Fetching GET sysparm_fields=label,value&element=subcategory&name=incident&dependent_value= Subcategory [category name] https://instance.service-now.com/api/now/table/sys_choice? sysparm_fields=label,value&element=urgency&name=incident Fetching   From Applications Manager 13410, the Urgency API has been changed to: Urgency https://instance.service-now.com/api/now/table/sys_choice? sysparm_fields=label,value&sysparm_querynameINtask^element=urgency Fetching https://instance.service-now.com/api/now/v1/table/sys_user_group? Assignment GET sysparm_fields=sys_id,name Groups Fetching all https://instance.service-now.com/api/now/v1/table/sys_user? GET Technicians sysparm_fields=roles,user_name,name&roles=itil Fetching technicians https://instance.service-now.com/api/now/v1/table/sys_user_grmember? GET of a Support sysparm_fields=user.name&group=[sys_id of support group chosen] Group Adding an https://instance.service-now.com/api/now/table/incident? POST incident &sysparm_fields=short_description,sys_id,description Editing https://instance.service-now.com/api/now/table/incident/[sys_id of ticket created]? incident POST &sysparm_fields=short_description,sys_id,description details Note: The following roles are required for the user in ServiceNow for integrating with Applications Manager: itil and itil_admin. Reference: https://www.servicenow.com/products/itsm.html AlarmsOne Integration AlarmsOne - Overview AlarmsOne is a centralized IT alert management tool provided by ManageEngine, that helps you manage all your IT alerts in one console. Third-party applications can be integrated with AlarmsOne to make alarm management easy. Key Benefits With AlarmsOne integration, you can: Consolidate all your IT alerts and group them based on host, network device, application, database, and more. Get visibility into each alert to help you minimize downtime and maximize performance. Reduce alert noise, create on-call schedules to notify your technicians about incidents through email, SMS, and call alerts, escalate unattended alerts, modify alert content to create actionable alerts, and so on. Integrating with AlarmsOne You can integrate Applications Manager with AlarmsOne in one of two ways:Integrate AlarmsOne Through Applications Manager Itself Integrate AlarmsOne Through Alarm Poller Agent If you don''t have an AlarmsOne account, click here to create one. Integrate AlarmsOne into Applications Manager Follow the below steps to integrate AlarmsOne with Applications Manager and start managing your alerts in AlarmsOne: Log in to your AlarmsOne account and go to Settings > Show API key. Copy the API key. (The API Key used to integrate AlarmsOne. This Key is generated when you create an AlarmsOne account.) Log in to Applications Manager and go to the AlarmsOne section.  Click Integrate in APM. This will take you to the Add-on Settings page. (Alternatively, you can navigate directly to the Add-on Settings page from the Admin tab itself). In the AlarmsOne Integration table, you will see the message "No accounts are added yet, click here to Add New Account." Click to go to the AlarmsOne Integration page. Paste the copied AlarmsOne API key in the AlarmsOne API Key field. If you check the Sync recent alarms checkbox, you can sync the recent 500 active alarms to AlarmsOne. Click Save. This completes the integration process. Now you can view and manage your alerts in AlarmsOne. Click here to learn how to configure AlarmsOne''s features such as noise reduction, escalations, on-call scheduling, alarm modifier, downtime, etc. Note: This integration needs an active internet connection to send alarms from Applications Manager to AlarmsOne in real time. Manage Applications Manager Alarms in AlarmsOne The AlarmsOne Integration page displays the AlarmsOne User Email-id, the Last Synched Time, the Last Sync Status, Last Alert Created Time and icons to Edit, Enable/Disable sync, or Delete an integration. Edit, Update or Delete an integration Go to the Settings tab and then Add-On Settings. In AlarmsOne Integration, click the edit icon ( )to edit AlarmsOne details.   And there is an checkbox called "Enable Sync status" , if you enable this check box then alerts are pushed to AlarmsOne. If you check the Enable Syncing checkbox, alerts are pushed to AlarmsOne. This option is displayed only after integration.  You can also Enable/ Disable the sync status under Add-On-Settings. You can delete an integration by clicking the Delete icon ( ) in the AlarmsOne Integration table. Note: To update the details,an AlarmsOne API Key is Mandatory. Re-integrating with AlarmsOne This option is shown if, after integrating with AlarmsOne, the user deletes the Applications Manager integration in his AlarmsOne account. Go to the Settings tab and then Add-On Settings. In AlarmsOne Integration, click the Re-integrate link (under the "Last Sync Status" column). The same AlarmsOne account will be re-integrated. E-mail notification While pushing alerts to AlarmsOne, if an error occurs,  the user will be notified through email. The e-mail states the reason the alert could not be pushed to the AlarmsOne account and the time at which the error occured. This notification mail will be sent only the first time an error occurs. Integrate AlarmsOne Through Alarm Poller Agent You can integrate Applications Manager from the AlarmsOne account itself using Alarm Poller agent. The agent will pull the alerts from Applications Manager every minute and push it to AlarmsOne server. Click here to know how.Limitations It is possible to sync only 3000 alerts to AlarmsOne in 5 minutes. This is because 500 alerts are synced in a single API call and the remaining 2500 in a bulk API call (500 per call). Alerts that exceed this threshold are removed. Single API calls can be used to execute actions, whereas bulk API calls cannot. Alert message length can be 50000 characters only. ManageEngine OpManager Network Monitoring Connector ManageEngine Applications Manager integrates now with a comprehensive Network Monitoring Tool, ManageEngine OpManager. ManageEngine OpManager provides an effective network monitoring software that offers comprehensive fault and performance management across WAN and all other IT infrastructure. Using Network Monitoring Connector, an Applications Manager User can view the status of his Network Devices in addition to Servers, Application Servers, Databases monitored by Applications Manager. Key Benefits: Single console to monitor network, server & applications. SLA and availability metrics of your business application by taking in to consideration the network, servers and applications. Single console to view all alarms. Version Compatibility OpManager Applications Manager From 125483 onwards From 15370 to latest From 125393 to 125482 From 15230 to 15360 From 125328 to 125392 From 15120 to latest From 125000 to 125327 From 14842/14860 to latest Configuring Applications Manager Configure Applications Manager to obtain the data from OpManager. In Applications Manager, go to Settings → Add-on Settings and select OpManager. Provide the details of the server and port in which OpManager is running. (Make sure that OpManager is up and running in this step) Provide the REST API key for user authentication, which is available in OpManager web client under Quick links (Settings icon) → REST API Key. Check the Enable Data Collection option if you want to perform data collection for the network devices. By default, this option is enabled. If you want to import all your devices from OpManager when integration is complete, then enable the Import All Devices option.(You also have the option to leave "Import All Devices" unchecked and associate the required devices to Monitor Groups after integration is complete.) Click Save. Modifying the Poll Interval You can configure the poll interval and set the time when Applications Manager must check for updates from the External Connectors. Go to Poll Interval tab under Add-on Settings. The poll interval settings that you can modify are: Update Alarms from External Connectors - This option indicates the alarm update interval, in which the alarms from external connectors are updated in Applications Manager. This can be configured as per the user requirements. The default time interval is 5 minutes. Update All Devices and Alarms from External Connectors - This option indicates the full update interval in which all the devices and alarms from external connectors are updated in Applications Manager. This can be configured as per the user requirements. The default full update interval is 30 minutes. Associate network device Monitors into existing Monitor Groups:In order to associate OpManager monitor against a Monitor Group in Applications Manager, click on the Home tab. Under Monitor Group Information, click Associate Monitor of Monitor Group Links in the left frame. A list of discovered Monitors (for both Applications Manager and OpManager) that are available for associating and those that have already been associated with that Monitor Group is displayed. You will also see a list of network devices under Network Devices being displayed. Select the check box of the corresponding Monitor from Monitors not present in this Monitor Group list and click Associate. You can also remove a Monitor which has already been associated with the Monitor Group by selecting the check box of Monitor(s) under Monitors present in this Monitor Group and clicking Remove. Associate network device Monitors into a new Monitor Groups: Click on the New Monitor Group. Provide a Monitor Group name, description of that monitor group and assign the owner for the monitor group. Once the Monitor Group is created, click on Associate Monitors provided in the Summary tab of that Monitor Group. A list of discovered Monitors (both Applications Manager and OpManager) that are available for associating is displayed. You will also see a list of network devices under Network Devices being displayed. Select the check box of the corresponding Monitor from the list and click Associate. Click on Back to Monitor Group to view the list of Monitors that you have associated for that group. Additional Configurations The following table contains additional configurations that can be made in OPM Connector: Requirement Steps to follow In OPMConnector.properties under  /conf directory (only for Professional edition and Managed Server) : To add attributes in Applications Add/set opmConnector.populate.attributes=true. Manager when a device is added in OpManager To view the attributes, restart Applications Manager and wait for the first full update. The attributes will be listed under Configure Alarms for OpManager device type. In OPMConnector.properties under  /conf directory (only for Professional edition and Managed Server): To add interfaces as monitors in Applications Manager Add/set opmConnector.fetch.extprod.interfaces=true.  To view the interfaces, restart Applications Manager and wait for the first full update. In OPMConnector.properties under  /conf directory (only for Professional edition and Managed Server) : To include a default Networks dashboard Add/set opmConnector.show.nwd.widgets=true.  To include the dashboard, restart Applications Manager. Associating Alarms and Actions for Network devices With the OpManager Network Monitoring Connector, you can view alarms from your OpManager network devices in Applications Manager and associate actions to Opmanager attributes. Alarms: Once you have imported all your devices from OpManager, go to the Alarms Tab to view all the alarms configured in Applications Manager along with their severity, type, date and the technician to whom the alarm is assigned. You can filter and sort through the alarms by clicking on the parameter type at the top of the table. You can view all alarms or filter the Critical  , Warning   and Clear   alarms. You can also filter alarms by: Alarm Actions Selected Time Selected Monitor GroupSelected Monitor Type You can search through alarms by clicking the search button   at the top of the alarms table. Click here to know more about the Alarms Tab. Actions: You can trigger corrective actions to OpManager attributes, once you have imported your network devices, such as sending e-mail, SMS, trap, and executing a command, to notify you of the alarms generated while monitoring the network devices. To trigger such corrective actions, you should have defined the action, which can then be associated with an attribute. Click here to learn more about how to define actions. Note: You cannot create or associate thresholds for OpManager attributes. Limitations If OpManager is integrated with the Admin server, integration in all the Managed servers will be restricted and vice versa. If OpManager is integrated with both Admin and Managed server, OpManager''s data collection in the Managed servers will be disabled. No OpManager data from the Managed servers will be displayed in both Admin and Managed server''s UI. The user will be able to access the delete option for the Managed server''s OpManager. (Note: Integrating OpManager with both Admin and Managed server, is not recommended). In the above case, if OpManager integrated with Admin server is deleted, then OpManager in Managed server''s data collection will be enabled and all the data related to Managed server''s OpManager will be displayed in both Admin and Managed server''s UI. Prometheus Integration Overview Prometheus is an open-source software application that is used for systems/event monitoring and alerting. It records, collects, and stores real-time data in the form of time series using HTTP pull model, and aids in discovering and monitoring various resources using flexible queries and real-time alerting. With Prometheus integration, you can automatically fetch scrape jobs configured from Prometheus server and categorize it into various monitor types supported in Applications Manager. Integrating Prometheus with Applications Manager enables you to achieve the following: Automatic categorization of monitor type based on scrape job. Data visualization within the product without the need for third-party tools. Configuration of alerts, actions and reports for all the collected metrics. Note: Currently, Tomcat-server monitor type is only supported for this integration. Prerequisites Prometheus server should be reachable to the system where Applications Manager is installed. If Prometheus server is deployed as a Pod/Container, the option cURL through SSH can be used for discovery and data collection, for which, the server should be accessible with localhost IP address or Pod IP address. For Tomcat server, discovery and data collection is performed using metrics exposed by the exporter. Make sure to deploy the exporter on the Tomcat server/container to scrape metrics from Prometheus. Learn more Steps to add integration Follow the steps given below to integrate Prometheus with Applications Manager: After logging into Applications Manager, navigate to Settings → Product Settings → Add-On Settings. Click on Add New Account button within the Prometheus thumbnail. Enter the Display Name of the add-on integration. Specify the Polling Interval time for discovery, in minutes. Choose Mode of data collection. Select Exposed Prometheus API if Prometheus server/pod is exposed over the network. Select cURL through SSH if Prometheus is accessible only on deployed server. Specify the Prometheus Server Details such as Host, API Port, Endpoint and the Protocol to be used while accessing Prometheus API.Enter the Basic Authentication credentials if enabled. Enter the required SSH Connection Details if the Mode of data collection is selected as cURL through SSH. Choose the Monitor Types, Discovery Options and the Action to be performed in case of data unavailability for discovered monitors. Click Save. After performing the above steps, you can view the list of discovered and monitors in the Add-on-settings page. A button named Show Monitors will be present at the top right corner of each added integration thumbnail, clicking which will display the list of monitors added for that integration. In addition, you can use various options to handle the monitor addition while performing the discovery. Use the Specific Instances option to customize the discoveries based on specific instances. Also, there are options to auto delete, un-manage monitors, and alert users if data is not available on Prometheus server. Note: Currently, Tomcat-server monitor type is only supported for this integration, wherein you can view performance metrics such as Server Response Time, Thread Usage, Memory utilization, and Web Applications. However, servlet-level metrics will not be shown. Applications Manager Integration with Site24x7 Overview ManageEngine Applications Manager supports integration with Site24x7, the website monitoring service based on the SaaS model. Site24x7 provides effective website uptime monitoring capability so you know how well your sites, hosts, mail servers and web applications are performing from outside your data center. With Site24x7 integration, you can view the uptime and performance status of all your websites from from inside your data center and out on a single console. Key Benefits With Site24x7 integration, you can: View performance metrics both from within your corporate LAN (Applications Manager Monitoring) and from multiple locations outside your data center (Site24x7 Monitoring). Availability and health reports from over 40+ locations (Servers) inside Applications Manager. Single Alarm Console. Integrating Site24x7 with Applications Manager Browse through the following topics to understand and configure Site24x7 data integration: Configuring Site24x7 Configuring Applications Manager Associating network device monitors into existing monitor-groups Configuring Site24x7 for data integration: Sign up for a Site24x7 account. Once you sign up, you can add monitors as per your requirement. Configuring Applications Manager: Once Site24x7 is configured correctly, you need to configure Applications Manager to sync data: Log in to Applications Manager. Click on the Settings tab. Click on Add-on/Product Settings. Click Add New Account in the right-hand corner of the Site24x7 Data Integration table. Enter the following Site24x7 product details: OAuth - Authorization using OAuth Protocol . This can be configured either by selecting the required OAuth provider from the drop down list or by creating a new OAuth provider by clicking on the Add Oauth Provider link. (To know more on how to configure a new OAuth Provider, refer here.) Account Name - Your Site24x7 Account Name or Display Name. Polling Interval - Enter the polling interval time in minutesClick Save button to save the settings. You can edit account details, disable data collection, fetch data and delete a monitor by clicking the Actions icons in the Site24x7 Data Integration table. Associating Site24x7 monitors into existing monitor groups To associate a Site24x7 monitor to a Monitor Group in Applications Manager: Click on the Home tab in Applications Manager. Under the Default Dashboard, click on a group name in the monitor group table. Monitor Group Information is displayed. Click the Associate Monitor link found at the right-side of the page. A list of Monitors that are available for associating and those that have already been associated with that Monitor Group is displayed. You can also see a list of Site24X7 monitors. Select the check box of the corresponding Monitor from Monitors not present in this Monitor Group list and click Associate. You can also remove a Monitor which has already been associated with the Monitor Group by selecting the check box of Monitor(s) under Monitors present in this Monitor Group and clicking Remove. Note: The data shown on the details page of Site24x7 monitor is fetched in real time from Site24x7 directly. It does not depend on the data collection for the Site24x7 account. The following monitors will not be imported into Applications Manager: vCenter Amazon Website Defacement Monitor RUM APM Insight Mobile APM The first three monitors will have only the details of the dependent MOs. The RUM monitor is available as "Web User Experience" monitor under APM, which will in turn add RUM monitor into the particular Site24x7 account. Integrating Slack with Applications Manager Overview Steps to Integrate Slack Creating a new Slack message action Overview Slack workspace is a shared space where team members can communicate and work together. It is like a chatroom for your work, facilitating your team to collaborate and coordinate on their tasks effectively. Integrating Slack with Applications Manager complements this process. By receiving timely alerts from Applications Manager into your Slack workspace in real-time, your team can provide faster response to service failures and problems. Steps to integrate Slack After logging into Applications Manager, navigate to Settings → Product Settings → Add-On Settings tab. Under the Slack Integration table, click on the link to add a new account. A new window will be opened requesting for the auth-code. Click on Get Auth-code. An authorization prompt page containing a list of all the permissions required for the Applications Manager app to be integrated with your workspace will be displayed. After analyzing all the permissions, click on the Authorize button. You will be redirected to another site where the auth-code will be provided. Copy this auth-code.Now return to the Slack Integration table in Applications Manager, and paste this auth-code in the space provided. Click on Save. A success message "Slack details updated successfully" will be displayed indicating the successful integration of Slack with Applications Manager. Creating a new Slack message action To create a new Slack message action in Applications Manager, follow the steps given below: Select the Slack Action option from the Actions menu. Enter the Display Name for the action. Choose the sender from which the message notification has to be received under Send As option. You can configure by selecting any one of the following options: Applications Manager: Allows the configured channel/member to receive message notifications directly from the ''Applications Manager'' bot. Only the receiver will be able to view the message notification. Slack User: Allows the configured channel/member to receive message notifications from the configured Slack user. Both the sender and the receiver will be able to view the message. Select a channel or a member to which the message has to be sent to. After selecting either of the above two options, a drop down containing the list of all the channels/members available in your Slack workspace will be displayed. Choose the required channel/member from the drop down. Enter the Title Message required to be shown in your message. Under Description, specify the required fields that need to be shown in your Slack message by entering appropriate replaceable tags for those fields. You can do so by choosing the required tag from the drop down list available right adjacent to the Description text box. After specifying the required Slack message, click on Create Action button to finish creating the Slack message action. After creating the Slack message action, you can test its execution by clicking the Execute [ ] icon for that action. Note: To receive message notifications in private channels, the user has to configure by inviting the ''Applications Manager'' bot to the required private channels in Slack. Applications Manager Plugin for OpManager Applications Manager Plugin - An Overview Editions Available for Installation Version Compatiblity Software Requirements for the Applications Manager Plug-in Instructions to apply Applications Manager plug-in Using the Applications Manager Plugin User Management in Applications Manager Plugin Applications Manager Plugin - An OverviewWith Applications Performance Management plug-in (APM Plugin) for OpManager,  you can proactively monitor business applications and help businesses ensure their revenue-critical applications meet end user expectations. This plug-in offers out-of-the-box monitoring support for 50+ applications and servers. Monitoring Highlights: Automatic discovery of application servers, databases, services, systems, transactions, custom applications, virtual resources and cloud apps in your heterogeneous data center. Experience comprehensive performance management of over 100 key performance indicators of your applications - including response time, resource availability, CPU/memory utilization and more. Get a holistic view of your IT resources including a wide range of business applications and network services. Perform end-user experience monitoring of enterprise Internet Services and hosted Web Services from your branch offices; and measure the end-user experience of business-critical network services such as DNS, LDAP, Ping and Mail server from customer locations. Effective, timely fault management with notification of problems through e-mail and SMS alerts. Powerful reporting capability with extensive coverage to  help administrators in application troubleshooting & capacity planning. Limitation: Users with business view restriction in OpManager will not be synced to Applications Manager Plugin. Editions Available for Installation Professional Edition - To install the Professional edition, the OpManager Standalone should be installed before installing Applications Manager Plugin. Enterprise Edition -  To install the Enterprise Edition, the OpManager central and OpManager Probe should be installed before Plugin Enterprise Edition installation. Version compatibility of Applications Manager Plugin with OpManager OpManager Applications Manager Plugin Applications Manager Plugin Standalone Enterprise Edition Versions 125630 and above Versions 15670 and above Versions 125614 to 125629 Versions 15560 to 15660 Versions 125561 to 125613 Versions 15470 to 15550 Versions 125468 to 125560 Versions 15340 to 15400, or Hotfix versions 15401 and 15402 Versions 125393 to 125467 Versions 15160 to 15330 Versions 125307 to 125392 Versions 15000 to 15150 Versions 14860 to 14911, or Hotfix Version 125214 Versions 14540 to 14700, or Versions versions 14843 to 14845 14730 to 14911 Versions 14540 to 14700, or Versions Version 125000 14730 to 14780 Note: It is mandatory for customers to upgrade Applications Manager to 15160 if OpManager is upgraded to 125393 and vice versa. OpManager Applications Manager Plugin (Both Standalone and EE) Version 124070 Versions 14310 to 14530 Version 123150 Versions 13730 to 14300 Versions 13680 to 13720 with backup of conf files. Replace the old Plugin.properties file in Version 123111 OpManager\AppManager\conf. Update Versions 123150 and below APM_BUILD_NUMBER with the correct version in Plugin.properties before restarting. Version 12 and above Versions 13110 to 13670 Version 123111 and below Versions 11500 and 11600 Versions 13010 and belowNote: Applications Manager plugin should be upgraded to version 14540 or above before upgrading OpManager from its service pack version 12.5  Software Requirements for the Applications Manager Plug-in The recommended software requirements for installing and running Applications Manager plug-in are as follows: Supported Operating Systems Supported Browsers Windows 7, Windows Server 2003,2008,2012 Internet Explorer 8.0 and above RedHat Linux 8.0 and above FireFox 7.x and above Enterprise Linux 2.1 and above Google Chrome v22.0 and above Debian/Suse/Ubuntu/Mandriva/CentOS/Fedora Core Instructions to apply Applications Manager plug-in Download OpManager''s Applications Manager plug-in file to OpManager server Shutdown the OpManager Service and execute the file. You have to install Applications Manager plug-in in OpManager server. Follow the on-screen instructions to complete the installation process. Once the installation wizard completed, the Applications Manager Plugin will be installed under OpManager_HOME/AppManager directory Start the OpManager Service. While uninstalling Applications Manager Plugin The database does not get removed in pgsql backend since it is created in OpManager Database server. Please ensure that the database is manually removed from OpManager server by using the DROP DATABASE command. Using the Applications Manager Plugin In version 125614 of OpManager, Applications Manager can be accessible under “Dashboards → Servers → Applications” or by clicking the Applications tab directly. Note: There is no need to apply a separate license file for Applications Manager Plugin. It is included within the OpManager license. User Management in Applications Manager Plugin OpManger automatically creates user profiles in Applications Manager plugin based on the OpManager users. To view Applications Manager plugin user profiles, Go to Apps → Admin → User Management. You''ll be taken to User Management dashboard, where there are 5 tabs- Profiles, User Groups, Permission, Views and Account Policy.Profiles: On clicking a user profile, you will be able to see the User profile details. However, editing user profiles details such as User Name, Update Password, E-Mail, Role is not allowed. Image file can be changed. User Groups: You can add user groups and associate users to them here. Specify the User Group name. Select the users to be associated to the group. Select the monitor group to be associated  to the user group. Click Create User Group to finish. Permissions: A set of Admin, Operator and AS400 permissions are given from which you can check the ones applicable to your infrastructure. Views: Select how you view the monitors in the home tab. You can choose between "Show the subgroups from the corresponding top level Monitor Group" and "Show the associated subgroups directly in the home tab itself."Account Policy: Option to Enforce account lockout and Enforce single user session is given here. You can specify the no of continuous failed login attempts and idle session timeout(min) after which account should be locked. If Enforce single user session is checked, user can have only one active session.  Applications Manager REST APIs ManageEngine Applications Manager provides REST APIs for fetching data from Applications Manager. Using these APIs, Applications Manager''s data can be integrated with any internal portal or 3rd party System Management software. The data can be represented in a single dashboard itself. By using any XML parser in a scripting language, Java, C, Perl or Python, etc. you can make HTTPs requests in the format recommended in the API. This data can then be inserted into your own database or put in any format that you need. Note: It is highly recommended to use the secure channel (HTTPS) mode to communicate with Applications Manager so as to avoid any security issues during REST API calls. Prerequisites Applications Manager User Account: Each Applications Manager User should have a valid UserName to use the API. Take an intranet portal for example. When each user logs in, the assigned monitors and alarms will be shown. So, it is imperative that each user should have separate API keys. When GetAlarms API is invoked with the key generated for that particular operator, it will list the alarms that are assigned to that person alone. How do APIs work? In order to use the API, each user should obtain an API key - which is a long text and is unique to their Applications Manager Account. The API key has to be passed as parameter in every API request made. Generate API Key The User can register for the API key from within Applications Manager product using the "REST API" option in the Settings tab. Note: Generating an API Key is a one-time process. The API Key you generate is unique to that particular installation. Steps for using REST API Click on the Settings tab Under Integration with Portals, click REST API. An API key is generated - eg.7b5fde68148fa2419bc2f1a1ab87e757Open the browser, the URL would be http:// :9090/AppManager/xml/ListServer? apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=all By changing to the required monitor, data pertaining to that monitor can be retrieved. Check if the following URL works fine. http:// :9090/AppManager/xml/ListServer? apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=server Above URL will give data of all the server monitors. ''all'' will give the entire Applications Manager''s data. By using any XML parser in a scripting language, Java, C, Perl or Python etc, you can make HTTPs requests in the format recommended in the API. This data can then be inserted into your own database or put in any format that you need. Note: REST API xsd files are available in /help/RESTAPI/xsd folder. REST API Key Regeneration A user logged into Applications Manager can view his API Key by clicking on the user photo to edit his details. If the user has an administrator account, the REST API key can be viewed in the Settings tab, under REST API. An Admin user can regenerate an API key for him as well as for other users. The REST API key is regenerated instantly. You should be prepared to modify the API Key in your web portal(s) that uses the API Key, soon after the regeneration, to insure that it continues to function correctly. REST APIs for Various Operations Browse through the below sections to know about the operations that can be performed using REST API: Add Monitor Downtime Scheduler Edit Monitor Monitor Group Operations List Data User Management Perform Operation Admin Activities Processes and Services Error Handling AddMonitor API This API allows the user to configure monitors in Applications Manager. The different monitors supported are: Application Servers Cloud Apps Custom Monitors Database Servers ERP EUM Java/Transaction Mail Servers Middleware/Portal Servers Services Web Server/Services Virtualization Converged InfrastructureRequest Parameters The common parameters involved in the API request are described below: Field Description apikey * The key generated from the Generate API Key option in the ''Admin'' tab. displayname * The display name of the monitor. subnet The subnet where the server is running. The default value is 225.225.225.0 The interval at which the server needs to be polled. This variable is optional. If pollInterval no value is mentioned, the default value of 5 minutes will be taken. The id of the monitor group. In Applications Manager, you can find the groupID of a monitor group using the following method: Click on the Group Name in the Monitor Groups table. This will open the Monitor Group details page The URL of the Monitor Group details page will be in the following format: groupID (haid) http://app-windows:9090/showapplication.do? &method=showApplication&haid=10000040 The haid in the URL is the Group ID that you require, in this case, 10000040. The value can be ''True'' or ''False''. Do not resolve DNS name when you have resolvedns multiple system IP addresses configured with single DNS name. credentialID A unique identifier set by Applications Manager for a credential. label Assign labels for a resource. * mandatory Adding a new monitor as a Delegated Admin user When adding a new monitor as a Delegated Admin user, the following parameters should be appended in the API URL: Field Description Denotes if the monitor should be added to monitor group. Value is addToGroup * either true or false. groupID * The group ID of the monitor group to which the monitor is to be added. * mandatory Sample Request http://app-windows:9090/AppManager/AppManager/xml/AddMonitor? apikey=f746be1da5fb1a2668b00251742ccd2d&type=SilverStream&displayname=sliverstream&host=hostna me&port=8081&ManagedServerID=1&addToGroup=true&groupID=10069 Adding a new monitor from an Admin server in the Enterprise Edition When adding a new monitor from an admin server in the Enterprise Edition, the user can select the Managed server of his preference. To do so, the following parameters should be appended in the API URL: Field Description The new monitor will be added in the Managed Server of which the ID is ManagedServerID * specified. ManagedServerGroupName * The new monitor will be added in a Managed Server in the specified Group. * If these parameters are not specified, the managed server will be selected based on the load-factor.Note: HTML encoding will be required for parameters with special characters (like display name or password). For example, if a password contains a special character like &, ", # , & , % or + , it should be replaced with the corresponding string as below while passing the password in the REST API: # should be replaced with %23 & should be replaced with %26 % should be replaced with %25 + should be replaced with %2B For More information about HTML encoding, refer here. Invoking the Add Monitor API will change the display name for existing monitors. Sample Request This example helps you add a Windows server to Applications Manager: http://app-windows:9090/AppManager/xml/AddMonitor? apikey=0b0fd47feeff9050d6a45dd7b5bb5791&type=servers&displayname=APM- Windows&host=hostname&snmptelnetport=161&os=WindowsXP&mode=SNMP&username=administrator&p assword=vembu&snmpCommunityString=public Example Output                      Monitor added successfully.            Sample Error If the API is not executed correctly, the request will fail and errors will be thrown as shown below:                    The Transaction mentioned in the request URL should be yes or no.                Samples for adding a new monitor from an Admin server ManagedServerID: http://app-windows:9090/AppManager/xml/AddMonitor? apikey=627b1432529fbace2867388e6abf15e&type=ms sql&displayname=mssql&username=sa&host=hostname&password=password@123&port=1433&instance=& authentication=SQL&ManagedServerID=2 ManagedServerGroupName: http://app-windows:9090/AppManager/xml/AddMonitor? apikey=627bce9dvsdv0db9fbace2867388e6abf15e&type=ms sql&displayname=mssql&username=sa&host=hostname&password=password@123&port=1433&instance=& authentication=SQL&ManagedServerGroupName=WIN4Note: Sometimes, API executions could result in error conditions. In case of an error, the error information would be sent in the response body. The response body will have as the child node along with the appropriate error code. To know more about the list of common error conditions, refer here. AddMonitor API - Application Servers This section explains how to use the AddMonitor API to add monitors of the ''Application Servers'' category. The following application servers are supported: Microsoft .NET GlassFish JBoss Server Oracle Application Server Resin Server SilverStream Tomcat Server VMware vFabric TC Server WebLogic Server WebSphere Server Jetty Server Apache Geronimo Java Runtime Monitor Microsoft .NET Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type The category type of the monitor you want to add. Value should be ''.Net''. host The name of the host where the .Net server is running. username The username of the .Net server. password The password of the .Net server. Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=4df5040d6db873dcdaf4359b259fd494&type=.Net&displayname=AppmanagerDotNet&host=app- xp3&username=administrator&password=vembu   Adding a new monitor from an Admin server in the Enterprise Edition When adding a new monitor from an admin server in the Enterprise Edition, the user can select the Managed server of his preference. Know more about the mandatory parameters to be appended. GlassFishSyntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host=[HOST]&port= [PORT]&username=[USERNAME]&password=[PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath= [JNDIPATH] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type The category type of the monitor you want to add. Value should be ''glassfish''. host The name of the host where the GlassFish server is running. port The port number where GlassFish server is running. username The username of the GlassFish server. password The password of the GlassFish server. JNDIPath The JNDI path name. For example, the JNDIPATH for default installations of GlassFish is /jmxrmi. Sample Request http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=glassfish&host=app- xp2&port=8686&username=admin&password=adminadmin&displayname=glfish&JNDIPath=/jmxrmi JBoss Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&version=[VERSION]&authEnabled= [AUTHENABLED]&username=[USERNAME]&password=[PASSWORD]&LaunchType= [LAUNCHTYPE]&filterEnabled=[FILTER ENABLED/DISABLED]&filterCondition=[FILTER CONDITION]&AppServers=[APP SERVERS] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The category type of the monitor you want to add. Value should be ''JBoss server''. host The name of the host where the JBoss server is running. port The port number where JBoss server is running. version The version of the JBoss server. Supported versions include 3.2.x, 4.x, 4.0.1, 4.0.2, 5.x, 6.x , 7.x and Wildfly_8.x . authEnabled Denotes whether authentication is enabled in the JBoss server. Value should be either ''on'' or ''off'' username The username of the JBoss server. This should be specified only if authEnabled value is ''on''. password The password of the JBoss server. This should be specified only if authEnabled value is ''on'' The launch type of the JBoss server. Value should be ''Domain'', if JBoss server is started as domain. This is applicable LaunchType for version 7.x and above, else value can be ''Standalone'' or optional. Specifies whether the filter is enabled or not while discovering and adding the monitor. Possible values are either true filterEnabled or false. Specifies whether the servers are to be included / excluded while discovering and adding the monitor. Possible values filterCondition are either include or exclude. AppServers The list of servers that are to be included / excluded based on the condition given for the filterCondition parameter. It should be specified in the format"hostName1:serverName1,serverName2,serverName3....;hostName2:serverName1,serverName2,serverName3...." Sample Request http://prod-server2:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=JBoss server&displayname=AppmanagerJBoss4&host=app- xp2&port=8080&version=Wildfly_8.x&authEnabled=on&username=guest&password=guest http://prod-server2:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=JBoss server&displayname=AppmanagerJBoss7_domain&host=app-win7-64- 2&port=9990&version=7.x&authEnabled=on&username=domain&password=appman&LaunchType=Do main&filterEnabled=true&filterCondition=include&AppServers=host1:Server11,Server12;host2:Server21, Server22,Server23 Oracle Application Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&version=[VERSION] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description Denotes the category type of the monitor you want to add. If you want to add an type Oracle application server monitor, specify the value as ''oracle application server''. host The name of the host where the Oracle application server is running. port The port number where Oracle application server is running. version The version of the Oracle application server. Supported version is 10.1.3 Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=oracle application server&displayname=appmanageroracle&host=app-xp5&port=7200&version=10.1.3 Resin Server Syntax http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Resin&host=[HostName]&port= [JMX PORT]&UserName=[Username]&Password=[password]&displayname=Resin&JNDIPath=[JNDIPATH] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type The category type of the monitor you want to add. Value should be Resin. host The name of the host where the Resin server is running. port The port number where Resin server is running.username The username of the Resin server. password The password of the Resin server. JNDIPath The JNDI path name. For example, the JNDIPATH for default installations of Resin is /jmxrmi. Sample Request http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=resin&host=app- xp2&port=8686&username=admin&password=adminadmin&displayname=resinmonitor&JNDIPath=/jmxrmi SilverStream Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST] &port=[PORT] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type The category type of the monitor you want to add. Value should be ''SilverStream'' host The name of the host where the SilverStream server is running. port The port number where the SilverStream server is running. Sample Request http://prod-server6:8090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=SilverStream&displayname=sl&host=myesuraj&port=8 080 Tomcat Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version= [VERSION] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type The category type of the monitor you want to add. The value should be ''tomcat server''. host The name of the host where the Tomcat server is running. port The port number where Tomcat is running. username The username of the Tomcat server. password The password of the Tomcat server. version The version of the Tomcat server. Supported version is 5 and above. sslenabled True if the SSL is enabled.Sample Request http://app-xp5:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=tomcat server&displayname=appmanagertomcat&host=host&port=8080&username=admin&password=admin&ver sion=5 VMware vFabric TC Server Syntax http://[ APM Host ]:[ APM Port ]/AppManager/xml/AddMonitor?apikey=[ API Key ]&type= [TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[ PORT ]&username=[USERNAME] &password= [PASSWORD]&JNDIPath=[JNDI Path] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description Denotes the category type of the monitor you want to add. The value should be as ''VMware vFabric tc type Server''. host The name of the host where VMware is running. port The port number where VMware is running. username The username of the VMware server. password The password of the VMware server. JNDIpath The JNDI path name. Sample Request http://app-windows:9090/AppManager/xml/AddMonitor? apikey=c4bc4e45a43d2d6bfbca6bdcaf31f436&type=VMware vFabric tc Server&displayname=vFabric&host=app-centos32- 2&port=6969&username=admin&password=springsource&JNDIPath=/jmxrmi WebLogic Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version= [VERSION] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description Denotes the category type of the monitor you want to add. The value should be as ''WEBLOGIC type SERVER''. host The name of the host where the WebLogic is running. SSL Option to enable SSL (applicable for version 9 and above). enabled port The port number where WebLogic is running. username The username of the WebLogic server.password The password of the WebLogic server. The version of the WebLogic server. Supported versions include 6.1, 7.0, 8.1, 9.x, 10.x, 12.x, and 14.x version (Versions 14 and above) Sample Request http://app-windows:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=WEBLOGIC SERVER&displayname=Appmanagerweblogic&host=app- linux1&port=7001&username=weblogic&password=weblogic&version=8.1 For SSL support over WebLogic: Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version= [VERSION]&sslenabled=[ISSSLENABLED] Example: http://app-windows:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=WEBLOGIC SERVER&displayname=Appmanagerweblogic&host=app- linux1&port=7001&username=weblogic&password=weblogic&version=12.x&sslenabled=true WebSphere Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&version=[VERSION]&mode=[MODE]&soapport=[SOAPPORT] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type Denotes the category type of the monitor you want to add. The value should be ''websphere server''. host The name of the host where the WebSphere is running. port The port number where WebSphere is running. username The username of the WebSphere server. password The password of the WebSphere server. version The version of the WebSphere server. Supported versions include 5.x, 6.x, 7.x, 8.x, and 9.x mode The deployment mode of the server. Value is ''BASE'' soapport The SOAP connector port. Sample Request Base Deployment http://prod-server4:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2- 64ee&port=9082&version=9.x&mode=BASE&soapport=8880 Base Deployment With Global Security Enabledhttp://prod-server4:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2- 64ee&port=9082&version=9.x&mode=BASE&soapport=8880&authEnabled=true&username=admin&passwo rd=123 Base Deployment With SSL Enabled http://prod-server4:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2- 64ee&port=9444&version=9.x&mode=BASE&soapport=8880&sslenabled=true Network Deployment http://prod-server4:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereND&host=app-w2k8r2- 64ee&port=9081&version=9.x&mode=ND&soapport=8880&ndhost=app-w2k8r2-64ee&ndport=9082 Jetty Server Syntax http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Jetty Server&host= [HostName]&port=[JMX PORT]&UserName=[Username]&Password= [password]&displayname=Jetty&JNDIPath=[JNDIPATH] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type The category type of the monitor you want to add. Value should be Jetty Server. host The name of the host where the Jetty server is running. port The port number where Jetty server is running. username The username of the Jetty server. password The password of the Jetty server. JNDIPath The JNDI path name. For example, the JNDIPATH for default installations of Jetty is /jmxrmi. Sample Request http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=Jetty Server&host=app- xp2&port=8686&username=admin&password=adminadmin&displayname=jettymonitor&JNDIPath=/jmxrmi Apache Geronimo Syntax http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ApacheGeronimo&HostName= [HostName]&Port=[JMX PORT]&UserName=[Username]&Password=[password]&displayname=[Display Name]&JNDIPath=[JNDIPATH] Request ParametersThe parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. Value should be ''ApacheGeronimo''. displayname The display name of the Apache Geronimo monitor. HostName The name of the host in which Apache Geronimo server is running. port The port number where Apache Geronimo server is running. Port The JMX Port of the Apache Geronimo server. Username The Username of Apache Geronimo instance. Password The password of Apache Geronimo instance. JNDI Path The JNDI Path of the server. Sample Request http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=ApacheGeronimo&host=app- xp2&port=8989&username=admin&password=adminpass&displayname=Apache Geronimo Server&JNDIPath=/jmxrmi AddMonitor APIs - Cloud Apps This section explains how to use the AddMonitor API to add monitors of the category type Cloud Apps. The following monitors are supported: Amazon Windows Azure (deprecated) OpenStack Microsoft Azure Oracle Cloud Infrastructure Google Cloud Platform Microsoft 365 Amazon Syntax For Applications Manager versions till 15170: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&accessKey= [ACCESSKEY]&SecretAccessKey=[SECRETACCESSKEY]&displayname=[DISPLAYNAME]&AccountType= [ACCOUNTTYPE]&AmazonServices=[SERVICES] For Applications Manager versions 15180 onwards: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Amazon&accessKey= [ACCESSKEY]&SecretAccessKey=[SECRETACCESSKEY]&displayname=[DISPLAYNAME]&AccountType= [ACCOUNTTYPE]&AmazonServices=[SERVICES]&GlobalRegions=[GLOBALREGIONS/False] &ChinaRegions= [CHINAREGIONS/False]&AWSGovCloudRegions=[GOVCLOUDREGIONS/False]&AdvancedSettings= [True/False]&discoverchild=[yes/no/unmanage]&DeletedResourceAction= [Alert/Stop/Unmanage/Delete]&StopDiscovery=[True/False]&AWSServicesToStopDiscovery= [SERVICES]&NameFilterRegex=[.*[a-zA-Z0-9-_.].*] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters.Field Description type The type of the monitor you want to add. Value should be Amazon The Amazon Services that you want to monitor. Possible values are: EC2 (for Elastic Compute Cloud) RDS (for Relational Database Services) S3 (for S3 Buckets) SNS (for Simple Notification Services) DYNAMODB (for DynamoDB) ALB (for Application Load Balancer) AmazonServices NLB (for Network Load Balancer) SQS (for Simple Queue Service) LAMBDA (for Lambda functions) BEANSTALK (for Elastic Beanstalk environments) ECS (for Elastic Container Service clusters) EKS (for Elastic Kubernetes Service) DYNAMODB,EC2,RDS,S3,SNS,ALB,NLB,SQS,LAMBDA,BEANSTALK,ECS,EKS (for multiple services) The access Key ID of the AWS account with API access. accessKey Note: Click here to know more about access keys. SecretAccessKey The secret access key of the accessKey for the AWS account. The account type. Possible values are AwsGlobal AccountType AwsChina AwsGovCloud List of global regions that you can choose from when AwsGlobal AccountType is chosen. Possible values are: All-Regions, us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-west-2, eu-west-3, eu-central-1, eu-north-1, ap-south-1, ap-northeast-1, ap- northeast-2, ap-southeast-1, ap-southeast2-2, sa-east-1, ap-east-1, ap- GlobalRegions* northeast-3, me-south-1, af-south-1, eu-south-1 or False. Note: Specify the value All-Regions only if you want to monitor from all the above-mentioned regions. Do not enter other region values when All- Regions is specified. List of China regions that you can choose from when AwsChina AccountType is ChinaRegions* chosen. Possible values are: cn-northwest-1, cn-north-1 or False. List of US GovCloud regions that you can choose from when AwsGovCloud AWSGovCloudRegions* AccountType is chosen. Possible values are: us-gov-west-1, us-gov-east-1 or False. Enables configuration options for discovery of child monitors. Possible values discoverchild* are yes, no, and unmanage. Enables advanced settings, when checked. Possible values are either True or AdvancedSettings* False. Actions to be performed on the resources deleted in Amazon console. If this DeletedResourceAction* parameter is not used, by default it is ''Alert''. Possible values are Alert/Stop/Unmanage/Delete. Prevents discovery of resources under chosen service. Possible values are either StopDiscovery* True or False. Services for which further discovery of resources must be prevented. Available AWSServicesToStopDiscovery* services are ALB, BEANSTALK, DynamoDB, EC2, ECS, LAMBDA, NLB, RDS, S3, SNS, and SQS. If this option is not used, then the value should be False. NameFilterRegex* Regex to filter EC2 instances and adds the instances that match the regex alone.Note: Regex may contain alphanumeric characters, hyphen(-), underscore(_), and period(.) symbols. To ignore characters, specify .* at the beginning/end/middle one or more times. Note: Parameters with * have been added from Applications Manager version 15180 onwards. Sample Request For Applications Manager versions till 15170: http://localhost:9090/AppManager/xml/AddMonitor? apikey=897cc23e5ca9b0f9a0c3838343517734&accessKey=ACCESSKEYACCESSKEYAC&type=Amazon&Sec retAccessKey=SECRETACCESSKEYSECRETACCESSKEYSECRETACCE&displayname=test&AccountType=Aws Global&AmazonServices=DYNAMODB,EC2,RDS,S3,SNS,ALB,NLB,SQS,LAMBDA,BEANSTALK,ECS,EKS For Applications Manager versions 15180 onwards: http://localhost:9090/AppManager/xml/AddMonitor? apikey=23kjk34k34khkhkh34l5j3&type=Amazon&accessKey=ACCESSKEYACCESSKEYAC&SecretAccessKey= SECRETACCESSKEYSECRETACCESSKEYSECRETACCE&displayname=Amazon&AccountType=AwsGlobal&A mazonServices=EC2,RDS,S3,SNS,ALB,NLB,SQS,LAMBDA,BEANSTALK,ECS,EKS&GlobalRegions=us-east- 1,us-west-2&AdvancedSettings=true&discoverchild=unmanage&DeletedResourceAction= [Alert/Stop/Unmanage/Delete]&StopDiscovery=True&AWSServicesToStopDiscovery=DYNAMODB&NameFil terRegex=[.*[a-zA-Z0-9-_.].*] Windows Azure (deprecated) Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=WindowsAzure&displayname= [displayName]&SubscriptionID=[SubscriptionID]&AccountName=[AccountName]&AccountKey= [AccountKey]&Timeout=[Timeout] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be WindowsAzure Enter your Windows Azure subscription ID. Note: Subscription ID can be obtained by signing into windows.azure.com using your SubscriptionID windows live id. Then click Hosted Service and navigate to Storage & CDN, then to Storage Accounts. AccountName Enter the Account Name of your Windows Azure Storage account. AccountKey Enter the Account key of your Windows Azure Storage account. Timeout Specify a Timeout interval in seconds. Sample Request http://prod-server2:9098/AppManager/xml/AddMonitor? apikey=24uk5g34kuj5vh45kug4k25ug3&type=WindowsAzure&displayname=azure&SubscriptionID=qwerty7 85213&AccountName=54321&AccountKey=qwerty&Timeout=30 OpenStack Syntaxhttp://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OpenStack&displayname= [DISPLAY_NAME]&baseAuthURL=[IDENTITY_URL]&tenantName=[PROJECT_NAME]&username= [USENAME]&password=[PASSWORD]&isProxyNeeded=[true/false]&isProjectScopedToken=[True/False] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description Applications Manager API key (To get the API Key, go to Applications Manager → Admin apikey → REST API) displayname The display name of the OpenStack monitor type The type of the monitor you want to add. For OpenStack, it should be "OpenStack" baseAuthURL The Base Authentication URL for OpenStack. Eg: http://controller:5000 tenantName The Project Name associated with User of OpenStack account. username The Username of OpenStack account. password The Password of OpenStack account. isProxyNeeded Specifies if a proxy is required for monitoring. Possible values are true/false. Specifies if the authorization scope is set to Tenant/Project. Possible values are isProjectScopedToken True/False. Sample Request http://prod-server2:9098/AppManager/xml/AddMonitor? apikey=37e05e898e97f63b66aec9fbd10b9d3c&type=OpenStack&displayname=OpenStack_API&baseAuth URL=http://controller:5000&tenantName=Venus&username=admin&password=Abc@123&isProxyNeeded=f alse&isProjectScopedToken=False Error Handling: 4601 - The Authentication URL should not be empty. 4602 - The Tenant Name should not be empty. Microsoft Azure To add Microsoft Azure monitor using Mode 1 (AD Application & Service Principal): Syntax https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID= [SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERYMODE]&ClientID= [CLIENTID]&TenantID=[TENANTID]&AppKey=[APPKEY] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common request parameters. Field Description type Type of the monitor you want to add. Value should be ''MicrosoftAzure''. displayname Preferred display name of the monitor. SubscriptionID Subcription ID of the Azure subscription to be monitored.Field Description Azure services to be monitored. The possible values are VirtualMachines StorageAccounts AzureServices SQLDatabases ServiceBus KubernetesServices Provide the services as comma-separated values. DiscoveryMode Mode of resource discovery. The value should be ''AzureSPApp''. ClientID Client ID of the AD Application created in Azure portal. TenantID Tenant ID (Directory ID) of Azure Active directory. AppKey Password of the AD Application created in Azure portal. Sample Request https://apm-prod-server:9900/AppManager/xml/AddMonitor? apikey=er8s9g98ds6gdfg77d85g87sd68&type=MicrosoftAzure&displayname=AzureRestAPI&SubscriptionID =12aaaaaa-bbbb-cccc-dddd- 000a111b111c&AzureServices=VirtualMachines,StorageAccounts,SQLDatabases,ServiceBus,KubernetesServ ices&DiscoveryMode=AzureSPApp&ClientID=12aaaaaa-bbbb-cccc-dddd- 000a111b111c&TenantID=12aaaaaa-bbbb-cccc-dddd- 000a111b111c&AppKey=1234abcde456/abCDeDFdfknsefLJSDkdnl To add Microsoft Azure monitor using Mode 2 (Azure Organizational Account): Syntax https://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname= [DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode= [DISCOVERYMODE]&AzureOrgUserName= [USEREMAILOFORGANIZATIONALACCOUNT]&AzureOrgPassword= [PASSWORDOFORGANIZATIONALACCOUNT] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common request parameters. Field Description type Type of the monitor you want to add. Value should be ''MicrosoftAzure''. displayname Preferred display name of the monitor. SubscriptionID Subcription ID of the Azure subscription to be monitored. Azure services to be monitored. The possible values are VirtualMachines StorageAccounts AzureServices SQLDatabases ServiceBus KubernetesServices Provide the services as comma-separated values. DiscoveryMode Mode of resource discovery. The value should be ''AzureOrgAccount'' AzureOrgUserName Organizational account created in Azure portal. AzureOrgPassword Password of the organizational account. Sample Request https://apm-prod-server:9900/AppManager/xml/AddMonitor? apikey=dfs758s6d5f876df986sdf97sdf785&type=MicrosoftAzure&displayname=AzureRestAPI&SubscriptionID=12aaaaaa-bbbb-cccc-dddd- 000a111b111c&AzureServices=VirtualMachines,StorageAccounts,SQLDatabases,ServiceBus,KubernetesServ ices&DiscoveryMode=AzureOrgAccount&AzureOrgUserName=apmou@apmoutlook.onmicrosoft.com&Azur eOrgPassword=Abc123 To add Microsoft Azure monitor using Mode 3 (OAuth Mode): Syntax https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID= [SUBSCRIPTIONID]&AzureServices=[SERVICES]&DiscoveryMode=[DISCOVERYMODE]&OAuthVal= [OAUTHVALUE] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common request parameters. Field Description type Type of the monitor you want to add. Value should be ''MicrosoftAzure''. displayname Preferred display name of the monitor. SubscriptionID Subcription ID of the Azure subscription to be monitored. Azure services to be monitored. The possible values are VirtualMachines StorageAccounts AzureServices SQLDatabases ServiceBus KubernetesServices Provide the services as comma-separated values. DiscoveryMode Mode of resource discovery. The value should be ''AzureOAuth''. OAuthVal Indicates the OAuth value. Sample Request https://apm-prod-server:9900/AppManager/xml/AddMonitor? apikey=lk54h45k6glk34jkg5kj346fgk34h5j534&type=MicrosoftAzure&displayname=AzureOAuthRestAPI&Su bscriptionID=12aaaaaa-bbbb-cccc-dddd- 000a111b111c&AzureServices=VirtualMachines,StorageAccounts,SQLDatabases,ServiceBus,KubernetesServ ices&DiscoveryMode=AzureOAuth&OAuthVal=10000000 Oracle Cloud Infrastructure Syntax http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OracleCloud&displayname= [DISPLAY_NAME]&TenancyOCID=[Tenancy_OCID]&UserID=[User_OCID]&OracleServices= [Oracle_Services]&PEMFilePath=[PEM_File_Path]&Fingerprint=[Finger_print]&RegionsToMonitor= [Regions_To_Monitor]&stopdiscovery=[Stop_Discovery_Option]&ActionOnTerminatedResources= [Action]&advancedsettings=[Advanced_Settings]&servicesToNotDiscover=[Services_To_Not_Discover] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common request parameters. Field Description displayname Name of the Oracle Cloud monitorField Description type Type of monitor to be added. Value should be OracleCloud. TenancyOCID Oracle Cloud Identifier for the tenancy. UserID Oracle Cloud Identifier for the user. Type of service to be monitored. Available services are Compute, Database, OracleServices and Storage. PEMFilePath File path in which the file contains the private key. Fingerprint Obtained by uploading public key to the Oracle Cloud console. Regions to monitor List of regions to be monitored. stopdiscovery Prevents discovery of resources under a particular service. ActionOnTerminatedResources Actions to be performed on terminated resources. advancedsettings Enables additional settings, when checked. Services for which discovery should not be enabled. Available services are servicesToNotDiscover Compute, Database, and Storage. Sample Request http://localhost:9600/AppManager/xml/AddMonitor? apikey=1d9d98ce3273afd265400c3ef7b78678&type=OracleCloud&displayname=oraclecloudrest&Tenancy OCID=ocid1.tenancy.oc1..aaaaaaaagltesttesttesttest26h5ksdo6fgbvbcmj377dnoka73rq&UserID=ocid1.user. oc1..aaaaaaaabz2skyed3j3kwxsgqtesttesttesttestoczno4ew2ov7rr57wnuza&OracleServices=Compute,Stora ge,Database&PEMFilePath=C:\Users\karthik- 8095\.oci\oci_api_key.pem&Fingerprint=ea;e1:f8:68:a1:7f:ds:df:as:sd:d7:62:9e:53:f0:1f&RegionsToMonitor= eu-frankfurt-1,us-ashburn- 1&stopdiscovery=False&ActionOnTerminatedResources=Unmanage&advancedsettings=False&servicesToN otDiscover=Compute Google Cloud Platform Syntax http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=GoogleCloudPlatform&displayname=[DISPLAY_NAME]&GCPServices= [GCP_Services]&ProjectID=[Project_ID]&provider=[OAuth_Provider_Name]&advancedsettings= [True/False]&deletedresourceaction=[Alert/Stop/Unmanage/Delete]&stopdiscovery= [True/False]&servicestostopdiscovery=[False/GCP_Services] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common request parameters. Field Description displayname Display name of the monitor. type Type of monitor to be added. The value should be GoogleCloudPlatform. Google Cloud Services like Compute, Storage, Filestore, etc. Available services are GCPServices ComputeEngine, CloudStorage, CloudFilestore and KubernetesEngine. ProjectID Unique ID of the project to be monitored. provider Name of the OAuth Provider created in AppManager. advancedsettings Enables additional settings. Possible values are either True or False Actions to be performed on the resources deleted in GCP console. If this parameter is deletedresourceaction not used, by default it is ''Alert''. Possible values - Alert/Stop/Unmanage/Delete Prevents discovery of resources under chosen service. Possible values are either True stopdiscovery or FalseField Description Services for which resources should not be discovered. Available services are servicestostopdiscovery ComputeEngine, CloudStorage, CloudFilestore and KubernetesEngine. If this option is not used, then the value should be False. Sample Request http://localhost:9591/AppManager/xml/AddMonitor? apikey=0da3949052acdcda12fa00200ae1170e&type=GoogleCloudPlatform&displayname=GCP&GCPServi ces=ComputeEngine,CloudStorage,CloudFilestore,KubernetesEngine&ProjectID=black-agility- 235006&provider=gcp&advancedsettings=True&deletedresourceaction=Stop&stopdiscovery=False&servic estostopdiscovery=False Microsoft 365 Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&Office365TenantName= [OFFICE365TENANTNAME]&Office365Useremail=[ADMINEMAIL]&Office365Password= [PASSWORD]&Office365Services=[OFFICE365SERVICES]&displayname=[DISPLAYNAME]&Timeout= [TIMEOUT]&ServiceHealth=[SERVICEHEALTH]&TenantID=[TENANTID]&ClientID=[CLIENTID]&ClientSecret= [CLIENTSECRET] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be Office365. Office365TenantName The tenant name used by the Microsoft 365 subscription. Office365Useremail The Microsoft 365 user email with admin privileges. Office365Password The Microsoft 365 user account password. Required services to monitor. Supported services are Office365Services "ExchangeOnline,SharepointOnline,SkypeForBusinessOnline,MicrosoftTeams" Timeout The Timeout interval in seconds. ServiceHealth Option to enable Service Health monitoring. (True or False) TenantID Tenant ID of the tenant in which the application is created. ClientID Client ID/Application ID of the application created ClientSecret Client Secret created in the application created. Sample Request http://prod-server2:9098/AppManager/xml/AddMonitor? apikey=4c362569ccc528be78fafdcc2317bc5c&type=Office365&Office365TenantName=appmanager&Offic e365Useremail=apm@appmanager.onmicrcosoft.com&Office365Password=test123&Office365Services=Ex changeOnline,SharepointOnline,SkypeForBusinessOnline,MicrosoftTeams&displayname=officemonitor&Ti meout=600&ServiceHealth=True&TenantID=lasnfklasf&ClientID=aknlasldald&ClientSecret=jkansdnasjndlas n AddMonitor APIs - Custom Monitors This section explains how to use the AddMonitor API to add monitors of the category type ''Custom Monitors''. The following monitors are supported: Windows Performance Counters Database Query MonitorFile/Directory Monitor Script Monitor Windows Performance Counters Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&pollinterval= [POLLINTERVAL] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common request parameters. Field Description         type The type of the monitor you want to add. Value should be Windows Performance Counters. host The name of the host where the Windows Performance Counters is running. username The user name of the host running Windows Performance Counters. password The password of the host running Windows Performance Counters. pollinterval The interval at which you want the polling to happen. Sample Request http://app-xp4:9090/AppManager/xml/AddMonitor? apikey=ee8d8e237bd5e1a0d8aed16a381c3b73&type=Windows Performance Counters&host=app- xpmll&displayname=hhhh&username=asasaa&password=admin123 Database Query Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&databasetype=[DATABASETYPE]&databasename=[DATABASENAME]&SSLEnabled=[SSL ENABLED]&showqueryoutput=[SHOWQUERYOUTPUT]&queries=[QUERIES] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of monitor you want to add. Value should be QueryMonitor. host The name of the host where the databae server is running. port The port number where the database is running username The user name of the database server. password The password of the database server. databasetype The database type for which the query is executed. databasename The name of the database server. SSLEnabled Option to enable SSL. Possible values are either true or false. showqueryoutput Option to specify whether you prefer query output. Values are yes or no queries Denotes the database query. There can be a maximum of five queries.Sample Request http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=bbab7f01458e96595b06d5c27efcc3af&type=QueryMonitor&displayname=qury&host=app- xp2&port=1433&username=sa&password=Advent1&databasetype=MsSQL&databasename=AMDB&SSLEnab led=true&showqueryoutput=yes&queries=select * from user File/Directory Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&filepath=[FILEPATH]&serversite=[SERVERSITE]&pollinterval=[POLLINTERVAL]&timeout= [TIMEOUT]&fileDirAge=[FILEDIRAGE]&checkAvailability=[CHECKAVAILABILITY]&contentChk= [CONTENTCHK]&filterFiles=[FILTERFILES] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         type The type of monitor you want to add. Value should be File Monitor or Directory Monitor. Specifies whether the file/directory to be monitored is located on the Local or Remote serversite server. (local or remote) filepath Absolute path of the file/directory to be monitored. fileDirAge Option to perform file/directory age check. (on or off) The monitor availability to be set if the file/directory is MODIFIED or NOT MODIFIED within a selectMonStatus certain time. (up or down) The file/directory change type for which the configured monitor availability should be set. Possible values are: selectChangeType 0 - When file/directory is not modified 1 - When file/directory is modified timeVal Amount of time for which the file/directory age should be checked. timeUnit The time unit for which the file/directory age should be checked. Alerts when the file/directory does not exist in the specified location (on or off). Default checkAvailability value is on. If the File / Directory to be monitored is in the Remote Server, you can choose the host by choosehost providing the host ID if the host was already added or using the value -1 to add a new host. host The name of the host where the File Monitor is running. monitoringmode Specifies the Mode Of Monitoring (WMI for Windows, Telnet/SSH for Linux) username The username to connect with the host. password The password for the new host username. The Command Prompt to connect in the Telnet/SSH mode. Specify the command prompt prompt value, which is the last character in your command prompt port The port number where the File/Directory Monitor is running. Default value is 23. contentChk Specifies whether content check needs to be configured. (on or off) The File Parsing Options to perform content check. Possible Values are: fileCheckType 0 - Perform content check to only appended content. 1 - Perform content check to the whole file. ccontent The string for which you want to check content matching. Content should be specified in JSON array format as: [{"severityCriteria":contentMatchSeverity, "contents": actualContent, "isRegex":regexCheck, "ruleType":ruleNum, "caseSensitive":caseSensitiveCheck,,"matchWholeWord":matchWholeWord}] Parameter Description The severity to be set when content match occurs. Possible values are: 0 - Availability Down contentMatchSeverity 1 - Availability Up 2 - Health Critical 3 - Health Warning 4 - Health Clear actualContent The actual content that needs to be matched. Specifies whether Regex match should be performed. (true or regexCheck false) ruleNum The number of contents that are to be matched. Specifies whether exact content match should be performed. caseSensitiveCheck (true or false) Specifies whether content match should be performed for the matchWholeWord whole word. (true or false) clearAlerts Specifies whether monitor status should be cleared when file is not modified. (on or off) You can set the monitor status to UP / DOWN if any/all of the contents/Regular Expressions are matched. Possible values are: selectRuleType any - Set monitor status when any of the contents/Regular Expressions is matched. all - Set monitor status when all of the contents/Regular Expressions are matched. The condition to filter files in the directory. Filtering conditions should be specified in JSON array format as: {"filepattern":"[FILE PATTERN]", "category":"[CATEGORY]", "condition":"[CONDITION]", "value":[VALUE], "unit":"[UNIT]", ,"alertSeverity":[SEVERITY]} Parameter Description filepattern Regular expression for the file pattern (such as *.txt or *.zip) Indicates the parameters based on which the files need to be filtered. Possible values include: category size - Size mod - Last Modified Time create - Created time (supported only for Windows directory) Indicates the filter condition. Possible values are: filterFiles condition LT - Lesser than GT - Greater than Indicates the value specified for the filter condition. Specified value should value be a positive integer. The unit for the value specified. Posssible values are either unit Bytes/KB/MB/GB (for Size filter category) or Minutes/Hours (for Last Modified Time and Created Time filter categories) The alert severity to be set when filtering conditions are met. Possible values are: 0 - Availability Down alertSeverity 1 - Availability Up 2 - Health Critical 3 - Health Warning 4 - Health ClearSample Request File Monitoring For a Local File: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=cb4078d8e8ef6859139d3727e6e6991e&type=File%20Monitor&displayname=test12345&filepath=D: \test.txt&serversite=local&pollinterval=5&timeout=60&fileCheckType=1&selectRuleType=all For a Remote File: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=1bbab7f01458e96595bb3eff62f0&type=File Monitor&displayname=test7&filepath=F:\LATEST\AppManager\logs\stdout.txt&serversite=remote&pollinter val=5&timeout=60& choosehost=-1&monitoringmode=WMI&host=app-support- w7&username=administrator&password=Apmsupport1 For a Local File when Content Check is enabled: http://prod-server8:9090/AppManager/AppManager/xml/AddMonitor? apikey=45d321201d8393b02a643a69f31197cf&type=File%20Monitor&displayname=test12345&filepath=D:\ test.txt&serversite=local&pollinterval=5&timeout=60&contentChk=on&fileCheckType=1&ccontent= [{"severityCriteria":"1", "contents": ["error", "exception"], "isRegex":"false", "ruleType":"1", "caseSensitive":true,"matchWholeWord":true}]&fileCheckType=whole&selectStatusType=down&selectRuleT ype=all For a Remote File when Content Check is enabled: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=6a3803a905cbbab7f01458e96595b856&type=File Monitor&displayname=test12&filepath=C:\Test\Grep.txt&serversite=remote&pollinterval=5&timeout=60&co ntentChk=on& ccontent=Exception&fileCheckType=whole&selectStatusType=down&selectRuleType=all&choosehost=-1& monitoringmode=WMI&host=app-xp2&username=asasaa&password=001 When both file/directory age check and content check are enabled: http://prod-server8:9090/AppManager//AppManager/xml/AddMonitor? apikey=1561056503f5164180f042db3eff62f0&type=File Monitor&displayname=test6&filepath=F:\LATEST\AppManager\logs\stdout.txt&serversite=local&pollinterv al=5&timeout=60& fileDirAge=yes&selectMonStatus=down&selectChangeType=notmodified&timeval=50&timeUnit=Minutes&c ontentChk=on& ccontent=test&fileCheckType=whole&selectStatusType=down&selectRuleType=any&countval=3 Directory Monitoring For a Local Directory: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=cb4078d8e8ef6859139d3727e6e6991e&type=Directory Monitor&displayname=testAPI&filepath=E:\temp&serversite=local&pollinterval=5&timeout=60&checkAvaila bility=on For a Remote Directory: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=1bbab7f01458e96595bb3eff62f0&type=Directory Monitor&displayname=testAPI4123&filepath=D:\test123&serversite=remote&monitoringmode=WMI&choose host=-1&host=172.20.18.187&username=uname&password=pswd123&pollinterval=5&timeout=60&checkAvai lability=on For a Local Directory when Filter Files is enabled:http://prod-server8:9090/AppManager/AppManager/xml/AddMonitor? apikey=45d321201d8393b02a643a69f31197cf&type=Directory Monitor&displayname=testAPI&filepath=E:\temp&serversite=local&pollinterval=5&timeout=60&checkAvaila bility=on&filterFiles= {"condition":"GT","unit":"Minutes","alertSeverity":1,"filepattern":"*.txt","category":"mod","value":5} For a Remote Directory when Filter Files is enabled: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=6a3803a905cbbab7f01458e96595b856&type=Directory%20Monitor&displayname=testAPI4123&fil epath=D:\test123&serversite=remote&monitoringmode=WMI&choosehost=-1&host=172.20.18.187&username =uname&password=pswd123&pollinterval=5&timeout=60&checkAvailability=on&filterFiles= {"condition":"GT","unit":"Minutes","alertSeverity":1,"filepattern":"*.txt","category":"mod","value":5} Script Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[Script Monitor]&displayname= [DISPLAYNAME]&serverpath=[SERVERPATH]&workingdirectory=[FILEPATH]&serversite= [LOCAL/REMOTE]&pollinterval=[POLLINTERVAL]&timeout=[TIMEOUT] Request Parameters The mandatory parameters involved in the API request are described below. Also, refer to the list of common request parameters. Mandatory Value Description         parameters Script type The type of the monitor you want to add. Value should be Script Monitor. Monitor displayname   Display name of the monitor serverpath   The path of the script file in the server, to be monitored  workingdirectory   The directory in which the script will be executed serversite local/remote Specifies whether the script to be monitored is on the Local or Remote Server. pollinterval   Set the Polling Interval. By default, it is 5 minutes Specify the Timeout value in seconds. The value can be the maximum time timeout   taken by the script to execute. To choose the Script Location as command, use the keyword isCommand   "isCommand=true" in the API call. globalseverity true/false Option to affect health when exception occurs. If Remote Server option is selected, the parameters are: Field Value Description         The name or IP address of the host where the script monitor is host   running. Specifies the Mode Of Monitoring. ( Telnet/SSH for Linux and monitoringmode TELNET/SSH/POWERSHELL Powershell for Windows) For new host, use -1, else use id value from the query ''select * choosehost -1/hostid from AM_SCRIPTHOSTDETAILS'' port 23/22 The port number. username   The username to add a new host. password   The password to add a new host. The SSH Key for SSH authentication. Public Key Authentication sshkey on/off (Supported for SSH2 only). Default value: off passphrase   The passphrase for key based authentication for SSH. prompt   The Command Prompt to connect in the Telnet/SSH mode.Specify the command prompt value, which is the last character in your command prompt. Default value is $ mode sh Enter the mode. The default value will be ''sh'' description   Private key If the Output Settings enabled, the parameters are: Field Value Description         opfile true/false Specify if you want to Get output from file. outputfile   Specify the path of the output file string_att   Enter the String attributes numeric_att   Enter the Numeric attributes Enter the value of Delimiter used in the output file. By default, it is "=". If you don''t delimiter   specify a delimiter, then ''space'' would be considered as a delimiter. If Tables in output file is enabled, the parameters are: Field Value Description         tablepresent on/off Output Settings. Default value: off table_row   Number of rows in the table  table   Table name numericatt   Numeric attribute stringatt   String attribute pcatt   Unique column cdl   Column delimiter message   Arguments pollinterval   Polling interval timeout   Time out manageTableRow retain/delete/unmanage Options to manage table row. (retain, delete, or unmanage) healthTableRow critical/warning/clear Options to manage table data. (critical, warning, or clear) Sample Request For a local server: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=1561056503f5164180f2db3eff62f0&type=Script Monitor&displayname=test1&serverpath=F:\AppManager\bin\CkServerConnection.bat&workingdirectory= F:\Managed\AppManager\bin\&serversite=local&pollinterval=5&timeout=30&globalseverity=true For a remote server: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=151056503f5164180f2db3b3eff62f0&type=Script Monitor&displayname=test2&serverpath=/home/likewise-open/ZOHOCORP/prodserver- 9091/test.sh&workingdirectory=/home/ZOHOCORP/prodserver- 9091&serversite=remote&pollinterval=5&timeout=60&choosehost=-1&monitoringmode=SSH&host=prodser ver-9091&username=prodserver-9091&password=Zoho123&prompt=$&port=22&globalseverity=true For a Command type script: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=a0c6b6d593637f737f34dab03132faca&type=Script Monitor&displayname=testAPI222&serverpath= echo helo&workingdirectory=/home/test&serversite=remote&pollinterval=5&timeout=60&choosehost=5&isCom mand=true&globalseverity=true With Output Settings enabled (Give new line with %0A):http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=1561003f5164180f280f042db3eff62f0&type=Script Monitor&displayname=test3&serverpath=F:\AppManager\bin\ChkServerConnection.bat&workingdirectory= F:\AppManager\bin\&serversite=local&pollinterval=5&timeout=60&opfile=true&outputfile=F:\AppManager\ bin\result.txt& string_att=Name1,Name2&numeric_att=Age1,Age2&delimiter==&globalseverity=true With the tables in output file enabled: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=1561056503f5164180f042db3eff62f0&type=Script Monitor&displayname=test3&serverpath=F:\AppManager\bin\ChkServerConnection.bat&workingdirectory= F:\AppManager\bin\ &serversite=local&pollinterval=5&timeout=60&opfile=true&outputfile=F:\AppManager\bin\result.txt& string_att=Name1,Name2&numeric_att=Age1,Age2&delimiter==&tablespresent=on&table_row=1& table1=Test1&numericatt1=Num1&stringatt1=Str1&pcatt1=Num1&cdl1=|&manageTableRow=delete&healthTa bleRow=critical&globalseverity=true AddMonitor APIs - Database Servers This section explains how to use the AddMonitor API to add monitors of the category type ''Database Servers''. The following databases are supported: IBM DB2 IBM Informix Memcached MS SQL MySQL Oracle Oracle NoSQL PostgreSQL Sybase ASE/SAP ASE/Sybase SQL Server SAP HANA Cassandra Redis MongoDB CouchBase HBase Neo4j SQL Anywhere Sybase Replication Server IBM DB2 Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance= [INSTANCE]&useSSL=[true/false] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be db2.username The user name of the user who has permission to access the DB2 database. host The name of the host in which DB2 is running. password The password of the user who has permission to access the DB2 database. port The port number where DB2 is running. instance The database/instance name. useSSL Indicates whether SSL is enabled for the DB2 server. (true or false) Sample Request http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5 &type=db2&displayname=appmanagerdb2&username=db2admin&host=app- xp4&password=admin&port=50000&instance=SAMPLEDB&useSSL=true IBM Informix Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=type&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&informixserver=[DATABASE SERVER NAME]&username= [USERNAME]&password=[PASSWORD] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be Informix. username The user name of the user who has permission to access the Informix database. host The name of the host in which the Informix database is running. password The password of the user who has permission to access the Informix database.. port The port number where the Informix database is running. instance The database/instance name. informixserver The name of your Informix server. By default, the name will be ol_machinename. Sample Request http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=f5297a51be2f6f962a5cdbd68521ee61&type=Informix&displayname=test&hostname=app-win7-64- 1&port=9088&username=informix&password=informix&informixserver=ol_informix1210 Memcached Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&Transaction=[TRANSACTION] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be Memcached.host The name of the host in which Memcached server is running. port The port number where Memcached server is running. Transaction Denotes if transaction test is enabled or not. Value should be either yes or no Sample Request http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98 &type=Memcached&displayname=mem_test&host=app-linux2&port=11211&Transaction=yes MS SQL Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port= [PORT]&namedInstance=[true/false]&instance=[INSTANCE]&authentication= [AUTHENTICATION]&encryption=[true/false]&kerberos=[true/false]&driverType= [microsoftjdbcdriver/jtdsjdbcdriver] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be ms sql. username The name of the user who has permission to access the MS SQL server. host The name of the host in which MS SQL is running. password The password of the user who has permission to access the MS SQL server. port The port number where MS SQL is running. instance The database/instance name. This is optional field. authentication The authentication type. Value should be either SQL or Windows. namedIntance If the SQL server is a named instance, this value will be true. encryption If ''Force Encryption'' is enabled in the server, this value will be true. kerberos Indicates whether Kerberos Authentication is enabled in the server. (True or False) The driverType has to be mentioned as microsoftjdbcdriver or jtdsjdbcdriver in order to choose driverType the required driver for connecting to the database for data collection. This is optional and the default driver is microsoftjdbcdriver. NOTE: If you are adding SQL Server 2008 or 2008 R2 version, then the driverType option should be jtdsjdbcdriver since support for SQL 2008 & 2008 R2 has been removed in the current version of Microsoft JDBC Driver. Sample Request http://prod-server7:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=MS SQL&displayname=appmanagermssql&username=sa&host=app- xp2&password=Advent1&port=1433&namedInstance=true&instance=MSSQLSERVER&authentication=SQL&e ncryption=true&kerberos=true&driverType=jtdsjdbcdriver MySQL Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance= [INSTANCE]&authentication=[AUTHENTICATION]&useSSL=[true/false]Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be mysql. username The name of the user who has permission to access the MySQL server. host The name of the host in which MySQL is running. password The password of the user who has permission to access the MySQL server. port The port number where MySQL is running. instance The database/instance name. This is optional field. authentication The authentication type. Value should be SQL Enabling this option will force the server to authenticate in both ways (i.e client-auth and server- useSSL auth). This is optional. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=mysql&displayname=appmanagermysql&username= root&host= shakthiprian&password=appmanager&port=13329&instance=mysql&authentication=SQL&useSSL=true Oracle Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance= [INSTANCE]&SSLEnabled=[isSSLEnabled]&discoverPDB=[DiscoverPDB]&oracleSocketTimeout= [SocketReadTimeout]&oracleQueryTimeout=[QueryExecutionTimeout] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be oracle. username The name of the user who has permission to access the Oracle database. host The name of the host in which Oracle is running. password The password of the user who has permission to access the Oracle database. port The port number where Oracle is running. instance The database/instance name. This is optional field. SSLEnabled True if the SSL is enabled otherwise the value is false. discoverPDB Option to enable discovery and monitoring of Pluggable Database(s). (yes or no) oracleSocketTimeout Socket Read Timeout value for database connection. Default value is 300 seconds. Query Execution Timeout value during data collection query execution. Default value is oracleQueryTimeout 60 seconds. Sample Request http://prod-server7:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=oracle&displayname=appmanageroracle&username =rajesh&host=swissql-xp1&password=rajesh&port=1521&instance=orcl&SSLEnabled=false&discoverPDB=yes&oracleSocketTimeo ut=300&oracleQueryTimeout=60 Oracle NoSQL Syntax http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey= [apikey]&type=OracleNoSQL&displayname=[Displayname]&HostName=[HostName]&Port= [Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey API key to create the Oracle coherence monitor type The type of the database you want to add. Value should be coherence. displayname Display name of the Oracle coherence monitor hostname The name of the host in which Oracle coherence is running. port The port number where Oracle is running. username The name of the user who has permission to access the Oracle coherence database. password The password of the user who has permission to access the Oracle coherence database. JNDIPath JNDI path to be used Sample Request http://Prod-server7:9010/AppManager/xml/AddMonitor? apikey=0b719d6a4a564c8be86fbc60d3f0b996&type=OracleNoSQL&displayname=OracleNoSQL&HostNa me=APP-W8-AIO-5&Port=5000&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi PostgreSQL Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&instance=[INSTANCE] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be PostgreSQL. host The name of the host in which PostgreSQL is running. port The port number where PostgreSQL is running. username The name of the user who has permission to access the PostgreSQL database. password The password of the user who has permission to access the PostgreSQL database. instance The database/instance name. This is optional field. SSLEnabled True if the SSL is enabled otherwise the value is false.Sample Request http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98 &type=PostgreSQL&displayname=postSQL&host=app- xp2&port=5432&username=postgres&password=postgres&instance=postgres&SSLEnabled=false Sybase ASE/SAP ASE/Sybase SQL Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance= [INSTANCE]&jconnect=[JCONNECT] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be SYBASE-DB-server. host The name of the host in which Sybase is running. port The port number where Sybase is running. username The name of the user who has permission to access the Sybase database. password The password of the user who has permission to access the Sybase database. instance The database/instance name. This is optional field. jconnect Option to connect using JConnect to collect data. (true or false) Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5 &type=SYBASE-DB-server&displayname=appmanagersybase&username=sa&host=app- xp3&password=&port=5000&instance=master&jconnect=true SAP HANA Syntax To Monitor OnPremise System: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SapHana&displayname= [DISPLAYNAME]&host=[HOST]&isOndemand=false&port=[PORT]&dbuser=[DB_USERNAME]&dbPassword= [DB_PASSWORD]&instance=[INSTANCE] To Monitor OnDemand System: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SapHana&displayname= [DISPLAYNAME]&host=[HOST]&isOndemand=true&accountName=[ACCOUNT_NAME]&username= [USER_NAME]&password=[ACCOUNT_PASSWORD]&dbuser=[DB_USERNAME]&dbPassword= [DB_PASSWORD]&instance=[INSTANCE] Request Parameters Field Description Hostname/ Landscape Host as given in https://help.hana.ondemand.com/help/frameset.htm? Host 350356d1dc314d3199dca15bd2ab9b0e.htmlPort IndexServer SQL Port. Default 30015. [Required only for On Premise Setup] isOndemand Value is true for On Demand setup, false for On Premise setup. accountName On demand CLoud Account Name. [Required only for On demand Setup] username UserName for the cloud account. [Required only for On demand Setup] password Password for the cloud account. [Required only for On demand Setup] dbUser Database User Name dbPassword Database Password nstance Instance Name Sample Request http://app-support-w7:9090/AppManager/xml/AddMonitor? apikey=151c7e98b0f2a3cbc44fbd56ec66a6c9&displayname=RestHana&type=SapHana&host=hanatrial.on demand.com& isOndemand=true&accountName=s0004447540trial&username=s0004447540&password=Zoho@123&db User=SYSTEM& dbPassword=Zoho@1234&instance=mdchana HBase Syntax http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=HBase&displayname= [Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password= [Password]&JNDIPath=/jmxrmi Request Parameters The parameters involved in the API request are described below.Also, refer to the list of common request parameters. Field Description apikey API key to create the HBase monitor type The type of the database you want to add. Value should be HBase displayname Display name of the HBase monitor hostname The name of the host in which HBase is running. port The port number where HBase is running. username The name of the user who has permission to access the HBase database. password The password of the user who has permission to access the HBase database. JNDIPath JNDI path to be used Sample Request http://Prod-server7:9010/AppManager/xml/AddMonitor? apikey=0b719d6a4a564c8be86fbc60d3f0b996&type=HBase&displayname=HBase&HostName=APP-W8- AIO-5&Port=5000&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi Cassandra Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=Cassandra&displayname=Cassandra&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be ''Yes'']&authRequired= [non mandatory column, if given the value should be ''true'']&username=[username]&password=[password]Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be Cassandra. host The name of the host in which Cassandra database is running. port The port number where Cassandra database is running. username The name of the user who has permission to access the Cassandra database. password The password of the user who has permission to access the Cassandra database. Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is discoverclusternodes not mandatory. authRequired Specify if authentication is required. Value can be True/False. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=849c51ce33436587873a08d69d5447fc&type=Cassandra&displayname=Cassandra&host=172.20.7.3 6&port=7199& username=&password=123 Redis Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Redis&displayname=Redis&host= [Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be ''Yes'']&authRequired=[non mandatory column, if given the value should be ''true'']&password=[password] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be Redis. host The name of the host in which Redis is running. port The port number where Redis is running. username The name of the user who has permission to access the Redis database. password The password of the user who has permission to access the Redis database. Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is discoverclusternodes not mandatory. authRequired Specify if authentication is required. Value can be True/False. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=849c51ce33436587873a08d69d5447fc&type=Redis&displayname=Redis&host=172.20.6.200&port= 6379&password=123 MongoDB Syntaxhttp://[Host]:[Port]/http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=MongoDB&displayname=MongoDB&host=[Host Name]&port=[Port Number]&discoverchildren=[non mandatory column, if given the value should be ''Yes'']&authRequired=[non mandatory column, if given the value should be ''true'']&username=[username]&password=[password] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be MongoDB. host The name of the host in which MongoDB is running. port The port number where MongoDB is running. username The name of the user who has permission to access the Mongo database. password The password of the user who has permission to access the Mongo database. Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is discoverclusternodes not mandatory. authRequired Specify if authentication is required. Value can be True/False. discoverchildren Values can be true/false. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=849c51ce33436587873a08d69d5447fc&type=MongoDB&displayname=MongoDB&host=172.20.6.2 00&port=6379&password=123 CouchBase Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &host=[HOST]&port=[PORT] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be CouchBase. displayname The display name of the Couchbase database. host The name of the host in which CouchBase is running. port The port number where CouchBase is running. Sample Request http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=3a45dc93b4eb6d7fbefe550e4a2a7c6c&type=Couchbase&displayname=Couchmonitoring&host=a pp-win7-64-4.csez.zohocorpin.com&port=8091">http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=3a45dc93b4eb6d7fbefe550e4a2a7c6c&type=Couchbase&displayname=Couchmonitoring&host=a pp-win7-64-4.csez.zohocorpin.com&port=8091 Neo4jSyntax http://[Host]:[PORT]/AppManager/xml/AddMonitor?apikey=[ API KEY ]&type=Neo4j&displayname= [DISPLAYNAME]&HostName=[Host]&Port=[Port]&UserName=[UserName]&Password= [Password]&DiscoverNode=yes/no Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be Neo4j. HostName The name of the host in which Neo4j is running. Port The bolt port number where Neo4j is running. UserName The name of the user who has permission to access the Neo4j database. Password The password of the user who has permission to access the Neo4j database. Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not DiscoverNode mandatory. Sample Request http://localhost:9090/AppManager/xml/AddMonitor? apikey=21ca68ece3dfc1bab0fa100b2c4f90cb&type=Neo4j&displayname=DISPLAYNAME&HostName=app- w8-aio-5&Port=7687&UserName=neo4j&Password=admin&DiscoverNode=yes SQL Anywhere Syntax http://[Host]:[port]/AppManager/xml/AddMonitor?apikey=[Key]&type=[type]&displayname= [DisplayName]&username=[userid]&host=[Host]&Password=[password]&port=[port] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be SQLAnywhere-DB-server. displayname Display name of the monitor. username The name of the user who has permission to access the SQL Anywhere database. host The name of the host in which SQL Anywhere server is running. Password The password of the user who has permission to access the SQL Anywhere database. port The port number where SQL Anywhere is running. Default port is 2638. Sample Request http://localhost:9096/AppManager/xml/AddMonitor? apikey=94e214da57134e2c57ce7c7ec4b523a8&type=SQLAnywhere-DB-server&displayname=sqlanywhere- demo&username=dba&host=hostname&Password=sql&port=2638 Sybase Replication Server Syntaxhttp://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance= [INSTANCE] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be SYBASE-Replication-server. host The name of the host in which Sybase Replication server is running. port The port number where Sybase Replication server is running. username The name of the user who has permission to access the Sybase Replication server. password The password of the user who has permission to access the Sybase Replication server. instance The database/instance name of the Sybase Replication server. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5 &type=SYBASE-Replication- server&displayname=appmanagersybaseRepServer&username=srpsuname&host=app- xp3&password=srpspass&port=5000&instance=master AddMonitor APIs - ERP This section explains how to use the AddMonitor API to add monitors of the ''ERP'' category type. The following monitors are supported: Oracle EBS SAP Server SAP CCMS Siebel Enterprise Server Microsoft Dynamics CRM / 365 (On-Premise) Microsoft Dynamics AX SAP Business One Oracle EBS Syntax For versions R11i and R12.0: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[SSL]&Version=[version] For versions R12.2.0, R12.2.5 & above (Username and Password Mandatory): http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[SSL]&Version=[VERSION]&Username= [USERNAME]&Password=[PASSWORD] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters.Field Description type The type of the ERP server you want to add. Value should be OracleEBS. host The name of the host in which Oracle EBS is running. port The port number where the Oracle EBS is running. SSL Indicates if SSL option is enabled. The value should be either yes or no. Version The running version of the Oracle EBS (R11i, R12.0, R12.1.3, R12.2.0, R12.2.5 & above). Username Username of the EBS admin server. Password Username of the EBS admin server. Sample Request: http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=4df5040d6db873dcdaf4359b259fd494&type=OracleEBS&displayname=oebs&host=app- xp2&port=80&SSL=no&version=r12.2.5&Username=uname&Password=pswd SAP Server Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&systemnumber= [SYSTEMNUMBER]&logonClient=[LOGONCLIENT]&language=[LANGUAGE]&routerString=[ROUTERSTRING] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         type The type of the ERP server you want to add. Value should be sap server. host The name of the host in which SAP server is running. username The user name used for accessing the SAP server. password The password of the SAP server. systemnumber The SAP system number. logonClient The SAP logon client. language The SAP logon language. Default value is en. routerString The SAP Router String through which SAP Server is connected.(Optional) Sample Request: http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=sap server&displayname=appmanagersap&host=app- xp1&username=BCUSER&password=minisap&systemnumber=00&logonClient=000&language=en&routerSt ring=/H/it360-m4600-1 SAP CCMS Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &host=[HOST]&username=[USERNAME]&password=[PASSWORD]&systemnumber= [SYSTEMNUMBER]&logonClient=[LOGONCLIENT]&language=[LANGUAGE]&monitorset=[MONITOR SET NAME]routerString=[ROUTERSTRING]Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         type The type of the ERP server you want to add. Value should be SAP CCMS. host The name of the host in which SAP server is running. username The user name used for accessing the SAP server. password The password of the SAP server. systemnumber The SAP system number. logonClient The SAP logon client. language The SAP logon language. Default value is en. monitorset The CCMS Monitor Set name. routerString The SAP Router String through which SAP Server is connected.(Optional) Sample Request: http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=86f7324e6e1651f704da21f6c119d8a4&type=SAP CCMS&displayname=appmanagersapccms&host=amp-2k8r2- 2&username=BCUSER&password=minisap1&systemnumber=00&logonClient=001&language=en&monitors et=SAP CCMS Technical Expert Monitors&routerString=/H/it360-m4600-1 Siebel Enterprise Server Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&snmptelnetport= [PORT]&displayname=[DISPLAYNAME]&HostName=[HOSTNAME]&mode=[SSH/WMI]&userName= [USERNAME]&password=[PASSWORD]&GatewayServer=[Siebel_gateway_server_name]&EnterpriseServer= [Enterprise_server]&SUserName=[Siebel_admin_username]&SPassword= [Siebel_admin_password]&InsDirectory=[Siebel_installation_directory_absolute_path]&prompt= [$/#/>]&timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         type The type of the ERP server you want to add. Value should be SiebelEnterpriseServer. displayname The display name of the Siebel Server. HostName The name of the host in which Siebel server is installed. snmptelnetport The port on which Siebel server is installed. mode The mode of monitoring specified for the server. (SSH or WMI) userName Siebel-installed server username (user role with executable permission). password Siebel-installed server password. GatewayServer The Siebel gateway server name. EnterpriseServer The Siebel enterprise server. SUserName The Siebel administrator username. SPassword The Siebel Administrator password InsDirectory The directory where Siebel is installed. prompt The bash prompt for unix based servers. ($,#, or >) timeout The timeout value, in minutes.Sample Request: http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=817f0d4d4ae2edc2e3ee6b9aa27d0601&type=SiebelEnterpriseServer&displayname=test&HostNam e=aixserver&snmptelnetport=22&mode=wmi&userName=root&password=a1X6Bm&GatewayServer=gate&E nterpriseServer=ent&SUserName=sadmin&SPassword=sadmin&InsDirectory=/home/guest/ramac&prompt= #&timeout=10 Microsoft Dynamics CRM / 365 (On-Premise) Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOSTNAME]&Version=[VERSION NO]&username=[USERNAME]&password= [PASSWORD]&eventlog=[YES/NO]&pollinterval=[INTERVAL] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. The value should be Microsoft Dynamics CRM. host The Host Name or IP Address of the host where the Dynamics CRM/365 application runs. displayname The Display Name of the Dynamics CRM/365 monitor. The UserName of the Host Machine. To monitor a Microsoft Dynamics CRM/365 application, use UserName Administrator user account which has the permission to excute WMI queries on ''root\CIMV2'' namespace of the Dynamics CRM/365 Server. password The password of the above user who has the permissions to execute WMI Queries. The version of the Dynamics CRM/365 Application. Possible values are: 2011, 2013, 2016 or Version Dynamics365 Sample Request: http://prod-server6:9090/AppManager/xml/AddMonitor? apikey=1f9323d96809a1ff38c941e575b9507a8a&type=Microsoft Dynamics CRM&displayname=API CRM&host=192.18.3.75&Version=2013&username=apmcluster2012\administrator&password=pass&eventlo g=NO&pollinterval=5 Microsoft Dynamics AX Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST NAME]&Version=[VERSION NO]&UserName=[USERNAME]&Password= [PASSWORD]&AXServices=[AX SERVICES]&remoteSQL=[True/False]&SQLhostname=[SQL HOSTNAME]&SQLcredentialdetails=[SQL CREDENTIAL DETAILS]&SQLusername=[SQL USERNAME]&SQLpassword=[SQL PASSWORD]&pollinterval=[INTERVAL] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. The value should be MSDynamicsAX.displayname .The display name of the AX application. host The hostname or IP address of the host where the AX server runs. Version The version of the Dynamics AX Application. UserName The UserName of the AX server machine. Password The password of the AX Server Machine. AXServices The services to be monitored. (AOS, MSSQLSERVER, RpcSs, IISADMIN) remoteSQL Denotes whether MSSQL is in remote server. (True/False) SQLhostname The hostname of the remote SQL server. Choose whether to use the credentials of AX server or to enter new credentials for SQL SQLcredentialdetails server. (AXcred/SQLcred) SQLusername The username of the remote SQL server. SQLpassword The password of the remote SQL server. Sample Request http://prod-4409:9210/AppManager/xml/AddMonitor? apikey=aca1b8f2f109e319f46733675983e847&type=MSDynamicsAX&displayname=AXTest&host=user- 4409&Version=2012&UserName=user- 4409&Password=Qwerty@123&AXServices=AOS,MSSQLSERVER,RpcSs,IISADMIN&remoteSQL=True&SQLh ostname=user-4016&SQLcredentialdetails=SQLcred&SQLusername=user- 4016\administrator&SQLpassword=Abcd@123&pollinterval=5 SAP Business One Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST NAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. The value should be SAPBusinessOne. displayname The display name of the integration framework. host The hostname or IP address of the integration framework. port The port number at which the integration framework is running. username The username of the integration framework. password The password of the integration framework. Sample Request http://prod-4409:9210/AppManager/xml/AddMonitor? apikey=aca1b8f2f109e319f46733675983e847&type=SAPBusinessOne&displayname=SAPB1test&host=SAPB1 user-4409&port=8080&username=SAPB1user-4409&password=SAPB1passwd AddMonitor APIs - EUM Monitors This section explains how to use the AddMonitor API to add monitors of the category type End User Monitoring (EUM). The following monitors are supported:Ping DNS LDAP Server Mail Server Telnet The following parameters are common in API requests for EUM monitors: Field Description The display name(s) of the EUM agent(s). If there are multiple entries, they can be comma eumAgents separated. eumAgentsId The unique ID of the EUM agents configured. These can be specified as comma separated. Specifies if the monitor has to be created in Applications Manager. Possible values are ''True'' or runOnServer ''False''   Note: It is not mandatory to use both ''eumAgents'' and ''eumAgentsId'' parameters in the same API request. You can use either one of these. The runOnServer parameter is not applicable for Real Browser Monitor (RBM). Ping Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]&eumAgents=[EUMAGENTS]&eumAgentsId= [EUMAGENTID]&runOnServer=[RUNONSERVER] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the service you want to add. Value should be ''Ping Monitor''. host The host in which the monitor is running. timeout The timeout value in seconds. Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Ping Monitor&displayname=apmping&host=smrithil&timeout=5&eumAgents=eumflorida&runOnServer=True DNS Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&timeout=[TIMEOUT]&SearchField=[SEARCHFIELD]&TargetAddress= [TARGETADDRESS]&LookupAddress=[LOOKUPADDRESS]&RecordType=[RECORDTYPE]&eumAgents= [EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER] Request ParametersThe parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the service you want to add. Value should be ''DNSMonitor''. displayname The display name of the host in which the monitor is running. timeout The timeout value in seconds. The value of SearchField. Options include None, Record Name, Address, Additional Name, SearchField Target, Admin, Host, Alias, Port and Priority. TargetAddress Host Name / IP Address to connect to the service LookupAddress The address you want to check in the DNS Server. The expected record type returned for the lookup address. The options include A, AAAA, RecordType CNAME, MX, NS, PTR, SOA, SPF, SRV and TXT. Sample Request http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=DNSMonitor&displayname=dnstttttt&timeout=15&Sea rchField=Record Name&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A&eumAgents=eum be1&runOnServer=True LDAP Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&username=[USERNAME]&timeout=[TIMEOUT]&LDAPServer= [LDAPSERVER]&LDAPServerPort=[LDAPSERVERPORT]&MatchingAttribute= [MATCHINGATTRIBUTE]&FilterCondition=[FILTERCONDITION]&IsSecured=[ISSECURED]&SearchFilter= [SEARCHFILTER]&SearchResult=[SEARCHRESULT]&SearchBase=[SEARCHBASE]&password= [PASSWORD]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the service you want to add. Value should be ''LDAP Server''. username The user name of the LDAP server. timeout The timeout value in seconds. LDAPServer The name of the LDAP Server. LDAPServerPort The port at which the LDAP server is running. The matching attribute value. Values include cn, uid, sn, displayname, givenname, MatchingAttribute objectclass, dc and ou FilterCondition The value of filter condition. Values include equals, contains and notequals IsSecured Specifies if the connection is secure or not. Value is either yes or no. SearchFilter The value of Search Filter. This field is optional. SearchResult The string value that matches with search results. SearchBase The value of SearchBase. This is mandatory field when adding a LDAP monitor. password The password of the LDAP server. ID for the credential to be used. credentialID Note: Credential ID can be used as an alternative to username and password fields.Sample Request http://operations-server9:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=LDAP Server&displayname=ldap_serverqqqq&username=cn=administrator,cn=users,dc=pmp,dc=com&timeout=1 0&LDAPServer=pmp- 2k8s&LDAPServerPort=389&MatchingAttribute=cn&FilterCondition=equals&IsSecured=no&SearchFilter=&S earchResult=&SearchBase=&Password=admin123123&eumAgents=eumbe1&runOnServer=True Mail Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host=[HOST]&port= [PORT]&displayname=[DISPLAYNAME]&emailid=[EMAILID]&timeout=[TIMEOUT]&authRequired= [AUTHREQUIRED]&sslEnabled=[SSLENABLED]&username=[USERNAME]&password= [PASSWORD]&tlsEnabled=[TLSENABLED]&pollinterval=[POLLINTERVAL]&mailsubject= [MAILSUBJECT]&fetchEnabled=[FETCHENABLED]&fetchType=[FETCHTYPE]&fsHost=[FSHOST]&fsport= [FSPORT]&fsSSLEnabled=[FSSSLENABLED]&fsTLSEnabled=[FSTLSENABLED]&fsUserName= [FSUSERNAME]&fsPassword=[FSPASSWORD]&eumAgents=[EUMAGENTS]&eumAgentsId= [EUMAGENTID]&runOnServer=[RUNONSERVER] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the service you want to add. Value should be ''Mail Server''. host The SMTP host name port The port at which SMTP is running. emailid The email address to which the mail will be sent. timeout The timeout value in seconds. authRequired Indicates if the SMTP requires authentication. Values are ''Yes'' or ''No'' sslEnabled Indicates if the SMTP host should be accessed through SSL. Values are ''Yes'' or ''No'' username The username of the SMTP host password The password of the SMTP host tlsEnabled Denotes whether TLS should be used for SMTP pollinterval The polling interval of the monitor in seconds. mailSubject The message to appear in the subject of the email. fetchEnabled Indicates if the POP/IMAP server should be monitored. Values are ''Yes'' or ''No''. Indicates the service that is monitored. If you want to add POP type, specify the value as 1. If you fetchType want to monitor IMAP server, specify the value as 2. fsHost The host name of the POP/IMAP server fsport The port at which the POP/IMAP server is running. fsSSLEnabled Indicates whether the POP/IMAP server is SSL enabled or not. Values are ''Yes'' or ''No''. fsTLSEnabled Indicates whether TLS should be used for POP/IMAP. Values are ''Yes'' or ''No''. fsUserName The user name of the POP/IMAP server. fsPassword The password of the POP/IMAP server ID for the credential to be used. credentialID Note: Credential ID can be used as an alternative to username and password fields. Sample Requesthttp://operations-server9:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Mail Server&host=smtp1&port=23&displayname=apmsmtp&emailid=admin@yourdomain.com&timeout=5&auth Required=Yes&sslEnabled=Yes&username=guest&password=guest&tlsEnabled=Yes&pollinterval=60&mails ubject=Testing Mail Server&fetchEnabled=Yes&fetchType=1&fsHost=POP1&fsport=110&fsSSLEnabled=Yes&fsTLSEnabled=Yes&f sUserName=admin&fsPassword=admin123123&eumAgents=eum1&runOnServer=True Telnet Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Telnet (EUM)&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&eumAgents= [AGENTNAME]&runOnServer=[RUNONSERVER] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the service you want to add. Value should be Telnet (EUM). host The host name in which the monitor is running. timeout The time out value in seconds. port The port number in which Telnet is running. eumAgents The display name(s) of the EUM agent(s), separated by comma. Specifies whether the monitor has to be created in Applications Manager. (true or runOnServer false) Sample Request http://operation-server2:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Telnet (EUM)&displayname=apmtelnet&host=smrithil&port=23&timeout=2&eumAgents=apm-eum- w7&runOnServer=true Java Runtime - AddMonitor API Here is how you can use the AddMonitor API to add a Java Runtime monitor: Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&jndiurl=[JNDIURL]&jmxEnabled=on&jmxurl= [URL]&authEnabled=on&username=[Username]&password=[Password] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be Java Runtime. host The name of the host where the monitor is running. port The port number where the Java Runtime monitor is running. jndiurl The JNDI name. The default value is jmxrmi.Field Description To enable customized JMX URL, the value of jmxEnabled should be on (jmxEnabled=on). Then, jmxEnabled give the JMX URL as value for the parameter jmxurl (jmxurl=[URL]) jmxurl The customized JMX URL. This parameter can be used only if the value of jmxEnabled is on. To enable authentication, the value of authEnabled should be on. If the value is on, also specify the authEnabled username and password used for authentication. username, If the value for authEnabled is on, also specify the username and password used for password authentication. (username=[Username]&password=[Password]) Sample Request http://op-server5:9090/AppManager/xml/AddMonitor? apikey=4df5040d6db873dcdaf4359b259fd494&type=Java Runtime&displayname=apmjava&host=myesuraj&port=1099&jndiurl=/jmxrmi&jmxEnabled=on&jmxurl= [URL]&authEnabled=on&username=[Username]&password=[Password] AddMonitor APIs - Mail Servers This section explains how to use the AddMonitor API to add monitors of the category type ''Mail Server''. The following monitors are supported: Exchange Server Mail Server Exchange Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &host=[HOST]&username=[USERNAME]&password=[PASSWORD]&version= [VERSION]&ServerRole[2019/2016/2013/2010/2007]=[ServerRole]&UsePowershell= [USEPOWERSHELL]&Timeout=[TIMEOUT] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the mail server you want to add. Value should be Exchange Server. host The name of the host where the Exchange server is running. username The user name for the system in which Exchange server is running. password The password for the system in which Exchange server is running. The Exchange server version. Supported versions are 2003, 2007, 2010, 2013, 2016 and version 2019. ServerRole2019 Supported roles are mbxserver2019 and edgeserver2019. ServerRole2016 Supported roles are mbxserver2016 and edgeserver2016. ServerRole2013 Supported roles are mbxserver2013, casserver2013 and edgeserver2013. Supported roles ServerRole2010 are mbxserver2010, casserver2010, edgeserver2010, hubserver2010 and umserver2010. Supported roles ServerRole2007 are mbxserver2007, casserver2007, hubserver2007, edgeserver2007 and umserver2007. To use powershell for datacollection use “Yes” or else use “No”.This argument is UsePowershell Mandatory. The timeout interval in seconds. Value should be greater than 120 seconds. (Applicable Timeout only in Powershell mode of monitoring)Sample Request http://prod-server6:9090/AppManager/xml/AddMonitor? apikey=2712f158d675135e9b3d81d9efd533c0&type=Exchange Server&displayname=apmexchange&host=emp- ex03&username=exchange\administrator&password=admin123&version=2019&ServerRole2019=mbxserver 2019&UsePowershell=Yes&Timeout=10 Mail Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version= [VERSION] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be Mail Server. host The name of the host where the mail server is running. port The SMTP port number emailid An email id available in the mail server. timeout The time out value in seconds. mailMsg The message to appear in the subject of the email. mailSubject The message to appear in the subject of the mail. smtpauth Use the smtpauth=true option to enable SSL. username If the SMTP server requires authentication, specify the User Name and Password password sslEnabled Use the SSLEnabled=true option to enable SSL. tlsEnabled Use tlsEnabled=true to enable TLS for securing data transmission. popenabled If you with to select POP as the Mail Fetching Server, use popenabled=true. fetchEnabled Specify fetchEnabled=true to Enable POP or IMAP Mail Fetching Server. If the POP/Imap service is in a different host, specify its POP/Imap Port where POP service popPort runs. popUserName If the POP/Imap service is in a different host, provide the authentication details User popPassword Name and Password for the POP service. popSSLEnabled Use popSSLEnabled=true to enable SSL for securing data transmission in POP/Imap popTLSEnabled Use poptlsEnabled=true to enable TLS for securing data transmission in POP/Imap. fetchType Select the Mail Fetching Server. Values are POP and IMAP. fsHost The Mail Fetching Server POP/IMAP Host. fsport The Mail Fetching Server POP/IMAP port. fsSSLEnabled Use the fsSSLEnabled=true option to enable SSL. fsTLSEnabled Use the fsTLSEnabled=true option to enable TLS. Sample Request http://prod-server5:9098/AppManager/xml/AddMonitor?apikey=4c362569ccc528be78fafdcc2317bc5c &type=Mail Server&host=smtp&displayname=apmmail&port=25&emailid=myesura@zohocorp.com&timeout=15&mailM sg=Testing mail server.AddMonitor APIs - Middleware/Portal This section explains how to use the AddMonitor API to add monitors of the category type ''Middleware/Portal''. The following monitors are supported: MS Office SharePoint WebLogic Integration IBM WebSphere MQ Microsoft Message Queue (MSMQ) RabbitMQ Microsoft BizTalk Oracle Tuxedo Microsoft Skype for Business Azure Service Bus Apache ActiveMQ Apache Kafka MS Office SharePoint Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&version=[SHAREPOINT VERSION]&SPType=[SHAREPOINT TYPE]&Powershell=[IS POWERSHELL ENABLED]&Services=[SHAREPOINT SERVICES] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         The type of the monitor you want to add. Value should type be MSOfficeSharePointServer. The Version of Microsoft Office SharePoint Server. Possible values are 2007, version 2010, 2013, 2016 or 2019. host The name of the host where the Office SharePoint server is running. username The user name of the SharePoint server. password The password of the SharePoint server. The SharePoint server type. Possible Values are: SPType Farm -If the server has a Farm setup. SPServer-If the server has a Stand Alone setup. Specifies if Powershell is enabled. Possible values are: Powershell (optional): True - If powershell is enabled. False - If powershell is not enabled. Service (optional): Version Field Name Possible Values ExcelServices / DocumentConversions / 2007 Service OfficeSearchGatherer SharepointServices / ContentDB / 2010 & WebApplication / TimerJobs / AccessServices / Services 2013 InfoPathServices / VisioWebAccess Services / ExcelServices / OfficeSearchGathererVersion Field Name Possible Values SharepointServices / ContentDB / 2016 & WebApplication / TimerJobs / AccessServices / SP2016Services 2019 InfoPathServices / VisioWebAccess Services / SearchServices Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=4df5040d6db873dcdaf4359b259fd494&type=MSOfficeSharePointServer&displayname=ms&host= app- server&username=administrator&password=admin123&version=2010&SPType=SPServer&Powershell=True& Services=SharepointServices,ContentDB,WebApplication,TimerJobs,AccessServices,InfoPathServices,Visio WebAccess Services,ExcelServices,OfficeSearchGatherer WebLogic Integration Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version= [VERSION] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         The type of the monitor you want to add. Value should be WebLogic type Integration. host The name of the host where the WebLogic Integration server is running. port The port number where the WebLogic Integration server is running. username The user name of the WebLogic Integration server . password The password of the WebLogic Integration server. version The WebLogic Integration server version. Value is 8.1 Sample Request: http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=136edbeb3ccb83c6cc71df03ef273313&type=WebLogic Integration&displayname=apm&host=app- server&port=7001&username=weblogics&password=weblogic&version=8.1 IBM WebSphere MQ Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&listenerport=[PORT]&displayname= [DISPLAYNAME]&serverconnectionchannel=[SERVERCONNECTIONCHANNEL]&Queue%20Manager= [QUEUEMANAGER]&AuthEnabled=[AUTHENABLED]&username=[USERNAME]&password= [PASSWORD]&MonitorBroker=[MONITORBROKER]&v10=[ISV10]&BrokerPort= [BROKERPORT]&BrokerAuthEnabled=[BROKERAUTHENABLED]&brokerusername= [BROKERUSERNAME]&brokerpassword=[BROKERPASSWORD]&timezone=[TIMEZONE] Request Parameters:The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         type The type of the monitor you want to add. Value should be IBM WebSphere MQ. host The name of the host where the WebSphere MQ server is running. listenerport The listener port number of the IBM WebSphere MQ server. displayname The display name of the monitor. The server connection channel through which the WebSphere MQ clients serverconnectionchannel communicate. The name of the Queue Manager through which the WebSphere MQ clients Queue Manager communicate. SSLEnabled Specify if SSL is enabled. Values are true or false. SSLCipherSpec The name of SSL Cipher Spec. AuthEnabled  Specifies if authentication is enabled. Possible values are true or false. username  The username to connect the websphere mq queue manager. password  The password to connect the websphere mq queue manager. FilterSysObject  The Filter System Objects.Possible values are true or false. SysObjects  The System Objects to monitor. MonitorBroker  Specifies if MessageBroker is enabled. Possible values are true or false. v10 IIB  Specifies if the Version is 10 and above. Possible values are true or false. The Port number of the IBMIntegrationBus(MessageBroker). Provide 0 if not BrokerPort  applicable. BrokerAuthEnabled  Specifies if the BrokerAuthentication is enabled. Possible values are true or false. brokerusername  The username to connect to the websphere message broker. brokerpassword  The password to connect to the websphere message broker.  timezone The timezone of the WebSphere MQ server. Sample Request: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=bc76b1abb8e9b209824a39d84578a194&type=IBM%20Websphere%20MQ&host=app- server&listenerport=1416&displayname=mqws&serverconnectionchannel=SCCHANEL1&Queue%20Manager =QMANAGER_QA1&AuthEnabled=true&username=test&password=test&&MonitorBroker=true&v10=true&Brok erPort=4416&BrokerAuthEnabled=true&brokerusername=test&brokerpassword=test&timezone=Default Microsoft Message Queue (MSMQ) Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&Powershell= [True/False]&Timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be Microsoft MQ. host The name of the host where the Microsoft MQ server is running. username The username of the MSMQ server. password The password of the MSMQ server.Powershell Indicates whether Powershell is enabled in the MSMQ server. (True or False) The timeout value in seconds. Value should be between 60 and 900 seconds. timeout Applicable only when Powershell is enabled in MSMQ server. Sample Request: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=256d041620d0aee9901558b44706dc84&type=Microsoft MQ&displayname=msmq&host=app- server&username=administrator&password=password&Powershell=True&Timeout=500 RabbitMQ Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST] &port=[PORT]&username=[USERNAME]&password=[PASSWORD] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description  Denotes the category type of the monitor you want to add. The value should be type as ''RabbitMQ''. host The name of the host where the RabbitMQ server is running. port The port number where RabbitMQ server is running. username The username of the RabbitMQ server server. password The password of the RabbitMQ server server. Sample Request: http://app-xp5:9090/AppManager/xml/AddMonitor? apikey=bc76b1abb8e9b209824a39d84578a194&type=VMware vFabric tc Server&displayname=vFabric&host=app- server&port=6969&username=admin&password=admin123&JNDIPath=/jmxrmi Microsoft BizTalk Syntax http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=BizTalkServer&displayname= [DISPLAYNAME]&host=[BIZTALKHOST]&Version=[2013/2016]&UserName=[USERNAME]&Password= [PASSWORD]&PowerShell=[TRUE/FALSE]&CredSSP=[YES/FALSE]&DBServer=[DBSERVERHOST]&DBName= [BIZTALKMANAGEMENTDBNAME] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         type The category type of the monitor you want to add. The value should be BizTalkServer. host The name of the host where where BizTalk is installed. Version Version of Biztalk Application 2013 - If Biztalk version is 2013 or below2016 - If Biztalk version is 2016 UserName The username of the BizTalk server host machine. Password The password of the BizTalk server host machine. Is powershell enabled? Values are: PowerShell True - powershell is enabled False - powershell is disabled The name of the server where the configuration database is stored (required only if PowerShell is DBServer enabled). DBName The name of the configuration database (required only if PowerShell is enabled). Specifies if CredSSP Authentication should be used,when Use Powershell option is chosen. The CredSSP value is yes if credssp needs to be enabled. Sample Request http://app-x5p:9400/AppManager/xml/AddMonitor? apikey=fcc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=ap m-biz1- 1&Version=2016&UserName=apm\administrator&Password=Pass123&PowerShell=True&CredSSP=False &DBServer=apm-biz1-1&DBName=BizTalkMgmtDb http://app-x5p:9400/AppManager/xml/AddMonitor? apikey=ddc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=a pm-biz16- 1&Version=2013&UserName=apm\administrator&Password=Pass123&PowerShell=False&CredSSP=Fals e Oracle Tuxedo Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST] &SNMPPORT=[PORT]&snmpCommunityString= [COMMUNITYSTRING]&timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description   The category type of the monitor you want to add. The value should be Oracle type Tuxedo. host The name of the host where where Tuxedo is installed. displayname The Display Name of the monitor. The SNMP port number , on which the Tuxedo SNMP agent is running. The SNMPPORT default port number is 161. The SNMP community string of Tuxedo SNMP agent. The default value is snmpCommunityString ''public''. Make sure you use a community string, that has at least ''Read-only'' privileges. timeout The timeout in seconds. Sample Request: http://app-xp5:9090/AppManager/xml/AddMonitor? apikey=a169e7aa3b4656d0db29532fd4347&type=OracleTuxedo&displayname=Tuxedo&host=172.31.10.1&SNMPPORT=161&snmpCommunityString=public&timeout= 40 Microsoft Skype for Business Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&Version= [VERSION]&Roles=[ROLES] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description The category type of the monitor you want to add. The value should type be LyncServer. The Host Name or IP Address of the host where the Microsoft Skype for host Business Server runs. displayname The Display Name of the monitor. The UserName of the account used to monitor the Microsoft Skype for UserName Business Server. The account should have administrator privileges to access Microsoft Skype for Business Server. The password of the above user who has administrator privileges to access password Microsoft Skype for Business Server. The version Microsoft Skype for Business 2015 or Microsoft Lync Server whichever is installed on the server. Possible values are: Version lync sfb2015 Provide the role(s) that you wish to monitor as comma separated values : FrontEndServer Roles A/V Conferencing Server EdgeServer MediationServer Sample Request http://app-xp5:9090/AppManager/xml/AddMonitor? apikey=4787dvds8941bc5a7b0db85d43a5b789&type=LyncServer&displayname=LyncAPI&host=172.31.10.1& UserName=APM\administrator&Password=pass&Version=sfb2015&Roles=FrontEndServer,A/V Conferencing Server,MediationServer Azure Service Bus Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[AzureServiceBus]&displayname= [DISPLAYNAME]&SubscriptionId=[SUBSCRIPTIONID]&Namespace=[NAMESPACE]&Timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters.Field Description         SubscriptionID Subscription ID of the Azure Subscription used. Namespace Service Bus Namespace name. Timeout Timeout in seconds. Sample Request: http://anne-2394:9096/AppManager/xml/AddMonitor?apikey=35eb5a8f77a1595f9d9e575a7c3575ad &type=AzureServiceBus&displayname=azureapmsbadmin&SubscriptionId=1591f1b0-6e8c-461f-8916- df7954193ec2&Namespace=applicationsmanager&Timeout=20 Apache ActiveMQ Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=ApacheActiveMQ&displayname= [Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password= [Password]&JNDIPath=/jmxrmi Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be ApacheActiveMQ. display name Display name of the ActiveMQ monitor. hostname The name of the host in which ActiveMQ server is running. port The port number where ActiveMQ server is running. username The name of the user who has permission to access the Apache ActiveMQ server. JNDIPath JNDI path to be used. Sample Request: http://prod-server8:9091/AppManager/xml/AddMonitor? apikey=ff5db35538c534e24dc2154cffbc7e6e&type=ApacheActiveMQ&displayname=Success&HostName=a pp-w8-aio-5&Port=1099&UserName=&Password=&JNDIPath=/jmxrmi Apache Kafka Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API KEY]&type=Kafka&displayname= [Displayname]&HostName=[Hostname]&Port=[Port]&UserName=[UserName]&Password= [Password]&JNDIPath=/jmxrmi Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be Kafka. display name Display name of the Kafka monitor. hostname The name of the host in which Kafka server is running. port The port number where Kafka server is running.username The name of the user who has permission to access the Apache Kafka server. JNDIPath JNDI path to be used. Sample Request http://prod-server8:9091/AppManager/xml/AddMonitor? apikey=15c64bc4cca4a3c45d0369fca1877e8a&type=Kafka&displayname=Kafka&HostName=172.20.8.62&P ort=9999&UserName=&Password=&JNDIPath=/jmxrmi AddMonitor APIs - Servers This section explains how to use the AddMonitor API to add monitors of the category type Servers. The following servers are supported: AIX IBM i FreeBSD/OpenBSD HP-UX/Tru64 Linux Mac OS Novell Sun Solaris Windows Windows Clusters AIX Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&os=[OS]&username=[USERNAME]&mode=[MODE]&snmptelnetport= [SNMPTELNETPORT]&password=[PASSWORD]&prompt=[PROMPT]&timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of monitor you want to add. The value should be ''servers''. host The name of the host where the AIX server is running. os The operating system of the server. Value is ''AIX''. username The username of the AIX server. mode The mode of monitoring the AIX server. Value should be either TELNET or SSH. snmptelnetport The port number where Telnet service is running. Default value is 23. password The password of the AIX server. timeout The time out value in seconds. prompt The command prompt value. Value is ''$'' This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API. (true or false)passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. Sample Request: http://prod-server1:9098/AppManager/xml/AddMonitor? apikey=624436f73f9fda2109cc916c8c8be5c1&type=servers&displayname=apmaix&host=adventaix&os=AIX &username=root&mode=TELNET&snmptelnetport=23&password=sankho&prompt=#&timeout=30 IBM i Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&subnet=[SUBNET]&pollInterval=[POLLINTERVAL]&os=[OS]&username= [USERNAME]&password=[PASSWORD]&timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''. host The name of the host where the IBM i server is running. subnet The subnet mask value pollInterval The polling interval for the monitor. os The operating system of the server. Value is ''AS400/iSeries''. username The username of the IBM i server. timeout The time out value in seconds. password The password of the IBM i server. This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you addgivenname have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. Sample Request: http://prod-server2:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmas400&host=pub1.rzkh.d e&subnet=255.255.255.0&pollInterval=5&os=AS400/iSeries&username=nimda&password=admin&timeout= 30 FreeBSD Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&subnet=[SUBNET]&pollInterval=[POLLINTERVAL]&os=[OS]&username= [USERNAME]&password=[PASSWORD]&mode=[MODE]&snmptelnetport=[SNMPTELNETPORT]&prompt= [PROMPT]&timeout=[TIMEOUT]&snmpCommunityString=[snmp Community String]Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''. host The name of the host where the FreeBSD server is running. subnet The subnet mask value pollInterval The polling interval for the monitor. os The operating system of the server. Value is ''FreeBSD''. username The username of the FreeBSD server. password The password of the FreeBSD server. mode The mode of monitoring. Value should be either SNMP, TELNET or SSH. The SNMP community string required for read-only access of SNMP data on the Server. snmpCommunityString  Mandatory when using SNMP mode. The default value is ''public''. snmptelnetport The port where Telnet service is running. Default value is 23. timeout The time out value in seconds. prompt The command prompt value. Value is $. This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address addgivenname that you have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. Sample Request: http://prod-server4:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmfreebsd&host=cm- bsd&subnet=255.255.255.0&pollInterval=5&os=FreeBSD&username=test&password=test&mode=TELNET&s nmptelnetport=23&prompt=$&timeout=30 HP-UX/Tru64 Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&username=[USERNAME]&password=[PASSWORD]&os=[OS]&mode= [MODE]&snmptelnetport=[SNMPTELNETPORT]&host=[HOST]&timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''. username The username of the HP-UX server. password The password of the HP-UX server. os The operating system of the server. Value is ''HP-UX''. mode The mode of monitoring. Values are SSH or TELNET snmptelnetport The port where SSH/Telnet service is running. Default values are 23 (for Telnet) and 22 (for SSH).timeout The time out value in seconds. host The name of the host where the HP-UX server is running. This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you addgivenname have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. Sample Request: http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmhpux&username=test&pa ssword=test&os=HP-UX&mode=SSH&snmptelnetport=22&host=hpuxtests&timeout=30 Linux Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&timeout= [TIMEOUT]&username=[USERNAME]&password=[PASSWORD]&snmpCommunityString=[snmp Community String] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''. host The name of the host where the Linux server is running. The port where SSH/Telnet/SNMP is running. Default values are 23 (for Telnet), 22 (for snmptelnetport SSH) and 161 (for SNMP). os The operating system of the server. Value is ''Linux''. timeout The time out value in seconds. The mode of monitoring. Value is either SNMP, SSH or TELNET. (For SNMP mode, the mode community string has to be added in the API request parameter.) This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address addgivenname that you have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. username The username to use the Telnet/ssh mode of monitoring. password The password to use the Telnet/ssh mode of monitoring. The SNMP community string required for read-only access of SNMP data on the Server. snmpCommunityString  Mandatory when using SNMP mode. The default value is ''public''. Sample Requests: SSH Mode:http://prod-server:9090/AppManager/xml/AddMonitor? apikey=cfb48066f523d94c18fd0a99bc4faa10&type=servers&displayname=APILINUX &host=app-centos32- 1&snmptelnetport=22&os=Linux&mode=SSH&timeout=10&username=test&password=Zoho123 SNMP Mode: http://prod-server:9090/AppManager/xml/AddMonitor? apikey=cfb48066f5fdvgf94c18fd0a99bc4faa10&type=servers&displayname=APILINUX &host=app- centos32-1&snmptelnetport=161&os=Linux&mode=SNMP&timeout=10&snmpCommunityString=Public Sample Response: Monitor added successfully. Mac OS Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username= [USERNAME]&password=[PASSWORD]&snmpCommunityString=[snmp Community String]&timeout= [TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''. host The name of the host where the Mac OS is running. The port where SSH/Telnet/SNMP is running. Default values are 23 (for Telnet), 22 (for snmptelnetport SSH) and 161 (for SNMP). os The operating system of the server. Value is ''Mac OS''. mode The mode of monitoring. Value is either SNMP, SSH or TELNET. username The user name of the Mac OS server. timeout The time out value in seconds. password The password of the Mac OS server. The SNMP community string required for read-only access of SNMP data on the Server. snmpCommunityString  Mandatory when using SNMP mode. The default value is ''public''. This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address addgivenname that you have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. Sample Request:http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmmac&host=apptest- mac&snmptelnetport=23&os=Mac OS&mode=TELNET&username=administrator&password=admin123&timeout=30 Novell Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode= [MODE]&snmpCommunityString=[snmp Community String]&timeout=[TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''. host The name of the host where the Novell server is running. snmptelnetport The port where SNMP is running. Default value is 161. os The operating system of the server. Value is ''Novell''. timeout The time out value in seconds. mode The mode of monitoring specified for the server. Value is ''SNMP''. The SNMP community string required for read-only access of SNMP data on the Server. snmpCommunityString  The default value is ''public''. This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address addgivenname that you have configured in the API. (true or false) Sample Request: http://production-server2:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmnovell&host=smrithil&sn mptelnetport=161&os=Novell&mode=SNMP&snmpCommunityString=public&timeout=30 Sun Solaris Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username= [USERNAME]&password=[PASSWORD]&snmpCommunityString=[snmp Community String]&timeout= [TIMEOUT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''.host The name of the host where the Sun Solaris server is running. The port where SSH/Telnet/SNMP is running. Default values are 23 (for Telnet), 22 (for snmptelnetport SSH) and 161 (for SNMP). os The operating system of the server. Value is ''SUN''. The mode of monitoring specified for the server. Value should be either SNMP, TELNET mode or SSH. username The user name of the Sun Solaris server. timeout The time out value in seconds. password The password of the Sun Solaris server. The SNMP community string required for read-only access of SNMP data on the Server. snmpCommunityString  Mandatory when using SNMP mode. The default value is ''public''. This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: forceadd True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address addgivenname that you have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. Sample Request: http://prod-server7:9090/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmsolaris&host=cagent- solaris2&snmptelnetport=23&os=SUN&mode=TELNET&username=guest&password=guest&timeout=30 Windows Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username= [USERNAME]&password=[PASSWORD]&snmpCommunityString=[snmp Community String]&timeout= [TIMEOUT]&kerberos_status=[ KERBEROS STATUS ] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be ''servers''. host The name of the host where the Windows server is running. snmptelnetport The port where SNMP is running. Default value is 161. The operating system of the server. Values can be Windows 2000, Windows 2003, os Windows 2008, Windows 2012, Windows 7, Windows 8, Windows XP, WindowsNT or Windows Vista mode The mode of monitoring specified for the server. Value should be either SNMP or WMI. username The user name of the Windows server. password The password of the Windows server. timeout The time out value in seconds. eventlog_status Specifies if Event Log Monitoring is enabled. Parameter values are true/false. The SNMP community string required for read-only access of SNMP data on the Server. snmpCommunityString Mandatory when using SNMP mode. The default value is ''public''. forceadd This parameter is used to force Applications Manager to bypass availability and otherauthentication-related checks and add the monitor. Possible values are: True - Force-adds the monitor False - Does not force-add the monitor. Specifies if you want to set the host name of the monitor as the Host Name / IP Address addgivenname that you have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. kerberos_status Specifies if Kerberos authentication is enabled. Possible values are either true / false. Sample Request: To add Windows server in SNMP mode: http://prod-server6:8080/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5 &type=servers&displayname=apmwindows&host=app-xp5&os=Windows XP&mode=SNMP&snmptelnetport=161&snmpCommunityString=public&timeout=30 To add Windows server in WMI mode: http://prod-server6:8080/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmwindows&host=app- xp5&os=Windows XP&mode=WMI&username=administrator&password=pass&timeout=300&kerberos_status=true Windows Clusters Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST NAME]&Version=[VERSION NO]&username=[USERNAME]&password= [PASSWORD]&DiscoverNodes=[NO OF NODES]&EventLog=[YES/NO]&pollinterval=[INTERVAL] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters Field Description type The category type of the monitor you want to add. Value should be Windows Cluster host The name of the host where the Windows server clusters are running. The Version of the Windows Server Clusters. Possible Values are: version 2008 (Default) 2008 R2 Specify if you need to discover nodes. Possible Values are: DiscoverNodes 0 - No(Default) 1 - Yes Specify if you need to display Event Logs.Possible Values are: EventLog Yes No(Default) The interval at which the server needs to be polled. This variable is optional. If no value is pollInterval mentioned, the default value of 5 minutes will be taken. forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are: True - Force-adds the monitor False - Does not force-add the monitor.Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you addgivenname have configured in the API. (true or false) passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication. Sample Request: https://prod-server6:8080/AppManager/xml/AddMonitor? apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=Windows Cluster&displayname=clusterApi&host=apmcluster&Version=2008 R2&username=apmcluster2012\administrator&password=12345&DiscoverNodes=1&EventLog=No&pollinter val=5 AddMonitor APIs - Services This section explains how to use the AddMonitor API to add monitors of the category type ''Services''. The following services are supported: Active Directory Ceph Storage DNS Monitor FTP/SFTP Monitor Hadoop Monitor JMX Applications LDAP Server Ping Monitor / Ping Monitor (EUM) Service Monitoring SNMP/Network Device Telnet / Telnet (EUM) Oracle Coherence Apache Zookeeper Apache Spark Istio Network Policy Server (Radius Server) UDP Port Active Directory Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&CredSSP=[Yes/FALSE]&username=[USERNAME]&password= [PASSWORD]&timeout=[TIMEOUT]&kerberos=[True/False] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common request parameters. Field Description type The type of the service you want to add. Value should be ''ActiveDirectory''. host The name of the host in which the Active Directory service is running. username The Active Directory username. password The Active Directory password. timeout Timeout in seconds for running scripts CredSSP Specifies if CredSSP Authentication should be used when the monitored AD Serveris a non-primary Domain Controller and is present in a different domain other than that of the Applications Manager server domain. The value is "Yes" if CredSSP needs to be enabled. kerberos Option to enable Kerberos authentication. (True or False) Sample Request http://operation-server3:9099/AppManager/xml/AddMonitor? apikey=123b7328e4b41d1efe64aa7980d83d77&type=ActiveDirectory&displayname=active_mon&host=app- xp4&username=administrator&password=admin123&timeout=300&CredSSP=Yes&kerberos=True Ceph Storage Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&prompt=[Prompt]&userName=[UserName]&password= [Password]&snmptelnetport=[PORT]&mode=[MODE OF MONITORING]&timeout=[TIMEOUT] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the service you want to add. Value should be ''Ceph Storage''. host The name of the host in which the Ceph service is running. username The Ceph Storage service username. password The Ceph Storage service password. prompt The command prompt value - ''$''. If you use # only v must use encode value of $23 The port number where Telnet/SSH service is running. The default port for Telnet is snmptelnetport 23 and SSH is 22. mode The Mode of Monitoring you want to use. Values can be Telnet or SSH. The amount of time spent by Applications Manager to establish a connection with timeout the server hosting the API service. The timeout value is 40 ms by default. Sample Request http://operation-server3:9099/AppManager/xml/AddMonitor? apikey=5e403cfde0653d142fac29b18863923b&type=Ceph Storage&displayname=ceph&host=ctl- cephadmin&prompt=$&userName=appmgr&password=appmgr%123&snmptelnetport=22&mode=SSH&tim eout=40 DNS Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&timeout=[TIMEOUT]&SearchField=[SEARCHFIELD]&TargetAddress= [TARGETADDRESS]&LookupAddress=[LOOKUPADDRESS]&RecordType=[RECORDTYPE] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Descriptiontype The type of the service you want to add. Value should be ''DNSMonitor''. displayname The display name of the host in which the monitor is running. timeout The timeout value in seconds. The value of SearchField. Options include None, Record Name, Address, Additional SearchField Name, Target, Admin, Host, Alias, Port and Priority. TargetAddress Host Name / IP Address to connect to the service LookupAddress The address you want to check in the DNS Server. The expected record type returned for the lookup address. The options include A, RecordType AAAA, CNAME, MX, NS, PTR, SOA, SPF, SRV and TXT. Sample Request http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=DNSMonitor&displayname=dnstttttt&timeout=15&Sea rchField=Record Name&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A FTP/SFTP Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&TargetAddress= [TARGETADDRESS]&DownloadFile=[DOWNLOADFILE]&IsSecured=[ISSECURED]&UploadFile= [UPLOADFILE]&RemoteSourceFileName=[REMOTESOURCEFILENAME]&RemoteDestinationFileName= [REMOTEDESTINATIONFILENAME]&LocalSourceFileName= [LOCALSOURCEFILENAME]&LocalDestinationFileName=[LOCALDESTINATIONFILENAME]&timeout= [TIMEOUT] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the service you want to add. Value should be ''FTPMonitor''. port The port number where the FTP/SFTP service is running. username The FTP/SFTP user name. password The FTP/SFTP password. TargetAddress Host Name / IP Address to connect to the service. Indicates if download is enabled. Possible values include yes and no. If you would DownloadFile like to monitor the downloads (mget) through FTP/SFTP while simulateneously downloading the file, specify yes. IsSecured Specifies if the connection is secure or not. Value is either yes or no. Indicates if upload file option is enabled. Values include yes and no. If you would UploadFile like to upload a file to target address, specify yes. The Remote Source FileName located in the target address. This is applicable RemoteSourceFileName only if the value of ''DownloadFile'' option is specified as yes. The Remote Destination FileName located in the target address. This is RemoteDestinationFileName applicable only if the value of ''UploadFile'' option is specified as yes. The name of the local source file with full path. The file must be available where LocalSourceFileName Applications Manager instance is running. This is applicable only if the value of ''UploadFile'' option is specified as yes. The local destination FileName with full path. The file will download in the given LocalDestinationFileName path where Applications Manager instance is running. This field is applicable only if the value of ''DownloadFile'' option is specified as yes timeout The timeout value in seconds.credentialID ID for the credential to be used. Note: Credential ID can be used as an alternative to username and password fields. Sample Request http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=FTPMonitor&displayname=ladpapitestooooo&port=2 2&username=sprasadh&password=sprasadh&TargetAddress=sprasadh&DownloadFile=no&IsSecured=yes& UploadFile=no&RemoteSourceFileName=&RemoteDestinationFileName=&LocalSourceFileName=&LocalDe stinationFileName=&timeout=15 Hadoop Monitor Note: NameNode and JobTracker / ResourceManager must be added using same Mode (JMX or RESTAPI). Syntax 1. Add Hadoop monitor through REST API mode of monitoring: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname= [DISPLAYNAME]&ModeOfMonitoring=RESTAPI&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeWebPort=[NAMENODE WEBPORT]&NameNodeSSLEnabled= [yes/no]&NameNodeWebAuthType=[SimpleAuth/NoAuth]&NameNodeUserName=[NAMENODE USERNAME]&JobTrackerHost=[JOBTRACKER HOSTNAME]&JobTrackerWebPort=[JOBTRACKER WEBPORT]&JobTrackerSSLEnabled=[yes/no}&JobTrackerWebAuthType= [SimpleAuth/NoAuth]&JobTrackerUserName=[JOBTRACKER USERNAME] 2. Add Hadoop monitor through JMX mode of monitoring: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname= [DISPLAYNAME]&ModeOfMonitoring=JMX&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeJMXPort=[NAMENODE JMXPORT]&NameNodeUserName=[NAMENODE JMX USERNAME]&NameNodePassWord=[NAMENODE JMX PASSWORD]&NameNodeJNDIPath=[NAMENODE JNDIPATH]&JobTrackereHost=[JOBTRACKER HOSTNAME]&JobTrackerJMXPort=[JOBTRACKER JMXPORT]&JobTrackerUserName=[JOBTRACKER JMX USERNAME]&JObTrackerPassWord=[JOBTRACKER JMX PASSWORD]&JobTrackerJNDIPath=[JOBTRACKER JNDIPATH] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description The mode in which datacollection for Hadoop monitor will happen. Possible values: ModeOfMonitoring  RESTAPI JMX Version of Hadoop. Possible values: Version 1.x 2.x NameNodeHost HostName of Namenode. NameNodeWebPort Web port of Namenode. NameNodeJMXPort JMX Port of NamenodeNameNodeSSLEnabled Is SSL is enabled for Namenode webport? Possible values: yes no Type authentication used by namenode web. Possible values: NameNodeWebAuthType NoAuth SimpleAuth Username of web access, if simple authentication is used in namenode. NameNodeUserName Username of JMX access, if JMX mode of monitoring is chosen in namenode. NameNodePassWord Password for JMX access, if it is necessary for JMX access in namenode. NameNodeJNDIPath JNDI path of the Namenode. JobTrackerHost HostName of Jobtracker. JobTrackerWebPort Web port of Jobtracker. JobTrackerJMXPort JMX Port of Jobtracker. Is SSL is enabled for Jobtracker webport? Possible values: JobTrackerSSLEnabled yes no Type authentication used by Jobtracker web. Possible values: JobTrackerWebAuthType NoAuth SimpleAuth Username of web access, if simple authentication is used in Jobtracker. JobTrackerUserName Username of JMX access, if JMX mode of monitoring is chosen in Jobtracker. JObTrackerPassWord Password for JMX access, if it is necessary for JMX access in Jobtracker. JobTrackerJNDIPath JNDI path of the Jobtracker. Sample Request 1. Add Hadoop monitor through REST API mode of monitoring: http://app-test-vm:9090/AppManager/xml/AddMonitor? apikey=90b71e0866f0f92488fbb4a2ab8d1195&type=Hadoop&displayname=Hadoop&ModeOfMonitoring= RESTAPI&Version=1.x&NameNodeHost=naga- 2385&NameNodeWebPort=50070&NameNodeSSLEnabled=no&NameNodeWebAuthType=SimpleAuth&Na meNodeUserName=hduser&JobTrackerHost=naga- 2385&JobTrackerWebPort=50030&JobTrackerSSLEnabled=no&JobTrackerWebAuthType=SimpleAuth&JobT rackerUserName=hduser 2. Add Hadoop monitor through JMX mode of monitoring: http://app-test-vm:9090/AppManager/xml/AddMonitor? apikey=90b71e0866f0f92488fbb4a2ab8d1195&type=Hadoop&displayname=Hadoop&ModeOfMonitoring= JMX&Version=1.x&NameNodeHost=naga- 2385&NameNodeJMXPort=8004&NameNodeUserName=&NameNodePassWord=&NameNodeJNDIPath=/jm xrmi&JobTrackerHost=naga- 2385&JobTrackerJMXPort=8004&JobTrackerUserName=&JobTrackerPassWord=&JobTrackerJNDIPath=/jmxr miJMX Applications Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&jndiurl=[JNDIURL] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the service you want to add. Value should be ''JMX Applications''. host The name of the host in which the monitor is running. port The port number where the RMI adapter is running. jndiurl The JNDI name. Example:/jmxrmi Sample Request http://prod-server1:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=JMX Applications&displayname=apmjmxapp&host=app-xp2&port=1099&jndiurl=/jmxrmi LDAP Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&username=[USERNAME]&timeout=[TIMEOUT]&LDAPServer= [LDAPSERVER]&LDAPServerPort=[LDAPSERVERPORT]&MatchingAttribute= [MATCHINGATTRIBUTE]&FilterCondition=[FILTERCONDITION]&IsSecured=[ISSECURED]&SearchFilter= [SEARCHFILTER]&SearchResult=[SEARCHRESULT]&SearchBase=[SEARCHBASE]&password=[PASSWORD] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the service you want to add. Value should be ''LDAP Server''. username The user name of the LDAP server. timeout The timeout value in seconds. LDAPServer The name of the LDAP Server. LDAPServerPort The port at which the LDAP server is running. The matching attribute value. Values include cn, uid, sn, displayname, givenname, MatchingAttribute objectclass, dc and ou FilterCondition The value of filter condition. Values include equals, contains and notequals IsSecured Specifies if the connection is secure or not. Value is either yes or no. SearchFilter The value of Search Filter. This field is optional. SearchResult The string value that matches with search results. SearchBase The value of SearchBase. This is mandatory field when adding a LDAP monitor. password The password of the LDAP server.Sample Request http://operations-server9:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=LDAP Server&displayname=ldap_serverqqqq&username=cn=administrator,cn=users,dc=pmp,dc=com&timeout=1 0&LDAPServer=pmp- 2k8s&LDAPServerPort=389&MatchingAttribute=cn&FilterCondition=equals&IsSecured=no&SearchFilter=&S earchResult=&SearchBase=&Password=admin123123 Ping Monitor/Ping Monitor (EUM) Syntax Ping Monitor: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Ping Monitor (Non EUM)&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT] Ping Monitor (EUM): http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Ping Monitor&displayname= [DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]&eumAgents=[AGENTNAME]&runOnServer= [RUNONSERVER] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description The type of the service you want to add. Value should either be Ping Monitor (Non type EUM) or Ping Monitor. displayname Display name of the monitor. host The host in which the monitor is running. timeout The timeout value in seconds. eumAgents The display name(s) of the EUM agent(s), separated by comma. Specifies whether the monitor has to be created in Applications Manager. (true or runOnServer false) Sample Request Ping Monitor: http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Ping Monitor (Non EUM)&displayname=apmping&host=smrithil&timeout=5 Ping Monitor (EUM): http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Ping Monitor&displayname=apmping&host=smrithil&timeout=5&eumAgents=apm-eum-w7&runOnServer=true Service Monitoring Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the service you want to add. Value should be service monitoring. host The host in which the monitor is running. timeout The timeout value in seconds. port The port number in which the service is running. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Service Monitoring&displayname=apmservice&host=smrithil&port=9090&timeout=3 SNMP/Network Device Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&snmpCommunityString= [SNMPCOMMUNITYSTRING]&timeout=[TIMEOUT] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the service you want to add. Value should be SNMP / Network Device. host The host in which the monitor is running. port The port number in which SNMP is running. snmpCommunityString The SNMP community string value. Default value is public. timeout The timeout value in seconds. Sample Request http://prod-server4:9099/AppManager/xml/AddMonitor? apikey=c9684ec1361be61f48cd1bd2221ac3fc&type=SNMP/Network Device&displayname=apmsnmp&host=sprasadh&port=161&snmpCommunityString=public&timeout=5 Telnet / Telnet (EUM) Syntax Telnet: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Telnet&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT] Telnet (EUM): http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Telnet (EUM)&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&eumAgents= [AGENTNAME]&runOnServer=[RUNONSERVER]Request Parameters The parameters involved in the API request are described below. Also, refer the list of common request parameters. Field Description type The type of the service you want to add. Value should be Telnet or Telnet (EUM). host The host name in which the monitor is running. timeout The time out value in seconds. port The port number in which Telnet is running. eumAgents The display name(s) of the EUM agent(s), separated by comma. Specifies whether the monitor has to be created in Applications Manager. (true or runOnServer false) Sample Request Telnet: http://operation-server2:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Telnet&displayname=apmtelnet&host=smrithil&port=2 3&timeout=2 Telnet (EUM): http://operation-server2:9090/AppManager/xml/AddMonitor? apikey=40648ef160f4786b20ed89ea51aa3f98&type=Telnet (EUM)&displayname=apmtelnet&host=smrithil&port=23&timeout=2&eumAgents=apm-eum- w7&runOnServer=true Oracle Coherence Syntax http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Coherence&displayname= [Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password= [Password]&JNDIPath=/jmxrmi Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description apikey API key to create the Oracle coherence monitor type The type of the database you want to add. Value should be coherence. displayname Display name of the Oracle coherence monitor hostname The name of the host in which Oracle coherence is running. port The port number where Oracle is running. username The name of the user who has permission to access the Oracle coherence database. The password of the user who has permission to access the Oracle coherence password database. JNDIPath JNDI path to be used  Sample Request http://prod-server7:9090/AppManager/xml/AddMonitor? apikey=27d484c4527d4f0911daef26e131a260&type=Coherence&displayname=Coherence_API&HostName=it360-m4600-1&Port=1099&PortAdd=1095&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi Apache Zookeeper Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=Zookeeper&displayname=Zookeeper&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be ''Yes'']&authReq=[non mandatory column, if given the value should be ''true'']&username=[username]&password=[password] Request Parameters The parameters involved in the API request are described below. Field Description type The type of the Service you want to add. Value should be Zookeeper. host The name of the host in which Zookeeper is running. port The port number where Zookeeper is running. username The name of the user who has permission to access the Zookeeper. password The password of the user who has permission to access the Zookeeper. Specifies if the Cluster Nodes must be discovered. Value can be YES/NO. This discoverclusternodes column is not mandatory. authReq Specifies if authentication is required. Value can be true/false. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=849c51ce33436587873a08d69d5447fc&type=Zookeeper&displayname=Zookeeper&host=172.20.7.3 6&port=7199&username=uname&password=123 Apache Spark Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]&DiscoverAllNodes=[YES/NO] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. Value should be ApacheSparkMaster. displayname The display name of the Apache Spark monitor. host The name of the host in which Apache Spark server is running. port The port number where Apache Spark server is running. ssl Specfies if SSL is enabled or not. Value can be either true or false. DiscoverAllNodes Specfies if you wish to discover all worker nodes. Sample Requesthttp://prod-server3:9090/AppManager/xml/AddMonitor? apikey=849c51ce33436587873a08d69d5447fc&type=ApacheSparkMaster&displayname=Spark&host=172.2 0.7.36&port=7199&SSL=true&DiscoverAllNodes=yes Istio Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAY NAME]&username=[USERNAME]&password=[PASSWORD]&namespace=[NAMESPACE]&Hostname= [HOSTNAME]&port=[PORT] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. Value should be Istio. displayname The display name of the Istio monitor. Hostname The name of the host in which Istio server is running. port The port number where Istio server is running. username The username of the Istio server. password Password of the Istio server. namespace The namespace of the Istio server. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=849c51ce33436587873a08d69d5447fc&type=Istio&displayname=imasterrestapi&username=apm- istio&password=kube&namespace=istio-system&Hostname=imaster&port=9922 Network Policy Server (Radius Server) Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=NetworkPolicyServer&displayname=[DISPLAYNAME]&host=[HOST]&UserName= [USERNAME]&Password=[PASSWORD]&Roles=[ROLES] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. Value should be NetworkPolicyServer. displayname The display name of the Network Policy Server (Radius Server) monitor. host The name of the host in which Network Policy Server (Radius Server) is running. UserName The username of the Network Policy Server (Radius Server). Password Password of the Network Policy Server (Radius Server).Field Description The roles of the Network Policy Server (Radius Server) separated by commas. Possible values are: RadiusServer Roles RadiusProxy Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=849c51ce33436587873a08d69d5447fc&type=NetworkPolicyServer&displayname=NPSAPI&host=183 .51.13.6&UserName=APM\administrator&Password=pass&Roles=RadiusServer,RadiusProxy UDP Port Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]&command=[COMMAND]&search= [VALUE] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be UDP Port. host The host name where the service is running. port UDP port in which the specified host is listening to. timeout Time to wait for receiving response from server after executing the command. Command to execute through the UDP port. command Note: Only text format command type is supported. Value to be searched in the server response after executing the command. search For multiple values, place the values within square brackets, separated by a comma. eg : ["value1","value2","value3"] Sample Request http://localhost:9094/AppManager/xml/AddMonitor? apikey=07d2etgshj9141fa7210c459dd8540c&type=UDP Port&displayname=UDP&host=localhost&port=13&timeout=5&command=test&search=["value"] AddMonitor APIs - Virtualization This section explains how to use the AddMonitor API to add monitors of the category type Virtualization. The following monitors are supported: VMware ESX/ESXi Server VMware Horizon View Connection Broker Microsoft Hyper-V Server Citrix Hypervisor (XenServer) XenAppvCenter Docker Kubernetes Red Hat Virtualization (RHV) Kernel-based Virtual Machine (KVM) OpenShift Oracle VM (OVM) Citrix Virtual Apps and Desktops VMware ESX/ESXi Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&addtoGroup=[ADDTOGROUP]&groupID=[GROUPID]&monitorvms= [MONITORVMS]&credentialID=[CREDENTIAL_ID]&DiscoveryFilterRegex=[DiscoveryFilterRegex] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description type The type of the monitor you want to add. Value should be VMware ESX/ESXi. host The name of the host where the VMWare ESX/ESXi server is running. port The port number where the VMware ESX/ESXi server is running. username The user name of the VMware ESX/ESXi server. password The password of the VMware ESX/ESXi server. addtoGroup Denotes if the monitor should be added to monitor group. Value is either true or false groupID The monitor group ID Indicates the way how the virtual machines of the ESXi server are to be monitored. Possible values are: no - VMs will not be discovered. monitorvms onlyavailability - VMs will be discovered but the metrics will not be monitored. (Will not count for licensing) yes - VMs will be discovered and monitored. DiscoveryFilterRegex The Discovery Filter Regex based on which the virtual machines are to be discovered (optional) and monitored. Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=e249ce592ad1052c4ea605bcf3125ad9&type=VMWare ESX/ESXi&displayname=vnwgroup&host=esx- 2&port=443&username=root&password=password&addToGroup=true&groupID=10000024&monitorv ms=onlyavailability&DiscoveryFilterRegex=VIRTUALMACHINE_NAME=test.* http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=e249ce592ad1052c4ea605bcf3125ad9&type=VMWare ESX/ESXi&displayname=vnwgroup&host=esx- 2&port=443&addToGroup=true&groupID=10000024&monitorvms=onlyavailability&credentialID=3&Di scoveryFilterRegex=VIRTUALMACHINE_NAME=test.* VMware Horizon View Connection BrokerYou can add the VMware Horizon View Connection Broker monitor in the following two ways: Add VMware Horizon View as a new monitor group (New Monitor Group --> VMware Horizon View).This will discover all the components in the Horizon View Set up including View Connection Broker. Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=VMwareView&displayname=[DISPLAYNAME]&host=[HOST]&username= [USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL] Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=VMwareView&displayname=HorizonVie w&host=172.18.144.52&username=vmwarehzview\user- test&password=APM@13&pollInterval=5   Add VMware Horizon View Connection Broker as a new monitor (New Monitor --> VMware Horizon View Connection Broker). This will discover View Connection Broker alone. Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=ViewConnectionBroker&displayname=[DISPLAYNAME]&host= [HOST]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&addtoGroup=[TRUE/FALSE]&groupID=[GROUPID] Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=ViewConnectionBroker&displayname= ViewBroker&host=172.18.144.52&username=vmwarehzview\maran- test&password=Zoho@13&pollInterval=5&addtoGroup=true&groupID=10000028 Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the monitor you want to add. Value should be VMwareView or ViewConnectionBroker. host The name of the host where the VMware Horizon View server is running. username The user name of your VMware server. password The password of your VMware server. Microsoft Hyper-V Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host= [HOST]&displayname=[DISPLAYNAME]&password=[PASSWORD]&addvms=[ADDVMS]&username= [USERNAME]&Version=[VERSION]&Kerberos=[true/false] Request ParametersThe parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the monitor you want to add. Value should be Hyper-V Server. host The name of the host where the Hyper-V server is running. password The password of the Hyper-V server. Indicates the way how the virtual machines (VMs) of the Hyper-V server are to be monitored. Possible values are: no - VMs will not be discovered. addvms onlyavailability - VMs will be discovered but the metrics will not be monitored. (Will not count for licensing) yes - VMs will be discovered and monitored. username The user name of the Hyper-V server. Version The version of your Microsoft Hyper-V Server. Possible values are 2008, 2012, 2016 or 2019. Kerberos Option to enable Kerberos authentication. Possible values are either true or false. Sample Request http://prod-server6:9090/AppManager/xml/AddMonitor? apikey=256d041620d0aee9901558b44706dc84&type=Hyper-V Server&host=amp-w2k8- 64&displayname=apmhyperv&password=admin123app2&addvms=yes&username=administrator&Version=2 008&Kerberos=true Citrix Hypervisor (XenServer) Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &host= [HOST]&displayname=[DISPLAYNAME]&username=[USERNAME]&password=[PASSWORD]&port= [PORT]&credentialID=[ CREDENTIALID ]&addvms=[ADDVMS]&addToGroup=[TRUE/FALSE]&groupID= [GROUPID]&monitorvms=[AVAILABILITY] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the monitor you want to add. Value should be XenServerHost. host The name of the host where the XenServerHost is running. password The password of the XenServerHost addvms Denotes whether the performance metrics of VMs should be collected. Value is either yes or no username The user name of the XenServerHost addToGroup Denotes if the monitor should be added to monitor group. Value is either true or false groupID The monitor group ID Indicates the way the virtual machines are to be monitored. Possible values are no, yes and onlyavailability.The value no means the VMs will not be discovered. The value yes indicates that monitorvms the VMs will be discovered and monitored. The value onlyavailability indicates that the VMs will be discovered but the metrics will not be monitored (will not count for licensing). Sample Request http://prod-server6:9090/AppManager/xml/AddMonitor? apikey=bc76b1abb8e9b209824a39d84578a194&type=XenServerHost&host=192.18.3.75&displayname=newxen&username=root&password=sankho&ad dvms=yes&monitorvms=yes http://prod-server6:9090/AppManager/xml/AddMonitor? apikey=bc76b1abb8e9b209824a39d84578a194 &type=XenServerHost&host=192.18.3.75&displayname=newxen&addvms=yes&monitorvms=yes&creden tialID=1 XenApp Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &host= [HOST]&displayname=[DISPLAYNAME]&UserName =[USERNAME]&Password=[PASSWORD]&Version= [VERSION] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. The value should be XenApp. host The name of the host where the XenApp Server is running. displayname The display name of the monitor. UserName The user name of the XenApp server host machine. password The password of the XenApp server host machine. version The version of XenApp. Sample Request http://prod-server6:9090/AppManager/xml/AddMonitor? apikey=bc76b1abb8e9b209824a39d84578a194&type=XenApp&host=192.18.3.75&displayname=XenAppSer ver&UserName =administrator&Password=pass&Version=7.6 vCenter Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&pollInterval=[POLL INTERVAL]&addtoGroup=[ADDTOGROUP]&groupID= [GROUPID]&discoverVM=[DISCOVER VMS]&sslVersion=[SSL VERSION]&DiscoveryFilterRegex= [DiscoveryFilterRegex] http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&vcHost=[VC HOST]&vcPort=[VC PORT]&username= [USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&discoverVM=[DISCOVER VMS]&sslVersion=[SSL VERSION]&isHostDCViaVC=[on/off]&DiscoveryFilterRegex= [DiscoveryFilterRegex] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be vCenter.vcHost The name of the host where vCenter is running. vcPort The port number where the vCenter is running. username The user name of the vCenter server. password The password of the vCenter server. addtoGroup Denotes if the monitor should be added to monitor group. Value is either true or false Specifies if data collection should happen using vCenter credentials or not. Value can be isHostDCViaVC on or off. (Optional parameter). Indicates the way how the virtual machines (VMs) of the vCenter are to be monitored. Possible values are: 0 - VMs will not be discovered. discoverVM 1 - VMs will be discovered but the metrics will not be monitored. (Will not count for licensing) 2 - VMs will be discovered and monitored. Specify the version of SSL configured for the vCenter. The values can one of the following: sslVersion SSLv3, TLSv1, TLSv1.1 or TLSv1.2. Default value will be TLSv1.2. DiscoveryFilterRegex The Discovery Filter Regex based on which the virtual machines are to be discovered and (optional) monitored. Sample Request http://prod-server1:6060/AppManager/xml/AddMonitor? apikey=bc76b1abb8e9b209824a39d84578a194&type=vCenter&displayname=vctest&vcHost=vcenter&vcPo rt=443&username=test&password=test&pollInterval=10&discoverVM=2&sslVersion=TLSv1.2&isHostDCViaV C=true&DiscoveryFilterRegex=VIRTUALMACHINE_NAME=test.* Docker Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&sslenabled=[SSL Enabled]&isAllContainerEnabled=[All Container Enabled]&isCertificateEnabled=[Certificate Enabled]&clientCertName=[Client Certificate Name]&keystorePassword=[Client Certificate Password]&AdvancedSettings= [true/false]&DeletedResourceAction=[Unmanage/Delete] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the monitor you want to add. Value should be Docker. host The name of the host where Docker is running. port The port number where Docker is running. username The user name of the Docker server. password The password of the Docker server. sslenabled Option to enable SSL. Possible values are either true or false. Option to discover and monitor all the containers that are available under the Docker isAllContainerEnabled server. Possible values are either true or false. Option to enable Client Certificate Authentication for the Docker server you want to isCertificateEnabled monitor. Possible values are either true or false. clientCertName Name of the Client Certificate. keystorePassword Password used for the Client Certificate. AdvancedSettings Option to enable advanced settings. (true or false)DeletedResourceAction Option to perform action on deleted Docker resources. (Delete or Unmanage) The Discovery Filter Regex based on which the containers are to be discovered and DiscoveryFilterRegex monitored. Sample Request Without Certificate: http://ProductionServer:6060/AppManager/xml/AddMonitor? apikey=dd2e6f7ec54632b4493d0dc13829df39&type=Docker&displayname=docker&host=testing&port=42 43&username=&password=&isSSLEnabled=false&isAllContainerEnabled=true&isCertificateEnabled=false& AdvancedSettings=true&DeletedResourceAction=Delete With Certificate: http://ProductionServer:6060/AppManager/xml/AddMonitor? apikey=dd2e6f7ec54632b4493d0dc13829df39&type=Docker&displayname=docker&host=testing&port=42 43&username=&password=&isSSLEnabled=true&isAllContainerEnabled=true&isCertificateEnabled=true&cli entCertName=abcd&keystorePassword=abcd123&AdvancedSettings=true&DeletedResourceAction=Unman age Kubernetes Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&mode=SSH&sshPKAuth=[true/false]&filterEnabled=[true/false]&filterCondition= [include/exclude]&NamespaceName=[NAMESPACE NAME]&prompt=[Prompt]&timeout=[Timeout in Seconds] The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description type The type of the monitor you want to add. Value should be Kubernetes. host The name of the host where the Kubernetes cluster is running. port The port number where Kubernetes is running. username The user name of the Kubernetes cluster. password The password of the Kubernetes cluster. mode The mode through which Kubernetes can be accessed. enable Public Key Authentication (Supported for SSH2 only), the SSH Key for SSH sshPKAuth authentication. Specify the command prompt value, which is the last character in your command prompt. prompt Default value is $ and possible values are >, #, etc. timeout The time out value in seconds. filterEnabled Option to Monitor Specific Namespace(s) in Kubernetes server. (true or false) Filtering condition to monitor specific namespace(s) in Kubernetes server. (include or filterCondition exclude) NamespaceName Name of the namespace(s) to be included/excluded, separated by commas. Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=0b0e064274e52eead3d1cabdd5ceee04&type=Kubernetes&displayname=kubemaster&host=kubem aster&port=22&username=test&password=test&mode=SSH&sshPKAuth=false&filterEnabled=true&filterCon dition=include&NamespaceName=name1,name2,name3&prompt=$&timeout=40Red Hat Virtualization (RHV) Syntax http://[ Host ]:[ Port ]/AppManager/xml/AddMonitor?apikey=[ API KEY ]&type=[ TYPE ]&displayname=[ DISPLAY NAME ]&host=[ HOST NAME ]&port=[ PORT ]&username=[ USERNAME ]&password=[ PASSWORD ]&pollInterval=[ POLL INTERVAL ]&timeout=[ TIMEOUT ]&discoverVM=[ DISCOVER VM ] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common request parameters. Parameter Description type The type of monitor you want to add. The value should be RHEV. host The name of the host where the RHV server is running. port The port number where the RHV server is running. username The user name of the RHV server. password The password of the RHV server. Indicates the way how the virtual machines of the RHV server are to be monitored. Possible values are: discoverVM 1 - Discover the virtual machines in Unmanaged state, and monitor only the health and availability of VMs. 2 - Discover the virtual machines in Managed state and monitor all the defined metrics. Sample Request http://localhost:8989/AppManager/xml/AddMonitor? apikey=47e71c777772a41d1482a394070aaae6&type=RHEV&displayname=rhevtest&host=apm- rhvm1.csez.zohocorpin.com&port=443&username=admin@internal&password=NewPassword&pollInterval= 5&timeout=300&discoverVM=2 Kernel-based Virtual Machine (KVM) Syntax: http://[ APPMANAGER_HOSTNAME ]:[ APPMANAGER_PORT ]/AppManager/xml/AddMonitor?apikey=[ APIKEY ]&type=[ TYPE ]&HostName=[ HOSTNAME ]&displayname=[ DISPLAYNAME ]&mode=[ MODE ]&snmptelnetport=[ PORT ]&username=[ USERNAME ]&password=[ PASSWORD ]&timeout=[ TIMEOUT ]&AddVMS=[ DISCOVERVMs ] With Credential Manager Telnet Mode: http://[ APPMANAGER_HOSTNAME ]:[ APPMANAGER_PORT ]/AppManager/xml/AddMonitor?apikey=[ APIKEY ]&type=[ TYPE ]&HostName=[ HOSTNAME ]&displayname=[ DISPLAYNAME ]&mode=TELNET&snmptelnetport=[ PORT ]&credentialID=[ CREDENTIALID ]&timeout=[ TIMEOUT ]&AddVMS=[ DISCOVERVMs ]&TelnetCredentialDetails=cmTelnet SSH Mode: http://[ APPMANAGER_HOSTNAME ]:[ APPMANAGER_PORT ]/AppManager/xml/AddMonitor?apikey=[ APIKEY ]&type=[ TYPE ]&HostName=[ HOSTNAME ]&displayname=[ DISPLAYNAME ]&mode=SSH&snmptelnetport=[ PORT ]&credentialID=[ CREDENTIALID ]&timeout=[ TIMEOUT ]&AddVMS=[ DISCOVERVMs ]&SSHCredentialDetails=cmSSH The parameters involved in the API request are described below. Also refer to the list of common request parameters.Parameter Description type The type of monitor you want to add. The value should be KVM. HostName The name of the host where the KVM server is running. mode The mode of monitoring for the KVM server. Possible values are SSH and TELNET. snmptelnetport The port number where the KVM server is running. username The user name of the KVM server. password The password of the KVM server. Indicates the way how the virtual machines (VMs) of the KVM server are to be monitored. Possible values are: 0 - VMs will not be discovered. AddVM 1 - VMs will be discovered but the metrics will not be monitored. (Will not count for licensing) 2 - VMs will be discovered and monitored. Sample Request: http://ProductionServer:6060/AppManager/xml/AddMonitor? apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm- server&displayname=kvm&mode=TELNET&snmptelnetport=23&username=test&password=pwd&timeout=4 0&AddVMS=2 With Credential Manager Telnet Mode: http://ProductionServer:6060/AppManager/xml/AddMonitor? apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm- server&displayname=kvm&mode=TELNET&snmptelnetport=23&credentialID=3&timeout=40&AddVMS=2&Te lnetCredentialDetails=cmTelnet SSH Mode: http://ProductionServer:6060/AppManager/xml/AddMonitor? apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm- server&displayname=kvm&mode=SSH&snmptelnetport=23&credentialID=3&timeout=40&AddVMS=2&SSHC redentialDetails=cmSSH OpenShift Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OpenShift &displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&mode=SSH&sshPKAuth=[true/false]&prompt=[Prompt]&OSUsername=[OpenShift Username]&OSPassword=[OpenShiftPassword]&timeout=[Timeout in Sec]&apiMode=[true/false]&OSPort= [OS Port]&OSToken=[Service Account Token]&filterEnabled=[true/false]&filterCondition= [include/exclude]&ProjectName=[Project Name] The parameters involved in the API request are described below. Also refer to the list of common request parameters. Parameter Description type Type of monitor. Value should be OpenShift. displayname Display name of the monitor host Name of the machine at which it is hosted on. port The port number where OpenShift is running. username The user name of the host server.password The password of the host server. mode Mode of authentication. Value should be SSH. sshPKAuth Whether SSH2 is enabled. Value should be true or false. prompt Specify the command prompt value, which is the last character in your command prompt. OSUsername The user name of the OpenShift server. OSPassword The password of the OpenShift server. Option to collect major metrics of Openshift environment through REST API. Possible values are apiMode either true or false. OSPort Port of the OpenShift server. OSToken Service account token of the OpenShift server administrator user. filterEnabled Option to Monitor Specific Project(s) in OpenShift server. (true or false) filterCondition Filtering condition to monitor specific project(s) in OpenShift server. (include or exclude) ProjectName Name of the project(s) to be included/excluded, separated by commas. Sample Request http://prod-server:7700/AppManager/xml/AddMonitor? apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&p ort=22&username=openshift&password=Server@123&mode=SSH&sshPKAuth=false&prompt=$&OSUsernam e=admin&OSPassword=admin&timeout=40 With Credential ID: http://prod-server:7700/AppManager/xml/AddMonitor? apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&p ort=22&mode=SSH&credentialID=1&OSUsername=admin&OSPassword=admin&timeout=40 Collecting major metrics through REST API: http://prod-server:7700/AppManager/xml/AddMonitor? apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&p ort=22&username=openshift&password=Server@123&mode=SSH&sshPKAuth=false&prompt=$&OSUsernam e=admin&OSPassword=admin&timeout=40&apiMode=true&OSPort=8443&OSToken=eyJhbGciOiJSUzI1NiIsI nR5cCI6IkpXVCJ9 Monitoring specific project(s): http://prod-server:7700/AppManager/xml/AddMonitor? apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&p ort=22&mode=SSH&credentialID=1&OSUsername=admin&OSPassword=admin&timeout=40&filterEnabled= true&filterCondition=include&ProjectName=proj1,proj2,proj3 Oracle VM (OVM) Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API KEY]&type=[TYPE]&displayname=[DISPLAY NAME]&host=[HOST NAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&pollInterval= [POLL INTERVAL]&discoverVM=[DISCOVER VM]&credentialID=[CREDENTIAL ID]&timeout=[TIMEOUT] The parameters involved in the API request are described below. Also refer to the list of common Request Parameters. Parameter Description type The type of monitor you want to add. The value should be OVM. host The name of the host where the OVM server is running. port The port number where the OVM server is running.username The user name of the OVM server. password The password of the OVM server. Indicates the way how the virtual machines (VMs) of the OVM server are to be monitored. Possible values are: discoverVM 0 - VMs will not be discovered. 1 - VMs will be discovered but the metrics will not be monitored. (Will not count for licensing) 2 - VMs will be discovered and monitored. timeout The server connection timeout value of Oracle VM Manager in seconds. Sample Request http://ProductionServer:6060/AppManager/xml/AddMonitor? apikey=f2fe671bf966e8607382fe9af59e9136&type=OVM&displayname=ovmmanager&host=172.24.158. 227&port=7002&username=admin&password=Oracle2019&pollInterval=2&discoverVM=2&timeout=30 0 http://ProductionServer:6060/AppManager/xml/AddMonitor? apikey=f2fe671bf966e8607382fe9af59e9136&type=OVM&displayname=ovmmanager&host=172.24.158. 227&port=7002&pollInterval=2&discoverVM=2&timeout=300&credentialID=1 Citrix Virtual Apps and Desktop Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=CitrixVirtualAppsAndDesktop &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&authentication=[SQL/Windows]&username= [USERNAME]&password=[PASSWORD]&DBName=[Database Name]&encryption=[true/false]&driverType= [jtdsjdbcdriver/microsoftjdbcdriver]&namedInstance=[true/false]&instance=[Instance Name] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. The value should be CitrixVirtualAppsAndDesktop. host The name of the host where the MS SQL server for Citrix Virtual Apps and Desktop is running. port The port number where the MS SQL server for Citrix Virtual Apps and Desktop is running. displayname The display name of the monitor. username The user name of the user who has permission to access the MS SQL database. password The password of the user who has permission to access the MS SQL database. authentication The type of authentication used. (SQL or Windows) If ''Force Encryption'' is enabled in the server, this value will be true. (Possible values: true or encryption false) The type of driver required for connecting to the database for data collection. driverType (microsoftjdbcdriver or jtdsjdbcdriver) If you want to connect using a Named Instance, set the value as true. (Possible values: true or namedInstance false) instance The name of the instance. Applicable only when the value of namedInstance parameter is true. Sample Request http://prod-server:9090/AppManager/xml/AddMonitor? apikey=123abc456def789ghi987jkl654mno321&type=CitrixVirtualAppsAndDesktop&displayname=CitrixVAD&host=apm- vad&port=1433&authentication=SQL&username=administrator123&password=pass@123&DBName=dbname 123&encryption=false&driverType=microsoftjdbcdriver&namedInstance=false AddMonitor APIs - Converged Infrastructure This section explains how to use the AddMonitor API to add monitors of the category type ''Converged Infrastructure''. The following converged infrastructures are supported: Nutanix CISCO UCS Nutanix Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&UserName=[USERNAME]&Password= [PASSWORD]&addtoGroup=[ADDTOGROUP]&groupID=[GROUPID]&AddVMS=[MONITORVMS] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description         type The type of the monitor you want to add. Value should be Nutanix. host The name of the host in which Nutanix is running. port The port number where Nutanix is running. The password of the user who has permission to access the Nutanix password deployment. The name of the monitor group you want to associate Nutanix monitor to. Not addtoGroup Mandatory. The group ID of the monitor group you want to associate Nutanix monitor to. groupID Not Mandatory. You can specify whether you want to monitor the VMs present in the Nutanix instance or not. Possible values are: AddVMS 0 - Do not discover VMs 1 - Discover VM but do not monitor metrics 2 - Discover and monitor VM metrics. Sample Request Rest-API with Password: http://localhost:9090/AppManager/xml/AddMonitor? apikey=ca986ad1a6b1a445d310670b5278129d&type=Nutanix&displayname=34.83.107.83&host=34.83.107. 83&port=9440&UserName=admin&Password=jUPFS3H7!N&AddVMS=2 Rest-API with Credentials: http://localhost:9090/AppManager/xml/AddMonitor? apikey=1f1741046689f3adcfc3ae2bdc874330&type=Nutanix&displayname=35.247.63.119&host=35.247.63.1 19&port=9440&credentialID=1&AddVMS=2&DiscoverNode=yes CISCO UCS Syntaxhttp://[APM_HOST]:[APM_PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host= [HOSTNAME]&port=[PORT]&isSSLEnabled=[IS SSL ENABLED]&username=[USERNAME]&password= [PASSWORD]&timeout=[TIMEOUT]&displayname=[DISPLAYNAME] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description         type The type of the monitor you want to add. Value should be CiscoUCS. host The name of the host in which the CISCO UCS server is running. port The port number where the CISCO UCS server is running. username The username of the Cisco UCS server. password The password of the Cisco UCS server. isSSLEnabled Denotes if SSL is enabled or not. Possible values are either true or false. timeout The timeout value in seconds. Sample Request: http://localhost:9085/AppManager/xml/AddMonitor? apikey=8f1fa34b3aa5cf06a7d555b3cb6ef5f8&type=CiscoUCS&host=172.24.157.134&port=80&username=uc spe&password=ucspe&timeout=40&displayname=RestAPI&isSSLEnabled=true AddMonitor APIs - Web Server/Services This section explains how to use the AddMonitor API to add monitors of the category type ''Web Server/Services''. The following monitors are supported: Apache Server Apache Solr IIS Server Nginx Server PHP Real Browser Monitor (RBM) URL Monitor Web Server SSL Certificate Monitor Elasticsearch Monitor HAProxy Monitor Web Services Nginx Plus Monitor ME ServiceDeskPlus ME OpManager ME ADManager Plus REST API Monitor Webpage Analyzer Apache Server Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &host=[HOST]&port=[PORT]&serverstatusurl=[SERVERSTATUSURL]&apacheurl=[APACHEURL] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be Apache Server. host The name of the host where the Apache server is running. port The port number where the Apache server is running. apacheauth Denotes whether the Apache server is authenticated. Possible values are true and false. apacheUserName The user name of the Apache server. This is required only if apacheauth value is true. apachepassword The password of the Apache server. This is required only if apacheauth value is true. sslenabled Indicates whether SSL is enabled. The value should be either on or off Indicates whether the Apache Server Status url can be modified. The value should be either serverstatusurl true or false. apacheurl The Apache server status url. Example: http:// server-status?auto Sample Request http://prod-server5:9090/AppManager/xml/AddMonitor? apikey=256d041620d0aee9901558b44706dc84&type=Apache Server&displayname=apmapache&host=shakthiprian&port=8080&serverstatusurl=true&apacheurl=ddss Apache Solr Syntax http://[Host]:[Port]http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type= [TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE] http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]&UserName=[USERNAME]&Password= [PASSWORD] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the database you want to add. Value should be Apache Solr display name Display name of the Apache Solr monitor host The name of the host in which Apache Solr server is running. port The port number where Apache Solr server is running. SSL Denotes if SSL is enabled or not. Value should be either true or false Sample Request http://prod-server8:9091/AppManager/xml/AddMonitor? apikey=90c166a4646e29315a57eca1d6b88858&type=ApacheSolr&displayname=SolrInstance&host=ap p-xp2&port=8993&ssl=false http://localhost:9080/AppManager/xml/AddMonitor? apikey=a5f75b0fd164d85bb6730b0c78a5af86&type=ApacheSolr&displayname=SolrInstance&host=loc alhost&port=7574&ssl=false&UserName=solr&Password=SolrRocksIIS Server Syntax For Applications Manager versions till 15110: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&sslenabled=[true/false] For Applications Manager version 15120 onwards: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password= [PASSWORD]&sslconfigured=[TRUE/FALSE]&donotresolvens=[TRUE/FALSE]&responseheadercheck= [TRUE/FALSE] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be IIS-server. host The name of the host where the IIS is running. port The port number where the IIS is running. username Username of the IIS server. password Password of the IIS server. sslenabled Indicates whether SSL is configured in the IIS server. (true or false) sslconfigured donotresolvens Indicates whether DNS needs to be resolved in the IIS server or not. (true or false) Indicates whether whether the IIS keyword needs to be checked in the response header. responseheadercheck (true or false) Sample Request For Applications Manager versions till 15110: http://prod-server8:9091/AppManager/xml/AddMonitor? apikey=90c166a4646e29315a57eca1d6b88858&type=IIS Server&displayname=apmiis&host=app- xp2&port=80&sslenabled=true For Applications Manager versions 15120 onwards: http://prod-server8:9091/AppManager/xml/AddMonitor? apikey=90c166a4646e29315a57eca1d6b88858&type=IIS-server&displayname=apmiis&host=app- xp2&port=80&username=iisuname&password=iispass&sslconfigured=false&donotresolvens=true&respons eheadercheck=false Nginx Server Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPALYNAME]&host=[HOST]&port=[PORT]&sslenable=[TRUE/FALSE]&nginxauth= [TRUE/FALSE]&username=[USERNAME]&password=[PASSWORD]&nginxstatusurl=[NGNIX STATUS URL]Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be Nginx. host The name of the host where the Nginx server is running. port The port number where the Nginx server is running. nginxauth Denotes whether the Nginx server is authenticated. Possible values are true and false. username The user name of the Nginx server. This is required only if nginxauth value is true. password The password of the Nginx server. This is required only if nginxauth value is true. Nginx Server Status url. The value should be either true or false. Please do insert /(slash) in prefix nginxstatusurl for nginxstatusurl as the example given below. Sample Request: http://operation-server9:9091/AppManager/xml/AddMonitor? apikey=a7867d64c831a50f8eb5be8bcfebab34&type=Nginx&displayname=apmnginx&host=deepak&port=8 080&sslenable=true&nginxauth=true&username=deepak&password=deepak&nginxstatusurl=/nginx_status PHP Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&serverpath=[SERVERPATH] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be PHP. host The name of the host where the PHP is running. port The port number where the PHP is running. serverpath The path to be used for connection. The default value is /phpstats.php Sample Request: http://operation-server9:9091/AppManager/xml/AddMonitor? apikey=90c166a4646e29315a57eca1d6b88858&type=PHP&displayname=apmiis&host=myesuraj&port=80& serverpath=/phpstats.php Real Browser Monitor (RBM) Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&rbmagentID=[RBMAGENTID]&timeout=[TIMEOUT]&scriptname= [SCRIPTNAME] Request Parameters:The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be RBM. rbmagentID The ID of the RBM agent. timeout The timeout value in seconds. scriptname The name of the web script. Sample Request: http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858 &type=RBM&displayname=RBM_test&rbmagentID=10000000&timeout=15&scriptname=newS URL Monitor Syntax: http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=[type]&displayname= [displayname]&timeout=[timeout]&url=[httpurl]&urlMethod=[method]&httpCondition= [condition]&httpValue=[responseCode]&checkForContent=[matchContent]&pollInterval= [pollInterval]&regex=true&casesensitive=true Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be UrlMonitor. displayname Name of the monitor to be created. timeout The timeout value in seconds. url The HTTP / HTTPS URL address that you want to monitor. This method specifies how to send form-data. Value should be G / P for Get and Post urlMethod respectively. httpCondition Error Response Code condition. Value should be LT / GT / EQ / NE / LE / GE (default GT). The response code number based on which the monitor will be shown as up or down (default httpValue 200). requestParams Specify the request parameters(eg., username, password). checkForContent The keyword for content match. verifyError The keyword for error verification. Enter a keyword which when matches with the content in the URL must be notified of error. errorIfMatch Note: The search is case sensitive. Multiple keywords should be put within quotes. Otherwise, it will be treated as ''Any'' one of the multiple keywords userName Provide the User name if the URL requires Form-based authentication. password Provide password, if the URL requires Form-based authentication. Specify the payload type for POST form submission method. The types are FORM, Text, XML, payload JSON. Specify if the content for content check contains a regular expression. The value of this field regex should be ''true'', if you want to enable it. Specify if you want to do a case sensitive keyword search. The value of this field should be casesensitive ''true'', if you want to enable it. Set the User Agent for monitoring the URL. (Values can be added like Mozilla/5.0 userAgent (compatible; MSIE 9.0; Windows Phone OS 7.5; Trident/5.0; IEMobile/9.0)) sslVersion Specify the version of SSL configured for the URL. The values can one of the following values: SSLv3, TLSv1, TLSv1.1 or TLSv1.2. Default value will be Auto. (NON-MANDATORY PARAMETER)Sample Request: http://prod-server8:9090/AppManager/xml/AddMonitor? apikey=90c166a4646e29315a57eca1d6b88858&type=UrlMonitor&displayname=appmanager&timeout=60 &url=http://appmanager.com&urlMethod=G&httpCondition=EQ&httpValue=200&requestParams=username =appAdmin%0Apassword=adminPass%0Arole=admin&checkForContent=Applications&verifyError=Exceptio n&errorIfMatch=quit&regex=true&casesensitive=true Web Server Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME] &host=[HOST]&port=[PORT] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be Web Server. host The name of the host where the web server is running. port The port number where the web server is running. Sample Request: http://prod-server8:9091/AppManager/xml/AddMonitor? apikey=90c166a4646e29315a57eca1d6b88858&type=Web Server&displayname=apmweb&host=app- xp2&port=80 SSL Certificate Monitor Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey= [APIKEY]&type=SSLCertificateMonitor&displayname=[displayName]&domain=[domain]&port= [port]&monitorLeafCertOnly=[true/false] Request Parameters: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the monitor you want to add. Value should be SSLCertificateMonitor. host The name of the host where the SSL Certificate Monitor is running. port The port number where the SSL Certificate Monitor is running. domain Enter the Domain name for which SSL certificate is required to be monitored. Use isProxyNeeded if the server is connected through proxy. Possible values are: isProxyNeeded isProxyNeeded=true isProxyNeeded=false ignoreHostNameError Specify if you want to Ignore SSL Certificate name mismatch error.Possible Values are:ignoreHostNameError=true ignoreHostNameError=false Option to ignore invalid root and intermediate certificate. If the value is not passed, then monitorLeafCertOnly it is assumed to be true. (true or false) timeout Enter the Timeout value in seconds. Sample Request: http://prod-server8:9091/AppManager/xml/AddMonitor? apikey=bc76b1abb8e9b209824a39d84578a194&type=SSLCertificateMonitor&displayname=SSLCertificate Monitor&domain=www.zoho.com&port=443&timeout=60&monitorLeafCertOnly=false Elasticsearch Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&ssl=[true/false]&DiscoverAllNodes=[Yes/No] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. Value should be ElasticSearchCluster. displayname The display name of the Elasticsearch monitor. host The name of the host in which Elasticsearch server is running. port The port number where Elasticsearch server is running. ssl Specfies if SSL is enabled or not. Value can be either true or false. DiscoverAllNodes Specifies if you want to discover nodes in Elasticsearch cluster. (Yes/No) Sample Request http://localhost:9097/AppManager/xml/AddMonitor? apikey=7c18de184b2c8b1caa8d65790b382f32&type=ElasticSearchCluster&displayname=localhost&host=lo calhost&port=9200&ssl=false To discover nodes: http://localhost:9097/AppManager/xml/AddMonitor?apikey=7c18de184b2c8b1caa8d65790b382f32& DiscoverAllNodes=Yes&type=ElasticSearchCluster&host=104.49.30.30&port=9200&ssl=false&displayname =test HAProxy Monitor Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=HAProxy&displayname= [DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE] Request Parameters:The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. type The type of the monitor you want to add. Value should be HAProxy. displayname The display name of the HAProxy monitor. host The name of the host in which HAProxy server is running. port The port number where HAProxy server is running. ssl Specfies if SSL is enabled or not. Value can be either true or false. Web Services Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Web Service&displayname= [DISPLAYNAME]&WSDLUrl=[WSDLURL]&endPointUrl=[ENDPOINTURL]&resFulWebservice=[true/false]&haid= [Monitor GroupId]&username=[USERNAME]&password=[PASSWORD]&customHeaders[Custom Header]&authToken[Authentication Token] Request Parameter: The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description WSDLUrl The WSDL URL required to add the monitor. endPointUrl The end-point URL required to add the monitor. resFulWebservice Set this value to true to enable REST-compliant Web services. haid The Monitor Group ID. username The username required to invoke the webservice. password The password required to invoke the webservice. You can use our pre-defined headers or create your own custom headers to invoke customHeaders operations. authToken Provide the Authentication Token, if required. Sample Request: http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=d0588c8b72c6e76713ac55c66e8d&type=Web Service&displayname=apmservice&WSDLUrl=http://www.dataaccess.com/webservicesserver/numberconv ersion.wso? WSDL&endPointUrl=http://www.dataaccess.com/webservicesserver/numberconversion.wso&timeout=30& resFulWebservice=true&haid=10001&username=user&password=pass123&customHeaders=test&authToken =authtoken Nginx Plus Syntax: http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NginxPlus&displayname=[Display Name]&host=[Host Name]&port=[Port No]&ssl=[true/false]&UserName=[User Name](optional)&Password= [password](optional) Request Parameter:The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description type The type of the Service you want to add. Value should be NginxPlus. host The name of the host in which Nginx Plus is running. ssl Whether SSL is enabled. Value should be true or false. port The port number where Nginx Plus is running. username The name of the user who has permission to access the Nginx Plus. password The password of the user who has permission to access the Nginx Plus. Sample Request: http://localhost:9092/AppManager/xml/AddMonitor? apikey=961280ec3cd4c76b39c1c9fbd871c5b0&type=NginxPlus&displayname=FromAPI&host=demo.nginx. com&port=443&ssl=true&UserName=test&Password=test ME ServiceDesk Plus Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&hostname=[HOST]&port=[PORT]&ssl=[TRUE/FALSE]&restapiKey= [RestAPIKey]&MonitorPGSQLDB=[MonitorPGSQLDB]&dbtype=[DBType]&DBHost= [DatabaseHost]&DBName=[DataBaseName]&DBPort=[DataBasePort]&DBUserName= [DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description The name or Ip address of the host where Servicedesk-Plus / SDP MSP is Hostname running. Port The Running Port of Servicedesk-Plus / SDP MSP. SSL If Enabled  Specifies if SSL enabled for Servicedesk-Plus / SDP MSP. To generate a new API key in ServiceDesk Plus, follow the steps given below: Log in to ServiceDesk Plus. Go to the Personalize tab available in the top pane. Click API key Generation.You can either select the Never Expire option or specify the date of expiry: If you select the Never Expire option, the key will be used in restapiKey Applications Manager, until you generate a new key. If you have set a date of expiry, you must manually update the new key in APM after that set time period for data collection to happen. Click Generate. Copy the API Key generated to use it in Applications Manager. Specify if you wish to monitor PGSQL Database with Yes/No. Displaying the MonitorPGSQLDB respective tab in UI depends on this value. (Case Sensitive) DBType The Database Type. Values can be pgsql or mssql. (Case Sensitive)Field Description DBName, DBPort, DBUserName PostgresSQL database credentials. and DBPassword SSLEnabled True if the SSL is enabled. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=5b43655d12396a7917e5d5b036ced3aa&type=SDPMonitor&displayname=satya_sdp&hostname=sat yavani-0618&port=8081&ssl=false&restapiKey=5B7ADE19-D4D7-4556-9F54- 07FAF42D2C29&MonitorPGSQLDB=Yes&dbtype=[DBType]&DBHost=[DatabaseHost]&DBName= [DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword= [DBPassword]&namedInstance=[IsNameInstance]&instance=[instance] ME OpManager Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OPMMonitor&hostname= [HOST]&port=[PORT]&authEnabled=[true/false]&username=[USERNAME]&password= [PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath=[JNDIPATH]&MonitorPGSQLDB=[Yes/No]&dbtype= [DBType]&DBHost=[DatabaseHost]&DBName=[DataBaseName]&DBPort=[DataBasePort]&DBUserName= [DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance= [instance]&SSLEnabled=[SSLEnabled] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description Hostname The name or Ip address of the host where ME OPManager is running. Port The running port of ME OPManager. authEnabled Specifies if authentication is enabled for ME OPManager. username and password Credential of the user. JNDIPath JNDIPATH for installation of OpManager Specify if you wish to monitor PGSQL Database with Yes/No. Displaying the MonitorPGSQLDB respective tab in UI depends on this value. (Case Sensitive) DBType The Database Type. Values can be pgsql or mssql. (Case Sensitive) DBName, DBPort, DBUserName PostgresSQL database credentials. and DBPassword SSLEnabled True if the SSL is enabled. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=38cb51649cf3ac0614c3aab294a7bebd&type=OPMMonitor&hostname=172.21.151.93&port=1998&au thEnabled=false&username=&password=&displayname=testOPM&JNDIPath=/jmxrmi&MonitorPGSQLDB=Ye s&dbtype=pgsql&DBHost=172.21.151.93&DBPort=13306&DBName=OpManagerDB&DBUserName=postgres& namedInstance=[IsNameInstance]&instance=[instance]&SSLEnabled=false ME ADManager Plus Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ADMPMonitor&hostname= [HOST]&port=[PORT]&authEnabled=[AUTHENABLED]&username=[USERNAME]&password=[PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath=[JNDIPATH]&MonitorPGSQLDB=[Yes/No]&dbtype= [DBType]&DBHost=[DatabaseHost]&DBName=[DataBaseName]&DBPort=[DataBasePort]&DBUserName= [DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance= [instance]&SSLEnabled=[SSLEnabled] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field  Description hostname The name or Ip address of the host where ADManager Plus is running. port The Running Port of ADManager Plus. authEnabled Specifies if authentication is enabled. username and password Credential of the user. displayname The displayname of the ADManager Plus monitor. JNDIPath The JNDIPATH for installation of ADManager Plus. Specify if you wish to monitor PGSQL Database with Yes/No. Displaying the MonitorPGSQLDB respective tab in UI depends on this value. (Case Sensitive) dbtype The Database Type. Values can be pgsql or mssql. (Case Sensitive) DBName, DBPort, DBUserName PostgresSQL database credentials. and DBPassword SSLEnabled Specifies if SSL enabled for ADManager Plus. Sample Request http://prod-server3:9090/AppManager/xml/AddMonitor? apikey=3be1ffd5109b27613464da89545964ba&type=ADMPMonitor&hostname=localhost&port=1991&auth Enabled=false&username=&password=&displayname=test&JNDIPath=/jmxrmi&MonitorPGSQLDB=Yes&dbty pe=pgsql&DBHost=satyavani- 0618&DBName=DB&DBPort=13306&DBUserName=postgres&DBPassword=postgres&namedInstance=false &SSLEnabled=false REST API Monitor Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API Key]&type=RESTAPIMonitor&displayname= [Display Name]&API=[REST API URL]&Timeout=[Timeout Value in Seconds]&Method= [GET/POST/PUT/DELETE]&RespType=[XML]&UserName=[Username]&Password=[Password] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Parameter Description type The type of the monitor you want to add. Value should be RESTAPIMonitor displayname The display name of the monitor. API The API call to be monitored. The amount of time spent by APM to establish a connection with the server Timeout hosting the API service (in seconds). The Form Submission method used to access the API. Method (GET/POST/PUT/DELETE) RespType The type of response to be expected.(Text/XML/JSON). The format in which request data will be sent (applicable only for POST & PUT payLoadType methods). Value can be FORM, Text, XML or JSON.Parameter Description payLoad The request data (the format should match the payLoadType specified). Specify the headers to establish a connection with the API server. Use sep to customHeaders separate the header name and value. For specifying multiple headers, use the separator # (Please encode the request parameters if they are sent via GET). Sample Request http://Prod-server7:9010/AppManager/xml/AddMonitor? apikey=8519e4fadfd79d5dc78bce7489bd9319&type=RESTAPIMonitor&displayname=Dummy&API=https://w ww.google.co.in/&Timeout=10&Method=POST&payLoadType=Text&payLoad=PayloadContent&customHea ders=Accept_sep_application/json; version=2.0#User-Agent_sep_Mozilla/5.0 (Windows NT 6.3;Win64; x64)&UserName=User1&Password=Pass_123 Webpage Analyzer Syntax http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname= [DISPLAYNAME]&webpageURL=[WEBPAGEURL]&pageLoadTimeout=[PAGELOADTIME]&timeToWaitForAjax= [WAITTIME]&Method=[GET/POST]&UserName=[USERNAME]&Password=[PASSWORD]&blockDomains= [DOMAINS TO BLOCK]&ContentCheck=[True/False]&RegexString=[REGEXSTRING]&contains=[STRING TO BE PRESENT]&notContain=[STRING NOT TO BE PRESENT]&isCaseSensitive= [True/False]&enableSSLMonitoring=[True/False]&domain=[DOMAIN NAME]&port=[PORT]&isProxyNeeded= [True/False]&ignoreHostNameError=[True/False]&Timeout=[TIMEOUT] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Parameter Description type The type of the monitor you want to add. Value should be WebpageAnalyzer displayname The display name of the monitor. webpageURL The URL of the webpage to be monitored. pageLoadTimeout Maximum time (in seconds) for the page to load. timeToWaitForAjax Time (in seconds) to wait after page load. This method specifies how to send form-data. Value should be either GET or Method POST. UserName Username of the webpage if the URL requires Basic authentication. Password Password of the webpage if the URL requires Basic authentication. Domains to block from monitoring separated by blockDomains "|". Example: adshost2.com|ad.turn.com ContentCheck Option to add content check for response. (True or False) RegexString Regular expression to be checked in the response if it is present or not. contains Content to be present in response. notContain Content that should not be present in response. isCaseSensitive Option to perform a case sensitive keyword search. (True or False) enableSSLMonitoring Option to enable SSL cerificate monitoring. (True or False) domain The domain name for which SSL certificate is required to be monitored. port The port number where the domain server is running. isProxyNeeded Use isProxyNeeded if the server is connected through proxy. (True or False) ignoreHostNameError Option to ignore SSL Certificate name mismatch error. (True or False) Timeout The timeout value in seconds.Sample Request http://Prod-server7:9010/AppManager/xml/AddMonitor? apikey=8519e4fadfd79d5dc78bce7489bd9319&type=WebpageAnalyzer&displayname=WPA&webpageURL= https://www.zoho.com/&pageLoadTimeout=30&timeToWaitForAjax=1&Method=GET&UserName=admin&P assword=admin&blockDomains=www.zohowebstatic.com&ContentCheck=True&RegexString=zi*&contains =APM&notContain=ME&isCaseSensitive=True&enableSSLMonitoring=True&domain=www.zoho.com&port=4 43&isProxyNeeded=False&ignoreHostNameError=True&Timeout=120 MaintenanceTask API The APIs given below allow you to work with downtime schedules in Applications Manager: Create Downtime Scheduler Task Delete Downtime Scheduler Task Edit Downtime Scheduler Task Get Downtime Scheduler Task Details Request Parameters The common parameters involved in these API requests are described below: Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. taskName The name of the maintenance task. This should be a unique value. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. Current status of the schedule. You have to choose from either ''enable'' or taskStatus ''disable'' taskid The unique identifier for the task The resource id of the monitor or monitor group for which the schedule has resourceid to be created Sample Request: This example helps you to create a downtime schedule in Applications Manager: http://app-windows:9090/AppManager/xml/CreateMaintenanceTask? apikey=bdd4d0643c6f591e123b7ba6fb69d9dd&taskMethod=daily &taskStartTime=20:00&taskEndTime=21:00&taskStatus=disable&taskEffectFrom=2010-05- 24%2016:48&taskName=dr1&taskType=monitor&resourceid=10000055 If the API is not executed correctly, the request will fail and errors will be thrown. Refer this page for a list of common error conditions. Creating Downtime Scheduler Tasks This API allows the user to create downtime schedules in Applications Manager. The schedules can be created with any of the following recurrence types:  Daily Weekly Monthly Once You can schedule a maintenance task for for monitor groups as well as individual monitors. To configure a schedule for a monitor group, just provide the tasktype as group and resourceid as the monitor group id. Downtime Schedule with Recurring type Daily Syntax http://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey= [APIKEY]&taskMethod=daily&taskStartTime=[STARTTIME]& taskEndTime= [ENDTIME]&taskStatus=disable&taskEffectFrom=[DATE]&taskName= [NAME]&taskType=monitor&resourceid=[RESOURCEID] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         Denotes the recurring frequency of the maintenance schedule, ''daily'' taskMethod indicates the schedule runs every day. taskStartTime The time when the maintenance task starts running taskEndTime The time when the maintenance task stops running taskEffectFrom The date and time from which the maintenance task becomes active The difference in the number of hours with respect to GMT. If the offset value offset provided is invalid, Applications Manager uses the user''s system time as the offset value. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created Example http://app-windows:9090/AppManager/xml/CreateMaintenanceTask? apikey=bdd4d0643c6f591e123b7ba6fb69d9dd&taskMethod=daily &taskStartTime=20:00&taskEndTime=21:00&taskStatus=disable&taskEffectFrom=2010-05- 24%2016:48&taskName=dr1 &taskType=monitor&resourceid=10000055   Output for the above example:                      Maintenance Task successfully created.            Downtime Schedule with Recurring type Weekly Syntax http://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskType= [TASKTYPE]&resourceid=[RESOURCEID] &totalNumber=[TOTALNUMBER]&taskMethod= [TASKMETHOD]&taskDescription=[TASKDESCRIPTION]&taskStatus=[TASKSTATUS] &taskEffectFrom= [DATETIME]&startDay1=[STARTDAY1]&startTime1=[STARTTIME1]&endDay1=[ENDDAY1]&endTime1= [ENDTIME1] &taskName=[TASKNAME] Request ParametersThe parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         The number of schedules to be created. You can create a maximum of 7 totalNumber weekly schedules Denotes the recurring frequency of the maintenance schedule, ''weekly'' taskMethod indicates the schedule runs every week. taskDescription The description of what the maintenance schedule does, optional value. taskEffectFrom The date and time from which the maintenance task becomes active The day on which the maintenance task starts running. The allowed values for startDay[n] n are 1,2,3,4,5,6 and 7 The time when the maintenance task starts running. The allowed values for n startTime[n] are 1,2,3,4,5,6 and 7 The day on which the maintenance task stops running. The allowed values for endDay[n] n are 1,2,3,4,5,6 and 7 The difference in the number of hours with respect to GMT. If the offset value offset provided is invalid, Applications Manager uses the user''s system time as the offset value. The time at which the maintenance task stops running. The allowed values for endTime[n] n are 1,2,3,4,5,6 and 7 The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created Example http://app-windows:9090/AppManager/xml/CreateMaintenanceTask? apikey=983a7d7ed56c5753f4977df5883e2b2d&taskType=monitor &resourceid=10000028&totalNumber=1&taskMethod=weekly&taskDescription=&taskStatus=disable&taskEf fectFrom=2010-06-01%2011:25 &startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week Note: You can create up to 7 weekly schedules at one go. Downtime Schedule with Recurring type Monthly Syntax Schedule by week: http://[host]:[port]/AppManager/[xml/json]/CreateMaintenanceTask?apikey=[apikey]&taskType= [monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskDescription= [descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representing months]&dateOrWeekWise=[week]&startsOn1=[First/Second/Third/Fourth/Last]&startDay1= [day]&startTime1=[HH:mm]&endAfter1=[1-7]&endTime1=[HH:mm] Schedule by date: http://[host]:[port]/AppManager/[xml/json]/CreateMaintenanceTask?apikey=[apikey]&taskType= [monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskDescription= [descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representing months]&dateOrWeekWise=[date]&startDate1=[date]&last1=[on]&startTime1=[HH:mm]&endDate1= [date]&endTime1=[HH:mm] Request ParametersThe parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         API Key The key generated from "Generate API Key" option in the Admin tab. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created. totalNumber Number of schedules. Denotes the recurring frequency of the maintenance schedule, ''monthly'' taskMethod indicates the schedule runs every week. The description of what the maintenance schedule does. This parameter is taskDescription optional. taskStatus Enabled or disabled. taskEffectFrom The date and time when the schedule starts running. taskName Name of the task. months The months for which the schedule is supposed to run. dateOrWeekWise Whether it should be scheduled weekwise or datewise. startsOn1 The week of the month the schedule should start running. startDay1 The day of the week the schedule should start running. startTime1 The time at which the schedule should start running. endAfter1 Number of days it should end after. endTime1 Time at which the schedule should end. startDate1 Date number at which the schedule starts. startTime1 Time at which the schedule should start. endDate1 Date number at which the schedule should end. endTime1 Time at which the schedule should end. The difference in the number of hours with respect to GMT. If the offset value offset provided is invalid, Applications Manager uses the user''s system time as the offset value. This option enables you to specify the date in reverse order. This is not last1 mandatory. Value should be ''on'' if this is included. Example Schedule by week: http://apm-8763:9090/AppManager/xml/CreateMaintenanceTask? apikey=68349d4c15833951f34d1cc7fb53f16a&taskType=monitor&resourceid=10000015&totalNumber= 1&taskMethod=monthly&taskDescription=none&taskStatus=enable&taskEffectFrom=2010-06- 01%2011:25&taskName=monthlyweekwisetask&months=1,2,3,4&dateOrWeekWise=week&startsOn1=First &startDay1=Sunday&startTime1=10:00&endAfter1=2&endTime1=20:10 Schedule by date: http://apm-8763:9090/AppManager/xml/CreateMaintenanceTask? apikey=68349d4c15833951f34d1cc7fb53f16a&taskType=monitor&resourceid=10000015&totalNumber= 2&taskMethod=monthly&taskDescription=none&taskStatus=enable&taskEffectFrom=2010-06- 01%2011:25&taskName=monthlydatewisetask&months=1,2,3,4&dateOrWeekWise=date&startDate1=2&la st1=&startTime1=10:00&endDate1=2&endTime1=20:10&startDate2=2&last2=on&startTime2=10:00&end Date2=1&endTime2=20:10 Downtime Schedule with Recurring type Once Syntaxhttp://[host]:[port]/AppManager/xml/CreateMaintenanceTask?apikey=[apikey]&totalNumber=[1- 5]&taskMethod=once&customTaskStartTime1=[yyyy-mm-dd HH:mm]&customTaskEndTime1=[yyyy-mm-dd HH:mm]&customTaskStartTime2=[yyyy-mm-dd HH:mm]&customTaskEndTime2=[yyyy-mm-dd HH:mm]&taskStatus=[enable/disable]&taskName=[NAME]&taskType=[monitor/group]&taskDescription= [Description]&resourceid=[ResourceID]&totalNumber=[1-5] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. Field Description         API Key The key generated from "Generate API Key" option in the Admin tab. Denotes the recurring frequency of the maintenance schedule, ''weekly'' taskMethod indicates the schedule runs every week. customTaskStartTime The date and time when the schedule starts running customTaskEndTime The date and time when the schedule stops running The description of what the maintenance schedule does. This parameter is taskDescription optional. The difference in the number of hours with respect to GMT. If the offset value offset provided is invalid, Applications Manager uses the user''s system time as the offset value. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created totalNumber Number of schedules. You can specify upto 5 schedules. Example Without totalNumber parameter: http://app-windows:9090/AppManager/xml/CreateMaintenanceTask? apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once &customTaskStartTime=2010-06- 03%2012:46&customTaskEndTime=2010-06-05%2012:46&taskStatus=disable&taskName=once &taskType=monitor&taskDescription=&resourceid=10000322  With totalNumber parameter: http://app-windows:9090/AppManager/xml/CreateMaintenanceTask? apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once &customTaskStartTime1=2010-06- 03%2012:46&customTaskEndTime1=2010-06-05%2012:46&customTaskStartTime2=2010-07- 03%2012:46&customTaskEndTime2=2010-07-05%2012:46&taskStatus=disable&taskName=once &taskType=monitor&taskDescription=once with 2 shedules&resourceid=10000322&totalNumber=2 Note: When totalNumber parameter is specified, the customTaskStartTime and customTaskEndTime parameters have to be defined for the affirmed number of times. Check the example above for an idea about how it should be defined. You can obtain the resourceid of a monitor by executing the ListMonitor API request. The output of this request contains resourceid of the monitor, among other values. Edit Downtime Scheduler Tasks APIs This API allows the user to edit downtime schedules in Applications Manager. Users can edit schedules with the following recurring types: Daily Weekly Monthly OnceYou can schedule a maintenance task for for monitor groups as well as individual monitors. To configure a schedule for a monitor group, just provide the tasktype as group and resourceid as the monitor group id. Editing Downtime Schedule with Recurring type Daily Sample Request: http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod= [TASKMETHOD]&taskStartTime=[TASKSTARTTIME] &taskEndTime=[TASKENDTIME]&taskStatus=[TASKSTATUS]&taskEffectFrom= [TASKEFFECTFROM]&taskName=[TASKNAME]&taskType=[TASKTYPE] &resourceid=[RESOURCEID]&taskid=[TASKID]&overwriteAssociatedResources=[TRUE/FALSE] Request Parameters The parameters involved in the API request are described below. Also, refer the list of common Request Parameters involved in executing the EditMaintenanceTask API requests. Field Description Denotes the recurring frequency of the maintenance schedule, ''daily'' taskMethod indicates the schedule runs every day. taskStartTime The time when the maintenance task starts running taskEndTime The time when the maintenance task stops running taskEffectFrom The date and time from which the maintenance task becomes active The difference in the number of hours with respect to GMT. If the offset value offset provided is invalid, Applications Manager uses the user''s system time as the offset value. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created Enables overwriting of already associated resources. This means that if the value of the parameter is true, the already associated resource Ids are deleted and the newly provided ids and used in the task. Possible values are: overwriteAssociatedResources True False Example: http://localhost:9000/AppManager/xml/EditMaintenanceTask? apikey=8563ac093c573d7096def3826c5bafd9&taskMethod=daily&taskStartTime=20:00&taskEndTime=21: 00&taskStatus=enable&taskEffectFrom=2018-08- 08%2016:48&taskName=test&taskType=monitor&resourceid=10000017&taskid=10000001&overwriteAsso ciatedResources=false Example output:                      Maintenance Task successfully edited.            Editing Downtime Schedule with Recurring type Weekly Sample Request:http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskType= [TASKTYPE]&resourceid=[RESOURCEID]&totalNumber=[TOTALNUMBER] &taskMethod=[TASKMETHOD]&taskDescription=[TASKDESCRIPTION]&taskStatus= [TASKSTATUS]&taskEffectFrom=[DATETIME]&startDay1=[STARTDAY1] &startTime1=[STARTTIME1]&endDay1=[ENDDAY1]&endTime1=[ENDTIME1]&taskName=[TASKNAME]&taskid= [TASKID]&overwriteAssociatedResources=[TRUE/FALSE] Request Parameters The parameters involved in the API request are described below. Also, refer thelist of common Request Parameters involved in executing the EditMaintenanceTask API requests. Field Description The number of schedules to be created. You can create a maximum of 7 totalNumber weekly schedules Denotes the recurring frequency of the maintenance schedule, ''weekly'' taskMethod indicates the schedule runs every week. taskDescription The description of what the maintenance schedule does, optional value. taskEffectFrom The date and time from which the maintenance task becomes active The day on which the maintenance task starts running. The allowed values for startDay[n] n are 1,2,3,4,5,6 and 7 The time when the maintenance task starts running. The allowed values for n startTime[n] are 1,2,3,4,5,6 and 7 The day on which the maintenance task stops running. The allowed values for endDay[n] n are 1,2,3,4,5,6 and 7 The time at which the maintenance task stops running. The allowed values for endTime[n] n are 1,2,3,4,5,6 and 7 The difference in the number of hours with respect to GMT. If the offset value offset provided is invalid, Applications Manager uses the user''s system time as the offset value. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created. Enables overwriting of already associated resources. This means that if the value of the parameter is true, the already associated resource Ids are deleted and the newly provided ids and used in the task. Possible values are: overwriteAssociatedResources True False Example: http://app-windows:9090/AppManager/xml/EditMaintenanceTask? apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskType=monitor &resourceid=10000028&totalNumber=1&taskMethod=weekly&taskDescription=&taskStatus=enable&taskEf fectFrom=2010-06-01%2011:25 &startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week1&taskid=10000 004&overwriteAssociatedResources=false Downtime Schedule with Recurring type Monthly Sample Request: Schedule by week: http://[host]:[port]/AppManager/[xml/json]/EditMaintenanceTask?apikey=[apikey]&taskType= [monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskDescription= [descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representingmonths]&dateOrWeekWise=[week]&startsOn1=[First/Second/Third/Fourth/Last]&startDay1= [day]&startTime1=[HH:mm]&endAfter1=[1-7]&endTime1=[HH:mm]&taskid=[downtimeschedulerid]  Schedule by date: http://[host]:[port]/AppManager/[xml/json]/EditMaintenanceTask?apikey=[apikey]&taskType= [monitor/group]&resourceid=[resourceid]&totalNumber=[1-5]&taskMethod=monthly&taskDescription= [descrition of the downtime schedule]&taskStatus=[enable/disable]&taskEffectFrom=[yyyy-mm-dd HH:mm]&taskName=[name of task]&months=[comma seperated numbers representing months]&dateOrWeekWise=[date]&startDate1=[date]&last1=[on]&startTime1=[HH:mm]&endDate1= [date]&endTime1=[HH:mm]&taskid=[downtimeschedulerid] Request Parameters The parameters involved in the API request are described below: Field Description API Key The key generated from "Generate API Key" option in the Admin tab. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created totalNumber Number of schedules Denotes the recurring frequency of the maintenance schedule, ''monthly'' taskMethod indicates the schedule runs every week. The description of what the maintenance schedule does. This parameter is taskDescription optional. taskStatus Enabled or disabled. taskEffectFrom The date and time when the schedule starts running taskName Name of the task months The months for which the schedule is supposed to run. dateOrWeekWise Whether it should be scheduled weekwise or datewise. startsOn1 The week of the month the schedule should start running. startDay1 The day of the week the schedule should start running. startTime1 The time at which the schedule should start running. endAfter1 Number of days it should end after. endTime1 Time at which the schedule should end. startDate1 Date number at which the schedule starts. startTime1 Time at which the schedule should start. endDate1 Date number at which the schedule should end. endTime1 Time at which the schedule should end. Example: Schedule by week: http://apm-8763:9090/AppManager/xml/EditMaintenanceTask? apikey=68349d4c15833951f34d1cc7fb53f16a&taskType=monitor&resourceid=10000015&totalNumber=1&t askMethod=monthly&taskDescription=none&taskStatus=enable&taskEffectFrom=2010-06- 01%2011:25&taskName=monthlyweekwisetask&months=1,2,3,4&dateOrWeekWise=week&startsOn1=First&st artDay1=Sunday&startTime1=10:00&endAfter1=2&endTime1=20:10&taskid=10000001 Schedule by Date: http://apm-8763:9090/AppManager/xml/EditMaintenanceTask? apikey=68349d4c15833951f34d1cc7fb53f16a&taskType=monitor&resourceid=10000015&totalNumber=2&t askMethod=monthly&taskDescription=none&taskStatus=enable&taskEffectFrom=2010-06- 01%2011:25&taskName=monthlydatewisetask&months=1,2,3,4&dateOrWeekWise=date&startDate1=2&last1=&startTime1=10:00&endDate1=2&endTime1=20:10&startDate2=2&last2=on&startTime2=10:00&endDate2=1 &endTime2=20:10&taskid=10000001 Downtime Schedule with Recurring type Once Sample Request: http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod= [TASKMETHOD]&customTaskStartTime=[CUSTOMTASKSTARTTIME] &customTaskEndTime=[CUSTOMTASKENDTIME]&taskStatus=[TASKSTATUS]&taskName= [TASKNAME]&taskType=[TASKTYPE] &taskDescription=[TASKDESCRIPTION]&resourceid=[RESOURCEID]&taskid= [TASKID]&overwriteAssociatedResources=[TRUE/FALSE] Request Parameters The parameters involved in the API request are described below: True False Field Description Denotes the recurring frequency of the maintenance schedule, ''weekly'' taskMethod indicates the schedule runs every week. customTaskStartTime The date and time when the schedule starts running customTaskEndTime The date and time when the schedule stops running The description of what the maintenance schedule does. This parameter is taskDescription optional. The difference in the number of hours with respect to GMT. If the offset value offset provided is invalid, Applications Manager uses the user''s system time as the offset value. The type of task to be created. Possible values are monitor (for an individual taskType monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group. The resource id of the monitor or monitor group for which the schedule has resourceid to be created. Enables overwriting of already associated resources. This means that if the overwriteAssociatedResources value of the parameter is true, the already associated resource Ids are   deleted and the newly provided ids and used in the task. Possible values are: Example: http://app-windows:9090/AppManager/xml/EditMaintenanceTask? apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once &customTaskStartTime=2010-06-03%2012:46&customTaskEndTime=2010-06- 05%2012:46&taskStatus=enable&taskName=once1 &taskType=monitor&taskDescription=&resourceid=10000322&taskid=10000005&overwriteAssociatedRes ources=false Note: You can obtain the resourceid of a monitor by executing the ListMonitor API request. The output of this request contains resourceid of the monitor, among other values. GetMaintenanceTaskDetails / ListMaintenanceTaskDetails API This API allows the user to view the details of downtime schedules configured in Applications Manager. Sample Request http://[ Host ]:[ Port ]/AppManager/xml/ListMaintenanceTaskDetails?apikey=[APIKEY]Request Parameters The parameters involved in the API request are described below: Field Description apikey The key generated from "Generate API Key" option in the Admin tab. Example http://app-windows:9090/AppManager/xml/ListMaintenanceTaskDetails? apikey=93c6eb60184e41f10fba2f365060b8e3 Output for the above example AppManager-response uri="/AppManager/xml/ListMaintenanceTaskDetails">                                                                                                                  DeleteMaintenanceTask API This API allows the user to delete a downtime schedule in Applications Manager. Sample Request http://[ Host ]:[ Port ]/AppManager/xml/DeleteMaintenanceTask?apikey=[APIKEY ]&taskid=[ TASKID] Request Parameters The parameters involved in the API request are described below: Field Description API Key The key generated from "Generate API Key" option in the Admin tab. taskid The TASKID in the AM_MAINTENANCECONFIG table Example: http://app-windows:9090/AppManager/xml/DeleteMaintenanceTask?apikey=5bc6a8e9a30d5bf894586d4db90282f5&taskid=10000001 Output for the above example:                      Maintenance Task successfully deleted.            Edit Monitor API With the APIs given below, you can edit or modify the details of a specific monitor: DNS MonitorService Monitor SSL Certificate Monitor Http URL Monitor Request Parameters The common parameters involved in these API requests are described below: Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. The display name for the monitor. Html encoding for special characters is displayname required (ex: Html encoding for & is & and" is "). The new display name for the monitor. Html encoding for special characters is newdisplayname required (ex: Html encoding for & is &and " is "). host The host name of applications manager server. The interval at which the server needs to be polled. The default value is 5 pollInterval minutes. port The port of Applications Manager server. The unique id which can be found from AM_ManagedObject table in the resourceid database. Sample Request This example helps you to edit the display name of a service monitor in Applications Manager: http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=ServiceMonitoring&resourceid= [RESOURCEID]&newdisplayname=[NEWDISPLAYNAME]&pollInterval=[pollInterval]&command= [COMMAND]&search=[SEARCH] If the API is not executed correctly, the request will fail and errors will be thrown. Edit DNS Monitor API This API allows you to edit the values used in the DNS Monitors. APIs for Edit DNS Monitor By Resource ID: http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=DNSMonitor&resourceid= [RESOURCEID]&newdisplayname=[NEWDISPLAYNAME]&pollInterval=[pollInterval]&domain= [DOMAIN]&isProxyNeeded=[ISPROXYNEEDED]&timeout=[TIMEOUT] By Display Name: http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=DNSMonitor&displayname= [DISPLAYNAME]&newdisplayname=[DISPLAYNAME]&pollInterval=[pollInterval]&LookupAddress= [LOOKUPADDRESS]&RecordType=[RECORDTYPE]&SearchField=[SEARCHFIELD]&SearchValue= [SEARCHVALUE]&TargetAddress=[TARGETADDRESS]&timeout=[TIMEOUT] Request Parameters Field Description LookupAddress The address you want to check in the DNS Server. The expected record type returned for the lookup address. The options include RecordType -None-, A, AAAA, CNAME, MX, NS, PTR, SOA, SPF, SRV, TXT. The value of Search Field. Options include -None-, Record Name, Address, SearchField Additional Name, Target, Admin, Host, Alias, Port, Priority.SearchValue The value you want to search in the specified field. TargetAddress Host Name / IP Address of the DNS Server. timeout The timeout value in seconds. Other Common APIs Example Requests http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=DNSMonitor&resourceid=10000657&LookupAd dress=sample http://app-windows:9090/AppManager/xml/ EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=DNSMonitor&resourceid=10000657&RecordTyp e=AAAA http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=DNSMonitor&resourceid=10000657&SearchFiel d=Host http://app-windows:9090/AppManager/xml/ EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=DNSMonitor&resourceid=10000657&SearchVal ue=zoho http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=DNSMonitor&resourceid=10000657&TargetAdd ress=192.168.5.11 http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=DNSMonitor&resourceid=10000657&LookupAd dress=sample&RecordType=AAAA&SearchField=Host&SearchValue=zoho&TargetAddress=192.168.5.11 &timeout=45 Edit Service Monitor API This API allows you to edit the details of the service monitors. APIs for Edit Service Monitor http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=Service Monitoring&resourceid= [RESOURCEID]&newdisplayname=[NEWDISPLAYNAME]&pollInterval=[poll Interval]&command= [COMMAND]&search=[SEARCH] ( OR ) http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=Service Monitoring&displayname=[DISPLAYNAME]&newdisplayname=[DISPLAYNAME]&pollInterval=[pollIn terval]&command=[COMMAND]&search=[SEARCH] Request Parameters Field Description command The command that will be executed after connecting to the port. search The string that has to be searched after executing the command Other Common APIs Example Requests http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=Service Monitoring&resourceid=10000116&newdisplayname=zohohttp://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=Service Monitoring&resourceid=10000116&command=GET / HTTP1.1 http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=Service Monitoring&resourceid=10000116&search=h http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=Service Monitoring&resourceid=10000116&pollInterval=10&search=&command=GET/HTTP1.0&newdisplaynam e=zoho Edit SSL Certificate Monitor API This API allows you to edit the values provided in the SSL certificate monitor. APIs for Edit Service Monitor: http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey= [APIKEY]&type=SSLCertificateMonitor&resourceid= [RESOURCEID]&newdisplayname= [NEWDISPLAYNAME]&pollInterval=[pollInterval]&domain=[DOMAIN]&isProxyNeeded= [ISPROXYNEEDED] &timeout=[TIMEOUT] http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey= [APIKEY]&type=SSLCertificateMonitor&displayname= [DISPLAYNAME]&newdisplayname= [DISPLAYNAME]&pollInterval=[pollInterval]&domain=[DOMAIN]&isProxyNeeded= [ISPROXYNEEDED]&timeout=[TIMEOUT] Request Parameters: Field Description The domain name for the SSL certificate which should domain be monitored. isProxyNeeded Yes, if server is connected through proxy. No, if its not. timeout The Timeout value in seconds Other Common APIs and error conditions. Example Requests: http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=SSLCertificateMonitor&resourceid=10000661& pollInterval=10 http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=SSLCertificateMonitor&resourceid=10000661& domain=zoho.com http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=SSLCertificateMonitor&resourceid=10000661&t imeout=60 http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=SSLCertificateMonitor&resourceid=10000661&i sProxyNeeded=Yes http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=SSLCertificateMonitor&resourceid=10000661& domain=zoho.com&isProxyNeeded=No&timeout=60 Edit URL Monitor API This API allows you to edit the values configured in the URL Monitors. Syntax for editing URL MonitorUsing Resource ID: http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=UrlMonitor&resourceid= [RESOURCEID] By Display Name: http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=UrlMonitor&displayname= [DISPLAYNAME] Using URL: http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=UrlMonitor&url=[URL] Request Parameters Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. resourceID The resourceid of the URL monitor that you are going to edit. displayname The display name of the HTTP-URL monitor. url The HTTP/HTTPS URL address that you want to monitor. The keyword for content matching. The URL monitoring searches the keyword checkForContent in the content of the URL page to check the availability of the URL. This field is optional. The keyword which when matches with the content in the URL must be notified of error . errorIfMatch Note: The search is case sensitive. Multiple keywords should be put within quotes. Otherwise, it will be treated as ''Any'' one of the multiple keywords. The condition/criteria of the Response Code with respect to the httpValue at which error should be notified. Possible values are: LT - Lesser than httpValue GT - Greater than httpValue httpCondition EQ - Equal to httpValue NE - Not equal to httpValue LE - Lesser than or Equal to GE - Greater than or Equal to httpValue The threshold value with respect to which the httpCondition should be met. The polling interval for which Applications Manager updates the status of the pollInterval monitor. The request parameters. For example, if you want to monitor a URL like http://appmanager:9090/showresource.do? requestParams haid=1&type=UrlMonitor&method=getMonitorForm, then provide "? haid=1&type=UrlMonitor&method=getMonitorForm" as request parameter. The time, in minutes, for which the URL monitor should wait for a page to timeout complete downloading before timing out in Time out field. Choose between the Post and Get method, which are the two types of Form method for any HTTP/HTTPS URL. Possible values are: urlMethod P - Post G - Get userName The Username if the URL requires Form-based authentication. The password for the corresponding Username if the URL requires Form- password based authentication.Field Description Specify if want the monitor to immediately be scheduled to run again for verification, when an error is detected. Possible values are: verifyError True - Verify the error. False - Do not verify the error. Other Common APIs Sample Requests http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=UrlMonitor&resourceid=10000657 http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=UrlMonitor&displayname=APM-URL-Monitor http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=UrlMonitor&url= http://www.zohocorp.com http://app-windows:9090/AppManager/xml/EditMonitor? apikey=9481566a94f26d8e44ee0889fd7628a0&type=UrlMonitor&displayname=APM-URL- Monitor&httpCondition=GT&httpValue=200 Update Schema API This API allows the user to update the schema with custom attributes for REST API monitors from Applications Manager. Syntax XML Input: http://[ APM Host ]:[ APM Port ]/AppManager/xml/updateRestAPIMonitorSchema JSON Input: http://[ APM Host ]:[ APM Port ]/AppManager/json/updateRestAPIMonitorSchema Request Parameters Field Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. resourceid Resource IDs of the REST API monitor separated by commas. responseType Indicates the response type - XML or JSON. schema Schema to be updated for REST API monitor. It should be either in XLST or JSON type. Note: API should be used only through HTTP POST method. Example Request API for monitor with XML Response: XML Input: http://apm-prod1:9090/AppManager/xml/updateRestAPIMonitorSchema Params in request body:apikey=c4e547c2330e2eb92d3e7af2362da9e9 resourceid=10000184,10000185 responseType=XML schema= : API for monitor with JSON Response: JSON Input: http://apm-prod1:9090/AppManager/json/updateRestAPIMonitorSchema Params in request body: apikey=c4e547c2330e2eb92d3e7af2362da9e9 resourceid=10000184,10000185 responseType=JSON schema=Response Code::response-code URI::response.response.uri Example Response Monitor with XML Response: XML Output: Monitor with JSON Response: JSON Output: {"response-code":"4000","response":{"result":[{"Status":"Schema updated for the resourceid(s): 10000185"}],"uri":"/AppManager/json/updateRestAPIMonitorSchema"}} Monitor Group Operations With the APIs given below, you can perform various monitor group operations in Applications Manager: Add Monitor Group Add Sub-Group Associate Monitor to Monitor Group Delete Monitor GroupDelete Sub-Group Edit Monitor Group Get Group Availability Move Group Unassociate Monitor from Monitor Group Add Monitor Group API This API allows the user to create a monitor group in Applications Manager. Sample Request http://[host]:[port]/AppManager/xml/AddMonitorGroup?apikey=[apikey]&grouptype=[type]&name= [displayname] Request Parameters The parameters involved in the API request are described below: Field Description Define the type of monitor group you want to create - monitorgroup / grouptype webappgroup. name Display name for the group. ApplicationServerGroup, WebServerGroup, DatabaseGroup, To add the default sub-groups while creating a Web Application Group via ServersGroup, EdgeDevicesGroup, Rest API, you must enable the subgroup. (For example, NetworkDevicesGroup, ApplicationServerGroup=enable) EndUserTransactionGroup Example: http://app-windows:9090/AppManager/xml/AddMonitorGroup? apikey=98597c390e092add5d53466794a769eb&grouptype=monitorgroup &name=Bob''s+Blog http://app-windows:9090/AppManager/xml/AddMonitorGroup? apikey=98597c390e092add5d53466794a769eb&grouptype=monitorgroup &name=Bob''s+Blog&WebServerGroup=enable   Add Sub-Group API This API allows the user to create a subgroup in Applications Manager. Sample Request http://[host]:[port]/AppManager/xml/AddSubGroup?apikey=[apikey]&haid=[groupid]&name=[displayname]&grouptype=[sub group type] or http://[host]:[port]/AppManager/xml/AddSubGroup?apikey=[apikey]&mgname=[groupname]&name=[displayname]&grouptype=[sub group type] Request Parameters The parameters involved in the API request are described below: Field Description        Define the type of sub group you want to create. The sub- group type should be the same as that of the parent group.The grouptype should be one of the following types: grouptype sub-group / WebServerGroup / DatabaseGroup / DatabaseCluster / ServersGroup / EdgeDevicesGroup / NetworkDevicesGroup / EndUserTransactionGroup / Site24x7 name Display name for the sub group. The resourceid of the monitor group in which you want to haid create the sub group.mgname Display name of the monitor group in which you want to create the sub group. Example: http://app-windows:9090/AppManager/xml/AddSubGroup?apikey=98597c390e092add5d53466794a769eb&haid=10000168 &name=Bob''s+Blogsg&grouptype   Associate Monitor to Monitor Group API This API allows the user to associate monitor to monitor group configured in Applications Manager. Syntax http://[host]:[port]/AppManager/xml/AssociateMonitortoMG?apikey=[apikey]&resourceid=[ids]&haid= [groupid] [ OR ] http://[host]:[port]/AppManager/xml/AssociateMonitortoMG?apikey=[apikey]&resourceid=[ids]&mgname= [groupname] Request Parameters The parameters involved in the API request are described below: Field Description         The resource ids of monitor, monitor group, sub group which you want to resourceid associate to corresponding groups, separated by commas. The resourceid for the monitor group to which the monitor group, sub group, haid monitor has to be associated. Group name for the monitor group to which the monitor group, sub group, mgname monitor has to be associated Value is true by default. If set to false, this prevents the default creation of a allowCreateMG new Monitor Group if mgname is provided in the request and no Monitor Group with this name is present. Sample Request http://app-windows:9090/AppManager/xml/AssociateMonitortoMG? apikey=98597c390e092add5d53466794a769eb &resourceid=10000095,10000170&haid=10000169 Delete Monitor Group API This API allows the user to delete a monitor group configured in Applications Manager. Sample Request http://[host]:[port]/AppManager/xml/group/delete?apikey=[apikey]&name=[groupname] or http://[host]:[port]/AppManager/xml/group/delete?apikey=[apikey]&haid=[resourceid] Request Parameters The parameters involved in the API request are described below: Field Description name Display name of the monitor group which you want to delete. haid Resource id of the monitor group which you want to delete. Example: http://app-windows:9090/AppManager/xml/group/delete?apikey=98597c390e092add5d53466794a769eb&name=AppNameDelete Sub-Group API This API allows the user to delete a sub-group configured in Applications Manager. Sample Request http://[host]:[port]/AppManager/xml/subgroup/delete?apikey=[apikey]&haid=[groupid] or http://[host]:[port]/AppManager/xml/subgroup/delete?apikey=[apikey]&name=[displayname] Request Parameters The parameters involved in the API request are described below: Field Description haid Resourceid of the sub group which you want to delete. name Display name of the sub group which you want to delete. Example: http://app-windows:9090/AppManager/xml/subgroup/delete?apikey=98597c390e092add5d53466794a769eb&haid=10000169 Edit Monitor Group API This API lets you to edit the details of a particular monitor group. Syntax: http://[Host]:[Port]/AppManager/xml/group/edit?apikey=[APIKEY]&haid=[HAID]&groupname= [GROUPNAME]&owners=[OWNERS]&location=[LOCATION]&description=[DESCRIPTION] Request Parameters The parameters involved in the API request are described below. Also refer to the list of common Request Parameters. Incase of errors during API execution, refer to the error handling section. Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. The unique resourceid for any monitor which can be found from AM_ManagedObject table in haid database. The new display name for the group. Html encoding for Special characters in displayname is groupname required (ex: Html encoding For & is & and " is ") owners The new owner of the group location The new location of the monitor group. description The new description of the monitor group. Sample Requests http://app-windows:9090/AppManager/xml/group/edit? apikey=9481566a94f26d8e44ee0889fd7628a0&haid=10000671&groupname=new http://app-windows:9090/AppManager/xml/group/edit? apikey=9481566a94f26d8e44ee0889fd7628a0&haid=10000671&owners=admin http://app-windows:9090/AppManager/xml/group/edit? apikey=b810259d38f463afc4a168dd98d7abb5&haid=10000475&groupname=MYTEST7 &owners=oper&location=India&description=MYTEST3Description Get Monitor Group Availability APIYou can use this API is used to pull up availability data on a monitor group in Applications Manager. Depending on the output format that you require, you can use one of the following APIs: getMonitorGroupAvailabilityInfo - Pulls up availability data on a monitor group in XML and JSON format. getMonitorGroupAvailability - Pulls up availability data on a monitor group in CSV format. getMonitorGroupAvailabilityInfo API Sample Request: http://[hostname]:[port]/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=[REST API Key] Request Parameters The parameters involved in the API request are described below: Field Description apikey * The key generated from the Generate API Key option in the ''Admin'' tab. Specify ''IncludeSubGroup=true'' if you also wish to know the availability status of IncludeSubGroup the sub-group within the monitor group. Specify CustomTime=true for custom time availability report. If CustomTime is CustomTime true then you must provide StartTime and EndTime. StartTime The start time of the report, in milliseconds. EndTime The end time of the report in milliseconds. The time period for which the report should be created. If this parameter is not provided then today''s availability is shown. Possible values are: 0 = Todays Availability 1 = Last 7 Days Availability 2 = Last 30 Days Availability 3 = Yesterday Availability ReportPeriod 5 = Last 1 Year Availability 6 = This week Availability 7 = This month Availability 8 = This year Availability 9 = This quarter Availability 11= Last month Availability 12= Last week Availability The ID of the monitor group. In Applications Manager, you can find the groupID of a monitor group using the following method: Click on the Group Name in the Monitor Groups table. This will open the Monitor Group details page HAID The URL of the Monitor Group details page will be in the following format: http://app-windows:9090/showapplication.do? &method=showApplication&HAID=10000040 The HAID in the URL is the Group ID that you require, in this case, 10000040. * mandatory Sample Inputs http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo? apikey=833015a191b75b11f953774ab34f034d To include sub-group:http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo? apikey=833015a191b75b11f953774ab34f034d&IncludeSubGroup=true For service availability calculation: http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo? apikey=833015a191b75b11f953774ab34f034d&ServiceAvailability=true For custom time availability report: http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo? apikey=833015a191b75b11f953774ab34f034d&CustomTime=true&StartTime=1584877371000&EndTime=158 5136571000 To set the Report Period: http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo? apikey=833015a191b75b11f953774ab34f034d&ReportPeriod=1 To filter with HAIDs: http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo? apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true&HAID=10000 Sample Outputs Description Sample Inputs and Outputs Input: http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo? apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true Output: To include sub-group   getMonitorGroupAvailability API Sample Request: http://[hostname]:[port]/AppManager/json/getMonitorGroupAvailability?apikey=[REST API Key] Request Parameters The parameters involved in the API request are described below:Field Description apikey * The key generated from the Generate API Key option in the ''Admin'' tab. Specify IncludeSubGroup=true if you also wish to know the availability status of IncludeSubGroup the sub-group within the monitor group. Specify CustomTime=true for custom time availability report. If CustomTime is CustomTime true then you must provide StartTime and EndTime StartTime The start time of the report, in milliseconds. EndTime The end time of the report in milliseconds. The time period for which the report should be created. If this parameter is not provided then today''s availability is shown. Possible values are: 0 = Todays Availability 1 = Last 7 Days Availability 2 = Last 30 Days Availability 3 = Yesterday Availability ReportPeriod 5 = Last 1 Year Availability 6 = This week Availability 7 = This month Availability 8 = This year Availability 9 = This quarter Availability 11= Last month Availability 12= Last week Availability The id of the monitor group. In Applications Manager, you can find the groupID of a monitor group using the following method: Click on the Group Name in the Monitor Groups table. This will open the Monitor Group details page HAID The URL of the Monitor Group details page will be in the following format: http://app-windows:9090/showapplication.do? &method=showApplication&HAID=10000040 The HAID in the URL is the Group ID that you require, in this case, 10000040. * - mandatory Sample requests: http://localhost:9090/AppManager/json/getMonitorGroupAvailability? apikey=833015a191b75b11f953774ab34f034d To include sub-group: http://localhost:9090/AppManager/json/getMonitorGroupAvailability? apikey=833015a191b75b11f953774ab34f034d&IncludeSubGroup=true For service availability calculation: http://localhost:9090/AppManager/json/getMonitorGroupAvailability? apikey=833015a191b75b11f953774ab34f034d&ServiceAvailability=true For custom time availability report: http://localhost:9090/AppManager/json/getMonitorGroupAvailability? apikey=833015a191b75b11f953774ab34f034d&CustomTime=true&StartTime=1584877371000&EndTime=158 5136571000To set the Report Period: http://localhost:9090/AppManager/json/getMonitorGroupAvailability? apikey=833015a191b75b11f953774ab34f034d&ReportPeriod=1 To filter with HAIDs: http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo? apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true&HAID=10000 Sample Output Description Sample Inputs and Outputs Input: http://localhost:9092/AppManager/json/getMonitorGroupAvailability? apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true To include Output: sub-group Today Availability Report ResourceID,DisplayName,Uptime %,Downtime % 10001368,App2-level1,100%,0% 10001369,App2-level2,100%,0% 10000252,App - 1,0.0%,100.0% Move Monitor Group API This API lets you to move a particular monitor group. API for Move Monitor Group http://[Host]:[Port]/AppManager/xml/group/move?apikey=[APIKEY]&haid=[HAID]&tohaid=[HAID] Request Parameters Field Description apikey The key generated from the Generate API Key option in the ''Admin'' tab. The unique resourceid for any monitor which can be found from haid AM_ManagedObject table in database. Error codes Sample Requests http://localhost:9091/AppManager/xml/group/move? apikey=3feef451ed7d7e30c08b2908aed0de40&haid=10000278&tohaid=10000279 http://localhost:9091/AppManager/xml/group/move? apikey=3feef451ed7d7e30c08b2908aed0de40&haid=10000278&tohaid=0 The above URL will move monitor group 10000278 outside its parent group when specifying 0 in the tohaid. It will be listed as main group in monitor group view. Unassociate Monitor from Monitor Group API This API allows the user to unassociate a monitor from a monitor group configured in Applications Manager.Sample Request http://[host]:[port]/AppManager/xml/removemonitor/group?apikey=[apikey]&resourceid=[ids Request Parameters The parameters involved in the API request are described below: Field Description         The resource ids of monitor, monitor group, sub group which you want to resourceid associate to corresponding groups, separated by commas. The resourceid for the monitor group to which the monitor group, sub group, haid monitor has to be associated. group name for the monitor group to which the monitor group, sub group, mgname monitor has to be associated Example: http://localhost:9091/AppManager/xml/removemonitor/group? apikey=2a0ac0c950e0bf3a90db7792b0572c1e&resourceid=10000096,10000096&haid=10000097     List Data With the APIs given below, you can get/list required data in Applications Manager: Get Downtime Details Get Monitor Data List Actions List Alarms List Dashboards List Monitor List Monitor Groups List Monitor Group Details List Monitor Types List Server Search Show Polled Data Get SLA Reports Get Downtime Details API This API is used to obtain the downtime data use of a monitor or a monitor group requested by the user for a specific period of time. Syntax API for XML Response http://[ APM Host ]:[ APM Port ]/AppManager/xml/GetDowntimeDetails?apikey=[API Key ]&type= [value]&period=[period]&resourceid=[resourceid]&showFullDetails=true API for JSON Response http://[ APM Host ]:[ APM Port ]/AppManager/json/GetDowntimeDetails?apikey=[API Key ]&type= [value]&period=[period]&resourceid=[resourceid]&showFullDetails=trueRequest Parameters Field Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. The resource id of the monitor, using which you can ping the host corresponding to the resourceid monitor. You can get downtime details for multiple resource ids by using comma separated values. The period for which the downtime details have been requested: Period: 0 ===> Today Period: 3 ===> Yesterday Period: 6 ===> This Week period Period: 1 ===> Last 7 days Period: 12 ===> Last Week Period: 7 ===> This Month Period: 2 ===> Last 30 days Period: 11 ===> Last Month The Type parameter is used to list all the monitors in a specified monitor type. Possible type values can be Linux, Windows XP, MYSQL-DB-server, Apache-server, UrlMonitor, Tomcat-server, etc. An optional parameter used to specify if user needs downtime details on a daily basis as showFullDetails additional data in response. Values are true or false (false dy default). Examples XML Input http://apm-prod1:9090/AppManager/xml/GetDowntimeDetails? apikey=c4e547c2330e2eb92d3e7af2362da9e9&type=windows&period=6&resourceid=10000135&showFull Details=true XML Response JSON Input http://apm-prod1:9090/AppManager/xml/GetDowntimeDetails? apikey=c4e547c2330e2eb92d3e7af2362da9e9&type=windows&period=6&resourceid=10000135&showFull Details=true JSON Response {"response":{"result":[{"AvailabilityMessage":"-","SchedulePercent":"0.0","DisplayName":"appcentos5-64- 2","ResourceId":"10000143","UnmanagePercent":"0.0", "AvailabilitySeverity":"- ","TotalDownTimeInSecs":"300","DownPercent":"0.12","UpPercent":"99.88","Period":"20"}],"uri":"/AppManager /json/GetDowntimeDetails"},"response-code":"4000"} Using Multiple Resource Ids XML Inputhttp://localhost:9840/AppManager/xml/GetDowntimeDetails? apikey=91f1aa274abdeea8ef8e49a1e37ce1be&period=20&resourceid=10000110,10000171,10000108&sho wFullDetails=true XML Response Response Parameters Field Description AvailabilityMessage The current availability RCA message of the resource. SchedulePercent The total scheduled downtime percentage of the resource. DisplayName The display name of the resource. ResourceId The resource id of the monitor, using which you can ping the host corresponding to the monitor. UnmanagePercent The total unmanaged downtime percentage of the resource. TotalDownTimeInSecs The total number of Seconds of Downtime. AvailabilitySeverity The current availability severity of the resource. DownPercent The total downtime percentage of the resource. UpPercent The total uptime percentage of the resource. The period for which the downtime details have been requested: Period: 0 ===> Today Period: 3 ===> Yesterday Period: 6 ===> This Week Period Period: 1 ===> Last 7 days Period: 12 ===> Last Week Period: 7 ===> This Month Period: 2 ===> Last 30 days Period: 11 ===> Last MonthField Description Field Description Date Represents the date for which the below details are calculated DownPercent Downtime percentage on above for the above date field SchedulePercent Scheduled downtime percentage on above for the above date field UpPercent Availability percentage on above for the above date field UnmanagePercent Unmanaged percentage on above for the above date field Field Description Total Downtime in Milliseconds DownTimeMillis ex: 1342381696674 Formatted Time at which the resource went Downtimes ( UpTime up after being down for some period. displayed only when ex: 3:28:42 PM requested for FullDetails) Formatted Time at which the resource went DownTime down. DowntimeSummary ex: 1:18:17 AM (Appears only if there is a downtime Total downtime in Hrs,mins and sec TotalDownTime on that date) ex: 14 Hrs 10 Mins 25 Secs Reason Id for the Below mentioned Downtime ReasonID Reason. (-1 if no information is available for downtime) Reason for downtime occured. ex: Outage is due to power supply. Downtime_Reason No Information Available. : if no reason is mentioned Get Monitor Data API This API allows the user to fetch the data for the latest poll from monitors. At the moment, we support fetching of first-level attributes of a monitor, i.e. the current data for the important attributes of a monitor such as response time, collection time, etc. Sample Request http://[Host]:[Port]/AppManager/xml/GetMonitorData?apikey=[APIKEY]&resourceid=[RESOURCEID] Request Parameters The parameters involved in the API request are described below: Field Description         API Key The key generated from "Generate API Key" option in the Admin tab. The resource id of the monitor for which data needs to be fetched. This API resourceid supports multiple resource ID as GET parameters. Multiple resource Ids can be given as comma separated values. Example http://app-windows:9090/AppManager/xml/GetMonitorData? apikey=095cb3835ff015b01a3b3a6c4ab2c38a&resourceid=10000293 The above example fetches the current data of a Sybase monitor. Output for the above example ListActions API This API lists all the actions configured for the monitors associated to the users. The details of each action is grouped according to the action type. Syntax API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListActions?apikey=[ API Key ]&type=all API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ListActions?apikey=[ API Key ]&type=all In future versions the following features will be included: i) Listing Actions will be supported in Admin server. ii) Listing Actions based on the type. Request Parameters Field Description This value specifies the type of action to be listed, to get all types of actions, we need to pass ''all'' as the type value for the field type. (In absence of this parameter also it will return all the types) Response Details Field Description DisplayName This is the displayname of the action. ID - Represents the Action ID ExecuteActionPath - Represents the uri for executing the action Action NAME - Represents the Name of the Action ActionProps - Represents the Action Proepeties like From Address, To Address, Message etc., this changes for each and every action type Sample Request XML Input: http://apm-prod1:9090/AppManager/xml/ListActions? apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all XML Response: JSON Input: http://apm-prod1:9090/AppManager/json/ListActions? apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all JSON Response {"response-code":"4000","response":{"uri":"/AppManager/json/ListActions","result":[{"Action": [{"ID":"20000003","ExecuteActionPath":"/common/executeAction.do? method=testAction&remote=true&actionID=20000003","NAME":"alert_mail","ActionProps": {"FROMADDRESS":"user1@zohocorp.com","TOADDRESS":"user2@zohocorp.com","SUBJECT":"Alarm from the Applications Manager"}}],"DisplayName":"E-mail Action(s)"}]}} ListAlarms API This API will list all alarms of the monitors configured in the Applications Manager for the user corresponding to the API Key. This details will include the Health and Availability of the monitor types, type image, Health outages, Critical/Warning/Clear/UP/Down count for each and every monitor type. API for XML Response :  http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListAlarms?apikey=[ API Key ]&type=[ Type ] API for JSON Response :  http://[ APM Host ]:[ APM Port ]/AppManager/json/ListAlarms?apikey=[ API Key ]&type=[ Type ] APIs for ListAlarms ManageEngine Applications Manager provides List Alarms API that allows the user to list the information regarding recent alarms in an XML format. The alarm APIs are listed as follows. Listing all recent alarms Listing all critical recent alarms Listing all warning recent alarms Listing all clear recent alarms Listing recent alarms by time filter Listing alarms by monitor type Listing alarms by monitor resource ID Listing alarms by top N Listing alarms that are acknowledged Listing alarms that are acknowledged Listing all recent alarms http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=all Listing all critical recent alarms http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=critical Listing all warning recent alarms http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=warning Listing all clear recent alarmshttp://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=clear Listing recent alarms after specified time http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&time=[ Time ] Listing alarms by monitor name http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&resourceid=[ resourceid ] Listing alarms by monitor type http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=[ TYPE ] Listing alarms by top N http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&topN=[ XYZ ] Listing alarms by group http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey= [ API key ]&groupName=Applications Manager Listing all the alarms excluding monitor groups http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=allmonitors Listing alarms that are acknowledged http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&acknowledgedAlerts=[true/false] Listing alarms that include configured traps http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&includeConfiguredTrapAlerts= [true/false] Note: a) For getting all the alarms we need to pass ''type=all'' .... it is mandatory. b) For combination of severity of alarms, ex: we can pass ''critical,warning'' as a value for type parameter to get both critcal and warning. Request Parameters Field Description API Key The key generated from "Generate API" option in the Admin tab. "resourceid=[ resourceid of monitor ]" is used to list the alarms of particular resourceid monitor. Type The severity type of the alarm, separated by commas. (critical/warning/clear) "type=all" is used to list all alarms. "type=critical" is used to list all the critical alarms. "type=warning" is used to list all the warning alarms. "type=clear" is used to list all the clear alarms. "type=Trap" is used to list all the trap alarms. "type=[ Monitor type ]" is used to list alarms by monitor type where   is TYPE in AM_ManagedObject table like Linux, Windows XP, MYSQL- DB-server, Apache-server, UrlMonitor, Tomcat-server, etc. Top N "topN=[ N ]" is used to list the top N alarms. "time=[ Time ]" is used to list the alarms generated after the specified time. Time  is repesented in milli second. acknowledgedAlerts Lists alarms that are acknowledged/unacknowledged. (true or false) includeConfiguredTrapAlerts Lists alarms that include configured traps. (true or false) (Optional) Extra Attributes AVAILABILITYSEVERITY This is the monitor availability severity (1 - critical, 5 - clear) HEALTHSEVERITY (previously This is the monitor severity for health (1-critical, 4-warning & 5- clear) known as SEVERITY) This value specifies the technician who has acknowleged/ picked up the TECHNICIAN Alarm generated for this monitor. This value is the annotation added regarding the alarm generated for this ANNOTATION monitor. This value is the link to the details page of the monitor for which the alarm DetailsPageURL is generated. Sample Request Listing all recent alarms http://app-windows:9090/AppManager/xml/ListAlarms?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a Listing recent alarms after specified time http://app-windows:9090/AppManager/xml/ListAlarms? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&time=1248868798412 Listing alarms that include configured traps http://app-windows:9090/AppManager/xml/ListAlarms? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=all&includeConfiguredTrapAlerts=true Response Parameters Field Description         Alarm Details DISPLAYNAME Display Name of the Monitor like Linux-1 RESOURCEID Resource ID of the Monitor HEALTHSEVERITY This is the monitor severity for health (1-critical, 4-warning & 5- clear) Alarm message like ''Resource is down. Health is critical as the resource is not MESSAGE available'' ATTRIBUTE ID Attribute ID of health of monitor MODTIME Time when the Alarm was generated (ms) STATUS Clear/Warning/Critical - status of the alarm TYPE Type of the Monitor like Linux TYPEDISPLAYNAME Display Name of the Type like ''Linux'' AVAILABILITYSEVERITY This is the monitor availability severity (1 - critical, 5- clear) This value specifies the technician who has acknowleged/ picked up the TECHNICIAN Alarm generated for this monitor.ANNOTATION This value is the annotation added regarding the alarm generated for this monitor. This value is the link to the details page of the monitor for which the alarm is DetailsPageURL generated. Example Response ListDashboards API This API fetches the List of Dashboards created in the Server which includes all the widgets configured in the Dashboards as there is no concept of assigning the dashboards/widgets to operators. But the data which is to be populated will be based on the monitors assigned for the user. API for XML Response:  http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListDashboards?apikey=[ Api Key ] API for JSON Response:  http://[ APM Host ]:[ APM Port ]/AppManager/json/ListDashboards?apikey=[ API Key ]   Response Details: Field Description DashboardId This is the username. DashboardName This is the description of the user account given at the time of creation of user account WidgetName -- This represents the display name of the widget Widget WidgetId -- This is the id of the widget created in this dashboard. WidgetURL -- This is the link to the widget of this dashboard   JSON Input http://apm-prod1:9090/AppManager/json/ListDashboards?apikey=c4e547c2330e2eb92d3e7af2262da9e9 JSON Response {"response-code":"4000","response":{"uri":"/AppManager/json/ListDashboards","result":[{"Widget": [{"WidgetName":"Monitor Groups","WidgetId":"20000001","WidgetURL":"/MyPage.do? method=getWidget&pageid=20000001&widgetid=20000001"},{"WidgetName":"Infrastructure Snapshot","WidgetId":"20000002","WidgetURL":"/MyPage.do? method=getWidget&pageid=20000001&widgetid=20000002"},{"WidgetName":"Recent 10 Alarms","WidgetId":"20000003","WidgetURL":"/MyPage.do? method=getWidget&pageid=20000001&widgetid=20000003"}],"DashboardId":"20000001","DashboardName":"Default Dashboard"}]}}     List Monitor API ManageEngine Applications Manager provides List Monitor API that allows the user to list details of monitor by the following categories. By monitor type By monitor ResourceID Listing all the added monitors This API lists all the monitors of a given type that are configured in Applications Manager for the user corresponding to the API Key. This details displayed includes the Health and Availability of the monitor types, image type, Health outages and Critical/Warning/Clear/UP/Down count for each monitor type. APIs for ListMonitor 1. By monitor type API for XML Response: http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=[ TYPE in AM_ManagedObject table ]API for JSON Response: http://[ Host ]:[ Port ]/AppManager/json/ListMonitor?apikey=[ API key ]&type=[ TYPE in AM_ManagedObject table ] 2. By monitor ResourceID API for XML Response: http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&resourceid=[ Resourceid ] API for JSON Response: http://[ Host ]:[ Port ]/AppManager/json/ListMonitor?apikey=[ API key ]&resourceid=[ Resourceid ] 3. Listing all the added monitors API for XML Response: http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=all API for JSON Response: http://[ Host ]:[ Port ]/AppManager/json/ListMonitor?apikey=[ API key ]&type=all   Note: a) For getting both Esx VirtualMachine and HyperV VirtualMachine , we can simply pass VirtualMachine as type b) For getting all windows types, pass ''Windows'' as type value c) For all network devices (devices added to APM from OPM) simply pass ''NWD'' as value for type. Request Parameters Field Description         apikey The key generated from "Generate API" option in the Admin tab. "type= " is used to list all the monitors in a specified monitor type.   is TYPE in AM_ManagedObject table like Linux, Windows XP, MYSQL-DB-server, type Apache-server, UrlMonitor, Tomcat-server, etc. To get all monitor types we need to pass ''all'' as the value for the field type. resourceid The resourceid of the monitor Sample Requests 1. By monitor Type http://app-windows:9090/AppManager/xml/ListMonitor?apikey=[Api Key]&type=Windows 2. By monitor ResourceID http://app-windows:9090/AppManager/xml/ListMonitor? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000047 3. Listing all the added monitors http://app-windows:9090/AppManager/xml/ListMonitor? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=allSample Response Input: http://app-windows:9090/AppManager/xml/ListMonitor? apikey=831975d6aace66d71c4f63027&resourceid=1000003 Response: Note: You can obtain the resourceid of a monitor by executing the ListMonitor API request. The output of this request contains resourceid of the monitor, among other values. Response Parameters Response Fields Decription DISPLAYNAME Monitor''s Display Name RESOURCEID Monitor''s Resource ID TYPE Monitor type like Windows, Linux Contains HEALTHMESSAGE - Which gives the Health Root Cause Message HEALTHATTRIBUTEID - Health Attribute ID  Health Details HEALTHSTATUS - Current health status of the monitor. It can have values clear or warning or critical HEALTHSEVERITY - Health status in number. Number 1 represents critical, 4 represents warning and 1 represents clear. Contains AVAILABILITYMESSAGE - Which gives the Availability Root Cause Message AVAILABILITYATTRIBUTEID - Availability Attribute ID Availability Details AVAILABILITYSTATUS - Current availability status of the monitor. It can have values up or down AVAILABILITYSEVERITY - Availability status in number. Number 5 represents up and number 1 represents down. Managed True - the monitor is in Managed state, False - the monitor is in Unmanaged State RESOURCENAME Monitor''s Resource Name DESCRIPTION Description of the Resource like Network Resource RCAPageURL URL that links to Root Cause Analysis details DetailsPageURL URL that links to details page of the monitor LASTALARMTIME This is the time (Unix epoch in millis) at which last alarm has been generated. IMAGEPATH This monitor type''s icon image path ASSOCIATEDGROUPS Monitor groups to which this monitor is associated with ListMonitorGroups APIThis API will fetch all the List of Monitor Groups created in the Server which includes all the sub-groups and associated monitors configured of the Monitor group. This will also list the monitor groups associated to the user. This will have information about monitor groups today''s availability, monitor health outages among subgroups and associated monitors. API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListMonitorGroups?apikey=[ API Key ]&type=all API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ListMonitorGroups?apikey=[ API Key ]&groupId=10000035 Request Parameters: Field Description This parameter is used to get the Monitor Group and its associated monitors based on the groupId monitor group id for the user This parameter is used to get the Monitor Group and its associated monitors based on the groupName monitor group name for the user. This parameter is used to determine whether the user need outage reports. The value of this parameter is either true or false. The default value is true. The following details are added in the response if value is "true": TODAYAVAILPERCENT TODAYSCHEDDOWNPERCENT TODAYUNMANGDPERCENT TODAYUNAVAILPERCENT OUTAGES outageReports AvailabilityUnknownCount UPCOUNT DOWNCOUNT HealthUnknownCount CLEARCOUNT WARNINGCOUNT CRITICALCOUNT This parameter is used to define whether the user need severity details or not. The value of this parameter is either true or false. The default value is true. The following details are added in the response if value is "true": HEALTHSEVERITY HEALTHSTATUS HEALTHMESSAGE severityDetails HealthRCAURL AVAILABILITYSEVERITY AVAILABILITYSTATUS AVAILABILITYMESSAGE AvailabilityRCAURL This parameter is used for displaying the tree view structure of the given monitor group. The values are, toplevel - Displays the all parent monitor groups of the given group. treeview bottomlevel - Displays the all child monitor groups of the given group. all - Displays the all parent and child monitor groups of the given group. If none of the above arguments passed, by default the first level sub-group will be displayed. listOnlyParentGroups If this parameter is set to true, only the parent monitor groups will be listed.Note: If the groupName or groupId is not specified in the input, then all the Monitor Group details will be pulled up in the response. Response Details: Field Description DetailsPageURL This is the url for the details page of the monitor group TODAYUNAVAILPERCENT This value represents the today''s unavailability perecentage AvailabilityRCAURL This represents the Availability RCA Url. Action This represents status of the monitor group whether actions or enabled or not CRITICALCOUNT This represents the critical monitors/monitorgroups count NAME \ DISPLAYNAME This Represents the displayname of the monitor group DOWNCOUNT This represents the total number of monitors/monitor groups down in this group TODAYAVAILPERCENT This value represents the today''s availability perecentage TODAYSCHEDDOWNPERCENT This value represents the today''s scheduled downtime perecentage Type This value represents type i.e Monitor group or sub group This represents the severity of the health for this Monitor group (1-critical, 4- HEALTHSEVERITY warning & 5-clear) This represents the number of monitors or subgroups for which the health is HealthUnknownCount unknown. This represents the severity of the availability for this monitor group (1-down , 5- AVAILABILITYSEVERITY up) AVAILABILITYMESSAGE This is the availability message for this group RESOURCEID This is the resourceid of the monitor group. This represents the number of monitors or subgroups for which the health is CLEARCOUNT clear. This represents the number of monitors or subgroups for which the availability is UPCOUNT up. HealthRCAURL This represents the link which show the Health RCA of this group. TODAYUNMANGDPERCENT This value represents the today''s unmanaged perecentage HEALTHMESSAGE This is the health message for this group This represents the number of monitors or subgroups for which the availability is AvailabilityUnknownCount unknown. This represents the number of monitors or subgroups for which the health is not OUTAGES clear. This represents the number of monitors or subgroups for which the health is WARNINGCOUNT warning. HEALTHSTATUS This represents health status of this group (CRITICAL / CLEAR / WARNING) AVAILABILITYSTATUS This represents availablility status of this group (UP/ DOWN)Field Description DetailsPageURL --- This is the details page of the sub group TODAYUNAVAILPERCENT --- this is today''s unavailability percentage for sub group AvailabilityRCAURL --- this represents the availability RCA url for sub group Action --- this states whether the actions are enabled for this subgroup or not. NAME \ DISPALYNAME --- this is the displayname of the subgroup TODAYAVAILPERCENT --- this is today''s availability percentage for sub group TODAYSCHEDDOWNPERCENT --- this is today''s scheduled downtime percentage for sub group SubMonitorGroup HEALTHSEVERITY --- this is health severity of the sub group TYPE --- this represents whether it is subgroup/group AVAILABILITYSEVERITY --- this is availability severity of the sub group AVAILABILITYMESSAGE --- this is availability message of the sub group RESOURCEID --- this is resource id the sub group HealthRCAURL --- this is health RCA url of this sub group TODAYUNMANGDPERCENT --- this is today''s unmanaged percentage of the sub group HEALTHMESSAGE --- this is health message of the sub group HEALTHSTATUS --- this is health status of the sub group AVAILABILITYSTATUS --- this is availability status of the sub group Case 0: When the type is all Case 1: When the outageReports is false Case 2: When the severityDetails is false Case 3: When both the outageReports and the severityDetails are false     JSON Input: http://apm-prod1:9090/AppManager/json/ListMonitorGroups? apikey=c4e547c2330e2eb92d3e7af2262da9e9&groupId=10000035 JSON Response: {"response-code":"4000","response":{"uri":"/AppManager/json/ListMonitorGroups","result": [{"DetailsPageURL":"/showresource.do? method=showResourceForResourceID&resourceid=20000036&method=showApplication","TODAYUNAVAI LPERCENT":"100.0","AvailabilityRCAURL":"/jsp/RCA.jsp? resourceid=20000036&attributeid=17","Action":"enabled","CRITICALCOUNT":"1","NAME":"Applications Manager","DOWNCOUNT":"1","TODAYAVAILPERCENT":"0.0","TODAYSCHEDDOWNPERCENT":"0.0","Type":"M onitor Group","HEALTHSEVERITY":"1","HealthUnknownCount":"0","AVAILABILITYSEVERITY":"1","AVAILABILITYMESSA GE":"Resource Applications Manager is down.
Root Cause :

1. Resource down.
   The resource AppManager Home Page is not available.Connection Timed Out. Increase the time out level:ResponseCode -200
   -->><\/li> <\/ol>","RESOURCEID":"20000036","CLEARCOUNT":"2","UPCOUNT":"2","HealthRCAURL":"/jsp/RCA.jsp? resourceid=20000036&attributeid=18","TODAYUNMANGDPERCENT":"0.0","HEALTHMESSAGE":"Health of Applications Manager is Critical.
   Root Cause :
   
   1. Health of AppManager Home Page is critical.
      Root Cause :
      1. AppManager Home Page is down
      <\/li> <\/ol>","AvailabilityUnknownCount":"0","OUTAGES":"1/3","DISPLAYNAME":"Applications Manager","WARNINGCOUNT":"0","HEALTHSTATUS":"critical","AVAILABILITYSTATUS":"down"}]}} ListMGDetails API This API will fetch the Monitor Group Details of the given monitor group id which includes all the sub-groups and associated monitors configured of the Monitor group. This will also list the monitor groups associated to the user. This will have information about monitor groups today''s availability, monitor health outages among subgroups and associated monitors.Syntax API for XML Response: http://[ APM Host ]:[ APM Port ]AppManager/xml/ListMGDetails?apikey=[ API Key ]&groupId=[GROUP ID] API for JSON Response: http://[ APM Host ]:[ APM Port ]AppManager/json/ListMGDetails?apikey=[ API Key ]&groupName=[GROUP NAME] Request Parameters Field Description This parameter is used to get the Monitor Group and its associated monitors based on the monitor groupId group id for the user This parameter is used to get the Monitor Group and its associated monitors based on the monitor groupName group name for the user Note: If the groupName or groupId is not specified in the input, then all the Monitor Group details will be pulled up in the response. Response Details Field Description NAME \ DISPLAYNAME This is the displayname of this group DetailsPageURL This is the url for the details page of this group TODAYUNAVAILPERCENT This the today''s unavailability percentage of this group Action This represents whether action is enabled or not TODAYAVAILPERCENT This the today''s availability percentage of this monitor group TODAYSCHEDDOWNPERCENT This is the today''s scheduled downtime percentage of this monitor group Type This represents the type HEALTHSEVERITY This represents the severity of the health for this group AVAILABILITYSEVERITY This represents the severity of the availability for this group AVAILABILITYMESSAGE This represents the availability message for this group RESOURCEID This is the resourceid of this group HealthRCAURL This is the health RCA url of this group TODAYUNMANGDPERCENT This is the today''s unamanaged percentage of this monitor group HEALTHMESSAGE This represents the health message for this group HEALTHSTATUS This is the health status of this group AVAILABILITYSTATUS This is the availability status of this group SubMonitorGroup Displays the details of the sub-monitor group. DetailsPageURL ---------> this is details page of the sub group TODAYUNAVAILPERCENT ---------> This the today''s unavailability percentage of this sub group AvailabilityRCAURL ---------> this is availability RCA url of the sub group Action ---------> this is action status of the sub group NAME \ DISPLAYNAME ---------> this is displayname of the sub group TODAYAVAILPERCENT ---------> this is today''s availability percentage of the sub group TODAYSCHEDDOWNPERCENT ---------> this is today''s scheduled downtime percentage of the sub group HEALTHSEVERITY ---------> this is health severity of the sub group TYPE ---------> this represents the type of the groupAVAILABILITYSEVERITY ---------> this is availability severity of the sub group AVAILABILITYMESSAGE ---------> this is availability message of the sub group RESOURCEID ---------> this is resourceid of the sub group HealthRCAURL ---------> this is health RCA url of the sub group TODAYUNMANGDPERCENT ---------> this is today''s unmanage percentage of the sub group HEALTHMESSAGE ---------> this is health message of the sub group HEALTHSTATUS ---------> this is health status of the sub group AVAILABILITYSTATUS ---------> This is the availability status of a sub group Displays the details of the monitors in the monitor group. DetailsPageURL ---------> this is details page of the monitor TODAYUNAVAILPERCENT ---------> This the today''s unavailability percentage of this monitor AvailabilityRCAURL ---------> this is availability RCA url of the monitor Action ---------> this is action status of the monitor NAME \ DISPLAYNAME ---------> this is displayname of the monitor TODAYAVAILPERCENT ---------> this is today''s availability percentage of the monitor TODAYSCHEDDOWNPERCENT ---------> this is today''s scheduled downtime percentage of the monitor Monitors HEALTHSEVERITY ---------> this is health severity of the monitor TYPE ---------> this represents the type of the monitor AVAILABILITYSEVERITY ---------> this is availability severity of the monitor AVAILABILITYMESSAGE ---------> this is availability message of the monitor RESOURCEID ---------> this is resourceid of the monitor HealthRCAURL ---------> this is health RCA url of the monitor TODAYUNMANGDPERCENT ---------> this is today''s unmanage percentage of the monitor HEALTHMESSAGE ---------> this is health message of the monitorof the monitor HEALTHSTATUS ---------> this is health status of the monitor AVAILABILITYSTATUS ---------> This is the availability status of the monitor Sample Request XML Input http://apm-prod1:9090/AppManager/xml/ListMGDetails? apikey=c4e547c2330e2eb92d3e7af2262da9e9&groupId=10000468 XML Response JSON Input http://apm-prod1:9090/AppManager/json/ListMGDetails? apikey=c4e547c2330e2eb92d3e7af2262da9e9&groupName=AppmanagerHomePage JSON Response {"response-code":"4000","response":{"uri":"/AppManager/json/ListMGDetails","result": [{"DetailsPageURL":"/showresource.do? method=showResourceForResourceID&resourceid=20000036&method=showApplication","Monitors": [{"DetailsPageURL":"/showresource.do? method=showResourceForResourceID&resourceid=20000043&method=showApplication","TODAYUNAVAI LPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp? resourceid=20000043&attributeid=17","Action":"enabled","NAME":"AppmanagerHomePage","TODAYAVAILP ERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"1","TYPE":"UrlMonitor","AVAILABILITY SEVERITY":"1","AVAILABILITYMESSAGE":"Resource down. The resource AppmanagerHomePage is not available.Connection Timed Out. Increase the time out level:ResponseCode -200 -->>","RESOURCEID":"20000043","HealthRCAURL":"/jsp/RCA.jsp? resourceid=20000043&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of AppmanagerHomePage is critical. Root Cause : 1. AppmanagerHomePage is down ","HEALTHSTATUS":"critical","DISPALYNAME":"AppmanagerHomePage","AVAILABILITYSTATUS":"down"}, {"DetailsPageURL":"/showresource.do? method=showResourceForResourceID&resourceid=20000041&method=showApplication","TODAYUNAVAI LPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp? resourceid=20000041&attributeid=17","Action":"enabled","NAME":"apm-prod1_Apache Server_9090","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"5","TYP E":"Apache-server","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource up. The resource apm-prod1_Apache Server_9090 is available.","RESOURCEID":"20000041","HealthRCAURL":"/jsp/RCA.jsp? resourceid=20000041&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of apm- prod1_Apache Server_9090 is clear. Root Cause : 1. apm-prod1_Apache Server_9090 is up 2. Response Time 16 ","HEALTHSTATUS":"clear","DISPALYNAME":"apm-prod1_Apache Server_9090","AVAILABILITYSTATUS":"up"},{"DetailsPageURL":"/showresource.do? method=showResourceForResourceID&resourceid=20000039&method=showApplication","TODAYUNAVAI LPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp? resourceid=20000039&attributeid=17","Action":"enabled","NAME":"apm-prod1_Windows Vista","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"5","TYPE":"Win dows Vista","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource up.The resource apm-prod1_Windows Vista is available.","RESOURCEID":"20000039","HealthRCAURL":"/jsp/RCA.jsp? resourceid=20000039&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of apm-prod1_Windows Vista is clear. Root Cause : 1. Data Collection Successful 2. apm-prod1_Windows Vista is up ","HEALTHSTATUS":"clear","DISPALYNAME":"apm-prod1_Windows Vista","AVAILABILITYSTATUS":"up"}],"TODAYUNAVAILPERCENT":"100.0","AvailabilityRCAURL":"/jsp/RCA.jsp? resourceid=20000036&attributeid=17","Action":"enabled","NAME":"Applications Manager","TODAYAVAILPERCENT":"0.0","TODAYSCHEDDOWNPERCENT":"0.0","Type":"Monitor Group","HEALTHSEVERITY":"1","AVAILABILITYSEVERITY":"1","AVAILABILITYMESSAGE":"Resource Applications Manager is down. Root Cause : 1. Resource down. The resource AppmanagerHomePage is not available.Connection Timed Out. Increase the time out level:ResponseCode -200 -->>","RESOURCEID":"20000036","HealthRCAURL":"/jsp/RCA.jsp? resourceid=20000036&attributeid=18","TODAYUNMANGDPERCENT":"0.0","HEALTHMESSAGE":"Health of Applications Manager is Critical. Root Cause : 1. Health of AppmanagerHomePage is critical. Root Cause : 1. AppmanagerHomePage is down ","DISPLAYNAME":"Applications Manager","HEALTHSTATUS":"critical","AVAILABILITYSTATUS":"down"}]}} ListMonitorTypes API This API will list all the monitor types configured in the Applications Manager for the user corresponding to the API Key. The details include the Health and Availability of the monitor types, type image, Health outages, Critical/Warning/Clear/UP/Down count for each and every monitor type. Syntax API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListMonitorTypes?apikey=[ API Key ]&type=all API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ListMonitorTypes?apikey=[ API Key ]&type=all Response Parameters Field Description AVAILUNKNOWNCOUNT This is the count of number of monitors for which availability is unknown. IMAGE This is the image path for the monitor type CRITICALCOUNT This is the count of number of monitors for which health is critical in a type SUBGROUP \ This represent the category under which it belongs to. (IIS-Server, Mail-Server, etc.,) RESCATEGORY DOWNCOUNT This is the count of number of monitors for which availability is down in a type HEALTHSEVERITY This is the severity of the health (1-critical, 4-warning and 5-clear) HEALTHMSG This is the health message for this monitor type This represents the group under which this monitor type is grouped. like (servers, RESCATEGORY Databases, etc.,) UPCOUNT This is the count of number of monitors for which availability is up in a type CLEARCOUNT This is the count of number of monitors for which health is clear in a type OUTAGES This is the health outages w.r.t the total number of monitors in this type DISPLAYNAME This is the displayname of the monitor type WARNINGCOUNT This is the count of number of monitors for which health is warning in a typeAVAILMSG This is the availability message for this monitor type COUNT This is the total number of monitors in this type HEALTHUNKNOWNCOUNT This is the count of number of monitors for which health is unknown in a type RESOURCETYPEURL This is the url of the page where all the monitor''s of this type will be listed. AVAILSEVERITY This is the severity of the availability for this type (clear -5, down -1) Example XML Input: http://apm-prod1:9090/AppManager/xml/ListMonitorTypes? apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all XML Response: JSON Input: http://apm-prod1:9090/AppManager/json/ListMonitorTypes? apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all JSON Response: {"response-code":"4000","response":{"uri":"/AppManager/json/ListMonitorTypes","result": [{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_urlmonitor.gif","CRITICALCOUNT":"1","SUB GROUP":"UrlMonitor","DOWNCOUNT":"1","HEALTHSEVERITY":"1","HEALTHMSG":"Health is critical.
      Root Cause:
      1. Health of AppManager Home Page is critical
      ","RESCATEGORY":"URL","UPCOUNT":"0","CLEARCOUNT":"0","OUTAGES":"1/1","DISPLAYNAME":"HTTP(s) URLs","WARNINGCOUNT":"0","AVAILMSG":"Resource is down.
      Root Cause:
      1. AppManager Home Page is down
      ","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do?method=showResourceTypes&direct=true&network=UrlMonitor&detailspage=true&PRINTER_FRIENDLY=true" ,"AVAILSEVERITY":"1"}, {"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_apache.gif","CRITICALCOUNT":"0","SUBGR OUP":"Apache-server","DOWNCOUNT":"0","HEALTHSEVERITY":"5","HEALTHMSG":"Health is clear.
      Root Cause:
      1. Health of apm-prod1_Apache Server_9090 is clear
      ","RESCATEGORY":"URL","UPCOUNT":"1","CLEARCOUNT":"1","OUTAGES":"0/1","DISPLAYNAME":"Apache Server","WARNINGCOUNT":"0","AVAILMSG":"Resource is up.
      Root Cause:
      1. apm-prod1_Apache Server_9090 is up
      ","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do? method=showResourceTypes&direct=true&network=Apache- server&detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"5"}, {"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_windows.gif","CRITICALCOUNT":"0","SUBG ROUP":"Windows","DOWNCOUNT":"0","HEALTHSEVERITY":"5","HEALTHMSG":"Health is clear.
      Root Cause:
      1. Health of apm-prod1_Windows Vista is clear
      ","RESCATEGORY":"SYS","UPCOUNT":"1","CLEARCOUNT":"1","OUTAGES":"0/1","DISPLAYNAME":"Windows ","WARNINGCOUNT":"0","AVAILMSG":"Resource is up.
      Root Cause:
      1. apm-prod1_Windows Vista is up
      ","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do? method=showResourceTypes&direct=true&network=Windows&detailspage=true&PRINTER_FRIENDLY=true"," AVAILSEVERITY":"5"}]}} Note: We hope to support the others in future, depending on popular customer demand. ListServer API ManageEngine Applications Manager provides List Server API that allows the user to list information about the server by the following categories: Listing all the server details By particular server name By IP Address of server APIs for ListServer 1. Listing all the server details API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListServer?apikey=[ API Key ]&type=all API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ListServer?apikey=[ API Key ]&type=all 2. By particular server name API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListServer?apikey=[ API Key ]&type=[ Server ParentNode Name ] API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ListServer?apikey=[ API Key ]&type=[ Server ParentNode Name ] 3. By IP Address of server API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListServer?apikey=[ API Key ]&ipaddress=[ IP Address of server ]API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ListServer?apikey=[ API Key ]&ipaddress=[ IP Address of server ] Request Parameters Field Description apikey The key generated from "Generate API " option in the Admin tab. Indicates the type of server details that are to be listed. Possible values are: all - Lists the details of all the servers in Applications Manager. type - Lists the details of specified server in Applications Manager, where, is the ParentNode in IpAddress table. ipaddress IP address of the server. Sample Requests 1. Listing all the server details http://app-windows:9090/AppManager/xml/ListServer? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=all 2. By particular server name http://app-windows:9090/AppManager/xml/ListServer? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=app-windows 3. By IP Address of server http://app-windows:9090/AppManager/xml/ListServer? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&ipaddress=192.123.4.5 Response Parameters Parameter Description Name Name of the Server Parent IP Parent Network IP address of the Server resourceid Resource ID of the Server Type Server Type like Windows DISPLAYNAME Display Name of the Server like XP1 IPADDRESS IP Address of the Server Contains information about the services running in the server. Service DISPLAYNAME - Display Name of the Service TYPE - Type of the service like SNMP Service Details RESOURCEID - Resource ID of the Service RESOURCENAME - Resource Name of the Service DESCRIPTION - Description of the Resource like Network Resource ATTRIBUTEID - Service Attribute ID RCALink Link to Root Cause Analysis details DetailsPageLink Link to the Details page of the ServerSample Response Search API This API will fetch the List of Monitors / Monitor Groups that matches the query string and the search condition. Also the search will be with in the list of monitors assigned to the user. API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Search?apikey=[ API Key]&query= [query]&searchCondition=[searchCondition] API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Search?apikey=[ API Key]&query= [query]&searchCondition=[searchCondition] Request Parameters: Field Description This value specifies the string that has to be searched in the monitors list associated query to an user. Additional Parameters: Field Description searchCondition This value specifies the type of monitor that has to be searched in the monitors list associated to an user. For example - displayname, monitortype, ipaddress andcustomfields. searchCondition can also be specified as ''all'' when if you wish to search in all monitor types. Response Details: Field Description Type This represents the type of the element got in search results HealthStatus This is health status of the search element AvailabilityMessage This is the availability message of the search element DisplayName This is the displayname of the search element This is the managed server name in which the monitor or group is added.It will have ManagedServer ''NA'' as value for professional edition AvailabilityStatus This is availability status of the search element SubGroup This is category to which the elements belongs to. ResourceId This is the resource id of the search element. HealthMessage This is the health message of the search element HealthSeverity This is the health severity of the search element ImagePath This is monitor type/ monitor group image path AvailabilitySeverity This is the availability severity of the search element DetailsPageURL This is details page of the search element.     Search in all Input: http://apm-prod1:9090/AppManager/xml/Search? apikey=4f77fe9c75f4472764a07846bf7f032d&query=linux&searchCondition=all  Response:   JSON Input http://apm-prod1:9090/AppManager/json/Search? apikey=4f77fe9c75f4472764a07846bf7f032d&query=linux&searchCondition=monitortype  JSON Response {"response":{"result":[{"Type":"Linux","HealthStatus":"clear","AvailabilityMessage":"Resource up.
      The resource app-centos32-1 is available.","DisplayName":"app-centos32-1","ManagedServer":"Admin Server","AvailabilityStatus":"up","SubGroup":"Linux","ResourceId":"10000108","HealthMessage":"Health of app-centos32-1 is clear.
      Root Cause :
      1. app-centos32-1 is up
      2. Data Collection Successful
      ","HealthSeverity":"5","ImagePath":"/images/icon_monitors_linux.gif","AvailabilitySeverity":"5","DetailsPageURL":"/showresour ce.do?resourceid=10000108&method=showResourceForResourceID&PRINTER_FRIENDLY=true"}, {"Type":"Linux","HealthStatus":"clear","AvailabilityMessage":"Resource up.
      The resource linux is available.","DisplayName":"linux","ManagedServer":"Admin Server","AvailabilityStatus":"up","SubGroup":"Linux","ResourceId":"10000117","HealthMessage":"Health of karthi linux is clear.
      Root Cause :
      1. linux is up
      2. Data Collection Successful
      ","HealthSeverity":"5","ImagePath":"/images/icon_monitors_linux.gif","AvailabilitySeverity":"5","DetailsPageURL":"/showresour ce.do?resourceid=10000117&method=showResourceForResourceID&PRINTER_FRIENDLY=true"}, {"Type":"Linux","HealthStatus":"clear","AvailabilityMessage":"Resource up.
      The resource prasadh linux is available.","DisplayName":"prasadh linux","ManagedServer":"Admin Server","AvailabilityStatus":"up","SubGroup":"Linux","ResourceId":"10000071","HealthMessage":"Health of linux1 is clear.
      Root Cause :
      1. linux1 is up
      2. Data Collection Successful
      ","HealthSeverity":"5","ImagePath":"/images/icon_monitors_linux.gif","AvailabilitySeverity":"5","DetailsPageURL":"/showresour ce.do? resourceid=10000071&method=showResourceForResourceID&PRINTER_FRIENDLY=true"}],"uri":"/AppManager/json/Search"},"response- code":"4000"} ShowPolledData API This API allows the user to fetch the polled data from a monitor or monitor group for the time period specified by the user. Syntax API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ShowPolledData?apikey=[ API Key ] API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ShowPolledData?apikey=[ API Key ] Request ParametersField Description resourceid This value is the resourceid of the monitor from which the data has to be fetched. attributeID This is the value of the attribute id for which the polled or archived data has to be shown. The period for which the downtime details have been requested: Period : 0 → Today Period : 3 → Yesterday Period : 6 → This Week Period : 1 or -7 → Last 7 days Period : 12 → Last Week period Period : 7 → This Month Period : 2 or -30 → Last 30 days Period : 11 → Last Month Period : 9 → This Quarter Period : 8 → This Year Period : 5 → Last 1 year Period: 20 → Shows all polled data Using these parameters you can set custom period for ShowPolledData API. Enter the values for startDate startDate and endDate in the format YYYY-MM-DD HH:MM where HH should be in 24 hour format. and   endDate Period parameter ''period'' should be set to 4 for custom period. Sample Request Polled Data API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/showPolledData? apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=20&attributeID=310 API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/showPolledData? apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=20&attributeID=3102 Last 7 days Data API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/showPolledData? apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-7&attributeID=3102 API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/showPolledData? apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-7&attributeID=3102 Last 30 days Data API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/showPolledData? apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-30&attributeID=3102 API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/showPolledData? apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042&period=-30&attributeID=3102Custom Period API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ShowPolledData? apikey=3d6d7d7fcabfc818ad28de01aa1c9773&resourceid=10000016&attributeID=1938&period=4&startDat e=2017-11-06 11:20&endDate=2017-11-16 11:40 API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ShowPolledData? apikey=3d6d7d7fcabfc818ad28de01aa1c9773&resourceid=10000016&attributeID=1938&period=4&startDat e=2017-11-06 11:20&endDate=2017-11-16 11:40 Response Details Field Description This is the start time in milli seconds format from which 7/30/ show polled StartTime data report is generated This is the end time in milli seconds format from which 7/30/ show polled data EndTime report is generated This is the start time in date time format from which 7/30/ show polled data StartDateTime report is generated This is the end time in date time format from which 7/30/ show polled data EndDateTime report is generated ResourceName This is the monitor name from which the data is returned ResourceType This is the type of the resource for which the data is returned AttributeName This is the name of the attribute Unit This is the units of the attribute AttributeID This is the ID of the user This is the type of data this API call is returning (Polled data / 7 days data / 30 ReportType days data). BusinessPeriod This represents the business period name ResourceId This is the monitor resourceid AttributeImage This is the attribute graph for the data returned along with this response. Status This is the status of the REST API call to get the show polled data This value specifies the the type of data that needs to be returned. its values Period are : 20 for show polled data, -7 for 7 days archieved data and -30 for 30 days archieved data. CollectionTime -- represents the time stamp in ms at which the data is collected RawData DateTime -- represents the time stamp in date time format at which the data is collected Value -- this represents the value of the attribute ArchivedTime -- represents the archived time in ms DateTime -- represents the archived time in data time format ArchiveData AvgValue -- this is the avg time of the value in that archived period MinValue -- this is the minimum value in that archived period MaxValue -- this is the maximum value in that archived period Sample Response XML Input:http://apm-prod1:9090/AppManager/xml/ShowPolledData? apikey=c4e547c2330e2eb92d3e7af2262da9e9&resourceid=20000039&period=20&attributeID=1957 XML Response: JSON Input: http://apm-prod1:9090/AppManager/json/ShowPolledData? apikey=c4e547c2330e2eb92d3e7af2262da9e9&resourceid=20000039&period=20&attributeID=1957 JSON Response: {"response-code":"4000","response":{"uri":"/AppManager/json/ShowPolledData","result": [{"StartTime":"1337928634448","EndDateTime":"May 25, 2012 3:32 PM","ResourceName":"apm- prod1_Windows Vista","Unit":"%","EndTime":"1337940130413","BusinessPeriod":"NA","ReportType":"Polled data","ThresholdDetails":[],"ResourceId":"20000039","AttributeName":"CPU Utilization","AttributeID":"1957","AttributeImage":"/webclient/temp/images/fjrEKg.jpg","Status":"SUCCESS"," RawData":[{"CollectionTime":"1337940130413","Value":"18","DateTime":"May 25, 2012 3:32 PM"}, {"CollectionTime":"1337939525577","Value":"11","DateTime":"May 25, 2012 3:22 PM"}, {"CollectionTime":"1337938920641","Value":"5","DateTime":"May 25, 2012 3:12 PM"}, {"CollectionTime":"1337938315808","Value":"6","DateTime":"May 25, 2012 3:01 PM"}, {"CollectionTime":"1337937710788","Value":"7","DateTime":"May 25, 2012 2:51 PM"}, {"CollectionTime":"1337937105838","Value":"7","DateTime":"May 25, 2012 2:41 PM"}, {"CollectionTime":"1337936500971","Value":"9","DateTime":"May 25, 2012 2:31 PM"}, {"CollectionTime":"1337935895963","Value":"18","DateTime":"May 25, 2012 2:21 PM"}, {"CollectionTime":"1337935291160","Value":"7","DateTime":"May 25, 2012 2:11 PM"}, {"CollectionTime":"1337934686297","Value":"31","DateTime":"May 25, 2012 2:01 PM"}, {"CollectionTime":"1337934079880","Value":"13","DateTime":"May 25, 2012 1:51 PM"}, {"CollectionTime":"1337933475084","Value":"16","DateTime":"May 25, 2012 1:41 PM"}, {"CollectionTime":"1337932869853","Value":"34","DateTime":"May 25, 2012 1:31 PM"}, {"CollectionTime":"1337932263739","Value":"8","DateTime":"May 25, 2012 1:21 PM"}, {"CollectionTime":"1337931658583","Value":"7","DateTime":"May 25, 2012 1:10 PM"}, {"CollectionTime":"1337931053751","Value":"17","DateTime":"May 25, 2012 1:00 PM"}, {"CollectionTime":"1337930448921","Value":"9","DateTime":"May 25, 2012 12:50 PM"}, {"CollectionTime":"1337929844110","Value":"6","DateTime":"May 25, 2012 12:40 PM"}, {"CollectionTime":"1337929239270","Value":"3","DateTime":"May 25, 2012 12:30 PM"}, {"CollectionTime":"1337928634448","Value":"9","DateTime":"May 25, 2012 12:20 PM"}],"ResourceType":"Windows Vista","StartDateTime":"May 25, 2012 12:20 PM","Period":"20"}]}} Get SLA Report APIs With the APIs given below, you can get the raw data of SLA reports for the configured business applications and servers from Applications Manager. SLA Report API Server SLA Report APISLA Configuration Details API SLA Report API This API allows the user to get the raw data of SLA reports in Applications Manager. Syntax Using period parameter: http://[ APM Host ]:[ APM Port ]/AppManager/xml/slaReport?apikey=[API Key]&period= [period]&showOnlySlaAppliedBAs=[true/false] Using custom time: http://[ APM Host ]:[ APM Port ]/AppManager/xml/slaReport?apikey=[API Key]&showOnlySlaAppliedBAs= [true/false]&startTime=[Start Time]&endTime=[End Time] Request Parameters Field Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. The period for which the SLA report have been requested. Possible values are: 0 → Today 3 → Yesterday 6 → This Week 1 → Last 7 days 12 → Last Week period 7 → This Month 2 → Last 30 days 11 → Last Month 9 → This Quarter 8 → This Year 5 → Last 1 year showOnlySlaAppliedBAs Filters out Only SLA Applied BA(s) in the response. (True or False) startTime Custom start time in milliseconds. endTime Custom end time in milliseconds. Sample Request Using period parameter: http://apm-prod1:9090/AppManager/xml/slaReport? apikey=c4e547c2330e2eb92d3e7af2362da9e9&period=0&showOnlySlaAppliedBAs=true Using custom time: http://apm-prod1:9090/AppManager/xml/slaReport? apikey=c4e547c2330e2eb92d3e7af2362da9e9&showOnlySlaAppliedBAs=true&startTime=1582191000000 &endTime=1582194600000 Sample Response Server SLA Report API This API allows the user to get the raw data of Server SLA reports in Applications Manager. Syntax Using period parameter: http://[ APM Host ]:[ APM Port ]/AppManager/json/serverSlaReport?apikey=[API Key]&period= [period]&showOnlySlaAppliedServers=[true/false] Using custom time: http://[ APM Host ]:[ APM Port ]/AppManager/json/serverSlaReport?apikey=[API Key]&showOnlySlaAppliedServers=[true/false]&startTime=[Start Time]&endTime=[End Time] Request Parameters Field Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. The period for which the server SLA report have been requested. Possible values are: 0 → Today 3 → Yesterday 6 → This Week 1 → Last 7 days period 12 → Last Week 7 → This Month 2 → Last 30 days 11 → Last Month 9 → This Quarter 8 → This Year 5 → Last 1 year showOnlySlaAppliedServers Filters out Only SLA Applied servers in the response. (True or False) startTime Custom start time in milliseconds. endTime Custom end time in milliseconds.Sample Request Using period parameter: http://apm-prod1:9090/AppManager/json/serverSlaReport? apikey=c4e547c2330e2eb92d3e7af2362da9e9&period=0&showOnlySlaAppliedServers=true Using custom time: http://apm-prod1:9090/AppManager/json/serverSlaReport? apikey=c4e547c2330e2eb92d3e7af2362da9e9&showOnlySlaAppliedServers=true&startTime=15821910000 00&endTime=1582194600000 Sample Response { "response-code": "4000", "response": { "result": [ { "MeanTimeToRepair": "0 Secs", "EventSlaStatus": "PASS", "EventSlaCondition": "less than", "Name": "Windows 10_AdminServer", "ClearEventCount": "0", "UnmanagedPercentage": "0", "WarningEventCount": "0", "MailOptedForSlaEscalation": "false", "EventSlaDuration": "month", "AvailabilitySlaCondition": "greater than", "Availability": "100", "MeanTimeBetweenFailures": "18 Hrs 14 Mins 51 Secs", "UnderScheduledMaintenancePercentage": "0", "SlaId": "2", "AvailabilitySlaValue": "99.9", "TotalDowntime": "0 Secs", "AvailabilitySlaStatus": "PASS", "CriticalEventCount": "0", "ResourceId": "10017", "EventSlaValue": "10", "SlaName": "Silver" } ], "uri": "/AppManager/json/serverSlaReport" } } SLA Configuration Details API This API allows the user to list the SLA configuration details in Applications Manager. Syntax Without SLA ID: http://[ APM Host ]:[ APM Port ]/AppManager/xml/slaDetails?apikey=[API Key] With SLA ID: http://[ APM Host ]:[ APM Port ]/AppManager/json/slaDetails?apikey=[API Key]&slaId=[SLA IDs] Request ParametersField Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. slaId Indicates the SLA Identifier. Multiple SLA IDs can be given (separated by commas). Sample Request Without SLA ID: http://apm-prod1:9090/AppManager/xml/slaDetails?apikey=c4e547c2330e2eb92d3e7af2362da9e9 With SLA ID: http://apm-prod1:9090/AppManager/json/slaDetails? apikey=c4e547c2330e2eb92d3e7af2362da9e9&slaId=1,2 Sample Response Without SLA ID: With SLA ID: { "response-code": "4000", "response": { "result": [ { "Description": "This is For Server", "Type": "Server", "AssociatedResources": [ { "DisplayName": "Windows 10", "ResourceId": "10000019" } ], "Id": "2", "BusinessHourId": "-1", "MailOptedForEscalation": "true", "AvailabilityThreshold": "97.0", "Name": "Silver ", "MailDetails": [{ "Subject": "Alarm due to SLA violation", "Message": "This information has been generated due to an SLA violation", "ToAddress": "info@test.com", "FromAddress": "info1@test.com" } ], "AvailabilityCondition": "greater than", "EventCondition": "less than", "EventThreshold": "10" }, { "Description": "This is For Business Application", "Type": "Business Application", "AssociatedResources": [ { "DisplayName": "Applications Manager", "ResourceId": "10000013" }, { "DisplayName": "test-1", "ResourceId": "10000206" } ], "Id": "1", "BusinessHourId": "-1", "MailOptedForEscalation": "true", "AvailabilityThreshold": "99.9", "Name": "Gold ", "MailDetails": [ { "Subject": "Alarm due to SLA violation", "Message": "This information has been generated due to an SLA violation", "ToAddress": "test1@test.com", "FromAddress": "test@test.com" } ], "AvailabilityCondition": "greater than", "EventCondition": "less than", "EventThreshold": "10" } ], "uri": "/AppManager/json/slaDetails" } } User Management API With the APIs given below, you can perform various user management operations in Applications Manager: Create User Delete User Get All User Roles List User Details Update User Add UserGroup Delete Usergroup List Usergroups Update Usergroups Create User API This API will allow admin to create a new user in Applications Manager. Sample Request For XML Response:http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/create?apikey=[API Key]&userName= [USERNAME]&role=[ROLE]&password=[PASSWORD] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/create?apikey=[API Key]&userName= [USERNAME]&role=[ROLE]&password=[PASSWORD] Request Parameters The parameters involved in the API request are described below: Field Description userName The user name of the user. role User group of the new user. Possible values are OPERATOR, MANAGER, ADMIN, USER. password Password of the new user. email (optional) Email id of the user. description Description of the user. (optional) groupId Group id of the monitor groups to which the user needs to be associated. The group ids should (optional) be comma separated. groupName Name of a monitor group to which the user needs to be associated. If groupId is provided this (optional) parameter will be ignored. Sample Request http://prod-server:2020/AppManager/xml/Users/create? apikey=bc343n432nmbb342243nnv324&userName=manager&role=MANAGER&password=manpass123 Sample Response Delete User API This API will allow admin to delete users. Sample Request For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/delete?apikey=[ API Key ]&userId=[id] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/delete?apikey=[ API Key ]&userName=[name] *Only one parameter (userId or userName) is to be mentioned. Request Parameters The parameters involved in the API request are described below:Field Description userId* Id of the users to be deleted. The user ids should be comma separated. userName The user name of the user to be deleted. If userId is provided this parameter will be ignored. Get All User Roles API This API allows the user to list all the available user roles with display name, description and role name in Applications Manager. Syntax http://[host]:[port]/AppManager/xml/Users/roles?apikey=[apikey] Request Parameters The parameters involved in the API request are described below: Field Description A long text, unique to every Applications Manager account, required to use the Applications Manager apikey REST APIs. The key can be generated using the Generate API Key option in the ''Admin'' tab. Sample Request http://app-windows:9090/AppManager/xml/Users/roles?apikey=7b5fde68148fa2419bc2f1a1ab87e75 ListUserDetails API Users Details This API allows an admin user to fetch the details of all the users. Users other than admin can only access their own details. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users?apikey=[ API Key ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Users?apikey=[ API Key ] User ID Details This API allows an admin user to fetch the details of a particular user, by providing either the user id or user name. Other users can only access their own details. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/[userId]?apikey=[ API Key ] (OR) http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/[username]?apikey=[ API Key ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/[userId]?apikey=[ API Key ] (OR)http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/[username]?apikey=[ API Key ] Request Parameters The parameters involved in executing this API request are: Field Description         userId Id of the user whose detail is to be fetched. userName The user name of the user whose detail is to be fetched. apikey The key generated using the Generate API Key option in the ''Admin'' tab. Sample Requests http://app-windows:59090/AppManager/xml/Users?apikey=93c6eb60184e41f10fba2f365060b8e3 http://app-windows:59090/AppManager/xml/Users/1?apikey=93c6eb60184e41f10fba2f365060b8e3 http://app-windows:59090/AppManager/xml/Users/admin? apikey=93c6eb60184e41f10fba2f365060b8e3 Sample Response Note: Deprecated API: The above API will work for users using Applications Manager 11030 and above. For users with lower versions, the ListUserDetails API (Sample: http://[Host]:[Port]/AppManager/xml/ListUserDetails? apikey=[APIKEY]) will continue to work till the next release. Update User API This API will allow an admin user to edit the information of all users, whereas other users will be able to change their own password and email address. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Users/update?apikey=[ API Key ]&userId=[id]&userName= [name]&role=[role]&password=[password] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Users/update?apikey=[ API Key ]&userId=[id]&userName= [name]&role=[role]&password=[password] Request Parameters for Admin Users Field Description        userId Id of the user to be updated. In case this info is not provided, the particular APIs owner id will be taken by default. The user name of the user. (User name of the default ''admin'' cannot be userName changed) User group of the new user. (User role of the default ''admin'' cannot be role changed) password New password of the user. oldPassword Old password of the user. email Email id of the user. description Description of the user. Group id of the monitor groups to which the user needs to be associated. The associateGroupId group ids should be comma separated. Name of a monitor group to which the user needs to be associated. If groupId associateGroupName is provided this parameter will be ignored. Group id of the monitor group from which the user needs to be removed. The removeGroupId group ids should be comma separated. Name of a monitor group from which the user needs to be removed. If groupId removeGroupName is provided this parameter will be ignored. * - All parameters are optional. Request Parameters for Normal Users Field Description         password New password of the user. Old password of the user (This parameter is mandatory to update the oldPassword password). email Email id of the user. Sample Response Add Usergroup API This API allows an admin user to add a user group in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupName=[ Group Name ]&userName=[ User Name ] http://[ APM Host ]:[ APM Port ]/AppManager/xml/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupId=[ Monitor Group ID ]&userId=[ User ID ] For JSON Response:http://[ APM Host ]:[ APM Port ]/AppManager/json/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupName=[ Group Name ]&userName=[ User Name ] http://[ APM Host ]:[ APM Port ]/AppManager/json/Usergroup/create?apikey=[ API Key ]&usergroupName=[ User Group Name ]&groupId=[ Monitor Group ID ]&userId=[ User ID ] Request Parameters The parameters involved in executing this API request are: Field Description         apikey The key generated using the Generate API Key option in the ''Admin'' tab. userId The Id of the user who is to be associated with the user group. userName The name of the user to be added. usergroupName The name of the usergroup to be added. groupId The Id of the group is to be added. Sample Request http://app-windows:59090/AppManager/xml/Usergroup/create? apikey=93c6eb60184e41f10fba2f365060b8e3&usergroupName=sample&groupName=ApplicationsMa nager&userName=user http://app-windows:59090/AppManager/xml/Usergroup/create? apikey=93c6eb60184e41f10fba2f365060b8e3&usergroupName=sample&groupId=10011,10000019&u serId=4,5 Delete Usergroup API This API allows an admin user to delete a user group. Users other than admin can only access their own details. Sample Request Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Usergroup/delete?apikey=[ API Key ] &usergroupName= [ Group Name ] http://[ APM Host ]:[ APM Port ]/AppManager/xml/Usergroup/delete?apikey=[ API Key ] &usergroupId=[ Group Id ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Usergroup/delete?apikey=[ API Key ] &usergroupName= [ Group Name ] http://[ APM Host ]:[ APM Port ]/AppManager/json/Usergroup/delete?apikey=[ API Key ] &usergroupId=[ Group Id ] Request Parameters The parameters involved in executing this API request are: Field Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. usergroupId The Id of the user group which is to be deleted. usergroupName The name of the user group which is to be deleted.Example http://app-windows:5909/AppManager/xml/Usergroup/delete? apikey=b9a17b29f5883a2a454ab1711b9f12f9&usergroupName=sample http://app-windows:5909/AppManager/xml/Usergroup/delete? apikey=b9a17b29f5883a2a454ab1711b9f12f9&usergroupId=1,2 List User Groups API This API allows an admin user to list all the user groups in Applications Manager. Users other than admin can only access their own details. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/UsergroupDetails?apikey=[ API Key ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/UsergroupDetails?apikey=[ API Key ] Request Parameters The parameters involved in executing this API request are: Field Description userId Id of the user whose detail is to be fetched. userName The user name of the user whose detail is to be fetched. apikey The key generated using the Generate API Key option in the ''Admin'' tab. Sample Request For XML Response: http://app-windows:59090/AppManager/xml/UsergroupDetails? apikey=93c6eb60184e41f10fba2f365060b8e3 For JSON Response: http://app-windows:59090/AppManager/json/UsergroupDetails? apikey=93c6eb60184e41f10fba2f365060b8e3 Update User Group API Users Details This API allows an admin user to update the details of a user group. Users other than admin can only access their own details. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Usergroup/update?apikey=[ API Key ]&usergroupId=[ User Group Id ]&usergroupName=[ User Group Name ]&associateGroupId=[ Associate Group ID ]&associateUserId=[ Associate User ID ]&removeGroupId=[ Remove Group ID ]&removeUserId=[ Remove User ID ]For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Usergroup/update?apikey=[ API Key ]&usergroupId=[ User Group Id ]&usergroupName=[ User Group Name ]&associateGroupId=[ Associate Group ID ]&associateUserId=[ Associate User ID ]&removeGroupId=[ Remove Group ID ]&removeUserId=[ Remove User ID ] Request Parameters The parameters involved in executing this API request are: Field Description userId ID of the user whose detail is to be updated. userName Username of the user whose detail is to be updated. apikey The key generated using the Generate API Key option in the ''Admin'' tab. usergroupId ID of the user group of which the details are to be updated usergroupname Name of the user group of which the details are to be updated ID of the user group to which the details are to be associated. The Group IDs associateGroupId should be separated by commas. ID of the user to which the details are to be associated. The User IDs should be associateUserId separated by commas. ID of the user group to which the details are to be removed. The Group IDs removeGroupId should be separated by commas. ID of the user to which the details are to be removed. The User IDs should be removeUserId separated by commas. Sample Request For XML Response: http://app-windows:5909/AppManager/xml/Usergroup/update? apikey=b9a17b29f5883a2a454ab1711b9f12f9&usergroupId=1&usergroupName=sampless&associateGroupI d=10000019&associateUserId=4&removeGroupId=10011&removeUserId=5 For JSON Response: http://app-windows:5909/AppManager/json/Usergroup/update? apikey=b9a17b29f5883a2a454ab1711b9f12f9&usergroupId=1&usergroupName=sampless&associateGroupI d=10000019&associateUserId=4&removeGroupId=10011&removeUserId=5 Perform Operations With the APIs given below, you can perform various operations in Applications Manager: Alarm Actions Authenticator Apply License Configure Mail Server Configure Proxy Server Configure SMS Server Delete Monitor Enable / Disable Actions Execute Action Manage UnManage PingPollNow UnManage and Reset Status Delete Downtime Managed Server Down Email Alert Fetch Data Alarm Actions API This API will be used to execute alarm actions like Assigning, Unassigning, Clearing Alarms and Adding, Listing Annotations in Applications Manager. API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/AlarmAction?apikey= &action= &entity= &username= &message= API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/AlarmAction?apikey= &action= &entity= &username= &message= Request Parameters: Field Description AppManager_Host The server in which Applications Manager is installed. AppManager_Port The Applications Manager webserver port. api_key The API key of the user performing the operation. action_type PickupAlarm / UnpickupAlarm / ClearAlarm / AddAnnotation / ListAnnotations The entity field should have value [Resource ID of Monitor]_[Attribute ID]. This is a unique identifier entity for an alarm in Applications Manager. message Specify the message used to annotate an alarm. Username used to pickup the alarm on the absence of which, the, username of the apikey will be username used. Sample XML Input: http://apm-prod1:9090/AppManager/xml/AlarmAction? apikey=37097301e45784daa94889f35f2509ab&action=ClearAlarm&entity=10000285_527 Sample XML Response: Successfully Cleared the Alarm! JSON Input http://apm-prod1:9090/AppManager/json/AlarmAction? apikey=37097301e45784daa94889f35f2509ab&action=ClearAlarm&entity=10000285_527JSON Response {"response":{"result":[{"message":"Successfully Cleared the Alarm!"}],"uri":"/AppManager/json/AlarmAction"},"response-code":"4000"} Authenticator API For mobile applications, new users may need to reuse the API Key provided to successfully authenticated users, so that they can use it for remaining operations.Authenticator API allows users to fetch details like the their API Keys, Roles, image and any other information associated to the user for successful authentication. Note: We hope to make it available only in HTTPS (SSL) Mode & POST Method. API for XML Response : https://[ APM Host ]:[ APM Port ]/AppManager/xml/Authenticator API for JSON Response : https://[ APM Host ]:[ APM Port ]/AppManager/json/Authenticator Request Parameters: Field Description j_username Username has to be posted to the above mentioned request with ''j_username'' as parameter name. j_password Password has to be posted to the above mentioned request with ''j_password'' as parameter name. Response Details: Field Description APIKey This is the username. Description This is the description of the user account given at the time of creation of user account EmailID This is the e-mail id of the user GroupName This is the typ of account the user has. ex: operator, admin, manager etc. UserImage This is User image path UserID This is the ID of the user UserName This is the username of the user. JSON Input https://apm-prod1:8445/AppManager/json/Authenticator?j_username=admin&j_password=admin JSON Response {"response-code":"4000","response":{"uri":"/AppManager/json/Authenticator","result": [{"EmailID":"NA","UserID":"1","Description":"NA","UserName":"admin","APIKey":"c4e547c2330e2eb92d3e7af22 62da9e9","UserImage":"/images/icon_user.gif","GroupName":"ADMIN"}]}} Apply License APIThis API allows the user to apply a license in Applications Manager. Sample Request http://[host]:[port]/AppManager/xml/ApplyLicense?apikey=[apikey]&filePath=[local-filepath] (or) Use multipart/form-data with post method : Example:

_

Upload a License File
License File

Request Parameters The parameters involved in the API request are described below: Field Description         filePath The path to the directory containing the license file. Example: http://app-windows:9090/AppManager/xml//ApplyLicense?apikey=7b5fde68148fa2419bc2f1a1ab87e75&filePath=local-filepath Mail Server API Mail Server API allows the user to view mail server details and configure mail server parameters in Applications Manager. This API is designed to support GET and POST requests. GET Request - To view/list mail server details. POST Request - To add or update mail server details. GET Request Whenever the request is sent by "GET" method, the data corresponding to the API will be listed. Sample Request: http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey] POST Request When the request is sent by "POST" method, the corresponding data will be added/updated.Sample Request: http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey] Request Parameters The parameters involved in the API request are described below: For Primary Server Field Description smtpServer The Server IP or host name of the host in which the SMTP server runs. smtpPort The SMTP port number. smtpEmail The email address available in that SMTP server. smtpUserName User name for authentication smtpPassword Password for authentication prmTlsAuth Primary Tls Authentication. The value can be either true or false. prmSslAuth Primary SSL Authentication. The value can be either true or false. For Secondary Server Field Description secSmtpServer The Server IP or host name of the host in which the SMTP server runs. secSmtpPort The SMTP port number. secSmtpEmail The email address available in that SMTP server. secSmtpUserName Username for authentication. secSmtpPassword Password for authentication. secTlsAuth Secondary Tls Authentication. The value can be either true or false. secSslAuth Secondary SSL Authentication. The value can be either true or false. Example: http://app-windows:9091/AppManager/xml/MailServer?apikey=7b5fde68148fa2419bc2f1a1ab87e75 Configure Proxy Server API This API allows the user to view proxy server details and configure proxy server parameters. This API is designed to support GET and POST requests. GET Request - To view/list proxy server details. POST Request - To add or update proxy server details. GET Request Whenever the request is sent by "GET" method, the data corresponding to the API will be listed. Syntax http://[host]:[port]/AppManager/xml/ProxyServer?apikey=[apikey] POST Request When the request is sent by "POST" method, the corresponding data will be added/updated. Syntax http://[host]:[port]/AppManager/xml/ProxyServer?apikey=[apikey]Request Parameters The parameters involved in the API request are described below: Field Description Option to automaticcally use default proxy configuration settings.Values can be true or false. If set to false, then automatic proxy configuration settings will useproxy be used. Note: Specifying any value other than "true" for this will be asssumed as false and the automatic proxy configuration will be used. The host name or host id of the proxy server that has to be used in host configuration. port The port number of the proxy server. username The username for proxy server authentication. password The password for proxy server authentication. Option to enable bypass for the proxy server. Values can be true or false. If set bypassproxy to true, will enable the bypass for the proxy server. Note: Any value other than "true" will be assumed as false. Do not use proxy for addresses beginning with the hosts mentioned in this dontProxyList parameter. Multiple hosts are separated by semicolon (;). Sample Request http://app-windows:9090/AppManager/xml/ProxyServer?apikey=7b5fde68148fa2419bc2f1a1ab87e75 Configure SMS Server API This API allows the user to to view SMS server details and configure SMS server parameters. This API is designed to support GET and POST requests. GET Request - To view/list SMS server details. POST Request - To add or update SMS server details. GET Request Whenever the request is sent by "GET" method, the data corresponding to the API will be listed. Sample Request http://[host]:[port]/AppManager/xml/SMSServer?apikey=[apikey]   POST Request When the request is sent by "POST" method, the corresponding data will be added/updated. Sample Request http://[host]:[port]/AppManager/xml/SMSServer?apikey=[apikey]   Request Parameters The parameters involved in the API request are described below:   Field Description        SMSPort The port in which the modem is connected.  Example: http://app-windows:9090/AppManager/xml/SMSServer?apikey=7b5fde68148fa2419bc2f1a1ab87e75 Delete Monitor API This API is used to delete a monitor. Sample Request http://[Host]:[Port]/AppManager/xml/DeleteMonitor?apikey=[APIKEY]&resourceid=[RESOURCEID] Request Parameters The parameters involved in executing this API request are: Field Description apikey The key generated using the Generate API Key option in the ''Admin'' tab. The resource id of the monitor that needs to be deleted. You may also add multiple resourceids to resourceid delete multiple monitors. Example http://app-windows:59090/AppManager/xml/DeleteMonitor? apikey=93c6eb60184e41f10fba2f365060b8e3&resourceid=10000032 Multiple resourceid can be given as comma separated.To delete multiple monitors: http://app-windows:59090/AppManager/xml/DeleteMonitor? apikey=93c6eb60184e41f10fba2f365060b8e3&resourceid=10000032,10000033,10000034 Example Output:                      The monitor deleted successfully.            If the API is not executed correctly, the request will fail and errors will be shown as given below:                    The specified apikey [ "+apiKey+" ] in the request is invalid. Kindly login to Applications Manager and check for the key in generate key in Admin tab.                Refer this page for a list of common error conditions. Enable/Disable Actions API ManageEngine Applications Manager provides REST APIs for bulk enabling or disabling of alarms actions configured for a monitor or monitor-groups. API to Enable/Disable Alarms for a monitorhttp://[ Host ]:[ Port ]/AppManager/xml/EnableDisableAlarmsAction?apikey=[ API key ]&resourceid=[ RESOURCEID]&alteraction=[enable/disable] http://[ Host ]:[ Port ]/AppManager/xml/EnableDisableAlarmsAction?apikey=[ API key ]&haid=[ MONITORGROUPID ]&alteraction=[enable/disable] Request Parameters Field Description API Key The key generated from "Generate API Key" option in the Admin tab. resourceid=[ RESOURCEID ] where RESOURCEID is the resourceid AM_ManagedObject.RESOURCEID of the monitor to be unmanaged. alteraction The enable or disable action. ID of the monitor group/sub group for which actions should be haid enabled/disabled. Example Input http://app-windows:9090/AppManager/xml/EnableDisableAlarmsAction? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000056&alteraction=enable Example Output Enable/Disable alarms done successfully. Execute Action This API will be used to execute the actions that are configured in Applications Manager. An Operator can only execute an action that is associated to him. Syntax API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/ExecuteAction?apikey=[ API Key ]&ActionId=10000056 API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/ExecuteAction?apikey=[ API Key ]&ActionId=10000056 Request Parameters Field Description ActionId This value specifies the action id and helps the API to execute the corresponding action. Sample Request XML Input: http://apm-prod1:9090/AppManager/xml/ExecuteAction? apikey=c4e547c2330e2eb92d3e7af2262da9e9&ActionId=10000056 XML Response: JSON Input: http://apm-prod1:9090/AppManager/json/ExecuteAction? apikey=c4e547c2330e2eb92d3e7af2262da9e9&ActionId=10000056 JSON Response: {"response-code":"4000","response":{"uri":"/AppManager/json/ExecuteAction","result": [{"ActionTypeID":"1","Status":"Success","ActionExecPath":"/common/executeAction.do? method=testAction&actionID=20000003","Message":"The action alert_mail has been successfully executed","ActionName":"alert_mail","ActionID":"20000003","ActionType":"E-mail Action(s)"}]}} Note: For the Actions like Ec2Instance / VMActions / Service actions (Start/ Stop/ Restart) will execute the action directly whereas in UI we are asking the user to send a test mail or to execute the action. Manage API ManageEngine Applications Manager provides Manage API that allows the user to manage a monitor. Syntax http://[ Host ]:[ Port ]/AppManager/xml/ManageMonitor?apikey=[ API key ]&resourceid=[ RESOURCEID ] http://[ Host ]:[ Port ]/AppManager/xml/ManageMonitor?apikey=[ API key ]&haid=[ MONITOR GROUP ID ] Note: This API is not supported for Admin Server. Request Parameters Field Description API Key The key generated from "Generate API Key" option in the Admin tab. resourceid=[ RESOURCEID ] where RESOURCEID is the AM_ManagedObject.RESOURCEID of the resourceid monitor to be managed. haid The resourceid of the monitor group that you want to manage. Sample Request http://app-windows:9090/AppManager/xml/ManageMonitor? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000031 Sample Response                         Monitor with resourceID 10000031 managed successfully             UnManage API ManageEngine Applications Manager provides REST APIs for fetching data from Applications Manager server. This API allows the user to unmanage a monitor. API to UnManage a Monitor: http://[ Host ]:[ Port ]/AppManager/xml/UnmanageMonitor?apikey=[ API key ]&resourceid=[ RESOURCEID ]   http://[ Host ]:[ Port ]/AppManager/xml/UnmanageMonitor?apikey=[ API key ]&haid=[ MONITORGROUPID ] Request Parameters: Field Description API Key The key generated from "Generate API Key" option in the Admin tab. resourceid=[ RESOURCEID ] where RESOURCEID is the AM_ManagedObject.RESOURCEID of the resourceid monitor to be unmanaged. haid The resourceid of the monitor group which you want to un-manage. Example Input: http://app-windows:9090/AppManager/xml/UnmanageMonitor? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000056   http://app-windows:9090/AppManager/xml/UnmanageMonitor? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&haid=10 Example Output:                         Monitor with resourceID 10000056 unmanaged successfully             Ping API This API will be used to ping the given server or the server corresponding to the given ping monitor''s resource ID. The ping command will be executed and the result will be passed as response of the request. Syntax API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Ping?apikey=[ API Key ]&resourceid=''10000157'' API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Ping?apikey=[ API Key ]&host=''hemachand-0591'' Request Parameters Field Description resourceid This value specifies the resourceid of the monitor, So that we can ping host corresponding tomonitor. This is the host of any server which can be passed as parameter to ping from the Applications host Manager server. Response Parameters Field Description APIKey This is the username. Description This is the description of the user account given at the time of creation of user account EmailID This is the e-mail id of the user GroupName This is the typ of account the user has. ex: operator, admin, manager etc., UserImage This is User image path UserID This is the ID of the user UserName This is the username of the user. Sample Request XML Input: http://prod-server:9090/AppManager/xml/Ping? apikey=apikey=c4e547c2330e2eb92d3e7af2262da9e9&resourceid=''10000157'' XML Response: JSON Input: http://apm-prod1:9090/AppManager/json/Ping? apikey=c4e547c2330e2eb92d3e7af2262da9e9&host=apm-prod1 JSON Response: {"response-code":"4000","response":{"uri":"/AppManager/json/Ping","result":[{"Output":"Pinging apm- prod1.csez.zohocorpin.com [fe80::51a4:f642:390a:7e1f%14] with 32 bytes of data:
Reply from fe80::51a4:f642:390a:7e1f%14: time<1ms

Ping statistics for fe80::51a4:f642:390a:7e1f%14:
Packets: Sent = 1, Received = 1, Lost = 0 (0% loss),
Approximate round trip times in milli-seconds:
Minimum = 0ms, Maximum = 0ms, Average = 0ms
","Host":"apm- prod1.csez.zohocorpin.com","IPAddress":"192.168.26.79"}]}} PollNow API This API allows you to poll a particular monitor. Syntax http://[Host]:[Port]/AppManager/xml/PollNow?apikey=[APIKEY]&resourceid=[RESOURCEID] Request ParametersThe parameters involved in executing this API request are: Field Description         apikey The key generated using the Generate API Key option in the ''Admin'' tab. resourceid The resource id of the monitor that needs to be polled. Sample Request http://app-xp5:9099/AppManager/xml/PollNow? apikey=123b7328e4b41d1efe64aa7980d83d77&resourceid=10000293 Sample Response The monitor polled successfully. If the API is not executed correctly, the request will fail and errors will be shown as given below:                    Improper resourceid in the request.                Refer this page for a list of common error conditions. UnManage and Reset Status API ManageEngine Applications Manager provides REST APIs for unmanaging and reseting the current status of your Applications Manager monitors. API to UnManage and Reset Status of a Monitor http://[ Host ]:[ Port ]/AppManager/xml/UnmanageAndResetMonitor?apikey=[ API key ]&resourceid=[ RESOURCEID] http://[ Host ]:[ Port ]/AppManager/xml/UnmanageAndResetMonitor?apikey=[ API key ]&haid=[ MONITORGROUPID ] Request Parameters Field Description         The key generated from "Generate API Key" option in the API Key Admin tab. resourceid=[ RESOURCEID ] where RESOURCEID is the resourceid AM_ManagedObject.RESOURCEID of the monitor to be unmanaged. The resourceid of the monitor group which you want to un- haid manage and reset. The following is an example for UnmanageAndResetMonitor APIhttp://app-windows:9090/AppManager/xml/UnmanageAndResetMonitor? apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000056 Example output:  Unmanage and status reset completed successfully. Delete Downtime The Delete Downtime API removes downtime details of monitors and monitor groups. Syntax: http://[Host]:[Port]/AppManager/xml/deleteDowntime?apikey=[APIKEY]&resourceid= [RESOURCEID]&fromInMillis=[FROM TIME IN MILLISECONDS]&toInMillis=[TO TIME IN MILLISECONDS] Request Parameters: The parameters involved in the API request are described below. Also, refer the list of common Request Parameters. Field Description resourceid          The resource Id of the monitor whose downtime is to be deleted. The time from when the downtime should be removed. It can be found under the From column from                on the window that pops up when the  availability chart of the monitor is clicked. fromInMillis        The From time in Milliseconds. The time till when the downtime should be removed.  It can be found under the To column on the to      window that pops up when the  availability chart of the monitor is clicked. toInMillis          The To time in milliseconds. Sample Request: http://localhost:7000/AppManager/xml/deleteDowntime? apikey=3c7f392cf8eab16be37cfaf11d1e1fba&resourceid=10000280&from=Jul 10, 2018 12:00:00 AM&to=Jul 10, 2018 10:12:24 AM http://localhost:7000/AppManager/xml/deleteDowntime? apikey=3c7f392cf8eab16be37cfaf11d1e1fba&resourceid=10000280&fromInMillis=1531161000000&toInMillis=1531197743753 Enable/Disable Managed Server Down Email Alert This Rest API enables or disables the Managed Server Down email alerts from the Admin server. Syntax http://[Host]:[Port]/AppManager/xml/masDownEmail?apikey=[APIKEY]&enableMasDownMailNotification= [True/false] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters. Field Description enableMasDownMailNotification Specifies if the Managed Server Down Email Alert should be enabled.Sample Request http://apm-prod1:9090/AppManager/xml/masDownEmail? apikey=04945ae1027316dd798d50886854ace5&enableMasDownMailNotification=false Note: Only users with Admin previleges can use this API. Fetch Data API This API allows you to fetch the data from the managed servers at the given instant to admin server in Applications Manager. Syntax http://[APM Admin Host]:[APM Admin Port]/AppManager/xml/fetchNowForManagedServer?apikey=[Admin API Key]&serverID=[Managed Server ID] Request Parameters Field Description apikey API key of the admin user. serverID ID of the Managed server. (Obtained from Managed server tab in Admin server) Sample Input http://apm-prod:9090/AppManager/xml/fetchNowForManagedServer? apikey=7843b843910cbe6a1e5509fb9e07abd9&serverID=1 Sample Response Fetch now completed successfully Note: This API is applicable only for admin servers and admin users. Admin Activities API With the APIs given below, you can perform various operations with the Admin server in Applications Manager: REST APIs for Enterprise Edition Business Hours Configure Alarms Credential Manager Domain Configuration Email Action Configuration Event Log Configuration Mail Server Configuration Threshold configurationList and Map Dependencies Rest API for generating alarms SNMP Trap Listener Applications Manager REST APIs for Enterprise Edition ManageEngine Applications Manager provides REST APIs for configuring business hours, alarms, domains, event logs, thresholds, managing credentials and more from Applications Manager''s Enterprise setup. Using these APIs, Applications Manager''s data can be integrated with any internal portal or 3rd party System Management software. The data can be represented in a single dashboard itself. Click on the following links to know more: How do APIs work? Generating an API Key By using any XML parser in a scripting language, Java, C, Perl or Python, etc. you can make HTTPs requests in the format recommended in the API. This data can then be inserted into your own database or put in any format that you need. Here is a list of the APIs that you can use in the Admin Server: Business Hours Configure Alarms Credential Manager Domain Configuration Email Action Configuration EventLog Configuration Mail Server Configuration Threshold Configuration List and Map Dependencies How do APIs work? In order to use the API, each user should obtain an API key - which is a long text and is unique to their Applications Manager Account. The API key has to be passed as parameter in every API request made. Generate API Key The User can register for the API key from within Applications Manager product using the "REST API" option in the Admin tab. Note: Generating the API key is a one-time process. Steps for using REST API Click on the Admin tab Under Applications Manager Server Settings, click on REST API. The API key is generated - eg.7b5fde68148fa2419bc2f1a1ab87e757 Open the browser, the URL would be http:// :9090/AppManager/xml/ListServer? apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=all By changing to the required monitor, data pertaining to that monitor can be retrieved. Check if the following URL works fine http:// :9090/AppManager/xml/ListServer? apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=server will give data of all the server monitors. ''all'' will give the entire Applications Manager''s data. By using any xml parser in a scripting language, Java, C, Perl or Python etc, you can make HTTPs requests in the format recommended in the API. This data can then be inserted into your own database or put in any format that you need. Business Hours APIsThese APIs allow an admin user to configure business hours in Applications Manager. Business hours is a pre- determined set of hours which helps you to view reports for the particular hours during the day. Business hours APIs are designed to support GET and POST requests: Add Business Hour (POST Method) Edit Business Hour (POST Method) Delete Business Hour (POST Method) List Business Hour (GET Method) Request Parameters The parameters involved in executing this API request are: Field Description mondaystarthour, tuesdaystarthour, wednesdaystarthour, thursdaystarthour, The hour of the day at fridaystarthour, saturdaystarthour, sundaystarthour which business begins. mondayendhour, tuesdayendhour, wednesdayendhour, thursdayendhour, The hour of the day at fridayendhour, saturdayendhour, sundayendhour which business ends. mondaystartminute, tuesdaystartminute, wednesdaystartminute, The minute of the day at thursdaystartminute, fridaystartminute, saturdaystartminute, sundaystartminute which business begins. mondayendminute, tuesdayendminute, wednesdayendminute, thursdayendminute, The minute of the day at fridayendminute, saturdayendminute, sundayendminute which business ends. workingdays - (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday) Working days of the week. Add Business Hour This API allows an admin user to add business hours in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&name=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays= [Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&name=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays= [Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour] Sample Request http://app-windows:59090/AppManager/xml/businesshours? apikey=09eebdd6893db4d20e16b84dff6664f1&mondayendhour=20&wednesdayendminute=0&saturdaye ndhour=00&thursdayendhour=20&saturdaystarthour=00&sundaystartminute=0&sundayendminute=0&mon daystartminute=0&thursdaystarthour=08&saturdayendminute=0&fridayendhour=20&description=sample description&name=Test Business Hour&tuesdaystartminute=0&mondaystarthour=08&fridaystartminute=0&sundayendhour=00&tuesdayend minute=0&fridaystarthour=08&thursdaystartminute=0&wednesdaystarthour=08&saturdaystartminute=0&su ndaystarthour=00&wednesdayendhour=20&wednesdaystartminute=0&thursdayendminute=0&tuesdayendh our=20&workingdays=Monday,Tuesday,Wednesday,Thursday,Friday&mondayendminute=0&fridayendminut e=0&tuesdaystarthour=08Edit Business Hour This API allows an admin user to edit the business hours added in Applications Manager. Syntax http://[ APM Host ]:[ APM Port ]/AppManager/xml/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&newbusinessname=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays= [Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&businessid=[Business Id]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/businesshours?apikey=[ API Key ]&mondayendhour=[ Monday End Hour]&wednesdayendminute=[ Wednesday End Minute]&thursdaystarthour=[ Thursday Start Hour]&description=[Description]&newbusinessname=[Name]&tuesdaystartminute=[Tuesday Start Minute]&mondaystarthour=[ Monday Start Hour]&fridaystartminute=[Friday Start Minute]&workingdays= [Working days like Monday,Tuesday,Wednesday,Thursday,Friday]&businessid=[Business Id]&mondayendminute=[ Monday End Minute]&fridayendminute=[ Friday End Minute]&tuesdaystarthour=[ Tuesday End Hour] Sample Request http://app-windows:59090/AppManager/xml/businesshours? apikey=09eebdd6893db4d20e16b84dff6664f1&mondayendhour=20&wednesdayendminute=0&saturdaye ndhour=00&thursdayendhour=20&saturdaystarthour=00&sundaystartminute=0&sundayendminute=0&mon daystartminute=0&thursdaystarthour=08&saturdayendminute=0&fridayendhour=18&newbusinessname=Tes t Business Hour&description=sample description new description&tuesdaystartminute=0&mondaystarthour=08&fridaystartminute=0&sundayendhour=00&tuesd ayendminute=0&fridaystarthour=15&thursdaystartminute=0&wednesdaystarthour=08&saturdaystartminute= 0&sundaystarthour=00&wednesdayendhour=20&businessid=10000&wednesdaystartminute=0&thursdaye ndminute=0&tuesdayendhour=20&workingdays=Friday&mondayendminute=0&fridayendminute=0&tuesda ystarthour=08 Delete Business Hour This API allows an admin user to delete business hours in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/businesshours?apikey=[ API Key ]&businessid=[Business Id],&TO_DELETE=true For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/businesshours?apikey=[ API Key ]&businessid=[Business Id],&TO_DELETE=true Sample Request http://app-windows:59090/AppManager/xml/businesshours? apikey=09eebdd6893db4d20e16b84dff6664f1&businessid=10001,&TO_DELETE=true List Business Hour This API allows an admin user to list down the business hours in Applications Manager.Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/businesshours?apikey=[ API Key ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/businesshours?apikey=[ API Key ] Sample Request http://app-windows:59090/AppManager/xml/businesshours? apikey=09eebdd6893db4d20e16b84dff6664f1 Configure Alarms APIs These APIs allow an admin user to configure alarms in Applications Manager. This API can also be used to configure alarms for monitor types. Request Parameters The parameters involved in executing this API request are: Field Description         apikey The key generated using the Generate API Key option in the ''Admin'' tab. resourceid/monitorname The resource ID of the monitor / monitorname. attributeid The attribute ID of the alarm attribute to be configured. thresholdid/thresholdname The ID or name of the threshold which will be assigned to attribute to configure alarm. criticalactionid/criticalactionname The ID or name of action to notify critical condition of the attribute . warningactionid/warningactionname The ID or name of action to notify warning condition of the attribute. clearactionid/clearactionname The ID or name of action to notify clear condition of the attribute. availabilityCriticalPollCount / The polls to retry count for critical/ clear status. availabilityClearPollCount  This attribute specifies if you wish to Save the Configuration, Save And Configure Another Alarm or Remove Configuration. Possible values are 1, 2 and 3 and they stand for: 1 - Save requesttype 2 - Save And Configure Another, 3 - Remove Configuration, 8 - Delete the template, disassociate the threshold and actions from monitors overrideConf Specify if you want to override existing Threshold Configuration. Possible values are:  true/false resourceType The monitor type to which the alarm template should be applied.   Note: To configure alarm for more than one attribute, specify attributes by comma separation. e.g: 402, 412, 413 Syntax http://[ APM Host]:[APM Port]/AppManager/xml/configurealarms?apikey=[ API Key ]&resourceid=[resourceid of monitor]&attributeid=[attribute IDs]&thresholdid=[Threshold ID]&criticalactionid=[Action ID]&warningactionid=[Action ID]&clearactionid=[Action ID]&requesttype=[1/2]&availabilityCriticalPollCount= [count]&availabilityClearPollCount=[count]http://[ APM Host]:[APM Port]/AppManager/xml/configurealarms?apikey=[ API Key ]&resourceType=[ Resource Type]&thresholdid=[Threshold ID]&attributeid=[attribute IDs]&requesttype=[1/2]&overrideConf= [true/false] Example http://localhost:9094/AppManager/xml/configurealarms? apikey=c2d21931768d803bf4f51aefc366dfaf&resourceid=10000111&thresholdid=3&attributeid=400,401,530 07&requesttype=1&criticalactionid=10000003&overrideConf=true&availabilityCriticalPollCount=4&availabili tyClearPollCount=7 http://localhost:9000/AppManager/xml/configurealarms? apikey=8563ac093c573d7096def3826c5bafd9&resourceType=PHP&thresholdid=3&attributeid=2304&reque sttype=1&overrideConf=false Credential Manager APIs Credential manager REST APIs allow admin users to add, update, delete and list credential by submitting the required parameters. Credential manager APIs are designed to support GET and POST requests: Add Credential Edit/Update Credential Delete Credential List Credentials Note: HTML encoding will be required for parameters with special characters (For example: display name or password). For example, if a password contains a special character like " # , & , % or + : # should be replaced with %23 & should be replaced with %26 % should be replaced with %25 + should be replaced with %2B while passing the password in the RESTAPI. For More information about HTML Encoding, refer the following document: http://www.w3schools.com/tags/ref_urlencode.asp When using the Credential Manager APIs, for operations like add, edit, delete credentials, it is recommended that the POST method be used. Add Credential Manager This API allows an admin user to add business hours in Applications Manager. The common parameters involved in executing this API request are: Field Description credentialName Enter a unique Credential Name type You must specify a credential type. It should be exact same as given in syntax for each type. credentialDescr Credential Description credentialID A unique identifier set by Applications Manager for a credential.   Field Description Servers Telnet Required parameters: type username promptpassword Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Telnet&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDEN NAME]&username=[USERNAME]&prompt=$&password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=05b4a12a5fc0747cfaa897850ae9a778&type=Telnet&credentialDescr=Test&credentialName=Telnet&username=test&prompt=$&password=test Required parameters: type snmpCommunityString timeout SNMP v1/v2 Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SNMP v1v2&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CR NAME]&snmpCommunityString=[COMMUNITY STRING]&timeout=[MINUTES] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=SNMP v1v2&credentialDescr=Test&credentialNa SNMPv2&snmpCommunityString=public&timeout=5 Required parameters: type snmpAuthProtocol snmpContextName snmpPrivPassword snmpAuthPassword snmpSecurityLevel SNMP v3 timeout snmpUserName Syntax: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=SNMP v3&snmpAuthProtocol=[MD5 or SHA]&c [CREDENTIAL NAME]&snmpContextName=[CONTEXT NAME]&snmpPrivPassword=[PRIVATE PASSWORD]&snmpSecurityLevel=[NOAUTHNOPRIV or AUTHNO AUTHPRIV]&snmpAuthPassword=[AUTHENTICATION PASSWORD]&timeout=[MINUTES]&snmpUserName=[USERNAME] Sample Request: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&snmpAuthProtocol=MD5&credentialName=snmp-v3 1&snmpContextName=cusu4NfK6N0s6b&snmpPrivPassword=&snmpSecurityLevel=NOAUTHNOPRIV&snmpAuthPassword=&type=SNMP v3&timeout=5&snm Required parameters: type username passphrase description prompt SSH password sshPKAuth Syntax: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=SSH&credentialName=[CREDENTIAL NAME]&u [USERNAME]&passphrase=[PASS PHRASE]&description=[PRIVATE KEY]&prompt=[PROMPT]&password=[PASSWORD]&sshPKAuth=on Sample Request: https://prod-server:9090/AppManager/xml/credential/add?apikey=4dd329f4b42f64c29013c591138eac2a&credentialName=ssh- 1&username=guest&passphrase=&description=&prompt=$&type=SSH&password=guestWMI Required parameters: type username password Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=WMI&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENT NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=05b4a12a5fc0747cfaa897850ae9a778&type=WMI&credentialDescr=Test&credentialName=WMI&username=administrator&password=admin123 Application servers Required parameters: type Password JNDIPath UserName GlassFish Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=GlassFish&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CRE NAME]&UserName=[USERNAME]&Password=[PASSWORD]&JNDIPath=[PATH] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=05b4a12a5fc0747cfaa897850ae9a778&type=GlassFish&credentialDescr=Test&credentialName=Glassfish1&UserName=admin&Password=adminad Required parameters: type username password JBoss sslenabled Server Syntax: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=JBoss Server&credentialName=[CREDENTIAL N [USERNAME]&password=[PASSWORD]&sslenabled=on Sample Request: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&credentialName=jboss-2&username=admin&type=J Server&password=password123&sslenabled=on Required parameters: type username password Microsoft .NET Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Microsoft .NET&credentialName=[CREDENTIANL NAME]&username=[USERNAME [PASSWORD]&credentialDescr=[CREDENTIAL DESCRIPTION] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Microsoft .NET&credentialName=.Net1&username=administrator&password=password123&credentialDescr=This is .net credential. VMware Required parameters: vFabric tc Server typePassword JNDIPath UserName Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=VMware vFabric tc Server&credentialDescr=[CREDENTIAL DESCRIPTION]&crede [CREDENTIANL NAME]&Password=[PASSWORD]&JNDIPath=[JNDI PATH]&UserName=[USERNAME] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=VMware vFabric tc Server&credentialName=vFabric1&Password=springsource&JNDIPath=/jmxrmi&UserName=admin Required parameters: type username password version WebLogic Server Syntax http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=WebLogic Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialNam NAME]&username=[USERNAME]&password=[PASSWORD]&version=[WLS_6_1 or WLS_7_0 or WLS_8_1 or WLS_9_0 or WLS_10_0]   Sample Request http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=WebLogic Server&credentialName=Weblogic6.1&username=weblogic&password=weblogic&version=WLS_6_1 Required parameters: type soapport username authEnabled password sslenabled WebSphere Server version Syntax: https://prod-server:9090/AppManager/xml/credential?apikey=[APIKEY]&type=WebSphere Server&soapport=[SOAP PORT]&credentialName=[CREDENTIAL [USERNAME]&authEnabled=on&password=[PASSWORD]&version=[5 or 6 or 7 or 8]&sslenabled=on   Sample Request: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=WebSphere Server&soapport=8880&credentialName=websphere7.x&username=wasadmin&authEnabled=on&password=admin&version=8&sslenabled=on Apache Required parameters: Server type username authEnabled password sslenabled Syntax: https://prod-server:9090/AppManager/xml/credential?apikey=[APIKEY]&type=Apache Server&credentialName=[CREDENTIAL NAME]&username= [USERNAME]&authEnabled=on&password=[PASSWORD]&sslenabled=on Sample Request: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=Apache Server&credentialName=Apache-1&username=test&authEnabled=on&password=test&sslenabled=on Required parameters: type username password sslenabled version Tomcat tomcatmanagerurl Server Syntax: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&tomcatmanagerurl=[TOMCAT MANAGER URL]&cred [CREDENTIAL NAME]&username=[USERNAME]&type=Tomcat Server&password=e6Lg48eOS0331s&sslenabled=on&version=[3 or 4 or 5 or 6 or 7] Sample Request: https://prod-server:9090/AppManager/xml/credential? apikey=4dd329f4b42f64c29013c591138eac2a&tomcatmanagerurl=/manager&credentialName=Tomcat6&username=tomcat&type=Tomcat Server&password=tomcat&sslenabled=on&version=7 Java/Transactions Required parameters: type jndiurl authEnabled username Java password Runtime Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Java Runtime&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[ NAME]&jndiurl=[JNDIURL]&authEnabled=on&username=[USERNAME]&password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Java Runtime&credentialName=JavaRuntime1&jndiurl=/jmxrmi&authEnabled=on&username=admin&password=admin Services Required parameters: User Name Password FTP/SFTP Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=FTPMonitor&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CR NAME]&User%20Name=USERNAME&Password=[PASSWORD] Sample Request: http://operations-server9:9090/AppManager/xml/credential? apikey=6c04347e331a72f3a107356cab05805c&type=FTPMonitor&credentialDescr=FTPSample&credentialName=FTPCred&User%20Name=ftpuser&Passwo Database DB2 Required parameters: type username password instanceSyntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=DB2&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENT NAME]&username=[USERNAME]&password=[PASSWORD]&instance=[DB NAME] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=DB2&credentialName=DB2 server1&username=db2admin&password=db2admin&instance=SAMPLE Required parameters: type namedInstance username authType instance MS SQL password Syntax: https://prod-server:9090/AppManager/xml/credential?apikey=[APIKEY]=MS SQL&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&namedI [SQL or Windows]&instance=[INSTANCE]&password=[PASSWORD] Sample Request: https://prod-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=MS SQL&credentialName=SQL Server1&username=sa&namedInstance=on&authType=SQL&instance=instance&password=password123 Required parameters: type username password instance MySQL Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MySQL&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDE NAME]&username=[USERNAME]&password=[PASSWORD]&instance=[DB NAME] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=a864e174c664b8661e7d8c3a07692b0e&type=MySQL&credentialName=MySQL4&username=root&password=root&instance=test Required parameters: type Password UserName Oracle Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Oracle&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDE NAME]&username=[USERNAME]&password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=a864e174c664b8661e7d8c3a07692b0e&type=Oracle&credentialName=Oracle11.0.4&username=system&password=password123 PostgreSQL Required parameters: type username password DBnameSyntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=PostgreSQL&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[C NAME]&UserName=[USERNAME]&Password=[PASSWORD]&DBname=[DB NAME] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=a864e174c664b8661e7d8c3a07692b0e&type=PostgreSQL&credentialName=PostgreSQL3&UserName=postgres&Password=postgres&DBname=po Required parameters: type username instance password Sybase Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Sybase&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDE NAME]&username=[USERNAME]&instance=[INSTANCE NAME]&password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Sybase&credentialName=Sybase server 4&username=sa&instance=test&password=test123 Required parameters: type authreq username password MongoDB Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MongoDB&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CRE NAME]&authreq=on&username=USERNAME&password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=a864e174c664b8661e7d8c3a07692b0e&credentialName=MongoDB7&authreq=on&type=MongoDB&username=root&password=root Required parameters: type username authreq password type=Cassandra Cassandra Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Cassandra&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CR NAME]&username=USERNAME&authreq=on&password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=a864e174c664b8661e7d8c3a07692b0e&type=Cassandra&credentialName=Cassandra1&username=cassandra&authreq=on&password=cassandra Middleware/Portal Microsoft Required parameters: MQ (MSMQ) type Password UserName Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Microsoft MQ (MSMQ)&credentialDescr=[CREDENTIAL DESCRIPTION]&credentiaNAME]&Password=d6pM4M2&UserName=USERNAME Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Microsoft MQ (MSMQ)&credentialName=MSMQ4&Password=Admin123&UserName=administrator Required parameters: type Password UserName MS Office SharePoint Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MS Office SharePoint&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentia [CREDENTIANL_NAME]&Password=[PASSWORD]&UserName=[USERNAME] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=MS Office SharePoint&credentialDescr=Test&cre Sharepoint3&Password=Password123&UserName=administrator Required parameters: type Password UserName RabbitMQ Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=RabbitMQ&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CR NAME]&Password=[PASSWORD]&UserName=[USERNAME] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=05b4a12a5fc0747cfaa897850ae9a778&type=RabbitMQ&credentialDescr=Test&credentialName=RabbitMQ5&Password=guest&UserName=guest End User Monitoring (EUM) Required parameters: UserName Password LDAP Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=LDAP Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[C NAME]&Username=[USERNAME]&Password=[PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=LDAP &credentialDescr=Ldapsample&credentialName=Ldap1&UserName=administrator&Password=admin Required parameters: SMTP UserName SMTP Password Mail Server Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Mail Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CR NAME]&SMTPUsername=[USERNAME]&SMTPPassword=[PASSWORD] http://prod-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=MailServer &credentialDescr=Mailserversample&credentialName=Mailserver11&SMTPUserName=administrator&SMTPPassword=admin   Virtualization VMware Required parameters:ESX/ESXi type username password Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=VMWare ESX/ESXi&credentialName=[CREDENTIAL NAME]&username=[USERNAM [PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=md73fu8rnduy3di3483sdkjk&type=VMWare ESX/ESXi&credentialName=VMWareCM&username=systemuname&password=password123 ERP Required parameters: type username password SAP Business One Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SAPBusinessOne&credentialName=[CREDENTIAL NAME]&username=[USERNAM [PASSWORD] Sample Request: http://prod-server:9090/AppManager/xml/credential? apikey=md73fu8rnduy3di3483sdkjk&type=SAPBusinessOne&credentialName=sapb1CM&username=adminuname&password=password123 Required parameters: type username password SAP Server Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=sap server&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&pas Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=md73fu8rnduy3di3483sdkjk&type=sap server&credentialName=sapserverCM&username=adminuname&password=password123 Required parameters: type username password SAP CCMS Syntax: http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SAP CCMS&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&pas Sample Request: http://prod-server:9090/AppManager/xml/credential?apikey=md73fu8rnduy3di3483sdkjk&type=SAP CCMS&credentialName=sapserverCM&username=adminuname&password=password123 Edit/Update Credential This API allows an admin user to edit the existing credential by providing the neccessary parameters. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/credential?apikey=[APIKEY]&credentialID= [CREDENTIAL_ID]&..For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/credential?apikey=[APIKEY]&credentialID= [CREDENTIAL_ID]&.. Example http://app-windows:59090/AppManager/xml/credential? apikey=05b4a12a5fc0747cfaa897850ae9a778&credentialID=10&password=newpassword Delete Credential We can delete a particular credential by giving its credential ID. The credential ID must be a whole number. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/credential?apikey=[APIKEY]&type= [TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/credential?apikey=[APIKEY]&type= [TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true Example http://app-windows:59090/AppManager/xml/credential? apikey=05b4a12a5fc0747cfaa897850ae9a778&credentialID=10&TO_DELETE=true List Credential Manager This API allows an admin user to list down the credentials in Applications Manager in both xml and json format. The type value could be "all" or a particular type. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/credential/list?apikey=[APIKEY]&type=[TYPE] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/credential/list?apikey=[APIKEY]&type=[TYPE] Example http://app-windows:59090/AppManager/xml/credential/list? apikey=05b4a12a5fc0747cfaa897850ae9a778&type=all Domain Configuration APIs These APIs allow an admin user to perform domain configuration in Applications Manager. APIs are designed to support GET or POST requests: Add Domain Configuration (POST Method) Update Domain configuration (POST Method) Delete Domain configuration (POST Method) List Domain configuration (GET Method) Request ParametersThe parameters involved in executing this API request are: Field Description domainname Name of the domain from which the users need to be imported. domaincontroller The hostname or the IP address of the DNS server for the domain. domainport The port of the DNS server. service OpenLDAP or Active Directory (AD) The permission level for a domain. The possible values are: 0 - Read Only - All users logged in through this domain will have read- permission only access. 1 - Full Control - Users logged in will behave according to their roles specified. Add Domain Configuration This API allows an admin user to add a new domain in Applications Manager. Syntax: For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain/create?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller]&domainport=[ Domain Port ]&service=[ Service ]&permission=[ Permission ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/domain/create?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller]&domainport=[ Domain Port ]&service=[ Service ]&permission=[ Permission ] Example: http://app-windows:59090/xml/AppManager/domain/create? apikey=16c220b3145cb34b1163cc81237e4fd0&domainname=csez.zohocorpin.com&domaincontroller=win 2k8master.csez.zohocorpin.com&domainport=389&service=AD&permission=1 Update Domain configuration This API allows an admin user to edit the existing Domain controller settings added in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain/update?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller]&domainport=[ Domain Port ]&service=[ Service ]&permission=[ Permission ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/domain/update?apikey=[ API Key ]&domainname=[ Domain Name ]&domaincontroller=[ Domain Controller ]&domainport=[ Domain Port ]&service=[ Service ]&permission=[ Permission ] Example: http://app-windows:59090/AppManager/xml/domain/update? apikey=16c220b3145cb34b1163cc81237e4fd0&domainname=csez.zohocorpin.com&domaincontroller=win2k8master.csez.zohocorpin.com&domainport=389&service=AD&permission=1 Delete Domain configuration This API allows an admin user to delete domain configurations in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain/delete?apikey=[ API Key ]&domainname=[ Domain Name ]&TO_DELETE=[ true/false ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/domain/delete?apikey=[ API Key ]&domainname=[ Domain Name ]&TO_DELETE=[ true/false ] Example: http://app-windows:59090/AppManager/xml/domain/delete? apikey=16c220b3145cb34b1163cc81237e4fd0&domainname=csez.zohocorpin.com&TO_DELETE=true List Domain configuration This API allows an admin user to list down the domains configured in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/domain/list?apikey=[ API Key ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/domain/list?apikey=[ API Key ] Example: http://app-windows:59090/AppManager/xml/domain/list?apikey=bfb8a60112560c40418e6f0bb37be874 Email Action Configuration APIs These APIs allow an admin user to configure e-mail to be sent to specified persons in the event of an alarm. Email Action Configuration APIs are designed to support GET and POST requests: Create Email Action (POST Method) Update Email Action (POST Method) Delete Email Action (POST Method) List Email Actions (GET Method) Request Parameters The parameters involved in executing this API request are: Field Description emailactionname Any display name for the action. If the display name of the email action contains a special character like # , & or + :# should be replaced with %23 & should be repalced with %26 + should be replaced with %2B while passing the emailactionname parameter in the RESTAPI. subject The subject of the e-mail. message The message of the e-mail. Possible Values are: businesstype 1 - Execute during business hour 0 - Execute outside business hour mailformat The format of the message: HTML, Plain Text or Both. smtpserver The Server IP or host name of the host in which the SMTP server runs. smtpport SMTP Port. 25 by default. businesshouraction True if a business hour needs to be associated to this action businessid Business ID Choose whether to append the alarm information generated by Applications appendmessage Manager to the Email. True or false toaddress The receiver''s address. fromaddress The sender''s address Create Email Action This API allows an admin user to create an email action in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/actions/emailaction?apikey=[ API Key ]&subject=[ Subject]&businesstype=[ Type]&mailformat=[ HTML/Plain Text/Both]&smtpserver=[ SMTP Server]&fromaddress=[ Sender address]&emailactionname=[ Name ]&businesshouraction=[ True/False ]&message=[ Message Text ]&businessid=[ Business ID]&toaddress=[ Receiver''s Address]&appendmessage= [ True/False ]&smtpport=[ Port ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/actions/emailaction?apikey=[ API Key ]&subject=[ Subject]&businesstype=[ Type]&mailformat=[ HTML/Plain Text/Both]&smtpserver=[ SMTP Server]&fromaddress=[ Sender address]&emailactionname=[ Name ]&businesshouraction=[ True/False ]&message=[ Message Text ]&businessid=[ Business ID]&toaddress=[ Receiver''s Address]&appendmessage= [ True/False ]&smtpport=[ Port ] Example http://app-windows:59090/AppManager/xml/actions/emailaction? apikey=09eebdd6893db4d20e16b84dff6664f1&subject=(Admin) Alarm from the Applications Manager&businesstype=1&mailformat=both&smtpserver=smtp&fromaddress=vijay@appmanager.com&em ailactionname=Applications manager&businesshouraction=true&message=This information has been generated by the Applications Manager&businessid=10000&toaddress=vijayakumar.mariappan@zohocorp.com&appendmessage=true&s mtpport=25 Update Email Action This API allows an admin user to edit any email action configured in Applications Manager.Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/actions/emailaction?apikey=[ API Key ]&subject=[ Subject]&businesstype=[ Business Type]&mailformat=[ HTML/Plain Text/Both]&smtpserver=[ SMTP Server]&fromaddress=[ Sender address]&businesshouraction=[ True/False ]&message=[ Message Text ]&emailactionid=[ ID ]&businessid= ID ]&toaddress=[ Receiver''s Address]&appendmessage=[ True/False ]&displayname=[ Display Name]&smtpport=[ Port ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/actions/emailaction?apikey=[ API Key ]&subject=[ Subject]&businesstype=[ Business Type]&mailformat=[ HTML/Plain Text/Both]&smtpserver=[ SMTP Server]&fromaddress=[ Sender address]&businesshouraction=[ True/False ]&message=[ Message Text ]&emailactionid=[ ID ]&businessid= ID ]&toaddress=[ Receiver''s Address]&appendmessage=[ True/False ]&displayname=[ Display Name]&smtpport=[ Port ] Example http://app-windows:59090/AppManager/xml/actions/emailaction? apikey=09eebdd6893db4d20e16b84dff6664f1&subject=(Admin) Alarm from the Applications Manager&businesstype=0&mailformat=html&smtpserver=smtp&fromaddress=vijay@appmanager.com&bu sinesshouraction=true&message=This information has been generated by the Applications Manager&emailactionid=10000&businessid=10000&toaddress=vijayakumar.mariappan@zohocorp.com& appendmessage=true&displayname=Applications manager&smtpport=25 Delete Email Action This API allows an admin user to delete an email action in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/actions/emailaction?apikey=[ API Key ]&emailactionid= [Business Id],&TO_DELETE=true For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/actions/emailaction?apikey=[ API Key ]&emailactionid= [Business Id],&TO_DELETE=true Example http://app-windows:59090/AppManager/xml/actions/emailaction? apikey=09eebdd6893db4d20e16b84dff6664f1&emailactionid=10000,&TO_DELETE=true List Email Actions This API allows an admin user to list down the email actions in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/actions/emailaction?apikey=[ API Key ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/actions/emailaction?apikey=[ API Key ]Example http://app-windows:59090/AppManager/xml/actions/emailaction? apikey=09eebdd6893db4d20e16b84dff6664f1 EventLog Configuration APIs These APIs allow an admin user to add, edit or delete EventLogs and to perfrom EventLog Configuration. EventLogs Add Edit Delete EventLog Configuration Add Edit Delete APIs for EventLogFile This API allows an admin user to add, edit or delete EventLogs in Applications Manager. The parameters involved in executing this API request are: Field Description logFileName LogFile property of the Events The Type of LogFile for Windows or WindowsAzure - EventLogs, AzureTraceLogs, category AzureDiagnosticLogs ruletype RULETYPE ID column from the AM_RULETYPE table for the logfile. Add Syntax XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&category= [ EventLogs Catagory ] JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&category= [ EventLogs Catagory ] Example http://app-windows:59090/AppManager/xml/logfile? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logFileName=adminlogfile&category=EventLogs Edit Syntax XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type] JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type ] Examplehttp://app-windows:59090/AppManager/xmlAppManager/xml/logfile? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logFileName=newadminname&ruletype=10000 Delete Syntax XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&ruletype=[ Type ]&TO_DELETE=[ TRUE ] JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&ruletype=[ Type ]&TO_DELETE=[ TRUE ] Example http://app-windows:59090/AppManager/xml/logfile? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&ruletype=10000&TO_DELETE=true APIs for EventLog Configuration This API allows an admin user to perform EventLog Configuration in Applications Manager. The parameters involved in executing this API request are: Field Description rulename Enter the Rule Name of your choice. eventid Enter the Event ID associated with the Event Log File source Source of the Event Log File category EventLogs category Values accepted are 0 - Event of Any Type eventtype 1 - Error 2 - Warning 3 - Information Respectively severity 1,4 for Critical and Warning respectively RULETYPE ID column from the AM_RULETYPE table for the logfile for Map to Application or ruletype Security events etc. status Status of the EventLog. Values accepted are 1 and 0 for Enable and Disable Respectively resourceids Resourceids of Windows monitors (Supports comma separated values). logCategoryName EventLogs category name for Windows ruleid Rule ID servertypes Supported Windows Monitor Server types haid Monitor Group id Option to set alarm severity to ''Critical'' or ''Warning'' based on a given time window. Values accepted are: TimeFrame 1 - used to mention current log rule is time frame based one. 24 - used to mention current log rule is 24 hours based one Syntax XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type ]&.. JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type ]&..Add Apply to All monitors: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&rulename=addedinrestapi&eventid=121&source=&category =&username=&eventtype=0&message=&severity=1&ruletype=1&status=1&resourceids=&logCategoryName= EventLogs&applyto=allmonitor&TimeFrame=1 Apply to Specific Monitor types: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logCategoryName=WindowsEventLogs&status=1&rulenam e=adminmontyperestapi&rulescope=1&haid=10045&severity=1&eventid=210&resourceids=&message=-1&a pplyto=monitortype&ruletype=1&username=-1&category=-1&source=-1&servertypes=Windows 2000&eventtype=0&displayname=addmontype&TimeFrame=1 Apply to selected monitors: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&rulename=admintestindi&eventid=121&alsource=&categor y=&username=&eventtype=0&message=&severity=1&ruletype=1&status=1&resourceids=10000097,1000010 0,20000076,20000065&logCategoryName=EventLogs&applyto=monitorlist&TimeFrame=1 Apply to monitors under a group: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&prerulestatus=&logCategoryName=WindowsEventLogs&st atus=1&rulename=adminhaid&rulescope=1&haid=10056&severity=1&eventid=210&message=-1&applyto=mo nitorgroup&ruletype=1&username=-1&category=-1&source=-1&servertypes=&savetype=new&eventtype=0&Ti meFrame=1 Edit Change Advanced Options: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logCategoryName=EventLogs&status=1&rulename=newna me&severity=1&eventid=121&resourceids=&message=testdesc1&applyto=monitorlist&category=testcatecat egory1&username=testuser1&ruletype=1&source=testsource1&ruleid=10003&eventtype=1&displayname=ne wname&TimeFrame=1 Change Event Type: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&eventtype=3&ruleid=10004&TimeFrame=1 Change Severity: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&severity=4&ruleid=10004&TimeFrame=1 Change Applyto Option: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&severity=4&ruleid=10004&applyto=monitorlist&resourcei ds=10000094&TimeFrame=1 http://app-windows:59090/AppManager/xml/logrulet? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&severity=4&ruleid=10005&applyto=monitorgroup&haid=1 0056&TimeFrame=1 Montype add/remove:http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&type=monitortype&action=add&servertypes=Windows 2012&ruleid=10006&TimeFrame=1 http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&type=monitortype&action=remove&servertypes=Windows 2012&ruleid=10006&TimeFrame=1 To add/remove a monitor from a rule: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=add&resourceids=100001&ruleid=10007&type=mo nitorlist&TimeFrame=1 http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=remove&resourceids=10000097&ruleid=10007&ty pe=monitorlist&TimeFrame=1 Change Status: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=changestatus&ruleids=10000003,10000002&stat us=disable&TimeFrame=1 http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=changestatus&ruleids=10000003,10000002&stat us=enable&TimeFrame=1 Delete Delete Logrule: http://app-windows:59090/AppManager/xml/logrule? apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=changestatus&ruleids=10000003,10000002&stat us=disable Mail Server Configuration APIs Mail Server API allows the user to view mail server details and configure mail server parameters in Applications Manager. These APIs allow an admin user to configure the mail server to send e-mail to specified persons in the event of an alarm. This API is designed to support GET and POST requests. GET Request - To view/list mail server details. POST Request - To add or update mail server details. GET Request Whenever the request is sent by "GET" method, the data corresponding to the API will be listed. Sample Request http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey] POST Request When the request is sent by "POST" method, the corresponding data will be added/updated. Sample Request http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey] Request Parameters The parameters involved in the API request are described below: For Primary Server:Field Description Is Mandatory primaryProtocol Should be SMTP or EWS Yes primaryAuthType Should be Basic or OAuth Yes The Server IP or host name of the host in which the Mandatory, if primaryProtocol is smtpServer SMTP server runs. SMTP Mandatory, if primaryProtocol is smtpPort The SMTP port number. SMTP smtpEmail The email address available in that Mail server. Yes smtpUserName User name for authentication - smtpPassword Password for authentication - Primary Tls Authentication. The value can be either prmTlsAuth - true or false. Primary SSL Authentication. The value can be either prmSslAuth - true or false. Mandatory, if primaryAuthType primaryOAuthProvider OAuth Provider ID for OAuth configuration. is OAuth Mandatory, if primaryProtocol is primaryURL Connection URL for EWS (Exchange server). EWS For Secondary Server: Field Description Is Mandatory secondaryProtocol Should be SMTP or EWS Yes secondaryAuthType Should be Basic or OAuth Yes The Server IP or host name of the host in which the Mandatory, if secSmtpServer SMTP server runs. secondaryProtocol is SMTP Mandatory, if secSmtpPort The SMTP port number. secondaryProtocol is SMTP secSmtpEmail The email address available in that Mail server. Yes secSmtpUserName Username for authentication. - secSmtpPassword Password for authentication. - Secondary Tls Authentication. The value can be secTlsAuth - either true or false. Secondary SSL Authentication. The value can be secSslAuth - either true or false. Mandatory, if primaryAuthType secondaryOAuthProvider OAuth Provider ID for OAuth configuration. is OAuth Mandatory, if primaryProtocol secondaryURL Connection URL for EWS (Exchange server). is EWS SMTP with Basic Authentication type in XML: http://[ APM Host ]:[ APM Port ]/AppManager/xml/MailServer?apikey=[ API Key ]&primaryProtocol=[ SMTP ]&primaryAuthType=[ Basic ]&smtpPort=[ Port ]&smtpUserName=[ Username]&smtpPassword=[ Password ]&smtpServer=[ Server Name ]&smtpEmail=[ Email Address ]&prmTlsAuth=[ true ]&prmSslAuth=[ True/False ]&fromAdminServer=[ True/False ]&secondaryProtocol=[ SMTP ]&secondaryAuthType=[ Basic ]&secSmtpPort=[ Secondary Port ]&secSmtpEmail=[ Email Address ]&secSmtpUserName=[ user Name ]&secSmtpServer=[ Secondary Server Name ]&secSmtpPassword=[ Password ]&secSslAuth=[ True/False ]&secTlsAuth=[ True/False ] EWS with OAuth Authentication type in XML: http://[ APM Host ]:[ APM Port ]/AppManager/xml/MailServer?apikey=[ API Key ]&primaryProtocol=[ EWS ]&primaryAuthType=[ OAuth ]&smtpEmail=[ Email Address ]&primaryOAuthProvider=[ OAuth Provider ID ]&primaryURL=[ Connection URL ]&fromAdminServer=[ True/False ]&secondaryProtocol=[ SMTP ]&secondaryAuthType=[ Basic ]&secSmtpPort=[ Secondary Port ]&secSmtpEmail=[ Email Address ]&secSmtpUserName=[ user Name ]&secSmtpPassword=[ Password ]&secSmtpServer=[ Secondary Server Name ]&secSslAuth=[ True/False ]&secTlsAuth=[ True/False ]SMTP with OAuth Authentication type in JSON: http://[ APM Host ]:[ APM Port ]/AppManager/json/MailServer?apikey=[ API Key ]&primaryProtocol=[ SMTP ]&primaryAuthType=[ OAuth ]&smtpPort=[ Port ]&primaryOAuthProvider=[ OAuth Provider ID ]&smtpServer=[ Server Name ]&prmTlsAuth=[ True ]&smtpEmail=[ Email Address ]&fromAdminServer=[ True/False ]&secondaryProtocol=[ SMTP ]secondaryAuthType=[ OAuth ]&secTlsAuth=[ True/False ]&secSmtpPort=[ Secondary Port ]&secSmtpEmail=[ Email Address ]&secSmtpServer=[ Secondary Server Name ]&secondaryOAuthProvider=[ OAuth Provider ID ] EWS with OAuth Authentication type in JSON: http://[ APM Host ]:[ APM Port ]/AppManager/json/MailServer?apikey=[ API Key ]&primaryProtocol=[ EWS ]&primaryAuthType=[ OAuth ]&primaryOAuthProvider=[ OAuth Provider ID ]&primaryURL=[ Connection URL ]&smtpEmail=[ Email Address ]&fromAdminServer=[ True/False ]&secondaryProtocol=[ EWS ]secondaryAuthType=[ OAuth ]&secSmtpEmail=[ Email Address ]&secondaryOAuthProvider=[ OAuth Provider ID ]&secondaryURL=[ Connection URL ] Example http://app-windows:59090/AppManager/xml/MailServer? apikey=09eebdd6893db4d20e16b84dff6664f1&primaryProtocol=SMTP&primaryAuthType=Basic&smtpPor t=25&smtpEmail=JohnDoe@appmanager.com&smtpServer=smtp&prmTlsAuth=true&prmSslAuth=true&&sm tpUserName=primary&smtpPassword=f6JO6WdbosecSslAuth=true&fromAdminServer=true&secTlsAuth=tru e&secondaryProtocol=smtp&secondaryOAuthProvider=Basic&secSmtpPort=25&secSmtpEmail=JohnDoe@y ahoo.com&secSmtpUserName=secondary&secSmtpServer=smtp&secSmtpPassword=f6JO5sMs6n7 Threshold Configuration APIs These APIs allow an admin user to configure thresholds in Applications Manager. Threshold Configuration APIs are designed to support GET and POST requests: Create Threshold (POST Method) Update Threshold (POST Method) Delete Threshold (POST Method) List Threshold (GET Method) Request Parameters The parameters involved in executing this API request are: Field Description The threshold display name. For display names that have special characters, replace ''#'' with %23, ''&'' with %26, ''+'' thresholdname with %2B while passing the threshold name in the RESTAPI. criticalcondition, warningcondition, clearcondition, Possible values for conditions are: secondarycriticalthresholdcondition, Numeric and Float Threshold conditions: secondarywarningthresholdcondition, secondaryinfothresholdcondition LT - Lesser than httpValue GT - Greater than httpValue EQ - Equal to httpValue NE - Not equal to httpValue LE - Lesser than or Equal to GE - Greater than or Equal to String Threshold Condition: CT - Contains DC - Does not contain QL - Equal toNQ - Not equal to SW - Starts with EW - Ends with The joiner condition with which the two threshold conditions are evaluated. Possible values are: criticalconditionjoiner, warningconditionjoiner, infoconditionjoiner OR - Logical "OR" condition AND - Logical "AND" condition criticalvalue, warningvalue, clearvalue, secondarycriticalthresholdvalue, Values for critical, warning or clear state. secondarywarningthresholdvalue, secondaryinfothresholdvalue Message to notify the user of a critical, warning or clear criticalmessage, warningmessage, clearmessage condition. Values denoting the maximum number of consecutive criticalpolls, warningpolls, clearpolls polls for critical, warning or clear severity. Values denoting the minimum number of consecutive min_criticalpolls, min_warningpolls, min_clearpolls polls for critical, warning or clear severity. The datatype of the threshold. Possible values are: 1 for Numeric Threshold type 4 for Float Threshold 3 for String Threshold The type of threshold to be configured. Possible values are: thresholdType 0 - Standard threshold 1 - Adaptive threshold The values of the upper threshold limit in percentage (%). Possible values are: adaptiveHigherPercentage 0 - Disable percentage checkbox 1 - Enable percentage checkbox The formula type based on which the adaptive threshold is set. Possible values are: adaptiveBaseformulaType 0 - Baseline 1 - Custom Expression The week based on which the baseline value is fixed in the adaptive threshold. Possible values are either "Previous adaptiveBaseWeek Week" or the desired week in the "week-month-year" format. Option to enable business hour for threshold. Possible businessHourAssociatedToThreshold value:  "enabled". The business hour type based on which the threshold should be applied. Possible values are: businessType 0 - Outside selected business hours 1 - During selected business hours Value denoting the Business Hour ID. The default value is selectedBusinessHourID ''0''. Create a Threshold The following API allows an admin user to create thresholds in Applications Manager. Syntax: For XML Response:http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=[ Threshold Type ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner=[ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner ]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=[ Threshold Type ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner=[ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner ]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ] Example http://app-windows:59090/AppManager/xml/threshold? apikey=09eebdd6893db4d20e16b84dff6664f1&type=1&thresholdname=Sample Threshold&thresholdType=0&criticalcondition=GT&criticalvalue=10&criticalconditionjoiner=AND&seconda rycriticalthresholdcondition=LT&secondarycriticalthresholdvalue=15&criticalmessage=criticalMessage&mi n_criticalpolls=2&criticalpolls=5&warningcondition=GT&warningvalue=5&warningconditionjoiner=AND&sec ondarywarningthresholdcondition=LT&secondarywarningthresholdvalue=10&warningmessage=warningMes sage&min_warningpolls=2&warningpolls=5&clearcondition=GT&clearvalue=0&infoconditionjoiner=AND&se condaryinfothresholdcondition=LT&secondaryinfothresholdvalue=5&clearmessage=clearMessage&min_cle arpolls=2&clearpolls=5&businessHourAssociatedToThreshold=enabled&businessType=1&selectedBusiness HourID=12345 Create an Adaptive Threshold The following API allows an admin user to create adaptive thresholds in Applications Manager Syntax: For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=1&adaptiveBaseformulaType=[ Adaptive Base Formula Type ]&adaptiveBaseWeek=[ Adaptive Base Week ]&adaptiveHigherPercentage=[ Adaptive Higher Percentage ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner= [ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=1&adaptiveBaseformulaType=[ Adaptive Base Formula Type ]&adaptiveBaseWeek=[ Adaptive Base Week ]&adaptiveHigherPercentage=[ Adaptive Higher Percentage ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner= [ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner ]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ] Example http://app-windows:59090/AppManager/xml/threshold? apikey=09eebdd6893db4d20e16b84dff6664f1&type=1&thresholdname=Sample Adaptive Threshold&thresholdType=1&adaptiveBaseformulaType=0&adaptiveBaseWeek=Previous Week&adaptiveHigherPercentage=1&criticalcondition=GT&criticalvalue=10&criticalconditionjoiner=AND&s econdarycriticalthresholdcondition=LT&secondarycriticalthresholdvalue=15&criticalmessage=criticalMessa ge&min_criticalpolls=2&criticalpolls=5&warningcondition=GT&warningvalue=5&warningconditionjoiner=AN D&secondarywarningthresholdcondition=LT&secondarywarningthresholdvalue=10&warningmessage=warni ngMessage&min_warningpolls=2&warningpolls=5&clearcondition=GT&clearvalue=0&infoconditionjoiner=A ND&secondaryinfothresholdcondition=LT&secondaryinfothresholdvalue=5&clearmessage=clearMessage& min_clearpolls=2&clearpolls=5 Update Threshold The following API allows an admin user to edit the thresholds added in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]&clearvalue=[ Clear Value ]&criticalpolls=[ Critical Polls ]&clearcondition=[ Clear Condition ]&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warnin gpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=[ Warning Polls ]&thresholdid=[ Threshold Id ] &warningvalue=[ Warning Value ]&criticalvalue=[ Critical Value ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]&clearvalue=[ Clear Value ]&criticalpolls=[ Critical Polls ]&clearcondition=[ Clear Condition ]&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warnin gpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=[ Warning Polls ]&thresholdid=[ Threshold Id ] &warningvalue=[ Warning Value ]&criticalvalue=[ Critical Value ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ] Example http://app-windows:59090/AppManager/xml/threshold? apikey=09eebdd6893db4d20e16b84dff6664f1&clearvalue=5&criticalpolls=0&clearcondition=GT&critical message=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warningpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=0&thresholdid=10001&warningvalue=5&criticalvalue=5&businessHourAssociatedToT hreshold=enabled&businessType=1&selectedBusinessHourID=12345 Delete Threshold The following API allows an admin user to delete thresholds in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]&thresholdid=[ Threshold Id=],&TO_DELETE=true For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]&thresholdid=[ Threshold Id=],&TO_DELETE=true Example http://app-windows:59090/AppManager/xml/threshold? apikey=09eebdd6893db4d20e16b84dff6664f1&thresholdid=10001,10003,10002,10000,&TO_DELETE=tru e List Thresholds The following API allows an admin user to list down the thresholds in Applications Manager. Syntax For XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ] For JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ] Example http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1 Sample Response: List and Map Dependencies The APIs - listDependencies and mapDependencies can be used to list, add and remove dependencies for Health and Availability attributes. Request Parameters The parameters involved in executing this API request are: Field Description resourceid The resource ID of the monitor to which dependencies should be mapped or removed. attributeid The attribute ID of the Health or Availability attribute of the particular monitor. The dependencies to be mapped or removed. Values should be given in the following dependentResources format: resourceid:attributeid The integer representing number of mapped dependencies on which the Health or dependenciesCount Availability attribute should depend. The boolean value which will decides the behaviour of the REST API i.e. if dependencies removeMapping  should be mapped or mapping removed (Optional parameter , default value : false). Sample API Requests mapDependencies http://localhost:9840/AppManager/xml/mapDependencies? apikey=91f1aa274abdeea8ef8e49a1e37ce1be&resourceid=10000110&attributeid=401&dependentResource s=10000110:53005,10000110:53006&dependenciesCount=3&removeMapping=true listDependencies http://localhost:9840/AppManager/xml/listDependencies? apikey=91f1aa274abdeea8ef8e49a1e37ce1be&resourceid=10000110&attributeid=400 Rest API for Generating Alarms The REST API and the parameter description for generating alarms is given below: Syntax http://localhost:14170/AppManager/xml/generateAlert?apikey=[apikey]&resourceid= [Resourceid]&attributeid=[attributeid]&severity=[severity as number]&alarmMessage=[Cause for the alert] Request Parameters The common parameters involved in the API request are described below: Field Description resourceid * Resource ID of monitor or MG to which alert should be generated attributeid * ID of the attribute to be affected entity Either above two values should be provided or entity should be provided in theformat resourceid_attributeid severity * Severity of the alert to be generated [ 1 - Critical , 4 - Warning and 5 - clear] Customized message (Cause for the alert) - Text CustomMessage. will be alarmMessage * appended in front of provided message in order to find difference between alert generated by poll and alert generated by this API If you don''t want your RCA Message to be appended with the text CustomMessage, you can use this parameter instead of alarmMessage actualAlarmMessage param. On providing both the params(alarmMessage and actualAlarmMessage), actualAlarmMessage will be given high priority. JSONObject - Params can be sent either as JSONObject or request params. (As of now SyncEventServlet is used for synching alerts and parameters are eventParams sent as JSONObject with the key eventParams. The same can be sent for this Rest API to sync alerts without any core change) Note: The parameters marked with an * are mandatory. Sample request http://localhost:14170/AppManager/xml/generateAlert? apikey=XXXXXXXXXXXXXXXXX&resourceid=10000140&attributeid=400&severity=1&alarmMessage=test message (or) http://localhost:2105/AppManager/xml/generateAlert?apikey=XXXXXXXXXXXXXXXXXXXX&eventParams= {entity:10000138_402,severity:5,alarmMessage:test_alert} Limitations Health of monitors and monitor groups cannot be changed directly. On generating alerts using trap attribute id, trap listener will not affect its configured monitors and monitor groups. SNMP Trap Listener APIs This API allows the user to create SNMP Trap Listener. Syntax SNMP v1 Trap: http://[HOST]:[PORT]/AppManager/xml/AddTrapListener?apikey=[API KEY]&trapName=[TRAP NAME]&trapStatus=[TRAP STATUS]&trapVersion=v1&trapType=[GENERIC TYPE]&specificType=[SPECIFIC TYPE]&enterpriseOID=[ENTERPRISE OID]&severity=[SEVERITY]&filterCondition=[FILTER VARBINDS]&trapCustomVarbinds=[CUSTOMIZE MESSAGE]&associateTrapSeverity=[ASSOCIATE TRAP SEVERITY]&trapHost=[RECEIVE TRAP]&monitorGroups=[MONITOR GROUPS] SNMP v2 Trap: http://[HOST]:[PORT]/AppManager/xml/AddTrapListener?apikey=[API KEY]&trapName=[TRAP NAME]&trapStatus=[TRAP STATUS]&trapVersion=v2&trapOID=[TRAP OID]&severity= [SEVERITY]&filterCondition=[FILTER VARBINDS]&trapCustomVarbinds=[CUSTOMIZE MESSAGE]&associateTrapSeverity=[ASSOCIATE TRAP SEVERITY]&trapHost=[RECEIVE TRAP]&monitorGroups=[MONITOR GROUPS] SNMP v3 Trap: http://[HOST]:[PORT]/AppManager/xml/AddTrapListener?apikey=[API KEY]&trapName=[TRAP NAME]&trapStatus=[TRAP STATUS]&trapVersion=v3&trapOID=[TRAP OID]&v3UserName=[V3 USERNAME]&severity=[SEVERITY]&filterCondition=[FILTER VARBINDS]&trapCustomVarbinds=[CUSTOMIZEMESSAGE]&associateTrapSeverity=[ASSOCIATE TRAP SEVERITY]&trapHost=[RECEIVE TRAP]&monitorGroups=[MONITOR GROUPS] Request Parameters The parameters involved in the API request are described below. Also, refer to the list of common request parameters. To know more about the HTTP error codes, refer here. Field Description Comments The key generated from "Generate API API Key   Key" option in the Admin tab. trapName Name of the SNMP trap listener.   trapStatus Status of the trap listener. (enable or disable)   trapVersion Version of the SNMP trap listener. (v1, v2, or v3)   The generic type of the trap. Possible values are: 0 - coldStart 1 - warmStart 2 - linkDown trapType Optional (Mandatory for version v1) 3 - linkUp 4 - authenticationFailure 5 - egpNeighbourLoss 6 - enterpriseSpecific Optional (Mandatory if The specific type of the trap (for trapType is 6) specificType enterpriseSpecific traps (i.e.) for trapType=6). ''*'' denotes match any specific type. enterpriseOID Enterprise Object ID (OID) of the v1 trap. Optional (Mandatory for version v1) Optional (Mandatory for versions v2 trapOID Object ID (OID) of the v2/v3 trap. and v3) v3UserName The username of the v3 trap. Optional (Mandatory for version v3) The condition to filter traps based on variable filterCondition Optional bindings. (AND / OR) The variable binding condition to filter the traps. Condition should be specified in JSON array format as: {"varId":"[VAR ID]","varCondition":"[VAR CONDITION]","varValue":"[VAR VALUE]"} Parameter Description The variable binding index VAR ID number. If WHOLE condition is chosen, VAR ID should be 0. filterText The filter condition. Possible Optional values are: QL - Equals NQ - Not Equals VAR CONDITION CT - Contains DC - Not contains SW - Starts with EW - Ends with VAR VALUE The string value to be matched. trapCustomVarbinds Message to customise the trap message Optional (Varbinds). Possible values are:$* $1, $2, $3,...,$N Any user-defined message with selected variables. {eg. $4 configuration changed in $2. Changed By: $5 } Associates trap severity on server health. (true or associateTrapSeverity Optional false) By default, value is false. The host of the trap, if you want to receive traps trapHost Optional from only this host. The IDs of the monitor groups you want to map the monitorGroups Optional trap listener to. If the severity has to be configured The severity of the trap listener when the trap is based on variable bindings, then severity received. Possible values are either critical, provide "varbindbased" as the warning, clear, or varbindbased. value. Optional (''criticalCondition'' field is mandatory if severity is criticalCondition, The condition by which the thresholds should be varbindbased) warningCondition, evaluated for Critical/Warning/Clear severity. Choose WHOLE if you want to clearCondition Possible values are either AND, OR, or WHOLE. match the threshold with whole trap message instead of individual varbind. The variable binding threshold conditions to determine Critical/Warning/Clear severity. Threshold condition should be specified in JSON array format as: {"varId":"[VAR ID]","varCondition":"[VAR CONDITION]","varValue":"[VAR VALUE]"} Parameter Description The variable binding index VAR ID number. If WHOLE condition is criticalThreshold, chosen, VAR ID should be 0. Optional (''criticalThreshold'' field is warningThreshold, mandatory if severity is The threshold condition. Possible clearThreshold varbindbased) values are: QL - Equals NQ - Not Equals VAR CONDITION CT - Contains DC - Not contains SW - Starts with EW - Ends with VAR VALUE The string value to be matched. criticalActions, The action ID(s) of the actions you want to warningActions, Optional configure if the severity is Critical/Warning/Clear. clearActions Note: Only upto 20 conditions are accepted. If the number of conditions are more than 20, it is treated as invalid. Sample Request SNMP v1 Trap: http://localhost:9091/AppManager/xml/AddTrapListener? apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v1&severity=critical&trapTy pe=6&specificType=2&enterpriseOID=.1.2.3.4&trapName=trap1OID&associateTrapSeverity=trueSNMP v2 Trap: http://localhost:9091/AppManager/xml/AddTrapListener? apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v2&severity=critical&trapOI D=.0.1.2.3.4&trapName=trap2 SNMP v3 Trap: http://localhost:9091/AppManager/xml/AddTrapListener? apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v3&severity=clear&trapOID =.0.1.2.3.4&trapName=trap3&v3UserName=mithun With varbind filters and varbind-based severity: http://localhost:9091/AppManager/xml/AddTrapListener? apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&filterCondition=OR&filterText= {"varId":"1","varCondition":"CT","varValue":"critical"}, {"varId":"3","varCondition":"SW","varValue":"hi"}&trapVersion=v1&severity=varbindbased&criticalCondition=A ND&criticalThreshold= {"varId":"1","varCondition":"CT","varValue":"critical"}&trapType=6&specificType=2&enterpriseOID=.1.2.3.4&tr apName=trap1OID&associateTrapSeverity=true With actions and monitor groups: http://localhost:9091/AppManager/xml/AddTrapListener? apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v1&severity=varbindbased& criticalCondition=AND&criticalThreshold= {"varId":"1","varCondition":"CT","varValue":"critical"}&warningCondition=AND&warningThreshold= {"varId":"1","varCondition":"CT","varValue":"critical"}&clearCondition=AND&clearThreshold= {"varId":"1","varCondition":"CT","varValue":"critical"}&trapType=6&specificType=2&enterpriseOID=.1.2.3.4&tr apName=trap1OID&associateTrapSeverity=true&warningActions=10000003,10000004,10000005&monit orGroups=10000013,100000134 Error Handling API execution could result in error conditions. In case of an error, the error information would be sent in the response body. The response body will have as the child node along with the appropriate error code. Error Codes The list of HTTP error codes are tabulated below: Code Description 4000 Operation Completed Successfully. 4000 Credential added successfully. 4000 Credential updated successfully. 4000 Credential deleted successfully. 4002 The specified resourceid in request URI should be an integer. 4003 The specified resourceid in request URI is wrong. The specified apikey [ "+apiKey+" ] in the request is invalid. Kindly log in to Applications Manager and 4004 check for the key in generate key in Admin tab. 4005 The specified type in request URI is wrong. 4006 The given ResoureID in the URL is wrong or repeated. 4007 The specified monitorname in request URI is wrong. 4008 The specified request URI is incorrect. 4016 The specified method in request URI is incorrect. 4024 The given taskid in the URL is wrong. 4025 The specified taskname in the URL is already exist or empty. 4032 The specified parameter in request URI is incorrect.4033 The taskName cannot be empty. 4034 The taskName already exists. 4035 The taskStatus should be either enable or disable. 4036 The taskType should be either group or monitor. 4037 Improper resourceid in the request. 4038 The startTime should be of the format (HH:MM). 4039 The endTime should be of the format (HH:MM). 4040 DestinationAddress DestinationPort GlobalTrap are mandatory for v1 trap 4041 The effectFrom should be of the format YYYY-MM-DD HH:MM . 4042 Task Method should be any one among Daily,Weekly or Once. 4043 The totalNumber should be between 1 to 7 only. 4044 The customTaskStartTime should be of the format (YYYY-MM-DD HH:MM). 4045 The customTaskEndTime should be a valid date format like (YYYY-MM-DD HH:MM). 4046 The startDay,startTime,endDay,endTime for weekly Maintenance are incorrect. 4048 The given taskid in the URL is not an integer. 4049 The monitor is under maintenance. Try pollnow after maintenance. 4050 The monitor cannot be polled when unmanaged. Mail server is not configured (This error occurs when the user tries to create an E-mail action using REST 4055 API without configuring mail server.). 4064 Kindly buy the License to avail the Applications Manager API''s. 4071 Smtp Server could not be connected. 4072 Proxy Server is not configured 4073 Proxy configuration failed 4074 Smtp Mail Server Connection Error 4075 Modem is not properly connected. 4076 Smtp host name/port should not be empty 4080 DestinationAddress DestinationPort GlobalTrap are mandatory for v2 trap 4105 Unknown Problem occured while calling a Rest API 4128 Server Error while processing the request. 4201 The pollInterval should be a valid whole number. 4202 The type should not be empty. 4203 The groupID should be a valid whole number. 4204 The WSDLUrl should not be empty. 4205 The field emailid should not be empty. 4206 The username and password mentioned in the request URL should not be empty. 4207 The popHost, smtpUserName and smtpPassword mentioned in the request URL should not be empty. 4208 The rbmagentID mentioned in the request URL should not be empty. 4209 The rbmagentID mentioned in the request URL is repeated or invalid. 4210 The scriptname mentioned in the request URL should not be empty. 4211 The displayname mentioned in the request URL should not be empty. 4212 Invalid OS type. 4213 The mode should be any one among SSH/TELNET/SNMP/WMI 4214 The snmptelnetport should be a valid one. 4215 The type mentioned in the request URL is not supported. 4216 The timeout should be a valid one. 4217 The host should not be empty. 4218 The port should be a valid one. 4219 The username mentioned in the request URL should not be empty.4220 The password mentioned in the request URL should not be empty. 4221 The authentication should SQL or Windows. 4222 The serverpath should not be empty. 4223 The jndiurl should not be empty. 4224 The instance should not be empty. 4225 The Transaction mentioned in the request URL should be yes or no. 4226 The LDAPServer should not be empty. 4227 The LDAPServerPort should not be empty. 4228 The MatchingAttribute should be anyone of cn, uid, sn, displayname, givenname, objectclass, dc, ou. 4229 The FilterCondition should be one of equals, contains or notequals. 4230 The IsSecured field should be either a yes or a no. 4231 The TargetAddress mentioned in the request URL should not be empty. 4232 The DownloadFile mentioned in the request URL should not be empty. 4233 The UploadFile should be either yes or no. 4234 The SearchField should not be empty. 4235 The TargetAddress should not be empty. 4236 The LookupAddress should not be empty. 4237 The RecordType should not be empty. 4238 The version of WEBLOGIC should be anyone of 6.1,7.0,8.1,9.x,10.x. 4238 The JNDIPath should not be empty. 4239 The version of JBoss server should be one of the following: 3.x, 4.x, 5.x, 6.x, 7.x and newer versions. 4240 The version of Tomcat Server should be anyone of 3,4,5,6. 4241 The version of Websphere Server should be anyone of 5.x,6.x,7.x 4242 The mode of Websphere Server should be BASE or ND. 4243 The soapport should be a valid whole number. 4244 The version of Oracle Application Server should be anyone of 10.1.2 or 10.1.3. 4245 The SSL of OracleEBS should be yes or no. 4246 The systemnumber of SAP Server should not be empty. 4247 The logonClient of SAP Server should not be empty. 4248 The language of SAP Server should not be empty. 4249 The specified taskMethod and taskid does not match. 4250 The starttime should less than endtime. 4251 Check for the date time configuration of weekly. 4252 The customTaskStartTime should be less than customTaskEndTime. 4253 The method for UrlMonitor should be post or get. The httpcondition for UrlMonitor should be as follows. LT for <, GT for >, EQ for =, NE for !=, LE <= and GE for 4254 >=. 4255 The url should not be empty. 4256 The version of Exchange Server should be any one of 2007, 2003, 2000, 5. 4257 The databasetype of QueryMonitor should be any one of MySQL, Oracle, DB2, MsSQL, Sybase, Postgres. 4258 The databasetypename of QueryMonitor should not be empty. 4259 The showqueryoutput of QueryMonitor should be any one of yes or no. 4260 The queries of QueryMonitor should not be empty. 4261 The name for adding Monitor Group already exists. 4262 The name should not be empty. 4263 The grouptype should be either monitorgroup or webappgroup. 4264 The userid in the request url is wrong or the values are repeated. 4265 The weblogic.jar is missing and is required for monitoring Weblogic server Version 6.4266 The weblogic.jar is missing and is required for monitoring Weblogic server Version 7. 4267 The weblogic.jar is missing and is required for monitoring Weblogic server Version 8. 4268 The weblogic.jar is missing and is required for monitoring Weblogic server Version 9. 4269 The weblogic.jar is missing and is required for monitoring Weblogic server Version 10. 4270 The accessKey should not be empty. 4271 The SecretAccessKey should not be empty. 4272 The apacheurl should not be empty. 4273 The serverstatusurl should be either true or false. 4274 The listenerport should not be empty. 4275 The serverconnectionchannel should not be empty. 4276 The jmxurl should not be empty. No EUM agent name configured. Please provide the EUM agent names(eumAgents) or the EUM agent 4300 ID(eumAgentsID) 4301 Some of the EUM agent names/IDs are invalid 4302 Error while fetching data for the EUM agent. Error - {0} 4303 The fetchType mentioned in the request URL should be either 1 or 2 - 1 for POP / 2 for IMAP. 4304 The fsTLSEnabled mentioned in the request URL should not be empty. 4305 The fsHost, fsUserName and fsPassword mentioned in the request URL should not be empty. 4306 The fsPort mentioned in the request URL should not be empty. The fetchType mentioned in the request URL should not be empty. Provide fetchType=1 for Pop Server and 4307 fetchType=2 for IMAP Server 4308 The tlsEnabled mentioned in the request URL should not be empty 4309 The fetchEnabled mentioned in the request URL should not be empty 4310 The url should not be empty 4310 When adding a URL monitor via Rest API, the URL field should not be empty. 4311 The urlMethod should be P or G. 4311 When adding a URL monitor via Rest API, the urlMethod field should not be empty. 4312 The httpValue should be a valid Integer. 4313 The httpCondition should be LT or GT or EQ or NE or LE or GE. Some parameter missing for edit URL.For editing URL monitor either one of the following ''type with 4314 resourceid'' or ''type with url'' or ''type with displayname'' is needed. 4315 The verifyError should be true or false. 4316 The url is not created before. 4320 Error occurred while editing the monitor. Parameter for Edit Monitor is missing. For editing monitor either the monitor resourceid or displayname is 4321 required. 4322 Unable to find Monitor with the given resourceid or display name. Verify the details provided. 4323 The Record Type mentioned for DNS Monitor is invalid. 4324 The Search Field mentioned for DNS Monitor is invalid. 4325 The domain name should not be empty. 4326 The given EUM monitor details is not for parent monitor. Try to edit again using the parent monitor details. 4340 The fsSSLEnabled mentioned in the request URL should not be empty. 4341 The sslEnabled mentioned in the request URL should not be empty Agent -{0} mentioned in the URL request not supported for RBM Monitor. RBM monitors support only 4342 agents running in Windows 4444 Error 4445 The Managed Server is Down. 4446 The value of datafrequency not equal to 1 or 2 in showpolleddata API. 4447 The GetQueryOutput Rest Api Returns an Empty Row Values.4500 The monitor group is not Associated to the Delegated Admin of this API key. 4509 Monitor already present in the DB. 4512 The specified time in request URI is incorrect. Either it is more than the current time or not a proper time 4522 Monitor group name already available. 4523 Monitor group name should not be empty. 4524 Owner name(s) [own] in the URL is wrong. 4525 Given location in the URL is wrong. 4526 Problem in editing monitor group. 4540 This API is not available for Admin Server. 4550 The username and password mentioned in the request URL should not be empty when nginxauth is true. The HostController/ServerName should not be empty if LaunchType of JBoss server is ''DOMAIN''. 4551 Applicable for version 7.x and above. 4553 File/Directory Name should be specified with Absolute Path 4554 The content field cannot be empty. 4555 The Hostname field cannot be empty. 4556 The Username field cannot be empty. 4557 Private Key cannot be empty if Key Based Authentication is chosen 4558 Script to be Monitored should not be empty 4559 Working directory(directory from which the script is executed) should not be empty 4560 The value for the parameter table_row (Number of tables) is invalid. 4561 The Tablename field cannot be empty. 4562 Either String attributes or Numeric Attributes that are present in that table should be given for monitoring 4563 Unique column for the table should not be empty. 4564 Prompt cannot be empty if the new host is selected VMware Horizon View Connection Broker is supported only when the product is running on a Windows 4574 Server 5001 The credential name should not be empty. 5002 The type should not be empty. 5003 The Credential Name already exists. Choose another name. 5004 The given Credential ID is not exist. 5005 Credential ID should not be empty. 5006 Credential ID should be a valid whole number. 5007 am.webclient.credentialManager.adminRestriction 5008 The type is null or empty. 5009 Something went wrong. 5010 Access is denied to perform this operation in Managed Server as SSO is enabled. 5011 The trapName should not be empty. 5012 The trapStatus is either empty or invalid. 5013 The trapVersion is either empty or invalid. 5014 The severity is either empty or invalid. 5015 The enterpriseOID is either empty or invalid. 5016 The trapType is either empty or invalid. 5017 The specificType should not be empty. 5018 The specificType is either empty or invalid. 5019 The trapOID is either empty or invalid. 5020 The v3UserName is either empty or invalid. 5021 The trapHost is invalid. 5022 The associateTrapSeverity is invalid.5023 The filterCondition is invalid. 5024 The filterText cannot be empty if the filterCondition is present. 5025 The filterText is invalid. 5026 The filterCondition cannot be empty if the filterText is present. 5027 The criticalCondition and the criticalThreshold should not be empty if the severity is varbindbased. 5028 The criticalCondition is invalid. 5029 The criticalThreshold cannot be empty if the criticalCondition is present. 5030 The criticalThreshold is invalid. 5031 The criticalThreshold should not have multiple values if the criticalCondition is WHOLE. 5032 The criticalCondition cannot be empty if the criticalThreshold is present. 5033 The warningCondition is invalid. 5034 The warningThreshold cannot be empty if the warningCondition is present. 5035 The warningThreshold is invalid. 5036 The warningThreshold should not have multiple values if the warningCondition is WHOLE. 5037 The warningCondition cannot be empty if the warningThreshold is present. 5038 The clearCondition is invalid. 5039 The clearThreshold cannot be empty if the clearCondition is present. 5040 The clearThreshold is invalid. 5041 The clearThreshold should not have multiple values if the clearCondition is WHOLE. 5042 The clearCondition cannot be empty if the clearThreshold is present. 5043 The clearCondition and the clearThreshold should not be empty. 5044 The warningCondition and the warningThreshold should not be empty. 5045 The criticalActions is not required since critical severity is not configured. 5046 The warningActions is not required since warning severity is not configured. 5047 The clearActions is not required since clear severity is not configured. 5048 The action IDs are either invalid or does not exist. 5049 The monitor group IDs are either invalid or does not exist. 5050 The given trap listener name already exists. Proxy error. This error code is returned when Applications Manager is not able to establish a connection 5301 with the host. 5302 The JConnect mentioned in the request URL should be yes or no. 5303 discoverPDB parameter should be given as yes or no. 5304 Socket Read Timeout / Query Execution Timeout value is invalid. 6000 Field is mandatory and cannot be empty. 6001 Page Load Timeout should be an integer between 1 and 30. 6002 Value for the field should be an integer. 6003 Wait after load should be an integer between 1 and 10. 6004 Value for the field should be true or false. 6005 Polling Interval should be greater than 30. 6006 Value for discoverOption should be one of the three: [0, 1, 2]. Processes and Services This section explains how to use REST APIs to perform various operations with ''Processes'' and ''Services''. Processes Add process Delete process Edit processServices Add service Processes Add Process http://[Host]:[Port]/AppManager/xml/process/add?apikey=[API_Key]&resourceid= [Server_ResourceID]&name=[Process_Name]&command=[Commands_Encoded_As_HTML] Delete Process  http://[Host]:[Port]/AppManager/xml/process/delete?apikey=[APIKey]&monitorid=[resid]&processid= [Processid] Edit Process  http://[Host]:[Port]/AppManager/xml/process/edit?apikey=[APIKey]&type=0&processid= [Processid]&name=[pname]&command=[command]&matchcriteria=[matchcriteria] Services Add Service  http://[Host]:[Port]/AppManager/xml/service/add?apikey=[API_Key]&resourceid= [Server_ResourceID]&name=[Service_Name]&displayname=[Service_Display_Name] End User Monitoring (EUM) Overview End User Experience monitoring provides the ability to monitor the health and performance of services from multiple locations outside your corporate firewall. End user experience monitoring tools like Applications Manager''s End User monitoring (EUM) provides greater visibility into the user experience and behaviors of these services and helps in detecting potential performance problems before end users are affected. It also enables you to take steps to improve the user experience of business-critical services. End user monitoring can be enabled by installing agents in client locations and configuring your monitors to make use of these agents for monitoring. The monitors currently supported by the EUM agent include Ping, Telnet, DNS, Mail Server, LDAP server and Real Browser Monitor (RBM). In this help document, you will learn how to perform end user experience monitoring with the help of Applications Manager''s End user application monitor. Browse through the following topics to understand End User monitoring (EUM) better: How does End User Monitoring work? Installing EUM agent EUM Dashboard How does End User Monitoring (EUM) work? End user monitoring enables IT operations to ensure that the real end users of an application or service are experiencing good performance. Since the EUM agents take care of collecting and reporting data, the IT administrator is able to accurately keep track of the performance of services without needing to take any additional steps.To configure EUM monitors, you have to download EUM agents, install them in your branch offices or customer locations, and install Applications Manager server in your head office. Once these agents are enabled, they will collect data about the service performance from these locations and pass it on to the central Applications Manager server. This data will then be processed by Applications Manager and used for measuring the end user experience. The EUM agents can be installed in multiple branch offices in different cities or in the systems of your end users. All you need is a secure https connection between the agent and the Applications Manager server. The EUM agent pings the Applications Manager server at specific time intervals and gathers information such as the service configuration details. The service will then be executed from the remote location and the results passed on to the central Applications Manager server. Based on the metrics received from the agent, the Applications Manager server measures the performance of these services and generates performance charts. Some of the performance metrics displayed in the monitor details page include response time from different locations, outage report based on locations, etc. Based on the information shown in the EUM monitor, the IT team can determine how the service is performing from different locations. If there is a performance issue in a particular agent, Applications Manager''s End user application monitor can help them troubleshoot, initiate root cause analysis, isolate the real performance issue and resolve them before end users are affected. Installing and Uninstalling EUM Agent System Requirements Installing EUM Agent Windows Linux Uninstalling EUM Agent Windows Linux End User Monitoring Agent Settings Server Settings Proxy Settings WebDriver SettingsLimitations System Requirements EUM Agents for RBM monitors have to be installed on a dedicated Windows / Mac machine - 8 GB RAM, 40 GB HD. However, Applications Manager can be installed on Windows or Linux. This works with the Professional Edition and Enterprise Edition (with Managed Server). Installing EUM Agent To start end user monitoring from multiple locations, you have to install the EUM agents in the respective locations. The agents can be installed in both Windows and Linux systems. Please note that the EUM agents will work only if the central Applications Manager server is running. Note: Edge-based EUM Agents can be installed only on Windows Server with Microsoft Edge (versions 17 & above) Support. Windows Follow the steps given below to install the EUM agent in Windows systems. Download the EUM Agent (.exe) file for Windows. Execute the downloaded file. The installshield wizard will open up. Click Next to continue. Read the license agreement and click the Yes button. Specify the details of your Applications Manager installation such as host, port, and EUM API Key (which is available under Admin → REST API → End User Monitoring). Click Next to proceed. Provide the location where the EUM agent should be installed in your machine. Click Browse to provide a different location of installation. Click Next. Specify the name of the folder to be placed in Program Folder. The default is ManageEngine End User Monitoring Agent. Click Next. If you want to install EUM as a service, select the ''Install End User Monitoring Agent as Service'' option and click Next. Please note that you need to have administrative privileges to install the EUM agent as a service. Note: Edge-based EUM Agents must be installed in non-service mode. The current settings will be displayed in the next screen. If you need to make any changes, click Back, or else click Next to continue with the installation. Once you click Next, the setup will start copying the jar files necessary for the EUM agent. You have an option to fill up a registration form for technical support. In the final step of the installation wizard, there are options available to View the Readme file and to Launch the End User Monitoring Agent Now. Select these options if required. Click Finish to complete the installation process. Linux Follow the steps given below to install the EUM agent in Linux systems. Download the EUM Agent (.bin) file for Linux. Execute the downloaded file. The Installation Wizard is displayed. Click Next to continue. Read the license agreement and click the Yes button. Provide the location where the EUM agent should be installed in your machine. Click Next. Current Settings will be displayed in the next screen. If you need to make changes, click Back, else click Next to continue the installation. Click Finish to complete the installation process. You have an option to fill up a registration form for Technical support. Finally, select if you want to view the ReadMe file or click Finish to launch the EUM agent immediately. Note: You can also install the EUM agent via command line. Just type in the following command in the command prompt: ./EUM_Agent.bin -console Execution of this command will take you through the installation process. Real Browser Monitor (RBM) via Firefox and Chrome browsers are supported in Linux.   Limitations: We recommend that you do not have more than one installation of the EUM agent in a machine as this causes malfunctioning in agent data collection in certain cases.Users need Administrative privileges to install the agent in both the Windows and Linux OS. Maximum allowed EUM Agents per Applications Manager instance is 20. Uninstalling EUM Agent In Windows: If the EUM agent is running, you should stop the agent before uninstalling it. You can stop the agent using any of these options: Use the Start menu->All Programs->ManageEngine EndUser Monitoring Agent->Stop Server option. From the command prompt, execute the StopServer.bat file present under the folder. Use the Start menu->All Programs->ManageEngine EndUser Monitoring Agent->Uninstall option. The installshield wizard will be displayed. Follow the instructions shown on screen to uninstall the agent. Remove the agent completely using the Control Panel->Add/Remove Programs option. In Linux: From the command line, go to the directory and execute the below commands: sh StopServer.sh sh StopServer.sh -force Exit out of the command prompt and close all the files and folders opened in the directory. Execute the command ./uninstaller.bin from the directory and follow the process. If there is no GUI or if you are uninstalling from a remote server, execute the command ./uninstaller.bin -console from the directory and follow the process. End User Monitoring Agent Settings When you start the End User Monitoring agent, the EUM web client will be automatically launched. The web client can be accessed at the URL http://localhost:9999 where localhost is the host system where the EUM agent is installed and 9999 is the port number where the EUM agent is running. Upon accessing the EUM agent, you will be prompted with the EUM login page. Login using EUM API Key, which is available under Admin → REST API → End User Monitoring. To learn how to change Applications Manager hostname, port number and other proxy settings, refer here. Note: To configure EUM agent settings for versions 17.0 & below, refer here. After successful login, you will be redirected to the Agent Settings page. Here you can modify the necessary EUM agent settings by clicking the Edit button and updating the settings. These changes will take effect only when you restart the agent. Server Settings Proxy Settings WebDriver Settings Server Settings The Server settings specified here are used to establish a successful connection with the Applications Manager instance: Server Host: Hostname of your Applications Manager instance. Server SSL Port: Provide SSL port of your Applications Manager instance. The port configurations can be viewed in AMServer.Properties file located under \conf\ directory. EUM API Key: API key for user authentication, which is available under Admin → REST API → End User Monitoring. Polling Interval: Polling Interval in minutes. Note: You have to restart the EUM agent for the any changes in Server settings to take effect.Proxy Settings The Proxy settings specified here are used to establish a successful connection with the Applications Manager instance: Auto-detect proxy settings for this network - EUM Agent automatically detects the proxy settings to be used. No proxy - EUM Agent connects without a proxy. Use system proxy settings – EUM Agent uses the proxy settings defined in your system settings. Automatic proxy configuration URL – EUM agent uses the proxy settings defined in the PAC file. Manual proxy configuration: Proxy Host & Proxy Port: Enter the value of the proxy host & port on which the proxy connection will run. Username & Password: Enter the username & password for authorization. No Proxy: Give the domain names for which the manual proxy configurations should not be applied. The following rules are applicable: Use semicolons(;) to separate entries The host may be any of the following types: A complete host name (e.g. www.test.com) A domain name. Domain names must begin with a dot (e.g. ".test.com") An IP-address (e.g. "12.34.56.78") An IP-subnet, specified as an IP-address and a netmask separated by a "/" (e.g. "12.34.56.78/255.255.255.192"). A 0 bit in the netmask means that bit won''t be used in the comparison (i.e. the addresses are AND''ed with the netmask before comparison). Note: You have to restart the EUM agent for the any changes in Proxy settings to take effect. If you have chosen any one of the following options: No proxy, Use system proxy settings OR Automatic proxy configuration URL, the EUM agent will automatically detect proxy settings to be used when connecting to Applications Manager. WebDriver Settings WebDriver specified here will be used to perform playback during each data collection. Microsoft Edge WebDriver Path: Complete filepath of the Microsoft Edge WebDriver installed on the server where this End User Monitoring Agent is installed. If the WebDriver is installed under C:\Windows\SysWOW64\ then the provide the path as C:\Windows\SysWOW64\MicrosoftWebDriver.exe Click here to find the steps to install WebDriver for Microsoft Edge (versions 17 & above). Google Chrome WebDriver Path: Complete file path of the Google Chrome WebDriver installed on the server where this End User Monitoring Agent is installed. Sample driver path: For Windows : C:\Windows\chromedriver.exe For Linux : /home/test/chromedriver Click here to find the steps to install WebDriver for Google Chrome (versions 65 & above). Note: Playback using Microsoft Edge WebDriver is supported only in the End User Monitoring Agent installed on Windows Server with Microsoft Edge (versions 17 & above) Support. Playback using Google Chrome WebDriver is supported only in the End User Monitoring Agent installed on Server with Google Chrome (versions 65 & above) support. EUM Dashboard The performance metrics of all the end user monitoring (EUM) monitors configured in Applications Manager will be displayed in the End User Monitoring Overview dashboard under the User Experience tab. This dashboard provides you an overview of the performance of your monitors tracked using EUM agents along with their health status from different locations. The metrics shown include the total number of EUM monitors and their current status (Clear, Critical or Warning), the category to which the monitor belongs to, and their health status from the locations configured.A green dot indicates health status is ‘clear’ from that specific location, a red dot indicates ‘critical’ status while an orange dot indicates ''warning'' health status. Click the dot icon to drill down into the monitor performance from that specific location. Click the reports icon in the EUM dashboard to view the ''At a Glance'' report for the monitor. The ''At a Glance'' report includes charts for availability, response time and outage report of the monitor from different locations. You can also view performance details based on the monitor type. For example, to view information about DNS monitors, click the DNS Monitor icon. EUM Agent Details Click the ''Locations'' link present in the right top corner of the ''End User Monitoring Overview'' dashboard to view details about the EUM agents being used to collect performance data. This screen shows the following agent configuration details: Parameter Description Name The name of the EUM agent IP Address The IP address of the EUM agent Port The port at which the agent is running Status Current status of the agent (whether the agent is up or down) The time interval in which the EUM agent contacts the Applications Manager Poll Interval server Browsers supported for RBM Displays the list of browsers that are supported for RBM Playback. Playback Agent Version The version of the EUM agent currently in use The time at which agent collected information from the Applications Last Updated at Manager server APM Insight - An Overview APM Insight (previously J2EE Transaction Monitoring) gives you visibility into the way your applications behave for your end users. You get comprehensive end-to-end transaction awareness across your entire infrastructure, enabling you to isolate performance issues and resolve them quickly without degrading the performance of your applications. Drill-down to the root cause of problems quickly and perform first-level troubleshooting. With so many different metrics being produced by the wide range of business applications, how can one normalize performance and assemble information into something meaningful to the end users? APM Insight offers visual representations of performance metrics of all components starting from URLs to SQL queries, Apdex scores to measure user satisfaction and transaction tracing. You can view the trace history of transactions to help identify and resolve performance degradation no matter where they originate. Further, to identify bottlenecks in performance, a trail of the Java method invocations can be viewed to identify the offending code. Browse through the following topics to understand the working of APM Insight: How Does APM Insight Work? APM Insight Agent for Java Ruby .NET Node.js PHP .NET Core APM Insight Configuration Options APM Insight Dashboard Web Transaction, Database Operations and Transaction Traces APDEX Score How does APM Insight work?APM Insight includes a remote monitoring agent to be deployed in your Application Server. This agent performs the tasks of data collection; acquisition and transmission. To configure APM Insight you must first download the APM Insight agent and deploy it in your application server. Once the agent is deployed, the agent residing in the Application Server uses byte code instrumentation to collect application performance metrics and sends it to the central Applications Manager server at fixed intervals. APM Insight gives you the following metrics for the applications that it is set to monitor: APDEX Scores Response Time Throughput Based on the metrics received from the agent, the APM Insight server measures the performance of the application and generates performance charts. This information is assembled and presented in detail in the APM Insight dashboard. How to install APM Insight? Download and install Configure agent When the Application Server starts up, APM Insight monitor will be added automatically in the Applications Manager. Agent auto-upgrade When the Agent Auto-upgrade feature is enabled, Applications Manager will automatically download the new agent zip/msi file for upgrade if a new agent version available. By default, auto-upgrade is disabled. You can enable auto-upgrade by clicking on the Customize Agent Configuration icon and checking the Agent Auto- upgrade checkbox. You can also enable auto-upgrade by setting the autoupgrade.enabled property in the apminsight.conf file to true. Note: For java agents, application restart is mandatory for the new agent to take effect. On the other hand, for .Net agents the update process can be scheduled by setting the "scheduledtime" property in apminsight.conf file. Manual Agent Upgrade By default, the auto-upgrade feature is disabled i.e the autoupgrade.enabled property in the apminsight.conf file is set to false. Here is how you can manually upgrade the agent: The following message will be displayed at the top of the APM Insight details page "The deployed agent version at this instance is (1.9/2.0), Update Now to the latest version (2.0/2.1)". On clicking the Update Now link, a confirmation dialog will appear to initiate agent update. For .Net agents the update process can be scheduled. In the pop-up Agent Update window, configure the schedule time for the update. IIS will be reset during that hour. Choose the Yes, continue button to start agent update. On doing so the alert message changes to "Agent update will happen shortly...". After few minutes, either on page refresh or on navigating to other tabs, the alert message will be modified. On successful download of the agent, the alert message changes to "Agent downloaded successfully. Please restart your application" for the Java Agent and or "Agent downloaded successfully. Update will happen at the scheduled hour" for the .Net Agent. If an error occurs during the agent update, then the message changes be "Problem encountered during agent update.View details". On clicking the View Details link, the error message will be displayed with options to retry or dismiss. Note: The Retry option will clear the upgrade status in the cache and immediately try to perform agent update, so message gets modified to "Agent update will happen shortly..." again. The Dismiss option will just clear the upgrade status in Cache and the message changes to "The deployed agent version at this instance is (1.9/2.0), Update Now to the latest version (2.0/2.1)".APM Insight - Java Application Performance Monitoring APM Insight Java agent relies on the agent-based byte-code instrumentation in Java for data acquisition and transmission. Requirements : Application Server(s) running on Java 1.6 & above Java Agent Setup Install APM Insight Java Agent Upgrade APM Insight Java Agent Uninstall APM Insight Java Agent Note: Do not install the APM Insight Agent along with other Application Performance Management (APM) tools. The APM Insight Agent installation may fail if there are other APM products installed in the same environment. Supported Frameworks Application Servers Supported Databases Supported JVM / JDK Supported Support for AWS Services Web Frameworks and other components Agent Configurations Java Agent Configuration Tracking Background Transaction Custom Instrumentation Custom Instrumentation Using Java Annotations Grouping Similar Transactions Context-based Monitoring Monitoring with Java Agent API Exclude transactions from monitoring Checksum Verification Agent Performance Report APM Insight Java Agent is optimized for minimal impact on the application. To understand about the resource utilization of Java Agent, refer here. Troubleshooting For troubleshooting tips, go to our Support Portal. Install APM Insight Java Agent In Applications Manager APM tab > Help Card > copy the License Key present there. Download the appropriate APM Insight Java Agent (apminsight-javaagent.zip) file. The zip file contains apminsight-javaagent.jar, apminsight-javaagent-api.jar and its conf files. This file should be copied to your Application Server. To configure Java agent using system properties, click here. Click on the links below to learn how to install the APM Insight Java Agent in different Application Servers: Install APM Insight Java Agent in Apache Tomcat 6.x & aboveInstall APM Insight Java Agent in AWS Elastic Beanstalk Install APM Insight Java Agent in Azure Web App Install APM Insight Java Agent in ColdFusion Install APM Insight Java Agent in Glassfish 3.x servers & above and clustered environments Install APM Insight Java Agent in IBM WebSphere 7.x servers & above Install APM Insight Java Agent in JBoss AS 4.2.x & above Install APM Insight Java Agent in JBoss EAP 6.2.x & above Install APM Insight Java Agent in Jira Server Install APM Insight Java Agent in JOnAS 4.x & above Install APM Insight Java Agent in Oracle Weblogic 10.3.x servers & above Install APM Insight Java Agent in Resin 3.1.x servers & above Install APM Insight Java Agent in SonarQube Install APM Insight Java Agent in Spring Boot Application Install APM Insight Java Agent in WildFly 8.x servers & above Install APM Insight Java Agent in Docker Install APM Insight Java Agent in other servers Note: For older versions of Java (v2.3 & below), data collection might not happen after upgrading Applications Manager to version 14440 & above. To enable, include the following keys in the apminsight.conf file after extracting the APM Insight Java agent zip (apminsight-javaagent.zip) file : license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT] Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=http://app-w8-test:9007 After including the above keys, save the file and restart the application. Troubleshooting: For troubleshooting tips, go to our Support Portal Install APM Insight Java Agent in Apache Tomcat 6.x & above Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a new directory to find agent jar and its configuration files Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:9007/ To learn more about the agent configurations, visit our Configuration Guide page. For Tomcat as non-service installation On Windows: Edit \bin\catalina.bat Add the following entry to the top and save the fileset JAVA_OPTS=%JAVA_OPTS% -javaagent: /apminsight-javaagent.jar On Linux: Edit /bin/catalina.sh Add the following entry to the top and save the file export JAVA_OPTS="$JAVA_OPTS -javaagent: /apminsight-javaagent.jar" For Tomcat as service installation Navigate to Configure Tomcat and to JAVA tab Add the below entry in Java Options box. -javaagent: /apminsight-javaagent.jar Note: Replace with the full directory path where the APM Insight Agent is installed. After adding the entry, click Apply and then OK.  Start the tomcat server  Install APM Insight Java Agent in AWS Elastic Beanstalk Create a new directory under /WEB-INF/lib, say appmanager. Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a appmanager directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:9090/ To learn more about the configurations, visit our Configuration Guide page. Repackage your application and deploy it on AWS Elastic Beanstalk. In AWS Console, go to Elastic Beanstalk and choose your application.Navigate to Configurations > Software Configuration > JVM command line options to add the java argument -javaagent: /WEB-INF/lib/apminsight-javaagent jar Note: Saving the JVM configuration changes will restart the application server automatically. Example: For installing agent in Tomcat container on linux, JVM argument would look like: -javaagent:/usr/home/tomcat/webapps/ROOT/WEB-INF/lib/appmanager/apminsight-javaagent.jar Install APM Insight Java Agent in Azure Web App Create a new directory under /WEB-INF/lib, say appmanager. Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a appmanager directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:9090/ To learn more about the configurations, visit our Configuration Guide page. Bundle your application and deploy it in Azure WebApp service. Add the below JVM argument in App Settings under Settings of your WebApp. Refer to screenshot. If using Tomcat server, please add Key "CATALINA_OPTS" and value as -javaagent:/usr/home/tomcat/webapps/ROOT/WEB-INF/lib/appmanager/apminsight-javaagent.jar If using Jetty server, please add Key "JAVA_OPTIONS" and value as -javaagent:D:/home/site/wwwroot/webapps/{APP_NAME}/WEB-INF/lib/appmanager/apminsight- javaagent.jar Restart your Webapp once for changes to take effect. Install APM Insight Java agent in ColdFusion Follow the below steps to install APM Insight Java agent in ColdFusion: Download the latest APM Insight Java agent (apminsight-javaagent.zip) file. Extract the zip file to a new directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include/modify the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ application.name=[APPLICATION NAME] where [LICENSE KEY] - License key obtained from Applications Manager under APM Insight tab. [HOST] - Host at which Applications Manager is running. [PORT] - Port number at which Applications Manager is running. [APPLICATION NAME] - Name of your application.Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://prod-test:9007/ application.name=ColdFusion_Server To learn more about the configurations, visit our Configuration Guide page. Go to the ColdFusion admin console. On the left menu, select SERVER SETTINGS → Java and JVM. In the textbox for JVM Arguments, add the following argument: -javaagent: /apminsight-javaagent.jar After specifying the above argument, save the configuration and restart the server. Install APM Insight Java Agent in Glassfish 3.x & above APM Insight Java Agent can be installed in Glassfish Server through Admin Console as follows: Example: -javaagent:D:/apminsight/apminsight-javaagent.jar Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here For standalone setup: Extract the zip file to a new directory outside the glassfish server directory Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example:license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:8443/ To learn more about the configurations, visit our Configuration Guide page. Open the administrative console of your glassfish server. Select Configurations and select the configuration used by the server Select JVM Settings > Add JVM Option, then add the following parameter -javaagent: /apminsight-javaagent.jar Click Save button and start the glassfish server For cluster setup: Extract the zip file to a new directory outside the glassfish server directory Copy the apminsight-javaagent.jar file from above directory to \glassfish\domains\ \lib\ext directory of the domain server Create a new directory named "apminsight" under \glassfish\nodes\ \ in instance server and copy only the agent conf files from directory created in step 1 to this directory. Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:8443/ To learn more about the configurations, visit our Configuration Guide page. Repeat the above two steps for every instance you like to add the java agent Open the administrative console of your glassfish server. Select Configurations and select the configuration used by the cluster. Select JVM Settings > Add JVM Option, then add the following parameters as such -javaagent:${com.sun.aas.instanceRoot}/lib/ext/apminsight-javaagent.jar -Dapminsight.home=${com.sun.aas.instanceRoot}/apminsight Click Save button and start the glassfish cluster.   Install APM Insight Java Agent in IBM Websphere 7.x servers & above Download the latest APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a new directory to find agent jar and its configuration files Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:8443/ To learn more about the configurations, visit our Configuration Guide page.Open administrative console of your IBM Websphere server, Select Servers > Server Types > WebSphere Application Servers Select > Java and Process Management > Process Definition Under Additional Properties, select Java Virutal Machine. Locate Generic JVM Arguments textbox and enter the following parameter -javaagent: /apminsight-javaagent.jarSave the settings and start the Websphere server. Install APM Insight Java Agent in JBoss AS 4.2.x & above Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a new directory to find agent jar and its configuration files Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:8443/ To learn more about the configurations, visit our Configuration Guide page. For JBoss AS 4.x, 5.x, 6.x servers: For Windows, open \bin\run.bat in any text editor and add the following entry at the top and save it. set JAVA_OPTS=-javaagent: /apminsight-javaagent.jar %JAVA_OPTS% For Linux, open /bin/run.sh in any text editor and add the following entry at the top and save it. export JAVA_OPTS="$JAVA_OPTS -javaagent: /apminsight-javaagent.jar" For JBoss AS 7.x servers: In standalone setup: Edit /bin/standalone.bat (In Linux, standalone.sh) file to add the following java arguments to the existing JAVA_OPTS. -Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine -javaagent: /apminsight-javaagent.jar In domain setup: Edit /domain/configuration/Host.xml file and locate tag and add the mentioned tags under your desired . Save the file and start the JBoss Application Server Note: There is a bug in JBoss AS 7.2.x with a hindrance to deploy our APM Insight Java Agent in this server. We suggest to upgrade the JBoss server and try installing APMInsight Agent. Install APM Insight Java Agent in JBoss EAP 6.2.x & aboveDownload latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a new directory to find agent jar and its configuration files Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:8443/ To learn more about the agent configurations, visit our Configuration Guide page. For Standalone setup, Edit /bin/standalone.bat (In Linux, standalone.sh) file to add the following java arguments to the existing JAVA_OPTS -Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine -javaagent: /apminsight-javaagent.jar For Domain setup, Edit /domain/configuration/Host.xml file and locate tag and add the mentioned tags under your desired tag. Save the file and start the JBoss EAP server Installing Java Agent in JBoss EAP through Management Console For version 6.2.x For version 7.x For version 6.2.x Open the management console through localhost:9990/console and login as “Management Realm” user. Select Hosts tab → Server Configurations → Server instance in which you like to install the agent → JVM Configuration tab Click on Edit button to create a JVM Configuration for the server. In JVM options text box, add the following lines (each JVM option must be separated by a new line)-javaagent:AGENT_HOME/apminsight-javaagent.jar Click on save button, you will see “Added/Modified JVM Config” message at top of the page. If the message doesn''t appear, check your configuration carefully and save it again. Now, select “System Properties” tab and Click “Add” button. In the newly opened dialog box, fill in the following values: Name : jboss.modules.system.pkgs Value : org.jboss.byteman,com.manageengine Boot-Time : Check And click “Save” button. Finally, start/restart your configured server instance from “Runtime” tab at top left corner of the page. For version 7.x Open the management console through localhost:9990/console and login as “Management Realm” user. Select Runtime tab → Hosts → Choose the Host followed by the Server instance in which you like to install the agent → Click View to view the Server configuration.Click on Edit button to create a JVM Configuration for the server. In JVM options text box, add the following lines (each JVM option must be separated by a new line) -javaagent:AGENT_HOME/apminsight-javaagent.jar Click on save button, you will see “Added/Modified JVM Config” message at top of the page. If the message doesn''t appear, check your configuration carefully and save it again. Now, select “System Properties” tab and click “Add” button. In the newly opened dialog box, fill in the following values: Name : jboss.modules.system.pkgs Value : org.jboss.byteman,com.manageengineBoot-Time : Check And click “Save” button. Finally, start/restart your configured server instance from “Runtime” tab at top left corner of the page. Install APM Insight Java Agent in Jira server Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here. Extract the zip file to a new directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:8443/ To learn more about the configurations, visit our Configuration Guide page. For Windows, Edit the file at /atlassian/jira/bin/catalina.bat to add the following JVM argument set "JAVA_OPTS=%JAVA_OPTS% -javaagent:{full_path_to_agent_directory}/apminsight-javaagent.jar - Datlassian.org.osgi.framework.bootdelegation=com.manageengine.*,sun.*,org.apache.xerces,org.apache.xerces.*" For Linux, Edit the file at /atlassian/jira/bin/catalina.sh to add the following JVM argumentJAVA_OPTS="$JAVA_OPTS -javaagent:{full_path_to_agent_directory}/apminsight-javaagent.jar - Datlassian.org.osgi.framework.bootdelegation=com.manageengine.*,sun.*,org.apache.xerces,org.apache.xerces.*" Restart the Jira server. Install APM Insight Java Agent in JOnAS 4.x servers & above Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here. Extract the zip file to a new directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=http://app-w8-test:9007/ To learn more about the agent configurations, visit our Configuration Guide page. For Windows, open \bin\jonas.bat in any text editor and add the following entry at the top and save the file. set JONAS_OPTS=%JONAS_OPTS% -javaagent: /apminsight-javaagent.jar For Linux, open /bin/jonas in any text editor and append the following value to JONAS_OPTS variable "-javaagent: /apminsight-javaagent.jar" Install APM Insight Java Agent in Oracle WebLogic 10.3.x & above Following are the steps to install APM Insight Java agent in Oracle WebLogic: Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a new directory to find agent jar and its configuration files Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:9007/ To learn more about the configurations, visit our Configuration Guide page. For standalone setup: Open /user_projects/domains/ /bin/startManagedWebLogic.bat(.sh) file in any text editor. Add the following lines at the top of the script file: For Windows: set JAVA_OPTIONS=-DUseSunHttpHandler=true -javaagent: apminsight- javaagent.jar %JAVA_OPTIONS% For Linux:set JAVA_OPTIONS="-DUseSunHttpHandler=true -javaagent: /apminsight- javaagent.jar $JAVA_OPTIONS" For cluster setup: Open the administrative console of Weblogic server, Select Environment > Servers > Configuration tab. Select > Configuration > Server Start tab. Locate Arguments textbox and enter the following argument: -DUseSunHttpHandler=true -javaagent: /apminsight-javaagent.jar Save the settings and start the WebLogic server. Install APM Insight Java Agent in Resin 3.1.x servers & above Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a new directory to find agent jar and its configuration files Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:9007/ To learn more about the configurations, visit our Configuration Guide page. For Resin 3.x servers, Open /conf/resin.conf file in any text editor. Locate your tag and the tag of the server you need to monitor and add the following tag: -javaagent: /apminsight-javaagent.jar For Resin 4.x servers, Open /conf/resin.xml file in any text editor. Locate your tag and the tag of the server you need to monitor and add the following tag: -javaagent: /apminsight-javaagent.jar Save the file and start the Resin server. Install APM Insight Java agent in SonarQube Follow the below steps to install APM Insight Java agent in SonarQube: Download the latest APM Insight Java agent (apminsight-javaagent.zip) file. Extract the zip file to a new directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include/modify the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ application.name=[APPLICATION NAME] where [LICENSE KEY] - License key obtained from Applications Manager under APM Insight tab. [HOST] - Host at which Applications Manager is running. [PORT] - Port number at which Applications Manager is running. [APPLICATION NAME] - Name of your application. Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://prod-test:9007/ application.name=SonarQube_Server To learn more about the configurations, visit our Configuration Guide page. Edit the sonar.properties file located under /conf/ directory. Under the WEB SERVER configuration, uncomment the property sonar.web.javaAdditionalOpts (if commented) and add the following argument: -javaagent: /apminsight-javaagent.jar Once the changes are made, save the file and restart the SonarQube server. Install APM Insight Java Agent in Spring Boot Application Follow the below steps to install APM Insight Java agent in Spring Boot applications: Download the latest APM Insight Java agent (apminsight-javaagent.zip) file. Extract the zip file to a new directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:9007/ To learn more about the agent configurations, visit our Configuration Guide page.Modify your application start up command by including the argument -javaagent: /apminsight-javaagent.jar as mentioned below: java -javaagent: /apminsight-javaagent.jar -jar .jar Example: java -javaagent:D:/apm/apminsight-javaagent.jar -Xms64m -Xmx1024m -jar MyApplication.jar Note: Please ensure that the -javaagent argument is placed before -jar parameter in the startup command. Install APM Insight Java Agent in WildFly 8.x servers & above Follow the steps given below to install Java agent in WildFly servers v8.x & above: Download the latest APM Insight Java agent (apminsight-javaagent.zip) file. Extract the zip file to a new directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include/modify the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT] application.name=[APPLICATION NAME] where [LICENSE KEY] - License key obtained from Applications Manager under APM Insight tab. [HOST] - Host at which Applications Manager is running. [PORT] - Port number at which Applications Manager is running. [APPLICATION NAME] - Name of your application. Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://prod-test:9007 application.name=Wildfly_Server To learn more about the configurations, visit our Configuration Guide page. Agent can configured based on the following installation types: Standalone agent installation Domain based installation Standalone agent installation Windows based installation Linux based installation Windows based installation For standalone agent setup in Windows, follow the steps given below: Open the standalone.bat file under /bin/ directory in any text editor. Copy the following JAVA_OPTS argument: set JAVA_OPTS=%JAVA_OPTS% -Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine - javaagent: \apminsightjavaagent.jar where refers to the directory where the java agent is extracted.Now paste the copied JAVA_OPTS argument (in bold text) above the mentioned section in the standalone.bat file as below: set JAVA_OPTS=%JAVA_OPTS% - Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine -javaagent: \apminsight-javaagent.jar echo ============================================================================== echo. echo JBoss Bootstrap Environment echo. echo JBOSS_HOME: "%JBOSS_HOME%" echo. echo JAVA: "%JAVA%" echo. echo JAVA_OPTS: "%JAVA_OPTS%" echo. echo ============================================================================== echo. Finally, restart the Applications Manager. After adding Java agent and performing a restart of Jboss server, if there are any Logger / Log Manager exceptions in logs, proceed to do the following step: For JDK 8 & below: Modify the JAVA_OPTS argument set previously in Step 1 as below: set JAVA_OPTS=%JAVA_OPTS% - Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine,org.jboss.logmanager -javaagent: \apminsight-javaagent.jar - Djava.util.logging.manager=org.jboss.logmanager.LogManager -Xbootclasspath/p: / /jboss-logmanager- .jar For JDK 9 & above: Modify the JAVA_OPTS argument set previously in Step 1 as below: set JAVA_OPTS=%JAVA_OPTS% - Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine,org.jboss.logmanager -javaagent: \apminsight-javaagent.jar - Djava.util.logging.manager=org.jboss.logmanager.LogManager -Xbootclasspath/p: / /jboss-logmanager- .jar Note: Make sure to modify the JAR filename and path in / /jboss-logmanager- .jar to the correct jboss-logmanager JAR as the name and path differ with different versions of JBoss. Learn more Linux based installation For standalone agent setup in Linux, follow the steps given below: Open the standalone.sh file under /bin/ directory in any text editor. Copy the following JAVA_OPTS argument: JAVA_OPTS=$JAVA_OPTS -Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine - javaagent: \apminsightjavaagent.jar where refers to the directory where the java agent is extracted. Now paste the copied JAVA_OPTS argument (in bold text) above the mentioned section in the standalone.sh file as below: JAVA_OPTS=$JAVA_OPTS -Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine - javaagent: \apminsight-javaagent.jar echo "==============================================================================" echo "" echo "JBoss Bootstrap Environment" echo "" echo "JBOSS_HOME: %JBOSS_HOME%" echo "" echo "JAVA: %JAVA%" echo "" echo "JAVA_OPTS: %JAVA_OPTS%" echo ""echo "==============================================================================" echo "" Finally, restart the Applications Manager. After adding Java agent and performing a restart of Jboss server, if there are any Logger/Log Manager exceptions in logs, perform the following step: For JDK 8 & below: Modify the JAVA_OPTS argument set previously in Step 1 as below: JAVA_OPTS=$JAVA_OPTS - Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine,org.jboss.logmanager -javaagent: \apminsight-javaagent.jar - Djava.util.logging.manager=org.jboss.logmanager.LogManager -Xbootclasspath/p: / /jboss-logmanager- .jar For JDK 9 & above: Modify the JAVA_OPTS argument set previously in Step 1 as below: JAVA_OPTS=$JAVA_OPTS% - Djboss.modules.system.pkgs=org.jboss.byteman,com.manageengine,org.jboss.logmanager -javaagent: \apminsight-javaagent.jar - Djava.util.logging.manager=org.jboss.logmanager.LogManager -Xbootclasspath/p: / /jboss-logmanager- .jar Note: Make sure to modify the JAR filename and path in / /jboss-logmanager- .jar to the correct jboss-logmanager JAR as the name and path differ with different versions of JBoss. Learn more Domain Based Installation For domain based installation, the installation may vary depends on the environment of the Wildfly Server through any of the following methods: Global Configuration : Applying the configuration at the global level to manage all the connected hosts using the domain.xml configuration file. Host-specific Configuration : Applying the configuration for an individual host using the host.xml configuration file. Note: You can also add the configuration settings to both domain.xml and host.xml depending upon the global configuration and the host-specific configuration. Global Configuration Follow the steps given below to apply the configuration at a global level: Open the domain.xml file located under /domain/configuration/ directory in any text editor. Find the element where you want to add your agent and add the following JVM properties (in bold text) inside the element: Find the element and add the following properties (in bold text) inside the element: Save the file and start the Wildfly server. Note: Changes in the domain.xml file require complete restart of both management host and the server host to take full effect. Host-specific Configuration Follow the steps given below to apply the configuration for an individual host: Open the host.xml file located under /domain/configuration/ directory in any text editor. Find the element where you want to add your agent and add the following JVM properties (in bold text) inside the element: Find the element and add the following properties (in bold text) inside the element: Save the file and start the Wildfly server. Note: Changes in the host.xml file require complete restart of both management host and the server host to take full effect. Install APM Insight Java Agent in Docker Follow the steps given below to install Java agent in Docker: Download the latest APM Insight Java agent (apminsight-javaagent.zip) file. Extract the zip file to a new directory to find agent jar and its configuration files. Open the apminsight.conf file in any text editor and include/modify the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT] application.name=[APPLICATION NAME] where [LICENSE KEY] - License key obtained from Applications Manager under APM Insight tab. [HOST] - Host at which Applications Manager is running. [PORT] - Port number at which Applications Manager is running. [APPLICATION NAME] - Name of your application.Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://prod-test:9007 application.name=Docker_Server To learn more about the configurations, visit our Configuration Guide page. Note: Alternatively, the APM Insight application configuration parameters can also be configured as Java System Properties instead of modifying the apminsight.conf file. Learn more Now create/modify the image file named Dockerfile in the directory location of your choice and include the following commands into the image file: #Creating a new directory ''apminsight'' under the specified app directory location RUN mkdir -p /apminsight #Adding the agent directory files into the specified app directory path under ''apminsight'' ADD / /apminsight/ #Configuring Java agent into the application ENV JAVA_OPTS="$JAVA_OPTS -javaagent: /apminsight/apminsight- javaagent.jar" where - Directory where the application is installed. - Directory where the Java agent is extracted. Save the file, rebuild the image and start the container. Example: Following is an example of the commands used for configuring the agent into the image file Dockerfile for Tomcat servers: FROM tomcat COPY sample.war /usr/local/tomcat/webapps/ #Add the apminsight and -javaagent parameters RUN mkdir -p /usr/local/tomcat/apminsight ADD ./apminsight/ /usr/local/tomcat/apminsight/ ENV JAVA_OPTS="$JAVA_OPTS -javaagent:/usr/local/tomcat/apminsight/apminsight-javaagent.jar" EXPOSE 8080 CMD ["catalina.sh","run"] Note: To add the agent to server, the -javaagent argument needs to provided. However, this method is a generic solution and may require some modifications depending on your app server/user environment. Install APM Insight Java Agent in Other Servers Download latest the APM Insight java agent zip file (apminsight-javaagent.zip) here Extract the zip file to a new directory to find agent jar and its configuration files Open the apminsight.conf file in any text editor and include the following keys: license.key=[LICENSE KEY] apm.host=https://[HOST]:[PORT]/ Example: license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac apm.host=https://app-w8-test:9090/ To learn more about the configurations, visit our Configuration Guide page. For Windows, open .bat using a text editor and add the following entry at the top of the startup script SET JAVA_OPTS=%JAVA_OPTS% -javaagent:" /apminsight-javaagent.jar"Example: SET JAVA_OPTS=%JAVA_OPTS% -javaagent:"D:/apminsight/apminsight-javaagent.jar" For Linux, open .sh using a text editor and add the following entry at the top of the startup script export JAVA_OPTS="$JAVA_OPTS -javaagent: /apminsight-javaagent.jar" Example: export JAVA_OPTS="$JAVA_OPTS -javaagent:/home/local/softwares/apminsight/apminsight- javaagent.jar" Save that application server startup file and restart the application server Configure APM Insight application using system properties APM Insight application configuration parameters can also be configured as Java System Properties as mentioned below: Name Key Application Name -Dapminsight.application.name= Applications Manager Host Name -Dapminsight.apm.host= License Key -Dapminsight.license.key= Specifying the above system properties along with the Java arguments will override the values specified in apminsight.conf file. Example: For Windows: set JAVA_OPTS=%JAVA_OPTS% -Dapminsight.application.name=MyApplication - Dapminsight.apm.host=https://prod-server-test:9001/ - Dapminsight.license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810 313e8fac For Linux: export JAVA_OPTS="$JAVA_OPTS -Dapminsight.application.name=MyApplication - Dapminsight.apm.host=https://prod-server-test:9001 - Dapminsight.license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810 313e8fac" Upgrade APM Insight Java Agent Agent versions 5.4 and above Agent versions below 5.4 Agent versions 5.4 and above For agent versions 5.4 and above, APM Insight Java agent can be upgraded from server using any of the following ways: Auto Upgrade Manual Upgrade Note: Auto upgrade feature will only work for major version changes in agent. Minor changes will not be covered.Auto Upgrade You can choose to upgrade to the latest agent version automatically from the web client directly, without the need to download from the website manually. By enabling the Agent Auto-upgrade option, Applications Manager will automatically download the new agent zip file for upgrade when a new agent version is available. By default, this auto-upgrade option is disabled. To enable, navigate to APM tab → Your application → Edit APM Insight Application Configuration → Edit APM Insight Agent Configuration Profile, then enable the Agent auto-upgrade option and click Save. After the deployment process is complete, you will be requested to restart your application server. Once the server is restarted, the updated version will come into effect. Manual Upgrade When a new version of the agent is available, following message will be displayed at the top of the APM Insight details page "The deployed agent version at this instance is 5.4. Update Agent to the latest version 5.5. Refer our release notes." Users can initiate the upgrade process by clicking on Update Agent link in the above said notification. On clicking the Update Agent link, a confirmation dialog will appear to initiate agent update Click on Yes, continue button to start the agent update. On doing so, the alert message changes to "Agent update will happen shortly...". After a few minutes, either on page refresh or on navigating to other tabs, the alert message will be modified. On successful download of the agent, the alert message changes to "Agent downloaded successfully. Please restart your application".Once the server is restarted, the updated version will come into effect.If an error occurs during the agent update, then the message changes to "Problem encountered during agent update. View details.". On clicking the View Detailslink, the error message will be displayed with options to continue or cancel. Note: The Re-initiate option will clear the upgrade status in the cache and immediately try to perform agent update, so message gets modified to "Agent update will happen shortly..." again. Agent versions below 5.4 For agent versions below 5.4, APM Insight Java agent can be upgraded by following the steps given below: Download the latest APM Insight Java Agent (apminsight-javaagent.zip) file. Extract the zip file to a new directory to find agent jars (apminsight-javaagent.jar and apminsight- javaagent-api.jar) and its configuration files. Navigate to the directory where you have deployed the APM Insight Java Agent in your Application Server. Take a backup of your old apminsight-javaagent.jar and apminsight-javaagent-api.jar in the directory. Then replace them with the new one. Restart the target Application server. Note: 1. Customers upgrading to Applications Manager 14440 or above must upgrade their Java agent to version 4.x or above. 2. While upgrading Java Agent from version 2.x to 4.x or above, the following keys in apminsight.conf file needs to be updated:           a. license.key value from Applications Manager web client APM tab > Help Card > License Key needs to be added.           b. apm.host value needs to be changed to https:// :  or http:// : after upgrade. Example 1: license.key=APMI_e448c81fe4927e0495e868124c7d345c2c2f0012f4796b154f4b1827fe56d119 apm.host=https://localhost:8443/ Example 2: license.key=APMI_e448c81fe4927e0495e868124c7d345c2c2f0012f4796b154f4b1827fe56d119 apm.host=http://localhost:9090/ Visit Configuration Guide page for more details. Uninstall the APM Insight Java Agent Remove -javaagent argument from JVM configurations / Java_Opts of your Applications server start up file JVM configurations for the respective servers can be found in the specified files as listed below: For Apache Tomcat: catalina.bat/catalina.sh For JBoss AS and Wildfly: /bin/standalone.bat(In Linux, standalone.sh) OR /domain/configuration/Host.xml OR Management console -> Hosts > Server Configurations > > JVM Configuration tabFor GlassFish: Admin console > Hosts > Server Configurations > > JVM Configuration tab For IBM WebSphere: Open administrative console of your IBM WebSphere server  Select Servers > ServerType > WebSphere Application Servers > Server Name > Java and Process Management > Process Definition > Java Virtual Machine > Generic JVM Arguments Delete the complete APM Insight folder Restart the Application server once. Application Servers Supported Apache Tomcat 6.x & above AWS Elastic Beanstalk Azure Web App Glassfish 3.x servers & above and clustered environments IBM WebSphere 7.x servers & above JBoss AS 4.2.x & above JBoss EAP 6.2.x & above Jira Server JOnAS 4.x & above Oracle Weblogic 10.3.x servers & above Resin 3.1.x servers & above Spring Boot Application WildFly 8.x servers & above Other servers JDBC Drivers Supported SQL Database Generic JDBC drivers IBM DB2 - db2jcc, jt400 Informix Microsoft SQL MySql 4.x & above Oracle - ojdbc, ojdbc5, ojdbc6 / ojdbc14, ojdbc7, ojdbc8, ojdbc10 PostgreSQL - 8.x & above SAP ASE / Sybase ASE - jconn2, jconn3, jConnect / jconn4 NoSQL Database Cassandra 2.1.x & above MongoDB 2.12 -2.14, 3.x & above JVM / JDK Supported Oracle Hotspot JDK version 1.6 & above IBM (J9) JDK version 1.6 & above OpenJDK version 1.6 & above HP-UX 11i JRE version 1.6 & above We do support the most commonly used JVMs from version 1.6 & above.AWS Services Supported APM Insight is now capable of tracking the performance of AWS Services / API Calls in user''s applications. When an application accesses AWS services through AWS SDK, the APM Insight agent automatically picks up those requests and starts tracking the performance of those service calls. List of AWS Services Supported: Relational Database Service (RDS) Simple Queue Service (SQS) DynamoDB SimpleDB S3 Service Simple Notification Service (SNS) Simple Email Service (SES) Glacier Service Kinesis Service EC2 Service Elastic MapReduce Elastic Beanstalk Route 53 Service Cloud Front Service Cloud Search Service Frameworks and Components supported Frameworks JAX-WS Play 2.0.x - 2.7 Restlet 2.2, 2.3 Spring 3.x - 4.x Struts 1.x, 2.x Components AWS services Apache HttpClient 3.x, 4.x EJB 3.x Filter Hibernate 3.x JSP Java.net.HttpURLConnection Memcached (spymemcached) Redis (Jedis) OkHttp Client (v3 & above) Agent Performance Report for APM Insight Java Agent Server SetupApplication Setup Memory Consumption Response Time Overload Network Bandwidth Usage Server Setup Application Server - Apache Tomcat 7.0.29 JDK/JVM Environment - Oracle JDK 1.6.0_24 Operating System - Windows 7 (x64) Application Setup J2EE Web Application MVC Frameworks used: Struts 2 ORM Frameworks used: Hibernate 4.2.19 Final Database: MySQL Cached Frameworks used: Memcached Memory Consumption The target web application is set to receive 300 requests per minute. APM Insight Java agent is configured to track all transactions (web, non-web). The agent consumes 35 to 40 MB to track all the transactions getting served by the Application Server. On increasing the throughput to the server to 600 requests per minute, the APM Insight Java agent consumes 80  to 100 MB, tracking all the transactions served by the application server. In case of Application servers serving huge requests, memory consumption by the APM Insight Java agent can be reduced (if needed) by configuring the sampling factor. Response Time Overload Response time overload added by the APM Insight Java agent is directly proportional to the number of method calls being instrumented. If the agent is set to track all the method calls happening in the transaction, the maximum response time overload will be 7% of the actual response time. On Minimal, Agent consumes 1% of the actual response time. Network Bandwidth Usage The communication between APM Insight agent and Applications Manager servers is of one-way HTTPS communication. The agent sends the performance metrics to Applications Manager server every one minute. There will be 2 requests per minute from the agent to our Applications Manager servers. /arh/data  - carries metric data of all the transactions performed on the server, which will consume at the maximum of 100 KB. /arh/trace - carries traces of every transaction which consumed response time larger than the configured threshold level. A complete snapshot of the transactions will be sent. This can be used for better debugging. Maximum data size sent is around 4MB. APM Insight Java Agent - Release Notes Java Version 5.4.1 Release Date: 02-02-2022 Issues FixedAgent shutdown time in ''apminsight.info'' file kept appending to previous values - this has now been resolved. Only the latest values are retained now. Null values were shown in JMX metrics caused by a NaN exception. Timeout of HttpUrlConnection class were captured separately. Enhancements Support for Play 2.7 & 2.8 framework. Support for OkHttp3 Client up to v4.8. Introduced an option to enable/disable diagnostics logs. REDIS component is enhanced to monitor additional operations like hset, hget, etc. Vulnerable classes of the log4j library have been removed (Agent uses log4j v1.2.17). (Latest version of log4j will be used in the next release.) Java Version 5.3.0 Release Date: 13-10-2021 Issues Fixed When log level was set to OFF, agent was still printing few lines before being disabled. Enhancements Support for monitoring messaging queues like Kafka, RabbitMQ, and ActiveMQ. Headers of web requests are captured from this agent version. Checksum verification to validate the integrity of the downloaded agent. Java Version 5.2.0 Release Date: 22-07-2021 Issues Fixed SQL queries were not captured while using MySQL client v8.x. Enhancements Support for Java 15 monitoring. Standalone HTTP calls are tracked as background transactions - this was deprecated in agent v5.1.0 and is now reverted back. Automatic transaction grouping is applied to background transactions. Java Version 5.1.0 Release Date: 15-04-2021 Enhancements Support for monitoring JMX metrics. Support for OkHttp Client (v3 & above). Http calls in the background are no longer tracked as separate background transactions. It will be captured as a part of any other transaction where it is executed. Java Version 4.9.0 Release Date: 19-08-2020Issues Fixed Agent was unable to instrument DB queries when WebLogic wraps JDBC calls. Deadlock between Tomcat main thread logger init and agent httpclient init. Enhancements Support for distributed tracing. Introduced an agent diagnostic collector log for troubleshooting diagnostics tasks. Java Agent Configuration Options This page should help you tune the configuration for APM Insight Java agent configuration profile. The APM Java agent configuration profile enables you to set threshold values for key parameters and web transactions. These settings can be configured in apminsight.conf file or from the web client (represented by ). Make sure that this file is present in the folder where you have deployed the APM Insight agent. The APM agent configuration profile is categorized into three parts: Basic configuration profiles Web transaction configurations Background transactions configurations Basic configuration profiles Name Key Description Default value Enabling this option will listen to all SQL Capture Queries which gets executed. If this database sql.capture.enabled True option is disabled, no Database Metrics SQL Queries will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true). Obfuscate Disabling this option will give you the SQL transaction.trace.sql.parametrize True real query (with parameters). It is Parameters recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will collect the threshold for stacktrace whenever any sql query SQLs in transaction.trace.sql.stacktrace.threshold 3(seconds) executed above this threshold time transaction value. trace Display Port number of application instances will Instance show.instance.port.number True be shown, if this option is enabled. Port number The log level at which the APM Insight Logging agent should record information. apminsight.log.level INFO level Supported levels are SEVERE, WARNING, INFO and FINE. Web transactions of the specified URL List of URL patterns will be skipped while tracking. *.css, *.js, extensions Use comma (,) to separate multiple *.gif, *.jpg, to be entries *.jpeg, transaction.skip.listening skipped Example: *.bmp, from transaction.skip.listening=*.jpeg, will *.png, tracking skip listening to transactions ending with *.ico .jpeg List of exceptions.ignore Enter the list of exceptions that need not Noneexceptions be tracked. to be skipped from tracking Provide regex patterns or transaction Skip names that can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Web transaction configurations Name Key Description Default value Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores Apdex apdex.threshold values below the apdex.threshold value, 0.5 Threshold the transaction is labeled as Satisfied. (seconds) If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transaction.tracking.request.interval transactions. If set to 5, APM Insight tracks 1 (request) factor only 1 in 5 requests of the same kind. Enabling this option will construct Trace Enable for Slow Transactions. You can view the transaction transaction.trace.enabled True traces collected in APM Insight Page by tracing selecting Traces tab. Trace of any transaction whose response time scoring above the specified Transaction threshold value will be collected, provided tracing transaction.trace.threshold 2 (seconds) if transaction.trace.enabled is set to true. threshold The trace can be used to analyze, troubleshoot the transaction working. Capture Trace snapshot will be taken for all HTTP trace if request(s) which has total external external webtransaction.trace.external.components.count.threshold components (like MYSQL, MEMCACHED, 50 (Count) calls etc) call count equal or higher than the exceeds configured number. Capture CPU time Record CPU time for every HTTP request, if webtransaction.record.cputime.enabled True per enabled. transaction? Capture Memory When enabled, memory allocations for all allocation webtransaction.record.memory.allocation.enabled 2 (seconds) web transactions will be captured. per transaction? Capture webtransaction.trace.input.params.record False Enabling this option captures parameters HTTP of all GET & POST web requests parameters? To skip capturing specific parameters use webtransaction.trace.input.params.ignore keyCaptured parameters can be viewed by selecting the required transaction in Traces tab To skip capturing specific web request password, parameters like password, PIN or any pswd, confidential values, specify those pass, parameter names for this key List of HTTP authKey, parameters webtransaction.trace.input.params.ignore Use comma(,) to separate multiple entries. parentId, to ignore Values specified for this key are case- parentID, sensitive resourceId, resourceID, If no value is specified, all request id, ID parameters will be recorded List of HTTP error codes This is the list of HTTP error codes, like to be http.errors.ignore 400, 401, and 500, that will not be None ignored tracked. from tracking Capture Captures Bytes in and out in network capture.http.network.bytes True HTTP Bytes requests, if this option is enabled. Background transaction configurations Name Key Description Default value Enabling this option, APM Insight agent starts tracking Track background transactions background bgtransaction.tracking.enabled True transactions All transactions other than HTTP are considered as background transactions Enabling this option, the agent collects traces for slow Capture background transactions, bgtransaction.trace.enabled True traces provided bgtransaction.tracking.enabled is set to true Traces will be collected for background transactions whose Transaction response time have crossed the 5 trace bgtransaction.trace.threshold specified threshold value, (seconds) threshold provided bgtransaction.trace.enabled is set to true Trace snapshot will be taken for Capture background transactions which trace if has total external components 50 external  bgtransaction.trace.external.components.count.threshold (like MYSQL, MEMCACHED, etc) (Count) calls call count equal or higher than exceeds the configured number. Capture Record CPU time for every CPU time bgtransaction.record.cputime.enabled background transaction, if False per enabled. transaction? Capture Memory allocated for Memory background transactions will allocation bgtransaction.record.memory.allocation.enabled False be captured, if this option is per enabled. transaction?Sampling bgtransaction.tracking.request.interval Sampling factor for 1 factor background transactions (Request) If value is set to 1, agent tracks every transaction. If value is set to n, agent tracks 1 in n transactions of same kind Tracking Background Transactions In a typical web application, the user communicates with the application via HTTP requests; these requests access the application server and render the requested data back to the user. Aside from these web transactions, there could be a number of transactions being executed in an application. These transactions may not be triggered by the user but they''re still vital for the application to properly function. In general, transactions that do not come under user purview are considered background transactions. Common examples include maintenance, schedulers, messaging, data archiving, etc. Since these transactions run in the background, it''s easy to overlook their performance. You often won''t know if these transactions are successful or not unless a major issue bogs down your entire application. This is why monitoring background transactions is essential for quickly debugging errors. APM Insight also captures these transactions and list them under Background tab in APM Insight dashboard. Note: This feature is available in .NET & Java agents only. How to monitor background transactions? Unlike web transactions, which are implemented using known frameworks like Struts, Play, Spring, etc., background transactions are custom-coded by developers to meet their specific needs and requirements. These are not captured by the APM Insight agent by default, but can be monitored using custom instrumentation. With custom instrumentation, you can use defined methods and classes. Include the specified code at the beginning of a method or class, and the agent will start tracking its performance. Note: Standalone HTTP URLs are no longer tracked as background transactions, i.e, background transaction with only HTTP call will no longer be monitored as background transaction. If they are part of any other transaction, only then they will be tracked. Metrics captured To enable tracking of background transactions, follow the steps given below: Log into your Applications Manager account. Under APM Insight tab, navigate to APM Insight app → Edit APM Insight Application Configuration. Go to APM Insight Agent Configuration Profile → Edit APM agent configuration profile → Background transactions and enable the Track background transactions checkbox. Finally, click Save.Configuration for background transactions is explained below: Configuration Description Default Value Enabling this option, APM Insight agent starts tracking background transactions bgtransaction.tracking.enabled true All transactions other than HTTP are considered as background transactions Enabling this option, the agent collects traces for slow background transactions, bgtransaction.trace.enabled true provided bgtransaction.tracking.enabled is set to true Traces will be collected for background transactions whose response time have crossed the 5 bgtransaction.trace.threshold specified threshold value, (seconds) provided bgtransaction.trace.enabled is set to true. Record CPU time for every bgtransaction.record.cputime.enabled background transaction, if false enabled. Memory allocated for background transactions will be bgtransaction.record.memory.allocation.enabled true captured, if this option is enabled. Trace snapshot will be taken for background transactions which has total external components bgtransaction.trace.external.components.count.threshold 40 (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number. Sampling factor for background 1 transactions (request) bgtransaction.tracking.request.interval If value is set to 1, agent tracks for Java & every transaction. If value is set 5 for .Net to n, agent tracks 1 in N agent transactions of same kind.   Note: These values cannot be changed during run-time for java agent. For the changes to be effective, server restart is required. Restart is not required servers using .Net agent, the values will be updated in run-time. Custom Instrumentation APM Insight agent instruments predefined classes of several Web Components and Frameworks to provide insight into the application. APM Insight also provides an option to custom instrument, classes of your choice. Custom instrumentation helps in providing wider insight into applications, where it will be easier to track performance of specific features or modules in the application.Java Agent provides two ways to custom instrument your application: Using Configuration file - You can use this method when you want to instrument classes or methods for specific instances.  Using Java Annotations - Use annotations to extract additional values by making changes in your application. Changes are reflected across all your application instances. Using Web Client - You can instrument your application methods and classes from Applications Manager web client. Changes are reflected across all your application instances. Using Configuration File To instrument classes of your choice, specify the class name in ''custom_instrumentation.conf'' (for versions below 4.9) or ''instrumentation.conf'' (for versions 4.9 and above) file, as per format specified below: Fully qualified ClassName : methodNames separated by comma(,) : component_Name Each entry of class/package must added in a new line. Use comma(,) as method separator for multiple entries. If methods to be instrumented is left blank, all methods under the specified class will be instrumented. If there exists, overloading methods that needs to be instrumented, all the overloaded methods will be instrumented.  Only a-zA-Z_0-9 characters are allowed for naming a component. If component_Name is not specified or invalid, by default agent considers it as APP Code. Example: a/b/c/CustomClass : methodA, methodB : ComponentA a/b/c/CustomClass : methodC : ComponentB a/b/c/CustomClass : : Component_A1 a/b/c/CustomClass : : If all classes in a package needs to be instrumented, specify the package name as described below. package_name/.* : Example: a/b/c/.* : : Component_C a/b/c/d/.* : : It is not recommended to specify packages as input, as the agent will instrument all methods in all classes and all packages under it. These may cost extra overhead in CPU and memory usage. Also, there will be many methods that are of least interest and also these makes the traces lengthy. Although it can be used to study the code flow. Note: It requires a application server restart for the changes to be effective Custom Instrumentation using Java Annotations  Using Java annotations, APM Insight provides an easier way to custom instrument your application classes and methods. Usage of Java annotation enables you to define custom names for the transaction and also assign a custom component. Prerequisites Download the apminsight-javaagent.zip file which includes agent jar with its associated files along with the apminsight-javaagent-api.jar Include the apminsight-javaagent-api.jar file to the project build path. Make sure the jar file is exported along with the application''s libraries. Java agent API library provides two annotations which can be used in your application to track the performance of your custom classes and methods.ApmTracker - Can be used upon any classes and methods, which will be instrumented and included in the traces. ApmRootTracker - Can be used upon the methods which are likely to be starting point of transaction execution (background). ApmTracker This annotation can be used on Classes and Methods. When used upon a class, the attributes are applied for all the methods in that class. It will override the method-wise annotations. Attributes: component - Optional attribute Defines the custom component for annotated classes/methods. Example: Case 1: Usage on Class @ApmTracker public class Category {     ... } Case 2: @ApmTracker(component="payment" public class PaymentProcessor {     ... } Case 3: Usage on Methods public class Product {     @ApmTracker     public int getPrice(String product, String brand) {         ...     }     ...     @ApmTracker(component="FetchBrand")     private List fetchAllBrandsList(String product) {         ...     } } name - Optional attribute A custom name for the annotated element, which will be prepended to actual method name. Method parameters can be used for custom name by mentioning the argument index (starts at 1) with prefix ''$''. The instrumented methods and its custom names can be viewed under Traces. ApmRootTracker This annotation can be used only on methods. If annotated method is the first method invoked on the server for processing the transaction, then the transaction is re-named using the value of the txnName attribute. Else, it is considered to be a normal method call and included in the traces. Attributes: component - Optional attribute Defines the custom component for annotated methods. name - Optional attributeA custom name for the annotated element, which will be prepended to actual method name. Method parameters can be used for custom name by mentioning the argument index (starts at 1) with prefix ''$''. txnName - Mandatory attribute Defines the name for the background transaction, only if the method is the entry point of the transaction else it will be tracked as generic method and added to the traces. The transaction is named according to the value specified for the attribute txnName. Grouping Similar Transactions Dynamic Transaction names are becoming more familiar with lots of applications, making it difficult to actually track the performance of the application. Dynamic transactions are web transactions within an application having single URL but get appended with unique alpha numeric identifiers every time they are invoked, making the web transaction name itself look different. Tracking such individual URLs is a herculean task. Here, this feature of grouping similar transactions, will help to group these dynamic transactions into the actual URL that needs to be monitored. Configuration Steps Create a new file named "transaction_merge_patterns.conf" in the directory where the apminsight.conf exists. Open the file in a text editor and add the key value pairs as per the syntax provided below Regular expression of URLs/web transaction=new name to be assigned Application server restart is required for the changes to be effective. Example: You have Web transaction URLs: ebay/shop/item/chocolate/nestle ebay/shop/item/chocolate/snickers ebay/shop/item/chocolate/orion ebay/shop/item/stationary/pencil ebay/shop/item/stationary/pen How to specify in transaction_merge_patterns.conf: ebay/shop/item/chocolate/.*=ebay/shop/chocolate ebay/shop/item/stationary/.*=ebay/shop/stationary ebay/shop/item/.*=ebay/shop/others APM Insight Java Agent - Context-based monitoring for Java applications Let''s say your application server has three Java applications running on it.  By default, transactions of all applications coming from the same app server are shown collectively under the Web Transactions tab in APM Insight. In the image cited below, "TomcatApplications" is the application monitor name, and jpetstore, sample and SampleWebApp are three contexts running on the same application server.The transactions of these three applications are listed out in the Web Transaction tab. Now, with context-based monitoring, you can monitor the performance of all individual applications running in the same app server separately, which helps you analyze your application performance at a more granular level. This means that by enabling context-based monitoring, transactions of jpetstore, SampleWebApp and sample can be viewed separately. Browse through the following topics to learn more on configuring context-based monitoring: Enabling context-based monitoring Renaming or grouping contexts Disabling context-based monitoring Enabling context-based monitoring Log in to Applications Manager. Download and install the APM Insight Java agent. Add the following key in the apminsight.conf file:  context.monitoring.enabled=true Restart the server. Perform some transactions in respective contexts for the agent to identify them as individual monitors. Each context name is prefixed with the application name provided in the configuration file. For example, if the application name provided in the configuration file is TomcatApplications, and individual context names are SampleWebApp, sample, and jpetstore, then the individual contexts will be shown in the APM Insight client as shown below: TomcatApplications/SampleWebApp TomcatApplications/sampleTomcatApplications/jpetstore Note: If context-based monitoring is enabled, each individual context is considered a separate APM Insight monitor and consumes a separate monitor license. Renaming or grouping contexts To rename your contexts: Navigate to the APM Insight agent directory. Create a file named "context_naming_patterns_conf". Provide a key-value pair, with the syntax key=value, wherein: Key denotes the exact context name or regex matching the context names. Value denotes the name used to rename the context. Example: When you want to change your context name from sampleapp to jpetstore, provide the key-value pair as sampleapp=jpetstore When you have contexts like /api/1, /api/2 and you want to monitor them as a single application, they can be grouped as /api/\d+=/api Important: Background transactions are not shown for individual contexts. Since it is not possible to identify which context triggered a background transaction, background transactions are captured at the JVM level, and the data is shown at the application level. Thread profiling is completed for the entire JVM and is not specific to context. Irrespective of which context the profiling is initiated from, it is performed on whole JVM and pushed to the main APM application (the one with name provided in the configuration file). Note: This feature is available only from APM Insight Java agent version 4.4 onwards. Disabling context-based monitoring To disable context based monitoring: Add the following parameter in your apminsight.conf file: context.monitoring.enabled=false In your agent directory, check for the directory apminsight_monitors and delete it, if it exists. Restart your app server. Monitoring JMX metrics With APM Insight Java agent, you can track Java Management Extensions (JMX) metrics. Although we monitor and enhance application performance using transaction metrics and traces, it is equally important to monitor the environment where your application is running. Moreover, monitoring JMX metrics helps you gain additional insights. By default, JMX metrics are captured from APM Insight Java agent version 5.1, and can be viewed under App Parameters tab. Since JMX metrics are specific to app servers, metrics captured by default in various servers are listed below. Metrics Tomcat JBoss WildFly GlassFish WebLogic WebSphere WebSphere Jetty AS AS Liberty profile Session     Data Source           Thread pool   Transactions       (JTA)Buffer Pool File Descriptor Count To enable capturing of JMX metrics, follow the steps given below: Log into your Applications Manager account. Under APM Insight tab, navigate to APM Insight app → Edit APM Insight Application Configuration. . Go to APM Insight Agent Configuration Profile → Edit APM agent configuration profile → Background transactions and enable the Capture JMX metrics checkbox. Finally, click Save. You can now view the JMX metrics under the App Parameters tab. Apart from the default metrics, you can also capture additional metrics by following the below given steps: Create a new file jmx_extensions.conf in agent directory. Add the JMX query in the following format: You can add wildcard (*) to the queries. You can also use the keys for naming the metrics by enclosing them with {}. Add each JMX in a new line. Examples: 1. java.lang:type=OperatingSystem java.lang-OperatingSystem OpenFileDescriptorCount Agent monitors attribute OpenFileDescriptorCount and it will be named as java.lang-OpenFileDescriptorCount 2. java.nio:type=BufferPool,name=* java.nio-BufferPool-{name} MemoryUsed, TotalMemoryThe result of above query is that the agent monitors all the beans under the Buffer Pool, and will monitor the attributes memory used and total memory. This will be named as java.nio-BufferPool-Direct-MemoryUsed, etc. If you do not want to monitor JMX metrics, you can disable the Capture JMX metrics checkbox under Configuration Profile → Edit APM agent configuration profile → Background transactions. Monitoring with Java Agent API In general, APM Insight Java Agent monitors commonly used frameworks and libraries. With Java Agent API, you can track custom metrics to monitor parameters that are specific to your application. This helps in contextual debugging. The Java Agent API allows you to annotate methods that are to be monitored. Additionally, you can provide a custom name for your methods and components to make it easier to identify and troubleshoot them. Requirements: Before monitoring via the Java Agent API, make sure the following requirements are met: Java version 1.6 and above. API JAR file (apminsight-javaagent-api.jar) which is bundled with the Java Agent zip file. The API Jar file is available in your application''s build path and bundled with your application (Preferred location: WEB-INF/lib). Usage: You can use the Java Agent API for the following: In Custom Instrumentation To track Exceptions To monitor block of code To add custom parameters to trace To customize transaction name Custom Instrumentation using the Java Agent API Apart from default classes and methods defined in the application framework, you can monitor your own application specific methods and classes using custom instrumentation. Custom instrumentation can be done either via the Java Agent API or by using the configuration file. The Java Agent API provides you with annotations to instrument your methods and classes. Track exceptions using Java Agent API (version 3.5) Although you can track exceptions with the help of the agent, the Java Agent API provides more visibility and customized options for monitoring/debugging purposes. Normally, the agent captures exceptions that have been logged or uncaught. In most cases, developers tend to catch exceptions and handle them within the code without propagating them. These kind of exceptions can be tracked using this API. With the Java Agent API, you can provide a custom message and actual throwable exception object and track exceptions when they occur. You can add the API in your application code to provide an error message and an exception. This is then tracked by the agent and associated with its respective transaction. You can view these exceptions under the Exceptions tab of APM Insight. Syntax: CustomTracker.trackException(String message, Throwable throwable); CustomTracker.trackException(Throwable throwable); Sample Input: try { int number = 10/0; } catch(Exception e) {CustomTracker.trackException("Exception - Tracked", e); } Sample Output: Monitor a block of code You can also use the Java Agent API to monitor specific blocks of code inside method levels. To monitor a block of code, enclose the block of code within the new object of the CustomTracker and stop method. You can associate a name, component, and exception with the block. As of now, names only support spaces, hyphens, underscores, and alphanumeric characters. Block names can be up to 64 characters long, while component names are limited to 32 characters. Creating a new CustomTracker object marks the start point of the block to be monitored; the end of the block is marked using the .stop() method. If there are any exceptions in the block, the exception object can be passed to the stop method; this automatically associates the exception to the corresponding block and its transaction. Syntax: CustomTracker tracker = new CustomTracker("block__name"); CustomTracker tracker = new CustomTracker("block_name", "component_name"); tracker.stop(); tracker.stop(exceptionObj); Sample Input: CustomTracker tracker = new CustomTracker("Custom Function"); try { // some operations tracker.stop(); } catch (NumberFormatException nfe) { tracker.stop(nfe); // some rescue operations } Sample Output: Add custom paramters to trace To give contextual meaning to traces, you can add additional parameters which can help you identify the context of the transaction trace. Contextual metrics can be anything, a session id, user id or certain method parameters which can help you identify the specific information about a transaction trace. You can add a maximum of 10 parameters to a transaction trace, these parameters can be viewed under Trace Summary. To add a custom parameter, follow the syntax given below: Syntax: CustomTracker.addParameter("key", value); where, key - Name of the parameter value - Parameter of the value. It can be of any type, internally agent converts them to string using Object.toString()Sample Input: import com.manageengine.apminsight.agent.api.CustomTracker; .... { .... CustomTracker.addParameter("Application View", "custom value"); CustomTracker.addParameter("Application", "MyApplication"); .... } Sample Output: Customize transaction name If you like to define a unique name for a transaction for easy tracking and identification, you can use our agent API. Syntax: CustomTracker.setTransactionName("name"); where, name - desired name for the transaction Sample Input: import com.manageengine.apminsight.agent.api.CustomTracker; .... { .... CustomTracker.setTransactionName("Application/Details"); .... } Sample Output: Exclude transactions from monitoring In an web application, few URLs (static pages, js files, images, etc) do not require performance monitoring. Such URLs can be excluded from monitoring using two ways, Exclude transactions using URL extensions Exclude transactions using RegexExclude by URL extensions Login to Applications Manager account. Under APM Insight tab, access the required application/instance, then go to Edit APM Insight Application Configuration and select Edit - APM Insight Agent Configuration Profile. Scroll down to the field ''List of URL extensions to be skipped from tracking'' Specify the URL extensions, to be excluded from performance monitoring Exclude by regex Login to Applications Manager account. Under APM Insight tab, access the required application/instance, then go to Edit APM Insight Application Configuration and select Edit - APM Insight Agent Configuration Profile. Scroll down to the field ''Skip Transactions'' Specify the valid regexes (comma separated). All the URLs matching these patterns will not be monitored by the agent. APM Insight Java agent - Checksum Validation You can verify the authenticity of the downloaded APM Insight agent with SHA256 checksum validation. This ensures that the downloaded agent is credible and is not tampered with by any malicious code or software. To verify the authenticity of the agent, follow the steps given below: Download the checksum file. Compare the checksum value provided in the downloaded file with the downloaded agent. Follow the steps below to validate the checksum value: For Linux systems, execute the following command: sha256sum apminsight-javaagent.zip For Windows, you can use either of the following commands: Open Command Prompt and execute the following command: certutil -hashfile apminsight-javaagent.zip SHA256 Open Windows Powershell and execute the following command: Get-FileHash apminsight-javaagent.zip -Algorithm SHA256 After executing the commands, you will obtain a checksum value. Check that value with the one downloaded from the checksum file. Sample Output: Note: If the checksum values differ, do not unzip or open the file. Signed JAR verification All agent jar files (apminsight-javaagent.jar and apminsight-javaagent-api.jar) are signed with a Zoho Corp. certificate. To verify the signature, execute this command: jarsigner -verify -verbose apminsight-javaagent.jar You can find the file is signed by "ZOHO Corporation Private Limited" at the end of the output.APM Insight .NET Agent Applications Manager''s .NET agent gives you insight into the way your .NET web-transactions work; helping you quickly drill-down to the root cause of issues. Now you can resolve performance degradation of .NET applications, no matter where they originate. Just download the latest .NET Agent and deploy it in your application server.  Click on the links below to learn more about the working of .NET agent and its usage: Working of APM Insight .NET Agent Installing the Agent Managing the agent Starting the .NET Agent Stopping the Agent Editing .NET Agent Configuration Uninstalling the Agent Using Application Filters Filtering Web Applications in settings dialog For Agent Version 2.3 and above For Agents below Version 2.3 Filtering Web Applications manually For Agent Version 2.3 and above For Agents below Version 2.3 Transaction grouping Background transactions Use .NET agent API for Custom Instrumentation HealthMonitor Diagnostics tool Agent Performance Report Frequently Asked Questions (FAQ) Release Notes Working of APM Insight .NET Agent The .NET Agent, instrumented into the application using .NET profiling API, collects the data (Metric/traces) and sends it to the Agent service through the Inter Process Communication (IPC). The Agent service, in turn, receives the data from the .NET agent and sends it to Applications Manager through a scheduler. Installing the AgentInstallation Requirements Applications running Microsoft .NET Framework Version 3.0 and above. IIS 6.0 and above. Installation Instructions Click APM tab. Click on .NET tab to download the file. Click Download to deploy the agent in your application server. Run the .msi file . This opens a "select installation folder" window. Click on Browse and select the folder path to install the .NET Agent. Click Next. In the next window, under the Startup Options, check the ''Start the Agent after installation'' check- box if you wish to start the agent. Click Next to start installation of the agent. A .NET Agent Configuration window appears before the installation is completed. Configure Applications Manager''s host and port and other apdex settings. Click the Save button to complete installation. Now the .NET agent is ready and all the ASP.NET applications (such as WCF) running on the server will be monitored. The collected data should be available in the apm-insight tab of Applications Manager''s web client within a few minutes. Note: Please uninstall any third-party profilers before installing the APM Insight .NET agent. Managing the agent Starting the .NET Agent If you have not checked the ''Start the Agent after installation'' check-box in the Startup Options dialog box during installation, manually start the agent service from Windows Service Manager. The service name is ManageEngine .NET Agent. Editing the .NET Agent Configuration Click on Edit Configuration from the ManageEngine .NET Agent folder in the Start Menu to edit the agent configuration. This opens the .NET agent configuration dialog box. After making the required changes, click Save to update the configuration file. Stopping the .NET Agent You can stop the agent service manually from the Windows Service Manager. This will close the IPC connection between the application and the service; removing the profiler variables from system environment variables and disabling the profiler. It also resets the IIS. You can manually re-start the agent as mentioned above in Starting the .NET Agent APM Insight Configuration This helps you fine-tune the configuration for tracking web based transactions. These settings can be configured in *.conf file. Refer here to know about APM Insight configuration options. Uninstalling the Agent Stop Agent from services.msc You can uninstall the agent from the Start menu. Click on ''Uninstall .NET Agent'' from the ManageEngine .NET Agent folder in the Start Menu to uninstall the agent. Note: Make sure to set a down time as it might restart IIS server. Using Application Filters You can choose individual application that you would want to monitor in your IIS server and view individual application metrics on your console. With this new feature you get the flexibility to add or remove monitoring of applications hosted under an IIS server. Filtering Web Applications in settings dialog For Agent Version 2.5 and aboveLaunch Edit Configuration window (Start Menu > Edit Configuration). This dialog is launched automatically during installation. If apminsight.appname key is present in any of the web applications in IIS, the dialog will give an option to remove them. Go to AppFilters tab. Select ''Use App Filters''. Select applications to be monitored. By default, all applications will be selected for monitoring. Provide applications a unique name in the text box under column ''Apm Insight key''. This will not affect the IIS. Click Save. Note: For agent version 2.3 to 2.5, Stop the .NET Agent windows service before launching Edit Configuration window. Start the .NET Agent after Saving your settings. For Agents below Versions 2.3 1. Versions 2.0 to 2.3 Stop the .NET Agent windows service (during installation, skip this step). Launch Edit Configuration window from (Start Menu > Edit Configuration (x64 or x86). This dialog is launched automatically during installation. If apminsight.appname key is present in any of the web applications in IIS, the dialog will give an option to remove them. From Version 2.0, this dependency has been removed. Go to AppFilters tab. Select ''Use App Filters''. Select applications to be monitored. By default, all applications will be selected for monitoring. Provide applications a unique name in the text box under column ''Apm Insight key''. This will not affect the IIS. Click Save. Start the .NET Agent windows service. 2. Versions older than 2.0 Launch Edit Configuration window (Start Menu -> Edit Configuration (x64 or x86)). Note that, this dialog is launched automatically during installation. Go to the AppFilters tab and select "Use App Filters". Select multi-monitor checkbox in the General tab under application name group box if your applications have to be individually monitored Select the ''Use ApmInsight keys'' option. This will add a key apminsight.appname to the selected applications in their respective web.config file, under the appSettings section. Select applications to be monitored. By default, all applications will be selected for monitoring. Provide applications a unique name in the text box under column ''Apm Insight key''. (Column will be hidden if ''Use ApmInsight keys'' in step #3 is not selected) Click Save. Restart .NET Agent windows service to effect changes.  Filtering Web Applications Manually For Agent Version 2.3 and above Changes to be made in Agent configuration Go to the APM Insight .NET Agent installation folder. Open DotNetAgent folder. Open appfilter.conf file and edit the following keys, use.app.filters=true (default) use.apminsight.appnames=true (default is false) include.app.names={json formatted appnames} eg: include.app.names = { "Default Web Site/" : "ServerRoot", "Default Web Site/Services/wcf1" : "Service1", ... } Copy this appfilter.conf file and paste it in the following location: %WINDIR%\ProgramData\DotnetAgent   For Windows server 2003, the corresponding path will be in%WINDIR%\Documents and Settings\All Users\Application Data\DotNetAgent\ In case of multimonitors, all sub folders in the above locations. Restart the .NET Agent windows service to effect changes.  For Agents below Version 2.3 1. Versions 2.0 to 2.3 Changes to be made in Agent configuration Go to the APM Insight .NET Agent installation folder. Open DotNetAgent folder. Open appfilter.conf file and edit the following keys, use.app.filters=true (default) use.apminsight.appnames=true (default is false) include.app.names={json formatted appnames} eg: include.app.names = { "Default Web Site/" : "ServerRoot", "Default Web Site/Services/wcf1" : "Service1", ... } Copy this appfilter.conf file and paste it in the following location: %WINDIR%\ProgramData\DotnetAgent\x64 (for 64-bit agent) %WINDIR%\ProgramData\DotnetAgent\x86 (for 32-bit agent) For Windows server 2003, the corresponding path will be in %WINDIR%\Documents and Settings\All Users\Application Data\DotNetAgent\x64 (for 64- bit agent) %WINDIR%\Documents and Settings\All Users\Application Data\DotNetAgent\x86 (for 32- bit agent) In case of multimonitors, all sub folders in the above locations. Restart the .NET Agent windows service to effect change. 2. Versions older than 2.0 To filter Web Applications you must make configuration changes in the following: IIS Manager Agent configuration Changes to be made in IIS Manager Launch IIS Manager. Select web application. For IIS 7.0 and newer versions- Go to Applications Settings section and add the following key value pair, to avoid conflicts in application names: key = apminsight.appname value = (Use this name in configuration file). For IIS version 6.0, open the web.Config file and edit section as follows: ... Save the web.Config Repeat the steps for all applications to be monitored. Changes to be made in Agent configuration Go to the APM Insight .NET Agent installation folder. Open DotNetAgent folder. Open apminsight.conf file and edit the following keys: use.apminsight.appnames=true (default is false) use.app.filters=true (default) include.app.names= (Note: provide the app names exactly as given in the appSettings section) Copy this apminsight.conf file and paste it in the following locations : %WINDIR%\ProgramData\DotnetAgent\x64 (for 64-bit agent) %WINDIR%\ProgramData\DotnetAgent\x86 (for 32-bit agent) For Windows server 2003, the corresponding path will be in %WINDIR%\Documents and Settings\All Users\Application Data\DotNetAgent\x64 (for 64- bit agent) %WINDIR%\ProgramData\DotnetAgent\x86 (for 32-bit agent) In case of multimonitors, all sub folders in the above locations. Restart the .NET Agent windows service to effect changes. Transaction Grouping Configuration Steps for .NET Agent Open Edit configuration window, select Transactions Merge tab. Add transaction patterns you want to merge. See grouping transaction with pattern sample here (refer samples here). Steps to perform transaction merge pattern configurations manually Go to the APM Insight .NET Agent installation folder after installing the agent. Open DotNetAgent folder. Open transaction_merge_patterns.conf file and add the patterns as mentioned here (refer samples here). Copy this transaction_merge_patterns.conf file and paste it under %WINDIR%\ProgramData\DotnetAgent\ directory. For Windows server 2003, the corresponding path will be under %WINDIR%\Documents and Settings\All Users\Application Data\DotNetAgent\ directory. In case of multi-monitors, all sub folders for every application in the above locations. We can add, remove or comment the patterns at any point of time in the configuration file. Transaction Merge Pattern Samples The below pattern will match with all transactions which start with aspsite/account/ and it will be renamed as account. aspsite/account/*=account The below pattern will match with all transactions which start with aspsite/ and end with /basicdetails. They will be renamed as basicdetails. aspsite/*/basicdetails=basicdetails The above pattern will match with all transactions which end with /educationdetails and it will be renamed as educationdetails. */educationdetails=educationdetails  Background Transactions Applications Manager allows users the ability to monitor background processes and other jobs running within the web application. Background trace threshold - You can enable the APM Insight agent to track the background transactions happening in the application server. It will collect traces of slow background transactions. Background transactions are considered to be slow, if it crosses the configured Background trace threshold.Sampling counter - For example, if you specify the Sampling Factor value as 5, the agent will track one in 5 background transactions. Use .NET agent API for Custom Instrumentation APM Insight .NET Agent API helps to track the user defined methods in a web application. It helps instrument specified methods in the web application DLLs for monitoring its performance. It can also be used to track specific parts of code. Steps to Add the API 1. Add a reference to the library DotNetAgent.Api.dll to your web application project. 2. The API dll is available in the API Manager Tool installed location (C:\Program Files (x86)\APM Insight\APM Insight.NET Agent\AgentApi\DotNetAgent.Api.dll). Note: For Agent below v2.3, locate the API dll from,(C:\Program Files\APM Insight\APM Insight .NET Agent ( )\AgentApi\DotNetAgent.Api.dll). 3. The API contains a class named CustomTracker to track the performance of a method. CustomTracker Class and its Methods   Constructors CustomTracker(Type thisType) thisType - The type of current class or base class. eg: CustomTracker dotNetAgentCustomTracker = new CustomTracker(this.GetType());> CustomTracker(Type thisType, string methodName) thisType - The type of current class or base class. methodName - The name of the method to be monitored. eg: CustomTracker dotNetAgentCustomTracker = new CustomTracker(this.GetType(),"BasicDetails"); CustomTracker(Type thisType, string className, string methodName) thisType - The type of current class or base class. className - The name of the class to be monitored. methodName - The name of the method to be monitored. eg: CustomTracker dotNetAgentCustomTracker = new CustomTracker(this.GetType(), "EmpController", "BasicDetails"); CustomTracker.StartTracker (Type thisType, string className, string methodName) This method is used to start the metric collection for the custom method. It is not required as it is called in constructor itself. CustomTracker.StopTracker() The metric collection will be stopped on calling this method. Always call it in a finally block. 4. Create an instance of CustomTracker class at the beginning of a method and invoke StopTracker() at the end of the method. 5. We can create CustomTracker instance with using{} block. The StopTracker() method will be called when disposing object automatically. The following examples show the usage of this CustomTracker: Example 1: Using the "using" statement: public ActionResult BasicDetails(int id = 0) { AdminBL objadmin = new AdminBL(); using(CustomTracker customTracker = new CustomTracker(base.GetType(),"BasicDetails")) {     ASPSite.BL.MYSQLReference.BasicDetails basicDetails = objadmin.getBasicDetails(id);       EmpApp.Models.BasicDetails basic = getBasicDetailsModel(basicDetails);       return View(basic);      } } Example 2: Using StartTracker and StopTracker within a try finally block: public ActionResult BasicDetails(int id = 0) {     CustomTracker customTracker = null;     AdminBL adminBL = new AdminBL();     try      {         customTracker = new CustomTracker(base.GetType(),"BasicDetails");         ASPSite.BL.MYSQLReference.BasicDetails basicDetails = adminBL.getBasicDetails(id);        EmpApp.Models.BasicDetails basicDetailsModel = getBasicDetailsModel(basicDetails);      }     finally     {     customTracker.StopTracker();     } return View(basicDetailsModel); } Example 3: Using CustomTracker to Instrument part of a code. public ActionResult BasicDetails(int id = 0) {       AdminBL adminBL = new AdminBL();       using(CustomTracker customTracker = new CustomTracker(base.GetType(),"BasicDetails"))     { //Instrumenting part of a code. To check the time taken by the function FetchAllEmployees and the SQL calls made from this function. using(CustomTracker fetchAllEmpTracker = new CustomTracker(base.GetType(),"FetchAllEmployees"))           {      FetchAllEmployees();             } ASPSite.BL.MYSQLReference.BasicDetails basicDetails = objadmin.getBasicDetails(id); EmpApp.Models.BasicDetails basic = getBasicDetailsModel(basicDetails); } return View(basicDetailsModel); }  Note: If the method name or class name is not given in the CustomTracker, it will attempt to get the current method name and class name by itself. The StartTracker() method will be called in constructor by default. If the agent not installed or the agent service stopped the invoked methods will have no effect. Diagnostics tool APM Insight .Net monitoring also features a diagnostics tool called HealthMonitor.exe. It monitors the health of the agent running in the server. The Health monitor is a self diagnostic tool, intended to provide a snapshot of the agent settings, for identifying and troubleshooting frequently encountered configuration issues in the agent. It is available, as a feature, from APM Insight .NET agent version 1.8 and above. It can be found in the start menu under "APM Insight .NET Agent" folder. Click the button on the left bottom corner of the tool to collects logs and creates a zip file for better troubleshooting and support. Troubleshooting with APM Insight .NET Agent HealthMonitor With the HealthMonitor, you can: Create Diagnostic zip file - The HealthMonitor captures all agent logs, and other system information, necessary to analyze the issue by the support team. You also have the option to append event log information. To include event logs, along with the diagnostic zip, run HealthMonitor.exe (found in Installation directory\HealthMonitor folder) via command prompt with "eventlogs" option. This requires administrative privileges. View Service settings - The Agent service mode (i.e., single/multi- instance), APM agent service status (running/stopped) and log level. Check Network connectivity - For successful communication, the APM Insight agent must be able to connect to server(s). Check Application filters - If application filters are applied, verify if the applications running are monitored. Refer Application Filters guide. Monitor worker processes - If no worker processes are shown as running, perform a transaction and retry.  Note : In Agent below v2.3, If worker processes are still not counted, then it could be due to the bitness of the agent. APM Insight agent and the worker processes should have the same bit. (i.e., 32-bit agent for 32-bit applications, and 64-bit agent for 64-bit applications). Verify monitor status - The status of the monitor (i.e., Managed/UnManaged/Deleted/LicenseExpired etc) will be displayed, under the monitor name. For a single instance, only one monitor will be listed. For multiple instances, all the monitors created by the agent would be listed. Verify profiler status - In order to successfully instrument the IIS applications, the profiler must be loaded into the worker process. If the loading fails, an IIS Reset must be performed to re-load the profiler. Also, ensure that some other profiling agents are not installed in the same machine (i.e. there can be only one active profiler in a machine).Note: In case of issues, please ensure that some transactions are done when the agent log level is "DEBUG" before creating the diagnostics zip. This would help us narrow down the issue quicker. To include event logs, along with the diagnostic zip, select the ''Event logs'' check box below ''Create Diagnotics zip file'' button. This requires administrative privileges. Agent Performance Report APM Insight .NET Agent is optimized for minimal impact on the application. To understand about the resource utilization of .NET Agent, refer here. Frequently Asked Questions (FAQ) If you face problems during the installation or the .NET Agent, go to our .NET Agent FAQ page for troubleshooting tips. APM Insight .NET Agent - Custom Instrumentation Manager Tool APM Insight .NET Agent Custom Instrumentation Manager is a configuration tool specifically designed for custom instrumentation released as part of the .NET agent version 2.5.4 and above. It helps in configuring a web application''s methods (framework methods as well as user defined ones) for instrumentation in just a few clicks. It is designed to: Give you visibility into your own application DLLs by showing the necessary classes and its methods. Help you configure custom instrumentation methods like adding or removing methods and renaming component for each method. Recycle running application pools for custom instrumentation to take effect. Installing Custom Instrumentation Manager tool Custom Instrumentation Manager is bundled with .NET Agent MSI and will be installed along with the agent. For details on downloading and installing the agent, check out the installation instructions. In the feature selection page, ensure that Custom Instrumentation feature is selected for installation. Working with Custom Instrumentation Manager Tool From the Windows Start menu or Start screen (Windows 8/Windows Server 2012), launch the Custom Instrumentation Manager tool. Load an application DLL from the bin directory of a web application. The below image shows loading a DLL.Choose required methods / classes or even entire assemblies from left pane and add it to the right pane for monitoring. The number of methods selected will be shown at the bottom. The component names can be set by editing the component text box individually. Alternatively select a group of components, right click and select "Set Component Name" option to assign a component for multiple methods. Click the Save button. After saving, the status bar will show a message "Recycle the application pools to take effect". Note that the message appears only when one or more w3wp processes are running.Clicking "Recycle App pools", recycles the running application pools without resetting IIS. This can be used to avoid application downtime. The notification message will disappear after recycling app pools. Thats it! In the next polling interval, the selected web application methods will be tracked and listed in the Traces tab in Applications Manager client. The added methods will be displayed along with the text [custom]. Note: There is no need to restart IIS for using this tool. It can be done when the application is running without suffering downtime. Windows Desktop Application Monitoring Monitor your stand-alone Windows desktop applications developed in the .NET platform with the APM Insight .NET agent from Applications Manager. Gain visibility into your console applications as well as the performance of your method calls. How it works In general, the APM Insight .NET agent monitors .NET applications hosted in IIS Servers. By default, contextual information is instrumented and reported for HTTP requests from these applications'' web transactions.  Since Windows desktop and console applications don''t communicate via HTTP requests, their default methods are monitored with the help of custom instrumentation to track their application performance.  With the help of Custom Instrumentation Manager, you can monitor exceptions, database calls, web service calls, and third-party packages like loggers, caching, and NoSQL calls. To view the performance of each individual transaction, use Custom Instrumentation Manager to add additional methods from application-dependent dynamic-link library (DLL) files. Configuration instructions Log in to your Applications Manager account, then go to APM Insight tab and download the .NET Agent. For details, refer these installation instructions. After installing the agent, select the Enable windows desktop application monitoring checkbox in the Edit configurations dialogue box, then click Save.Open the application configuration file for the Windows application that you want to monitor. In the application configuration (app.config) file , enable custom instrumentation by adding the following code under : Add a new key named apminsight.enabled and set the value as true. Add a new key named apminsight.appname and specify its value as the name of the application you wish to monitor. Here is sample code for these two steps:                   Save the application configuration file. Load the corresponding EXE version of the file in Custom Instrumentation Manager and select which Windows application process methods you want to add. To monitor more methods, add the corresponding DLLs of desktop or console apps in Custom Instrumentation Manager.Restart the application. Output To view the output of monitored methods, navigate to APM Insight → DOTNET application → Transactions → Recent 5 Traces of this Transaction → Trace details. Windows Service Performance Monitoring Monitor the performance of your Windows services developed in the .NET platform with the APM Insight .NET agent from Applications Manager. Analyze the method calls of your Windows services and enhance their performance. How it works In general, .NET web applications hosted in IIS servers will have contextual information instrumented with their HTTP requests. These requests are also reported as web transactions. Windows services, on the other hand, don''t have HTTP requests, meaning that default methods like OnStart, Run, OnPause, OnContinue, OnStop, OnSessionChange, OnShutdown, and other similar service methods can be monitored using Custom Instrumentation Manager. By adding methods to Custom Instrumentation Manager, you can monitor the performance of exceptions, database calls, web service calls, and third-party packages like loggers, caches, and NoSQL calls. Use Custom Instrumentation Manager to add more methods from service-dependent dynamic-link library (DLL) files, allowing you to view the performance of every individual transaction. Configuration steps Log in to your Applications Manager account, then go to APM Insight tab and download the .NET agent. For details, refer to these installation instructions. In the Edit configuration dialog box—which appears at the end of agent installation—select the Enable windows service monitoring checkbox under the Windows services tab.  Click Save.Windows services developed in .NET will populate a list. Select the services that you want to monitor and click Save. Upon saving, the executable file for corresponding services will be added to Custom Instrumentation Manager. Use the services.msc console to restart each of the Windows services from this list. You can now view the monitors you added from the Applications Manager web client and the basic methods of these services will now be tracked. If you want to monitor any dependent DLL methods for particular service processes, just add them using Custom Instrumentation Manager. View the performance of each your services'' executed methods under the Traces tab. View the status of your Windows service monitors using the Health Monitor. This tool also provides the status of monitors and Windows services. Note: Whenever you make any changes to Windows services in Edit configurations, you must manually restart the modified services. Add additional service-dependent DLLs to Custom Instrumentation Manager to track the performance of methods. Only services developed in .NET will be shown in Edit configurations. Agent Performance Report for APM Insight .NET Agent Test Environment Impact on Application Response Time Impact on CPU usage Impact on Memory consumption Impact on Network usageSupported Environments Test Environment OS: Windows 2012 R2 CPU: Single core, Shared Memory: 1.75 GB IIS version: 8.5 Version: .NET 4.0 Duration of test: 2 hrs Avg no of requests per min: 500 Impact on application''s Response Time The APM Insight .NET Agent only instruments framework methods by default, and hence the overhead on response time is minimal. On an average, the response time variation due to the agent is around 30 ms. The response time variation during peak response times was around 500 ms. The same is summarized below: RESPONSE TIME SUMMARY Without Agent With Agent Average Response time (ms) 4820.85 4853.21 Peak Response time (ms) 14465 15079 Impact on CPU usage With the default production settings, the APM Insight .NET Agent does not consume more than 5~10 % CPU on average (using default production settings). The CPU usage depends mainly on the number of methods instrumented (using custom instrumentation) and the log level (default is CRITICAL). The maximum consumption will be during the application startup or domain creation, since it involves initializing profiler and loading .NET Agent''s libraries. Once initialized, the average overhead due to .NET Agent, remains at around 5% in addition to the normal CPU usage of the web application. CPU Usage Without Agent With Agent Average usage (%) 32.78 39.58 Impact on Physical Memory (RAM) usage The APM Insight .NET Agent by default collects performance data and pushes it to its own service, every minute, and hence, the footprint on the user memory is minimal, and only transient. The important thing to note here is that the memory consumption is directly proportional to the number of data collected in a minute, and so, decreasing the sampling factor or transaction trace threshold comes at a cost of increased RAM usage. However, with the default production settings, (sampling factor=5, trace threshold=2 sec, sql trace threshold=3 sec) the memory will not exceed 90 MB, even during peak load. The below table summarizes the details. MEMORY USAGE Without Agent With Agent Average Working Set (MB) 228.11 292.56 Peak Working Set (MB) 314.81 390.62 Impact on Network usage APM Insight .NET Agent collects and sends data to the Applications Manager servers once every minute. The data collected is sent in 2 requests, as arh/data - for apdex and response time metrics. The maximum size of this request is around 40 kb. arh/trace - for stack trace and exception metrics. The maximum size of this request is around 4 MB. It is to noteworthy to mention that the amount of data sent depends on the number of unique web transactions and errors that occur within 1 minute, up to a maximum of 250 transactions. With an average load of 500 requests per minute, with an APDEX of 0.975 and an average error rate of 2%, the average network usage is around 800 kb per minute. Supported EnvironmentsAll APM Insight .NET agents support the following environments: Windows Server 2003 and above IIS 6.0 and above .NET 2.0 and above APM Insight .NET Agent Configuration Options This page should help you tune the configuration for APM Insight .NET agent configuration profile. The .NET agent configuration profile enables you to set threshold values for key parameters and web transactions. These settings can be configured in apminsight.conf file or from the web client (represented by ). Make sure that this file is present in the folder where you have deployed the APM Insight agent. Browse through the following topics to view the agent configuration profile for the respective categories of .NET: DOTNET Configuration profile DOTNET SERVICE Configuration profile DOTNET DESKTOP Configuration profile DOTNET Configuration profile The .NET agent configuration profile is categorized into three parts: Basic configuration profiles Web transaction configurations Background transactions configurations Basic configuration profiles Name Key Description Default value Enabling this option will listen to all Capture SQL Queries which gets executed. database SQL sql.capture.enabled True Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate SQL transaction.trace.sql.parametrize Disabling this option will give you True Parameters the real query (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will collect the threshold for stacktrace whenever any sql query transaction.trace.sql.stacktrace.threshold 3(seconds) SQLs in executed above this threshold time transaction trace value. Port number of application instances Display Instance show.instance.port.number will be shown, if this option is True Port number enabled.Logging level apminsight.log.level The log level at which the APM CRITICAL Insight agent should record information. Supported levels are SEVERE,WARNING, INFO and FINE. Web transactions of the specified URL patterns will be skipped while tracking *.css, *.js, List of URL *.gif, *.jpg, extensions to be Use comma(,) to separate multiple *.jpeg, transaction.skip.listening skipped from entries *.bmp, tracking Example: *.png, transaction.skip.listening=*.jpeg, *.ico will skip listening to transactions ending with .jpeg List of exceptions to be Enter the list of exceptions that need exceptions.ignore None skipped from not be tracked. tracking Provide regex patterns or transaction Skip names that can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Web transaction configurations Name Key Description Default value Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores Apdex 0.5 apdex.threshold values below the apdex.threshold value, Threshold (seconds) the transaction is labeled as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 5 transaction.tracking.request.interval factor (request) If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace Enable for Slow Transactions. transaction transaction.trace.enabled True tracing You can view the traces collected in APM Insight Page by selecting Traces tab. Transaction transaction.trace.threshold Trace of any transaction whose response 2 tracing time scoring above the specified (seconds)threshold threshold value will be collected, provided if transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. Capture Trace snapshot will be taken for all HTTP trace if request(s) which has total external external component.trace.threshold components (like MYSQL, MEMCACHED, 30 (Count) calls etc) call count equal or higher than the exceeds configured number. Enabling this option captures parameters of all GET & POST web requests To skip capturing specific parameters use Capture webtransaction.trace.input.params.ignore HTTP webtransaction.trace.input.params.record False key parameters? Captured parameters can be viewed by selecting the required transaction in Traces tab To skip capturing specific web request parameters like password, PIN or any confidential values, specify those parameter names for this key List of HTTP password, parameters webtransaction.trace.input.params.ignore Use comma(,) to separate multiple entries. authKey to ignore Values specified for this key are case- sensitive If no value is specified, all request parameters will be recorded Capture Captures the parameters sent in the HTTP webtransaction.trace.request.headers.record http(s) headers (both GET & POST), if this False headers?  option is enabled. The values of these parameters in the List of http(s) headers (both GET & POST) will be Request webtransaction.trace.request.headers.ignore ignored from tracking. Sensitive and None headers to confidential keys like Cookie, Host and ignore others should be mentioned here. Capture Captures the Custom parameters which Custom custom.parameters.record are defined in your application code, if this False Parameters? option is enabled. Capture Record CPU time for every HTTP request, if cputime.capture.enabled False CPU Time? enabled. cpu time will get collected whenever any CPU Time cputime.threshold transaction cpu consumes above this 60% threshold threshold value Background transaction configurations Name Key Description Default value Enabling this option, APM Insight agent Track starts tracking background transactions background bgtransaction.tracking.enabled True transactions All transactions other than HTTP are considered as background transactions Capture bgtransaction.trace.enabled Enabling this option, the agent collects True traces traces for slow background transactions,provided bgtransaction.tracking.enabled is set to true Traces will be collected for background Transaction transactions whose response time have 2 trace bgtransaction.trace.threshold crossed the specified threshold value, (seconds) threshold provided bgtransaction.trace.enabled is set to true Sampling factor for background transactions Sampling 5 bgtransaction.tracking.request.interval factor If value is set to 1, agent tracks every (Request) transaction. If value is set to n, agent tracks 1 in n transactions of same kind Track Web Enabling this option will collect background Services as bgtransaction.enable.web.services False web service transaction background DOTNET SERVICE Configuration Profile Basic configuration profiles Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will threshold for collect the stacktrace SQLs in transaction.trace.sql.stacktrace.threshold whenever any sql query 3(seconds) transaction executed above this trace threshold time value. Display show.instance.port.number Port number of True Instance application instances will Port number be shown, if this option is enabled.The log level at which the APM Insight agent should Logging record information. apminsight.log.level CRITICAL level Supported levels are SEVERE,WARNING, INFO and FINE. List of exceptions Enter the list of to be exceptions.ignore exceptions that need not None skipped be tracked. from tracking Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Sampling factor helps in tracking sampled Sampling transactions. transaction.tracking.request.interval 5(request) factor If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified threshold value Transaction will be collected, 2 tracing webtransaction.trace.external.components.count.threshold provided if (seconds) threshold transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. Trace snapshot will be taken for all HTTP Capture request(s) which has total trace, if external components (like component.trace.threshold 30 external call MYSQL, MEMCACHED, exceeds etc) call count equal or higher than the configured number. Capture CPU Record CPU time for every cputime.capture.enabled False Time? HTTP request, if enabled. cpu time will get collected whenever any CPU Time cputime.threshold transaction cpu 60% Threshold consumes above this threshold valueDOTNET DESKTOP Configuration profile Basic configuration profiles Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will threshold for collect the stacktrace SQLs in transaction.trace.sql.stacktrace.threshold whenever any sql query 3(seconds) transaction executed above this trace threshold time value. Port number of Display application instances will Instance show.instance.port.number True be shown, if this option is Port number enabled. The log level at which the APM Insight agent should Logging record information. apminsight.log.level CRITICAL level Supported levels are SEVERE,WARNING, INFO and FINE. List of exceptions Enter the list of to be exceptions.ignore exceptions that need not None skipped be tracked. from tracking Skip transaction.skip.patterns Provide regex patterns or None Transactions transaction names that can be skipped from tracking. Multiple entriesshould be comma separated values. Sampling factor helps in tracking sampled Sampling transactions. transaction.tracking.request.interval 5(requests) factor If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified threshold value Transaction will be collected, 2 tracing webtransaction.trace.external.components.count.threshold provided if (seconds) threshold transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. Trace snapshot will be taken for all HTTP Capture request(s) which has total trace, if external components (like component.trace.threshold 30 external call MYSQL, MEMCACHED, exceeds etc) call count equal or higher than the configured number. Capture CPU Record CPU time for every cputime.capture.enabled False Time? HTTP request, if enabled. cpu time will get collected whenever any CPU Time cputime.threshold transaction cpu 60% Threshold consumes above this threshold value APM Insight .NET Agent Components Supported The following list of components are supported in APM Insight .NET agent. Internal Components: ASPX (Active Server Page Extended) MVC (Model - View - Controller) External Components: Web Service Calls ASMX (Active Server Method Extended) WCF (Windows Communication Foundation)Web API (Web Application Programming Interface) Database Calls Enterprise Library Microsoft SQL Server Microsoft SQL Server Compact (SQL CE) MySQL OLE DB Oracle PostgreSQL Mem Cache and No SQL Cassandra Redis (Service Stack and Stack Exchange Provider) Queue Microsoft Message Queuing (MSMQ) Others DATAUPLOAD  FILEUPLOAD  OWIN (Open Web Interface for .NET) Web Requests Backup and Restore .NET Agent Configuration In general, the APM Insight .NET agent can be installed in multiple load balanced servers. The same agent configurations like standalone app filters, Windows service apps filters, and more can be applied across all servers to replicate the same configurations. But if you have hundreds of servers, it may be difficult to replicate the same configuration for each server. In these cases, you can take the backup configuration from one server and restore it in rest of the servers using the APM Insight Health Monitor tool. Backup of configurations Restore of configurations Backup of configurations To take a backup of configuration via application, follow the steps given below: Open the Health Monitor tool, and navigate to the Tools tab.Click on Back Up Configuration and a file named DotNetAgentConfigBackUp.zip will be created in the desired location. The Backup file will contains the configurations of the dotnetAgent and it will be used to restore the configuration to the multiple servers. Restore of configurations The configuration file can be restored in two ways: Restore via application Restore via Command Line Restore via application Note: Make sure to install the latest version of .NET agent before proceeding. Copy the DotNetAgentConfigBackUp.zip file to the new server location where it is to be installed. Open the Health monitor tool, and navigate to Tools tab.Click Restore Configuration and load the DotNetAgentConfigBackUp.zip file. This will automatically restart the agent service. Restart the Windows Service and standalone apps manually to take full effect. Restore via Command Line In case if you have not installed the agent across your servers, you can install the agent and restore the configurations via command line. This eliminates the need to install the agent and then install the health monitor across all agents. The installing agent will take the configurations automatically from the back up file and install with those defined configurations. We can also make a batch script to execute the same in hundreds of servers to reduce the agent configuration work in application servers. Copy the DotNetAgentConfigBackUp.zip file to the new server where the agent needs to be installed. Place the configuration backup file in the same location as the agent MSI. Use the below command to install the agent MSI while restoring the configurations. C:\> msiexec -i apminsight-dotnetagent.msi configbackupfile=DotNetAgentConfigBackUp.zip Restart the Windows Service and standalone apps manually to take full effect. View method type (GET / POST) in web service calls APM Insight has the ability to track the ASP.NET web service calls like ASMX, WCF, or Web API frameworks. The service calls will be displayed along with its method type like GET, POST, PUT, DELETE, etc. It provides the clarity to view the performance of each method on CRUD (Create, Retrieve, Update and Delete) operations in a MVC Web API. For example, consider the CRUD operations below in a ASP .NET Web API. Action HTTP Method Relative URI Get a list of all products GET /api/products Get a product by ID GET /api/products?id=1234 Get a product by category GET /api/products?category=mycategory Create a new product POST /api/products Update a product PUT /api/products?id=1234 Delete a product DELETE /api/products?id=1234The above example shows the Web API CRUD operations performed over the product database. It uses the single API transaction to perform all these operations. With APM Insight, performance of a particular API transaction can be viewed along with its corresponding method type. View method type in request parameters The same GET method will be used for getting the product based on ID or product category. We can also view those transactions separately by the request parameters displayed under the transaction trace summary. Checksum verification You can verify the authenticity of the downloaded agent with SHA256 checksum validation. This ensures that the downloaded agent is credible and is not tampered with by any malicious code or software. For the .NET agent, you can use CertUtil or Get-FileHash to compute a file hash for verifying the checksum with the agent checksum value. To verify the authenticity of the agent: Download the checksum file for .NET agent & .NET Core agent. To check via CertUtil, run the below command via PowerShell or Command Prompt to compute the hash. CertUtil -hashfile SHA256 On successful execution, you will get the following response: SHA256 hash of YOUR_FILENAME: 319fac26e690ddae59f6de7c0600bcf7ec005820039e8da86c7194d62935fb94 CertUtil: -hashfile command completed successfully. To check via Get-FileHash, run the below given command via PowerShell to compute the hash. Get-FileHash -Algorithm SHA256 | Format-List On successful execution, you will get the following response: Algorithm : SHA256 Hash : 319FAC26E690DDAE59F6DE7C0600BCF7EC005820039E8DA86C7194D62935FB94 Path : After computing the hash, kindly verify with the downloaded checksum value. Verify the signature of your agent binaries Right-click on the agent file and select Properties. Navigate to the Digital Signatures tab in the Properties window. The signature will be shown here as seen in the image below:APM Insight .NET Agent - Release Notes .NET v5.4.0 Release Date: 26-10-2021 Issues Fixed There were issues in collecting trace when exception occured irrespective of response time. Standalone app was created as DOTNET_SERVICE when it was spawning from a Windows service. Removed the profiler settings for the windows service and standalone app rather than disabling it during the agent uninstallation. Namespace was not available in Custom instrumentation configuration tool. Security issue fixes. Enhancements Support for Rabbit MQ monitoring. Support for Microsoft SQL Async - collecting database calls only. Support for MongoDB calls. Support for Azure Service Bus calls. Support for ElasticSearch calls. Checksum verification to validate the integrity of the downloaded agent. Showing Stand alone app version and Sorting option in Edit config tool Suffix a request param value in transaction name (Hidden config). Backup and restore config via command line and health monitor tool. Extracting SQL parameter values from parameterized queries. Tracking custom exceptions without modifying the code. Revamped NLog exception tracking. Thread profiling sampling threads count limited to 10 for better performance. Web API application root tracker has been changed for the latest version of WebAPI. Collecting database name in trace. Default log level for profiler will be DEBUG for troubleshooting Collect process specific environment variables in agent diagnostic file Added host collection for PostgreSQL calls for service map. Changing default port from -1 to component specific default port. .NET v4.8.1 Release Date: 28-09-2020 Issues Fixed The ''Create Diagnostic Zip File'' option was not working in Health Monitor tool. (Broken since v4.8.0) .NET v4.8.0 Release Date: 19-08-2020 Issues Fixed Response code metric was not captured at instance-level. Enhancements Enhanced and revamped the Standalone App configuration in the agent configuration tool.Revamped Health monitor tool for collecting diagnostic data. Added inner exception stack trace in exception metric trace. .NET v4.7.0 Release Date: 01-07-2020 Issues Fixed The ''Create Diagnostic Zip File'' option was not working in Health Monitor tool. The APM Insight Monitor for .NET agent goes DOWN and metrics were not being collected, even though the .NET agent service was RUNNING. On restart of .NET agent service, some of the APM Insight .NET instances get re-created under a new APM Insight Application and the existing APM Insight instance goes down. Security critical issue fix in .NET 4.0 applications. Enhancements Modified the image in installation wizard. APM Insight Ruby on Rails Agent Applications Manager''s Ruby agent deployed on a Rails platform gives you end-to-end web-transaction awareness enabling you to isolate performance issues and resolve them quickly. Applications Manager requires a monitoring agent (ruby gem) to be deployed in your application server to monitor Ruby application performance. Download the latest Ruby Agent and deploy it in your application server. The agent collects application performance metrics and sends it to the central Applications Manager server at fixed intervals i.e. every 60 seconds. Ruby Agent Setup Install Ruby Agent Upgrade Ruby Agent Uninstall Ruby Agent Note: Do not install the APM Insight Agent along with other Application Performance Management (APM) tools. The APM Insight Agent installation may fail if there are other APM products installed in the same environment. Agent Configurations Ruby Agent Configuration Grouping Similar Transactions Custom instrumentation and exception tracking Troubleshooting: For troubleshooting tips, go to our Support Portal. Install APM Insight Ruby on Rails Agent Supported Environments Ruby - 1.8.7 and higher Rails - 3.0 and higher Sinatra - 1.4.0 and higherSteps to install APM Insight Ruby On Rails Agent For Heroku applications For all other applications For Heroku applications In Applications Manager APM tab > Help Card > copy the License Key present there. Download the the appropriate APM Insight Ruby on Rails Agent file (apminsight.gem) from here. Copy this file to your application home directory. Open ''Gemfile'' in text editor, add gem ''apminsight''. Execute ''bundle install'' to install the dependencies. Push these changes to your project repository (differs based on your deployment method). Go to Heroku> your application > settings > Config variables, add the following variables LICENSE_KEY = Enter your License Key APM_APPLICATION_NAME = Enter your application name Deploy the application in Heroku. For all other applications In Applications Manager APM tab > Help Card > copy the License Key present there. Ruby Agent installation can be done in two ways: Install from rubygems.org by using the following command gem install apminsight Download the the appropriate APM Insight Ruby on Rails Agent file (apminsight.gem) from here and run the command: gem install {path}/apminsight.gem For Rails environment: Add the following line into Gemfile gem ''apminsight'' Bundle it to your application by executing command bundle install For Sinatra environment: Add the following line into Gemfile gem ''apminsight'' If you are not using Bunde.require in your application, add the line to your application file require ''apminsight'' Once the gem is installed in your respective environment, copy the configuration file apminsight.conf from  /apminsight/conf/ directory to application home directory Open the apminsight.conf file in any text editor and update the mandatory configurations keys such as adding application.name, apm.host, apm.port, license.key etc in there. To learn more about the Ruby agent configurations, visit our Configuration Guide page.Restart the application server Note: To check if the agent is installed correctly, use the command gem list. This command will list all the installed gem in the machine. Check if the apminsight gem file is included in the list. Upgrade APM Insight Ruby on Rails Agent There are two methods using which the Ruby agent can be upgraded: Update Gem from rubygems.org Update Gem from appmanager.com Update Gem from rubygems.org Go to the application home directory, execute command bundle update apminsight to update to the latest version of the Ruby agent. Update Gem from appmanager.com Download the latest agent APM Insight Ruby on Rails Agent gem from here. Execute command gem install \apminsight.gem  Go to application home directory, execute command bundle update --local Note: 1. Customers upgrading to Applications Manager 14440 or above must upgrade their Ruby Agent from version 1.0.0/1.0.1 to 1.8.1 or above. 2. While upgrading Ruby Agent from version 1.0.0/1.0.1 to 1.8.1 or above,  the following keys in apminsight.conf file needs to be updated:           a. license.key value from Applications Manager web client APM tab > Help Card > License Key needs to be added.           b. apm.host value needs to be changed to https:// :  or http:// : after upgrade. Example 1: license.key=APMI_e448c81fe4927e0495e868124c7d345c2c2f0012f4796b154f4b1827fe56d119 apm.host=https://localhost:8443/ Example 2: license.key=APMI_e448c81fe4927e0495e868124c7d345c2c2f0012f4796b154f4b1827fe56d119 apm.host=http://localhost:9090/ Visit Configuration Guide page for more details. Uninstall APM Insight Ruby on Rails Agent Execute command gem uninstall apminsight Remove or comment gem ''apminsight''  in Gemfile file in application directory Execute command bundle update Ruby Agent Configuration Options This page should help you tune the configuration for APM Insight Ruby agent configuration profile. The APM Insight Ruby agent configuration profile enables you to set threshold values for key parameters and web transactions. These settings can be configured in apminsight.conf file or from the web client (represented by ). Make sure that this file is present in the folder where you have deployed the APM Insight agent. Basic configuration profiles Name Key Description Default valueEnabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will threshold for collect the stacktrace SQLs in transaction.trace.sql.stacktrace.threshold whenever any sql query 3(seconds) transaction executed above this trace threshold time value. Port number of Display application instances will Instance show.instance.port.number True be shown, if this option is Port number enabled. List of *.css, *.js, exceptions Enter the list of *.gif, *.jpg, to be exceptions.ignore exceptions that need not *.jpeg, skipped be tracked. *.bmp, from *.png, *.ico tracking Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Apdex apdex.threshold 0.5 Application Performance Threshold (seconds) Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.orgIf any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 1 transaction.tracking.request.interval factor Transaction If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Trace of any transaction whose response time scoring above the specified threshold value Transaction will be collected, tracing webtransaction.trace.external.components.count.threshold provided if 2 (seconds) threshold transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. APM Insight Ruby on Rails Agent: Checksum Validation You can verify the authenticity of the downloaded AppManager agent with SHA256 checksum validation. This ensures that the downloaded agent is credible and is not tampered with by any malicious code or software. To verify the authenticity of the agent: Download the checksum file here. Compare the checksum value provided in the apminsight.gem.sha256 file with the downloaded agent. Follow the steps below to validate the checksum value. For Linux systems, execute the following command sha256sum apminsight.gem For Windows, you can use either of the commands below: Open Command Prompt and execute the following command:certutil -hashfile apminsight.gem SHA256 Open Command Prompt and execute the following command: Get-FileHash apminsight.gem -Algorithm SHA256 After executing the commands, you will obtain a checksum value; check that value with the one downloaded from the checksum file. Sample Output: APM Insight Ruby Agent - Release Notes Ruby Version 1.8.3 Release Date: 29-04-2021 Enhancements Checksum Verification to validate the integrity of the downloaded agent. Issues Fixed Agent Initialization failure due to failure of server connection. Grouping Similar Transactions Dynamic Transaction names are becoming more familiar with lots of applications, making it difficult to actually track the performance of the application. Dynamic transactions are web transactions within an application having single URL but get appended with unique alpha numeric identifiers every time they are invoked, making the web transaction name itself look different. Tracking such individual URLs is a herculean task. Here, this feature of grouping similar transactions, will help to group these dynamic transactions into the actual URL that needs to be monitored. Configuration Steps Create a new file named "transaction_merge_patterns.conf" in the directory where apminsight.conf file resides in your application. Open the file in any text editor and specify key value pairs as per syntax given below Regular expression of URLs=new_name_to_be_assigned Start or restart the rails server, all transactions performed from now, will use the above defined patterns to merge the transactions Example: ruby/shop/item/laptops/.*=shop/laptops ruby/shop/item/.*/dell/.*=shop/item/dell .*/cart/purchase=shop/purchase Custom Instrumentation and exception tracking APM Insight Ruby Agent is capable of identifying default methods and classes from multiple application frameworks. The agent automatically tracks identified methods and additional metrics, but, in some cases, performance data on these methods may not be enough to debug issues. When you need additional application- specific information to resolve an issue, you can use our API to collect application-specific metrics.Track additional methods By default, the Ruby Agent only captures framework classes like Controllers, DB queries, and Views. You can use custom instrumentation to monitor other application-specific methods. To get started, specify the methods to be instrumented in the application initializer, as shown below. Then create a new file named instrumentation.rb under config/initializers/. This gives you in-depth details to troubleshoot and debug issues with your applications. Syntax: require ''agent/api/custom_tracker'' MyClass.class_eval do include ::APMInsight::API::CustomTracker     track_method :my_method1     track_method :my_method2 end Example: require ''agent/api/custom_tracker'' ProjectsController.class_eval do include ::APMInsight::API::CustomTracker     track_method :get_internal end Tracking exceptions via the API The APM Insight Ruby Agent is capable of capturing exceptions occurring in known framework methods. However, the agent can''t track user-defined exceptions occurring in your application. In such cases, you can use the agent API to push exception data to Applications Manager server via the agent.  First, add the API in the application wherever necessary. Once the app server is started, the agent will capture the exceptions when they occur, automatically associate them with the current transaction, and push those exceptions to Applications Manager servers. This helps you track all exceptions from one place. Syntax: require ''agent/api/custom_tracker'' Example: require ''agent/api/custom_tracker'' ... # Other declarations and definitions def find_value begin .... # some instructions rescue => ex APMInsight::API::CustomTracker.trackException(ex) .... # rescue operations end end APM Insight PHP Agent PHP agent deployed on Web Server gives you end-to-end web-transaction awareness enabling you to isolate performance issues and resolve them quickly. To monitor your PHP application performance, you will need to deploy the APM Insight PHP agent onto your web server. The agent collects application performance metrics and sends it to Applications Manager server every 60 seconds. Requirements: PHP 5.3 to 7.4, Linux OS 64 bit (except Alpine OS) and Windows. Webservers supported: IIS, Apache2, NGINX or any other FPM based webserver. Frameworks supported: Codeigniter, CakePHP, Laravel, Drupal, Joomla, WordPress, Magneto, Syfony. Databases supported: MS SQL, Oracle, Cassandra, MySQL drivers, SQLite, PostgreSQL and PDO based DB queries.Note: For Windows, supported PHP versions are 5.3 to 7.4 and supported web server is IIS For Linux, supported PHP versions are 5.3 to 7.4 PHP Agent Setup Install PHP Agent for Linux Install PHP Agent for Windows Uninstall PHP Agent for Linux Uninstall PHP Agent for Windows Note: Do not install the APM Insight Agent along with other Application Performance Management (APM) tools. The APM Insight Agent installation may fail if there are other APM products installed in the same environment. Agent Configurations PHP Agent Configuration Group Similar Transaction Agent Performance Report APM Insight PHP Agent is optimized for minimal impact on the application. To understand about the resource utilization of PHP Agent, refer here. Installing APM Insight PHP Agent in Linux To install APM Insight PHP agent in Linux operating system, follow the below given instructions: Instructions for installation using script Instructions for manual installation Instructions to install in Docker Automatically restart agent during service reboots Instructions for installation using script In Applications Manager web client, go to APM tab and copy the License Key present in the helpcard. Download the APM Insight PHP Agent agent Linux file (agent_php.zip) from the download page to the required Linux server. Start by logging into root. Extract the agent_php.zip file into /opt directory. This will create a sub-directory called zpa. $ cd /opt $ wget https://www.manageengine.com/products/applications_manager/54974026/agent_ph p.zip $ unzip agent_php.zip Navigate to zpa/bin directory and execute the command: $ cd zpa/bin $ sudo sh configure.sh [LICENSE KEY] [HOSTNAME] [APPLICATION NAME] where, [LICENSE KEY] - License key from Applications Manager. (mandatory) [HOSTNAME] - Hostname of the PHP application. (mandatory) [APPLICATION NAME] - Monitor name to be shown in the Applications Manager console. By default, it is set to PHP-Application. (optional) Open the apminsight.conf file available in the zpa/conf directory and include the following keys: For PHP agent versions below 2.9.3:apm.host=[HOST-NAME] apm.port=[HOST-PORT] use.https=[true/false] For PHP agent versions 2.9.3 and above: apm.host=[HOST-NAME] apm.port=[HOST-PORT] apm.protocol.https=[true/false] Example: For PHP agent versions below 2.9.3: apm.host=localhost apm.port=8443 use.https=true For PHP agent versions 2.9.3 and above: apm.host=localhost apm.port=8443 apm.protocol.https=true After including the required keys, save and close the file. Restart your PHP agent using the following command: $ sh run.sh restart Restart your web server / FPM server using the following commands: #For Apache servers, $ sudo service apache2 restart #For FPM servers, $ sudo service php-fpm restart How to verify if the installation is successful: After the installation, go to the terminal and execute the following command: $ php -m | grep zpa The output should contain zpa. Note: The agent does not restart automatically during server reboots. To start, stop or restart the agent, use the following commands: $ cd /opt/zpa/bin #Start the agent $ sh run.sh start #Stop the agent $ sh run.sh stop #Restart the agent $ sh run.sh restart #For systemd supported OS, use the following command to restart: $ service zpdpsvc restartInstructions for manual installation If PHP is installed using third-party managed services, like cPanel/WHM, or if the PHP path is not set properly during the installation, you might get the following message: PHP is not found in PATH. Kindly install PHP or add PHP installation directory to PATH! In these cases, you can retry the installation after setting the correct PHP directory in the PATH variable, or you can proceed to configure the agent manually, using these steps: Download the agent using the following command: wget https://www.manageengine.com/products/applications_manager/54974026/agent_php. zip Verify the integrity of the downloaded agent using checksum validation. Move the agent under /opt/ directory and extract the contents of the downloaded file. This will create a directory zpa/ under /opt/. sudo unzip -d /opt/ agent_php.zip Find your PHP API version, using the following command. There should be a corresponding zpa.so file in the /opt/zpa/lib directory for the respective API version. Eg., zpa20131226.so for API version 20131226. php -i | grep "PHP API" # Example output PHP API => 20131226 Find your PHP''s ini configuration path. This is the path where dynamically loaded extension configurations are added. Copy the /opt/zpa/bin/zpa.ini to this location. php -i | grep "Scan this dir" # Example output # Scan this dir for additional .ini files => /opt/cpanel/ea-php56/root/etc/php.d/ cp /opt/zpa/bin/zpa.ini /opt/cpanel/ea-php56/root/etc/php.d/zpa.ini Note: Use this step, only when the output in step 4 in this section is not configured. In case the ini configuration path is not set, the extensions must be configured in the php.ini file directly. Add the following line to php.ini near the end of the file. extension=zpa.so Find your PHP''s extension directory. This is the path where extension libraries are loaded. Copy the respective zpa.so file for the API version obtained from step 3 in this section. php -i | grep "extension_dir" # Example output # extension_dir => /opt/cpanel/ea-php56/root/usr/lib64/php/modules cp /usr/lib/php/zpa20131226.so /opt/cpanel/ea-php56/root/usr/lib64/php/modules/zpa. so Restart your web servers. If you are running Apache, restart apache/httpd service. If you''re running nginx/fpm based servers, restart the php-fpm services. # For Apache2 (Debian) sudo service apache2 restart # For Apache2 (RHEL/CentOS) sudo service httpd restart # For nginx/fpm based servers. sudo service php-fpm restart Verify if the agent is successfully loaded using the following command. The output should contain zpa. php -i | grep zpa #Example output #zpa #zpa.version => 3.0.2 #zpa.date => 7 May 2021 #zpa.capture_clirequest => 1 => 1 #zpa.capture_httphost => 0 => 0 #zpa.capture_phpself => 0 => 0To start communicating with Applications Manager, add the Applications Manager license key to apminsight.conf file under /opt/zpa/conf/. Place the license key value in the line beginning with license.key= ################### APM Insight Agent Configuration File ################### # license.key= # Navigate to /opt/zpa/bin directory and start the agent service by executing the following command: cd /opt/zpa/bin sudo sh run.sh start # To verify the status # ps -ef | grep zpdp To make sure the agent is restarted during system reboots, you can register the agent as a service. Alternatively, you can use rc.local or cron task to ensure agent is started during system reboots. Instructions to install in Docker While creating container images, add these commands to the Docker files used for image creation as follows: RUN cd /opt/ && wget https://www.manageengine.com/products/applications_manager/54974026/agent_php.zip RUN unzip agent_php.zip RUN cd /opt/zpa/bin && sh configure.sh RUN sh run.sh start Whenever the container is started, make sure zpdpsvc is restarted using the following command (under /opt/zpa/bin directory) sh run.sh start Automatically restart agent during service reboots To automatically restart APM Insight PHP agent during system reboots, use the below given steps: For systemd servers: The agent will automatically start during server reboots for systemd supported Linux flavors. For non systemd servers: Edit the /etc/rc.local file Add the following lines to the rc.local: cd /opt/zpa/bin sh run.sh restart and save that file Installing APM Insight PHP Agent in Windows To install APM Insight PHP Windows agent in Applications Manager, follow the below given instructions: In Applications Manager web client, go to APM tab and copy the License Key present in the help card. Download the APM Insight PHP Agent agent msi file from the download page. Start the installer and follow the steps given in the installation wizard. Enter the copied License key (displayed in the APM tab) when prompted and proceed with the installation. After installation is complete, open the apminsight.conf file available in the \APM Insight PHP Agent\zpa\conf directory and include the following keys: For PHP agent versions below 2.9.3: apm.host=[HOST-NAME] apm.port=[HOST-PORT] use.https=[true/false]For PHP agent versions 2.9.3 and above: apm.host=[HOST-NAME] apm.port=[HOST-PORT] apm.protocol.https=[true/false] Example: For PHP agent versions below 2.9.3: apm.host=localhost apm.port=8443 use.https=true For PHP agent versions 2.9.3 and above: apm.host=localhost apm.port=8443 apm.protocol.https=true After including the required keys, save and close the file. Execute an iisreset command manually after implementing the above changes. Generate traffic on the server and check the data collected in the APM Insight console. Uninstalling APM Insight PHP Agent in Linux To uninstall your APM Insight PHP agent in Linux, carry out the following instructions: Go to zpa/bin directory and execute $ sh configure.sh uninstall Restart the web server Uninstalling APM Insight PHP Agent in Windows To uninstall your APM Insight PHP agent in Windows, carry out the following instructions: Access the Control Panel in your Windows machine. Go to Programs and Features, right click on APM Insight PHP Agent and select Uninstall. Follow the instructions to complete uninstallation.  Note: Uninstalling agent requires Administrator rights in your windows admin group. The agent related configuration files and logs will be deleted automatically PHP Agent Configuration Options The APM Insight PHP Agent Configuration file helps you fine tune the configuration for tracking web based transactions. These settings can be configured in apminsight.conf file or from the web client (represented by ). Make sure that the apminsight.conf file is present in the folder where you have deployed the APM Insight agent. Editing the configuration settings These settings can be configured using the edit option available in the web client.The APM Insight agent configuration profile is categorized into two methods: PHP configuration profile Configurations available only in apminsight.conf file PHP configuration profile Basic configuration profile Name Key Description Default value Enabling this option will listen to all SQL Queries Capture which gets executed. database sql.capture.enabled True SQL Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate Disabling this option will SQL transaction.trace.sql.parametrize True give you the real query Parameters (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Port number of Display application instances will Instance show.instance.port.number True be shown, if this option is Port number enabled. Logging apminsight.log.level The log level at which the WARNING level APM Insight agent should record information.Supported levels are SEVERE,WARNING, INFO and FINE. Provide regex patterns or transaction names that Skip can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the Apdex apdex.threshold value, 0.5 apdex.threshold Threshold the transaction is labeled (seconds) as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. transaction.tracking.request.interval 3(requests) factor If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Transaction webtransaction.trace.external.components.count.threshold Trace of any transaction 2 tracing whose response time (seconds) threshold scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true. The trace can be used toanalyze, troubleshoot the transaction working. Configurations available only in apminsight.conf file Certain configuration files cannot be modified from the client. These settings can be configured in apminsight.conf file. Name Configuration Description Default value Specify the desired Application''s Name to show in Applications Manager. Application application.name If there are multiple instances of your application and you would like True Name to group them, then specify the same application name in all installed APM Insight Agent Configuration files. Example: myonlineshopping.com The API Key for the corresponding user. This will be available in the APM Insight home page, after login. License key license.key * none Copy and Paste the Key as value for this parameter. This key is user specific. Do not share with anyone else. Specify whether the Agent installed Application Server is under a proxy network. If set True, Proxy credential information should be given in order to send the metric data from the agent to Applications Manager. Configure If behind.proxy is set to true, specify values for the following keys: behind.proxy False Proxy proxy.server.host: Host name of the proxy server proxy.server.port: Proxy server''s port proxy.auth.username: User name of the proxy server proxy.auth.password: password for the proxy server Specify the port number in which your application is running on the Agent agent.server.port server. 80 Server Port * Each port number ios treated as an individual instance and will be grouped under the same application name. * Mandatory values. If any of these entries are not provided or invalid, the agent cannot be initialized/started. However, the application server (where the agent is deployed) will start normally. Grouping Similar Transactions Dynamic Transaction names are becoming more familiar with lots of applications, making it difficult to actually track the performance of the application. Dynamic transactions are web transactions within an application having single URL but get appended with unique alpha numeric identifiers every time they are invoked, making the web transaction name itself look different. Tracking such individual URLs is a herculean task. Here, this feature of grouping similar transactions, will help to group these dynamic transactions into the actual URL that needs to be monitored. Configuration Steps Create a new file named "transaction_merge_patterns.conf" in the directory where the apminsight.conf exists. Open the file in a text editor and add the key value pairs as per the syntax provided below Regular expression of URLs/web transaction=new name to be assignedApplication server restart is required for the changes to be effective. APM Insight PHP agent - Checksum Validation You can verify the authenticity of the downloaded APM Insight agent with SHA256 checksum validation. This ensures that the downloaded agent is credible and is not tampered with by any malicious code or software. To verify the authenticity of the agent, follow the steps given below: Download the checksum file for Windows or Linux. Compare the checksum value provided in the downloaded file with the downloaded agent. Follow the steps below to validate the checksum value: For Linux systems, execute the following command: sha256sum agent_php.zip For Windows, you can use either of the following commands: Open Command Prompt and execute the following command: certutil -hashfile agent_php.msi SHA256 Open Windows Powershell and execute the following command: Get-FileHash agent_php.msi -Algorithm SHA256 After executing the commands, you will obtain a checksum value. Check that value with the one downloaded from the checksum file. Sample Output: Note: If the checksum values differ, do not unzip or open the file. Agent Signature Verfication All the agent files are signed with a Zoho Corp. certificate. To verify the signature, follow the steps below: Note: Downloading the PGP key for the signature file verification is important. Without the PGP key, the verification may not be successful. Download the Applications Manager PHP agent public key (appmgrphp.pub) file. It should be similar to the following output.Import the public key to your trusted keystore (use .pub or .asc to save the aforementioned key). "gpg --import appmgrphp.pub"  [or] "gpg --import appmgrphp.asc" Download the signature file (agent_php.zip.sig) and verify the downloaded zip with its signature. "gpg --verify agent_php.zip.sig agent_php.zip" Agent Performance Report for APM Insight PHP Agent Test Environment Impact on CPU usage Impact on Memory consumption Impact on binary data processing Impact on Application Response Time Test Environment OS: 64 bit Linux OS CPU: Intel i5, 2.5 Hz, 4 cores Memory: 8 GB Apache Web Server Impact on CPU usage When the target web application is set to receive 300 requests per minute, the APM Insight PHP Agent consumes only 1 % CPU on average (using default production settings). On increasing the throughput to 600 requests per minute, the APM Insight PHP agent consumes around 0.3-1.6% CPU on average. The below table summarizes the details RPM (Requests per Minute) % CPU Usage (Without Agent) % CPU Usage (With Agent) 300 0.1-0.2 0.1-1.2 600 0.6-1.9 0.9-3.5 Impact on Physical Memory (RAM) usage The APM Insight PHP Agent by default collects performance data and pushes it to its own service, every minute, and hence, the footprint on the user memory is minimal, and only transient. The memory usage is a maximum of 212 KB at an RPM of 300, and a maximum of 24 KB at an RPM of 600. The below table summarizes the details: RPM (Requests per Minute) Memory in KB (Without Agent) Memory in KB (With Agent) 300 6344-8852 6360-9064 600 6360-9856 6364-988 Impact on binary data processingThe above statistics are for agents running on an Apache web server. To understand how much memory and CPU the agent will consume when processing binary data, please see the below table. RPM (Requests per Minute) % CPU Usage Memory (KB) 300 0.1-0.3 4740-6012 600 0.3-0.7 4740-6104 Impact on application response time To calculate how fast php execution is, many use a PHP Benchmark script provided by http://www.php- benchmark-script.com/ The following table shows the impact of PHP agent''s on your application''s response time. PHP version: 7.2.23-1+ubuntu18.04.1+deb.sury.org+1 Platform: Linux Benchmark Version 2.8 Version 2.9 No Agent test_ifelse 1.446 sec 0.805 sec 0.763 sec test_loop 1.911 sec 1.520 sec 1.511 sec test_stringmanipulation 5.793 sec 3.065 sec 3.031 sec test_math 4.578 sec 2.633 sec 2.569 sec total 13.728 sec 8.023 sec 7.874 sec APM Insight PHP Agent - Release Notes PHP Version 3.1.1 Release Date: 13-10-2021 Issues Fixed SSL errors in agent communication. Error in grouping similar transaction. Enhancements Support for Oracle database. Support for MSSQL database. Support for Cassandra database. Support for monitoring applications developed in PHP version 8.0 for Linux. Support for thread safe PHP versions - ZTS/XAMPP (Version 7.0 and above). CLI Requests can be tracked with their script names. Domain names can be tracked in transactions. Application name & Hostname can be passed as an argument. Checksum verification to validate the integrity of the downloaded agent. PHP Version 2.9.3 Release Date: 16-07-2020 Issues Fixed ''Segmentation fault core dumped'' issue caused agent to crash while using PHP 7.2. Memory leak issues. Enhancements Support for PHP version 7.4. Support for PostgreSQL database instrumentation.Support for instrumenting ''Mysql_real_connect'' type of database connection calls. APM Insight NodeJS Monitoring Overview Node.js is becoming one of the most sought-after platform for building various scalable web and mobile applications quickly. NodeJS monitoring tools like Applications Manager''s APM Insight allows you to monitor, troubleshoot and diagnose performance issues by providing code-level visibility of your Node.js applications, and captures every transaction that occurs over all the tiers of your Node.js'' architecture. In this help document, you will learn how to get started with Node.js monitoring by installing the APM Insight Node.js agent in Applications Manager. Requirements: Node.js version 4 and above Frameworks supported: Express Databases supported: MySQL, PostgreSQL, Microsoft SQL, MongoDB Nodejs Agent Setup and Configuration Install Nodejs Agent Uninstall Nodejs Agent Node.js Agent Configuration Configure custom directory for agent logs Custom Instrumentation Release Notes Install APM Insight Node.js Agent To install APM Insight Node.js agent, follow the below given instructions: Note: The below given instructions work only for APM insight Node.js agent versions above 1.7.2. For APM Insight agent versions 1.7.2 and below, refer here. In Applications Manager web client APM tab > Help Card > copy the License Key present there. Download the APM Insight Node.js Agent file (apm_insight_agent_nodejs.zip) from the download page and extract it in the Node.js server. Open your Node.js application. Access the node packet manager (NPM). Use the following command to install an APM Insight Node.js agent from NPM. npm install /agent_minified Example: npm install /users/joe/agent_minified If you want to deploy APM Insight agent to all the Node.js applications on the computer, use the global option via -g flag. npm install -g /agent_minified Example: npm install -g /users/joe/agent_minified This will create an APM Insight directory under node_modules.   Create a new file named apminsightnode.json in the same directory as your application start file. Add the below code snippet in the file: {   licenseKey : ''[LICENSE-KEY]'',  appName : ''[APPLICATION-NAME]'',   port : [APPLICATION-PORT],   apmHost: ''[APM-HOST-NAME]'',   apmPort: [APM-SSL-PORT] } Example: {   licenseKey : ''APMI_ee42094f83dd841d16b9c56796c22b63bef00ac6918f547280947d1f6c2be1 ea'',   appName : ''APMInsight_NodeJSapp'',   port : 3000,   apmHost: ''localhost'',   apmPort: 8443 } If you use proxy connections, enter this code instead: {   licenseKey : ''[LICENSE-KEY]'',   appName : ''[APPLICATION-NAME]'',   port : [APPLICATION-PORT],   apmHost: ''[APM-HOST-NAME]'',   apmPort: [APM-SSL-PORT]   proxyServerHost : ''[PROXY-SERVER]'',   proxyServerPort : [PROXY-PORT],   proxyAuthUser : ''[PROXY-USERNAME]'',   proxyAuthPassword : ''[PROXY-PASSWORD]'' } Include the following code in the first line of your Node.js application start file. If using Common JS: require(''apminsight'')() If using ES: import apminsight from ''apminsight''; apminsight.config() Save the file and restart your application. Note: The APM Insight Nodejs Agent is incompatible with other profiling tools, such as running the node process with the debugger mode (--inspect switch). If your application uses the cluster module, place the require statement in both the master and worker processes. If you are unable to add application port in apminsightnode.json file, you can add it in your application start file as mentioned below: require(‘apminsight’) ( {port: } ) However other parameters like license key and app name should be added only in apminsightnode.json file. You can also set configuration values like license key, app name, and port as environment variables using the following license keys: License key - APMINSIGHT_LICENSE_KEY App Name - APMINSIGHT_APP_NAME Port - APMINSIGHT_APP_PORT APM Host - APMINSIGHT_APM_HOST APM Port - APMINSIGHT_APM_PORTFor APM Insight agent versions 1.7.2 and below: We highly recommend you to download the lastest version of APM Insight Node.js agent. But if you are looking to download agent verison 1.7.2 and below for some specific reasons, refer the below given steps: In Applications Manager web client APM tab > Help Card > copy the License Key present there. Download the APM Insight Node.js Agent file (apm_insight_agent_nodejs.zip) from the download page and extract it in the Node.js server. Open your Node.js application. Access the node packet manager (NPM). Use the following command to install an APM Insight Node.js agent from NPM. npm install /agent_minified Example: npm install /users/joe/agent_minified If you want to deploy APM Insight agent to all the Node.js applications on the computer, use the global option via -g flag. npm install -g /agent_minified Example: npm install -g /users/joe/agent_minified This will create an APM Insight directory under node_modules.   Include the following code in the first line of your Node.js application source code, before any other require statement. Replace the variables with the values for your setup.  require(''apminsight'')({   licenseKey : ''[LICENSE-KEY]'',   appName : ''[APPLICATION-NAME]'',   port : [APPLICATION-PORT],   apmHost: ''[APM-HOST-NAME]'',   apmPort: [APM-SSL-PORT] }) Example: require(''apminsight'')({   licenseKey : ''APMI_ee42094f83dd841d16b9c56796c22b63bef00ac6918f547280947d1f6c2be1 ea'',   appName : ''Insight_NodeJS'',   port : 3000,   apmHost: ''localhost'',   apmPort: 8443  }) If you use proxy connections, enter this code instead: require(''apminsight'')({   licenseKey : ''[LICENSE-KEY]'',   appName : ''[APPLICATION-NAME]'',   port : [APPLICATION-PORT],   apmHost: ''[APM-HOST-NAME]'',   apmPort: [APM-SSL-PORT]   proxyServerHost : ''[PROXY-SERVER]'',   proxyServerPort : [PROXY-PORT],   proxyAuthUser : ''[PROXY-USERNAME]'',   proxyAuthPassword : ''[PROXY-PASSWORD]'' }) Save the file and restart your application. Uninstall APM Insight Node.js AgentTo uninstall APM Insight Node.js agent, follow the below given instructions: Remove require(''apminsight''); as the first line of the app''s main module. Access the node packet manager (NPM). Remove the npm package with npm uninstall apminsight --save. After the uninstall process finishes, restart your application. Node.js Agent Configuration Options The APM Insight Node.js Agent Configuration file helps you fine tune the configuration for tracking web based transactions. These settings can be configured from the web client. Basic configuration profiles Web transaction configurations Background transactions configurations Basic configuration profiles Name Key Description Default value Enabling this option will listen to all Capture SQL Queries which gets executed. database SQL sql.capture.enabled True Queries If this option is disabled, no Database Metrics will be collected. Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Obfuscate SQL transaction.trace.sql.parametrize Disabling this option will give you True Parameters the real query (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace Enabling this option will collect the threshold for stacktrace whenever any sql query transaction.trace.sql.stacktrace.threshold 3(seconds) SQLs in executed above this threshold time transaction trace value. Port number of application instances Display Instance show.instance.port.number will be shown, if this option is True Port number enabled. The log level at which the APM Insight agent should record Logging level apminsight.log.level information. CRITICAL Supported levels are SEVERE,WARNING, INFO and FINE. List of URL transaction.skip.listening Web transactions of the specified *.css, *.js, extensions to be URL patterns will be skipped while *.gif, *.jpg, skipped from tracking *.jpeg, tracking *.bmp,Use comma(,) to separate multiple *.png, entries *.ico Example: transaction.skip.listening=*.jpeg, will skip listening to transactions ending with .jpeg Provide regex patterns or transaction Skip names that can be skipped from transaction.skip.patterns None Transactions tracking. Multiple entries should be comma separated values. Web transaction configurations Name Key Description Default value Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the Apdex apdex.threshold value, 0.5 apdex.threshold Threshold the transaction is labeled (seconds) as Satisfied. If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. Sampling factor helps in tracking sampled Sampling transactions. 1 transaction.tracking.request.interval factor (request) If set to 5, APMInsight tracks only 1 in 5 requests of the same kind Enabling this option will construct Trace for Slow Enable Transactions. transaction transaction.trace.enabled True You can view the traces tracing collected in APM Insight Page by selecting Traces tab. Transaction transaction.trace.threshold Trace of any transaction 2 tracing whose response time (seconds) threshold scoring above thespecified threshold value will be collected, provided if transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. Trace snapshot will be taken for all HTTP Capture request(s) which has total trace if external components (like 30 external webtransaction.trace.external.components.count.threshold MYSQL, MEMCACHED, (Count) calls etc) call count equal or exceeds higher than the configured number. Web transaction Trackers with resp time tracker webtransaction.tracker.drop.threshold less than this threshold 10(ms) drop will be dropped threshold Background transaction configurations Name Key Description Default value Enabling this option, APM Insight agent starts tracking Track background transactions background bgtransaction.tracking.enabled True transactions All transactions other than HTTP are considered as background transactions Enabling this option, the agent collects traces for slow Capture background transactions, bgtransaction.trace.enabled True traces provided bgtransaction.tracking.enabled is set to true Traces will be collected for background transactions whose Transaction response time have crossed the 5 trace bgtransaction.trace.threshold specified threshold value, (seconds) threshold provided bgtransaction.trace.enabled is set to true Trace snapshot will be taken for Capture background transactions which trace if has total external components 50 external  bgtransaction.trace.external.components.count.threshold (like MYSQL, MEMCACHED, etc) (Count) calls call count equal or higher than exceeds the configured number. Capture Record CPU time for every CPU time bgtransaction.record.cputime.enabled background transaction, if False per enabled. transaction? Capture Memory allocated for Memory background transactions will allocation bgtransaction.record.memory.allocation.enabled False be captured, if this option is per enabled. transaction?Sampling factor for background transactions Sampling 1 bgtransaction.tracking.request.interval If value is set to 1, agent tracks factor (Request) every transaction. If value is set to n, agent tracks 1 in n transactions of same kind APM Insight Node.js Agent custom logs directory For Node.js applications, you can configure your own directory for your agent logs. To do so, configure the directory path of your logs in the first line of your node.js application startup file. Pass the complete path in the logsDir key. The log directory path varies based on the platform. For Windows, logs directory format should include double backslash in path separator. For Linux, single forward slash will be used as the path separator. Example: In Linux, require(''apminsight'')({     licenseKey : ''APMI_ee42094f83dd841d16b9c56796c22b63bef00ac6918f547280947d1f6c2be1e a'',     appName : ''Insight_NodeJS'',     port : 3000,     apmHost: ''localhost'',     apmPort: 8443,     logsDir: ''/Users/learn/logs'' }) In Windows, require(''apminsight'')({     licenseKey : ''APMI_ee42094f83dd841d16b9c56796c22b63bef00ac6918f547280947d1f6c2be1e a'',     appName : ''Insight_NodeJS'',     port : 3000,     apmHost: ''localhost'',     apmPort: 8443,     logsDir: ''C:\\users\\logs'' }) APM Insight Node.js agent - Custom instrumentation for Node.js applications Applications Manager''s APM Insight Node.js agent captures incoming web requests like http, https, http2, and other similar ones by default. To gain more granularity, you can use the custom instrumentation APIs to analyze specific transactions or code blocks in your applications. To use custom instrumentation in your Node.js applications, you must have the APM Insight module installed. Use the below command to load the APM Insight module into your application: var apminsight = require(''apminsight'') Following are the list of APIs that are used to analyze various transactions/code blocks in your applications: Monitor web/background transactions Monitor custom components Track handled errors Instrument app parameters Track custom parametersMonitor web/background transactions By default, incoming web requests are automatically collected by the agent and displayed under the ''Web Transactions'' in ''Transactions'' tab. However, other client-server communications, like socket connections, are not monitored by the agent. Also, it does not monitor background transactions by default. With the help of APIs, you can monitor, customize or skip various web or background transactions. Below are the list of APIs that can be used to instrument web/background transactions: Instrument web transactions Instrument background transactions Change/customize transaction name Ignore transactions End transaction API Note: When you instrument web or background transactions, they must be followed by the End transaction API. Instrument web transactions Using this API, you can monitor web transactions by instrumenting them as below: Syntax apminsight.startWebTransaction(txnName, handler) txnName : string value handler : handler is the function, that will be executed once txn is created Example var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); var io = require(''socket.io'')(http); /* this request will be collected automatically*/ app.get(''/'', function(req, res){ res.sendFile(__dirname + ''/index.html''); }); /*need to use custom instrumentation for socket communication*/ io.on(''connection'', function(socket){ apminsight.startWebTransaction(''/message'', function(){ doSomething() ........ apminsight.endTransaction(); }); }); http.listen(3000);   Instrument background transactions Using this API, you can monitor background transactions by instrumenting them as below: Syntax apminsight.startBackgroundTransaction(txnName, handler) txnName : string value handler : handler is the function, that will be executed once txn is created Example var apminsight = require(''apminsight''); function doBackground(){setInterval( function(){ apminsight.startBackgroundTransaction(''routine'', function(){ doSomething()......... apminsight.endTransaction(); } }, 5000); } Change/customize transaction name Using this API, you can customize the names of your transaction by instrumenting them as below: Syntax apminsight.setTransactionName(customTxnName) cusTxnName : string value Example var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); /* this request will be collected automatically with txn name /admin*/ app.get(''/admin'', function(req, res){ /* txn name will be changed to /homepage*/ apminsight.setTransactionName(''/homepage''); res.sendFile(__dirname + ''/index.html''); }); http.listen(3000); Ignore transactions Using this API, you can skip transactions from monitoring by instrumenting them as below: Syntax apminsight.ignoreCurrentTransaction() Example var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); var io = require(''socket.io'')(http); app.get(''/logout'', function(req, res){ /* this request will be ignored */ apminsight.ignoreCurrentTransaction(); res.sendFile(__dirname + ''/index.html''); }); http.listen(3000); End transaction API Syntax apminsight.endTransaction()Monitor custom components The agent captures default framework components, classes, and methods. However, user-defined classes and methods can be monitored only by instrumenting them with the following API. These details can be viewed under the ''Traces'' tab. Also, if any transaction involving a database operation is called in the instrumented class or method, those details will be reflected in the ''Database'' tab. Syntax apminsight.startTracker(trackerName, componentName, handler, cb) trackerName : string value componentName : string value handler : handler is the function, that will be executed cb : optional param, if it is present then it will be treated as asynchrous tracker Example Without cb: var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); app.get(''/'', function(req, res){ apminsight.startTracker(''readFile'', ''FS'', function(){ res.sendFile(__dirname + ''/index.html''); }); }); http.listen(3000); With cb: var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); app.get(''/'', function(req, res){ apminsight.startTracker(''readFile'', ''FS'', function(cb){ doSomething()...... cb(); }, function(){ // send response }); }); http.listen(3000); Track handled errors All async I/O errors and unhandled errors are captured by the agent in general. This API helps you to track handled errors. For instance, if you have handled errors using the try-catch method, such errors can be notified via this API, and the notified errors are associated with its corresponding transaction. The captured errors can be viewed under ''Errors'' as well as the ''Traces'' tab. Syntax apminsight.trackError(err) err : Error object Example var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); /* this request will be collected automatically*/app.get(''/'', function(req, res){ try{ fetchAndSendResponse(); }catch(err){ apminsight.trackError(err) sendErrorResponse(); } }); http.listen(3000); Instrument app parameters Using App Parameters, you can monitor important parameters, like the size and frequency of a variable or an operation in your application. To understand how App Parameters work, refer here. incrementCustomMetric This API collects the sum of custom metrics. Syntax apminsight.incrementCustomMetric(metricName, metricValue) metricName : string value metricValue : optional, if it is not present then metric will incremented by 1 Example var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); app.get(''/buy'', function(req, res){ apminsight.incrementCustomMetric(''products'', req.product.count); res.sendFile(__dirname + ''/index.html''); }); http.listen(3000); averageCustomMetric This API collects the average of custom metrics. Syntax apminsight.averageCustomMetric(metricName, metricValue) metricName : string value metricValue : number Example var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); app.get(''/pay'', function(req, res){ apminsight.averageCustomMetric(''amount'', req.amount); res.sendFile(__dirname + ''/index.html''); }); http.listen(3000); Track custom parametersTo give contextual meaning to traces, you can add additional parameters which can help you identify the context of the transaction trace. Contextual metrics can be anything, a session ID, user ID or certain method parameters which can help you identify the specific information about a transaction trace. You can add a maximum of 10 parameters to a transaction trace. These parameters can be viewed under ''Trace Summary''. Syntax apminsight.addParameter("key", value); where, key - Name of the parameter. value - Value of the Parameter. It can be of any type, however, agent converts them to string internally. Example var apminsight = require(''apminsight''); var app = require(''express'')(); var http = require(''http'').Server(app); app.get(''/'', function(req, res){ apminsight.addParameter("User Detail", "APM User"); apminsight.addParameter("User ID", 408); res.sendFile(__dirname + ''/index.html''); }); http.listen(3000); APM Insight Node.js Agent - Release Notes Node.js Version 2.2.2 Release Date: 02-02-2022 Issues fixed There was an issue with data collection of Traces when the datatype of Emitter name was symbol. Node.js Version 2.2.1 Release Date: 25-11-2021 Issues fixed ''Top Error codes'' and ''Transaction Split Up by Error Code'' were missing data in the ''Exceptions'' tab. Validation for the application port is done. Enhancements Support for capturing external HTTP calls using ''request'' module. Support for providing application port (dynamic port) in the application start file. Support for capturing Query Statement when the query is executed by pg-query-stream. Support for providing License key, Agent Port, Host as environmental variables. Security - Agent configuration initialization information moved to new file ''apminsightnode.json'' instead of application startup file. Learn more Support for capturing HTTP params. Support for capturing HTTP Headers Support for viewing the exact URL in ''Traces'' tab. Node.js Version 1.7.2Release Date: 19-08-2020 Enhancements Support for Oracle database instrumentation. Support for Distributed Tracing. Agent dependency package ''https-proxy-agent'' updated to latest version. Added custom parameters to trace. APM Insight .NET Core Agent Installing APM Insight .NET Core Agent Uninstalling APM Insight .NET Core Agent Installing APM Insight .NET Core Agent To install APM Insight .NET Core agent in Applications Manager, follow the steps given below: Download the .NET Core Agent and unzip the agent. Run Powershell in administrator mode and navigate to the location of unzipped agent. Install the .NET Core Agent by executing the below command: ./InstallAgent.ps1 -Destination "[path]" -InstallType "[local|global]" -LicenseKey [licenseKey] where, Destination "[path]" → The location where the agent will be installed. May be an absolute or relative path. Wrapping quotes are also required. InstallType [local|global] → Determines whether the installation will be done locally or globally. Local install is the recommended installation type. LicenseKey [licenseKey] → The license key copied from the Application Manager APM Insight homepage. Example: ./InstallAgent.ps1 -Destination "G:\.NET_Core_Agent" -InstallType "local" -LicenseKey APMI_762cf0800fd41749008b5d73115a6841d8dee7e01fc2f451500d39786b593c39 Open the apminsight.conf file from the destination path in any text editor and include the following keys: apm.host=[HOST]:[PORT] Example: apm.host=app-w8-test:9007 If the Applications Manager sends data through HTTP protocol, include the below line in apminsight.conf file: apm.protocol.https=false Save the file, perform IIS reset and restart your .NET Core application. Note:To Change the .NET Core application name, Navigate to the application publish directory. Create or open the apmapplication.conffile, then add or modify the application name. application.name="[YourApplicationName]" Changing the application name only creates a new host whereas the previous host does not get deleted. Restart the .NET Core application. Uninstalling APM Insight .NET Core Agent To uninstall APM Insight .NET Core agent from application server, follow the below given instructions in that server:Stop the .NET Core applications that are being instrumented. Run Powershell in administrator mode and navigate to the unzipped agent path. Execute the script UninstallAgent.ps1 (Installed Agent directory will not be removed but the agent settings will be removed.) Restart the .NET Core application for the changes to take effect. Reset IIS if the applications are hosted in IIS. Configure Application Filters for .NET Core applications You can exclude select .NET Core applications from being monitored by APM Insight. This will help exclude unwanted applications and result in efficient use of your license. Use the following steps to monitor select .NET Core applications using APM Insight. Note: This is applicable only for applications hosted in IIS. Follow the steps given below to configure application filters: Navigate to the .NET Core agent folder. Open the appfilter.config file in the text editor. Add or modify the app pool name and its corresponding monitor name as shown below. Note: Unlike .NET agent, applications are monitored or excluded based on their application pool name in .NET Core agent. This is why you need to enter the corresponding application pool name. You can also set the same name or a new name by which you want to monitor the app pools in Applications Manager. Save the appfilter.config file. Recycle the application pool or run the RESET IIS command. Perform transactions in the application to view data in the Applications Manager console. Monitor self-contained applications using .NET Core Agent Loader API By default, when you install an APM Insight .NET Core agent, the agent will be loaded along with the .NET dependencies configurations. But in the case of self-contained applications, this is not possible. In these cases, you can install the .NET Core agent, and load it using the agent loader API. To do so, add the loader agent API snippet in the startup file of the .NET Core application. Note: The .NET Core agent should be installed to make it work, as it serves as a helper API to load the agent. Steps: Add the NuGet package into your .NET Core web application/API project. Modify the ConfigureServices method in your Startup.cs file. Insert the following line of code before the AddMvc() method inside the ConfigureServices method: ManageEngine.Middleware.LoadAgent(); Publish and deploy the application. Install the agent as per these instructions. Agent diagnosis tool for .NET Core agentAn agent diagnosis tool can come in handy while troubleshooting Applications Manager''s agent issues in your .NET Core application. It helps you extract basic information like agent logs, event logs, and application-related information for troubleshooting frequently encountered configuration issues in the agent. Follow the steps given below to run the agent: Open PowerShell using Run as administrator. Navigate to the \DotNetCoreAgent\AgentDiagnostics directory. Execute the script AgentDiagnoser.ps1 It will generate the file AgentDiagnostics.zip in the same location. Send the zip file to appmanager-support@manageengine.com for further analysis. Checksum verification You can verify the authenticity of the downloaded agent with SHA256 checksum validation. This ensures that the downloaded agent is credible and is not tampered with by any malicious code or software. For the .NET agent, you can use CertUtil or Get-FileHash to compute a file hash for verifying the checksum with the agent checksum value. To verify the authenticity of the agent: Download the checksum file for .NET agent & .NET Core agent. To check via CertUtil, run the below command via PowerShell or Command Prompt to compute the hash. CertUtil -hashfile SHA256 On successful execution, you will get the following response: SHA256 hash of YOUR_FILENAME: 319fac26e690ddae59f6de7c0600bcf7ec005820039e8da86c7194d62935fb94 CertUtil: -hashfile command completed successfully. To check via Get-FileHash, run the below given command via PowerShell to compute the hash. Get-FileHash -Algorithm SHA256 | Format-List On successful execution, you will get the following response: Algorithm : SHA256 Hash : 319FAC26E690DDAE59F6DE7C0600BCF7EC005820039E8DA86C7194D62935FB94 Path : After computing the hash, kindly verify with the downloaded checksum value. Verify the signature of your agent binaries Right-click on the agent file and select Properties. Navigate to the Digital Signatures tab in the Properties window. The signature will be shown here as seen in the image below:APM Insight .NET Core Agent Components Supported The following list of components are supported in APM Insight .NET Core agent. Internal Components: MVC (Model - View - Controller) External Components: Web Service Calls MVC (Model - View - Controller) Web API (Web Application Programming Interface) Database Calls Microsoft SQL Server Microsoft SQL Server Compact (SQL CE) MySQL OLE DB Oracle PostgreSQL Enterprise Library Others Cassandra CQL Sharp HTTP Client APM Insight .NET Core Agent - Release Notes .NET Core v5.4.0 Release Date: 26-10-2021 Issues Fixed Security issue fixes. Enhancements Support for self-contained applications. Support for .NET Core 3.1 applications. Support for tracking HTTP Headers. Support for .NET 5.0 applications. Support for MySQL Connector. Support for application filters. Support for entity framework core. Added support for configuring instrumentation via portal. Checksum verification to validate the integrity of the downloaded agent. Moved the custom instrumentation configuration file to the application''s publish directory. Enhanced agent diagnose tool for troubleshooting. WebAPI application root tracker has been changed for the latest version of WebAPI.Collecting database name in trace. Revamped the .NET core uninstallation script to remove agent settings completely. Default log level for profiler will be DEBUG for troubleshooting. Collect process specific environment variables in agent diagnostic file. Added host collection for PostgreSQL calls for service map Changed default port from -1 to component specific default port. Custom instrumentation using Web Client By default, APM Insight agent captures all your application transactions, known classes and methods, and web frameworks. In certain cases, methods or frameworks, apart from the default ones, are not captured, so as to minimize the agent overload on the application.  To view all your methods and frameworks and to obtain granularity in your debugging process, you can instrument your custom methods or frameworks - this process, is called as Custom instrumentation. Uses of Custom instrumentation Custom instrumentation can be of great help for the following scenarios: When you want to obtain 100% visibility into all your application methods and frameworks. When you see an ''Uninstrumented block of code'' while checking transaction traces. In such cases, you can instrument the method or class, that was not picked by the agent to check its performance. When the framework is not supported or instrumented by default. For the above mentioned circumstances, you can deploy custom instrumentation.  Note: This method is supported only for Java and .NET Core agents. You can custom instrument your Ruby and Node.js applications via agent APIs.  Also, these configurations are specific to APM Insight applications and this will be applied across all instances. For instance specific custom instrumentation, you can use Java agent API or .NET agent API, depending upon your application platform. How to custom instrument methods, classes, or frameworks? Follow the steps given below to perform custom instrumentation: Log in to Applications Manager web client. Go to APM tab → Your application → Edit APM Insight Application Associates. Enter the following lines of code mentioned below as input in the textbox. You can enter the input either in Text or JSON format. The format for both types are given below: JSON format type: Format: {"Fully qualified ClassName":{"MethodName1" : "ComponentName", "MethodName2" : "C omponentName" }}   Example: { "com.sample.web.tasks.ModelUpdateHandler": { "doHandle": "MODEL_UPDATE", "update": "MODEL_UPDATE" } } Text format type: Format: Fully qualified ClassName : methodNames separated by comma(,) : Component Name   Example: com.sample.web.tasks.ModelUpdateHandler : doHandle,update : MODEL_UPDATE com.sample.web.services.SystemCheck : doCheck, isHealthy :com.sample.web.store.DataModifier : : MODIFIER com.sample.web.utils.FileUtils : : Note: For both JSON and Text type, use the below format for specifying the fully qualified classname: Java classes format - com/appmanager/apminsight/agent/JavaAgent .NET Core classes format - Com.Appmanager.Apminsight.Agent.DotAgent After entering the above lines, click Save. Before and after custom instrumentation Java agent Before: After: .NET Core agent Before: After: APM Insight Agent Configuration OptionsThis page should help you tune the configuration for APM Insight agent configuration profile. The APM agent configuration profile enables you to set threshold values for key parameters and web transactions. These settings can be configured in apminsight.conf file or from the web client (represented by ). Make sure that this file is present in the folder where you have deployed the APM Insight agent. The APM agent configuration profile is categorized into three parts: Basic configuration profiles Web transaction configurations Basic configuration profiles Configuration Description Default Value Specify the desired Application''s Display Name to show in Applications Manager If there are multiple instances of your application and you would like to group them, then specify the same application name in all installed APM Insight Agent Configuration files. application.name* My Application Example: myonlineshopping.com Note: With the APM Insight Java agent, you have the option to configure the application name through JVM arguments instead of configuring it in the apminsight.conf file. Add the following parameter: -Dapminsight.application.name=MyApplication Specify weather the Agent installed Application Server is under a proxy network. If set True, Proxy credential information should be given in order to send the metric data from the agent to Applications Manager. If behind.proxy is set to true, specify values for the following keys: behind.proxy false proxy.server.host: Host name of the proxy server proxy.server.port: Proxy server''s port proxy.auth.username: User name of the proxy server proxy.auth.password: password for the proxy server Specify the HTTP listening port of the Application Server. agent.server.port* It will be useful to distinguish Instances when more than one Application 8080 Server runs in same host.Example: 8080 Directory path where the APM Insight log should be stored. Use forward slash(/) as path separator apminsight.log.dir example: D:/apminsight/   Defaults to the directory where APM Insight agent jar is installed if commented or mentioned incorrectly or unable to create the configured directory. The log level at which the APM Insight agent should record information. apminsight.log.level INFO (level) Supported levels are SEVERE,WARNING, INFO and FINE. Web transactions of the specified URL patterns will be skipped while tracking *.css, *.js, *.gif, *.jpg, transaction.skip.listening Use comma(,) to separate multiple entries *.jpeg, *.bmp, *.png For ex: transaction.skip.listening=*.jpeg, will skip listening to transactions ending with .jpeg Capture database SQL Enabling this option will listen to all SQL Queries which gets executed. true queriesIf this option is disabled, no Database Metrics will be collected. Enabling this option will parametrize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true) Parametrize SQLs in Disabling this option will give you the real query (with parameters). true transaction trace It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. Stacktrace threshold for Enabling this option will collect the stacktrace whenever any sql query SQLs in transaction trace 3 (Second) executed above this threshold time value. Enabling this option agent will automatically download and install the latest Agent Auto-upgrade false available version The following properties are applicable for Applications Manager build 14440 and above URL where the Applications Manager is running. apm.host* If an invalid/ unreachable Applications Manager details is entered, the https://localhost:8443 agent throws a ''Connection Refused'' Exception and will retry until the correct details is entered in apminsight.conf. The license Key for the corresponding Applications Manager. This will be available in the APM tab > Help Card.  Copy and Paste the Key as value for this parameter. license.key*   This key is Applications Manager specific and do not share it with anyone else.  Example:  license.key=APMI_38497e5d7f08c97214db485882372818b854445c98e2927e94 The following properties are applicable for Applications Manager build below 14440 Host Name where the Applications Manager is running. If an invalid/ unreachable host names is entered, the agent throws a ''Connection Refused'' Exception and will retry until the correct host name is apm.host* entered in apminsight.conf. localhost It accepts either the host name or an Ipv4 address Example: mymachine.mydomain.com Specify true if the data to the Applications Manager should be sent through apm.protocol.https HTTPS Protocol. false If false, data will be sent through HTTP Protocol Specify the HTTP Port of the Applications Manager. If apm.protocol.https is true, specify the HTTPS Port. apm.port* If the service is not running in the specified port, the agent throws a  9090 ''Connection Refused'' Exception and will retry until the correct port is entered in apminsight.conf.   Notes: Options marked with a * are mandatory. If any of the mandatory entries are not provided, the Agent cannot be initialized / started. However the Application Server (where the Agent is deployed) will start normally. Any changes to these options will take effect only when the Application Server restarts (except for apminsight.log.level property for the .NET agents which can be changed at Run time as well).Web transaction configurations Configuration Description Default Value Application Performance Index (simply called Apdex) is measurement of an Application''s Performance ranging from 0 to 1. Detailed information about Apdex can be found at www.apdex.org If any transaction response time scores values below the apdex.threshold value, the 0.5 Apdex threshold transaction is labeled as Satisfied. (Second) If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated. If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating. A kind of sampling. If said 20, APM Insight will only track request after every 20 requests of same kind. i.e. it will track 1st, 21st, 41st.. Sampling factor 1 (request) request of its kind. The request count maintained will be reset after every one minute. Enabling this option will construct Trace for Slow Transactions. Enable transaction tracing You can view the traces collected in true Applications Manger APM Insight Page by selecting Traces tab Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if 2 Transaction tracing threshold transaction.trace.enabled is set to true. (Seconds) The trace can be used to analyze, troubleshoot the transaction working. Enabling this option captures parameters of all GET & POST web requests To skip capturing specific parameters use webtransaction.trace.input.params.record false webtransaction.trace.input.params.ignore key Captured parameters can be viewed by selecting the required transaction in Traces tab To skip capturing specific web request parameters like password, PIN or any confidential values, specify those parameter names for this key password, webtransaction.trace.input.params.ignore Use comma(,) to separate multiple entries. authKey Values specified for this key are case-sensitive If no value is specified, all request parameters will be recorded   webtransaction.naming.use.requesturl To display complete URL of web transactions, use webtransaction.naming.use.requesturl=true in the apminsight.conf file. This is a hidden configuration and it''s default value is false.To specify encoding charset when handling application data, use webtransaction.encoding.charset webtransaction.encoding.charset=Windows-   1252 in the apminsight.conf file. It''s default value is UTF-8 APM Insight will use its default factory value, if any invalid value specified for an option. APM Insight Dashboard Overview Monitored Parameters Data clean up & Data Collection Limits Overview The performance of complex, distributed applications can be efficiently monitored only when data is presented in a simple and impactful manner. APM Insight''s customized dashboards help you understand your applications at a single glance! The performance metrics of the applications being monitored in APM Insight is displayed under the APM tab. These metrics include mainly: Application Performance Index (APDEX) Response Time Throughput, etc. Configure Alarms In APM Insight, ''Configure Alarm'' [ ] option is supported at Instance level (and not Application level) and is provided in the Instance page so that we can use it to configure Threshold and Actions. By default, we fetch average data for last 5 minutes while applying threshold for the respective attributes. We can update the 5 minutes interval in apminsight.properties file located under \working\apminsight\conf directory. [Key Name: attribute.update.timeinterval]. Restart required to apply this changes. Enable Reports In APM Insight, ''Enable Reports'' [ ] option is also supported at Instance level (and not Application level) and is provided in the Instance page so that we can use it to enable/disable reports for APM Insight attributes. By default, reports are enabled for all APM Insight attributes (under Setting → Enable Reports → Customer Reports → APM Insight) and can be customized based on requirement. Following are the list of reports that can be generated for APM Insight attributes: Trend Analysis Report At a Glance Report Forecast Report Inventory Report Schedule Reports Availability Report Health Report Attributes ReportNote: Common time zone should be maintained between the Applications Manager server and APM Insight agent-installed server for proper functioning. Monitored Parameters To view detailed performance metrics, click over the corresponding listed instance. The metrics are categorized into six different tabs for better understanding: Monitor Information Overview Transactions Database Traces JVM Exceptions Service Map App Parameters Thread Profiling Monitor Information Category Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Name of the application given Display Name during the time of monitor creation. Type of the agent running on the Agent Type Application particular Application. Total number of hosts for present Hosts on the particular application. Total Number of Instances present Instances on the particular application. Instance Name of the instance given during Display Name the time of monitor creation. Agent Installed Indicates the directory where the Path agent is installed. Last The timestamp when the agent communicated last communicated with the time Application Manager. Type of the agent running on the Agent Type particular instance. Monitor Creation The time at which the monitor was Time created. Indicates the agent version which Agent Version is currently used. The host where the agent is Host running on a particular instance. The port where the agent is Port running on a particular instance. The IP Address of the particular IP Address instance. Operating System where the OS instance of the application is running. OS Version Version of the operating system where the instance of theapplication is running. Architecture of the operating OS Architecture system where the instance of the application is running. Application Runtime Environement version where the Environment application is running. Version Overview The performance metrics of the applications being monitored in APM Insight is displayed under the Overview tab. These metrics include: Category Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core It is a measure of response time based against a set threshold. Satisfied, Apdex Tolerating and Frustrated are the percentage of users under respective category. The average response time Avg. Resp. of transactions for the Time chosen time frame. The number of requests Throughput served per minute for the Application/Instance chosen time frame. information The proportion of error Errors (%) transactions to total for the chosen time frame. The number of exceptions that occurred during the life cycle of transactions for the Exceptions chosen time frame. These are either fatal or warning category. The timestamp at which the Agent Last agent communicated with Communicated APM. Graph Metrics The minimum average value for the corresponding Min parameter for chosen time frame. The maximum average value for the corresponding Max parameter for chosen time frame. The 95th percentile of average values for the 95th Percentile corresponding parameter for chosen time frame. The averaged value for the Average corresponding parameter for chosen time frame. The averaged value for the Average Resp. corresponding response Time time of transaction for chosen time frame. Apdex Score A decimal values between 0 and 1 for instance orapplication for the chosen time frame. The number of requests Throughput served per minute for the (cpm) chosen time frame. The number of occurrences Count for the particular parameter for the chosen time frame. The pattern how a Transaction transaction or exception or Name error code. The value of response time Resp. Time for a transaction. Exception The number of occurrences Count of exception or error code. In addition to the above metrics, you can also view various types of transaction details and represent them as graphs/charts. These include: Graph Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Response time broken by Components Apdex Score Data Throughput Error Count (count) Exception Count Split up by Exception Recent 5 Error Transactions Top 5 Transactions by Resp. Time Recent 5 Exception Traces Transactions The Transactions tab gives you transaction details pertaining to the action that consumes longer time, frequently accessed actions, tier-wise breakdown of transaction response time (Example: JVM, Database, and much more) from the application level down to the individual transaction level. You can also view various transactions that are running as Web Transaction, Background or Errors. Below are the metrics shown in the Transactions tab: Category Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Table Metrics Transaction Name of the transaction Name The Application Performance Apdex Index (APDEX) score of the Score application. The number of transactions that Count are running in the application. The percentage value of the number of errors that have Errors (%) occurred within the application. Avg. The average value of the time Response taken for the transaction to Time respond within the application. Min. The minimum amount of time Response taken for the transaction to Time respond within the application.Max. The maximum amount of time Response taken for the transaction to Time respond within the application. Total The total amount of time taken Response for the transaction to respond Time within the application. The average value of the Avg. CPU amount of time taken by the Time CPU to run the transaction. The number of errors that are of Fatal ''Fatal'' severity. The average amount of bytes Avg. Bytes that are received by that In (KB) transaction within the application. The average amount of bytes Avg. Bytes that are sent from that Out (KB) transaction within the application. The minimum amount of bytes Min. Bytes that are received by that In (KB) transaction within the application. The maximum amount of bytes Max. Bytes that are received by that In (KB) transaction within the application. The total amount of bytes that Total Bytes are received by that transaction In (KB) within the application. The minimum amount of bytes Min. Bytes that are sent from that Out (KB) transaction within the application. The maximum amount of bytes Max. Bytes that are sent from that Out (KB) transaction within the application. The total amount of bytes that Total Bytes are sent from that transaction Out (KB) within the application. Graph Metrics The minimum average value for Min the corresponding parameter for chosen time frame. The maximum average value for the corresponding Max parameter for chosen time frame. The 95th percentile of average 95th values for the corresponding Percentile parameter for chosen time frame. The averaged value for the Average corresponding parameter for chosen time frame. Exception The number of occurrences of Count exception or error code. The number of requests served Throughput per minute for the chosen time (cpm) frame.Apdex The Application Performance Score Index (APDEX) score of the application. The number of transactions that Count are running in the application. The value of response time for a Resp. Time transaction. The average value of the Avg. CPU amount of time taken by the Time CPU to run the transaction. The time in which the Request communication was happened Time for the Trace Response The time taken by the trace to Time complete its execution. The amount of time taken by CPU Time the cpu to respond. Table Metrics - External The total number of external (Recent 5 Traces/Slow Calls call made by the trace. Traces of this Transaction) Exception The total number of exception Count occurred in a transaction. The minimum amount of time SQL Time taken for the transaction to respond within the application. The total number of external Distributed calls made by the trace in Calls various applications. Collection The time in which transaction Time got collected The Application Performance Apdex Index (APDEX) score of the Score application. Average The average value of the time Raw Table Data Response taken for the transaction to Metrics Time respond within the application. Total The total number of Request transactions that are running in Count the application. Number of errors that have Errors occurred within the application. In addition to the above metrics, you can also view all the transaction details and represent them as graphs based on: Graph Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Response time broken by Components Request Throughput Data Throughput App Server Components Split Up Split Up By Execution Event Count Error Count Response time and Throughput broken by Components Event CountNote: You can switch between the graphical or tabular representation of the transaction page using the Graph View and Table View buttons available at the top of the page. Traces The Tracing feature will provide you with insight into individual transactions that are running within your application. Transaction Traces are snapshots of transactions to help you identify performance bottlenecks by drilling down the transactions to pinpoint the cause of trouble. Based on your configuration in apminsight.conf file, the SQL statements executed within the transaction and its stack trace are collected and displayed in tree view. Also, you can view various transactions that are running as Error Traces and Distributed Traces. Tab Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby All Traces Error Traces Distributed Traces Below are the metrics shown in the Traces tab: Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Detailed date and time at which the trace was Start Time started. Name of the transaction on which the trace was Transaction launched. CPU Time The amount of time taken by the CPU to respond. Response The time taken by the trace to complete its Time execution. Avg. Response Average amount of the time taken by the trace when Time run multiple times. The minimum amount of time taken for the SQL Time transaction to respond within the application. External calls Total number of external calls made by the trace. Exception Total number of exceptions occurred in a Count transaction. Bytes In The total number of bytes requested. Bytes Out The total number of bytes responded. Memory Used Total amount of memory used by the trace. Method Count Total number of method calls executed by the trace. Distributed Total number of external calls made by the trace in calls Count various applications. Instance Name of the Instance. By clicking on individual transactions, you get a detailed view of the performance of executions for the selected transaction trace along with the list of internal invocations that were performed within the transaction. Following are the list of metrics that are monitored in this view: Summary Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core HTTP Response code Response code HTTP Method HTTP Method Total calls The Total Number of method calls and thetotal number of external calls executed by the trace. The name of the thread which executes the Thread Name trace. Identifier of the thread which executes the Thread ID trace. The Number of Database Queries Executed No.of DB Queries by the trace.  Slowest Method calls The names of all the components traced and count - Slowest with the slowest being shown first.  Method call  Slowest Method calls The number of times component being and count - Count called. The time duration the component took to Slowest Method calls executed out of the total time that the trace and count - Duration took to execute. Slowest Method calls Percentage value of the duration the and count - Percentage component took to execute. Total External calls The name of all the external call count - External call components. Total External calls The number of times the the external count - Count component being called. Request Parameters The Query String passed in the trace. Following are the list of graphs shown under this tab: Graph Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Slowest Method calls and count Total External calls count Trace Details Tree View: Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Delay The difference between the time taken for the method Time call and the current method call. Exclusive The time taken for the execution of a particular method. The time taken for the command and all its sub Total  command took together to complete. Metric Name of all the action performed by the trace. Components View: Graph Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Components View SQL Statements Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core The time when the SQL query was executed by Timestamp the trace. Execution The total time for the execution of a particular Time method.Query Query which is executed. No.Of The total number of queries executed. Queries Remote (External) Calls Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core External The name of all the external calls executed. calls The number of times the external component being Count called Exceptions Attribute Description Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Time The time at which the Exception occurred. Severity Level of exception  Message Error message when exception occurred. Exception class class name of the exception Stack Trace Stack Trace of the exception  Other traces of this transaction Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core The minimum average value for the corresponding Minimum parameter for chosen time frame. The maximum average value for the corresponding Maximum parameter for chosen time frame.  The averaged value for the corresponding parameter for Average the chosen time frame. 95th The 95th Percentile of the average values for the Percentile corresponding parameters for chosen time frame. Following are the list of graphs shown under this tab: Graph Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Transaction Response time and Throughput Database With APM Insight''s Database feature, you can get detailed performance metrics to identify the slow database calls, database usage and overall performance of the database furnished with detailed graphical and tabular representations. By clicking on individual database operations, you get a list of web transactions that were performed by this particular table, thereby helping you to narrow down and isolate the root cause of performance slowdown. Below are the metrics shown in the Database tab: Table View: Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Database The name of the database operation occurring within Operation the application.Count The number of times that database operation is running in the application. The percentage value of the number of errors that have Errors (%) occurred within the application. Avg. The average value of the time taken for the database Response operation to respond within the application. Time Min. The minimum amount of time taken for the database Response operation to respond within the application. Time Max. The maximum amount of time taken for the database Response operation to respond within the application. Time Total The total amount of time taken for the database Response operation to respond within the application. Time Top 5 Traces in DB The name of the database operation occurring within Transaction the application. SQL Time The amount of time taken for the SQL query to execute. Graph View: Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Response The value of response time for a transaction. Time(ms) The number of requests served per minute for the Throughput(cpm) chosen time frame. The percentage of database operation taken in Split(%) total operation The minimum average value for the Min corresponding parameter for chosen time frame. The maximum average value for the Max corresponding parameter for chosen time frame. The 95th percentile of average values for the 95th Percentile corresponding parameter for chosen time frame. In addition to the above metrics, you can also view all the database operations and represent them as graphs based on: Graph Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Overall Database Response Time and Throughput Database Response Time Database Throughput by Operation Database Operation by caller Database Operation by Response Time Database Operation Throughput JVM Applications Manager''s APM Insight aids you in monitoring your Java application by monitoring your application code that are running on your JVMs. The JVM tab helps you monitor key metrics that are crucial for your Java applications and provides deep insight by visualizing the performance and representing them in tabular and graphical representations, allowing admins to gain visibility of how various resources and system parameters impact the Java application performance. Below are the metrics shown in the JVM tab:Summary Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core JVM CPU This indicates the CPU usage of the JVM on the server. Usage Runtime Returns the total amount of memory in the Java virtual Memory machine. Eden Space - The pool from which memory is initially allocated for most objects. Heap Survivor Space - Pool containing objects that have Memory survived GC of eden space. Tenured Gen - Pool containing objects that have existed for some time in the survivor space. Code Cache - Memory used for compilation and storage of native code. Non- Heap Perm Gen - Holds all the reflective data of the virtual Memory machine itself, such as class and method objects. With JVMs that use class data sharing, this generation is divided into read-only and read-write areas. Just In Memory that is converted to assembler and stored for Time running at higher speed. Compiler JVM Classes Number of Loaded and Unloaded classes. Count Garbage Collector - PS Scavenge & PS MarkSweep Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Live JVM statistics about garbage collector activity like Garbage the number of collected objects and time spend Collector collecting them. Threads Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Peak Peak live thread count since the Java virtual machine Threads started or peak was reset. Live Threads Number of live threads currently running. Daemon Number of daemon threads currently running. Threads Deadlock Number of threads that are in deadlock waiting to Threads acquire object monitors. Configuration Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Up Time The total available time of the instance. Processor The total number of processors available. CountTotal Threads The total number of threads taken by the Instance. Total classes The total no. of classes used by the Instance. General JVM Name Specifies the Java virtual machine name. JVM Version The Java virtual machine version. The input arguments passed to the Java virtual Java machine which does not include the arguments to Arguments the main method. The version of Java class that is used by the system Class Version class loader to search for class files. The Java class path that is used by the system class Classpath loader to search for class files. Library Path The Java library path. The boot class path that is used by the bootstrap Boot Classpath class loader to search for class files. Host OS The name of the operating system. OS Arch The operating system architecture. OS Version The Version of Operating System Memory Heap The amount of heap that the Java virtual machine Initial(MB) initially requests from the operating system in MB Maximum amount of heap that can be used for memory management in MB. This amount of memory is not guaranteed to be available if it is Heap greater than the amount of committed memory. The Maximum(MB) Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size. The amount of non-heap memory that the Java Non-Heap virtual machine initially requests from the operating Initial(MB) system in MB. Maximum amount of non-heap memory that can be used for memory management in MB. This amount of memory is not guaranteed to be available if it is Non-Heap greater than the amount of committed memory. The Maximium(MB) Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size. Up Time The total available time of the instance. Processor The total number of processors available. Count Total Threads The total number of threads taken by the Instance. Total classes The total no. of classes used by the Instance. Exceptions Applications Manager''s APM Insight eases your monitoring needs by providing detailed insights into various exceptions that are occurring within the application. The Exceptions tab helps you identify different types of exceptions and errors that are hindering the performance of your applications with detailed graphical and tabular representations. Below are the metrics shown in the Exceptions tab: Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Top ExceptionsTransaction The name of the exception that has occurred in the Name application. The number of times that exception has occurred in Count the application. Top Error Codes Transaction The name of the error code that has occurred in the Name application. The number of times that error code has occurred in Count the application. Recent 5 Exception Traces Transaction The name of the exception trace that has occurred Name in the application. Exception The number of times that exception trace has Count occurred in the application. Recent 5 Error Transactions Transaction The name of the error transaction that has occurred Name in the application. The name of the error code that has occurred in the Error Code application. In addition to the above metrics, you can also view all the various exceptions occurring within the application and represent them as graphs based on: Graph Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Transaction Split up by Exception Transaction Split up by Error Code Exception Count Error Count   Note: To view reports on the metrics for the APM Insight monitor, click on Reports from the main tab and then select Trend Analysis Report from the list at the left. The following report types are displayed: At a glance Report Downtime History Summary Report of Monitor Service Map Following are the metrics monitored under ''Service Map'' tab. Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Component Monitored applications dependent resources Host Monitored applications dependent resource host Average The average amount of the time taken by the Response Individual component or host Time The number of failed request count by the Individual Failed Request component or host to the application Total Request The number of request count by the Individual Count component or host to the application Throughput The number of requests served per minute for thechosen time frame. Following are the list of graphs shown under this tab: Graph Name Agent / Supported Application Java .NET .NET Core Node.js PHP Ruby Average Response Time Total Response Time Throughput Request Count Count Rate App Parameters Following are the metrics monitored under ''App Parameters'' tab. Category Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Parameter The parameter name provided by the user in Name the application The minimum aggregated value for the Min corresponding parameter on a particular interval. The maximum aggregated value for the Sum Max corresponding parameter on a particular interval The 95th percentile of aggregated values for 95th the corresponding parameter on a particular Percentile interval The aggregated value for the corresponding Total parameter on a particular interval Parameter The parameter name provided by the user in Name the application The minimum average value for the Min corresponding parameter on a particular interval. The maximum average value for the Average Max corresponding parameter on a particular interval The 95th percentile of average values for the 95th corresponding parameter on a particular Percentile interval The averaged value for the corresponding Average parameter on a particular interval Thread Profiling Following are the metrics monitored under ''Thread Profiling'' tab. Category Attribute Description Agent / Supported Application Java .NET .NET Node.js PHP Ruby Core Thread Collection The time in which the demanded thread profiles Time profiling collection for certain duration The number of simultaneous requests Thread handled by the application in a demanded Count durationMin. CPU The minimum amount of time taken by CPU Time to execute application threads in a demanded duration The maximum amount of time taken by CPU Max CPU to execute application threads in a Time demanded duration The average amount of time taken by CPU to Avg. CPU execute application threads in a demanded Time duration Min. The minimum amount of memory allocated Memory for application threads in a demanded (MB) duration Max. The maximum amount of memory allocated Memory for application threads in a demanded (MB) duration Avg. The average amount of memory allocated Memory for application threads in a demanded (MB) duration Identifier of a thread which should be high Thread Id CPU consuming thread High CPU consuming method for selected Method thread The amount of time taken by the CPU to Thread CPU Time execute the selected thread Dump Memory The amount of memory allocated for Allocated selected threads (MB) The method execution count for selected Count thread Data Clean Up & Data Collection Limits Data clean up options and Data collection limits can be set by navigating to Settings -> Performance Polling -> APM Insight. Following are the clean up parameters for which retention period can be set: Parameter Description Maximum Limit Raw Data The number of days for which raw performance data for APM Insight monitors 60 days Retention Period will be retained before clean up. Traces Retention The number of days for which traces data for APM Insight monitors will be 60 days Period retained before clean up. Note: Cleanup schedule Details: Data cleanup happens during every restart of Applications Manager, and subsequently every Sunday at 00:00 hours. Following are the parameters for which data collection limits can be set: Parameter Description Allowed Range (Per Application) Web The maximum number of unique web transactions that can be 350-2000 Transactions stored for an application. Background The maximum number of unique background transactions that can 300-2000 Transactions be stored for an application. The maximum number of exceptions that can be stored for an Exceptions 150-500 application. Database The maximum number of database operations that can be stored 500-1000 Operations for an application. The maximum number of components that can be stored for an Components 200-400 application. App Parameters The maximum number of app parameters that can be stored for an 50-200application. Reference Screenshot:   Note: Please note that increasing the above periods/limits will result in a proportionate increase in database size. Web Transaction Monitoring The Web Transaction page will give you details pertaining to the action that consumes longer time, frequently accessed actions, tier-wise breakdown of transaction response time (Example: JVM, Database, and much more) from the application level down to the individual transaction level. The transactions can be sorted out on the basis of Most Time Consuming , Throughput, Lowest Apdex and Slowest Average Response. Transaction Trace The Transaction tracing feature will provide you with insight into individual transactions. Transaction Traces are snapshots of transactions to help you identify performance bottlenecks by drilling down the transactions to pinpoint the cause of trouble. Based on your configuration in apminsight.conf, the SQL Statements executed within the transaction and its stack trace are collected and displayed in tree view. In the trace page transactions are assembled with various parameters like: Transaction Start Time Transaction Response Time Transaction Average Response Time Database operations With APM Insight you can get detailed performance metrics to identify the slow database calls, database usage and overall performance of the database furnished with detailed graphical and tabular representations. By clicking on individual database operation, you get a list of web transactions that were performed by this particular table, thereby helping you to narrow down and isolate the root cause of performance slowdown. In the Database page you can view all the database operations and represent them as charts based on: Overall Database Response Time and Throughput Database Response Time by Operation Database Throughput by Operation Database operations can be sorted on the basis of: Slowest average response time. Throughput Most time-comsumingNote: You can switch between the graphical or tabular representation of the webtransaction and database operations page using the Graph View and Table View buttons at the right-hand corner of the page. Apdex Score Apdex (Application Performance Index) is an open standard to measure the user satisfaction regarding a web application. It is a metric that provides a single score ranging between 0-1 (0 = no users satisfied, 1 = all users satisfied), giving business application owners an insight into the measure of their customer happiness and satisfaction levels. Easy to calculate and interpret, the data collected over a period of time are converted into a simple index based on the application responsiveness. Application responsiveness is categorized into three zone based on the Apdex score: The value T can be defined by the application owners The Apdex Score is calculated using the following formula:               Satisfied Count + Tolerating Count  Apdex =                                              2                             Total Samples Satisfied: This represents the time value (T seconds) below which users are not impeded by application response time. Depicts the user is fully productive. Tolerating: This represents response time greater than T (precisely, T to 4T), where the user notices performance lagging but continues the process, which depicts the response is tolerated by the user. Frustrated: This represents response time F, greater than 4T which is unacceptable, and users may abandon the process, which depicts the user is frustrated. The score of 1 show all the users are satisfied with the application performance, whereas a score of 0 show no users are satisfied. Score of 0.5 shows all the users are tolerating the application performance. As the application responsiveness vary, the score ranges from 0-1. Apdex Score, as a whole, is critical to measure the service levels and customer satisfaction which in turn measures the business growth. Moreover, these values are easy to decipher; unlike the traditional values of average response time and throughput, that does not accurately interpret a particular transaction that is performing slow and affect user satisfaction.     App Parameters Overview App Parameters is a helpful feature that monitors important metrics in your application. With App Parameters, you can monitor the: Size,  numeric value, or frequency of a variable. Size or frequency of an operation in an application. Let''s say a simple web request involves an API call, a database (DB) operation, and a cache hit; a single request can invoke multiple resources, and multiple users can invoke multiple requests at once. In these instances, you can figure out how often the API was called, as well as the number of times the DB operation took place during a particular time interval. This helps you assess if the CPU or memory is being overloaded and how this is affecting your app performance for the given time interval.  With real-world applications, the App Parameters feature comes in handy when monitoring the frequency of hits to DB calls, service calls, or user-defined framework calls. Based on the report in App Parameters, you can troubleshoot performance degradation caused by an overload of hits.   Get started with App Parameters: Operations involvedInstallation instructions for .NET applications Installation instructions for Java applications Installation instructions for Node.js applications Viewing App Parameters Operations involved Sum - The sum of all values passed in a specific interval for a parameter. Average - The average value passed in a specific interval for a parameter. Every parameter will be sent with the below metrics to track its frequency: Sum Parameters Description Param Name The parameter name provided by the user in the application. Total Value The aggregated value for the corresponding parameter during a particular interval. Average Parameters Description Param Name The parameter name provided by the user in the application. Total Value The aggregated value for the corresponding parameter during a particular interval. Minimum Value The minimum value captured in that particular interval. Maximum Value The maximum value captured in that particular interval. Total Count The total number of hits. Note: App Parameter APIs are available for .NET, Java and Node.js agents. Installation instructions for .NET applications Install the APM Insight .NET agent. Add the DotNetAgent.Api.dll file found in the installation path as a reference to your application. Include the following code snippet wherever required: Syntax Sum: Sum of values passed in a specific interval for a parameter. If the sum is an empty value, it will be incremented by 1.  DotNetAgent.Api.CustomTracker.Increment("keyName");  DotNetAgent.Api.CustomTracker.Increment("keyName", value);  Average:  Average of values passed for a parameter in a specific interval. DotNetAgent.Api.CustomTracker.Average("keyName", value); Example public ActionResult Register() { DateTime st = DateTime.Now; double myKeyValue = Convert.ToDouble(Request.QueryString["mykey"]); //parameter "register" will be incremented by 1 and sent as SUMDotNetAgent.Api.CustomTracker.Increment("register"); //parameter "mykey" will be incremented by myKeyValue and sent as SUM DotNetAgent.Api.CustomTracker.Increment("mykey", myKeyValue); double myKeyAvgValue = GetAverageValue(); //parameter "myavgkey" will be incremented by value and sent as AVG DotNetAgent.Api.CustomTracker.Average("myavgkey", myKeyAvgValue); return View(); } Publish the application to start tracking the parameters. Installation instructions for Java applications Install the APM Insight Java agent. Ensure you meet the prerequisites. Bundle the API jar found in your application build path (apminsight- javaagent-api.jar file). The preferred location is WEB-INF/lib. Add the below code snippet wherever required: Syntax Sum: Value for the key will be incremented by 1. Key will be cleared on every agent polling interval. CustomMetric.increment("key_name") Value for the key will be increment by the specified value. Key will be cleared on every agent polling interval. CustomMetric.increment("key_name", value) Average: Value for the key will be aggregated and its count will be collected by the agent and pushed to Applications Manager''s servers. CustomMetric.average("key_name", value) Example private void generateReport(String type) { CustomMetric.increment(type); // Other app operations double averageValue = getAverageValue(); CustomMetric.average(type, averageValue); Publish the application to start tracking the parameters. Viewing App Parameters To view App Parameters, Log in to your Applications Manager account → Your application → App Parameters. App Parameters created for operations/variables will be listed on the right, along with the name you have provided and the type of parameter (Sum or Average). Click on the parameter you wish to view—you can create, save, and update views for future reference. Thread Profiling OverviewThread profiling enables you to identify and isolate bottlenecks in your code stack. In Applications Manager''s APM Insight, all thread profiles collected in the chosen time window are listed, along with the thread count, CPU time and memory details. Each thread profile consists of a list of threads that were running when the application was being profiled. Upon clicking a specific thread profile, one can view: High CPU consuming threads,along with its thread ID, CPU time and memory allocated details Time consuming methods which could potentially affect application''s performance Invocation count of every method Contents: Viewing thread profiles Types of thread profiling Viewing thread profiles To view Thread Profiles, Log into your Applications Manager account. Go to APM tab and click on your application. Click on Thread Profiling tab and then click on individual threads to inspect them further. Note: Thread profiling is supported only for JAVA and .NET agents. Types of thread profiling Scheduled profiling On-Demand profiling Scheduled profiling APM Insight schedules thread profiling twice a day for a period of 5 minutes. Note: In Java agent, scheduled thread profiling happens for every one hour. By default, Scheduled profiling is disabled for Java agent and is not supported for .NET agent. For Java agent, scheduled profiling can be enabled by adding the below property in apminsight.conf file: thread.profiling.enabled=true After implementing the above changes, save and close the file. Now scheduled profiling will happen for every one hour. On-Demand profiling With On-Demand profiling, one can initiate thread profiling at the current time for a duration ranging from 5 to 30 minutes. The threads are sampled at regular time interval in the specified duration and the collective data is displayed at the end of time duration. To initiate On-Demand profiling, Log into your Applications Manager account. Go to APM tab and click on your application. Click on Thread Profiling tab, then click on On-Demand thread profiling tab to initiate. Specify time duration and click on Initiate profiling. Note: On-Demand  profiling can be initiated only once per hour (i.e) if you initiate On-Demand profiling for 5 minutes, next initiation can be done only after 55 minutes. On-Demand profiling can be initiated for both applications and instances. In application view, On-Demand profiling will be initiated for the first available instance.In instance view, On-Demand profiling will be initiated only when the instance is UP. When your instance is suspended, On-Demand profiling will be disabled. Distributed Tracing Overview With Distributed Tracing, you can track transaction traces made from one application to another. This enables you to monitor calls made between applications and narrow down the problem. Contents: What is a trace? What is distributed tracing? Prerequisites to enable Distributed Tracing How Distributed Tracing works? Viewing the data Metrics and Inference What is a trace? A trace is the execution flow of a transaction, including its method calls, database queries, and exceptions. When a transaction exceeds the specified threshold value, it''s captured as a trace. What is distributed tracing? Modern applications have evolved from their monolithic ancestry to microservices or distributed systems. Analyzing issues in such environments involves correlating data from multiple services spread across the system, creating an inevitable need for a more sophisticated tracing mechanism to diagnose and troubleshoot issues. Distributed tracing fulfills this need by being able to trace the entire path of a web transaction across application or service boundaries. Prerequisites to enable Distributed Tracing Ensure that you have installed APM Insight agents across all your applications that need to be monitored. Make sure your agents are updated to the following versions: Java agent version 4.9.0 .NET agent version 4.8.0 Node.js agent version 1.7.2 Note: Distributed Tracing can be viewed only for applications under the same account. If your applications are spread over various accounts, you cannot have a consolidated view of all your traces across all your accounts. How Distributed Tracing works? When an application or service makes an API request to another application or service, Applications Manager''s APM Insight adds an HTTP header containing the metadata required to track the service request. If Applications Manager''s APM Insight is enabled in the other corresponding service, it will process the HTTP header and return the tracking information to its caller via the response headers. If the other service in turn calls another service, the header propagation continues, thus tracing all paths taken by the original application or service across the distributed system. Note: Traces are captured only when the request exceeds the defined threshold level in any of the services. If your application uses any proxy service, ensure that the corresponding keys X-Appmanager-Id and X- Appmanager-DT-Data are added to request and response headers in order for the agent to track the transaction.Viewing the data To view distributed traces, follow the steps below: Log in to your Applications Manager account → APM → Your applications. Click on the respective application to view its traces. Upon clicking the trace, you can see the title ''Distributed Tracing''. This lists the calls made to other applications and the corresponding transactions. Metrics and inference On the Distributed Tracing tab, there are various metrics provided to help you analyze the results of the trace. Below are the metrics shown under the Distributed Tracing table: Parameter Description Start Time Time at which the transaction was started. Transaction Name of the transaction. Response Time Time taken for the transaction to respond within the application (in ms). Application Name Name of the application. By clicking Expand Tree View on the right-hand side of the Application Name, you can view the method calls and code blocks that took a significant amount of time to complete this request. Under normal circumstances, these transaction traces are viewed separately without context. With Distributed Tracing, you can understand precisely the method calls requested by a transaction from a particular application, and how it has exceeded the threshold level. This simplifies your debugging process. Service Maps Service Maps give you a complete overview of your application infrastructure along with its connection to other dependent resources. With Service Maps, you can view: The status of your application and instances Key metrics like Response time, Throughput and Status of connection Number of failed request count This helps you to detect and troubleshoot your application problems before your customers are impacted. Viewing Service Maps To view Service maps: Log into your Applications Manager account and go to APM tab. Choose your application or instance. Click on Service Maps tab for topological view of your application infrastructure. Note: Service maps do not need any configuration.Service map is not supported for Ruby agent. Metrics and Inference Service maps can be visualized in the following views: Map view Graph view Tabular view Map View Map View provides the way of analyzing the topological view of your application. In Map view, application along with their instances are represented in the central node. The outer fully enclosed circle in the center of the semi circle  represents the Application. The inner enclosed circle represent each of the application instance. Green indicates application/instance is UP. Red indicates application/instance is DOWN. Purple indicates application/instance is Unmanaged. Pink indicates application/instance is under Scheduled Maintenance. On hovering the outer enclosed circle displays the application name. On hovering the inner enclosed circle displays the instance name. On clicking the Instance name in the tooltip,it redirects to the particular Instance.  On hovering each of the components, displays the status of that component with the metrics mentioned below: Average Response Time Failed Requests Total Requests Throughput In case of Failed Request,the component status indicated in Red. On clicking the component name in the tooltip,it redirects to its graph view.Graph View The graph view lists out parameters like average response time,total response time, throughput, total request count, error count and error rate. These metrics can be viewed for all components, for all hosts corresponding to individual components and for individual hosts. Graph view showing all metrics for all components Graph view showing all metrics of all hosts of a particular component.Graph view showing all metrics of a particular host of a particular component. Tabular View The Tabular view lists down all components along with their respective hosts. Clicking on individual component or host takes you to the corresponding graph view. Application Discovery and Dependency Mapping (ADDM) Browse through the following sections to know more about the Application Discovery and Dependency Mapping (ADDM) feature in Applications Manager: What is ADDM? Using ADDM Dependency Maps Application Discovery and Dependency Mapping (ADDM) What is ADDM? ADDM is, quite simply, a feature to help you discover your applications and have a comprehensive insight into your business infrastructure. Imagine a map that displays all your applications, along with their relationships to otherapplications as well as to your infrastructure as a whole. Better yet, you have it all in one place. Yes, that should perhaps encapsulate it. Why do you need ADDM? Clearly, unless you want to manage your IT resources using spreadsheets or by employing audit techniques, ADDM is all that you need. Here is just a glimpse of what you can do with ADDM: Discover and group resources. Establish relationships between resources. Map the resources and gain a global view of your IT infrastructure. Assess the health and impact potential of resources. Detect/ Isolate problems with ease if any. Get periodic status reports of your applications. Make informed decisions and take your business to new levels. Now that you have some idea about ADDM, let''s help you understand it better. Here''s how you can use ADDM. Click here. ADDM - Features of Dependency Maps Assuming you have arrived at the Business View successfully, allow us to give you just a little bit more information on what you can do with the Dependency Map. So, while you can view your Applications and their Dependencies in the map, you will also find a lot of other tasks made easy. For example, if you are at the Business View for a specific Monitor Group, you can configure a lot of Monitor Group actions directly from here by clicking the Monitor Group Actions tab on the right hand side. Some of these actions include, Editing Monitor Groups. Associating or Deleting Monitors from the Group. Creating Sub Groups. Configuring Alarms. Viewing Application Reports and Anomaly Dashboards. Furthermore, you can: Move your cursor over the Monitor Group or Monitors in the map and explore options. Drag and reposition your Monitors in the map to suit your view. Access the View Settings from the left hand side to customize your view. Technologies discovered through ADDM Below are the list of technologies that can be discovered through ADDM: Windows server JBOSS server Nginx Linux server JDK 1.5 Oracle DB server Apache Tomcat Apache server Memcached PostgreSQL server Cassandra MongoDB Redis WebLogic server IBM DB2 MySQL DB server Resin WebSphere server GlassFish MS SQL DB server Sybase DB server How to use ADDM? The first step while using ADDM is to Discover Applications. The next is to Map them. How to Discover Applications/ Resources?Discovering resources is a simple process. Here are a few easy steps: Once you have logged in to Applications Manager, simply click on the Admin tab. There, click on Add/ Discover under the Discovery and Data Collection heading. Click on Discovery tab. From then on, you can follow the instructions on the web client to complete the discovery process. Need more help on this? Click here. How to use Dependency Mapping? Dependency Mapping is an automatic feature, so you don''t have to rack your brain over it. Once you have associated Monitors to Monitor Groups, go to Home>Business view and there it is. A holistic Mapview of all your Business Applications! You can also view Dependency Maps for individual Monitor Groups. Choose your Monitor Group from the Home tab and select Business View. In case you are unclear about Monitors and Monitor Groups, click here. Features of Dependency Maps. Discovery Filters Applications Manager allows you to discover resources in a monitor type based on various filtering conditions. You can choose to filter resources for discovery based on the regex filters for the particular monitor. It discovers resources that matches the specified regex filter from the server and monitors their performance and availability. Note: Currently, this option is available only for Docker and VMware ESXi monitors. Syntax _ =[Regex] where, - Module type to be monitored. - Name of the attribute to be monitored. [Regex] - Regex value to be specified. Following are the list of points that are to be noted for entering a valid regex filter: Users can provide multiple filters separated by comma and provide appropriate conditions/symbols such as "||" (OR), "&&" (AND) and "[]" between the filters with different attribute names to create multiple options. Users should not use the characters _ [ ] in the regex value as they are used as a separator and for grouping functionality. Users can provide discovery filter regex for multiple Module Types of the same monitor type. However, they cannot group multiple Module Types in the Discovery Filter regex. Example: CONTAINER_NAME=tomcat.* && NODE_NAME=test.* In case the user provides any invalid module type or an attribute name that is not supported, an error message will be shown during the monitor addition. Attribute names, module names and regex are case-sensitive. Supported monitor types Following are the list of monitor types that support discovery filters: Monitor Name Module Type (Child / Tabular Resources) Attributes Name Docker CONTAINER NAME, IMAGE VMware ESXi / vCenter VIRTUALMACHINE NAME Examples Following are some examples by which regex filters can be specified: S.No. Discovery Regex Behavior1 CONTAINER_NAME=tomcat.* This will discover all the containers starting with the name ''tomcat''. CONTAINER_NAME=tomcat.*, This will discover all the containers starting with the name 2 NODE_NAME=test.* ''tomcat'' and node name starting with ''test''. CONTAINER_NAME=tomcat.* This will discover the container starting with the name ''tomcat'' 3 && CONTAINER_IMAGE=tomcat8.* and image starting with ''tomcat8''. CONTAINER_NAME=tomcat.* || This will discover the container starting with the name ''tomcat'' 4 CONTAINER_IMAGE=tomcat8.* or the image starting with ''tomcat8''. CONTAINER_NAME=tomcat.* && This will discover the container starting with the name ''tomcat'' 5 [CONTAINER_IMAGE=tomcat8.* || if container image starts with ''tomcat8'' or the path starts with CONTAINER_PATH=cont1.*] ''cont1''. CONTAINER_NAME=tomcat.* , This will discover all the container starting with name ''tomcat'' 6 [CONTAINER_IMAGE=tomcat8.* || and the container if container image starts with ''tomcat8'' or the CONTAINER_PATH=cont1.*] path start with ''cont1''. Enterprise Edition Overview ManageEngine Applications Manager - Enterprise Edition allows you to monitor more number of servers and applications in a distributed setup. You can configure independent Applications Manager installations to monitor resources and then collectively view the data from all these independent Applications Manager installations ("Managed Server") from a single installation ("Admin Server"). Installation & Setup During installation, you will be provided with options of selecting the type of installation as Free/Professional/Enterprise Edition On choosing Enterprise Edition, you would be asked to choose whether you want the installation to be that of Admin Server or Managed Server In Enterprise Setup, you must first configure the Admin Server and then configure the Managed Server Admin Server: Enter the WebServer and SSL port and continue with installation. Managed Server: Enter the Admin server Host Name, SSL Port (8443 by default),WebServer port and Probe Registration Key. Select the Proxy Settings needed to contact the Admin Server if needed (This is a separate step in Linux but not so in Windows Installation) Note : The Probe Registration Key is regenerated automatically for every 24 hours and can be found under Admin → Product Settings → Product License in Admin server. Before installing the Managed Server, make sure the build numbers of the Admin as well as the Managed Server are the same. In case of mismatch, the new Managed Server will not start and a build mismatch error will appear in the logs folder (Wrapper.log file). To know your build number, check the stderr / StartUpLogs_out file(s) located under logs in the Applications Manager parent folder.Enterprise Edition Overview As a first step, Admin Server has to be started. When a Managed Server starts, it contacts the Admin Server for registering itself (based on the Admin Host/ SSL Port provided during installation). The Admin Server assigns a unique ID to this Managed Server called the "Server ID". Each managed Server is identified by its Server ID. Every 5 minutes, the Admin Server contacts the Managed Servers that are registered to it and fetches the required data from each of the Managed Servers. You can view all the data from the Managed Servers in the Admin Server console itself.   Converting the Professional Edition to Enterprise Edition If you are using Applications Manager as a standalone server (Professional) and want to convert it into a distributed setup (Enterprise Edition) without losing the Configuration Information, you will have to do the following steps : Do a fresh installation of Admin server of Applications Manager and start the same. Now, in the existing standalone Applications Manager ''s, Click on link Convert standalone server into Managed Server under the ''Admin tab - Global Settings''''. (You can convert only one standalone server to Managed server. You can add more Managed Servers through fresh installations.) You will have a popup requesting details of the Admin Server Host and Admin Server SSL port. Provide the details to complete the conversion from Standalone server to Managed Server. You can verify from the Support tab if the type of Server is Managed Server. Note : It is possible to convert a Standalone installation to a Managed Server only if there are no other Managed Servers already added to the Admin server i.e., only if you are just installing a new Admin Server. If you already have a Enterprise Setup (Admin Server/Managed Server), you cannot convert a Standalone Server to be a part of the setup. It is not possible to change from Admin server type to a Standalone setup or vice versa without reinstalling the product.  Warnings : It is not possible to revert from Managed server back to Standalone setup although it will still be functioning without any problems. We do not recommend moving a Managed server from one admin server to another. Browse through the following sections to know more about Enterprise Edition: Admin Servers Managed Servers Single Sign-On (SSO) Admin Activities Failover Support Using MSSQL as Backend DB Server Failover Support Using PostgreSQL as Backend DB ServerNote: Visit Enterprise Edition FAQ for details on when to, how to set up Enterprise Edition. Enterprise Edition - Admin Server Enterprise Edition Admin Server is the master server through which you will be able to view consolidated data of all the Managed Servers. Installation Managed Server Configuration Adding a New Monitor in Admin Server Managed Server Groups Creating Monitor Groups in Admin Server Managed Server Actions More: Proxy Managed Server request through Admin Server User Administration In the Enterprise Editon Managed Server Access FAQ Installation During installation, you need to: Select the Edition option as ''Enterprise Edition''. Select the installation type as ''Admin Server''. Enter the HostName, WebServer port, SSL port of the Admin Server. Kindly carry on with the rest of the installation process. Managed Server Configuration The Managed Server automatically gets registered with the Admin Server when it starts up. In case you want to edit the configuration, go to Settings tab. Click on Managed Servers link. This will take you to the Managed Server page from where you can configure the Managed Servers. Alternatively, this can be done by clicking on the Managed Servers link just below the main tabs. Here is how you can configure a Managed Server: Click on the Add New link, it opens up the Add New Managed Server form Enter the Host Name of the Managed Server Enter the Web Server Port number, the port at which the web client is to be connected Enter the SSL port number, the port at which secure communication is to be made between the Admin and Managed Server. Enter the Server ID, the ID present under Installation Information table under Settings tab -> Tools -> Support of the Managed Server Enter the Admin Password for the Managed Server.(Note: This password should be same as that of Admin role password of that managed server. If user changes that password in the Managed server, then the user has to manually update the same in admin server) Click on Add Managed Server and the Managed Server gets added. It is displayed under Managed Servers link along with the details of the number of monitors, status, load factor, etc., The following managed sever details are displayed in the table: Server ID - The id of the managed server. Display Name - The display name of the managed server. Managed Server Group - The managed server group to which the server belongs. Monitors Status - The health status of the monitorLoad Factor - The Load Factor of the server. Last Polled at - The time last polled at. Synching - The syncing status of the managed server (completed or in progress) Download - The status of the Service pack download. Upgrade - The upgrade status of the Service Pack. You can select one or more Managed Servers and click the Download Now link at the bottom of the table to download the Service Pack and the Upgrade Now link to upgrade the Service Pack. Note In order to find if a particular Applications Manager installation is heavily loaded you can use the Load Factor, which is provided in the ''Support'' tab under the ''Applications Manager Installation Information'' category. The load factor follows the format x.y, where ''x'' represents load on Applications Manager Server, while ''y'' represents the load on the Database used by Applications Manager. A value of zero represents least loaded, while a value of nine represents most loaded. Hence Load Factor can take values from 0.0 to 9.9 (heavily loaded). The Load Factor of each of the Managed Servers is also displayed in the Admin server under the "Managed Servers" option and you can use the same to distribute load evenly among the Managed Servers. The Load Factor can be denoted by x.y where x represents Managed server polling load factor and y represents Managed server data base load factor. The Maximum value of x,y can be configured in AMServer.properties file of Admin server: x - am.mas.polling.max.loadfactor - default value 5 y - am.mas.database.max.loadfactor - default value 5 Creating a New Monitor from an Admin Server Applications Manager Enterprise Edition allows you to add monitors and group them from the Admin Server in a distributed setup. To add a new monitor in a host, refer these links. However, while adding a new monitor from an Admin server, the managed server under which the monitor is to be added can be selected manually by the user or using load factor by Applications Manager. The value for Maximum monitors allowed per Managed server can be configured in AMServer.properties. The key is am.max.monitorcount.mas and default value is 500. Selecting Managed Server Using Load Factor: You can select one of the following options in the Add Monitor Page: Least Loaded Managed Server from all Managed Servers Least Loaded Managed Server from a Managed Server Group Selecting Managed Server Specified by the User: The user can select the managed server. This will add the monitor directly to the selected managed server irrespective of load factor and monitor count. Managed Server Groups Certain resources can be monitored from managed servers running in the same domain/ geographical location as the resource. Load factor calculation across all the distributed managed servers can result in the addition of a monitor in a server located in another domain (since the load factor condition matches). Grouping managed servers in the same area gives the user the option to use load balancing within the group of managed servers. Creating a Managed Server Group: Go to the Managed Servers link in Applications Manager. In the Managed Servers table, click on the edit icon near the managed server that you wish to add to a group. In the Edit Managed Server window, choose a Managed Server Group from the drop-down menu after entering all the required details. You alternately have the option to Add New Managed Server Group to the list using the + icon. While creating a new monitor from an Admin Server, after entering the required details, choose the Least Loaded Managed Server from a Managed Server Group load balancing option and select the Managed Server Group from the drop down menu that appears. Click Add monitor. Creating Monitor Groups in Admin ServerVarious monitors in Managed Servers can be grouped and a consolidated view can be obtained in Admin Server. For eg., consider a set up that has three Managed Servers and one Admin Server. Each Managed Server has 200 monitors which includes 10 windows servers. If you want to monitor the windows servers in all the three managed servers as a group, then you can create a new Monitor Group in the admin server. You can create Monitor Groups by following the steps in Create Monitor Group help document. Once you have created the Monitor Group, the next step would be to associate the required monitors from Managed Servers to the Monitor Group in the Admin Server. After the setup is done, you can configure the alarms for the Monitor Group. Currently, only EMail and SMS alarm actions are supported. Managed Server Actions Fetch Data: There is an option to fetch the data from the managed servers at the given instant, instead of waiting for the poll to happen. Edit: You can edit the managed server details using this option. Enable/Disable: You can enable/disable data collection in the Managed Server. Note that when you disable, data collection will still take place, you only stop syncing with the managed server. Admin Email Settings: An EMail can be configured to be sent once a Managed Server goes down and also once every 24 hrs till the Managed Server is up again. The EMail setting is available in the Admin EMail Settings" option under the "Admin" tab. The option to enable/disable this EMail, is available in the "Edit" option of the respective Managed Server. Proxy Managed Server request through Admin Server When you login to the Admin console, Graphs and images displayed for a monitor are retrieved directly from the corresponding Managed Server itself and are displayed in the Admin console. These graphs/images cannot be retrieved, if the Admin Server is accessible from a particular machine/over the Internet and the Managed Server is not accessible. In this case, select the "Proxy Managed Server request through Admin Server" request option. This will result in the images/graphs being fetched to the Admin Server from the Managed Server first and then the image from the Admin Server is viewable in the Web Browser. E.g., Admin Server is running as part of IDC and accessible via the Internet (From a machine say "ClientMachine") but the Managed Servers are not accessible (from "ClientMachine") this option should be enabled. User Administration In the Enterprise Editon In the Enterprise setup, the User Administration module functions independently in the Admin Server and Managed Server. Hence, a user-based view assigned in the Managed Server will not reflect in the Admin Server and vice- versa. Since, you will be viewing the data collectively from the Admin Server, you need to assign owners to the various Monitor Groups of the Managed Server in the Admin Server. Of course, if it is assigned in the Managed Server it will function independently. Also, in the Manager Console (SLA Management console), you can assign SLAs and associate actions to be invoked for SLA violation to the Monitor Groups in the Admin Server. Managed Server Access Click on the Jump To link in the Admin Server just above the toolbar, which brings down a list of the Managed Servers. Clicking on any of the Managed Server names in the list will take you to the web console of the respective Managed Server in a separate browser Window. Note ENTERPRISEADMIN role is used for logging into the Managed Server from Admin Server for data synchronising. The username for this role is systemadmin_enterprise and the password is the regular ADMIN role password. This role is not exposed in the UI, it will be used internally. Visit our Enterprise Edition FAQ page for more details on when and how to set up the Enterprise Edition. FAQ - How is the Managed server selected by APM using load factor? The following two things are used to select the managed server automatically: Load Factor (x.y) where, x represents Managed server polling load factor y represents Managed server data base load factorMax. value of x,y can be configured in AMServer.properties file of Admin server x - am.mas.polling.max.loadfactor - default value 5 y - am.mas.database.max.loadfactor - default value 5 Maximum monitor allowed per Managed server The value can be configurable in AMServer.properties. The key is am.max.monitorcount.mas and default value is 500. The Condition for choosing managed server is, x < maxAllowedValueOfPollingLoad (and) y < maxAllowedValueOfDatabaseLoad (and) n < maxMonitorAllowed If the condition is not matched then we show the "No Managed server is available" message to the user. Enterprise Edition - Managed Server Enterprise Edition allows you to configure independent Applications Manager installations to monitor various resources and then collectively view the data from all these independent Applications Manager installations known as Managed Servers, from a single master server known as Admin Server. During installation, you need to select ''Enterprise Edition''. Next select the installation type as ''Managed Server''. Consequently, you need to enter the HostName, SSL & webserver port of the Admin Server, to which the Managed Server is going to be connected. Managed Server''s function is similar to that of a standalone Applications Manager, with the user configuring the various monitors, thresholds and alarms. HTTPS mode of communication is used for the communication with the Admin Server. Using the Jump To link in the Admin Server (just above the toolbar) you can view the Managed Server web console. Managed Server Configuration Managed Server Actions FAQ Note: To change a Professional Edition to Managed Server, go to Global Settings, select ''Convert standalone server into Managed Server''. This option is available only if you have installed the full build and not for upgrades through PPM. You need to make the following changes in the Product_Home/conf/AMServer.properties file and restart the server to convert to the Managed Server. am.ssl.enabled=true am.server.type=MAS am.adminserver.host=Admin Server Host Name am.adminserver.port=Admin Server SSL Port Visit Enterprise Edition FAQ for details on when to, how to set up Enterprise Edition. Managed Server Configuration The Managed Server automatically gets registered with the Admin Server when it starts up. In case you want to edit the configuration, go to Settings tab. Click on Managed Servers link. This will take you to the Managed Server page from where you can configure the Managed Servers. Alternatively, this can be done by clicking on the Managed Servers link just below the main tabs. Steps to Add a Managed Server Click on the Add New link, it opens up the Add New Managed Server form Enter the Host Name of the Managed Server Enter the Web Server Port number, the port at which the web client is to be connected Enter the SSL port number, the port at which secure communication is to be made between the Admin and Managed Server.Enter the Server ID, the ID present under Installation Information table under Settings tab -> Tools -> Support of the Managed Server Enter the Admin Password for the Managed Server.(Note: This password should be same as that of Admin role password of that managed server. If user changes that password in the Managed server, then the user has to manually update the same in admin server) Click on Add Managed Server and the Managed Server gets added. It is displayed under Managed Servers link along with the details of the number of monitors, status, load factor, etc., The following managed sever details are displayed in the table: Server ID - The id of the managed server. Display Name - The display name of the managed server. Managed Server Group - The managed server group to which the server belongs. Monitors Status - The health status of the monitor Load Factor - The Load Factor of the server. Last Polled at - The time last polled at. Synching - The syncing status of the managed server (completed or in progress) Download - The status of the Service pack download. Upgrade - The upgrade status of the Service Pack. You can select one or more Managed Servers and click the Download Now link at the bottom of the table to download the Service Pack and the Upgrade Now link to upgrade the Service Pack. Note: In order to find if a particular Applications Manager installation is heavily loaded you can use the Load Factor, which is provided in the ''Support'' tab under the ''Applications Manager Installation Information'' category. The load factor follows the format x.y, where ''x'' represents load on Applications Manager Server, while ''y'' represents the load on the Database used by Applications Manager. A value of zero represents least loaded, while a value of nine represents most loaded. Hence Load Factor can take values from 0.0 to 9.9 (heavily loaded). The Load Factor of each of the Managed Servers is also displayed in the Admin server under the "Managed Servers" option and you can use the same to distribute load evenly among the Managed Servers. Note: The Load Factor can be denoted by x.y where x represents Managed server polling load factor and y represents Managed server data base load factor The Maximum value of x,y can be configured in AMServer.properties file of Admin server: x - am.mas.polling.max.loadfactor - default value 5 y - am.mas.database.max.loadfactor - default value 5 Managed Server Actions Fetch Data: There is an option to fetch the data from the managed servers at the given instant, instead of waiting for the poll to happen. Edit: You can edit the managed server details using this option. Enable/Disable Sync: You can enable/disable data collection in the Managed Server. Note that when you disable, data collection will still take place, you only stop syncing with the managed server. Push Auth Key: Allows you to push the auth key to selected Managed server(s), which is used to authenticate the sync between the Admin server and selected Managed server(s). Admin Email Settings: An EMail can be configured to be sent once a Managed Server goes down and also once every 24 hrs till the Managed Server is up again. The EMail setting is available in the Admin EMail Settings" option under the Settings tab. The option to enable/disable this EMail, is available in the "Edit" option of the respective Managed Server. Proxy Managed Server request through Admin Server: When you login to the Admin console, Graphs and images displayed for a monitor are retrieved directly from the corresponding Managed Server itself and are displayed in the Admin console. These graphs/images cannot be retrieved, if the Admin Server is accessible from a particular machine/over the Internet and the Managed Server is not accessible. In this case, select the "Proxy Managed Server request through Admin Server" request option. This will result in the images/graphs being fetched to the Admin Server from the Managed Server first and then the image from the Admin Server is viewable in the Web Browser. E.g., Admin Server is running as part of IDC and accessible via the Internet (From a machine say "ClientMachine") but the Managed Servers are not accessible (from "ClientMachine") this option should be enabled.User Administration: In the Enterprise setup, the User Administration module functions independently in the Admin Server and Managed Server. Hence, a user-based view assigned in the Managed Server will not reflect in the Admin Server and vice-versa. Since, you will be viewing the data collectively from the Admin Server, you need to assign owners to the various Monitor Groups of the Managed Server in the Admin Server. Of course, if it is assigned in the Managed Server it will function independently. Also, in the Manager Console (SLA Management console), you can assign SLAs and associate actions to be invoked for SLA violation to the Monitor Groups in the Admin Server. Managed Server Access Click on the Jump To link in the Admin Server just above the toolbar, which brings down a list of the Managed Servers. Clicking on any of the Managed Server names in the list will take you to the web console of the respective Managed Server in a separate browser Window. Note: ENTERPRISEADMIN role is used for logging into the Managed Server from Admin Server for data synchronising. The username for this role is systemadmin_enterprise and the password is the regular ADMIN role password. This role is not exposed in the UI, it will be used internally. Important: Visit Enterprise Edition FAQ for details on when and how to set up the Enterprise Edition. FAQ - How is the Managed server selected by APM using load factor? The following two things are used to select the managed server automatically. Load Factor (x.y) where, x represents Managed server polling load factor y represents Managed server data base load factor Max. value of x,y can be configured in AMServer.properties file of Admin server x - am.mas.polling.max.loadfactor - default value 5 y - am.mas.database.max.loadfactor - default value 5 Maximum monitor allowed per Managed server The value can be configurable in AMServer.properties. The key is am.max.monitorcount.mas and default value is 500. The Condition for choosing managed server is, x < maxAllowedValueOfPollingLoad (and) y < maxAllowedValueOfDatabaseLoad (and) n < maxMonitorAllowed If the condition is not matched then we show the "No Managed server is available" message to the user. Enterprise Edition - Single Sign-On (SSO) Overview Applications Manager''s Enterprise Edition supports Single Sign-On (SSO) - a mechanism which offers a user unified access i.e users do not have to actively enter their credentials more than once in order to access multiple independent installations (your Admin Server and Managed Servers). Users gain access to all their Managed Servers with a single user authentication into the Admin Server eliminating further prompts when they switch applications during a particular session. Benefits: Security - Capability to implement consistent authentication and authorization guidelines across your enterprise. Resource savings - Reducing time spent re-entering passwords for the same identity or profile and central access management. User Experience - Ability to move between services and portals securely and seamlessly without password prompts. Enabling Single Sign-On You can enable Single Sign-On in your Applications Manager Enterprise setup as follows: Download the appropriate cas war file based on the Applications Manager''s version installed. Applications Manager WAR File Version15530 and above cas_8.war cas_8.war file located under \working\resources 14270 to 15510 directory of Admin server. Below 14270 cas.war Place the downloaded .war file in the webapps folder in the following path: \working\apache\tomcat\webapps in your Admin Server. Start Applications Manager and navigate to the Settings tab. Open User Administration under Applications Manager Server Settings. Navigate to the SSO tab. Check the Enable SSO checkbox. Restart Applications Manager. SSO is enabled. Note: Single Sign-on in Managed Servers will be enabled only after Applications Manager is restarted. Please take care to perform the restart after a few minutes to ensure that the SSO key from the Admin server is synched with the Managed Servers. The Admin server should be running when the Managed Server starts for SSO to work. Users created in the Admin server will be synced to the Managed Server. No user creation or modification can be performed in your managed servers In case of HTTP 400 (Bad Request) error faced while accessing the Managed server monitor from Admin server, try implementing the below steps: Make sure that the Managed server hostname shown in Admin server and the hostname specified for am.appmanager.hostname key in AMServer.properties file (under /conf/ directory) of that Managed server should be the same. If not, update the correct hostname in Admin server''s Edit Managed Server page and save it. Then stop the Managed server and update the same hostname for am.appmanager.hostname key in AMServer.properties file (under /conf/ directory) of that Managed server. Finally, save the changes and restart the Managed server. Update the Managed server hostname to lowercase in Admin server''s Edit Managed Server page and save it. Then stop the Managed server and update the same hostname to lowercase for am.appmanager.hostname key in AMServer.properties file (under /conf/ directory) of that Managed server. Finally, save the changes and restart the Managed server. Enterprise Edition - Performing Admin Activities from the Admin Server The Settings tab in the Enterprise setup client lists all the administrative functions that can be performed with the product. The following are the group of activities performed by the system administrators from the Admin Server to monitor their system/ service/ application running in the network through Applications Manager: Applications Manager Server Settings: New Monitor | Bulk import of Monitors Alarm Escalation Downtime Scheduler Credential Manager Managed Server User Administration Global Settings Configure Mail Server Configure Proxy Logging Personalize Web Client Product License SupportAdd-On/Product Settings Shutdown Applications Manager Alarm/Action: Actions Threshold Profile Configure Alarms Event Log Rules Monitor Group Rules Server Process Templates Windows Service Templates Integration with Portals Rest API for Admin Server JSON Feed Dashboards World Map View Reporting Reports Settings Schedule Reports Business Hours SLA Management Enterprise Edition - Failover Support Using MSSQL as Backend DB Server Follow the steps below to implement failover support in ManageEngine Applications Manager: Single Database - Dual AppServer Architecture The setup involves a primary Applications Manager, a secondary Applications Manager and a common database. The primary and secondary Applications Manager refer to the common database only. While the primary Applications Manager talks with the database, the secondary Applications Manager simply listens to the database. If the primary server goes down, the secondary server takes over. Afterwards, the initial primary server is restarted and it starts functioning as a secondary server. Before installing failover (for Managed Servers): Log into Applications Manager''s Admin console and go to Managed servers list. Edit the Managed server to enable the radio button for Failover details. Enter the Hostname, Web server and SSL port information before installing the Failover setup for that Managed server. Once it is saved you can start the Failover server installation. Failover Setup Details Let us assume we are going to set up three nodes - node1, node2 and node3. Applications Manager: node1, node2 MSSQL Database: node3Step 1: Install MSSQL database Server in node3 and make sure MSSQL Server is started in node3. Create the database with the name AMDB which is the database name used in Applications Manager by default.(You can change the name as you wish). Step 2: Install Applications Manager in node1. While installing, make sure you select the database as MSSQL and give the same DB name, port number as in Step1. Start the Applications Manager in node1, this will act as the primary server. Check in the wrapper.log Step 3: Install the Applications Manager in node2. While installing, make sure you select the database as MSSQL and give the same DB name, port number as in Step1. Start the Applications Manager in node2. Check in the wrapper.log When node1Applications Manager goes down, node2Applications Manager will act as secondary server. Sample Nohup Output INFO | jvm 1 | 2013/08/05 01:00:06 | Checking for the availablity of the Primary Server in the Database. Found an entry. INFO | jvm 1 | 2013/08/05 01:00:06 | INFO | jvm 1 | 2013/08/05 01:00:06 | Trying to connect to the Primary Server at 192.168.1.3 INFO | jvm 1 | 2013/08/05 01:00:06 | INFO | jvm 1 | 2013/08/05 01:00:07 | Please wait ... INFO | jvm 1 | 2013/08/05 01:00:08 | ....Connected INFO | jvm 1 | 2013/08/05 01:00:08 | INFO | jvm 1 | 2013/08/05 01:00:08 | INFO | jvm 1 | 2013/08/05 01:00:08 | Starting AdventNet Web NMS Standby Server. The Modules will be started once it takes over as the Primary Server. INFO | jvm 1 | 2013/08/05 01:00:08 | INFO | jvm 1 | 2013/08/05 01:00:08 | Monitoring the Primary Server at 192.168.1.3 When node1Applications Manager goes down, node2Applications Manager will start up completely and will act as secondary server. Email notifications will be triggered on occurrence of a failover where you have to correct the issues with the node that is down. Then start it back as secondary which will now listen for another failure. INFO | jvm 1 | 2013/08/05 01:09:47 | Monitoring the Primary Server at 192.168.1.3 INFO | jvm 1 | 2013/08/05 01:10:48 | Starting to do FailOver Tasks. INFO | jvm 1 | 2013/08/05 01:11:08 | Process : AlertFE [ Started ] INFO | jvm 1 | 2013/08/05 01:11:08 | Process : NmsMainFE [ Started ] INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:08 | Verifying connection with web server... verified INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:08 | Applications Manager started successfully. INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:08 | Please connect your client to the web server on port: 9095 INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:09 | The new primary server is 192.168.1.4 Note: Above steps need to be implemented for each installation in the Enterprise setup for failover. Enterprise Edition - Failover Support Using PostgreSQL as Backend DB Server Follow the steps below to implement failover support in ManageEngine Applications Manager: Single Database - Dual AppServer Architecture The setup involves a primary Applications Manager, a secondary Applications Manager and a common database. The primary and secondary Applications Manager refer to the common database only. While the primaryApplications Manager talks with the database, the secondary Applications Manager simply listens to the database. If the primary server goes down, the secondary server takes over. Afterward, the initial primary server is restarted and it starts functioning as a secondary server. Before installing failover (for Managed Servers): Log into Applications Manager''s Admin console and go to Managed servers list. Edit the Managed server to enable the radio button for Failover details. Enter the Hostname, Web server and SSL port information before installing the Failover setup for that Managed server. Once it is saved you can start the Failover server installation. Failover Setup Details Let us assume we are going to set up three nodes - node1, node2 and node3. Applications Manager: node1, node2 PostgreSQL Database: node3   STEP 1 - Install PGSQL database Server in node3 and make sure PGSQL Server is started in node3. Download Applications Manager from our Website. Postgres is bundled with the product and we recommend that you use the bundled software. Steps to setup remote Postgres DB Server: Install Applications Manager as you would normally do on the remote server where you need to run the DB. Install as Professional Edition as we are only going to use the DB on this installation. (In windows right click and run the installer as "Run as Administrator" Same should be followed when working with command prompt. The Label of command prompt window should read "Administrator") Start this installation once and then stop it. Go to windows services and make sure the ManageEngine Applications Manager service is stopped. From Applications Manager server open an Administrator command prompt window. Go to folder and execute the below command: shutdownApplicationsManager.bat -force Repeat the above command to ensure that all processes are stopped. In Windows, open a command prompt window and go to .. /bin folder and run uninstallservice.bat to remove the ManageEngine Applications Manager windows service. We do not need it here as it is going to be DB Server. Changes in pg_hba.conf file: Open pg_hba.conf under ../ /working/pgsql/data/amdb folder. Under # IPv4 local connections, change Address 127.0.0.1/32 to 0.0.0.0/0. (This will allow connections to be made to this PGSQL DB from remote servers.) Changes in postgresql.conf: Open postgresql.conf file in /working/pgsql/data/amdb folder: Uncomment the line listen_addresses and replace localhost with * In Windows, go to /working/bin folder from command prompt and run the "register_pgdbservice.bat" script. This will install PGSQL as Windows Service. You may now go to Windows Services and start the ApplicationsManager_Posgresql service and the PGSQL DB server should be ready for connections.In Linux you can go to /ManageEngine/ /working folder and run sh./bin/startPGSQL.sh & and the PGSQL DB server should be ready for connections. STEP 2 - Install Applications Manager in node 1. Install Applications Manager as you would normally do on the remote server. Start this installation at least once and stop it as follows: In Windows services and make sure the ManageEngine Applications Manager service is stopped. From Applications Manager server, open an Administrator command prompt window. Go to folder and run the following command: shutdownApplicationsManager.bat -force. Repeat the above command to ensure that all processes are stopped. Open the /conf/AMServer.properties file in Wordpad and update below entries and save it: am.dbserver.type=pgsql am.db.port=15432 (Port number can be confirmed from the /working/pgsql/data/amdb/postgres_ext.conf file of the PGSQL DB Server you installed.) am.dbport.check=false Update the database_params.conf file shown in below 2 locations.They are identical files.Only change you have to make is for the jdbc URL as shown below. Update the hostname and port of the remote server running your PGSQL DB here. Url jdbc:postgresql://paulp0558:15432/amdb? dontTrackOpenResources=true&useUnicode=true&characterEncoding=UTF-8 AppModules TopoDB- MapDB-EventDB-AlertDB-PollDB-PolicyDB-USERSTORAGEDB-ApplnDB Update the same for database_params.conf file located in below 2 locations: .. /working/conf/PGSQL .. /working/conf Now you may start Applications Manager from Windows Services.It will be connected to the PGSQL running on the remote server.This will act as the primary server. Check in the /logs/wrapper.log file. In Linux you can start and track the startup process as follows: nohup sh startApplicationsManager.sh & Press ENTER tail -f nohup.out STEP 3 - Install Applications Manager in node2. This will act as Secondary server. Install Applications Manager as you would normally do on the remote server. Start this installation at least once and stop it as follows: In Windows services and make sure the ManageEngine Applications Manager service is stopped. From Applications Manager server open an Administrator command prompt window. Go to folder and run following command: shutdownApplicationsManager.bat -force Repeat the above command to ensure that all processes are stopped. Open the /conf/AMServer.properties file in Wordpad and update below entries and save it: am.dbserver.type=pgsql am.db.port=15432 (Port number can be confirmed from the \working\pgsql\data\amdb\postgres_ext.conf file of the PGSQL DB Server you installed.) am.dbport.check=false Update the database_params.conf file shown in below 2 locations. They are identical files. Only change you have to make is for the jdbc URL as shown below. Update the hostname and port of the remote server running your PGSQL DB here. Url jdbc:postgresql://paulp0558:15432/amdb? dontTrackOpenResources=true&useUnicode=true&characterEncoding=UTF-8 AppModules TopoDB-MapDB- EventDB-AlertDB-PollDB-PolicyDB-USERSTORAGEDB-ApplnDBUpdate the same for database_params.conf file located in below 2 locations: .. /working/conf/PGSQL .. /working/conf Now you may start Applications Manager from Windows Services. This installation will not start completely as the Primary is already up and running. It will start and will listen to the Primary Server. The same can be confirmed from the /logs/wrapper.log file. Note: In Linux, you can start and track the startup process as follows: nohup sh startApplicationsManager.sh & Press ENTER tail -f nohup.out Sample Nohup Output INFO | jvm 1 | 2013/08/05 01:00:06 | Checking for the availability of the Primary Server in the Database. Found an entry. INFO | jvm 1 | 2013/08/05 01:00:06 | INFO | jvm 1 | 2013/08/05 01:00:06 | Trying to connect to the Primary Server at 192.168.1.3 INFO | jvm 1 | 2013/08/05 01:00:06 | INFO | jvm 1 | 2013/08/05 01:00:07 | Please wait ... INFO | jvm 1 | 2013/08/05 01:00:08 | ....Connected INFO | jvm 1 | 2013/08/05 01:00:08 | INFO | jvm 1 | 2013/08/05 01:00:08 | INFO | jvm 1 | 2013/08/05 01:00:08 | Starting AdventNet Web NMS Standby Server. The Modules will be started once it takes over as the Primary Server. INFO | jvm 1 | 2013/08/05 01:00:08 | INFO | jvm 1 | 2013/08/05 01:00:08 | Monitoring the Primary Server at 192.168.1.3 When node1Applications Manager goes down, node2Applications Manager will start up completely and will act as secondary server. Email notifications will be triggered on occurrence of a failover where you have to correct the issues with the node that is down. Then start it back as secondary which will now listen for another failure. INFO | jvm 1 | 2013/08/05 01:09:47 | Monitoring the Primary Server at 192.168.1.3 INFO | jvm 1 | 2013/08/05 01:10:48 | Starting to do FailOver Tasks. INFO | jvm 1 | 2013/08/05 01:11:08 | Process : AlertFE [ Started ] INFO | jvm 1 | 2013/08/05 01:11:08 | Process : NmsMainFE [ Started ] INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:08 | Verifying connection with web server... verified INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:08 | Applications Manager started successfully. INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:08 | Please connect your client to the web server on port: 9095 INFO | jvm 1 | 2013/08/05 01:11:08 | INFO | jvm 1 | 2013/08/05 01:11:09 | The new primary server is 192.168.1.4 Note: Above steps need to be implemented for each installation in the Enterprise setup for failover. Web Client Browse through the following sections to know more about the components available in Applications Manager Web Client: Web Client Details Icon Representation Dashboards & Widgets Custom Fields Mobile Web/iPhone App Bulk Import of Monitors Web Client DetailsYou can access Applications Manager Webclient via Programs Menu → ManageEngine Applications Manager → Applications Manager Start (Applications Manager starts and the webclient opens up) If you have already started Applications Manager, you can find a small icon on the Taskbar - Right click on the Applications Manager tray icon to access the webclient If Applications Manager is running in host - [Appln-Server] -port - 9090, you can directly access the webclient through the browser URL - http://Appln-Server:9090. You can view the monitors from an internet site or from any remote machine via this URL. The following are the links that are common throughout all the screens in the Applications Manager: Quick Note: Provides a brief description about the functioning of the different parameters on which you are currently working. Talk Back: You can send your technical feedback about Applications Manager by filling up the form. About: You can see the details of Applications Manager like Build No, SP version, type of license etc., and also the credits roll of the contributors to the product. Personalize: Provides an option to view the Applications Manager with a different look and feel, as you prefer. For more details, refer to the Personalize section of Performing Admin Activities. Licensing: You can apply the registered License file that you have purchased, by clicking on this link. Help: Provides detailed information about working with the product. Note that the help is context sensitive and you can click on the Home link to view the main page of Applications Manager Help Docs. Get Quote: You can send a sales quote to Applications Manager Sales team based on your monitoring requirement.. Logout: To log out and return to login page. Search: The Search Field is placed on the left side and in all pages of the web client. It provides an option for searching relevant links for some keywords in the product. The keyword-specific links are categorized as Monitors, Help Documents, Bookmarks (pre-defined), and Reports that list the links under their respective category based on the keyword. For example, searching for keywords such as Monitors provide the relevant links under Help Documents and Bookmarks and for WebLogic, the links are categorized under Help Documents, Bookmarks, and Reports. Alarm Summary : Lists the recent critical alarms of Applications Manager. You can also click on the shades (representing the different severity) in the graph that will display the alarms based on the severity. Printer Friendly : This option is available in all the pages of the web client. Clicking this link provides you a printer friendly view of the current page. This comes handy for printing Alarms and Reports. Screenshot : Allows you to capture screenshots of your Applications Manager display. You can take screenshots either by capturing the full screen (Visible Area) or by capturing a part of the screen (Partial Area). After capturing the necessary screenshots, you can share them with Applications Manager support by filling the necessary Subject and its Description in detail. Clicking on Submit will trigger an email to Applications Manager support. Note: A maximum of 5 screenshots can be stored locally. (Older screenshot will be removed if exceeded) In order to trigger an email, you need to configure your mail server through SMTP server. Click here to learn how to configure your mail server. Note: By clicking on Jump to link, you can choose to log into ManageEngine ServiceDesk Plus / ManageEngine OpManager from Applications Manager console itself. And also, in Enterprise Setup, you can choose to jump to the Managed Servers from Admin Server. Icon Representation The following are the icons used in Applications Manager and their significance: Widgets Icon Signifies Severity Health is Critical Health is WarningHealth is Clear Health Unknown Availability Down Availability Up Health of Numerical Attribute is Critical Health of Numerical Attribute is Warning Health of Numerical Attribute is Clear Health of Numerical Attribute is Unkown Report Report generated by monitoring the attribute of the Monitor for 7 days. Report generated by monitoring the attribute of the Monitor for 30 days. General Icon Signifies Edit icon to make changes in the configurations. Alarm Configuration icon where the thresholds and actions of the attributes are associated with the Monitor/ Monitor Group. Business View icon Pop Out Edit Tabs. Assign Dashboards to tabs. Add Annotation. View Alarm Summary Printer Friendly Page Take Screenshot (Alt+Shift+S) View Help Documentation Show Widget Properties Edit Widget Reload Widget Delete Widget Dashboards & Widgets Dashboards Custom Dashboards Creating a new Dashboard Widgets Topology Map view Dashboards Applications Manager comes with four Dashboards - Default Dashboard, Business View, Availability and QoS Worldwide (Quality Of Service Worldwide). QoS Worldwide This is done using ''Embed webpage'' widget . This dashboard helps you monitor your websites from outside your data center. Site24x7 is a website monitoring service that helps manage end user experience from a global point of presence. It helps monitor application and web service performance from a location closer to where your actual customers are. Business Dashboards: You can quickly configure your business metrics like customer wins, revenue, etc. It helps the Manager to allign IT with business needs.Monitor Group Template Dashboards: After configuring a dashboard, you can save the settings as monitor group template. This monitor group template can then be applied for other monitor groups, thereby it becomes easier to create dashboards for monitor groups. Custom Dashboards By using Custom Dashboards feature, you can create Dashboards of your choice - like Status View of all the Databases, Status view of all Web Applications deployed in Tomcat Server. By adding the different widgets given, custom dashboards can be created. This is in addition to the already created four Dashboards - Default Dashboard, Business View, Availability and QoS Worldwide (Quality Of Service Worldwide). Creating a new Dashboard Under Home tab, click on New Dashboard link. It opens up the Create New Dashboard page. Enter the Dashboard Name and Description You can then configure the layout of the dashboard by selecting the number of columns and their size. You can save the dashboard settings as template and apply it to monitor groups. You have the option of applying the template to specific monitor groups or apply it across all the monitor groups. Then from the Widget list, you can choose the widgets you want to add. Click on Create. The new dashboard would be created with your choice of widgets. When you add a widget to the Dashboard, an empty widget will be added with an option to edit it. Click on edit widget icon and change the filter criteria for the widget until you get the desired data for the widget. Widgets Top N Monitors: This widget displays Top N monitors based on a performance metric.To view the data ,select a performance metric and select the monitors from which Top N should be listed. You have an option to view the graph for the selected time period. Performance Metric Widget: This widget displays the Snapshot value of a specific Monitor''s performance metric. You have an option to view the graph for the selected time period. Threshold Breakers: This widget displays all the monitors which have exceeded the threshold Performance for a performance metric. You have an option to view the graph for the selected performance Widgets metric. Tabular Data: This widget displays values in a tabular format, packs more data in a smaller area. Topology Map View: This widget displays the interconnection of different resources in your enterprise on a map and also associate links between them. You can use the Topology Map widget to view, say, a small number of your available devices and servers that are spread across the globe or across different locations. Know More about the Topology Map View and how to create one. Availability Infrastructure Snapshot: This widget gives you a snapshot of availability and health of monitors and Health grouped by Monitor Type. Widgets Availability & Health Status: Multiple Monitors: This widget lets you view the snapshot of monitors of specific Type. Last 24 Hours / 30 Days Availability History: This widget displays the Availability history for last 24 hours / 30 days for all monitors of selected Type. Last 24 Hours / 30 Days Health History:This widget displays the Health history for last 24 hours / 30 days for all monitors of selected Type. Availability, Health and Alarm Summary: This widget displays Availability and Health status and Alarm status for the selected Monitor category. Heat Map Widget: This widget displays the severity status for the Health and Availability of selected monitors in various coloured boxes, each representing the severity status of specific monitors. Also, you have an option to display the summary chart of all the selected monitors which allows you to quickly grasp the state and impact of monitors in the form of a pie chart. Monitor Status Overview: This widget displays the overall status based on the availability of selected monitors in different colors, each representing the availability status, along with the overall monitor count in the form of a pie chart.ADDM Dependency Map: This widget displays the visual map view of the servers and their associated applications that are available and connected to each other for the selected Dependency Map. Monitors under Downtime Schedules/Unmanaged Widget: This widget displays the list of monitors for which downtime schedules have been assigned and shows whether the monitors are currently in scheduled maintenance or unmanaged state. Last N Alarms: This widget displays the last N alarms for all the monitors. Monitors by Status and Downtime Widget: This widget shows the health and availability status Alarms of all monitors that are down for a certain time duration. Alarm Summary Widget: This widget displays alerts for all monitors and monitor groups. Availability and Health Status: This widget displays all the Monitor Groups Availability and Health snapshot and Last 24 hours availability. Last 24 Hours / 30 Days Availability History: This widget displays the Availability history for last 24 hours / 30 days for all Monitor Groups. Last 24 Hours / 30 Days Health History: This widget displays the Health history for last 24 hours Monitor / 30 days for all Monitor Groups. Group Widgets Business View Widget: This widget displays the Business View of the Monitor Groups. Monitor Group Tree View: This widget displays a hierarchial tree view of the list of Monitor Groups and their associated Monitors that are present in the environment, along with their health and availability status. World Map View: This widget displays the Monitor Groups, and Sub Groups in a map view provided location has been assigned to the respective groups. Embed Web Page: This widget allows you to include a web page from another application into your dashboard.You can use this widget to integrate your custom dashboards. Utility Widgets Bookmarks: This widget allows you to add weblinks to important documents, KBase articles. Custom HTML or Text: This widget allows you to add notes to your operator.   Widget and Dashboard Actions Click on Actions tab to perform administrative operations for dashboards. Action Description Add Widgets Adds new Widgets Edit Dashboard Edits the custom created dashboards Delete Dashboard Deletes the selected dashboard New Dashboard Creates new dashboard Publish Dashboard: The selected dashboard can be integrated with your Web Portal by using the Javascript Code Snippet given. So, those who can access your webportal can see the dashboard also. Set as Default: The selected dashboard is set as the default dashboard. So, whenever you access the home tab, this dashboard would be displayed by default. Limitations of Widgets: If you install a Non-English Version, say Chinese version, of Applications Manager, and then change your language settings to English, the Widget and Dashboard names will not automatically be translated from Chinese to English characters.  You can, however, manually edit the Dashboard or Widget and change the name to English characters. Note: By clicking on Tabs Edit icon you can choose the order in which the dashboard will be listed under the Home tab. Topology Map ViewA topology map is an effort to visualize the interconnection of different resources in an enterprise on a map. you can group a certain set of network devices and servers of your choice under a Map View and also associate links between them. You can also create a sub map view within a map and display the same as a shortcut icon in a Map View. Background images [global maps, etc.] can be used for the Map View using the available default images or, you can also import your own background image. Creating a Topology Map View Widget Adding a new Topology Map Creating a Topology Map View Widget: In the home tab, under click the actions button and choose the New Dashboard link. It opens up the Create New Dashboard page. Enter the Dashboard Name and Description You can then configure the layout of the dashboard by selecting the number of columns and their size. You can also save the dashboard settings as template and apply it to monitor groups. You have the option of applying the template to specific monitor groups or apply it across all the monitor groups. Then from the Widget list, choose Topology Map View under the Monitor Group Widgets. Click on Create. A new dashboard will be created with an empty Topology Map View widget. Click on the Edit Widget button to add/associate a topology map. A new Edit Widget form pops up. Add a widget name and description. Either choose one of the existing Topology Maps from the drop down menu or click add to add a new map view. Click Save Configuration. The Topology Map will be displayed in your widget. Adding a new Topology Map In the New Map View form, enter the Map View Name. Select the Background map from the drop down list [or, click on the Browse button to import a map / image of your choice; you may even keep the background blank by not selecting any image]. Select the device Category from the drop-down list. Select the required devices from the list of available devices. Select the device and click the >> symbol to add them to the map. [You may select all network devices or deselect all network devices using the appropriate check box provided] Click Done. You now see the Map View with the selected network devices and background image. The Map View is now seen in the Editmode. The following actions are supported from the edit mode: Add more devices / servers to the map Add Links between 2 devices Add Shortcut on this map to another map. Delete the map Modify the Map Properties, i.e. the background Map image. After performing the desired actions, you can save the map by clicking on the Save button. Custom Fields As you monitor your applications and servers using Applications Manager, you may come across situations where certain important server-related data is not captured by the default fields present in Applications Manager. In such situations, you may want to add extra field types to capture that information. The ''Custom Fields'' option allows you to configure these extra field types as per your business requirements. Configuring Custom Fields Click the Custom Fields button in the Monitor Information section of the monitor details page. This will open the Custom Fields section immediately below, where you can modify existing fields or add new fields. There are 3 different tabs in the ‘Custom Fields’ section.Custom Fields: In this tab, there are some preset fields such as Label, Impact, etc. You can edit the fields and specify their values as necessary. Apart from the default fields, you can add custom fields of your own if required. Just click the icon in the right-hand corner of the ‘Custom Fields’ tab. This will open the ‘Add/Remove Custom Fields’ popup window where you can add new fields, edit current fields or remove unwanted fields. Mark as PII: PII stands for Personally Identifiable Information. In Custom fields, the user can enter any details that might contain PII. On doing this, the field will be encrypted and stored in the database. Since Location is a PII, it will be encrypted and stored by default. User/Owner: This tab allows you to associate users to the particular monitor or monitor group. All types of user roles such as user, operator, administrator, and manager are supported. Location: In this tab, you can specify information pertaining to the physical location of the server. The available fields include Location Name, Floor, building, city, state, country, postal code and zip code. Note: The default values for custom fields of a monitor are inherited from the parent monitor group. Custom Fields in Enterprise Edition Although the custom fields option is available in both Professional and Enterprise editions of Applications Manager, there are a few minor differences in the way they can be configured in the Enterprise edition. From the admin server, you can add new fields, enable/disable fields, values, etc. for the monitors of the admin server. You will have full control over the monitors of the admin server. You cannot create or edit new fields in a managed server. You can only assign values to existing fields. Note: Custom fields cannot be configured for external device monitors (i.e. monitors from ManageEngine OpManager such as routers and switches). However, they can be assigned to a monitor group. You can assign multiple values for certain fields such as label and user. Top Mobile Client, iPhone and Android App ManageEngine Applications Manager Mobile Web, iPhone App and Android App allows your technicians to access the Applications Manager performance data from your smartphones. With on-the-go monitoring you can reduce the time for resolution of a fault occurring in your system, thereby increasing the overall availability of your business services. ManageEngine Applications Manager provides three options: Use the Mobile Web Client, which can be accessed using popular Mobile Web browsers. Use the Applications Manager iPhone App, available in the iPhone App Store. Use the Android App, available in the Google Play Store Optimized for most types of smart phones, Applications Manager provides a convenient method to track critical applications, perform actions, receive alerts and identify issues quickly and easily from any location. There are seven views that are mainly available via your mobile: Infrastructure View Monitor Group View Dashboards Alarms Down Monitors ActionsSearch Infrastructure View Infrastructure view displays a list overview of all the monitors associated with a user classified into various categories, say Applications Servers, Database Servers etc. This view enlists the overall availability and health status and their health outages (the number of monitors in error by the total number of monitors). For usability reasons, the monitor types with critical health status are shown at top of the page. You can view the list of monitors of a particular type by clicking on any category under the list. By clicking on the monitor name will display a monitor details page where we can poll, manage/unmanage and ping the monitor. Monitor Group View Monitor group view lists all the configured top level monitor groups. This gives a clear view of the day''s availability and health status of a monitor group or subgroup and the outages. This makes it easier to track if one of the monitors have failed. As in the Infrastructure View, you can click on a monitor group to see details like the total number of monitors associated to the group. Dashboards The dashboards view is for users who want a bird''s eye view summarizing the dashboards alone. By clicking on any of the dashboards, you can list the widgets configured. Further, you can click on the widget names to know the widget details. Alarms By default, this view lists all the critical and warning alarms. You also have the option to list the clear alarms. The alarms are sorted based on the time of creation. By clicking on the health icons, you can get a summary of the alarm details. Clicking on an alarm opens the alarm details page where you can manage/unmanage alarm or clear the alarms. From an alarm details page you can also go the monitor or group details page by clicking on its name.  Down Monitors/ Outages This view lists all the ''down'' or unavailable monitors associated to the user. From this view you also get a summary of the down monitor details like how long the monitor has been down. Clicking on the monitor name, displays a page where you can poll, manage/unmanage and ping the monitor. Actions This view will list all the action types associated with each of the monitors. Clicking on the action type lists the actions. You can view action details by clicking on the action name. From this view, you can execute the action. This is useful for executing actions like Windows service actions, Amazon EC2 actions and VM actions. Search You can display the Search page from the drop-down menu at the top of the page or from the tab at the bottom. You can use the search bar to search for any keyword. The Search result will have the list of monitors or monitor groups related to the keyword along with their availability and health status. You can go to the monitor/group details page by clicking on the monitor/group name. The seven monitoring views in the Mobile Client of Applications Manager are tailored to meet the end user''s needs and provides you with effective portable monitoring of your environment. Note: Dashboards and Actions are not supported in the iPhone App. Push Notification The iPhone/Android app provides you with push notifications for health and availability related alerts. To set it up, use the ''Settings'' option in the home page and then ''Notification Settings'' to customize the various options. By default, the option to notify during a Critical Health condition will be enabled. Server Settings: To run Applications Manager''s iPhone/Android app, you have to provide Applications Manager installation details. For this, click on the link ''Server Settings'' from the login page and find options to Edit or Add applications manager server details. Click on the ''+'' symbol and provide the Applications Manager Host Name and SSL Port. You can also use this page to add multiple installations of Applications Manager. Select the particular row to switch between the various installations and use the ''Sign In'' button at the top of the screen to land in the login page.Bulk Import of Monitors Selecting this option, you would be able to add monitors of the same type in bulk. By giving all the configuration details in a .csv file, bulk import of monitors is made possible. Bulk Import of Monitors: Click on New Monitor link, select the monitor type you want to add. In the New Monitor screen, you will find the link to Bulk Import Monitor.Clicking on that link will take you to Bulk Import Monitor screen. Here, you can upload the .csv file that has all the configuration details. The file would be uploaded to the Applications Manager Machine in the location \working\bulkadd\ . This file will be deleted once the discovery for monitors is scheduled, for security reasons. The list of all monitors to be added is listed down. On clicking ''Start Discovery'', all the monitors would be added to Applications Manager. Format for Bulk Import .csv file Monitor Details Type Format for the Bulk Import csv file : Active #Header:DisplayName,HostName,UserName,Password,MonitorGroup,PollInterval Directory * Download a sample csv file. Format for the Bulk Import csv file : Amazon #Header:DisplayName,Access Key ID,Secret Access Key,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : Apache Solr #Header: DisplayName,Host Name / IP Address,Port,SSL is enabled,MonitorGroupID,PollInterval * Download a sample csv file Format for the Bulk Import csv file : BizTalk #Header:DisplayName,credentialID,HostName,UserName,Password,Enable PowerShell (for Application Name),Database Server,Database Name,MonitorGr * Download a sample csv file. Format for the Bulk Import csv file : Ceph #Header:DisplayName,HostName/IP Address,Prompt,UserName,Password,credentialID,MonitorGroupID,PollInterval Storage * Download a sample csv file. Format for the Bulk Import of csv file : #Header: DisplayName,HostName,SubNetMask,Port,UserName,Password,DatabaseName,MonitorGroup,PollInterval CouchBase **MonitorGroup,PollInterval entries are optional. * Download a sample csv file. Format for the Bulk Import csv file : DNS #Header:DisplayName,Target Address,Lookup Address,Timeout,Record Type,Search Field,Search Value,MonitorGroup,PollInterval,Run on server,Run on age * Download a sample csv file. Docker Format for the Bulk Import csv file : #Header:DisplayName,HostName/IP Address,Port,Username,Password,SSL is enabled,credentialID,MonitorGroupID,PollInterval TestDocker,apm-u12-temp,4243,,,false,,,5 SecuredDocker,102.198.12.4,2376,User,User123,true,,10000095,10* Download a sample csv file. Format for the Bulk Import csv file : DOTNET #Header: DisplayName,HostName,SubNetMask,UserName,password,credentialID,MonitorGroupID,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : ESX #Header:DisplayName,HostName/IP Address,Port,UserName,Password,VM Discovery,MonitorGroupID,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : #Header:DisplayName,Host Name / IP Address,Version,Exchange 2013 Role,Exchange 2010 Role,Exchange 2007 Role,Exchange 2013 Mailbox Services,Exch Services,Exchange 2013 Edge Services,Exchange 2010 Mailbox Services,Exchange 2010 Client Access Services,Exchange 2010 Hub Transport Services,Exc Exchange Services,Exchange 2010 Unified Services,Exchange 2007 Mailbox Services,Exchange 2007 Client Access Services,Exchange 2007 Hub Transport Services,E Services,Exchange 2007 Unified Messaging Services,Exchange 2003/below Services,User Name,Password,credentialID,Mode Of Monitoring,Customize Co URI,MonitorGroupID,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : #Header:DisplayName,Target Address,User Name,Password,Port No,Timeout,Is Secured,Download File,Show availability down when download fails,Remote FTP Destination,File Name,Upload File,Show availability down when upload fails,Local Source,File Name,Remote Destination,File Name,MonitorGroup,PollInter * Download a sample csv file. Format for the Bulk Import csv file : GlassFish #Header:DisplayName,HostName,Port,UserName,Password,JNDIPath,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : #Header:DisplayName,Mode Of Monitoring,Version,NameNode, HostNameNode, JMX Port,NameNode Web Port,is SSL Enabled,Authentication Type,UserNa JNDIPath,JobTracker/ResourceManager Host,JobTracker/ResourceManager JMX Port,JobTracker/ResourceManager Web Port,is SSL Enabled,Authentication Hadoop Type,UserName,Password,JobTracker/ResourceManager JNDIPath,MonitorGroupID,PollInterval * NameNode and JobTracker/ResourceManager must be added using the same mode * Download a sample csv file. Format for the Bulk Import csv file: HBase #Header:DisplayName,Host Name / IP Address,JMX Port,typeOfNode,credentialID,Is Authentication required,UserName,Password,JNDI Path,PollInterval,Mo * Download a sample csv file. Format for the Bulk Import csv file : Horizon View #Header:DisplayName,Connection Broker Hostname / IP,User Name,Password,MonitorGroupID,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : HyperV #Header:DisplayName,Host Name / IP Address,User Name,Password,Monitor Performance Metrics of Virtual Machines,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : IBM #Header:DisplayName,Queue Manager,Host Name,Listener Port,CCSID,Server Connection Channel,MonitorGroup,PollInterval Websphere * Download a sample csv file.IBM DB2 Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,Username,Password,DatabaseName,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : IBM Informix #Header:DisplayName,Host Name / IP Address,Port,Database Server,UserName,Password,credentialID,MonitorGroupID,PollInterval * Download a sample csv file Format for the Bulk Import csv file : Java #Header: DisplayName,HostName,Port,Credential Details,Credential Manager,JNDIName,UserName,Password,MonitorGroup,PollInterval Runtime * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName, HostName, SubNetMask, Port, JBOSSVersion, Username, Password, isSSLEnabled, MonitorGroup, PollInterval JBOSS **MonitorGroup,PollInterval entries are optional * JBOSSVersion can have the following values : 3.2.x or 4.x or 4.0.1 or 4.0.2. * Download a sample csv file. Format for the Bulk Import csv file : Kafka #Header:DisplayName,HostName,JMX Port,credentialID,PollInterval,UserName,Password,JNDIPath,MonitorGroupID * Download a sample csv file Format for the Bulk Import csv file : #Header:DisplayName,LDAP Server,LDAP Server Port,UserName,Password,Search Base,Search Filter,Matching Attribute,Filter Condition,Search Result,Time LDAP PollInterval,Run on server,Run on agent * Download a sample csv file. Format for the Bulk Import csv file : #Header:DisplayName HostName / IP Address Is Secure Connection(SSL) Enable TLS SMTP Port Email ID SMTP Server requires Authentication SMTP UserNa Mail Server POP/IMAP Monitoring Select Mail Fetching Server POP/IMAP Host Is Secure Connection(SSL) Enable TLS Port UserName Password Mail Subject Timeout Mon server Run on agent * Download a sample csv file. Format for the Bulk Import csv file : Memcached #Header:DisplayName,HostName / IP Address,Port,Enable transaction test,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : MSMQ #Header:DisplayName,HostName,UserName,Password,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,UserName,Password,InstanceName,MonitorGroup,PollInterval MSSQL **MonitorGroup,PollInterval entries are optional * If you want to connect using Named Instance specify the field InstanceName .If not please leave this field empty. * Download a sample csv file. MYSQL Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,ForceSSL,UserName,Password,DatabaseName,MonitorGroup,PollInterval **MonitorGroup,PollInterval entries are optional* Each monitor information should be given in the order of the fields specified in the Header. * Download a sample csv file. Format for the Bulk Import csv file : Nginx #Header:DisplayName,Hostname,Port SSL is enabled,Is Authentication required,UserName,Password,Server,Status,URL,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file: OpenStack #Header:DisplayName,Base Authentication URL,Tenant Name,Username,Password,Need Proxy,credentialID,MonitorGroupID,PollInterval * Download a sample csv file Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask, Port,MonitorGroup,PollInterval ORACLE AS **MonitorGroup,PollInterval entries are optional * Download a sample csv file. Format for the Bulk Import csv file : Oracle EBS #Header:DisplayName,HostName,Port,SSL Enabled,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,UserName,Password,InstanceName,MonitorGroup,PollInterval ORACLE **MonitorGroup,PollInterval entries are optional * Download a sample csv file. Format for the Bulk Import csv file : Oracle #Header:DisplayName,HostName,JMX Port,Additional JMX Port,credentialID,PollInterval,UserName,Password,JNDIPath,MonitorGroupID Coherence * Download a sample csv file. Format for the Bulk Import csv file : Oracle #Header:DisplayName,HostName,Port,credentialID,PollInterval,UserName,Password,JNDIPath,MonitorGroupID NoSQL * Download a sample csv file Format for the Bulk Import csv file : Ping #Header:DisplayName,HostName / IP Address,Timeout,MonitorGroup,PollInterval,Run on server,Run on agent * Download a sample csv file. Format for the Bulk Import csv file : Postgresql #Header: DisplayName,HostName,Port,UserName,Password,DBname,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : Rabbitmq #Header:DisplayName Host Name,Port,User Name,Password,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : Resin Server #Header:DisplayName,HostName,Port,UserName,Password,JNDIPath,credentialID,MonitorGroupID,PollInterval * Download a sample csv file REST API Format for the Bulk Import csv file :#Header:DisplayName,Rest API URL,Timeout,Form Submission Method,Pay Load,credentialID,UserName,Password,Custom HTTP(s) Headers,Response Typ response,Should contain,Should not contain,is Case Sensitive,is Regular Expression,MonitorGroupID,PollInterval *Download a sample csv file Format for the Bulk Import csv file : #Header: DisplayName,Host Name / IP Address,SAP HANA Cloud Platform,Port,Account Name,User Name,Password,credentialID,DB User Name,DB Passwo SAP HANA Name,MonitorGroupID,PollInterval * Download a sample csv file Format for the Bulk Import csv file : #Header: DisplayName,HostName,OperatingSystem,SubNetMask,ModeOfMonitoring,UserName,Password,SNMPCommunityString,TelnetSSHCommandPro **MonitorGroup,PollInterval entries are optional Server * OperatingSystem can have the following values : Windows 2003 or Windows 2000 or windows XP or WindowsNT or AIX or FreeBSD or HP-UX or Linux or Mac * ModeOfMonitoring can have the following values : WMI or SNMP or SSH or TELNET . * Download a sample csv file. Format for the Bulk Import csv file : Service #Header: DisplayName,HostName,SubNetMask,Port,CommandtoExecute,MatchContent,PollInterval Monitor * Download a sample csv file. Format for the Bulk Import csv file : SharePoint #Header:DisplayName,HostName,UserName,Password,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : Siebel #Header:DisplayName,Host Name / IP Address,Operating System,Prompt,UserName,Password,Gateway Server,Enterprise Server,Siebel Administrator,Sieb Monitor Directory,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : SilverStream #Header:DisplayName,HostName,Port,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : SSL #Header:DisplayName,Domain,Port,Need proxy to connect the domain,Timeout,MonitorGroup,PollInterval Certificate * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,UserName,Password,DatabaseName,MonitorGroup,PollInterval SYBASE **MonitorGroup,PollInterval entries are optional * Download a sample csv file. Format for the Bulk Import csv file : Telnet #Header: DisplayName,Host Name / IP Address,Port,Timeout(in Seconds),MonitorGroup,PollInterval * Download a sample csv file. TOMCAT Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,TomcatVersion,isSSLEnabled,UserName,Password,MonitorGroup,PollInterval **MonitorGroup,PollInterval entries are optional * TomcatVersion can have the following values : 3.x or 4.x or 5.x or 6.x. * Download a sample csv file.Format for the Bulk Import csv file : Tuxedo #Header:DisplayName,HostName/IP Address,Port,Community String,Timeout,credentialID,MonitorGroupID,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName,URLAddress,CheckForContent,ErrorIfMatch,UserName,Password,TimeoutInSeconds,FormSubmissionMethod,MonitorGroup,PollInte **MonitorGroup,PollInterval entries are optional URL Monitor * Each monitor information should be given in the order of the fields specified in the Header. * FormSubmissionMethod can have the following values : post or get * The attributes CheckForContent,ErrorIfMatch,UserName,Password,TimeoutInSeconds,FormSubmissionMethod are all optional. * For sample a simple form of monitor can just have #DisplayName,URLAddress,CheckForContent. * Download a sample csv file. Format for the Bulk Import csv file : vFabric #Header:DisplayName,HostName,Port,UserName Password,JNDIPath,MonitorGroup,PollInterval * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,WeblogicVersion,Username,Password,MonitorGroup,PollInterval Weblogic **MonitorGroup,PollInterval entries are optional Server * Weblogic_Version can have the following values : 7.0 or 8.1, 9.x, 10.x or 12.x . * Download a sample csv file. Format for the Bulk Import csv file : Web Service #Header: DisplayName,URLAddress,TimeoutInSeconds,MonitorGroup,PollInterval,Username,Password * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,port,WebsphereVersion,SOAPPort,UserName,Password,DeploymentMode,NetworkDeployerHost,NetworkDeployerSO Websphere **MonitorGroup,PollInterval entries are optional Server * Each monitor information should be given in the order of the fields specified in the Header. * WebsphereVersion can have the following values : 5.x or 6.x * DeploymentMode can have the following values BASE or ND. * Download a sample csv file. Format for the Bulk Import csv file : Windows Azure #Header: DisplayName,Subscription Id, Account Name, Account Key,https,Timeout,MonitorGroup,PollInterval Monitor * Download a sample csv file. Format for the Bulk Import csv file : #Header: DisplayName,HostName,SubNetMask,Port,WeblogicIntegrationVersion,Username,Password,MonitorGroup,PollInterval WebLogic **MonitorGroup,PollInterval entries are optional Integration * WeblogicIntegrationVersion can have the following values : 8.x . * Download a sample csv file. Format for the Bulk Import csv file : XenServer #Header:DisplayName,HostName/IP Address,Https Port,UserName,Password,VM Discovery,MonitorGroup,PollInterval Monitor * Download a sample csv file. XenApp Format for the Bulk Import csv file : #Header:DisplayName,HostName,Version,UserName,Password,credentialID,Enable Event Log Monitoring,MonitorGroupID,PollInterval* Download a sample csv file. Appendixes Applications Manager Home Data Collection for Host Resource SNMP Agent Installation SNMP Agent Configuration Security/Firewall Requirements User Management Security Policy Forums and Blogs Add-ons Pricing Third Party Packages Used Applications Manager Home refers to the directory in which you have installed the Applications Manager product. This directory location is specified by you when you install the product. For example, let us assume that you have installed Applications Manager under the default directory of C: drive in your system. In this case, denotes C:/Program Files/ManageEngine/AppManagerxx. In Linux, if Applications Manager is installed under home directory, then  denotes ~/ManageEngine/AppManager_Home Data Collection for Host Resource The important configuration details that are required while discovering host resource by Applications Manager are as follows: Applications Manager Monitor Operating System Operating System Linux Sun Solaris HP-UX / IBM AIX FreeBSD Windows Tru64 Telnet mode Telnet mode Telnet mode of data of data of data collection. collection. collection. Default telnet Default telnet Telnet Telnet Default telnet port is 23. port is 23. mode of mode of port is 23. SSH mode of SSH mode of data data SSH mode of SNMP mode data data collection. collection. data of data collection. collection. Default Default collection. collection, Default SSH Default SSH telnet port telnet port Default SSH default port Linux port is 22 port is 22 is 23. is 23. port is 22 is 161. HOST- SNMP mode SNMP mode SSH mode SSH mode RESOURCE- SNMP mode of data of data of data of data MIB must be of data collection, collection, collection. collection. implemented collection, default port default port Default Default in the Agent. default port is 161. HOST- is 161. HOST- SSH port SSH port is 161. HOST- RESOURCE- RESOURCE- is 22 is 22 RESOURCE- MIB must be MIB must be MIB must be implemented implemented implemented in the Agent. in the Agent. in the Agent. Windows Telnet mode Telnet mode Telnet Telnet Telnet mode Through WMI of data of data mode of mode of of data API (Windows collection. collection. data data collection. Management collection. collection. Information )Default telnet Default telnet Default Default Default telnet . RPC Service port is 23. port is 23. telnet port telnet port port is 23. must be is 23. is 23. running. SSH mode of SSH mode of SSH mode of (Remote data data SSH mode SSH mode data Procedure collection. collection. of data of data collection. Call). Default SSH Default SSH collection. collection. Default SSH port is 22 port is 22. Default Default port is 22 SNMP mode SSH port SSH port of data SNMP mode SNMP mode SNMP mode is 22 is 22 collection, of data of data of data default port collection, collection, collection, is 161. HOST- default port default port default port RESOURCE- is 161. HOST- is 161. HOST- is 161. HOST- MIB must be RESOURCE- RESOURCE- RESOURCE- implemented MIB must be MIB must be MIB must be in the Agent. implemented implemented implemented in the Agent. in the Agent. in the Agent. SNMP Agent Installation (Adapted from Windows help) Installing SNMP Agent on Windows 7 Installing SNMP Agent on Windows 2008 Installing SNMP Agent on Windows XP/2000/2003 Installing SNMP Agent on Windows NT Installing SNMP Agent in Windows 2012 Installing SNMP Agent on Linux Installing SNMP Agent on Solaris You need to know the following information before you install the Simple Network Management Protocol (SNMP) service on your computer: Community names in your network. Trap destinations for each community. IP addresses and computer names for SNMP management hosts. Installing SNMP Agent on Windows 7 To install SNMP on Windows 7 follow the steps given below: You must be logged in as an administrator or a member of the Administrators group to complete this procedure. If your computer is connected to a network, network policy settings may also prevent you from completing this procedure. Click Start and go to the Control Panel, double-click Programs and Features. Alternatively you can also run appwiz.cpl @,2 in the start menu Click Turn Windows features on or off in the left-hand side of the page. Select the Simple Network Management Protocol check box, and click OK. Click Next. Insert the respective CD or specify the complete path of the location at which the files are stored. SNMP starts automatically after installation. This completes the installation process. To configure SNMP agents respond to SNMP requests, refer to Configuring SNMP agents. Installing SNMP Agent on Windows 2008 To install SNMP on Windows XP, 2000 and 2003, follow the steps given below: You must be logged in as an administrator or a member of the Administrators group to complete this procedure. If your computer is connected to a network, network policy settings may also prevent you from completing this procedure.Click Start and go to the Control Panel, double-click Programs and Features. Alternatively you can also run appwiz.cpl @,2 in the start menu Click Turn Windows features on or off in the left-hand side of the page. Select the Simple Network Management Protocol check box, and click OK. Click Next. In Server Manager click Add Features In Add Features Wizard, check the SNMP Services option checkbox and Install. This completes the installation process. To configure SNMP agents respond to SNMP requests, refer to Configuring SNMP agents. Installing SNMP Agent on Windows XP, 2000 and 2003 To install SNMP on Windows XP, 2000 and 2003, follow the steps given below: You must be logged on as an administrator or a member of the Administrators group to complete this procedure. If your computer is connected to a network, network policy settings may also prevent you from completing this procedure. Click Start, point to Settings, click Control Panel, double-click Add or Remove Programs, and then click Add/Remove Windows Components. In Components, click Management and Monitoring Tools (but do not select or clear its check box), and then click Details. Select the Simple Network Management Protocol check box, and click OK. Click Next. Insert the respective CD or specify the complete path of the location at which the files are stored. SNMP starts automatically after installation. This completes the installation process. To configure SNMP agents respond to SNMP requests, refer to Configuring SNMP agents. Installing SNMP Agent on Windows NT To install SNMP in Windows NT, follow the steps given below: Right-click the Network Neighborhood icon on the Desktop. Click Properties. Click Services. Click Add. The Select Network Service dialog box appears. In the Network Service list, click SNMP Service, and then click OK. Insert the respective CD or specify the complete path of the location at which the files are stored and click Continue. After the necessary files are copied to your computer, the Microsoft SNMP Properties dialog box appears. This completes the installation process. To configure SNMP agents respond to SNMP requests, refer to Configuring SNMP agents. Configuring SNMP Agent in Windows 2012 Log into your dedicated server using Remote Desktop. Click on Windows Key > Administrative Tools > Server Manager. Click Manage > Add Roles and Features. Click Next > Next > Next > Next. Verify SNMP Services are installed. Click Cancel.Click on Windows Key > Administrative Tools > Services. Right click on SNMP Service and click on Properties. Click on the Security tab.  Type your randomized 8 - 10 character connection string. Be sure to make it Read-Only, not Read Write. Click on Add.   Installing SNMP Agent on Linux systems The installation of new version of SNMP is required only for versions prior to 8. Download the latest rpm version of SNMP using the following URL: http://prdownloads.sourceforge.net/net-snmp/net-snmp-5.1.1-1.rh9.i686.rpm? download Download the zip version of SNMP using the following URL: http://heanet.dl.sourceforge.net/sourceforge/net-snmp/ucd-snmp-4.2.6.tar.gz To install using the rpm, follow the steps given below: Login as "root" user.Before installing the new version of net-snmp, you need to remove the earlier versions of net-snmp in your machine. To list the versions of net-snmp installed in your machine, execute the following command: rpm -qa | grep "net-snmp" If there are already installed version in your machine, remove them using the command: rpm -e --nodeps If there are no previously installed versions in your machine, then execute the following command to install the new version: rpm -i --nodeps   To install using the zip, follow the steps given below:   Extract the file using following command: tar -zxvf ucd-snmp-4.2.6.tar.gz   To install SNMP, follow the steps given below: Login as root user. Execute the command to set the path of the C compiler: export PATH= :$PATH Execute the following four commands from the directory where you have extracted the ucd-snmp: ./configure --prefix= --with-mib-modules="host" directory_name is the directory to install SNMP agent. Preferably choose a directory under /root. The directories /usr and /local might contain the files of an older version of SNMP and so do not choose these directories to ensure proper installation. make umask 022 make install This completes the installation process. To configure SNMP agents respond to SNMP requests, refer to Configuring SNMP agents. Installing SNMP Agent on Solaris Systems Download the latest version of SNMP using the following URL: http://heanet.dl.sourceforge.net/sourceforge/net- snmp/ucd-snmp-4.2.6.tar.gz Extract the file using following command: tar -zxvf ucd-snmp-4.2.6.tar.gz To install SNMP, follow the steps given below: Note: To Install in Solaris 8, Follow the given steps: This completes the installation process. For configuring SNMP agents to respond to SNMP requests, refer to Configuring SNMP agents. Login as root user. Execute the command to set the path of the C compiler: export PATH= :$PATH Execute the following four commands from the directory where you have extracted the ucd-snmp: ./configure --prefix= --with-mib-modules="host" directory_name is the directory to install SNMP agent. Preferably choose a directory under /root. The directories /usr and /local might contain the files of an older version of SNMP and so do not choose these directories to ensure proper installation. make umask 022 make installThe package would be installed. The package is configured with the compile option of " ./configure --with- mib-modules=host ". The agent would have support for host-resource-mib. netsnmp-5.1.1 package is available in the following url ftp://ftp.sunfreeware.com/pub/freeware/sparc/8/netsnmp-5.1.1-sol8-sparc-local.gz. This package is for solaris8 on sparc. gunzip netsnmp-5.1.1-sol8-sparc-local.gz. pkgadd -d netsnmp-5.1.1-sol8-sparc-local. To start netsnmp agent: Execute - # /usr/local/sbin/snmpd. To stop this daemon: Execute - # pkill -9 -x -u 0 snmpd SNMP Agent Configuration Configuring SNMP agent in Windows XP/2000/2003 Configuring SNMP agent in Windows NT Configuring SNMP Agent in Windows 2012 Configuring the SNMP Agent in Linux versions prior to 8 Configuring the SNMP Agent in Linux versions 8 and above Configuring the SNMP Agent in Solaris Systems Configuring SNMP Agent in Windows 7, XP, 2008 and 2003 Systems For details about installing SNMP agents in Windows systems, refer to Installing SNMP Agent on Windows Systems. To configure SNMP agent, follow the steps given below: Click Start, point to Settings, and then click Control Panel. Double-click Administrative Tools and then double- click Computer Management. In the console tree, click Services and Applications and then click Services. In the details pane, scroll down and click SNMP Service. On the Action menu, click Properties. On the Security tab, select Send authentication trap if you want a trap message to be sent whenever authentication fails. Under Accepted community names, click Add. Under Community Rights, select a permission level for this host to process SNMP requests from the selected community. In Community Name, type a case-sensitive community name, and then click Add. Specify whether or not to accept SNMP packets from a host: To accept SNMP requests from any host on the network, regardless of identity, click Accept SNMP packets from any host. To limit acceptance of SNMP packets, click Accept SNMP packets from these hosts, click Add, type the appropriate host name and IP or IPX address, and then click Add again. Click Apply to apply the changes. Configuring SNMP Agent in Windows NT Systems For details about installing SNMP agents in Windows systems, refer to Installing SNMP Agent on Windows Systems. To configure SNMP agent in Windows NT systems, follow the steps given below: Click Start, point to Settings, and then click Control Panel. Double-click Administrative Tools, and then double- click Services.In the details pane, click SNMP Service and then click Properties. Click the Security tab. If you want to send a trap for failed authentications, select the Send Authentication Trap check box. Under Accepted Community Names, click Add. In the Community Names box, type a community name from which you will accept requests. To move the name to the Accepted Community Names list, click Add. Repeat step 7 for any additional community name. To specify whether to accept SNMP packets from any host or from only specified hosts, click one of two options: Accept SNMP Packets From Any Host, if no SNMP packets are to be rejected on the basis of source computer ID. Only Accept SNMP Packets From These Hosts, if SNMP packets are to be accepted only from the computers listed. To designate specific hosts, click Add, type the names or addresses of the hosts from which you will accept requests in the IP Host or IPX Address box, and then click Add to move the name to the Only Accept SNMP Packets From These Hosts list. Repeat step 9 for any additional hosts. On the Agent tab, specify the appropriate information (such as comments about the user, location, and services). Click OK to apply the changes. Configuring SNMP Agent in Windows 2012 Log into your dedicated server using Remote Desktop. Click on Windows Key > Administrative Tools > Server Manager. Click Manage > Add Roles and Features. Click Next > Next > Next > Next. Verify SNMP Services are installed. Click Cancel. Click on Windows Key > Administrative Tools > Services. Right click on SNMP Service and click on Properties. Click on the Security tab.  Type your randomized 8 - 10 character connection string. Be sure to make it Read-Only, not Read Write.Click on Add. Configuring the SNMP Agent in Linux versions prior to 8 For details about installing SNMP agents in Linux systems, refer to Installing SNMP Agent on Linux Systems Stop the agent if it is running already, using the command: /etc/rc.d/init.d/snmpd stop Make the following changes in /etc/rc.d/init.d/snmpd file Replace the line daemon /usr/sbin/snmpd $OPTIONS with daemon /root/ucd_agent/sbin/snmpd $OPTIONS Replace the line killproc /usr/sbin/snmpd with killproc /root/ucd_agent/sbin/snmpd This is to choose the current installed version while starting and stopping the SNMP agent. Start the agent using the command /etc/rc.d/init.d/snmpd start. Configuring the SNMP Agent in Linux versions 8 and above On Linux versions 8 and above, the latest version of SNMP will already be available. You need to just make the following changes in snmpd.conf file: Insert the lineview    allview    included   .1.3.6 next to the line #   name    incl/excl    subtree     mask(optional) Change the line access  notConfigGroup ""  any   noauth   exact  systemview none none next to the line #   group  context sec.modelsec.level prefix read   write  notif as access  notConfigGroup ""  any   noauth   exact  allview none none Then restart the snmp agent using the following command: /etc/rc.d/init.d/snmpd restartConfiguring the SNMP Agent in Solaris Systems For details about installing SNMP agents in Solaris systems, refer to Installing SNMP Agent on Solaris Systems. Stop the agent if it is running already using the following command: /etc/init.d/init.snmpdx stop Make the following changes in /etc/init.d/init.snmpdx file Replace the lines if [ -f /etc/snmp/conf/snmpdx.rsrc -a -x /usr/lib/snmp/snmpdx ]; then /usr/lib/snmp/snmpdx -y -c /etc/snmp/conf -d 3 -f 0 fi with /sbin/snmpd Replace the line /usr/bin/pkill -9 -x -u 0 ''(snmpdx|snmpv2d|mibiisa)'' with /usr/bin/pkill -9 -x -u 0 ''(snmpd)'' Restart the agent using the following command: /etc/init.d/init.snmpdx start. Security/Firewall Requirements This section explains how the Applications Manager can be accessed behind a firewall. Fire walls act as barriers preventing unauthorized access to a network. They act as entrance through which authorized people may pass and others not. You need to configure the firewall so that the host on which Applications Manager runs, can access the monitor at the relevant port. Note: It is important to know that all ports must be opened for bi-directional communication to take place. Ports to be opened when Monitors are behind the firewall: Monitors Port Details APPLICATION SERVERS Glassfish Glassfish JMX port (default : 8686) Two-way communication between JBoss web server port (default : 8080) and Applications Manager web server port (default : 9090). JBoss Applications Manager hostname should be accessible from JBoss server. JBoss RMI object port (default : 4444). Jetty Enable JMX for monitoring. The JMX Port for default installations of Jetty is 9999. Windows Management Instrumentation (WMI) -- Port: 445 Microsoft .Net Remote Procedure Call (RPC) (default : 135) Know more about the  ports required for WMI Mode of monitoring. Oracle Application Server Oracle Application Server port (default : 7200) Tomcat Tomcat web server port (default : 8080) VMware vFabric tc Server JMX port of VMware vFabric tc Server (default : 6969) Two-way communication between WebLogic listening port (default : 7001) and WebLogic Applications Manager web server port (default : 9090) WebSphere WebSphere application port (default : 9080) CUSTOM MONITORS Database Query monitor Corresponding database server port File/Directory, Script Telnet Port: 23 (if mode of monitoring is Telnet) (Telnet/SSH mode) SSH Port: 22 (if mode of monitoring is SSH)File/Directory, WMI Windows Management Instrumentation (WMI) -- Port: 445 Performance counter (WMI Remote Procedure Call (RPC) -- Port: 135 mode) Know more about the  ports required for WMI Mode of monitoring. DATABASE SERVERS DB2 The port in which DB2 is running (default: 50000) Memcached The port in which Memcached server is running (default : 11211) MySQL The port in which MySQL is running (default : 3306) Oracle The port in which Oracle is running (default : 1521) PostgreSQL The port in which PostgreSQL is running (default : 5432) The port in which SQL Server is running (default : 1433). UDP port 1434 might be Microsoft SQL Server required for the SQL Server Browser Service when you are using named instances. Sybase The port in which Sybase is running (default : 5000) SAP HANA SAP HANA''s IndexServer port (default: 30015) The port in which Hbase is running. For default installations of HBase, the JMX Apache HBase port number is 10101 for Master and 10102 for RegionServer. NoSQL Enable JMX for monitoring. The JMX Port for default installations of Cassandra is Cassandra 7199. ERP Oracle EBS Oracle EBS webserver port (default:7200) To monitor a Microsoft Dynamics CRM/365 application, use Administrator user account which has the permission to excute WMI queries on ''root\CIMV2'' namespace of the Dynamics CRM/365 Server. Firewall access for monitoring: Ports required for monitoring via WMI. Microsoft Dynamic CRM/365 Windows Management Instrumentation (WMI) (default : TCP 445) (On-Premise) Remote Procedure Call (RPC) (default :TCP 135) Target server uses random port above 1024 by default to respond back for remote communication (DCOM) (default : TCP 1025 to 1030) Powershell access for monitoring: Click here to see powershell prerequisites. MAIL SERVERS Windows Management Instrumentation (WMI) (default : 445) Remote Procedure Call (RPC) (default : 135) Exchange Server PowerShell remoting - TCP 5985 and 5986 Exchange PowerShell session - TCP 80 and 443 Know more about the ports required for WMI Mode of monitoring SMTP server port (default : 25) to send mails from Applications Manager. Mail Server POP port (default : 110 ) to fetch mails using the POP server. MIDDLEWARE/PORTAL IBM WebSphere MQ The MQ Listener Port (default:1414) Windows Management Instrumentation (WMI) -- Port: 445 Microsoft MSMQ/SharePoint Server Remote Procedure Call (RPC) -- Port: 135 Know more about the  ports required for WMI Mode of monitoring. VMware vFabric RabbitMQ The Port ID where the management plugin is configured (default : 55672) Server WebLogic Integration Server WebLogic Integration port (default : 7001) The SNMP port number , on which the Tuxedo SNMP agent is running. The default Oracle Tuxedo port number is 161.Apache ActiveMQ The port in which ActiveMQ is running. The default JMX port is 9999. If the Apache Kafka is running on JDK7 Update 4 or above, the port number to which the RMI connector will be bound should be set using the system property "- Dcom.sun.management.jmxremote.rmi.port=9999" in Apache Kafka for Apache Kafka connecting from Applications Manager through firewall. If the Apache Kafka is running on older versions of JDK, refer http://www.netcluesoft.com/rmi-through-a-firewall.html for setting up the port number for RMI connector communication. SERVERS To connect AS400/iSeries server from Applications Manager it uses JTOpen package. The JTOpen package uses the following Non-SSL ports 449, 446, 8470, AS400/iSeries 8471, 8472, 8473, 8474, 8475, 8476. Ensure that the ports mentioned under "Port Non-SSL" column in the link are not blocked in firewall. https://www-01.ibm.com/support/docview.wss?uid=nas8N1019667 Telnet Port (default : 23), if mode of monitoring is Telnet. Linux / Solaris / AIX / HPUnix SSH Port (default : 22), if mode of monitoring is SSH /Tru64 Unix SNMP Agent Port (default : 161), if mode of monitoring is SNMP Windows For WMI Mode of Monitoring: To monitor a Windows Server the user must have "Administrator" privileges Ports required - Windows Management Instrumentation (WMI) (default : 445) Remote Procedure Call (RPC) (default : 135) WMI uses DCOM for remote communication.The server to be monitored by applications manager uses a random port number above 1024 by default to respond back. You have to connect to this target server and configure it to use a port within a specified range of ports. Check out this link to know more about restricting the ports in the target server:  https://support.microsoft.com/en- us/help/154596/how-to-configure-rpc-dynamic-port-allocation-to-work-with- firewalls. Note that you must specify at least 5 ports in this range for target server ( you are normally recommended to open at least a 100 ports). This same range of ports must also be opened in the firewall. In Windows Server 2008 and later versions, and in Windows Vista and later versions,  use the following dynamic port range: Start port: 49152 End port: 65535 If your computer network environment uses only Windows Server 2012, Windows Server 2008 R2, Windows Server 2008, Windows 8, Windows 7, or Windows Vista, you must enable connectivity over the high port range of 49152 through 65535. Windows 2000, Windows XP, and Windows Server 2003 use the following dynamic port range: Start port: 1025 End port: 5000 If your computer network environment uses Windows Server 2012, Windows Server 2008 R2, Windows Server 2008, Windows 8, Windows 7, or Windows Vista together with versions of Windows earlier than Windows Server 2008 and Windows Vista, you must enable connectivity over both the following port ranges: High port range 49152 through 65535 Low port range 1025 through 5000 SNMP Mode of monitoring:Ports required - SNMP Agent Port: 161 SERVICES Windows Management Instrumentation (WMI) -- Port: 445 Remote Procedure Call (RPC) -- Port: 135 Active Directory PowerShell remoting -- TCP 5985 and 5986 Also refer to ports required for WMI Mode of monitoring under Servers FTP/SFTP Port in which FTP or SFTP is running (default:21 for FTP, 22 for SFTP) Port of JMX agent (default:1099)   To monitor JMX behind firewall, the following changes have to be done. Edit startApplicationsManager.bat/sh file. Add -Dmonitor.jmx.rmi.port= to the JMX [ MX4J / JDK 1.5] Java runtime options. Restart Applications Manager server Ensure that you have the RMI Socket port (step1) and JNDI Port (step4) are opened up in the firewall Add the JMX Applications monitor after providing the relevant details. The monitor should be added successfully LDAP LDAP server port Service Monitoring The service port that you need to monitor SNMP SNMP Agent port (Default:161) Telnet Port which you need to Telnet The default port of JMX agent is 1099 If the Apache ZooKeeper is running on JDK7 Update 4 or above, the port number to which the RMI connector will be bound should be set using the system property "- Dcom.sun.management.jmxremote.rmi.port=1099" in Apache ZooKeeper for Apache ZooKeeper connecting from Applications Manager through firewall. If the Apache ZooKeeper is running on older versions of JDK, refer http://www.netcluesoft.com/rmi-through-a-firewall.html for setting up the port number for RMI connector communication. Enable JMX for monitoring. The JMX Port for default installations of Coherence is Oracle Coherence 1099. Hadoop Enable JMX for monitoring. The JMX port of the NameNode. TRANSACTION Applications Manager''s Web Server port should be accessible from the APM APM Insight Insight agent server (default:9090). VIRTUALIZATION Windows Management Instrumentation (WMI) -- Port: 445 Hyper-V Remote Procedure Call (RPC) -- Port: 135 Also refer to the ports required for WMI Mode of monitoring under Servers VMWare ESX/ESXi VMWare Web Service port (default:443) Citrix Xenserver The https Port where the XenServer web service runs. The default port is 443. Docker The Docker socket port. (default port: 4243). WEB SERVER/SERVICES The qeport (default:5001) mentioned in the Real Browser Monitor AppManager_Homeworkingconfqeruntime.properties file should be (Qengine port) accessible from the machine where you want to Record RBM webscriptsSSL Certificate Monitor SSL port in which the web server is running (default:443). Web Server - Apache / IIS / HTTP Port of Web Server (default:80). PHP Elasticsearch The port on which the ElasticSearch is running (default: 9200). Apache Solr The port on which the ApacheSolr is running (default: 8983) Miscellaneous Trap Listener port (default:1620) in Applications Manager server should be Trap Listeners accessible from the server where you want to send traps. More on receiving SNMP Traps. Web User Experience Make sure you are connected to the internet and can access Site 24X7. Monitoring Applications Manager makes sure that data is secure. The internal PGSQL database allows only the localhost to access the database through authenticated users. User Names and Passwords are stored in the PGSQL database that is bundled along with the product. The passwords are encrypted to maintain security. Privileges required for different monitor types: Monitors Privileges Active Directory Administrator username/password [WMI mode] The AWS Access Key Id for accessing the AWS through the API. The access key has 20 alpha-numeric characters. Amazon The Secret Access Key of the AWS. The secret key should be 40 alpha-numeric characters long. Apache Server Credentials for accessing the server status url for Apache To retrieve data for all modules in AS400/iSeries monitor except ''Disk'', an user with *USER user profile is required. To retrieve data for ''Disk'' and to perform Admin actions from Applications Manager, an user with *SECOFR user profile is required. If using the *SECOFR user profile is not possible, then for retrieving disk data and to perform the admin actions such as viewing spooled file, job log and performing actions in JOBS, SPOOL, SUBSYSTEM a user profile with special authorities such as *ALLOBJ, *SAVSYS, *JOBCTL, *SPLCTL is required. AS400/iSeries The user should have permission to access QMPGDATA/QPFRDATA library because Applications Manager uses performance collection service for retrieving disk details from AS400/iSeries server. Note: If the performance data collection is not enabled in AS400/iSeries, you need to start it by using the command STRPFRCOL or GO PERFORM-->COLLECT PERFORMANCE DATA-- >START PERFORMANCE COLLECTION. You will also be able to execute the STRPFRCOL command from AS400/iSeries server monitor page in Admin-- >Non-Interactive command option. Database Query Monitor User with privileges for accessing a particular database and execute the query DB2 User with atleast SYSMON instance level authority Exchange Server Administrator username/password [WMI mode] File/Directory User with privileges for accessing the File or Directory to monitor If Authentication is enabled, enter the Username and Password for connecting to the FTP/SFTP FTP/SFTP server & move to required directory Glassfish Username and password for connecting to Glassfish Admin console HP-UX Guest user privilege HTTP URL If basic authentication is required enter the same in monitor Administrator privileges to the root OS (Windows 2008 R2 and other supported Hyper-V Hyper-V versions) IBM AIX Guest user privileges are sufficient but "root" privileges are required for collecting Memory related details. Hence, it is preferable to use a "root" account to view all thedetails IBM WebSphere MQ A Channel name with type of "Server Connection Channel" Use the JBoss username/password (if Jboss is authenticated). User should be able JBoss to access the JBoss JMX console. If not, no username/password is required If Authentication is enabled, enter the Username and password for connecting to the JMX agent. If the Java application is running on JDK7 Update 4 or above, the port number to which the RMI connector will be bound should be set using the system property "- JMX/Java Runtime Dcom.sun.management.jmxremote.rmi.port=1099" in that Java application for connecting from Applications Manager through firewall. If the Java application is running on older versions of JDK, refer http://www.netcluesoft.com/rmi-through-a-firewall.html for setting up the port number for RMI connector communication. If Authentication is enabled, enter the Username and Password. If no username and LDAP password is provided, then it will connect to LDAP server as an anonymous login. Linux Guest user privilege If Authentication is enabled, enter the Username and password for connecting to the Mail Server SMTP and POP Microsoft .Net Administrator username/password [WMI mode] Microsoft Office Administrator username/password [WMI mode] SharePoint Server MS SQL System Administrator/Owner for the "master" database MSMQ Administrator username/password [WMI mode] The User-name specified should have access to the databases to be monitored. MySQL MySQL should also be configured. This allows the host on which App Manager is running to access the MySQL database. Oracle User with CONNECT and SELECT_CATALOG_ROLE roles You need a SAP user profile with the following authorization objects: S_RFC, S_XMI_LOG and S_XMI_PROD which are the minimum prerequisities for adding a SAP monitor. SAP/SAP CCMS We use the SAP Java Connector to connect to the SAP ABAP server. The SAP JCo will communicate from APM to SAP using the SAP Dispatcher. The SAP Dispatcher port to be used is 3200 with the SAP System number. Script monitor User with privileges for executing the script and accessing the output file. Server with SNMP mode SNMP Community string with read privileges. For SNMP Version V1/V2c: SNMP Community string with read only privileges. For SNMP Version V3: Select one of the three Security Levels in the drop-down list: SNMP/Network device NoAuthNoPriv - Messages can be sent unauthenticated and unencrypted. Enter a UserName and Context Name. AuthNoPriv - Messages can be sent authenticated but unencrypted. Enter a UserName, Context Name and an Authentication Password. You can select an Authentication Protocol like MD5 or SHA from the drop-down list. AuthPriv - Messages can be sent authenticated and encrypted. Enter a UserName, Context Name,an Authentication Password and a Privacy Password. You can select an Authentication Protocol like MD5 or SHA from the drop-down list. By default ''DES'' encryption technique will be used. Solaris Guest user privilege. Sybase The user should have admin privileges or the DB owner for master database.Tomcat For 5.x and above, a username and password is required to connect to Tomcat Manager Application. If not, no username/password is required. For 5.x the user specified should have a ''manager'' role. For 6.x and above, the user specified should have "manager-gui", "manager- script", "manager-jmx" and "manager-status" roles. When adding VMWare ESX/ESXi servers for monitoring, we recommend that you use the root account. However, if you are unable to use the root account, you can use a ''view-only'' profile to add the servers. This profile has all the privileges required for VMWare ESX/ESXi monitoring. The user you create must be: a member of the group user. based on the profile ''read only''. VMware vFabric RabbitMQ User Name and Password of RabbitMQ server. Server Use the WebLogic username/password, if WebLogic is authenticated. The user WebLogic should be an administrator. Otherwise, no username/password is required. WebLogic Integration Use the WebLogic username/password, if WebLogic is authenticated. User should Server be an administrator. Else no username/password is required. Give the User Name and Password, if it is required to invoke the webservice Webservices operation. If Global Security is enabled, use the same username/password . If not, no WebSphere username/password is required. Windows Administrator username/password [WMI mode]. Enterprise Edition Path Ports SSL Port (default 8443) - for database syncing Admin to Managed Server Webserver (default 9090). Managed Server to Admin SSL Port (default 8443). Note: Production Environment gives you the configuration details that you need to take care of, when moving Applications Manager into Production. User Management Security Policy Applications Manager supports user management security policy for password validation. Validation: Password should not be same/part of your Login name Password length should not be less than 8 characters Password length should not be greater than 255 characters Password should contain atleast 1 numeric character Password should contain atleast 1 special character Password should contain both uppercase and lowercase characters Password should not be the same as your last 4 passwords Password validation should be done in both server and client side. Client side validation: Check for password length - should not be less than 8 characters Check for password length - should not be greater than 255 characters Check for password - should contain atleast 1 numeric character Check for password - should contain atleast 1 special character Check for password - should contain both uppercase and lowercase charactersCheck for password - should not be same/part of your Login name Server side validation: Above, the validation was given for client side. It is also done in server side. When Client validation has failed due to some malicious action (like truncating password) then server side validation should happen before changes happen to password. Check for password - should not be the same as your last 4 passwords Check for password - should contain atleast 1 numeric character Check for password - should contain atleast 1 special character Check for password - should contain both uppercase and lowercase character Check for password - should not be same/part of your Login name Password should not have more than three consecutive characters from the previous password Account  Lock-out Feature: User can try a maximum of 5 times with unsuccessful login, afterwards account automatically gets locked out. After 30 minutes of time, it gets locked out automatically. It will show the error message once it gets locked. Single session per user: Application will allow the user to have only one session per user id at any point of time.  Same user can not be connected to server from different machines/webclient at the same time. It will show the error message that “User Already logged in”         Forums and Blogs Here are links to some interesting Forums and Blog posts: Post Description Application-Aware Network 5 Reasons why you should consider application-aware network Performance Management performance management [Presentation]: An overview of Synthetic End User Experience Monitoring EUM Monitoring with Applications Manager Set Dashboard as a Tab Have the KPIs of multiple apps in a single page Cassandra Database Monitoring Monitoring Cassandra Cluster Databases with Applications Manager MongoDB Monitoring What does Applications Manager have to offer for MongoDB Monitoring? Scipt Monitoring Functionality Monitor custom jobs and track uptime with Script Monitoring functionality Migrate your database from MySQL Migrating your Applications Manager database from MySQL to MS SQL for to MS SQL storing performance data and configuration information of the monitors Bulk Alarm Configuration Setting up alarms across multiple monitors in one go Monitoring the critical components of the vFabric tc Server to detect Monitor vFabric tc Server performance problems IBM Tivoli integration Integrate Applications Manager alerts into IBM Tivoli Console Track Your Website’s SSL Certificate Expiry Date Using Applications SSL certificate monitoring Manager Recognition in Gartner''s Magic ManageEngine included in Gartner''s Magic Quadrant for Application Quadrant Performance MonitoringManage Virtual Machine Sprawl Virtual Machine Sprawls: How can you keep them in check? Manage Virtual Resources Automate Virtual Machine Management with Applications Manager Identify Java code consuming high CPU in Linux (linking JVM thread and Identify Problematic Java Code Linux PID) Multi-vendor Virtualization support Now Monitor Hyper-V and VMware Servers from the Same Console Server Troubleshooting Reduce one step from your usual Server Troubleshooting Handbook Flexible Alarm Management Flexible Alarm Management for Performance Counters Improve Operations Productivity by Integrating Contextual Information Improve Operations Productivity using New Widgets for Custom Dashboards Application Dependency Mapping Application Dependency Mapping for better alarm management Proactively detect application performance problems with Anomaly Anomaly Detection Detection How to start Applications Manager when Linux boots (like starting Linux Startup Applications Manager as service in Windows) ? Am I configuring properly? Tips on easy configuration Root Cause Analysis Information on how best you can use Root Cause Analysis Alarm Configuration made easy - 1 Tips on easy alarm configuration Alarm Configuration made easy - 2 Access Applications Manager Database and Generate Custom Reports / Custom Reports Dashboards Migrating/Changing Applications How to migrate Applications Manager from machine to another? Manager HP-UX monitoring Monitoring all the disk volumes in HP-UX machine How to monitor database tables of your choice using script monitor Script Monitor - Example1 feature? Script Monitoring - Example2 Script Monitoring - Monitor data from a particular row in the table Script Monitor - Example3 How to monitor Sybase using scripts? Builds Advantages of Windows build over Linux build SMS Alarms Easy way to send SMS Alarms Want a sound Alarm Steps to configure sound Alarm from a remote machine OpManager or Applications Helps you decide between OpManager and Applications Manager Manager Dell''s OpManage How to integrate Dell''s OpManage with Applications Manager GlassFish Application Server How to monitor GlassFish Application Server Response Time across Multiple Get to know how Enterprise Edition aids in comparing response time Locations across multiple locations Creating a proper threshold Tips on easy Threshold Configuration RCA Messages & Polls Insight into RCA Messages Create New Monitor Type Create your own custom monitor types Monitor Log Files and System Log files and System Events monitoring Events Intranet & Applications Manager How to integrate Applications Manager in your Intranet AppManager as a Linux Service Steps to install AppManager as a service on a Linux system. Add-Ons Pricing Applications Manager offers add-on features which are optional to use. These add-ons need to be purchased along with the base product. Pricing Structure of Add-ons: All the add-ons are typically priced as a flat fee. You can monitor any number of resources as long as you are within the overall ''monitors'' count.For example, if you buy a 25 monitors license with SAP add-on, you can add any number of SAP monitors as long as the monitor count does not exceed 25. For more information about add-on pricing structure, please refer our online store. Note: All the add-ons are included as part of the product. You can use them for free during your evaluation period. Once the evaluation period is over, you can use only those add-ons that you have purchased. If you want to evaluate add-ons after your trial period has expired, you can request for a trial license by filling up this form in our website. Top Third Party Packages used in Applications Manager This page has details about the third party packages used in Applications Manager. The license files for the corresponding third parties is also included with the product. If license file is not available in product, the link for it can be found in this document. Name Organization Used License Type License Version JAVA-CAS-CLIENT Jasig Cas Client 3.2.1     JAVA-CAS-SERVER Jasig Cas  3.5.2     Oracle Binary Code License Java Oracle Corporation 1.7.0_71 Agreement for the Java SE http://w working/jre Platform Products Tomcatworking/apache/tomcat The Apache Software License, Apache 7.0.21   working/classes/LICENSE_APACHE_TOMCAT.txt Version 2.0 Pgsql PostgreSQL The PostgreSQL License https://w 9.2.4  Working/pgsql Strutsworking/apache/tomcat/common/lib/commons-collections.jar working/WEB-INF/lib/commons-beanutils.jar working/WEB-INF/lib/commons-digester.jar working/WEB-INF/lib/commons-fileupload.jar working/WEB-INF/lib/commons-lang.jar The Apache Software License, Apache 1.1   working/WEB-INF/lib/commons-validator.jarworking/apache/lib/commons- Version 1.1 collections.jarworking/WEB-INF/lib/jakarta-oro.jar working/WEB-INF/lib/struts-el.jar working/WEB-INF/lib/struts.jar working/classes/LICENSE_STRUTS Project : Apache working/apache/tomcat/common/lib/commons-dbcp.jar CommonsComponents working/apache/tomcat/common/lib/commons-lang.jar :  The Apache Software License, working/apache/tomcat/common/lib/commons-pool.jar   http://w DBCP Version 2.0 working/apache/tomcat/common/lib/servlet.jarworking/WEB-INF/lib/not-yet-commons- Lang ssl-0.3.10.jar Pool Project : Apache working/apache/tomcat/common/lib/commons-fileupload-1.1.1.jar Commons The Apache Software License, 1.1.1    working/classes/LICENCE_COMMONS_FILEUPLOAD.txt Components : Version 2.0 FileUpload Project : Apache working/apache/tomcat/lib/commons-beanutils.jar Commons The Apache Software License, 1.6  http://w working/classes/LICENSE_COMMONS_BEANUTILS.txt Components Version 2.0 : BeanUtils Project : Apache working/apache/tomcat/lib/commons-digester.jar The Apache Software License, Commons 1.8 http://w working/classes/LICENSE_COMMONS_DIGESTER.txt Version 2.0 Components : DigesterName Organization Used License Type License Version working/classes/axisaxis.jar working/classes/axiscommons-discovery-0.2.jar working/classes/axisjaxrpc.jar working/classes/axisjaxrpc.jar Apache The Apache Software License, 1.3   working/classes/axissaaj.jar Project : Axis Version 2.0 working/classes/axiswsdl4j working/classes/axiswsdl4j-1.5.1 working/classes/LICENSE_AXIS.txt Oracle Corporation working/classes/classes12.zip Oracle Technology Network Product : Oracle 11.2.0.4   working/classes/LICENSE_oracle_jdbc_driver.txt License Agreement Database Oracle Corporation working/classes/activation.jar Sun Microsystems, Inc.Binary JavaBeans Activation 1.0.2   working/classes/LICENSE_ACTIVATION.txt Code License Agreement Framework working/classes/aws-java-sdk-1.11.171.jar Amazon Web Services  v1.11.171 Apache License, Version 2.0 http://a working/classes/aspectjrt-1.8.2.jar working/classes/aspectjrt-1.8.2.jar working/classes/aws-swf-build-tools-1.1.jar working/classes/freemarker-2.3.9.jar ion-java-1.0.2.jar working/classes/jackson-dataformat-cbor-2.6.7.jar working/classes/jmespath-java-1.11.171.jar Amazon Web Services working/classes/spring-beans-3.0.7.RELEASE.jar v1.11.171 Apache License, Version 2.0 http://a - New dependent jars working/classes/spring-context-3.0.7.RELEASE.jar working/classes/spring-core-3.0.7.RELEASE.jar working/classes/spring-test-3.0.7.RELEASE.jar working/classes/commons-codec-1.9.jar working/classes/joda-time-2.8.1.jar working/apache/tomcat/bin/commons-logging-1.1.3.jar Project : Apache The Apache Software License, working/classes/commons-email-1.2.jar Commons 1.2 http://w Version 2.0 Components : Email Project : working/classes/commons-httpclient-3.0-rc1.jar Apache Commons The Apache Software License, 3.0 RC1    working/classes/LICENSE_COMMONS_HTTPCLIENT.txt Components Version 2.0 : HttpClient Project : The Apache Software License, working/classes/commons-io-2.2.jar Apache Commons 2.2  http://w Version 2.0 Components : IO Project : working/classes/commons-net-2.0.jar The Apache Software License, Apache Commons 2.0    working/classes/LICENSE_COMMONS_NET.txt Version 2.0 Components : Net working/classes/db2jcc.jar working/classes/db2jcc_license_cu.jar IBM DB2   IBM License   working/classes/LICENSE_DB2JCC.txt working/classes/dnsjava-2.0.6.jar dnsjava 2.0.6  BSD License   working/classes/LICENSE_DNSJAVA.txt working/classes/dom4j-1.6.1.jar working/classes/jaxb-api.jar working/classes/jaxb-impl.jar VI Java 5.1  BSD license   working/classes/LICENSE_JAXWS.txt working/classes/vijava5120121125.jar working/classes/LICENSE_VIJAVA.txt GCM (Google Cloud working/classes/gcm-server.jar The Apache Software License, Messaging for 3.0   working/classes/LICENSE_GCMSERVER.txt Version 2.0 Android) working/classes/gson-1.3.jar The Apache Software License, Google 1.3    working/classes/LICENSE_GSON.txt Version 2.0Name Organization Used License Type License Version working/classes/htmllexer.jar Common Public License HTML Parser 1.5 http://h working/classes/htmlparser.jar Version 1.0 GNU Lesser General Public working/classes/HTTPClient.jar Innovation 0.3-3 https://w License, version 2.1 working/classes/httpcore-4.1.jar Apache The Apache Software License, 4.1   working/classes/LICENSE_HTTPCOMPONENTS_CORE.txt HttpComponents Version 2.0 working/classes/httpclient-4.5.2.jar Apache 4.2.5 The Apache Software License, working/classes/httpcore-4.4.4.jar https:// HttpComponents 4.5.2 Version 2.0 working/classes/httpmime-4.2.5.jar working/classes/itext-1.01.jar working/classes/LICENSE_ITEXT.txt working/classes/jasperreports-0.6.5.jar GNU Lesser General Public Jaspersoft 0.6.5   working/classes/LICENSE_JASPER_REPORTS.txt License, version 2.1 working/classes/jdt-compiler.jar working/classes/LICENSE_JDT_COMPILER.html working/classes/JavaPNS_2.2.jar JavaPNS working/classes/LICENSE_JAVAPNS.txt 2.2 GNU Lesser General Public Legion of the Bouncy   working/classes/bcprov-jdk15on-147.jar 1.47 License, version 3 Castle working/classes/LICENSE_BOUNCYCASTLE.txt working/classes/jaxen-1.1.1.jar Jaxen 1.1.1 BSD License   working/classes/jedis-2.1.0.jar Jedis 2.1.0 MIT License   working/classes/js.jar Rhino 1.6R1 Mozilla Public License   working/classes/LICENSE_MPL.txt working/classes/json.jar JSON   JSON License   working/classes/LICENSE_JSON.html working/classes/json_simple-1.1.jar The Apache Software License, JSON.simple 1.1   working/classes/LICENSE_JSON_SIMPLE.txt Version 2.0 working/classes/jt400.jar JTOpen 7.6 IBM Public License Version 1.0   working/classes/LICENSE_JTOPEN.txt working/classes/jtds-1.2.2.jar GNU Lesser General Public jTDS 1.2.2   working/classes/LICENSE_JTDS.txt License, version 2.1 Python Software Foundation working/classes/jython.jar Jython 2.1 http://w License, version 2 working/classes/mail-1.4.6.jar JavaMail 1.4.6 Sun Microsystems, Inc.   working/classes/maverick-all.jar SSHTOOLS SOFTWARE working/classes/LICENSE_MAVERICK_J2SSH.html J2SSH Maverick   1.6.11  LICENSE working/classes/LICENSE_MAVERICK_J2SSH.pdf working/classes/mongo-java-driver-3.4.2.jar The Apache Software License, MongoDB Java Driver 2.11.3    working/classes/LICENSE_Mongo_java_driver_3_4_2.txt Version 2.0 working/classes/mx4j-remote.jar MX4J 2.0.1 The MX4J License   working/classes/LICENSE_MX4J.txt working/classes/ocpsoft-pretty-time-1.0.6.jar GNU Lesser General Public PrettyTime 1.0.6   working/classes/LICENSE_OCPSOFT_PRETTY_TIME.txt License, version 3 working/classes/poi-3.0.1-FINAL-20070705.jar working/classes/poi-3.13-20150929.jar 3.0.1 working/classes/poi-ooxml-3.13-20150929.jar The Apache Software License, Apache POI   working/classes/poi-ooxml-schemas-3.13-20150929.jar Updating Version 2.0 working/classes/xmlbeans-2.6.0.jar to 3.13 working/classes/LICENSE_POI.txtName Organization Used License Type License Version WEB NMSworking/classes/ApiUtils.jar working/classes/ApplnMonitorClientExtn.jar working/classes/ApplnMonitorServerExtn.jar working/classes/ sh-1.2b3.jar working/classes/clientAPI.jar working/classes/ClientExamples.jar working/classes/comm.jar working/classes/CommonUtils.jar working/classes/crimson.jar working/classes/ tp.jar working/classes/jaxp.jar working/classes/jcommon.jar working/classes/jfreechart.jar ManageEngine Internal datat 4.5   working/classes/jnlp.jar Software working/classes/jta.jar working/classes/log4j.jar working/classes/ManagementClient.jar working/classes/ManagementServer.jar working/classes/SNMPConfigurationTool.jar working/classes/SNMPDebugger.jar working/classes/xan.jar working/classes/xjo.jar working/classes/ldap_jarsjndi.jar working/classes/ldap_jarsldap.jar working/classes/ldap_jarsproviderutil.jar working/WEB-INF/classes/webclient-common.jar working/WEB-INF/classes/webclient-fault.jar The Apache Software License, working/template/jquery.slides.min.js SlidesJS 3.0.4 http://w Version 2.0 working/template/jquery-1.11.0.min.js jQuery 1.11.0 MIT license https://j working/template/jquery-migrate-1.2.1.min.js working/template/jquery-ui.min.js jQuery UI 1.10.3 MIT license https://j working/images/jquery-ui.min.css jQuery UI Themes 1.10.3  MIT license https://j ery.dataTables.min.jsworking/images/jquery.multiselect.css jQuery UI MultiSelect working/template/jquery.multiselect.filter.min.js 1.13 MIT license https://j Widget working/template/jquery.multiselect.min.js working/templated3.js d3.js 3.4.8 BSD license   working/classes/joor-0.9.3.jar joor- The Apache Software License, Google   working/classes/LICENSE_JOOR.txt 0.9.3 Version 2.0 working/template/jquery.dataTables.min.js working/images/jquery.dataTables.min.css working/images/images /ack_disabled.png working/images/images /ack_enabled.png working/images/images /ack_enabled_hover.png working/images/images /forward_disabled.png working/images/images /forward_enabled.png Datatables.net 1.10.15 MIT license https://j working/images/images/f orward_enabled_hover.png working/images/images/sort_asc.png working/images/images/sort_asc_disabled.png working/images/images/sort_both.png working/images/images/sort_desc.png working/images/images/sort_desc_disabled.png working/classes/LICENSE_DATATABLES_1_10_15.txt working/classes/opencsv-2.4.jar The Apache Software License, Apache Maven 2.4   working/classes/LICENSE_OPENCSV.txt Version 2.0Name Organization Used License Type License Version working/classes/xmlrpc-client-3.1.jar working/classes/xmlrpc-common-3.1.jar The Apache Software License, working/classes/xenserver-6.1.0-1.jar XenServer 6.1   Version 2.0 working/classes/ws-commons-util-1.0.2.jar working/classes/LICENSE_XENSERVER.txt working/classes/iText-2.0.8.jar GNU Lesser General Public working/classes/core-renderer.jar Flying Sauces 2.1   License, version 2.1 working/classes/LICENSE_FLYING_SAUCES.txt Project : Apache The Apache Software License, working/classes/commons-lang3-3.3.2.jar Commons 3.3.2 http://w Version 2.0 Components : Lang working/template/colpick.js GNU General Public License working/images/colpick.css colpick Color Picker 2.0.2   Version 2 working/classes/LICENSE_COLPICK.txt working/classes/hadoop-auth-2.3.0.jar working/classes/slf4j-api-1.7.5.jar Apache The Apache Software License, 2.3.0   working/classes/slf4j-log4j12-1.7.5.jar Project: Hadoop  Version 2.0 working/classes/LICENSE_HADOOP.txt working/classes/OpenForecast-0.5.0.jar GNU Lesser General Public OpenForecast 0.5.0   working/classes/LICENSE_OPENFORECOAST_GPL.txt License, version 2.1 working/template/highcharts.js Highcharts 4.1.7 Commercial   /working/classes/jconn4.jar sybase.com 7.00     working/template/FusionCharts.HC.Charts.js 3.3.1 working/template/FusionCharts.HC.js working/template/FusionCharts.js FusionCharts Commercial   working/template/FusionChartsExportComponent.js   working/template/FusionMaps.js Azure SDK for Java working/classes/adal4j-1.1.3.jar working/classes/adapter-rxjava-2.0.2.jar working/classes/asm-1.0.2.jar working/classes/azure-1.0.0-beta3.jar working/classes/azure-client-authentication-1.0.0-beta3.jar working/classes/azure-client-runtime-1.0.0-beta3.jar working/classes/azure-core-0.9.6.jar working/classes/azure-mgmt-batch-1.0.0-beta3.jar working/classes/azure-mgmt-compute-1.0.0-beta3.jar working/classes/azure-mgmt-graph-rbac-1.0.0-beta3.jar working/classes/azure-mgmt-keyvault-1.0.0-beta3.jar working/classes/azure-mgmt-network-1.0.0-beta3.jar working/classes/azure-mgmt-resources-1.0.0-beta3.jar working/classes/azure-mgmt-storage-1.0.0-beta3.jar 1.0.0- working/classes/azure-storage-4.4.0.jar Microsoft MIT License https://g beta3 working/classes/client-runtime-1.0.0-beta3.jar working/classes/guava-19.0.jar working/classes/jackson-annotations-2.8.4.jar working/classes/jackson-core-2.8.4.jar working/classes/jackson-databind-2.8.4.jar working/classes/jackson-datatype-joda-2.8.4.jar working/classes/json-smart-2.2.1.jar working/classes/nimbus-jose-jwt-4.27.jar working/classes/oauth2-oidc-sdk-4.8.5.jar working/classes/okhttp-3.4.1.jar working/classes/okhttp-urlconnection-3.4.1.jar working/classes/okio-1.9.0.jar working/classes/retrofit-2.1.0.jar working/classes/rxjava-core-0.20.0-RC2.jar working/classes/api-annotations-0.0.1.jar working/classes/xmlunit-1.6.jar XML 1.6 BSD License   working/classes/XMLUNIT_1_6_LICENSE.txt Unitworking/classes/ BadInputFilterValve (working/apache/tomcat/lib/servlets-advent.jar) The Apache Software License, BadInputFilterValve     working/classes/LICENSE_BADINPUTFILTERVALVE.txt Version 1.1Name Organization Used License Type License Version working/classes/jboss/401/dom4j.jar working/classes/jboss/401/jbossall-client.jar working/classes/jboss/402/dom4j.jar GNU Lesser General Public working/classes/jboss/402/jbossall-client.jar JBoss     License, version 2.1 working/classes/jboss/common/jboss-management.jar working/classes/jboss/jbossall-client.jar working/classes/LICENSE_JBOSS.txt working/template/calendar.js GNU Lesser General Public working/template/calendar-en.js Dynarch 0.9.6 http://w License working/template/calendar-setup.js PostgreSQL Global workin/classes/postgresql_jdbc3.jar   BSD license http://w Development Group working/classes/SMSLib.jar GNU Lesser General Public working/classes/SMSServer.jar SMSLIB 1.2.1   License, Version 2.1 working/classes/LICENSE_SMSLIB.txt GNU Lesser General Public working/classes/RXTXcomm.jar RXTX 2.2 http://u License, Version 2.1 Dynamic Drive DHTML Scripts dropdown.js Dynamic Drive   http://w - Terms of use  working/wrapper.exe working/classes/wrapper.jar Tanuki Software   Commercial   working/classes/wrapper.dll working/conf/wrapper-license.conf https://w working/classes/JCONN4_README.txt Sybase ASE   - url_id=te working/classes/LICENSE_BOUNCYCASTLEPROVIDER.txt BouncyCastle   commercial https://w esapi-2.1.0.jar OWASP 2.1.0 Opensource http://c working/classes/pdfbox.jar working/classes/fontbox-2.0.8.jar PDFBox 2.0.8 OpenSource   working/classes/LICENSE_PDFBOX_2_0_8.txt working/template/dataTables.buttons.min.js working/classes/DATATABLES_EXTENSION-BUTTONS_LICENSE.TXT Datatable 1.3.1 MIT https://d   working/template/buttons.html5.min.js Datatable 1.5.2 MIT https://d working/classes/DATATABLES_EXTENSION-BUTTONS_LICENSE.TXT working/template/pdfmake.min.js working/classes/LICENSE-PDF_make-0.1.35.txt Datatable 0.1.36 MIT https://c   working/template/vfs_fonts.js Datatable 0.1.36 MIT https://c working/classes/LICENSE-PDF_make-0.1.35.txt working/classes/commons-math3-3.6.1.jar Apache 3.6.1 Apache 2.0 http://w working/classes/stl-java-0.1.2.jar Apache 0.1.2 Apache 2.0 http://w working/classes/antisamy-1.5.3.jar OWASP 1.5.3 Opensource http://w working/classes/batik-util.jar Apache 1.7 Apache 2.0 http://w working/classes/commons-csv-1.3.jar Apache 1.3 Apache 2.0 http://w working/classes/commons-fileupload-1.3.2.jar Apache 1.3.2 Apache 2.0 http://w working/classes/cssparser-0.9.21.jar Apache 0.9.21 Apache 2.0 http://w working/classes/dnsjava-2.0.6.jar DNSJava 2.0.6 DNSJava http://w working/classes/MimeUtil.jar Apache 2.1.4 Apache 2.0 http://w working/classes/Tika.jar Apache 1.14 Apache 2.0 http://w working/classes/nekohtml.jar Apache 1.9.21 Apache 2.0 http://w working/classes/snakeyaml-1.11.jar Apache 1.11 Apache 2.0 http://w working/classes/ua-parser-1.3.0.jar Apache 1.3 Apache 2.0 http://w working/classes/xercesImpl.jar Apache 2.11 Apache 2.0 http://wName Organization Used License Type License Version app/chrome/recorder_source/jquery-3.3.1.min.js app/chrome/recorder_source/chosen.jquery.js jQuery 3.3.1 MIT License https://j app/chrome/recorder_source/chosen.css working/classes/com.ibm.ws.admin.client_8.5.0.jar working/classes/com.ibm.ws.orb_8.5.0.jar         working/classes/ibmjsseprovider2.jar working/template/daterangepicker/bootstrap_daterangepicker_2_1_25/daterangepicker.css Daterangepicker 2.1.25 MIT   working/template/daterangepicker/bootstrap_daterangepicker_2_1_25/daterangepicker.js Others Easy Upgrade Plugin for OPM Support and Product Info Glossary Database Migrations Supported Modems Regular Expressions Enabling Powershell Tomcat Server.xml | Tomcat Users.xml WMI Prerequisites Easy Upgrade Overview Easy Upgrade in the Enterprise Edition How to take backup before upgrade? Overview Applications Manager''s Easy Upgrade feature ensures users have access to the latest Applications Manager versions and can automatically upgrade to the latest service packs easily. The complexity of upgrading managed servers with the latest software upgrades can also become tedious as the number of managed servers in your system grow. The Easy Upgrade option helps you upgrade your managed servers from a centralized dashboard. Easy Upgrade is available only in Enterprise Edition. Note: Before upgrade to the latest service pack, please make sure to take a complete backup of the '' '' folder and the Applications Manager database. To use Easy Upgrade features in your Applications Manager setup, you need to first enable the option in the Settings tab, under Global Settings. Easy Upgrade in the Enterprise Edition In the Enterprise Edition, users can upgrade their managed servers once the admin server is upgraded. You can see the running version of each of your Managed Servers from the Admin Server. Note : While performing upgrades in the Enterprise Edition, remember to upgrade all instances at once. Upgrading the Admin Server A link to download the latest version of the product will be displayed in the About page along with the latest compatible version. Click Download and the latest Applications Manager PPM will be downloaded into your machine.Once the download is completed, an Upgrade now link appears in the About page near the latest compatible version. Click Upgrade now to upgrade your setup. Applications Manager displays the message "Software Patch Upgrade is initiated. Service will be shutdown shortly. Please reconnect this web console after 15 mins." and begins upgrade. Note: In a Failover setup, Easy Upgrade will be performed on secondary server first. Once the secondary server is upgraded to the latest version, the primary server will perform self-upgrade to the latest version. Upgrading your Managed Servers You can initiate upgrade action for all managed servers in bulk from the Admin Server, once the admin server is upgraded. Click on Managed Servers link. This will take you to the Managed Server page from where you can configure the Managed Servers. The Managed Servers table displays running version of each of the managed servers. The table also displays the syncing , download and upgrade status of the managed servers. If the latest complatible version has not been downloaded, you can select the managed server and click Download Now to download the latest compatible version. Note : If the required version patch is already downloaded, then the Upgrade Link will appear. If not, go to /working/patches/ folder where you can find a folder with the latest build number inside which you can find the latest PPM. Once the download is completed, Select the checkboxes of the managed servers that you wish to upgrade and an click the Upgrade Now link. This upgrades the selected managed servers to their latest version. The icons used to display the download and upgrade statuses are as follows: - Download / Upgrade Completed - Download completed and ready for Upgrade. - Download / Upgrade in Progress. How to take backup before upgrade? Stop the ManageEngine Applications Manager service from Start → Run → services.msc (For Linux servers execute sh shutdownApplicationsManager.sh command from '' '' location). Via command prompt, execute the shutdownApplicationsManager.bat -force command from the '' '' folder. (For Linux servers execute sh shutdownApplicationsManager.sh -force command from '' '' location). Go to the '' /working/support'' folder and delete all old support files (files with extension as .gz or .zip). Go to the '' /working/webclient'' and delete the ''temp'' directory. Go to the '' '' and delete the old logs folders (Example: logs_old or logs_date or logs.zip). Also delete logs folder under '' /working'' location. (Do not delete the ''logs'' folder as it may be useful if any issues occur post upgrade, delete only old logs folders if present) Go to the '' /working and delete hs_err_pid .log files & java_pid .hprof files if present (where xxxx can be any process ID). Go to the '' /working/heapdump'' and delete the contents in that directory. Go to the '' /working/backup'' and delete the backups which are older than last one year. (If there is no backup then proceed to next step). Take a complete backup of '' '' folder. After that close all the explorer & command prompt windows. If you are using Microsoft SQL server backend, then connect to the corresponding SQL server & take the backup of Applications Manager database. Glossary Terms Definition Action These are tasks to be performed to notify the user, when alarms are generated by Applications Manager.For example, while monitoring WebLogic server, if the user wants to be intimated when the server response time is greater than 1000ms, then an alarm is generated when the condition is met. The users are notified of the alarms through Actions such as sending e-mail, SMS, trap, and executing a command.Activities allowing IT administrators to configure any operation in Applications Manager Admin Activities with ease. Only the ''Admin'' user can perform these activities. For more information on user access, refer to the User Administration section. Alarms are notifications generated based on Threshold / Health values .They are generated when the value of a numerical attribute exceeds the pre-defined threshold Alarms limit. Additionally, the status of health and availability of an application can also be determined through Alarms. This activity enables the user to associate a threshold profile with an attribute so that alarms are generated. It includes associating the action to be executed when an alarm is Alarm Configuration generated.Additionally, the dependencies for the ‘Health’ attribute of a Monitor can also be configured. Attributes are parameters/objects of a Monitor and they provide information about them. Attribute These are parameters whose values are set to threshold to generate alarms. An attribute that determines whether a system or application is available for use (Up or Down). For example, if a Web server is running, then the availability is up.Consider a Availability situation where the Web server may be running fine but its response time is high. This is indicated by Availability as Up and Health as critical if the response time is a dependent parameter for health. Refers to the logical grouping of one or more Monitors such as application servers, Monitor Groups network services, databases, web applications etc. This provides a holistic view of the business environment. Custom Monitors provide a way to monitor your Java applications or other applications that expose management information through SNMP (Simple Network Management Custom Monitor Protocol) and JMX (Java Management Extensions).Say, you have a Java application with built-in manageability using JMX and any application that has an SNMP interface, then they are managed by building Custom Monitors. Dependencies determine health of Monitor or Monitor Group health or availability of Monitor Group Dependencies They consist of the dependent parameters of the Monitor based on which the severity of the health and availability is determined. For example, Health of a Tomcat Server may depend on the overall response time of the server or on the response time of each of the web applications deployed on the server etc. By configuring dependencies, you can determine the attribute, based on which the severity of health changes. Discover Network Locating all Monitors running within a network range. Enterprise OID in OID that uniquely distinguishes traps of different organizations, i.e. they vary for different SNMP Trap vendors. This field applies only to SNMPv1 traps. These are types that are mapped to specific OID to generate SNMP traps and provide Generic Type in additional information about the functioning of the Monitor Group. They are applicable SNMP Trap only to SNMPv1 traps. The different types of Generic traps are coldStart, warmStart, linkDown, linkUp, authenticationFailure, and egpNeighborLoss. An attribute that indicates the quality of Monitors, based on their dependencies. For example, If a Web server takes 10 mins to respond, its response time is high but the server Health is still available. Hence it is indicated by Health as critical  (If response time is a dependent parameter of health) and Availability as up . It is a continuous process that uses methodical collection and analysis of data to provide Monitoring business management. Application on which monitoring is performed. Monitor is an instance of a Monitor Type that is running in a port of a host. For example, Application Servers such as WebLogic Monitor servers or Tomcat servers etc, Database servers such as Oracle or MySQL servers are some of the Monitor Types while a WebLogic server running on a particular port of a host is a Monitor. Refers to application such as WebLogic server, JBoss server, System server, URL Monitor, Monitor Type Oracle Database server, MySQL Database server, etc. that are monitored by Applications Manager.Different instances of these applications are Monitor. The average time to repair a device or a system back to acceptable operating conditions. Mean Time To Repair The term can also means, the time spent to restore a machine to operating condition after (MTTR) failure.This must be as low as possible. MTTR thresholds can be set to trigger root cause. Mean Time Between The average time that a device or a system worked without failure. The term also stands Failures (MTBF) for the length of time a user may reasonably expect a device or system to work before anincapacitating fault occurs.This must be as high as possible. MTBF thresholds can be set to trigger root cause. Polling Interval The time interval to monitor the different parameters configured for a Monitor. Root Cause Analysis helps to point the actual cause of a problem. You can view the ''Root Cause Analysis'' by clicking on the status icon of the attributes. For example, RCA Expand the nodes to view the actual cause of the problem. Here, WebLogic Health is critical as Availability and Response Time (dependencies of Health) are also critical. They provide organized presentation of data that depicts the behavior of Monitor Types Reports over a specified period of time. Response Time The time taken by a Monitor to react to a given input. Indicates how serious the problems are. There are three levels of severities: Critical, Severity Warning, and Clear. These are controlled by the threshold set by the user or administrator. An outgoing e-mail server using Simple Mail Transfer Protocol (SMTP) that sends your outgoing messages to the appropriate recipients. Most e-mail systems that send mail SMTP Server over the Internet use SMTP to send messages. The messages can be retrieved using POP server. Object identifier (OID) that is used to uniquely identify each object variable of a MIB SNMP OID (Management Information Base). Specific Type in When generic is set to Enterprise, a specific trap ID is identified. SNMP Trap SubNetMask The subnet mask determines the maximum number of hosts on a subnetwork. Threshold is the value that determines the severity of the alarm based on the pre-defined conditions. For example, if the user wants to be intimated when the server response time Threshold is greater than 1000ms, then a threshold can be created based on this condition and assigned to the attribute. Continuous URL monitoring service that monitors web pages. They verify the availability URL Monitors of specified, addressable, standard HTTP and HTTPS URLs of web pages. Database Migrations Three types of DB Migration can be done in Applications Manager: MySQL to PostgreSQL (Supported Both in Windows and Linux) MySQL / PostgreSQL to Microsoft SQL  (Supported only in Windows) PGSQL to SQL Server migration for Applications Manager Plug-in (Supported only in Windows) MySQL to PostgreSQL Migration Note: You need to be on Version 13210 of Applications Manager or above to do migration, so please check the build number in the Support tab. Prerequisites Before starting Migration check the Database port number in following files (and make sure it''s the same in all the files): AMServer.properties in "AppManager_Home/conf" database_params.conf in "AppManager_Home/working/conf" startMySQL.bat (before export in MySQL build) / startPGSQL.bat (before import in PGSQL build) in "AppManager_Home/working/bin" Install the PostgreSQL build which is same as MySQL. Start and stop the new PostgreSQL build. Take backup of the MySQL Database before starting Migration.Steps for Migration: Step 1 - Stop MySQL build “ManageEngine Applications Manager” service and via command prompt (make sure you run as administrator) , go to directory and execute the below commands.                             shutdownApplicationsManager.bat                             shutdownApplicationsManager.bat -force                 Via command prompt, go to directory and execute the below command in Linux.                             sh shutdownApplicationsManager.sh                              sh shutdownApplicationsManager.sh -force Step 2 - In MySQL AppManager, open a command prompt using administrator privileges, run the /bin/Migration/MigrateToPGSQL.bat script, data export process will start. You can view progressin /logs/Migration/.                      Example:                                  MigrateToPGSQL.bat Export                                  sh MigrateToPGSQL.sh Export (in case of Linux)   Step 3 - From the MySQL AppManager copy /working/Migration.zip file to the same location in the PGSQL AppManager and unzip it (All the *.txt files should be in /working/Migration/)   Step 4 - In MySQL AppManager run the \bin\BackupConfig.bat (or sh) script and copy the \working\backup\backupconfzip_Type_Build_Date_HH_MM_SS.zip file to the same location in the PGSQL AppManager.   Step 5 - Take a backup of AMServer.properties under AppManager_HOME/conf folder in PGSQL build.   Step 6 - Run the \bin\RestoreConfig.bat (or sh) script with the backupconfzip_Type_Build_Date_HH_MM_SS.zip file that  was copied in step 4.   Step 7 - In PGSQL AppManager go to /working/pgsql/data and remove or rename  “amdb” folder.   Step 8 - In PGSQL AppManager, open a command prompt using administrator privileges, run the /bin/Migration/MigrateToPGSQL.bat script, data import process will start. You can view progress in /logs/Migration/.                          Example:                                     MigrateToPGSQL.bat Import                                     sh MigrateToPGSQL.sh Import (in case of Linux)   Step 8 - Replace the host details of PGSQL build in AMServer.properties with the details in backup file taken in step 5.   Step 9 - Start the PGSQL Applications Manager & check your data.   Note: 1. After Migration, it is mandatory to copy and paste all the Prerequisites files needed for monitoring from MYSQL to the PGSQL build. Once database migration is completed, please confirm that there are no failed tables. Once this is done, start the migrated build. 2. If the MigrateToPGSQL or MigrateToMSSQL scripts are once executed in a build, a text file will be created in the working\migration folder which will not allow you to run the same script again successfully. Delete or rename the ''migration'' folder to run the scripts again. PostgreSQL/MySQL to MS SQL Migration Note: 1. The migration is now possible only in a Windows version of Applications Manager.  2. You need to be on version 13210 of Applications Manager or above to do migration, so please check the build number in the Support tab. Prerequisites Take backup of the PostgreSQL/MySQL database before starting migration. Install the Applications Manager with same build number by selecting MS SQL backend, start & stop it once.The MS SQL build should not be running during migration. But MySQL/PostgreSQL build should be running, so please make sure that it is. Open Migration.properties file in \conf folder in PostgreSQL/MySQL Applications Manager and enter details of the Microsoft SQL Server like hostname, port, database name, username & password same as you have provided in step 2. # ------------------------------------- # Target Database Details for migration # ------------------------------------- am.importdb.type=mssql am.importdb.host=APP-WIN7-64-1 # we don’t need to mention port if the target server is a SQLServer instance am.importdb.port=1433 am.importdb.instance=- am.importdb.name=AMDB_MSSQL # For Domain authentication should be given as DomainName\\Username am.importdb.user=sa am.importdb.password=password Steps for Migration 1. In the  PostgreSQL/MySQL Applications Manager execute the below under \bin\Migration folder in command window (make sure you run as administrator).        MigrateToMSSQL.bat Export       A specific Migration.zip file will be created in \working\ location.              AppManagerMigration.zip (Professional Edition)              AdminServerMigration.zip (Admin Server)              ManagedServer_X0000000.zip (Managed Server With ServerID X) 2. Copy your specific zip file & unzip it under the C:\migration folder of the Windows server where your MSSQL database is running. 3. Now in PostgreSQL Applications Manager, execute the below command under \bin\Migration folder in command prompt window.               MigrateToMSSQL.bat Import  This will import your data from PostgreSQL/MySQL DB and insert into target DB (Example: AMDB_MSSQL) in the SQL Server. 4. Copy the below information from the existing PostgreSQL Applications Manager to MSSQL Applications Manager installation               \working\mibs               \working\adventnet_ssh_privateKey_file.txt_* 5. Stop the PostgreSQL/MySQL Applications Manager and start the MS SQL Applications Manager. You will have all your existing monitors/configurations and reports in that with data stored in MS SQL server now.   Note: Currently we have the following options while migrating a. Can exclude any table without migrating b. Can specify row limit for tables which have more rows count.   (Event or AM_Disk_MinMaxAvgData or similar tables can have million of rows, so we can set a limit if a need arises). These options can be given in migration.conf file under \working\conf\PGSQL\ for PostgreSQL build and \working\conf\MySQL\ for MySQL build.   Note: 1. This step is not mandatory and may be required while very large database migration only. 2. After migration, it is mandatory to copy and paste all the prerequisites files needed for monitoring from MySQL\PostgreSQL to the MSSQL build. 3. Once database migration is completed, please confirm that there are no failed tables. Once this is done, start the migrated build. PGSQL to SQL Server migration for Applications Manager Plug-in Note: 1. The migration is now possible only in a Windows version of Applications Manager.  2. You need to be on version 13210 of Applications Manager or above to do migration, so please check the build number in the Support tab.Prerequisites Take backup of the PGSQL Database before starting Migration. Install the Applications Manager with same build number by selecting MS SQL Backend, start & stop it once. The MSSQL Build should not be running during Migration. But PGSQL build should be running, so please make sure that it is. Open Migration.properties file in OpManager\AppManager\conf folder in PGSQL AppManager and enter details of the Microsoft SQL Server like hostname, port, database name, username & password same as you have provided in step 2. # ------------------------------------- # Target Database Details for migration # ------------------------------------- am.importdb.type=mssql am.importdb.host=APP-WIN7-64-1 # we don’t need to mention port if the target server is a SQLServer instance am.importdb.port=1433 am.importdb.instance=- am.importdb.name=AMDB_MSSQL # For Domain authentication should be given as DomainName\\Username am.importdb.user=sa am.importdb.password=password Steps for Migration 1. In the  PGSQL AppManager execute the below under OpManager\AppManager\bin\Migration folder in command window (make sure you run as administrator).              MigrateToMSSQL.bat Export  A specific Migration.zip file will be created in OpManager\AppManager\working\ location.              AppManagerMigration.zip (Professional Edition)              AdminServerMigration.zip (Admin Server)              ManagedServer_X0000000.zip (Managed Server With ServerID X) 2. Copy your specific zip file & unzip it under the C:\ drive of the Windows server where your MSSQL database is running. 3. Now perform the Migration steps given by OpManager and restart your OpManager. 4. Now in PGSQL AppManager, execute the below under OpManager\AppManager\bin\Migration folder in cmd window.               MigrateToMSSQL.bat Import  This will import your data from PGSQL DB and insert into target DB (example: AMDB_MSSQL) in the SQL Server. 5. Copy the below information the existing PGSQL AppManager to MSSQL AppManager installation              OpManager/AppManager/working/mibs              OpManager/AppManager/working/adventnet_ssh_privateKey_file.txt_* 6. Stop the PGSQL AppManager and start the MS SQL AppManager. You will have all your existing monitors/configurations and reports in that with data stored in MS SQL server now.   Note: Currently we have the following options while migrating a. Can exclude any table without migrating b. Can specify row limit for tables which have more rows count.   (Event or AM_Disk_MinMaxAvgData or similar tables can have million of rows, so we can set a limit if a need arises). These options can be given in migration.conf under OpManager\AppManager\working\conf\PGSQL\ for PGSQL build.   Note: This step is not mandatory and may be required while very large database migration only. After Migration, it is mandatory to copy and paste all the Prerequisites files needed for monitoring from PGSQL to the MSSQL build. Supported Modems for SMS Notifications Following is a list of the modems supported in Applications Manager for SMS Notifications. S No. Modem Version Baud Rate ManufacturerS No. Modem Version Baud Rate Manufacturer 1 iTegno 3000 115200 Wavecom 2 iTegno WM1080A 115200 Wavecom 3 Wavecom M1306B   Wavecom 4 iTegno 3800   Wavecom 5 MultiTech MultiModem MTCBA-G-F1     6 Wavecom Fastrack M1206B 115200 Wavecom 7 VISIONTEK 81GC   Linkwell Telesystems 8 TELTONIKA ModemCOM/G10 115200 Teltonika DIGICOM Pocket GPRS Micro (Version 9 9600 Digicom 1.47) 10 DIGICOM Pokcet GPRS Pico (Version 1.47) 9600 Digicom Mobiles Supported S.No Mobile Model Baud Rate Manufacturer 1 Motorola E398 9600 Motorola 2 Nokia 6210   Nokia 3 Nokia 6310   Nokia 4 Nokia 6230i   Nokia 5 Nokia 8250   Nokia 6 Nokia 6610 115200 Nokia 7 Nokia 7210 115200 Nokia 8 Sony Ericsson T610 19200 Sony Ericsson 9 Sony Ericsson W800i 115200 Sony Ericsson 10 samsung sgh-c100 9600 Samsung 11 Sharp GX30 115200 Sharp 12 Sony Ericsson k700 115200 Sony Ericsson 13 Motorola RAZR V3 115200 Motorola 14 Nokia 7610 115200 Nokia 15 Nokia 3310/3315 19200 Nokia 16 Siemens M35 19200 Siemens 17 Siemens M50 19200 Siemens 18 Siemens C45 19200 Siemens   Can’t find the modem that you''re looking for? Just check whether the device you have meets the following configuration: Your modem must have GSM functionality with the provision to insert the SIM card. It should support 7bit (GSM default alphabet), 8bit and Unicode (UCS2) encoding. Applications Manager uses AT commands to send SMS, so the device should respond to AT commands. [If needed, you can test it using HyperTerminal]. If all the above criteria match, AppManager will support your modem phone. Regular Expressions Applications Manager supports usage of Regular Expressions (Regex) while searching for data. A regular expression is a special sequence of characters defines a search pattern for strings.Regular Expression Syntax: Here is the table listing down all the regular expression metacharacter syntax available in Java: Subexpression Matches ^ Matches beginning of line. $ Matches end of line. Matches any single character except newline. Using m option allows it to match newline . as well. [...] Matches any single character in brackets. [^...] Matches any single character not in brackets \A Beginning of entire string \z End of entire string \Z End of entire string except allowable final line terminator. re* Matches 0 or more occurrences of preceding expression. re+ Matches 1 or more of the previous thing re? Matches 0 or 1 occurrence of preceding expression. re{ n} Matches exactly n number of occurrences of preceding expression. re{ n,} Matches n or more occurrences of preceding expression. re{ n, m} Matches at least n and at most m occurrences of preceding expression. a| b Matches either a or b. (re) Groups regular expressions and remembers matched text. (?: re) Groups regular expressions without remembering matched text. (?> re) Matches independent pattern without backtracking. \w Matches word characters. \W Matches nonword characters. \s Matches whitespace. Equivalent to [\t\n\r\f]. \S Matches nonwhitespace. \d Matches digits. Equivalent to [0-9]. \D Matches nondigits. \A Matches beginning of string. \Z Matches end of string. If a newline exists, it matches just before newline. \z Matches end of string. \G Matches point where last match finished. \n Back-reference to capture group number "n" Matches word boundaries when outside brackets. Matches backspace (0x08) when inside \b brackets. \B Matches nonword boundaries. \n, \t, etc. Matches newlines, carriage returns, tabs, etc. \Q Escape (quote) all characters up to \E \E Ends quoting begun with \Q See Also Monitor Information - File / Directory Monitor | Create Other New Monitors WMI Prerequisites Prerequisites for WMI mode of monitoring Install the latest .NET Framework on your Applications Manager machine. Enable .NET Framework 3.5:To know how to enable .NET 3.5 in Windows Server 2008, click here. To know how you can enable .NET 3.5  other Windows Servers, click here. Firewall access for monitoring: Ports required for monitoring via WMI: Windows Management Instrumentation (WMI) (default : TCP 445) Remote Procedure Call (RPC) (default :TCP 135) Target server uses random port above 1024 by default to respond back for remote communication (DCOM) (default : TCP 1025 to 1030) Enabling Powershell For using PowerShell in Applications Manager, you need the latest Windows Management Framework (Windows PowerShell 5.0) on both Applications Manager server and the remote Windows server. Powershell - Enable Script Execution Powershell script execution must be enabled on Applications manager server for data collection. Here is how you can do it: Execute the below cmdlet from an administrator powershell window: Set-ExecutionPolicy Unrestricted If the above cmdlet produces an Error as below, you can configure Powershell Script Execution via Group Policy Editor: Configure Powershell Script Execution via Group Policy Editor Open the Group Policy Editor from Control Panel → Edit Group Policy (or) run gpedit.msc from Start menu. To configure, navigate under Computer Configuration to Policies\Administrative Templates\Windows Components\Windows PowerShell. You should see a setting called Turn on Script Execution like in the following image: Double-click the setting. You will want to enable it and select an option from the drop down.Set it to “Allow All Scripts”. Click Apply and OK. Enable and Use Remote Commands in Windows PowerShell Ensure that Windows PowerShell is enabled in both servers: Open Control Panel. Select Programs and Features. In the Tasks list, click Turn Windows features on or off. When the Server Manager console opens, check if Windows PowerShell is enabled. Ports required for PowerShell remoting - Default: TCP 5985 and 5986 You can verify the availability of Windows Remote Management (WinRM) service and configure PowerShell for remoting by following these steps: Start Windows PowerShell as an administrator by right-clicking the Windows PowerShell shortcut and selecting Run As Administrator. To configure Windows PowerShell for remoting, type the following command:  Enable-PSRemoting -force Configure the TrustedHosts setting on both computers, so that computers will trust each other: On Remote Monitored Server: Set-Item wsman:\localhost\client\trustedhosts On Applications Manager Sever: Set-Item wsman:\localhost\client\trustedhosts * Include the below cmdlets to be execute on remote Windows server when enabling powershell remoting (It''s not required to be run on the Applications Manager server): "Set-Item WSMan:\localhost\Shell\MaxShellsPerUser -value 25 -WarningAction SilentlyContinue" ( To increase the maximum number of concurrent shells that a user can remotely open) "Set-Item WSMan:\localhost\Shell\IdleTimeout -value 60000 -WarningAction SilentlyContinue" (Determines how long the session stays open if the remote computer does not receive any communication from the local computer, including the heartbeat signal. When the interval expires, the session closes.)On both computers, restart the Windows Remote Management (WinRM) so the new settings will take effect: Restart-Service WinRM. You can test the configuration and connection from Applications Manager by following these steps: Open PowerShell Console with administrator privileges. Run : $testSession= New-PSSession -ComputerName -Credential Get-Credential A popup will appear, give the remote server credentials. If any error is thrown, do the required configuration/setup to resolve it. If step 3 executes without error, remove the testSession by executing : Get-PSSession | Remove-PSSession The steps above will test whether the WinRM service is running on the remote computer and if Applications Manager can communicate with the remote server. Enabling CredSSP Authentication CredSSP delegates the users credentials from one computer to another remote computer. Use Credssp authentication when the Remote Server is present in a different domain other than that of the Applications Manager server domain. This is used for Active Directory, SharePoint Server and Exchange Server monitors for some specific metrics. Steps to enable CredSSP Authentication Perform the following steps on the Remote Server: Open Windows PowerShell as Administrator and execute the below commands in the Administrator PowerShell: Enable-WSManCredSSP -Role Server Open gpedit.msc and go to Local Computer Policy -> Computer Configuration -> Administrative Templates -> System -> Credentials Delegation - Enable Encryption Oracle Remediation and set Protection Level to Mitigated (Optional) Perform the following steps on the Applications Manager server: Note: Replace with the hostname of the Remote Server. Open Windows PowerShell as Administrator and execute the below commands in the Administrator PowerShell: Enable-WSManCredSSP -Role client -DelegateComputer Open gpedit.msc and go to Local Computer Policy -> Computer Configuration -> Administrative Templates -> System -> Credentials Delegation - Enable Allow delegating fresh credentials and set value "wsman/ " - Enable Allow delegating fresh credentials with NTLM-only server authentication and set value "wsman/ " In the Administrator PowerShell run the below command: $testSession= New-PSSession -ComputerName -Authentication Credssp -Credential Get- Credential If Session is created without any error in the Edit Monitor page, enable the Use CredSSP authentication option and update the monitor. Two-Factor Authentication (TFA) in Applications Manager Overview Steps to configure TFA Troubleshooting stepsOverview Two Factor Authentication (TFA) provides an additional level of authentication and improves security by requiring the user to provide a unique time-based one time password (TOTP) generated through Authenticator Apps, or as a one time password (OTP) sent to the user''s configured email address. TFA strengthens authentication and prevents unauthorized access. Once enabled, users will be prompted to enter the One Time Password (OTP) along with their default password. Steps to configure TFA To configure Two Factor Authentication in Applications Manager, follow the steps given below: Go to Settings → User Management → Two Factor Authentication. Select the Enable Two Factor Authentication (TFA) option. Choose the desired Authentication Mode. Authentication can be performed using any one of the following methods: Authenticator Apps (TOTP): Allows you to authenticate using Time-based One Tine Password (TOTP) generated via Authenticator apps. Some examples of Authenticator apps include but not limited to Google Authenticator, Microsoft Authenticator, Duo, etc. Learn more Note: All users will be prompted to set up their Authenticator app during their next login. Learn more Email: Allows you to authenticate using One Time Password (OTP) sent via email to the user''s configured email address. Learn more Note: Mail Server Settings and Email ID''s for all users need to be configured for the Email Authentication Mode. Specify the number of days for which the browser must remember your login. With this, you will not be required to provide TOTP/OTP while logging in on that browser for the specified number of days. This will be applicable to everyone and is up to the user to select the checkbox to trust the browser during login. Click Save. After configuring the above settings, Two-Factor Authentication can be performed in Applications Manager by following the steps based on any of the below Authentication Modes chosen: Authentication using Authenticator apps Authentication using email Authentication using Authenticator apps During the next login, install the app and follow the steps shown on screen to configure your desired Authenticator app on your mobile device, which is a one-time process. Then, enter the OTP generated in the Authenticator app to login as a second factor to able to access the product UI.Note: The time in the configured mobile device must be in sync with the Applications Manager server time.Authentication using email If the mode of Authentication is chosen as Email, then the OTP will be sent via email to the configured email address. Then, enter the OTP generated in the email to login as a second factor to able to access the product UI. Note: Mail server should be reachable for Applications Manager with a connection time out of 1 minute in order for Applications Manager to be able to send OTP in mail. Troubleshooting steps In the event that a new TOTP secret is required due to the loss of the mobile device configured or for any other such reason:The super admin can go to Settings → User Management → Select respective users and click on the Reset TOTP secret icon to reset TOTP for them. If the super-admin itself has lost the configured mobile device/is unable to retrieve the OTP from App/Email, then TFA can only be disabled manually in the server where Applications Manager is installed. To troubleshoot, follow the steps below: Shutdown Applications Manager. Open the AMServer.properties file located under /conf/ directory. Add the key am.twofactor.authentication.status=disable and save the file. Start Applications Manager and proceed for login. Enable Two-factor authentication whenever required. Tomcat Server.xml factory org.apache.commons.dbcp.BasicDataSourceFactory maxActive 100 maxIdle 30 maxWait 10000 username root password driverClassName org.gjt.mm.mysql.Driver url jdbc:mysql://localhost:13326/AMDB? autoReconnect=true Tomcat Users.xml ">