Manual: Settings-Auditing

Feature=Audit records a Date+Time based recording of significant events, database updates, and similar activities that occur while a RidgeStar website is operating. The individual Audit entries will be retained for review using Administrator: Manage-Audit until their Expiration Date+Time is reached.

The retention period for an Audit entry is dynamically computed when it is stored according to the specification in Setting=Auditing. The Setting is made up of 1 to nn entries that specify a series of conditions that will be used in a "First Fit" scheme to determine the applicable Expires Date+Time.

Setting=Auditing is stored as a standard JSON string, which can range from very simple to quite complex. For complex specifications, RidgeStar does offer a configuration aid that may be active on your site as Administrator: Configure-Auditing.

Setting Options

Each entry in Setting=Auditing can contain a Regular Expression for each of the Audit fields, which are:

Class

Specifies the general grouping associated with the Audit entry.

Valid Class values are: Assignment, Broadcast, DBAdd, DBDelete, DBReplace, DBUpdate, Download, Email, File, Hacking, Logoff, Logon, Mail, MatchReport, and SQL, as describe at Manual: Settings-Audit.

Event

Represents the specific action or recording of activity that represents the Audit entry

Keep

Specifies the length of time (Interval) that will be used to compute the Expiration date+time of the Audit Entry. The specification MUST conform with the syntax required by MariaDB Date and Time Units.

IP

The IP Address associated with the requestor associated with the Audit entry

Item

A specific record number within a Table.

Page

The PageName associated with the operational page that is associated the Audit entry.

Table

The MariaDB Database table name associated with the Audit entry

URL

The URL identifying the specific page on the website associated with the Audit entry.

User

The specific User Key (relative to the website the Audit is active in) associated with the Audit entry

Examples

By way of example, consider:

[{"Keep":"6 month"}]

This example (which IS the default) indicates that all Audit entries will be retained for 6 months from the Date+Time it was created.

[{"Class":"Logon|Logoff","Keep":"6 week"},{"Keep":"6 month"}]

This example will Keep Audit entries in the Class of Logon or Logoff for 6 weeks and all other Audit entries for 6 months .

[{"Page":"Profile|Users","Keep":"1 year"},{"Keep":"4 month"}]

This example will Keep Audit entries from any Page containing "Profile" or "Users" in the PageName for a full year and all other Audit entries for 4 months .

Complexity

Note that the syntax required for the Setting is quite cryptic and MUST be coded properly.

If you have any questions or concerns about coding this, RidgeStar recommends you contact your Account Representative or use Administrator: Configure-Auditing to handle the encoding of the JSON string properly.