Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
# Overview about all processes executed on your server<pre># Tracing of any errors thrown by BaseX01:31:51.888 127.0.0.1:4803 admin REQUEST [GET] http://localhost:8984/rest/factbook# Tracing of wrong modified data01:31:51.892 127.0.0.1:4803 admin 200 4.43 ms# Tracing of all specific user processes# Tracing of time specific processes</pre>
The server logs are written in plain-text and can be opened with any editor.Furthermore there are well structured to give you a perfect overview about An admin user has accessed the processes.In your <code>factbook</code> database folder you can find a folder named '.logs' where all log files arestored with the belonging datevia REST.
→Changelog
This article is part of the [[Advanced User's Guide]]. It describes how client operations are logged by the server.
The server logs can e.g. be used to get an overview of all processes executed on your server, trace any errors
or compile performance statistics.
==Introduction==
The server logs give are written in plain text. In your [[Configuration#Database Directory|Database Directory]], you can find a folder named <code>.logs</code> in which all log files are stored with the according date. Note that, depending on your OS and configuration, files and folders beinning with a <code>.</code> may be hidden. The log directory can be changed via the {{Option|LOGPATH}} option. Some more notes on the logging facility: * HTTP requests are included in the log files.* Logging can be turned on/off via the [[Options#LOG|LOG]] option.* The maximum length of logging messages can be changed via [[Options#LOGMSGMAXLEN|LOGMSGMAXLEN]].* The [[Admin Module]] provides access to the log files from XQuery. ==RESTXQ== {{Mark|Introduced with 8.6:}} Non-trivial web applications provide the ability for users to sign in and out. User handling can be realized with session attributes (see e. g. the [[DBA]] code). By default, RESTXQ code is run with admin permissions. However, as it is more interesting to know which user has called a function, the RESTXQ user string (which is {{Code|admin}} by default, and which will show up in the log data) will be overwritten by the value of an {{Code|id}} session attribute. If the request path includes {{Code|/dba/}}, the {{Code|dba}} session attribute will be assigned. If the following advantagesfunction is called more than once, {{Code|joe}} will appear as user in the second and subsequent log entries: <pre class="brush:xquery">import module namespace Session = 'http://basex.org/modules/session';declare %rest:path('/session-id') function local:f() { Session:set('id', 'joe'), 'I am Joe'};</pre> ==Format== ; Example 1: <pre>01:18:12.892 SERVER admin OK Server was started (port: 1984)01:18:15.436 127.0.0.1:4722 jack REQUEST XQUERY for $i in 1 to 5 return random:double()01:18:15.446 127.0.0.1:4722 jack OK Query executed in 2.38 ms. 2.72 ms01:18:15.447 127.0.0.1:4722 jack REQUEST EXIT01:18:15.447 127.0.0.1:4722 jack OK 0.39 ms</pre> A server has been started and a user <code>jack</code> has connected to the server to perform a query and exit properly. ; Example 2: <pre>01:23:33.251 127.0.0.1:4736 john OK QUERY[0] 'hi' 0.44 ms01:23:33.337 127.0.0.1:4736 john OK ITER[0] 1.14 ms01:23:33.338 127.0.0.1:4736 john OK INFO[0] 0.36 ms01:23:33.339 127.0.0.1:4736 john OK CLOSE[0] 0.21 ms01:23:33.359 127.0.0.1:4736 john REQUEST EXIT01:23:33.359 127.0.0.1:4736 john OK 0.14 ms</pre> A user <code>john</code> has performed an iterative query, using one of the client APIs. ; Example 3:
==Format of the Logs=Changelog=
;Example:Version 8.6* Added: <pre>16:00:00The log directory can be changed with the {{Option|LOGPATH}} option.094 [127.0.0.1:3920] LOGIN admin OK 16:00:00.104 [127.0.0.1* Updated:3920] XQUERY 1 to 10 OK 12Include session attributes in log data.36 ms 16:00:00.114 [127.0.0.1:3920] LOGOUT admin OK</pre>
