Skip to content
Snippets Groups Projects
Commit 98f455ac authored by Jason Salyers's avatar Jason Salyers
Browse files

[JES] Updates to readme for better clarification on the log file setup

parent b9b417aa
No related branches found
No related tags found
No related merge requests found
......@@ -21,16 +21,20 @@ Providing no arguments or passing -h or --help will cause the tool to print the
<b>Notes about Nginx Log File:</b>
The tool expects the log file to follow the format:
The tool expects the log file to follow a specific format. Add the following lines near the top of your nginx configuration file (on linux this is found at <b>/etc/nginx/sites-available/default</b>):
```
$remote_user || [$time_local] || "$request" || '
$status || $body_bytes_sent || "$http_referer" || '
"$http_user_agent" || "$http_x_forwarded_for" || '
"$upstream_http_x_jussi_cache_hit" || "$upstream_http_x_jussi_namespace" || '
"$upstream_http_x_jussi_api" || "$upstream_http_x_jussi_method" || "$upstream_http_x_jussi_params" || '
'$upstream_connect_time || $upstream_response_time';
log_format api_log '$remote_addr - $remote_user || [$time_local] || "$request" || '
'$status || $body_bytes_sent || "$http_referer" || '
'"$http_user_agent" || "$http_x_forwarded_for" || '
'"$upstream_http_x_jussi_cache_hit" || "$upstream_http_x_jussi_namespace" || '
'"$upstream_http_x_jussi_api" || "$upstream_http_x_jussi_method" || "$upstream_http_x_jussi_params" || '
'$upstream_connect_time || $upstream_response_time';
```
and then down in the server section of the file add the line:
```
access_log /var/log/jussi/access.log api_log buffer=32k flush=5s;
```
This is the current logging configuration for the nginx server that sits in front of the production Jussi instance.
<b>Do an Analysis</b>
......@@ -58,4 +62,4 @@ If LibreOffice Calc is your default application for CSV files, double clicking
<b>Development<b>
The code was written in the eclipse IDE so the structure follows the eclipse workspace structure. You'll need to download and link the json-simple.1.1.1.jar file that is at the root of this project to be able to parse the json entries in the log file.
\ No newline at end of file
The code was written in the eclipse IDE so the structure follows the eclipse workspace structure. You'll need to download and link the json-simple.1.1.1.jar file that is at the root of this project to be able to parse the json entries in the log file.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment