X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Flog.xml;h=83266d63a67e876d3e63c26a7091c419a569011d;hb=915efbba95f2a46ef5abf35e8fe85f2d0d0567ea;hp=69a8c8c5002a7f324fde7d9a95ff268b43f57407;hpb=9960226abe1700d3dc87e68529755e5cff09f0d9;p=metaproxy-moved-to-github.git diff --git a/doc/log.xml b/doc/log.xml index 69a8c8c..83266d6 100644 --- a/doc/log.xml +++ b/doc/log.xml @@ -1,16 +1,20 @@ - - - %common; + + %idcommon; ]> - - + + + Metaproxy + Index Data + + log 3mp - Metaproxy Module - + Metaproxy Module + log @@ -21,6 +25,273 @@ This filter logs packages sent - and received . + + + Configurable values: + + message + + + Specifies a custom message for the log message. + + + + filename + + + Specifies a name of log file. + + + + category + + + Specifies the category of messages to be logged. The category is an + XML attribute and value of attribute is a boolean; + true for enabled; false + for disabled. + The following category attributes are supported: + + + access + + + One line log messages inspired by Apache access log entries. + This is a brief message stating the request and response. + This is enabled by default. All other categories are disabled by + default. See the section ACCESS LOG. + + + + user-access + + + One line log messages similar to access but + with the authenticated user on each log line. + + + + request-apdu + + + Z39.50 Request APDU. + + + + response-apdu + + + Z39.50 Response APDU. + + + + apdu + + + Z39.50 APDU (request and response) + + + + request-session + + + Request session. + + + + response-session + + + Response session. + + + + session + + + Session (request and response) + + + + init-options + + + Z39.50 Init Request options + + + + + + + + + + + + + The access log + + The access is is strictly one line per entry and aims for + easy mangling with tools such as awk, grep, perl etc. + Many values may be omitted in the packages in which case a single + dash is printed instead. This is to ensure that all values have + well-defined position. + + + The basic format and order is + + time (position 1) + + Full time of event + + + + + Custom message (position 2) + + The string as given in element message. + + + + + IP (position 3) + + IP address of origin (peer) + + + If category user-acesss is used the + user is written on position 3 and the IP is written on position 4. + + + + + session (position 4) + + Session ID. Can be used to identify a particular Z39.50 session. + For HTTP this session ID only tracks the HTTP socket (kept alive). + NOT to be confused the the HTTP cookie mechanism. + + + + + elapsed (position 5) + + Elapsed time . + The elapsed time is the time between the point in time + where a package was received form the client and the + point where a response was received from the next filter + in chain (backend eventually). + + + + protocol (position 6) + + Protocol type which is one of Z3950 or + HTTP_Request or + HTTP_Response. + + + + + + + + For packages of with protocol marker Z3950 + the the access log line is followed by the APDU type + information + depending on the type. The APDU type is on position 7. + + + + initRequest + + Z39.50 Initialize Request with the information + username, vhost, + implementation ID, implementation name, implementation version. + + + + + initResponse + + Z39.50 Initialize Response with the information: + status (OK or FAIL), implementatino ID, implementation name, + implementation version. + + + + + searchRequest + + Z39.50 Search Request with the information: + database(s), result set ID, record syntax, query. + + + Multiple databases are separated by + a plus-sign (+). The query itself is + multiple tokens. For this reason it is placed as the last + information on this log entry. + + + + + searchResponse + + Z39.50 Search Response with the information: + status (OK or FAIL), hit count, number of records returned, + next result set position. + + + + + presentRequest + + Z39.50 Present Request with the information: + result Set ID, start position, number of records requested, + record syntax, record composition. + + + + + presentResponse + + Z39.50 Present Response with the information: + status (OK, DIAG, ERROR), number of records returned, + next result set position. + + + + + scanRequest + + Z39.50 Scan Request with the information: + database(s), number of terms requested, preferred position in + response, step size, start point. + + + start point is a multi token value in PQF notation. + + + + + scanResponse + + Z39.50 Scan Response with the information: + status (OK, ERROR), number of entries returned, position of term, + step size. + + + + + + + + + + SCHEMA + + EXAMPLES @@ -29,7 +300,8 @@ B - logs/etaproxy.log + + logs/metaproxy.log ]]> @@ -50,15 +322,7 @@