Plesk Spider Tool

 

Information

Spider is a tool that scans important Plesk log files and gives you recommendations as to which KB articles might be useful.

How it works:
– Each knowledge base article has short descriptions which are called signatures.
– The Spider utility scans Plesk logs and compares log records to article signatures.
– If Spider finds a signature in a log file, it will show the article ID that contains this signature.
Please note that due to imperfect technology, Spider may find KB articles that are unrelated to your case. Therefore, you should verify that you have the same problem as the one described in the KB article before applying the provided workaround/fix/solution.
Also note that Spider cannot always find an applicable KB article.
All Spider-related questions can be discussed at the Parallels Forum. Please share your experiences and opinions there.

 

APPLIES TO:

  • Parallels Plesk Panel 10.x for Linux
  • Parallels Plesk Panel 9.x for Linux/Unix
  • Parallels Plesk Panel 10.x for Windows
  • Parallels Plesk Panel 9.x for Windows

Download

You can download the appropriate version of Spider here:
For Windows
For Linux

Basic usage

Download the Spider archive on the Plesk server, unpack it to any destination, and run the script spider.sh on a Linux server orspider.cmd on a Windows server.
From the output you can determine whether any KB articles might be useful for diagnosing your problem. By default, Spider only checks logs for problems occurring within the past day. If you think the problem may have originated before then, we recommend using the from option described in the Advanced Usage section.
Linux:

# mkdir Spider
# cd Spider/
# wget http://troubleshooting.plesk.parallels.com/resolveissue/troubleshooting/web/spider_linux.tgz
#
# tar -zxf spider_linux.tgz
#
# sh spider/spider.sh
Processing log "mail"...
Processing log "mailman"...
Processing log "sw"...
Processing log "httpd"...
Processing log "httpd-ssl"...
Processing log "named"...
KB Articles, that could be helpful:
112247: http://kb.parallels.com/en/112247
111616: http://kb.parallels.com/en/111616
112737: http://kb.parallels.com/en/112737
Spider log has been saved to /root/Spider/spider/5-02-2012-18-22-10.log
#

Windows:
– Download Spider from the URL http://troubleshooting.plesk.parallels.com/resolveissue/troubleshooting/web/spider_windows.zip.
– Unpack archive to any destination.
– Change directory to Spider directory and run script spider.cmd.

C:\Users\Administrator\Desktop\spider_windows\spider>spider.cmd
Spider started without parameters
Logs category "cp" loaded. Following logs will be processed: "plesk"
Logs category "mail" loaded. Following logs will be processed: "mailenable", "merak", "smartermail"
Processing log "plesk"...
Processing log "mailenable"...
Processing log "merak"...
Processing log "smartermail"...
KB Articles, that could be helpful:
112536: http://kb.parallels.com/en/112536
Spider log has been saved to C:\Users\Administrator\Desktop\spider_windows\spider\10-11-2011-22-57-12.log
Press any key to continue . . .

Check the output and make sure your issue is related to the proposed article.

Advanced usage

Use the help option to see all available script options.

# sh spider/spider.sh --help
Usage: spider.sh [--help]  [--from=date_from]  [--to=date_to]  [--verbose]  [--disable-filtering]  [log_name_1  [log_name_2  [...]]]
--from=date_from: looks for signatures in log records with date greater than date_from
    if not passed: filtering is performed for the last day (24 hours)
    date_from values are values acceptable by PHP strtotime function
    examples of strtotime valid dates:
       "10 May 2010",  "10 May 2010 14:00",  "yesterday",  "last week",  "last Monday",
       "-3 day" (3 days ago),  "-1 day 2 hours",  "-3 week",  "-2 month"
--to=date_to: looks for signatures in log records with date less than date_to
    other issues are the same as for --from parameter, except for default value -
    if not passed: no filtering is performed
--verbose: shows log lines and signatures' IDs in result
--show-files: shows files (sources) where Spider will look for signatures
    Note that this list of files does not include certain files
    that were filtered in the early stages.
  log_name_1, log_name_2, ... - names of log files to look for signatures in
  valid log names for your OS: mail, mailman, sw, httpd, httpd-ssl, named,
  pmm-logs, pmm-msessions, pmm-rsessions valid log categories for your OS:
  cp, mail, web, pmm
  if no log names are presented search is performed for all known log files

EXAMPLES:
Use option from for checking logs from a specific date:

# sh spider/spider.sh --from="11 Nov 2011"
>spider.cmd --from="11 Nov 2011"

or for the most recent period of time:

# sh spider/spider.sh --from="-5 days"
>spider.cmd --from="-5 days"

Use options from and to for checking logs from a specified period:

# sh spider/spider.sh --from="7 July 2010" --to="9 July 2010"

Verbose mode should be used if you want to see the line that was found:

>spider.cmd --verbose
# sh spider/spider.sh --verbose

Use option show-files to show files (sources) Spider will search for signatures:

>spider.cmd --show-files
# sh spider/spider.sh --show-files

Specify logs name or logs category to perform searches in these logs only:

>spider.cmd pmm-rsessions
# sh spider/spider.sh cp

You can combine options:

# spider/spider.sh --from="25 Oct 2011" --to="-1 hour" --show-files --verbose mail
Spider started with the following parameters: '--from=25 Oct 2011' '--to=-1 hour' '--show-files' '--verbose' 'mail'
Logs category "mail" loaded. The following logs will be processed: "mailman", "maillog"
Spider will look for signatures in the following files (sources):
maillog
/usr/local/psa/var/log/maillog.processed
/usr/local/psa/var/log/maillog
Processing log "mailman"...
Processing log "maillog"...
KB Articles, that could be helpful:
Article #112247
Signature #3224: deferral: cname_lookup_failed_temporarily._(#4.4.3)
maillog:
Found in /usr/local/psa/var/log/maillog:
Nov 11 10:09:07 ce56x64 qmail: 1328440147.269085 delivery 644: deferral: CNAME_lookup_failed_temporarily._(#4.4.3)/
Signature #3225: #4.4.3
maillog:
Found in /usr/local/psa/var/log/maillog:
Nov 11 10:09:07 ce56x64 qmail: 1328440147.269085 delivery 644: deferral: CNAME_lookup_failed_temporarily._(#4.4.3)/
Article #111616
Signature #3588: cname_lookup_failed_temporarily
maillog:
Found in /usr/local/psa/var/log/maillog:
Nov 11 10:09:07 ce56x64 qmail: 1328440147.269085 delivery 644: deferral: CNAME_lookup_failed_temporarily._(#4.4.3)/
Spider log has been saved to /root/Spider/spider/11-11-2011-14-33-10.log

Leave a comment