org.mule.runtime.api.profiling

Interface ProfilingDataProducer<T extends ProfilingEventContext,S>

Type Parameters:

T - the class that encapsulates the data for the profiling event context.

S - the class of the source object from which the profiling event context is created.

@Experimental
public interface ProfilingDataProducer<T extends ProfilingEventContext,S>

A producer of profiling data represented by a ProfilingEventContext.

A ProfilingDataProducer must be firstly registered via ProfilingService.registerProfilingDataProducer(ProfilingEventType, ProfilingDataProducer) and then can be obtained via ProfilingService.getProfilingDataProducer(ProfilingEventType). Once it is obtained, it can be used to emit profiling data by invoking triggerProfilingEvent(ProfilingEventContext).

Since:

1.0

See Also:

ProfilingService

Method Summary

Modifier and Type	Method and Description
void	triggerProfilingEvent(S sourceData, Function<S,T> transformation) Triggers a profiling event.
void	triggerProfilingEvent(T profilerEventContext) Triggers a profiling event.

Method Detail

triggerProfilingEvent

void triggerProfilingEvent(T profilerEventContext)

Triggers a profiling event. Implementations must either be stateless or designed to support concurrent invocations.

Parameters:

profilerEventContext - the ProfilingEventContext for the emitted event.

triggerProfilingEvent

void triggerProfilingEvent(S sourceData,
                           Function<S,T> transformation)

Triggers a profiling event. The profiling event context will be the result of applying the transformation to sourceData. The profiling event context is responsible for applying this transformation if the ProfilingEventContext is needed. It may not need to produce nor generate the data. The ProfilingDataProducer implementation will be responsible to decide this.

Parameters:

sourceData - object to transform.

transformation - transformation to apply to generate the ProfilingEventContext.