Audit Agent Configuration

Manual configuration

It is possible to manually configure how the Audit Agent works in order to tailor itself to the operational mode of the server it is installed.

If you have used the installation script to automatically install AuditIQ, then you do not need to manually configure.

Basic usage

The basic usage is as follows...

php ~/installation_path/audit_agent.phar --api-key=<api> <store_path>

... where <api> must be replaced with the value provided to you when your AuditIQ account for this website was setup (it is specific to each website)and <store_path> must be replaced with the full directory where Magento is installed, for example...

php ~/installation_path/audit_agent.phar --api-key=123456 /var/www/magento/

In this mode, the following things are scanned:

Magento - Configuration, modules, server and data is collected.
Infrastructure - Only server data such as CPU load and free storage is collected.

Infrastructure only

If you want to monitor the infrastructure ONLY (i.e. CPU load and free storage) on servers where Magento is NOT installed, then adjust the command as follows...

php ~/installation_path/audit_agent.phar  --api-key=<api> --only-infra --node-name=<node>

... where <node> must be replaced with the name/purpose of the server. So, for example, if this was being used on a server that is being used for the MySQL database, then the command might be...

php ~/installation_path/audit_agent.phar  --api-key=123456 --only-infra --node-name=mysql

Note

Please note: The node-name values are entirely arbitrary and can be anything you want. Please ensure that the names are unique across all of your servers.

Security scan

If you have the Professional Edition, then you need to additionally enable the Sansec integration. This is done by adjusting the command, as follows:

php ~/installation_path/audit_agent.phar --api-key=<api> --sansec-key=<key> <store_path>

... where <key> must be replaced with the license key provided to you for this website. Please note, this is a different value to the API Key.

If Sansec eComscan is NOT installed in ~/bin/ecomscan then you must additionally adjust the command as follows...

php ~/installation_path/audit_agent.phar --api-key <api> --sansec-key=<key> --sansec-path=<sansec_path> <store_path>

... where <sansec_path> must be replaced with the full path of the Sansec eComscan executable.