Logging: Difference between revisions

Latest revision as of 07:26, 3 April 2023

When users interact with Moodle, many of their interactions are logged using the Events subsystem. This subsystem includes a powerful, and granular, logging mechanism which allows the collection of relevant information.

The Moodle core logs common interactions, and most activities also include granular logging of student progress through the activity.

Examples of log entries include:

logging in or out
accessing a course
updating a course
viewing an activity within a course
viewing a forum discussion
creating a new forum discussion
replying to an existing post in a forum discussion
completing an activity

Log stores

When an event is logged, it can be sent to zero, or more log stores. A log store is simply a data warehouse for the log entries.

Moodle comes includes with three log stores:

Standard
External database

Your site administrator can choose which log stores are enabled, and in which order, from Administration > Site administration > Plugins > Logging > Manage log stores.

Note: A new Moodle site will have Standard logging enabled and Legacy logging disabled. A site which has been upgraded will have both enabled.

The default Standard log is very detailed and should meet most requirements.

The "Write buffer size" is the number of log entries inserted in one batch database operation, which improves performance.

From Site administration > Plugins > Reports > Manage reports, the administrator can see which log stores support which given report:

External log store

An External database log store also allows you to connect to an external log database. This uses the same logging format as the Standard log store, but allows you to send logs to a different database. It can still be queried from within the Moodle User Interface, and is sometimes preferable on busy sites where many logs are created.

Legacy log store

The Legacy log store was disabled in 4.1.

Analytics

Moodle also has a powerful Analytics engine, which uses Machine Learning to predict and warn of potential student outcomes. Many of these predictions are based upon the logs that are generated and stored by Moodle.

Please note that some Log Store plugins are write-only and cannot be used for this purpose. Both the Standard logstore, and the External logstore included with Moodle are compatible with the Moodle Analytics features.

@@ Line 1: / Line 1: @@
-{{New features}}
+When users interact with Moodle, many of their interactions are logged using the Events subsystem. This subsystem includes a powerful, and granular, logging mechanism which allows the collection of relevant information.
-The site administrator can define which log stores are available, and in which order, from ''Administration>Site administration>Plugins>Logging>Manage log stores.''
-Available stores are: Standard, Legacy and External database.
+The Moodle core logs common interactions, and most activities also include granular logging of student progress through the activity.
+Examples of log entries include:
+* logging in or out
+* accessing a course
+* updating a course
+* viewing an activity within a course
+* viewing a forum discussion
+* creating a new forum discussion
+* replying to an existing post in a forum discussion
+* completing an activity
+== Log stores ==
+When an event is logged, it can be sent to zero, or more log stores. A log store is simply a data warehouse for the log entries.
+Moodle comes includes with three log stores:
+* Standard
+* External database
+Your site administrator can choose which log stores are enabled, and in which order, from ''Administration > Site administration > Plugins > Logging > Manage log stores.''
 ''Note:'' A new Moodle site will have Standard logging enabled and Legacy logging disabled. A site which has been upgraded will have both enabled.
-The default Standard log is very detailed and should meet most requirements. The Legacy log should be disabled unless you have old custom reports that need it. An External database log store also allows you to connect to an external log database.
+The default Standard log is very detailed and should meet most requirements.
-[[File:logstores.png]]
+The "Write buffer size" is the number of log entries inserted in one batch database operation, which improves performance.
-From ''Site administration>Plugins>Reports>Manage reports'', the administrator can see which  log stores support which given report:
+[[File:42logstores.png]]
+From ''Site administration > Plugins > Reports > Manage reports'', the administrator can see which log stores support which given report:
 [[File:reportslogstore.png]]
+=== External log store ===
+An External database log store also allows you to connect to an external log database. This uses the same logging format as the Standard log store, but allows you to send logs to a different database. It can still be queried from within the Moodle User Interface, and is sometimes preferable on busy sites where many logs are created.
+=== Legacy log store ===
+The Legacy log store was disabled in 4.1.
+== Analytics ==
+Moodle also has a powerful [[Analytics]] engine, which uses Machine Learning to predict and warn of potential student outcomes. Many of these predictions are based upon the logs that are generated and stored by Moodle.
+Please note that some Log Store plugins are write-only and ''cannot'' be used for this purpose. Both the Standard logstore, and the External logstore included with Moodle ''are'' compatible with the Moodle Analytics features.
 ==See also==
 * [[Logs]]
+* [[Events list report]]
 * [[:dev:Event_2 | Developer documentation on Events (giving examples of levels)]]
+* [https://moodle.org/plugins/browse.php?list=category&id=54 Log storage plugins]
 [[Category:Site administration]]
 [[es:Usar bitácoras]]
+[[de:Logging]]

Documentation