Configuring and Using the WebLogic Diagnostic Framework

Introduction and Roadmap

This section describes the contents and organization of this guide and the audiences to which it is addressed—Configuring and Using the WebLogic Diagnostic Framework.

What Is the WebLogic Diagnostic Framework?

The WebLogic Diagnostic Framework (WLDF) is a monitoring and diagnostic framework that defines and implements a set of services that run within the BEA WebLogic Server® process and participate in the standard server life cycle. Using WLDF, you can create, collect, analyze, archive, and access diagnostic data generated by a running server and the applications deployed within its containers. This data provides insight into the run-time performance of servers and applications and enables you to isolate and diagnose faults when they occur.

WLDF includes several components for collecting and analyzing data, including the following:

Diagnostic Image Capture—creates a diagnostic snapshot from the server that can be used for post-failure analysis
Archiver—captures and persists all data events, log records, and metrics from server instances and applications
Instrumentation—adds code to WebLogic server instances and the applications running on them to execute diagnostic actions at specified locations in the code. The Instrumentation component provides the means for creating and tracking diagnostic context by uniquely identifying requests and tracking them as they flow through the system.
Harvester—captures metrics from run-time MBeans, including WebLogic Server MBeans and custom MBeans
Watches and Notifications—provides the means for monitoring server and application states and sending notifications based on criteria set in the watches
Logging services—manages logs for monitoring server, subsystem, and application events. The WebLogic Server logging services are documented separately from the rest of the WebLogic Diagnostic Framework. See Configuring Log Files and Filtering Log Messages.

WLDF provides a set of standardized application programming interfaces (APIs) that enable dynamic access and control of diagnostic data, as well as improved monitoring that provides visibility into the server. Independent Software Vendors (ISVs) can use these APIs to develop custom monitoring and diagnostic tools for integration with WLDF.

WLDF is a new feature in WebLogic 9.0. In previous releases of WebLogic Server, access to diagnostic data by monitoring agents—which were developed by customers or third-party tool developers—was limited to JMX attributes, and changes to monitoring agents required server shut down and restart. However, WLDF enables dynamic access to server data through standard interfaces, and the volume of data accessed at any given time can be modified without shutting down and restarting the server.

Document Scope and Audience

This document tells how to configure and use the monitoring and diagnostic services provided by WLDF.

WLDF provides features for monitoring and diagnosing problems in running WebLogic server instances and clusters and in applications deployed to them. Therefore, the information in this document is directed both to system administrators and to application developers. It also contains information for third-party tool developers who want to build tools to support and extend WLDF.

It is assumed that readers are familiar with Web technologies and the operating system and platform where WebLogic Server is installed.

Guide to This Document

This document is organized as follows:

This chapter, "Introduction and Roadmap," introduces the organization of this guide and the audiences to which this guide is addressed.
Understanding WLDF Configuration, provides an overview of how WLDF features are configured for servers and applications.
Configuring and Capturing Diagnostic Images, tells how to configure and use the WLDF Diagnostic Image Capture component to capture a snapshot of significant server configuration settings and state.
Configuring Diagnostic Archives, tells how to configure and use the WLDF Diagnostic Archive component to persist diagnostic data to a file store or database.
Configuring the Harvester for Metric Collection, tells how to configure and use the WLDF Harvester component to harvest metrics from runtime MBeans, including WebLogic Server MBeans and custom MBeans.
Configuring Watches and Notifications, provides an overview of WLDF watches and notifications.
Configuring Watches, tells how to configure watches to monitor server instances and applications for specified conditions and then send notifications when those conditions are met.
Configuring Notifications, tells how to configure notifications that can be triggered by watches.
Configuring Instrumentation, tells how to add diagnostic instrumentation code to WebLogic Server classes and to the classes of applications running on the server.
Configuring the Diagnostic Context, tells how to use the DyeInjection monitor and how to us dye filtering with diagnostic monitors.
Accessing Diagnostic Data Using the Data Accessor, tells how to configure and use the WLDF Data Accessor component to retrieve diagnostic data.
Introduction to Programming WLDF, provides an overview of how you can use the JMX API and the WebLogic Scripting Tool (weblogic.WLST) to configure and use WLDF components.
WLDF Query Language, describes the WLDF query language that is used for constructing expressions to query diagnostic data using the Data Accessor, construct watch rules, and construct rules for filtering logs.
WLDF Instrumentation Library, describes the predefined diagnostic monitors and diagnostic actions that are included in the WLDF Instrumentation Library.
WebLogic Scripting Tool Examples, provides examples of how to perform WLDF monitoring and diagnostic activities using the WebLogic Scripting Tool.
Terminology, is a glossary of terms used in WLDF.

Introduction and Roadmap

What Is the WebLogic Diagnostic Framework?

Document Scope and Audience

Guide to This Document

Related Documentation