WLSDM Help


1. Introduction

WLSDM is an enterprise “WebLogic console extension” which enables monitoring for WebLogic JMX MBean metrics and all the WebLogic domain assets (Health, Servers, Applications, Data Sources, JMS… etc.). It is very easy to create alarm and notification definitions by using WLSDM metric browser. WLSDM can store any WebLogic metric values historically and also can generate graphical reports.

WLSDM is a WebLogic Console extension and runs under WebLogic console on Admin server.

1.1. Important WLSDM Features

  • Deploy just in seconds
  • Responsive user interface
  • Responsive graphs
  • Configure domain monitoring with WLSDM setup wizard
  • Get alarms and notifications
  • Robust alarm generation infrastructure (Parametric alarm counter support)
  • Customize email templates according to your organization
  • Fancy and responsive ALERT and CLEAR emails (HTML)
  • Get CLEAR emails and notifications when problem disappeared
  • Create unlimited dashboards
  • Responsive health page for WebLogic domain assets
  • Monitor applications' response times
  • Monitor WebLogic logs by using WLSDM log inspector
  • Store WebLogic JMX metric values historically
  • Get JVM thread,heap dumps when a defined case occurred
  • Generate reports
  • Localize (language) and customize HTML emails’ content, subject, header… etc.
  • Customize and configure WLSDM settings (SMTP, Email content, Logging… etc.)

1.2. WLSDM Functionality and Easy Usage

By using WLSDM, there is no need to write WLST scripts for getting WebLogic MBean metrics and scheduling it. Let WLSDM take care everything. WLSDM can access any values on WebLogic console.

  1. Add metric monitoring by using WLSDM metric browser
  2. Enable monitoring and storing data
  3. Specify threshold values for the metrics
  4. Monitor values on dashboards with fancy graphs
  5. Get ALERT and CLEAR notifications instantly
  6. Access historical data and generate reports

2. Installation

2.1. Install in Two Steps

At first, copy wlsdm.$version/war/wlsdm.war file to WebLogic domain's console-ext folder. Then restart WebLogic domain's admin server. That's all, WLSDM will deploy automatically.

  1. copy wlsdm.$version/war/wlsdm.war ${WEBLOGIC_DOMAIN_HOME}/console-ext/.
  2. restart admin server

*Optional: There is no need to install agent for MBean, Log and Response Time monitoring. For backend monitoring, remote JVM actions please install wlsdm_agent.jar

Copy wlsdm.$version/jar/wlsdm_agent.jar file to a path on the server.

 *3. add -javaagent:/path/to/wlsdm_agent.jar to managed server's classpath.

While WebLogic domain’s Admin Server starting, following log will be visible in Admin Server log file. This means WLSDM is deployed successfully.

  <Mar 4, 2015 2:01:31 PM EET> <Info> <WLSDM> <BEA-000000> <WLSDM deployed successfully.>
  <Mar 4, 2015 2:01:31 PM EET> <Info> <WLSDM> <BEA-000000> <WLSDM metric collector initialized successfully.>
  <Mar 4, 2015 2:01:31 PM EET> <Info> <WLSDM> <BEA-000000> <WLSDM performance monitoring initialized successfully.>

2.2. Accessing WLSDM Console

After the installation login to WebLogic admin console then WLSDM portlet will be visible under WebLogic domain structure.


Click "Smart Dashboard Console" on WLSDM menu.

OR

Type WLSDM URL on browser's address bar for accessing directly.


http:// ${ADMIN_SERVER_IP} : ${PORT} /console/WLSDM

https:// ${ADMIN_SERVER_IP} : ${PORT} /console/WLSDM


2.3. WLSDM Acess Role

Important Note: Only default “Administrators” group members or users who have global “Admin” role can access to WLSDM console, remaining cannot access WLSDM console.

3. Completing WLSDM Wizard

WLSDM has a robust wizard which is aimed for setting up a WebLogic domain’s monitoring configurations easily and fast. This wizard is active only for the first login. WLSDM reads the WebLogic domain and offers important metric to monitor.


3.1. WLSDM Quick Installation Wizard


Step 1: Welcome: Wizard introduction



Step 2: License Infromation

After accepting the license agreement, WLSDM offers two options:

  1. Evaluate for 15 days:
  2. If you do not have a valid WLSDM license key, choose this option for the evaluation. After 15 days WLSDM will ask for a valid license.

  3. Enter license key:
  4. If you have a valid WLSDM license key, choose this option and enter the appropriate license information. The license key will be checked offline and activated instantly if it is a valid key.


Step 3: Alarm Configuration (Optional)

In step 3, the SMTP settings and email recipients can be configured easily. These settings can be left blank, but it is highly recommended to configure these settings successfully.

By setting up email configuration WLSDM will send notifications and HTML email alerts.

Use "Send" button for testing SMTP settings. If you configured the SMTP settings successfully, you will get a test email as below.




If any error occurs then check wlsdm.log file which is located under $WL_DOMAIN_HOME/WLSDM/logs folder.


Step 4: Reading Domain

WLSDM reads WebLogic domain and lists the domain resources to configure monitoring settings.


Step 5: Domain Resources

There are four main groups which WLSDM offers to monitor: Servers, Deployments, Data Sources and JMS

Select domain resources to monitor. All important domain resources are selected by default. These can be unselected in this step.




Step 6: Metric Configuration

This is most important step and highly recommended to complete carefully. WLSDM offers important WebLogic MBean metrics to monitor according to domain’s available resources.


Complete Step-6 operations as:

1. Check metric values: All available metrics are grouped by WebLogic servers. All the sub instance threshold values can be set on main metric record. Click on threshold editbox and see current instance values.



2. Set threshold values: Give reasonable threshold values according to the WebLogic domain characteristic.
3. Enable/Disable alarm: It can be done by using ON/OFF button on “Alarm” column.
4. Delete metric instance: It is also possible to remove the metric instance.
5. Reset values and configurations: All the configurations, values and deletion processes can be reset by clicking on refresh icons on metric group tabs.

Step 7: Finish

It is unable to access to the wizard page after completing WLSDM monitoring wizard steps. But all the configurations and values can be updated on Configuration/Metrics and Dashboard pages.


4. Runtime {WLSDM} Folder Structure

When WLSDM installed to a WebLogic domain, it creates "WLSDM" folder under WebLogic domain's home folder. Directory layout of WLSDM folder:




${WL_DOMAIN_HOME}/WLSDM



Folder Name Relative Path Description
db ${WL_DOMAIN_HOME}/WLSDM/db WLSDM's embedded database folder. WLSDM uses embedded Apache Derby Database which comes with wlsdm.war file. There is no operational cost for maintaining WLSDM database, the console extension take care everything.
config ${WL_DOMAIN_HOME}/WLSDM/config Configuration folder which consists of html email "templates" folder and main WLSDM config file wlsdm.config.xml
logs ${WL_DOMAIN_HOME}/WLSDM/logs WLSDM's default log folder. There are two log file, one wlsdm.db.log the other is wlsdm.log which is the main log file.
temp ${WL_DOMAIN_HOME}/WLSDM/temp This folder is using by WLSDM's log inspector module for sending alert emails which have log attachments.

5. WLSDM Console Usage

5.1. General Usage

Main WLSDM menu is located on the left side and default is collapsed. It can be expand/collapse by menu icon.



Page operations icon is located on the right top of every pages. Visual page settings and page functions can be list page operations menu.



Summary metric notification window is located on the right top of every page.




5.2. Smart Dashboards Usage

Health Dashboard

Health dashboard page is the home page of WLSDM and lists all the WebLogic domain resources at one page. All the states and health values is listed for per WebLogic server instance.



Health Notifications

WLSDM checks these health and states periodically. If the health is not "OK" and state's value is not "RUNNING" for any resource, WLSDM generates "Health ALARM" and sends email notifications as below.



Using Health Dashboard

Health alarm notifications can be enabled/disabled for each resources (Servers, Applications, Data Sources and JMS) by clicking on alarm icon on the lists.



Default Dashboards

Servers, Deployments, Data Sources and JMS Servers dashboards are default dashboards which are created at wizard steps.

Dashboard page operations are as below:

  • Can update dashboard name
  • Can change “Metric Load Range” historically (Minimum 1 minute)
  • Can change automatic “Page Refresh Frequency” (Minimum 30 seconds)
  • Can change number of charts per line (Minimum 1 chart)
  • Can change chart heights (Minimum 100px)
  • Can change grid display status (Show / Hide)


Chart Usage on Dashboard Pages

All metric and chart operation icons are located on the top right of charts.





  • Metric & Chart Options: Opens metric options window
  • Print: Print window is opened and it is possible to save the charts as PDF document
  • Show/Hide: Opens/Closes chart display
  • Reload: Reloads metric values for the current chart (Loads the current values of WebLogic MBeans)
  • Close: Removes the chart occurrence on the page. When page refreshes the chart is loaded again.


Metric and Chart Options

Opens the "Metric and Chart" Options window. All the operations can be done on this window easily.

  • Can change "Metric Chart Type"
  • Can change metric's dashboard settings to show on which dashboard to display
    Important Feature: A metric can be assign multiple dashboard.



  • Alarm settings (ON / OFF)
  • Action settings (Thread Dump, Heap Dump... etc.)
  • Synchronization settings (Controlling extended WebLogic servers)
  • Synchronization settings (Controlling extended WebLogic servers)
  • Monitoring metric instance health