Logging all requests on the file system¶
The history mode logs all requests into a database. This can put a very significant strain on the database and can lead to insertion issues as the request table begins to host millions of records.
As an alternative to the history mode it’s possible to enable the auditing logger, which will log the details of each request in a file, which is periodically rolled. Secondary applications can then process these log files and built ad-hoc summaries off line.
Configuration¶
The monitor.properties
file can contain the following items to enable and configure file auditing:
Go to the ${GEOSERVER_DATA_DIR}/monitoring (%GEOSERVER_DATA_DIR%/monitoring in Windows) and open the
monitor.properties
, then append the following configuration:audit.enabled=true audit.path=${TRAINING_ROOT} audit.roll_limit=20
Replace
${TRAINING_ROOT}
with the full path to the workshop root folder, and remember to always use forward slashes,/
, in the path, regardless of the operating system. For example, on Windows the path might look likeC:/data/Training_2.18.X
Go to the Map Map Preview and open the geosolutions:states layer clicking on the
OpenLayer
link.Perform a few times zoom the map.
Open the new created log file (named like
geoserver_audit_yyyymmdd_nn.log
) located at ${TRAINING_ROOT}.Note
- audit.enable: is used to turn on the logger (it is off by default).
- audit.path: is the directory where the log files will be created.
- audit.roll_limit: is the number of requests logged into a file before rolling happens.
Note
The files are also automatically rolled at the beginning of each day.
Outputs and contents¶
The log directory will contain a number of log files following the geoserver_audit_yyyymmdd_nn.log
pattern. The nn
is increased at each roll of the file. The contents of the log directory will look like:
geoserver_audit_20110811_2.log
geoserver_audit_20110811_3.log
geoserver_audit_20110811_4.log
geoserver_audit_20110811_5.log
geoserver_audit_20110811_6.log
geoserver_audit_20110811_7.log
geoserver_audit_20110811_8.log
Customizing the log contents¶
The log contents are driven by three FreeMarker templates. We can customize them to have the log file be a csv file for example.
On the file system navigate to the GeoServer data directory located at $GEOSERVER_DATA_DIR (%GEOSERVER_DATA_DIR% in Windows).
In the
monitoring
directory create a new file namedheader.ftl
(is used once when a new log file is created to form the first few lines of the file).Open
header.ftl
in the text editor of your choice and enter the following content (make sure to end the file with a newline):# start time,services,version,operation,url,response content type,total time,response length,error flag
Create another file named
content.ftl
.Open
content.ftl
in the text editor of your choice and enter the following content (make sure to end the file with a newline):${startTime?datetime?iso_utc_ms},${service!""},${owsVersion!""},${operation!""},"${path!""}${queryString!""}",${responseContentType!""},${totalTime},${responseLength?c},<#if error??>failed<#else>success</#if>
Create a last file named
footer.ftl
, and leave its contents emptyRun again a few requests, the log files should contain something like the following now:
# start time,services,version,operation,url,response content type,total time,response lenght,error flag 2012-06-07T10:37:09.725Z,WMS,1.1.1,GetMap,"/geosolutions/wmsLAYERS=geosolutions:ccounties&STYLES=&FORMAT=image/png&SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&SRS=EPSG:4269&BBOX=-106.17254516602,39.489453002927,-105.18378466798,40.054948608395&WIDTH=577&HEIGHT=330",image/png,59,30420,success 2012-06-07T10:37:10.075Z,WMS,1.1.1,GetMap,"/geosolutions/wmsLAYERS=geosolutions:ccounties&STYLES=&FORMAT=image/png&SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&SRS=EPSG:4269&BBOX=-105.84010229493,39.543136352537,-105.34572204591,39.825884155271&WIDTH=577&HEIGHT=330",image/png,45,18692,success