<commit_before>SysReporter
===========

SysReporter is a bash script that runs and aggregates a set of reports about its host server. The report can then be emailed to the system administrator on a daily, hourly, minutely basis.

Requirements
------------

* ssmtp (if emailing is enabled)
* sar (if using the default system activity report)

Install
-------

* Move the SysReporter directory to a place of your choosing
* Move sysreporter.conf to /etc
* Edit /etc/sysreporter.conf and fill in the server name variable and the email addresses to send the report (separated by comma).
* Install and setup ssmtp if you would like to receive the reports via email
* Setup a cron job to run periodically
* The default set of reports includes one called "sar" (System Activity Report) which requires the sysstat package. If this package is not installed the report won't run. If you want to use sar follow these instructions:
    - Install the sysstat package
    - Edit /etc/default/sysstat and change Enabled to true
    - Run "sudo service sysstat restart"
    - sar is completely optional, it will not affect other reports

Usage
-----

report.sh [command] [arguments]

Commands:
    - run - Run a full report and email if enabled
    - show - Show reports that will be ran
    - enable - Enable a set of reports `report.sh enable 41` or `report.sh enable apache`
    - disable - Disable a set of reports, same syntax as enable
    - help - Show usage
    - version - Show version

Reports
-------<commit_msg>Updated readme formatting<commit_after>SysReporter
===========

SysReporter is a bash script that runs and aggregates a set of reports about its host server. The report can then be emailed to the system administrator on a daily, hourly, minutely basis.

Requirements
------------

* ssmtp (if emailing is enabled)
* sar (if using the default system activity report)

Install
-------

1. Move the SysReporter directory to a place of your choosing
2. Move sysreporter.conf to /etc
3. Edit /etc/sysreporter.conf and fill in the server name variable and the email addresses to send the report (separated by comma).
4. Install and setup ssmtp if you would like to receive the reports via email
5. Setup a cron job to run periodically
6. The default set of reports includes one called "sar" (System Activity Report) which requires the sysstat package. If this package is not installed the report won't run. If you want to use sar follow these instructions:
    - Install the sysstat package
    - Edit /etc/default/sysstat and change Enabled to true
    - Run "sudo service sysstat restart"
    - sar is completely optional, it will not affect other reports

Usage
-----

sysreport [command] [arguments]

Commands:

- `run` - Run a full report and email if enabled
- `show` - Show reports that will be ran
- `enable` - Enable a set of reports `report.sh enable 41` or `report.sh enable apache`
- `disable` - Disable a set of reports, same syntax as enable
- `help` - Show usage
- `version` - Show version

Reports
-------
{'fraction_non_alphanumeric': 0.07773734700628515, 'fraction_numerical': 0.0033079722130334105, 'mean_word_length': 3.3261802575107295, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, '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': '5138496', 'n_tokens_mistral': 805, 'n_tokens_neox': 771, 'n_words': 442}