org.mule.runtime.api.profiling

Interface ProfilingService

@Experimental
 @NoImplement
public interface ProfilingService

Service that provides profiling resources. This is implemented by the Runtime. Different components can inject this service and register or obtain a ProfilingDataProducer to begin emitting profiling data. For instance: @Inject private ProfilingService profilingService; // register a profiling data producer for the TEST_PROFILING_TYPE event type profilingService.register(TEST_PROFILING_TYPE, new TestProfilingDataProducer()); // .... // trigger a profiling event profilingService.getProfilingDataProducer(TEST_PROFILING_TYPE).event(data);

Since:

1.0

See Also:

ProfilingDataProducer, ProfilingEventType

Method Summary

Modifier and Type	Method and Description
<T extends ProfilingEventContext,S> ProfilingDataProducer<T,S>	getProfilingDataProducer(ProfilingEventType<T> profilingEventType) Returns a previously registered ProfilingDataProducer that can be used to emit profiling events of a certain ProfilingEventType.
<T extends ProfilingEventContext,S> ProfilingDataProducer<T,S>	getProfilingDataProducer(ProfilingEventType<T> profilingEventType, ProfilingProducerScope producerScope) Returns a previously registered ProfilingDataProducer that can be used to emit profiling events of a certain ProfilingEventType indicating the producer scope.
ThreadSnapshotCollector	getThreadSnapshotCollector() Returns a ThreadSnapshotCollector that can be used to collect information about threading.
<T extends ProfilingEventContext,S> void	registerProfilingDataProducer(ProfilingEventType<T> profilingEventType, ProfilingDataProducer<T,S> profilingDataProducer) Registers a ProfilingDataProducer that can be obtained to emit profiling events of a certain ProfilingEventType.

Method Detail

getProfilingDataProducer

<T extends ProfilingEventContext,S> ProfilingDataProducer<T,S> getProfilingDataProducer(ProfilingEventType<T> profilingEventType)

Returns a previously registered ProfilingDataProducer that can be used to emit profiling events of a certain ProfilingEventType.

Parameters:

profilingEventType - the ProfilingEventType that will be emitted.

Returns:

the corresponding ProfilingDataProducer

getProfilingDataProducer

<T extends ProfilingEventContext,S> ProfilingDataProducer<T,S> getProfilingDataProducer(ProfilingEventType<T> profilingEventType,
                                                                                        ProfilingProducerScope producerScope)

Returns a previously registered ProfilingDataProducer that can be used to emit profiling events of a certain ProfilingEventType indicating the producer scope.

Parameters:

profilingEventType - the ProfilingEventType that the ProfilingDataProducer will emit

producerScope - the ProfilingProducerScope that will be bound to the the ProfilingDataProducer

Returns:

the corresponding ProfilingDataProducer

registerProfilingDataProducer

<T extends ProfilingEventContext,S> void registerProfilingDataProducer(ProfilingEventType<T> profilingEventType,
                                                                       ProfilingDataProducer<T,S> profilingDataProducer)

Registers a ProfilingDataProducer that can be obtained to emit profiling events of a certain ProfilingEventType.

Parameters:

profilingEventType - the ProfilingEventType that the ProfilingDataProducer will emit.

profilingDataProducer - the ProfilingDataProducer that will be registered.

getThreadSnapshotCollector

ThreadSnapshotCollector getThreadSnapshotCollector()

Returns a ThreadSnapshotCollector that can be used to collect information about threading.

Returns:

the ThreadSnapshotCollector.