Class searchengine_monitor

Description

A monitor class to check if the search engine is up and about

Located in /monitor-defs.php (line 623)

generic_monitor
   |
   --searchengine_monitor
Variable Summary
 mixed $hits
 mixed $host
 mixed $host_abbrev
 mixed $port
 mixed $searcher
Method Summary
 searchengine_monitor searchengine_monitor (string $searcher, integer $hits, [string $host = ""], [string $port = ""])
 boolean check ()
Variables
mixed $hits = 0 (line 631)

Expected no. of hits

mixed $host = "" (line 634)

Search engine host

mixed $host_abbrev = "" (line 640)

Search engine host abbreviation

mixed $port = "" (line 637)

Search engine port

mixed $searcher (line 628)

The search engine search object

Methods
Constructor searchengine_monitor (line 652)

Define a new Search Engine monitor object. We register the query to use and the number of hits we expect. You can also specify the hostname and port of the Search server here, although Axyl users can leave these out (blank) if they have configured them with setup-system.php.

searchengine_monitor searchengine_monitor (string $searcher, integer $hits, [string $host = ""], [string $port = ""])
  • string $searcher: Search object, ready to execute
  • integer $hits: No of results expected back from search
  • string $host: Hostname of the server
  • string $port: Port number of the server
check (line 673)

Make the check on Lucene by firing the query off and checking for the expected number of hits coming back.

  • return: True if Lucene delivered correct number of hits.
boolean check ()

Documentation generated by phpDocumentor 1.3.0RC3