Package kieker.monitoring.core.controller

Class MonitoringController

java.lang.Object
kieker.monitoring.core.controller.AbstractController
kieker.monitoring.core.controller.MonitoringController
All Implemented Interfaces:
kieker.common.registry.IMonitoringRecordReceiver, IMonitoringController, IProbeController, IRemoteController, ISamplingController, IStateController, IStateListener, ITimeSourceController, IWriterController
public final class MonitoringController
extends AbstractController
implements IMonitoringController, IStateListener
Since:
1.3

  • Field Summary

    Fields inherited from class kieker.monitoring.core.controller.AbstractController

    monitoringController

  • Method Summary

    Modifier and Type Method Description
    boolean activateProbe​(java.lang.String pattern)
    Activates a probe.
    void addPatternParameter​(java.lang.String pattern, java.lang.String parameterName, java.util.List<java.lang.String> parameters)
    Adds or updates a parameter for the given pattern.
    void addPatternParameterValue​(java.lang.String pattern, java.lang.String name, java.lang.String value)
    Add one value to a list of parameter values for a pattern.
    void beforeEnableMonitoring()
    Triggers if the monitoring is guaranteed to be enabled, but has not yet been published to other threads.
    protected void cleanup()
    This method should clean up.
    void clearPatternParameters​(java.lang.String pattern)
    Deletes all parameters from the given pattern.
    static MonitoringController createInstance​(kieker.common.configuration.Configuration configuration)
    This is a factory method creating a new monitoring controller instance using the given configuration.
    boolean deactivateProbe​(java.lang.String pattern)
    Deactivates a probe.
    void deletePatternParameter​(java.lang.String pattern, java.lang.String parameterName)
    Deletes a parameter from the given pattern.
    boolean disableMonitoring()
    Disables monitoring.
    boolean enableMonitoring()
    Enables monitoring.
    java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getAllPatternParameters​(java.lang.String pattern)
    Looks up the parameters for a probe /the pattern of the probe and returns them, may be null.
    java.lang.String getApplicationName()
    This method returns the application name stored in the controller.
    java.lang.String getControllerDomain()  
    int getExperimentId()  
    java.lang.String getHostname()
    The hostname will be part of the monitoring data and allows to distinguish observations in cases where the software system is deployed on more than one host.
    static IMonitoringController getInstance()  
    java.lang.String getName()
    Returns the name of this controller.
    java.util.List<java.lang.String> getProbePatternList()
    Returns the current list of patterns with a prefix indicating whether the pattern is active or not.
    protected SamplingController getSamplingController()  
    ITimeSource getTimeSource()
    Returns the ITimeSource used in this controller.
    static java.lang.String getVersion()
    Return the version name of this controller instance.
    int incExperimentId()
    Increments the experiment ID by 1 and returns the new value.
    protected void init()
    This method should to the initialization work.
    boolean isDebug()
    Is the debug mode enabled?
    boolean isMonitoringEnabled()
    Returns whether monitoring is enabled or disabled/terminated.
    boolean isMonitoringTerminated()
    Returns whether monitoring is permanently terminated.
    boolean isProbeActivated​(java.lang.String signature)
    Tests if a probe is active.
    boolean newMonitoringRecord​(kieker.common.record.IMonitoringRecord record)
    Called for each new record to write it out to the pre-configured target (e.g., file system, database, or messaging queue).
    void removePatternParameterValue​(java.lang.String pattern, java.lang.String name, java.lang.String value)
    Remove one value to a list of parameter values for a pattern.
    boolean removeScheduledSampler​(ScheduledSamplerJob sampler)
    Stops future executions of the given periodic ScheduledSamplerJob .
    ScheduledSamplerJob schedulePeriodicSampler​(ISampler sampler, long initialDelay, long period, java.util.concurrent.TimeUnit timeUnit)
    Schedules the given ISampler with given initial delay, and period.
    boolean sendMetadataAsRecord()
    This method sends the meta data (like the controller and host name, the experiment ID, etc.) as a record.
    void setExperimentId​(int newExperimentID)
    Sets the experiment ID to the given value.
    void setProbePatternList​(java.util.List<java.lang.String> patternList)
    Overwrites the current list of patterns with a new pattern list.
    boolean terminateMonitoring()
    Permanently terminates monitoring.
    java.lang.String toString()
    This method is used to log the status of the controllers to the console.
    void waitForTermination​(long timeoutInMs)
    Waits for the termination of the monitoring controller.

    Methods inherited from class kieker.monitoring.core.controller.AbstractController

    createAndInitialize, isTerminated, setMonitoringController, terminate

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait