Skip navigation.
Downloads | Product Documentation | Support

Administration Console Online Help

# Configure Instrumentation for Applications

Before you begin

A diagnostic applicaton module is a software component that you configure to monitor an aspect of a running application or application module. Diagnostic application modules are similar to diagnostic system modules, but you can configure only instrumentation in a diagnostic application module. (You can configure additional diagnostic features in a diagnostic system module. See Create diagnostic system modules) When you configure instrumentation for an applcation, you can use standard diagnostic monitiors and diagnostic actions from the WebLogic Diagnostic Framework Instrumentation Library, or you can create your own diagnostic monitors and then attach diagnostic actions from the library to them.

To configure application-scoped instrumentation in the Administration Console, you must first create a well-formed diagnostics descriptor file named `weblogic-diagnostics.xml` and place it in the root `META-INF` directory of the application or application module. (See "Configuring Application-Scoped Instrumentation" in Configuring and Using the WebLogic Diagnostics Framework.) Once that file is created and placed in the directory, you can start the Adminstration console to create or modify the diagnostic monitors in the diagnostic application module.

To configure instrumentation in a diagnostic application module:

1. If you have not already done so, in the Change Center of the Administration Console, click Lock & Edit (see Use the Change Center).
2. In the left pane, click Deployments.
3. On the Summary of Deployments > Control page, click the name of the application or application module for which you want to configure diagnostic monitors.
4. On the Setting for [Application or Module name] page, select Configuration > Instrumentation.
5. To enable or disable all diagnostic monitors for this application or module, select or deselect Enabled.

   Note: To enable instrumentation for an application or module, you must also enable instrumentation for the server or cluster to which the application or module is deployed. See Enable or disable instrumentation in a diagnostic system module

6. [Optional] Specify filters to restrict which classes the Weblogic Diagnostic Framework (WLDF) will process to determine if diagnostic code should be woven into the class code, as defined in the joinpoints defined in the diagnostic monitors.
   1. In the Included Classes field, enter a pattern expression to specify classes to process.
   2. In the Excluded Classes field, enter a pattern expression to specify classes not to process.

   The pattern expression is a comma-delimited list of packages or classes to include or exclude. You can use the asterix (*) wildcard to represent one or more characters.

   The expressions are evaluated as follows:

   - If neither Included Classes nor Excluded Classes are specified, all classes in the application or application module will be processed.
   - If Included Classes are specified but Excluded Classes are not, all Included Classes (and no others) will be processed.
   - If Excluded Classes are specified but Included Classes are not, all classes except those specified in the Excluded Classes list will be processed.
   - If both Included Classes and Excluded Classes are specified, all Included Classes will be processed, unless a class listed as included is also listed as excluded, in which case that class will be excluded from processing.
7. [Optional] In the Excluded Classes field, enter a pattern expression to specify the classes to which diagnostic monitors cannot be added.
8. If you enabled or disabled instrumentation, or if you added or edited a pattern expression in the Included Classes or Excluded Classes fields, click Save to save your changes.
9. Add, create, or modify diagnostic monitors, as described in the steps below.
10. To add a monitor from the WLDF Instrumentation library:
    1. Click Add Monitor From Library.
    2. On the Add/Remove Monitors From Library page, select one or more diagnostic monitors from the Available list, then click the right arrow to move the monitors to the Chosen list.
    3. Click Finish.
11. To create a custom monitor and add it to this diagnostic module, see Create Custom Diagnostic Monitors for Applications.
12. To modify the configuration for any existing monitor, under Diagnostic Monitors in this Module click the name of the monitor you want to configure. On the Settings for [Diagnostic Monitor name] page, modify the configuration settings.
13. To activate these changes, in the Change Center of the Administration Console, click Activate Changes.
    Not all changes take effect immediately—some require a restart (see Use the Change Center).