system.mes.monitor.start

Sepasoft MES Module Suite

Description

Start (or create and start) a timer within the MES Monitor component. Metrics can be reset and collected for the purpose of measuring server loading and software performance over the timer duration. Use the method .end() on the returned Timer object to stop the timer.

Syntax

system.mes.monitor.start(name)

Parameters

String name - The name to identify this metric by. Using '\' in the name creates subfolders in the Tag structure. Note: give the system a minute to update the folder structure before refreshing.

Returns

timer - Timer object. Use .end() to stop the timer.

Scope

All

Object Functions

The following methods use the Timer object.

end()

Description

Records the time difference between the current time and when the timer was started and logs the duration to Monitoring.

Syntax

end()

Parameters

None

Returns

None

Scope

All

addException()

Description

Adds an exception to the timer metric.

Syntax

addException(e)

Parameters

Exception e - The exception to add to the timer metric.

Returns

None

Scope

All

Code Examples

Code Snippet

Copy Code

Code

import java.lang.Exception

timer = system.mes.monitor.start("doWorkScript")

try:
    doWork()
except Exception, e:
    timer.addException(java.lang.Exception('%s' % e))
finally:
    timer.end()

Sepasoft MES Module Suite