Adjust query/event logging code in favour of more complex owncloud/diagnostics (#27643)

* Adjust query/event logging code in favour of more complex owncloud/diagnostics
* Add descriptions to IQueryLogger and IEventLogger interfaces

3 files changed, 57 insertions, 2 deletions

diff --git a/lib/public/Diagnostics/IEventLogger.php b/lib/public/Diagnostics/IEventLogger.php
index 517a131d436..4c2ae9e3b2c 100644
--- a/lib/public/Diagnostics/IEventLogger.php
+++ b/lib/public/Diagnostics/IEventLogger.php
@@ -3,7 +3,12 @@
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
  * @author Morris Jobke <hey@morrisjobke.de>
+<<<<<<< HEAD
  * @author Robin Appelman <robin@icewind.nl>
+=======
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Piotr Mrowczynski <piotr@owncloud.com>
+>>>>>>> a5095447b7... Adjust query/event logging code in favour of more complex owncloud/diagnostics (#27643)
  *
  * @license AGPL-3.0
  *
@@ -31,7 +36,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 +45,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 +55,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 +69,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..3ab491a2751 100644
--- a/lib/public/Diagnostics/IQueryLogger.php
+++ b/lib/public/Diagnostics/IQueryLogger.php
@@ -3,7 +3,12 @@
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
  * @author Morris Jobke <hey@morrisjobke.de>
+<<<<<<< HEAD
  * @author Robin Appelman <robin@icewind.nl>
+=======
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Piotr Mrowczynski <piotr@owncloud.com>
+>>>>>>> a5095447b7... Adjust query/event logging code in favour of more complex owncloud/diagnostics (#27643)
  *
  * @license AGPL-3.0
  *
@@ -33,6 +38,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 +50,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();
 }