Technical documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{indexmenu_n>1}}

===== User logs =====

All actions within netYCE are logged to offer an audit trail. These are actions performed by the users and of some of the back-end functions (e.g. tftp server). User actions like the editing of variables are logged extensively as are the additions and deletes. The actions performed by the (scheduled) Jobs are not included in this log although the submission of these jobs by the users are. The Job execution results have their own log, the Job Logs.

The user action Log can accessed from the '**Operate - Logs**' or from '**Admin - Logs**' menus. The 'Change Logs' form shows the historical Logs in pages of 100 entries, the most recent at the top.

By default the logs are filtered for the entries of the current user (or ''**Operator**''), but can be modified to any other known user or for ''-- All --'' users. New Log entries inserted while the form is open are __not__ shown.


{{:menu:admin:action_logs:user_logs_grid.png|1000}}

Three categories of Filters can be used search logs. The ''**Action**'' column defines the type of action performed, the ''**Name**'' column the relevant object name or names (e.g. site name or node name). The most detail is available in the ''**Message**'' column, although only the first line of the message is displayed. when using a ''Message'' filter, the entire message is searched.

The filter strings support wildcard searches but will rarely be needed since the entered string will be treated as a case insensitive substring. To use wildcards, use the SQL characters ''**%**'' and ''**_**'' for 'none or several characters' (like '*') and 'one character' (like '?') respectively. When using multiple filters, the resulting logs will meet all criteria.

Using the date filter, results can now be sorted both by month, and by day in order to narrow down the searches.

==== Log Details ====

The Log Details are opened by double clicking any Log entry. Many logs offer additional details using multiple lines in the message. If the operator has sufficient access rights, these are displayed in the Log Details.

The kind of details available differ per message type. For the logs resulting from editing variables in the various forms, the next format is used:
  o 1st line = "Updated <object> (<table>)"
  o 2nd line = "Keys: <key> = <value>, <key> = <value>, ..."
  o 3rd line = ""
  o 4th line = <variable>:
  o 5th line = "  <old-value> => <new-value>
  o remaining lines as #4, #5 for other changed variables

When the variable contains a multiline value, the 5th line is replaced by a more elaborate section that consists of the **diff** (formatted differences) between the old and new values followed by the full new value. Various lines with ''--- ---'' are used for demarcation of the sections.

{{:menu:admin:action_logs:log_details.png|1000}}


===== Job logs =====
The logs of specific command jobs can be found in the operate section under Operate -> Jobs -> Job logs.
When clicking on the link in the lower right corner of each row, the job details will be displayed in a separate window.