<commit_before>#Quixr - Apache2 virtual host analysis

[![Build Status](https://travis-ci.org/derhansen/quixr.png?branch=develop)](https://travis-ci.org/derhansen/quixr)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/derhansen/quixr/badges/quality-score.png?s=11465c0dd3d311aee21755773ce8d6cdee6b6a6f)](https://scrutinizer-ci.com/g/derhansen/quixr/)
[![Code Coverage](https://scrutinizer-ci.com/g/derhansen/quixr/badges/coverage.png?s=25346efac4d6a7dd41a73e3745027229becdd797)](https://scrutinizer-ci.com/g/derhansen/quixr/)
[![Dependency Status](https://www.versioneye.com/user/projects/53098aa5ec1375991b000016/badge.png)](https://www.versioneye.com/user/projects/53098aa5ec1375991b000016)

Quixr is a command line tool which analyzes traffic and used diskspace for Apache2 virtual hosts. Quixr outputs its
analysis data into a JSON file, which can be used for reporting and data visualization.

Quixr is still under **development**, so some major features are missing and expect things to change during development.

##Todos

* Quota reporting
* Webtool for data visualization

##Who should use Quixr?

Quixr is for administrators who have multiple virtual hosts on an Apache2 webserver and want to get a global overview
about the traffic and diskspace usage of virtual host.

##Requirements

In order to use Quixr the following requirements must be met

* PHP 5.3 or higher installed on the server
* All Apache2 virtual hosts must be inside the same directory (e.g. `/var/www/`)
* Logfiles for each virtual host must be located inside a subfolder for each virtual host (e.g. `/var/www/vhost1/logfiles`)

##Traffic analysis

The Quixr logfile analysis checks the logfile for each virtual host and accumulates the daily traffic. If the target
JSON file already contains historical data, new traffic data gets merged.

###Usage

```
Usage:
 analyze:traffic vhost-path logfile-path logfile target-file [logformat]

Arguments:
 vhost-path         Path to virtial hosts (e.g. /var/www/)
 logfile-path       Path to logfiles of each virtual host (e.g. logs)
 logfile            Logfile (e.g. access.log)
 target-file        Target JSON file for analysis results (e.g. quixr.json
 logformat          Apache2 Logfile format. Allowed values: common, combined (default: "combined")
```<commit_msg>[TASK] Update readme.md  - Refs #50<commit_after>#Quixr - Apache2 virtual host analysis

[![Build Status](https://travis-ci.org/derhansen/quixr.png?branch=develop)](https://travis-ci.org/derhansen/quixr)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/derhansen/quixr/badges/quality-score.png?s=11465c0dd3d311aee21755773ce8d6cdee6b6a6f)](https://scrutinizer-ci.com/g/derhansen/quixr/)
[![Code Coverage](https://scrutinizer-ci.com/g/derhansen/quixr/badges/coverage.png?s=25346efac4d6a7dd41a73e3745027229becdd797)](https://scrutinizer-ci.com/g/derhansen/quixr/)
[![Dependency Status](https://www.versioneye.com/user/projects/53098aa5ec1375991b000016/badge.png)](https://www.versioneye.com/user/projects/53098aa5ec1375991b000016)

Quixr is a command line tool which analyzes traffic and used diskspace for Apache2 virtual hosts. Quixr outputs its
analysis data into a JSON file, which can be used for reporting and data visualization.

Quixr is still under **development**, so some major features are missing and expect things to change during development.

##Todos

* Quota reporting
* Webtool for data visualization

##Who should use Quixr?

Quixr is for administrators who have multiple virtual hosts on an Apache2 webserver and want to get a global overview
about the traffic and diskspace usage of virtual host.

##Requirements

In order to use Quixr the following requirements must be met

* PHP 5.3 or higher installed on the server
* All Apache2 virtual hosts must be inside the same directory (e.g. `/var/www/`)
* Logfiles for each virtual host must be located inside a subfolder for each virtual host (e.g. `/var/www/vhost1/logfiles`)
* Document root for each virtual host must be located inside a subfolder for each virtual host (e.g. `/var/www/vhost1/htdocs`)

##Traffic analysis

The Quixr logfile analysis checks the logfile for each virtual host and accumulates the daily traffic. If the target
JSON file already contains historical data, new traffic data gets merged.

###Usage

```
Usage:
 analyze:traffic vhost-path logfile-path logfile target-file [logformat]

Arguments:
 vhost-path         Path to virtial hosts (e.g. /var/www/)
 logfile-path       Path to logfiles of each virtual host (e.g. logs)
 logfile            Logfile (e.g. access.log)
 target-file        Target JSON file for analysis results (e.g. quixr.json
 logformat          Apache2 Logfile format. Allowed values: common, combined (default: "combined")
```
{'fraction_non_alphanumeric': 0.09425625920471281, 'fraction_numerical': 0.04018514622343783, 'mean_word_length': 4.566744730679157, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 16, 'lorem ipsum': 0, 'www.': 11, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3241470', 'n_tokens_mistral': 1619, 'n_tokens_neox': 1489, 'n_words': 494}