From 66401c61c09b24683533f44583bef9a2daa04fc5 Mon Sep 17 00:00:00 2001 From: nick Date: Sat, 28 Jan 2023 12:08:31 -0500 Subject: [PATCH] readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0fbdc21 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Nicholas Hope Science Fair 2023 Code and Logs + +This is the repo for my (Nicholas Hope) code that analyzes log files from various servers across the world. + +THE SCIENCE FAIR IS NOW OVER. THIS CODE IS LEFT ONLY FOR THE PURPOSE OF EXAMINATION. + +  + +## Contents + +There are three main components: + +1. `fetch-logs.sh`, which would retrieve log files from the servers when they were running. __It is now not functional, as those servers are not availible anymore.__ +2. `analyze.py`, a Python script to analyze the data and produce a CSV. +3. `logs/`, the directory containing all of the log files. + +  + +## Instructions + +0. Clone the repository +1. For each directory, unpack all access.log.*.gz +2. Run the python script `analyze.py`, providing the log directory as the first and only argument. +3. It will make a new file, `analysis.csv` containing the analysis. Do with this data what you please. \ No newline at end of file