WAS v8.5 > Troubleshoot > Work with Diagnostic Providers

Create a Diagnostic Provider

Use Diagnostic Providers to query the startup configuration, current configuration, and current state of a diagnostic domain. Diagnostic Providers also provide access to any self diagnostic tests available from a diagnostic domain.

To complete this task you must have programming knowledge of the system and the proper authorities to perform the following steps.

The steps that follow outline a general process for creating Diagnostic Providers (DP).

1. Determine your diagnostic domain. Look for configuration MBeans that control a similar domain in the same component. Extending an existing configuration MBean with a DP interface avoids proliferation of new MBeans and has the benefit that mapping from a diagnostic MBean to a configuration MBean requires no additional information.

2. Determine what configuration attributes to expose. Include information used to configure your component from the configuration MBeans.

3. Determine what state attributes to expose. Anything you might want to know about the state of your component for troubleshooting can go here.

4. Determine what self diagnostic tests you will expose.

5. Determine what test attributes you will return for each self diagnostic.
6. Create your DP registration XML file.
   

7. Create your DP implementation.
   1. To see an example, refer to Implement a Diagnostic Provider and keep in mind that most things that a Diagnostic Provider should do are already done for you in the DiagnosticProviderHelper class.
   2. To ensure that we do not collect unwanted data, add hooks in your component code where you need to collect state data using the DiagnosticConfig object.

   3. Add hooks in your component code where you need to store or be able to access configuration data.

8. Add code to register your DP implementation.

   Typically, the best place to do this is where your component is initialized.

9. Add Diagnostic Provider IDs (DPID) to the logged messages. Registering a DPID with a logger makes that information available in any messages logged with this logger. This enables fast paths in the DP utility to function on this particular Diagnostic Provider.
   1. Register your DPID with your loggers (for any of your loggers that you only want to associate a single DPID with).

   2. When we use multiple DPIDs with the same Logger, we can (instead of registering a single DPID with a Logger) add DPIDs to individual logging calls in the parm[0] position. Do not put {0} in the corresponding localized messages. It is bad practice to print the DPID in your messages as this would be inconsistent with messages from loggers with statically assigned DPIDs.

Subtopics

• Diagnostic Provider Extensible Markup Language
  Some conventions to follow for Diagnostic Provider (DP) XML declarations.
• Choose a Diagnostic Provider name
  To ensure consistency when choosing Diagnostic Provider names to use with your components, you should consider the guidelines that follow.
• Implement a Diagnostic Provider
  To use a Diagnostic Provider configure an MBean with the methods and attributes required to handle the data from the application server and client applications.
• Create a Diagnostic Provider registration XML file
  The Diagnostic Provider registration XML is used to provide information about the exposed configuration, state, and self diagnostic attributes and tests to the Diagnostic Provider utility. It is also used to populate objects needed later in the process, to assist in filtering, and to assist in localization.
• Diagnostic Provider Extensible Markup Language
  Some conventions to follow for Diagnostic Provider (DP) XML declarations.
• Choose a Diagnostic Provider name
  To ensure consistency when choosing Diagnostic Provider names to use with your components, you should consider the guidelines that follow.
• Implement a Diagnostic Provider
  To use a Diagnostic Provider configure an MBean with the methods and attributes required to handle the data from the application server and client applications.
• Create a Diagnostic Provider registration XML file
  The Diagnostic Provider registration XML is used to provide information about the exposed configuration, state, and self diagnostic attributes and tests to the Diagnostic Provider utility. It is also used to populate objects needed later in the process, to assist in filtering, and to assist in localization.

+

Search Tips   |   Advanced Search