net.anotheria.moskito.webui.tracers.api

Interface TracerAPI

All Superinterfaces:

net.anotheria.anoplass.api.API, net.anotheria.anoprise.metafactory.Service

All Known Implementing Classes:

RemoteTracerAPIStub, TracerAPIImpl

@DistributeMe(agentsSupport=false,
              moskitoSupport=false)
 @SupportService
 @FailBy(strategyClass=org.distributeme.core.failing.RetryCallOnce.class)
public interface TracerAPI
extends net.anotheria.anoplass.api.API, net.anotheria.anoprise.metafactory.Service

API for tracing. Tracing is ability of a Monitoring Point to trace all calls that passes through. This is useful if you want to find out who is using a method. Tracing is performed by tracers. One tracer represents a monitoring point (producer). A tracer is always referenced by the producer id of its producer.

Since:

05.05.15 00:42

Author:

lrosenberg

Method Summary

Modifier and Type	Method and Description
void	createTracer(java.lang.String producerId) Creates a new tracer for given producer id.
void	disableTracer(java.lang.String producerId) Temporarly disables a tracer.
void	enableTracer(java.lang.String producerId) Reenables a previously disabled tracer or creates a new tracer, if there were no tracer for this producer id.
TracerAO	getTracer(java.lang.String producerId) Returns a tracer by a producer id of the associated producer if such a tracer exists.
java.util.List<TracerAO>	getTracers() Returns registered tracers.
java.util.List<TraceAO>	getTraces(java.lang.String producerId, TimeUnit timeUnit) Returns traces that have been recorded by the tracer associated with the producer id.
void	removeTracer(java.lang.String producerId) Removes a tracer by producer id.

Methods inherited from interface net.anotheria.anoplass.api.API

deInit, init

Method Detail

getTracers

java.util.List<TracerAO> getTracers()
                             throws net.anotheria.anoplass.api.APIException

Returns registered tracers.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getTracer

TracerAO getTracer(java.lang.String producerId)
            throws net.anotheria.anoplass.api.APIException

Returns a tracer by a producer id of the associated producer if such a tracer exists.

Parameters:

producerId -

Returns:

Throws:

net.anotheria.anoplass.api.APIException

getTraces

java.util.List<TraceAO> getTraces(java.lang.String producerId,
                                  TimeUnit timeUnit)
                           throws net.anotheria.anoplass.api.APIException

Returns traces that have been recorded by the tracer associated with the producer id.

Parameters:

producerId - id of the producer.

timeUnit - timeunit for the calculation of duration. The duration is measured in nanoseconds and should be recalculated.

Returns:

Throws:

net.anotheria.anoplass.api.APIException

createTracer

void createTracer(java.lang.String producerId)
           throws net.anotheria.anoplass.api.APIException

Creates a new tracer for given producer id. If such a producer doesn't exists yet, no harm will be done. The tracer will be active but won't be able to collect anything. The tracer will cost no performance.

Parameters:

producerId - id of the producer the tracer should be associated with.

Throws:

net.anotheria.anoplass.api.APIException

removeTracer

void removeTracer(java.lang.String producerId)
           throws net.anotheria.anoplass.api.APIException

Removes a tracer by producer id.

Parameters:

producerId - id of the producer the tracer is associated with.

Throws:

net.anotheria.anoplass.api.APIException

disableTracer

void disableTracer(java.lang.String producerId)
            throws net.anotheria.anoplass.api.APIException

Temporarly disables a tracer.

Parameters:

producerId - id of the producer the tracer is associated with.

Throws:

net.anotheria.anoplass.api.APIException

enableTracer

void enableTracer(java.lang.String producerId)
           throws net.anotheria.anoplass.api.APIException

Reenables a previously disabled tracer or creates a new tracer, if there were no tracer for this producer id.

Parameters:

producerId - id of the producer the tracer is associated with.

Throws:

net.anotheria.anoplass.api.APIException