Tomcat server can be configured to use different type of logging systems, the server comes with default logging configuration and can be configured to use log4j. The access logs are based on the LogValve interface and
Steps:
- Add Log Data In XpoLog, When adding a log to XpoLog you can now select the Log Type (logtype) for Apache Tomcat with the following logtypes:
- tomcat
- in addition select also the log type - access or out or servlet
- in addition select also the log type - access or out or servlet
- tomcat
- Once all required information is set click next and edit the log pattern, this step is crucial to the accuracy and deployment of the Analytic App. Use the following conversion table to build the XpoLog pattern out of the log format.
Example
In the Apache Tomcat configuration file, usually server.xml or by default, located under the conf/ directory (Linux "/etc/httpd/conf") search for the LogFormat directive:
LogFormat "%a %l %u %t \"%r\" %>s %b %D \"%{Referer}i\" \"%{User-Agent}i\"" combined
The following sequence is the log structure definition for the Httpd server %a %l %u %t \"%r\" %>s %b %D \"%{Referer}i\" \"%{User-Agent}i\"
In XpoLog such pattern will be translated into:
{geoip:Client IP,ftype=remoteip;type=;,} {string:Remote Log Name,ftype=remotelog;,} {string:Remote User,ftype=remoteuser;,} [{date:Date,locale=en,dd/MMM/yyyy:HH:mm:ss z}] "{choice:Method,ftype=reqmethod;,GET;POST} {string:URL,ftype=requrl;,}{block,start,emptiness=true}?{string:Query,ftype=querystring;,}{block,end,emptiness=true} {string:reqprotocol,ftype=reqprotocol;,}" {number:Status,ftype=respstatus;,} {number:Bytes Sent,ftype=bytesent;,}{block,start,emptiness=true} {number:TimeToPrcessRequest,ftype=processrequestmilli;,}{block,end,emptiness=true} "{string:Referer,ftype=referer;,}" "{string:User Agent,ftype=useragent;,}"{eoe}
For more information see below:
https://tomcat.apache.org/tomcat-7.0-doc/logging.html
https://tomcat.apache.org/tomcat-8.0-doc/logging.html
https://tomcat.apache.org/tomcat-9.0-doc/logging.html
If the Server is using the log4j library please follow the steps documented in adding logs from log4j 1.2 or log4j 2.*
Apache Https Access Log Format Conversion Table
logtyep should be set to: httpd, access
Format String | Description | XpoLog Pattern | XpoLog ftype | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Remote IP-address | {ip:RemoteIP,ftype=remoteip} | remoteip | ||||||||||||
| Local IP-address | {ip:LocalIP,ftype=localip} | localip | ||||||||||||
| Size of response in bytes, excluding HTTP headers. | {number:BytesSent,ftype=bytesent} | bytesent | ||||||||||||
| Size of response in bytes, excluding HTTP headers. In CLF format, i.e. a ' | {text:BytesSent,ftype=bytesent} | bytesent | ||||||||||||
| The contents of cookie Foobar in the request sent to the server. Only version 0 cookies are fully supported. | {string:Cookie_< FOOBAR >} Replace < FOOBAR > with cookie name | |||||||||||||
| The time taken to serve the request, in microseconds. | {number:ResponseTimeMilliSecs} | |||||||||||||
| The contents of the environment variable FOOBAR | {string:EnvVariable_< FOOBAR >} Replace < FOOBAR > with variable name | |||||||||||||
| Filename | {text:FileName}
| |||||||||||||
| Remote host | {text:Remotehost,ftype=remotehost}
| remotehost | ||||||||||||
| The request protocol | { text:RequestProtocol,ftype=reqprotocol}
| reqprotocol | ||||||||||||
| The contents of Foobar affect this. If you're interested in what the request header was prior to when most modules would have modified it, use mod_setenvif to copy the header into an internal environment variable and log that value with the | {text:<FOOBAR>} https://en.wikipedia.org/wiki/List_of_HTTP_header_fields and so on it goes for the different headers.
| |||||||||||||
| { text:Referer,ftype=referer}
| referer | |||||||||||||
| { text:User-agent,ftype=useragent}
| useragent | |||||||||||||
%{ X-Forwarded-For}i | {text: X-Forwarded-For,ftype=forwardforip} OR {ip: X-Forwarded-For,ftype=forwardforip}
| forwardforip | |||||||||||||
| Number of keepalive requests handled on this connection. Interesting if KeepAlive is being used, so that, for example, a '1' means the first keepalive request after the initial one, '2' the second, etc...; otherwise this is always 0 (indicating the initial request). Available in versions 2.2.11 and later. | {number:KeepAlive} | |||||||||||||
| Remote logname (from identd, if supplied). This will return a dash unless mod_ident is present and IdentityCheck is set | {text:logname} | |||||||||||||
| The request method | {text:RequestMethod,ftype=reqmethod} | reqmethod | ||||||||||||
| The contents of note Foobar from another module. | {string:<FOOBAR>}
| |||||||||||||
| The contents of Foobar | {string:<FOOBAR>}
| |||||||||||||
| The canonical port of the server serving the request | {number:ServerPort,ftype=serverport} | serverport | ||||||||||||
| The canonical port of the server serving the request or the server's actual port or the client's actual port. Valid formats are
| {number:ServerPort,ftype=serverport} {number:LocalServerPort,ftype=localserverport} {number:RemotePort,ftype=remoteport} | serverport localserverportt remoteport | ||||||||||||
| The process ID of the child that serviced the request. | {text:ProcessID,ftype=processid} | processid | ||||||||||||
| The process ID or thread id of the child that serviced the request. Valid formats are | {text:ProcessID,ftype=processid} Valid formats are | processid | ||||||||||||
| The query string (prepended with a | {text:QueryString,ftype=querystring} OR Suggest a regexp that will build a list of parameters as cloumns. The query string (prepended with a | querystring | ||||||||||||
| First line of request | {text:FirstLine,ftype=reqfirstline} TBD - might be parsed to multiple value and types}
| reqfirstline | ||||||||||||
| The handler generating the response (if any). | {text:ResponseHandler}
| |||||||||||||
| Status. For requests that got internally redirected, this is the status of the *original* request --- | {number:ResponseStatus,ftype=respstatus} . For requests that got internally redirected, this is the status of the *original* request --- %>s for the last. | respstatus | ||||||||||||
| Time the request was received (standard english format) | {date:Date,locale=en,dd/MMM/yyyy:HH:mm:ss z}
| |||||||||||||
%{ format}t | The time, in the form given by format, which should be in an extended the time is taken at the beginning of the request processing. If it starts with processing. In addition to the formats supported by
These tokens can not be combined with each other or The extended | {date:Date,locale=en,dd/MMM/yyyy:HH:mm:ss z} sec number of seconds since the Epoch | |||||||||||||
| The time taken to serve the request, in seconds. | {number:ResponseTimeSecs,,ftype=processrequestmilli}
| processrequestmilli | ||||||||||||
| The time taken to serve the request, in a time unit given by same result as |
| processrequestmilli processrequestmicrosecs processrequestsecs | ||||||||||||
| Remote user (from auth; may be bogus if return status ( | {text:User,ftype=remoteuser} Remote user (from auth; may be bogus if return status ( | remoteuser | ||||||||||||
| The URL path requested, not including any query string. | {text:RequestURL,ftype=requrl} The URL path requested, not including any query string. | requrl | ||||||||||||
| The canonical ServerName of the server serving the request. | {text:ServerName,ftype=servername} | servername | ||||||||||||
| The server name according to the UseCanonicalName setting. | {text:ServerName,ftype=servername} The server name according to the UseCanonicalName setting. | servername | ||||||||||||
| Connection status when response is completed:
(This directive was | {text:ConnectionStatus} Connection status when response is completed:
(This directive was | |||||||||||||
| Bytes received, including request and headers, cannot be zero. You need to enable mod_logio to use this. | {number:TotalBytesWHeadersReceived,ftype=reqbyteswheaders} (with headers) | reqbyteswheaders | ||||||||||||
| Bytes sent, including headers, cannot be zero. You need to enable mod_logio to use this. | {number:TotalBytesWHeadersSent,ftype=respbyteswheaders} (with headers – can help compute header size) | respbyteswheaders | ||||||||||||
| The contents of VARNAME | {text:Req_<VARNAME>} The content of VARNAME: trailer line(s) in the request sent to the server. | |||||||||||||
| The contents of VARNAME | {text:Resp_<VARNAME>} The contents of VARNAME | |||||||||||||
|