com.apama.sor.utils
Event LatencyLogger


Event helper to allow the logging of latency monitoring information to file.
Since:
CMF 2.1.0

Import summary
 TimeFormatPlugintimeFormat
 
Member summary
 com.apama.correlator.LogginglatencyLog
 wildcard stringname
 wildcard stringlatencyType
 wildcard stringprepender
 com.apama.sor.Constantsconstants
 
Action summary
 stringDEFAULT_TEMPLATE(string directory)
 voiddoLatencyLog(float startTime, float endTime)

Perform a latency log entry.
 voidinitialise(string name, string directory, string latencyType)

Initialise the audit event helper. Invocation of this action causes creation of the import logging plugin.
 voidsetPrepender(string prepender)

Allows setting of the pre-pender before or after initialisation.
 
Import detail

timeFormat

            TimeFormatPlugin timeFormat
        

Member detail

constants

            com.apama.sor.Constants constants
        

latencyLog

            com.apama.correlator.Logging latencyLog
        

latencyType

            wildcard string latencyType
        

name

            wildcard string name
        

prepender

            wildcard string prepender
        

Action detail

DEFAULT_TEMPLATE

            string DEFAULT_TEMPLATE(string directory)
        
Parameters:
directory

doLatencyLog

            void doLatencyLog(float startTime, float endTime)
        
Perform a latency log entry.
Parameters:
startTime - The start time to log
endTime - The end time to log

initialise

            void initialise(string name, string directory, string latencyType)
        
Initialise the audit event helper. Invocation of this action causes creation of the import logging plugin.
Parameters:
name - The logical name of the instance used in construction of the logfile name
directory - The directory path in which to create the Latency log file
latencyType - A user-defined string used to group types of latency

setPrepender

            void setPrepender(string prepender)
        
Allows setting of the pre-pender before or after initialisation.
Parameters:
prepender - The string prepender to use