org.openspaces.admin.dump

Interface DumpProvider

All Known Subinterfaces:

Admin, GridServiceAgent, GridServiceAgents, GridServiceContainer, GridServiceContainers, GridServiceManager, GridServiceManagers, InternalAdmin, InternalGridServiceAgent, InternalGridServiceAgents, InternalGridServiceContainer, InternalGridServiceContainers, InternalGridServiceManager, InternalGridServiceManagers, InternalLookupService, InternalLookupServices, InternalMachine, InternalZone, LookupService, LookupServices, Machine, Zone

All Known Implementing Classes:

DefaultAdmin, DefaultGridServiceAgent, DefaultGridServiceAgents, DefaultGridServiceContainer, DefaultGridServiceContainers, DefaultGridServiceManager, DefaultGridServiceManagers, DefaultLookupService, DefaultLookupServices, DefaultMachine, DefaultZone

public interface DumpProvider

Elements in the admin API that support dump operations. Allows to generate dump of the given element(s).

Author:

kimchy

Method Summary

Modifier and Type	Method and Description
DumpResult	generateDump(String cause, Map<String,Object> context) Generates dump for all the provided dump processors.
DumpResult	generateDump(String cause, Map<String,Object> context, String... processor) Generates dump for the provided processors.

Method Detail

generateDump

DumpResult generateDump(String cause,
                        Map<String,Object> context)
                 throws AdminException

Generates dump for all the provided dump processors. Note, this will include a heap dump which can consume time and potentially be of very large size

Parameters:

cause - The cause that this dump was generated

context - Allows to provide specific parameters to specific processors

Throws:

AdminException

generateDump

DumpResult generateDump(String cause,
                        Map<String,Object> context,
                        String... processor)
                 throws AdminException

Generates dump for the provided processors. The current list of processors include:

• summary: General summary information of the process.
• network: Information on the network layer of the process and the OS network stats.
• thread: Thread dump of the process.
• heap: Heap dump of the process. Note, this is a heavy operation and can produce very large dump files
• log: Adds all the log files of the process to the dump file.
• processingUnits: Dump of all the processing units (applicable only for GSCs) information.

Parameters:

cause - The cause this dump was generated.

context - Allows to provide specific parameters to specific processors.

processor - The list of processors to be used.

Throws:

AdminException