diff options
Diffstat (limited to 'lib/public/Diagnostics')
| -rw-r--r-- | lib/public/Diagnostics/IEventLogger.php | 25 | ||||
| -rw-r--r-- | lib/public/Diagnostics/IQuery.php | 5 | ||||
| -rw-r--r-- | lib/public/Diagnostics/IQueryLogger.php | 21 |
3 files changed, 49 insertions, 2 deletions
diff --git a/lib/public/Diagnostics/IEventLogger.php b/lib/public/Diagnostics/IEventLogger.php index 517a131d436..c76e96c5674 100644 --- a/lib/public/Diagnostics/IEventLogger.php +++ b/lib/public/Diagnostics/IEventLogger.php @@ -4,6 +4,7 @@ * * @author Morris Jobke <hey@morrisjobke.de> * @author Robin Appelman <robin@icewind.nl> + * @author Piotr Mrowczynski <piotr@owncloud.com> * * @license AGPL-3.0 * @@ -31,7 +32,7 @@ namespace OCP\Diagnostics; */ interface IEventLogger { /** - * Mark the start of an event + * Mark the start of an event setting its ID $id and providing event description $description. * * @param string $id * @param string $description @@ -40,7 +41,9 @@ interface IEventLogger { public function start($id, $description); /** - * Mark the end of an event + * 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. * * @param string $id * @since 8.0.0 @@ -48,6 +51,11 @@ interface IEventLogger { public function end($id); /** + * 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. + * * @param string $id * @param string $description * @param float $start @@ -57,8 +65,21 @@ interface IEventLogger { public function log($id, $description, $start, $end); /** + * This method should return all \OCP\Diagnostics\IEvent objects stored using + * start()/end() or log() methods + * * @return \OCP\Diagnostics\IEvent[] * @since 8.0.0 */ public function getEvents(); + + /** + * 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. + * + * @since 12.0.0 + */ + public function activate(); } diff --git a/lib/public/Diagnostics/IQuery.php b/lib/public/Diagnostics/IQuery.php index 7f26bd7f1b8..ceaee191b39 100644 --- a/lib/public/Diagnostics/IQuery.php +++ b/lib/public/Diagnostics/IQuery.php @@ -59,4 +59,9 @@ interface IQuery { * @since 11.0.0 */ public function getStacktrace(); + /** + * @return array + * @since 12.0.0 + */ + public function getStart(); } diff --git a/lib/public/Diagnostics/IQueryLogger.php b/lib/public/Diagnostics/IQueryLogger.php index 58ea78795e2..32723a56cb9 100644 --- a/lib/public/Diagnostics/IQueryLogger.php +++ b/lib/public/Diagnostics/IQueryLogger.php @@ -4,6 +4,7 @@ * * @author Morris Jobke <hey@morrisjobke.de> * @author Robin Appelman <robin@icewind.nl> + * @author Piotr Mrowczynski <piotr@owncloud.com> * * @license AGPL-3.0 * @@ -33,6 +34,10 @@ use Doctrine\DBAL\Logging\SQLLogger; */ interface IQueryLogger extends SQLLogger { /** + * Mark the start of a query providing query SQL statement, its parameters and types. + * This method should be called as close to the DB as possible and after + * query is finished finalized with stopQuery() method. + * * @param string $sql * @param array $params * @param array $types @@ -41,14 +46,30 @@ interface IQueryLogger extends SQLLogger { public function startQuery($sql, array $params = null, array $types = null); /** + * Mark the end of the current active query. Ending query should store \OCP\Diagnostics\IQuery to + * be returned with getQueries() method. + * * @return mixed * @since 8.0.0 */ public function stopQuery(); /** + * This method should return all \OCP\Diagnostics\IQuery objects stored using + * startQuery()/stopQuery() methods. + * * @return \OCP\Diagnostics\IQuery[] * @since 8.0.0 */ public function getQueries(); + + /** + * Activate the module for the duration of the request. Deactivated module + * does not create and store \OCP\Diagnostics\IQuery objects. + * Only activated module should create and store objects to be + * returned with getQueries() call. + * + * @since 12.0.0 + */ + public function activate(); } |