Logging 2 - Revision history

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

2021-07-14T13:22:53Z

Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:22, 14 July 2021
Line 210:		Line 210:

	In MDL-42894, a logging API comparison was done and it's results were promising.		In MDL-42894, a logging API comparison was done and it's results were promising.
	{\| class="~~nicetable~~"		{\| class="wikitable"
	\|-		\|-
	! Enabled Stores		! Enabled Stores

Stronk7 at 11:43, 6 April 2020

2020-04-06T11:43:44Z

← Older revision		Revision as of 11:43, 6 April 2020
Line 178:		Line 178:
	Each storage plugin with a writer interface is responsible for backlisting or filtering of events. Some of the examples of filtering that can done is as follows.		Each storage plugin with a writer interface is responsible for backlisting or filtering of events. Some of the examples of filtering that can done is as follows.
	* Include guests actions (default ''Yes'')		* Include guests actions (default ''Yes'')
	* Include log levels (default ''empty''), accepts constants from [[~~Event_2~~#Level_property]]		* Include log levels (default ''empty''), accepts constants from [[Events API#Level_property]]
	* Include by CRUD (default ''empty''), accepts C, R, U, and D		* Include by CRUD (default ''empty''), accepts C, R, U, and D
	* Include by component (default ''empty'')		* Include by component (default ''empty'')

Stronk7 at 11:28, 6 April 2020

2020-04-06T11:28:16Z

← Older revision		Revision as of 11:28, 6 April 2020
Line 47:		Line 47:
	= Logging =		= Logging =

	The new [[~~Event 2\|~~Events API]] introduced in Moodle 2.6 provides a notification mechanism and single collection point for actions within Moodle. The Events system also defines information about events that can be extended with additional information and functionality by core code and plugins, as needed.		The new [[Events API]] introduced in Moodle 2.6 provides a notification mechanism and single collection point for actions within Moodle. The Events system also defines information about events that can be extended with additional information and functionality by core code and plugins, as needed.

	In order to capture events a logging API was specified, consisting of a number of plugin types.		In order to capture events a logging API was specified, consisting of a number of plugin types.

Stronk7: /* See also */

2020-04-06T11:24:26Z

Dmonllao at 03:06, 25 May 2015

2015-05-25T03:06:04Z

← Older revision		Revision as of 03:06, 25 May 2015
Line 77:		Line 77:
	# A teacher opens an activity report.		# A teacher opens an activity report.
	# The activity report queries available log readers by using the current log manager (implementing \core\log\manager).		# The activity report queries available log readers by using the current log manager (implementing \core\log\manager).
	# If there is more than one log reader (implementing \core\log\~~sql_select_reader~~) available they can select the source of data for the report.		# If there is more than one log reader (implementing \core\log\sql_reader) available they can select the source of data for the report.
	# The report requests events from the log reader and displays them.		# The report requests events from the log reader and displays them.

Line 118:		Line 118:
	** public function get_description() - some help for admins.		** public function get_description() - some help for admins.
	** public function is_logging() - is latest data available?		** public function is_logging() - is latest data available?
	* '''interface \core\log\sql_select_reader''' extends \core\log\reader - general log storage that supports sql selects (or emulates them)		* '''interface \core\log\sql_reader (\core\log\sql_select_reader in Moodle 2.7 and Moodle 2.8)''' extends \core\log\reader - general log storage that supports sql selects (or emulates them)
	** public function get_events_select($selectwhere, array $params, $order, $limitfrom, $limitnum) - returns event object instances matching given parameters.		** public function get_events_select($selectwhere, array $params, $order, $limitfrom, $limitnum) - returns event object instances matching given parameters.
	** public function get_events_select_count($selectwhere, array $params) - returns number of events that would be returned from get_events() with the same parameters.		** public function get_events_select_count($selectwhere, array $params) - returns number of events that would be returned from get_events() with the same parameters.
Line 187:		Line 187:
	Defines:		Defines:

	class \logstore_database\log\store implements \core\log\~~sql_select_reader~~, \tool_log\log\writer;		// Note that in Moodle 2.7 and Moodle 2.8 \core\log\sql_select_reader was used instead of \core\log\sql_reader.
			class \logstore_database\log\store implements \core\log\sql_reader, \tool_log\log\writer;

	This log storage plugin is responsible for step 2 only from [[#Figure1\|Figure 1]] above. There will be no interface to read from it provided with Moodle core.		This log storage plugin is responsible for step 2 only from [[#Figure1\|Figure 1]] above. There will be no interface to read from it provided with Moodle core.
Line 195:		Line 196:
	Defines:		Defines:

	class \logstore_legacy\log\store implements \core\log\~~sql_select_reader~~, \tool_log\log\store;		// Note that in Moodle 2.7 and Moodle 2.8 \core\log\sql_select_reader was used instead of \core\log\sql_reader.
			class \logstore_legacy\log\store implements \core\log\sql_reader, \tool_log\log\store;

	This plugin will not conduct any log writing; it will translate existing {log} table data into the new event format and transforms new SQL selects to match the legacy table format. This serves as an emulation layer that allows new reports to access historical data stored in mdl_log table. Users will have to select this datasource manually if they want to see historical data that is not present in new log tables.		This plugin will not conduct any log writing; it will translate existing {log} table data into the new event format and transforms new SQL selects to match the legacy table format. This serves as an emulation layer that allows new reports to access historical data stored in mdl_log table. Users will have to select this datasource manually if they want to see historical data that is not present in new log tables.

Dmonllao at 03:00, 25 May 2015

2015-05-25T03:00:53Z

← Older revision		Revision as of 03:00, 25 May 2015
Line 129:		Line 129:
	*** ? and :named parameter placeholders		*** ? and :named parameter placeholders
	*** Use of anything besides the mentioned keywords/operators is strictly forbidden.		*** Use of anything besides the mentioned keywords/operators is strictly forbidden.
	* '''interface \core\log\sql_internal_reader''' extends \core\log\reader - log storage that can expose data as read-only database view or table.		* '''interface \core\log\sql_internal_table_reader (\core\log\sql_internal_reader in Moodle 2.7 and Moodle 2.8)''' extends \core\log\reader - log storage that can expose data as read-only database view or table.
	** public function get_internal_log_table_name() - returns database table or view; structure is described in phpdocs, it will include all columns defined by log_sql		** public function get_internal_log_table_name() - returns database table or view; structure is described in phpdocs, it will include all columns defined by log_sql

Line 165:		Line 165:

	Defines:		Defines:
			// Note than in Moodle 2.7 and Moodle 2.8 sql_internal_reader was used instead of sql_internal_table_reader.
	class \logstore_standard\log\store implements \core\log\~~sql_internal_reader~~, \tool_log\log\writer;		class \logstore_standard\log\store implements \core\log\sql_internal_table_reader, \tool_log\log\writer;

	The name logstore_standard does not seem to be optimal - ''logstore_db'' is not allowed because it collides with standard /db/ subdirectory in plugins and ''logstore_database'' should be probably reserved for external database logging (to prevent any confusion).		The name logstore_standard does not seem to be optimal - ''logstore_db'' is not allowed because it collides with standard /db/ subdirectory in plugins and ''logstore_database'' should be probably reserved for external database logging (to prevent any confusion).

Tbannister: Fixed tracker link.

2015-03-17T19:07:27Z

Fixed tracker link.

← Older revision		Revision as of 19:07, 17 March 2015
Line 207:		Line 207:
	Running new and old event logging at the same time with result in twice the number of DB inserts. It is therefore recommended to disable the old logging as soon as possible.		Running new and old event logging at the same time with result in twice the number of DB inserts. It is therefore recommended to disable the old logging as soon as possible.

	In ~~[https://tracker.moodle.org/browse/~~MDL-42894 ~~MDL-42894]~~, a logging API comparison was done and it's results were promising.		In MDL-42894, a logging API comparison was done and it's results were promising.
	{\| class="nicetable"		{\| class="nicetable"
	\|-		\|-

Raymor: /* Benefits of the new logging system */

2014-08-18T21:48:18Z

Benefits of the new logging system

← Older revision		Revision as of 21:48, 18 August 2014
Line 9:		Line 9:
	= Benefits of the new logging system =		= Benefits of the new logging system =
	A few benefits of the new logging system are:		A few benefits of the new logging system are:
	* it allows ~~capturer~~ of richer information from Moodle about actions;		* it allows capture of richer information from Moodle about actions;
	* it provides control over how much information is logged;		* it provides control over how much information is logged;
	* it abstracts log writing and reading so logging can be scaled;		* it abstracts log writing and reading so logging can be scaled;

Deraadt: Improving the grammar a bit.

2014-04-30T07:41:49Z

Improving the grammar a bit.

Show changes

Ankitfrenz: /* Mockups */

2014-04-29T02:08:29Z

Mockups

← Older revision		Revision as of 02:08, 29 April 2014
Line 255:		Line 255:
	--[[User:Rajesh Taneja\|Rajesh Taneja]] ([[User talk:Rajesh Taneja\|talk]]) 16:19, 14 February 2014 (WST)		--[[User:Rajesh Taneja\|Rajesh Taneja]] ([[User talk:Rajesh Taneja\|talk]]) 16:19, 14 February 2014 (WST)

	== ~~Mockups~~ ==		== Screenshots ==
	=== Log management page ===		=== Log management page ===
	[[File:event-observer.png \|frame\|center\| Log management page]]		[[File:event-observer.png \|frame\|center\| Log management page]]

← Older revision		Revision as of 11:24, 6 April 2020
Line 331:		Line 331:
	=See also=		=See also=

	* [[~~Event 2~~]]		* [[Events API]]
	* [[Migrating logging calls in plugins]]		* [[Migrating logging calls in plugins]]
	* [[Migrating reports accessing logs]]		* [[Migrating reports accessing logs]]