Logging
Published:
24 Nov 2014, last updated 24 Nov 2014 15:12
Introduction
Camino incorporates a standard logging functionality that is used by all components, modules and functionality. The purpose of logging within Camino is provide an accurate record of actions performed, either by users or automatic functionality and, where applicable, maintain a suitable audit trail.
What actions or events are logged?
By default, Camino will automatically log important events like user logins, changes of settings and system errors. These important, or core events include:
- Successful logins
- Failed logins
- Settings Saved
- Sitemap Generation
- Sitemap Pinging
With Camino modules, the scope of what is logged or not depends on individual modules. Audit critical modules like Market record a large number of actions. Content orientated modules like Pages and Blogs tend only to record core actions like content creation, updating and settings updates.
What data is recorded?
A log entry does not only serve to simply record that an event occurred. It also contains information about the event, where it occurred and who or what caused the log entry to be created.
| Property Name |
Required |
Notes |
| Source |
Y |
The identity of the functionality that created the log entry. In most cases, this will be a module identity. |
| Code |
Y |
The unique code that identifies the log entry. |
| ReferenceId |
N |
An Id used to identify a specific object in the database. For example, if the log entry pertains to a content item, the value will the item's Id. |
| UserId |
Y |
The Id of the user account that was active when the |
| IpAddress |
Y |
The IP address - either IPv4 or IPv6 - of the client. |
| Data |
N |
Optional information container for log entries. This may contain additional information pertaining to the log entry. For example, for a failed login this will contain the username that was entered. |
| Location |
Y |
The webform, handler or control that |
| Recorded |
Y |
The server's date and time when the log entry was created. |
Log Entry Life
As of Camino 0.9, log entries are automatically deleted once they reach a certain age. By default, this is 30 days, but a value between 7 and 120 days may be configured through Camino Control Panel Settings.
Although it is tempting to keep log entries indefinitely, this can have a detrimental affect on database size. Left unmaintained, the log entries table can go into tens of thousands of rows.
The deletion or cleaning of expired log entries takes place daily and is triggered by a scheduled task. Typically, this task runs at 01:00.
Technical Information
The underlying logging functionality is powered by the CalzadaMedia.Perception library. Consequently, most improvements, additions and bug fixes and additions are recorded against that project, not Camino.