aminer

NAME

aminer - lightweight tool for log checking, log analysis

SYNOPSIS

aminer --Config|--config|-c file [OPTIONS]...

DESCRIPTION

This manual page documents briefly the aminer command. For more details see packaged documentation at /usr/share/doc/logdata-anomaly-miner.

OPTIONS

--config, -c file

Specify the configuration file, otherwise /etc/aminer/config.py is used. See /etc/aminer/template_config.py or /etc/aminer/template_config.yml for configuration file templates and examples.

--daemon, -D

With this parameter, aminer will detach from the terminal and daemonize. When not in foreground mode, aminer will also change the working directory to /, hence relative path in configuration file will not work.

--stat, -s stat-level

Set the statistic logging level. Possible stat-levels are 0 for no statistics, 1 (default) for normal statistic level and 2 for verbose statistics.

--debug, -d debug-level

Set the debug logging level. Possible debug-levels are 0 for no debugging, 1 (default) for normal output (INFO and above), 2 for printing all debug information.

--run-analysis

INTERNAL PARAMETER - DO NOT USE. It is just documented here for completeness.

--restore, -R backup-directory

Restores the persistence directory from backup-directory.

--clear, -C

With this parameter all persisted data in config_properties['Core.PersistenceDir'] is deleted. USE THIS PARAMETER CAREFULLY. IT DELETES ALL SUB-DIRECTORIES OF THE PERSISTENCE DIRECTORY.

--remove, -r directory

Remove persisted data of one Detector.

Example 1: --remove NewMatchPathDetector

Example 2: --remove NewMatchPathDetector --remove EventCorrelationDetector

--from-begin, -f

With this parameter all live data in config_properties['Core.PersistenceDir']/AnalysisChild/RepositioningData is deleted.

--help, -h

Prints the help-screen

--version, -v

Prints the version-string

FILES

/etc/aminer/config.py

The main configuration file for the aminer daemon. See /etc/aminer/template_config.py and /etc/aminer/template_config.yml for configuration file templates and examples.

BUGS

Report bugs via your distribution's bug tracking system. For bugs in the the software trunk, report via at https://github.com/ait-aecid/logdata-anomaly-miner/issues.

At startup, aminer will quite likely print out some security warnings to increase transparency. They are here just to remind you of the limitations the current implementation. They should be the same as for nearly all other programs on your platform, just that others do not tell you. See the source code documentation for a short explanation, why a given part of the implementation is not that secure as it could be when leveraging the security features a platform could provide you.

AUTHOR

Markus Wurzenberger <[email protected]>

Wrote this manpage for the Debian system.

COPYRIGHT

This manual page was written for the Debian system (and may be used by others).

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

02/01/2023

logdata-anomaly-miner