Contents for Configuring and Using the WebLogic Diagnostic Framework
Introduction and Roadmap
What Is the WebLogic Diagnostic Framework?
Document Scope and Audience
Guide to This Document
Related Documentation
Understanding WLDF Configuration
About Configuration MBeans and XML
Tools for Configuring WLDF
How WLDF Configuration Is Partitioned
Server-Level Configuration
Application-Level Configuration
Configuring Diagnostic Image Capture and Diagnostic Archives
Configuring Diagnostic System Modules
About the Diagnostic System Module and Its Resource Descriptor
Referencing the Diagnostics System Module from Config.xml
About the Resource Descriptor Configuration
Managing Diagnostic Modules
More Information About Configuring Diagnostic System Resources
Configuring Diagnostic Modules for Applications
About the Configuration MBean Hierarchy and Mappings to XML Elements
Configuring and Capturing Diagnostic Images
How to Initiate Image Captures
About First Failure Detection and Notification
Configuring Diagnostic Image Captures
What Information Is Captured
About the Captured Image File
Configuring Diagnostic Archives
Configuring the Archive
Configuring a File-Based Store
Configuring a JDBC-Based Store
Creating WLDF Tables in the Database
Configuring JDBC Resources for Use By WLDF
Configuring the Harvester for Metric Collection
About Harvesting, Harvestable Data, and Harvested Data
Harvesting Data from the Different Harvestable Entities
Configuring the Harvester
Configuring the Harvester Sampling Period
Configuring the Types of Data to Harvest
Specifying Type Names for WebLogic Server MBeans vs. Custom MBeans
When Configuration Settings are Validated
Example Configurations for Different Harvestable Types
Configuring Watches and Notifications
About Watches and Notifications
Overview of Watch and Notification Configuration
Sample Watch and Notification Configuration
Configuring Watches
About the Types of Watches
Configuration Options Shared by all Types of Watches
Configuring Harvester Watches
Configuring Log Watches
Configuring Instrumentation Watches
Defining Watch Rule Expressions
Configuring Notifications
About the Types of Notifications
Configuring JMX Notifications
Configuring JMS Notifications
Configuring SNMP Notifications
Configuring SMTP Notifications
Configuring Image Notifications
Configuring Instrumentation
Concepts and Terminology
Instrumentation Scope
Configuration and Deployment
Joinpoints, Pointcuts, and Diagnostic Locations
Diagnostic Monitor Types
Diagnostic Actions
Instrumentation Configuration Basics
About the Instrumentation Configuration Files
The XML Elements Used for Instrumentation
Configuring Server-scoped Instrumentation
Configuring Application-scoped Instrumentation
Comparing System-scoped to Application-scoped Instrumentation
Overview of the Steps Required to Instrument an Application
Creating a Descriptor File for a Delegating Monitor
Creating a Descriptor File for a Custom Monitor
Defining Pointcuts for Custom Monitors
Deploying an Application Diagnostic Descriptor
Creating Deployment Plans using weblogic.PlanGenerator
Deploying an Application with Deployment Plans
Support for Dynamic Control of the Instrumentation Configuration
Updating an Application with a Modified Plan
Configuring the Diagnostic Context
About the Contents, Life Cycle, and Configuration of a Diagnostic Context
About Context Life Cycle and the Context ID
About Dyes, Dye Flags, and Dye Vectors
Where Diagnostic Context is Configured
Overview of the Process
Configuring the Dye Vector via the DyeInjection Monitor
Dyes Supported by the DyeInjection Monitor
About the PROTOCOL Dye Flags
About the THROTTLE Dye Flag
When Contexts Are Created
Configuring Delegating Monitors to Use Dye Filtering
How Dye Masks Filter Requests To Pass to Monitors
Using Throttling to Control the Volume of Instrumentation Events
Configuring the THROTTLE Dye
How Throttling is Handled by Delegating and Custom Monitors
Using weblogic.diagnostics.context
Accessing Diagnostic Data Using the Data Accessor
About the Data Stores Accessed by the Data Accessor
Accessing Diagnostic Data Online
Accessing Data Using the Administration Console
Accessing Data Programmatically Using Runtime MBeans
Using WLST to Access Diagnostic Data Online
Using the WLDF Query Language with the Data Accessor
Accessing Diagnostic Data Offline
Introduction to Programming WLDF
Programming Tools
Configuration and Runtime APIs
WLDF Packages
Deploying WLDF Application Modules
Programming WLDF: Examples
Example: DiagnosticContextExample.java
Example: HarvesterMonitor.java
Example: JMXAccessorExample.java
WLDF Query Language
Components of a Query Expression
Supported Operators
Operator Precedence
Supported Literals
Numeric Literals
String Literals
About Variables in Expressions
Creating Watch Rule Expressions
Creating Log Event Watch Rule Expressions
Creating Instrumentation Event Watch Rule Expressions
Creating Harvester Watch Rule Expressions
Creating Data Accessor Queries
Data Store Logical Names
Data Store Column Names
Creating Log Filter Expressions
Building Complex Expressions
WLDF Instrumentation Library
Diagnostic Monitor Library
Diagnostic Action Library
WebLogic Scripting Tool Examples
Dynamically Creating DyeInjection Monitors Example
Watch and JMXNotification Example
JMXWatchNotificationListener Class Example
MBean Registration and Data Collection Example
Terminology