CirrusSearch\Api\CheckSanity Class Reference

Validates the sanity of the search indexes for a range of page id's. More...

Inheritance diagram for CirrusSearch\Api\CheckSanity:

Collaboration diagram for CirrusSearch\Api\CheckSanity:

Public Member Functions
	execute ()
	getAllowedParams ()
	isInternal ()
	Mark as internal.

Protected Member Functions
	makeChecker (string $cluster, Remediator $remediator)
	getExamplesMessages ()

Detailed Description

Validates the sanity of the search indexes for a range of page id's.

Invokes the cirrus sanity checker which compares a range of page ids current state in the sql database against the elasticsearch indexes. Reports on issues found such as missing pages, pages that should have been deleted, and old versions in the search index.

Also offers a constant rerender-over-time through the sequenceid and rerenderfrequency options. The sequenceid should be incremented each time the same set of page ids is sent to the checker. A subset of the page ids will be emit as oldDocument in each batch, such that after rerenderfrequency increments of sequenceid all pages will have been rerendered. The purpose of the over-time rerender is to ensure changes to how pages are rendered make it into the search indexes within an expected timeframe.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Member Function Documentation

getExamplesMessages()

CirrusSearch\Api\CheckSanity::getExamplesMessages ( )

protected

See also

ApiBase::getExamplesMessages

Returns

array

isInternal()

CirrusSearch\Api\CheckSanity::isInternal

(

)

Mark as internal.

This isn't meant to be used by normal api users

Returns

bool

---

The documentation for this class was generated from the following file:

• includes/Api/CheckSanity.php