\OCP\DiagnosticsIEventLogger

Interface IEventLogger

Summary

Methods
Constants
start()
end()
log()
getEvents()
activate()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

start()

start(string  $id, string  $description) 

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

Parameters

string $id
string $description

end()

end(string  $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.

Parameters

string $id

log()

log(string  $id, string  $description, float  $start, float  $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.

Parameters

string $id
string $description
float $start
float $end

getEvents()

getEvents() : array<mixed,\OCP\Diagnostics\IEvent>

This method should return all \OCP\Diagnostics\IEvent objects stored using start()/end() or log() methods

Returns

array<mixed,\OCP\Diagnostics\IEvent>

activate()

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.