Difference between revisions of "Slogan"

From DXSpider Documentation Wiki
Jump to: navigation, search
Line 1: Line 1:
 
=Introduction=
 
=Introduction=
  
'''slogan''' is a console tool to analyse monthly log files created by DXSPIDER. It gives you an overall picture regarding connected users, helps to identify power users, loads, etc.
+
'''slogan''' is a console tool to analyze monthly log files created by DXSPIDER. It gives you an overall picture regarding connected users, helps to identify power users, loads, etc.
  
Program helps to find possible frauds also displaying the contry of the IP address, indicating a different country than the callsign itself.
+
The program also helps to find possible frauds displaying the country of the IP address, indicating a different country than the callsign itself.
  
slogan list end users connected to the system during the period and display the following information:
+
Slogan lists end users connected to the system during the period and display the following information:
  
*callsign
+
*Callsign
*date and time of first conenction
+
*Date and time of first connection
*date and time of last connection (if there are more)
+
*Date and time of last connection (if there are more)
*number of connections
+
*Number of connections
*total connected time
+
*Total connected time
*number of different IP addresses used
+
*Number of different IP addresses used
 
*IP address of last connection
 
*IP address of last connection
*country where the last IP is allocated
+
*Country where the last IP is allocated
  
 +
Some summary information is also displayed:
  
There are summary information is also displayed:
+
*Name of log file analyzed
 +
*Date of creation
 +
*Date and time of forst log entry
 +
*Date and time of last log entry
 +
*Number of different callsigns connected
 +
*Number of stations already connected when log starts
 +
*Number of max conencted users
 +
*Date and time when max users connected
 +
*Number of log errors (connect/disconnect sequence)
  
*name of log file analyzed
 
*date of creation
 
*date and time of forst log entry
 
*date and time of last log entry
 
*number of different callsigns connected
 
*number of stations already connected when log starts
 
*number of max conencted users
 
*date and time when max users connected
 
*number of log errors (connect/disconnect sequence)
 
  
 +
=Prerequisites=
  
=Pre-requisits=
+
The program is written in PYTHON, a free scripting language. Usually it is already installed on a LINUX system. No special modules are required. Compatible with Python 2.2.x, 2.3.x, 2.4.x and 2.5.x versions. 2.6.x is expected to work but not tested yet. Python 3.x is intentionally not backward compatible, therefore slogan may need to be modified to work properly. Stick with 2.5 or 2.5 version.
 
+
Program is written in PYTHON, a free scripting language. Usually it is already installed on a LINUX system. No special modules are required. Compatible with Python 2.2.x, 2.3.x, 2.4.x and 2.5.x versions. 2.6.x is expected to work but not tested yet. Python 3.x is intentionally not backward compatible, therefore slogan most be modified most likely to change. Stick with 2.5 or 2.5 version.
+
  
 
For WINDOWS download it from http://www.python.org
 
For WINDOWS download it from http://www.python.org
 
  
 
=Operating systems=
 
=Operating systems=
Line 44: Line 42:
 
=LINUX Installation=
 
=LINUX Installation=
  
Extract archive and copy slogan, geoip.py and ip-to-country.csv to a directory which is included in the shell path. On most LINUX system /usr/local/bin is a good choice, but it may vary.  
+
Extract the archive and copy slogan, geoip.py and ip-to-country.csv to a directory which is included in the shell path. On most LINUX systems /usr/local/bin is a good choice, but it may vary.  
  
 
Check file permissions and change it to 644 if necessary. On some systems 777 would be needed.
 
Check file permissions and change it to 644 if necessary. On some systems 777 would be needed.
Line 52: Line 50:
 
An installed DXSPIDER system is not necessary, only the log file is processed. Program can be run on a different machine.
 
An installed DXSPIDER system is not necessary, only the log file is processed. Program can be run on a different machine.
  
No online connection required, Internet is not used at all.
+
No online connection required, the Internet is not used at all.
 
   
 
   
  
Line 60: Line 58:
  
 
*Download latest Python (was 2.5.2 when tested) from www.python.org and install
 
*Download latest Python (was 2.5.2 when tested) from www.python.org and install
*Open Control panel/System 'Special' tab (or similar, do not have English WIN)
+
*Open Control panel/System 'Advanced' tab
 
*Click 'Environment variables' on the bottom
 
*Click 'Environment variables' on the bottom
 
*Click Path in the lower window (system variables)
 
*Click Path in the lower window (system variables)
 
*Add the Python install path, default is C:\Python25 (use ; as a separator)
 
*Add the Python install path, default is C:\Python25 (use ; as a separator)
 
  
 
Now WINDOWS knows where to find Python.
 
Now WINDOWS knows where to find Python.
  
Copy slogan, geoip.py and ip-to-country.cvs to a dirextory of your choise. Open a command line window, enter to the directory where slogan files are and type:
+
Copy slogan, geoip.py and ip-to-country.cvs to a directory of your choice. Open a command line window, enter to the directory where slogan files are and type:
  
 
python slogan <log file>
 
python slogan <log file>
  
It works without any modification, renaming, etc. of the original files.
+
It works without any modification, renaming etc. of the original files.
  
  
Line 79: Line 76:
 
Program requires only one argument, the name of the log file. In case of typical DXSPIDER installation log files are stored in the /spider/data/log/ directory in a subdirectory for each year.
 
Program requires only one argument, the name of the log file. In case of typical DXSPIDER installation log files are stored in the /spider/data/log/ directory in a subdirectory for each year.
  
For example to analyse the March 2008 log type in the console:
+
For example to analyze the March 2008 log type in the console:
  
 
slogan /spider/data/log/2008/03.dat
 
slogan /spider/data/log/2008/03.dat
Line 93: Line 90:
  
 
The IP to country database is updated regularly, latest version is available at http://ip-to-country.webhosting.info
 
The IP to country database is updated regularly, latest version is available at http://ip-to-country.webhosting.info
 
  
 
=Licence=
 
=Licence=
  
Program including the geoip.py module can be used, shared or modified freely with no restrictions. For the licencing info of the IP to country database visit http://ip-to-country.webhosting.info
+
Program including the geoip.py module can be used, shared or modified freely with no restrictions. For the licensing info of the IP to country database visit http://ip-to-country.webhosting.info
 
+
  
 
=Feedback=
 
=Feedback=
  
Your feedback, error reports, feature reqests are welcome. Send email to [mailto:ha5di@freemail.hu ha5di@freemail.hu]
+
Your feedback, error reports, feature requests are welcome. Send email to [mailto:ha5di@freemail.hu ha5di@freemail.hu]
 
+
  
 
=Reporting bugs=
 
=Reporting bugs=
Line 109: Line 103:
 
When you report a bug please send the following information:
 
When you report a bug please send the following information:
  
*slogan version
+
*Slogan version
 
*Python version
 
*Python version
*type and version of host operating system running slogan
+
*Type and version of host operating system running slogan
*screen copy of error message
+
*Screen copy of error message
*log file processed
+
*Log file processed
 
+
  
 
=Latest version=
 
=Latest version=
  
 
Latest release is 1.3
 
Latest release is 1.3
 
  
 
=Download=
 
=Download=
  
 
http://www.hasix.org/files/slogan/slogan-13.zip
 
http://www.hasix.org/files/slogan/slogan-13.zip

Revision as of 10:16, 27 December 2008

Introduction

slogan is a console tool to analyze monthly log files created by DXSPIDER. It gives you an overall picture regarding connected users, helps to identify power users, loads, etc.

The program also helps to find possible frauds displaying the country of the IP address, indicating a different country than the callsign itself.

Slogan lists end users connected to the system during the period and display the following information:

  • Callsign
  • Date and time of first connection
  • Date and time of last connection (if there are more)
  • Number of connections
  • Total connected time
  • Number of different IP addresses used
  • IP address of last connection
  • Country where the last IP is allocated

Some summary information is also displayed:

  • Name of log file analyzed
  • Date of creation
  • Date and time of forst log entry
  • Date and time of last log entry
  • Number of different callsigns connected
  • Number of stations already connected when log starts
  • Number of max conencted users
  • Date and time when max users connected
  • Number of log errors (connect/disconnect sequence)


Prerequisites

The program is written in PYTHON, a free scripting language. Usually it is already installed on a LINUX system. No special modules are required. Compatible with Python 2.2.x, 2.3.x, 2.4.x and 2.5.x versions. 2.6.x is expected to work but not tested yet. Python 3.x is intentionally not backward compatible, therefore slogan may need to be modified to work properly. Stick with 2.5 or 2.5 version.

For WINDOWS download it from http://www.python.org

Operating systems

Program is developed and tested on LINUX (CentOS 5.2). It is expected to work on any modern LINUX system and any other OS where PYTHON is available, including WINDOWS. However it is not tested yet on other systems.


LINUX Installation

Extract the archive and copy slogan, geoip.py and ip-to-country.csv to a directory which is included in the shell path. On most LINUX systems /usr/local/bin is a good choice, but it may vary.

Check file permissions and change it to 644 if necessary. On some systems 777 would be needed.

No configuration is required.

An installed DXSPIDER system is not necessary, only the log file is processed. Program can be run on a different machine.

No online connection required, the Internet is not used at all.


WINDOWS XP Installation

Following installation is tested on WINDOWS XP. WINDOWS 2000 and VISTA must be similar.

  • Download latest Python (was 2.5.2 when tested) from www.python.org and install
  • Open Control panel/System 'Advanced' tab
  • Click 'Environment variables' on the bottom
  • Click Path in the lower window (system variables)
  • Add the Python install path, default is C:\Python25 (use ; as a separator)

Now WINDOWS knows where to find Python.

Copy slogan, geoip.py and ip-to-country.cvs to a directory of your choice. Open a command line window, enter to the directory where slogan files are and type:

python slogan <log file>

It works without any modification, renaming etc. of the original files.


Usage

Program requires only one argument, the name of the log file. In case of typical DXSPIDER installation log files are stored in the /spider/data/log/ directory in a subdirectory for each year.

For example to analyze the March 2008 log type in the console:

slogan /spider/data/log/2008/03.dat

You can save output to a file on the usual way:

slogan /spider/data/log/2008/03.dat > report0803.txt


Update

New versions will be announced on the DXSPIDER mailing list.

The IP to country database is updated regularly, latest version is available at http://ip-to-country.webhosting.info

Licence

Program including the geoip.py module can be used, shared or modified freely with no restrictions. For the licensing info of the IP to country database visit http://ip-to-country.webhosting.info

Feedback

Your feedback, error reports, feature requests are welcome. Send email to ha5di@freemail.hu

Reporting bugs

When you report a bug please send the following information:

  • Slogan version
  • Python version
  • Type and version of host operating system running slogan
  • Screen copy of error message
  • Log file processed

Latest version

Latest release is 1.3

Download

http://www.hasix.org/files/slogan/slogan-13.zip