IEventLogger¶

interface OCP\Diagnostics\IEventLogger¶

Interface IEventLogger

Implemented by:	`OC\Diagnostics\EventLogger`
Source:	lib/public/Diagnostics/IEventLogger.php#32

Methods¶

public OCP\Diagnostics\IEventLogger::start($id, $description)¶

Mark the start of an event setting its ID $id and providing event description $description.

Source:	lib/public/Diagnostics/IEventLogger.php#40
Parameters:	$id (string) $description (string)
Since:	8.0.0

public OCP\Diagnostics\IEventLogger::end($id)¶

Mark the end of an event with specific ID $id, marked by start() method.

Ending event should store \OCP\Diagnostics\IEvent to

be returned with getEvents() method.

Source:	lib/public/Diagnostics/IEventLogger.php#50
Parameters:	$id (string)
Since:	8.0.0

public OCP\Diagnostics\IEventLogger::log($id, $description, $start, $end)¶

Mark the start and the end of an event with specific ID $id and description $description,

explicitly marking start and end of the event, represented by $start and $end timestamps.

Logging event should store \OCP\Diagnostics\IEvent to

be returned with getEvents() method.

Source:	lib/public/Diagnostics/IEventLogger.php#64
Parameters:	$id (string) $description (string) $start (float) $end (float)
Since:	8.0.0

public OCP\Diagnostics\IEventLogger::getEvents()¶

This method should return all \OCP\Diagnostics\IEvent objects stored using

start()/end() or log() methods

Source:	lib/public/Diagnostics/IEventLogger.php#73
Returns:	`\OCP\Diagnostics\IEvent[]`
Since:	8.0.0

public OCP\Diagnostics\IEventLogger::activate()¶

Activate the module for the duration of the request. Deactivated module

does not create and store \OCP\Diagnostics\IEvent objects.

Only activated module should create and store objects to be

returned with getEvents() call.

Source:	lib/public/Diagnostics/IEventLogger.php#83
Since:	12.0.0