Extension:CirrusSearch/ko

미디어위키 확장 기능 설명서

CirrusSearch 출시 상태: 안정
구현	검색, API , 훅
설명	Implements searching for MediaWiki using Elasticsearch
만든 이	Nik Everett, Chad Horohoe, Erik Bernhardson
최신 버전	continuous updates
호환성 정책	스냅샷은 미디어위키와 함께 릴리스됩니다. Master is not backward compatible.
Composer	mediawiki/cirrussearch
변수 $wgCirrusSearchDeduplicateInQuery $wgCirrusSearchAlternativeIndices $wgCirrusSearchLanguageWeight $wgCirrusSearchAutomationCIDRs $wgCirrusSearchUseIcuFolding $wgCirrusSearchStemmedWeight $wgCirrusSearchQueryStringMaxDeterminizedStates $wgCirrusSearchRedirectDocuments $wgCirrusSearchNamespaceMatcherProfiles $wgCirrusSearchExtraIndexSettings $wgCirrusSearchTalkNamespaceWeight $wgCirrusSearchPrefixWeights $wgCirrusSearchMustTrackTotalHits $wgCirrusSearchPrefixSearchRescoreProfile $wgCirrusSearchLanguageToWikiMap $wgCirrusSearchCompletionSuggesterUseDefaultSort $wgCirrusSearchExtraFieldsInSearchResults $wgCirrusSearchMoreLikeThisMaxQueryTermsLimit $wgCirrusSearchUseIcuTokenizer $wgCirrusSearchCompletionBannedPageIds $wgCirrusSearchOptimizeIndexForExperimentalHighlighter $wgCirrusSearchRescoreProfiles $wgCirrusSearchPhraseRescoreBoost $wgCirrusSearchInterwikiProv $wgCirrusSearchMoreLikeThisAllowedFields $wgCirrusSearchQueryStringMaxWildcards $wgCirrusSearchElasticQuirks $wgCirrusSearchMaxFileTextLength $wgCirrusSearchFallbackProfiles $wgCirrusSearchMoreLikeThisTTL $wgCirrusSearchAllowLeadingWildcard $wgCirrusSearchInterwikiPrefixOverrides $wgCirrusSearchMaintenanceTimeout $wgCirrusSearchReplicas $wgCirrusSearchPhraseSlop $wgCirrusSearchManagedClusters $wgCirrusSearchWriteBackoffExponent $wgCirrusSearchUserTesting $wgCirrusSearchShardCount $wgCirrusSearchUseCompletionSuggester $wgCirrusSearchPhraseSuggestReverseField $wgCirrusSearchFallbackProfile $wgCirrusSearchFragmentSize $wgCirrusSearchUnlinkedArticlesToUpdate $wgCirrusSearchCustomPageFields $wgCirrusSearchClientSideUpdateTimeout $wgCirrusSearchIgnoreOnWikiBoostTemplates $wgCirrusSearchRegexMaxDeterminizedStates $wgCirrusSearchInterwikiHTTPConnectTimeout $wgCirrusSearchExtraIndexes $wgCirrusSearchCategoryDepth $wgCirrusSearchMergeSettings $wgCirrusSearchWeights $wgCirrusSearchCrossProjectShowMultimedia $wgCirrusSearchBannedPlugins $wgCirrusSearchMoreLikeThisConfig $wgCirrusSearchClusterOverrides $wgCirrusSearchCrossProjectBlockScorerProfiles $wgCirrusSearchEnableIncomingLinkCounting $wgCirrusSearchNearMatchWeight $wgCirrusSearchReplicaGroup $wgCirrusSearchFeedbackLink $wgCirrusSearchCompletionSuggesterSubphrases $wgCirrusSearchNumCrossProjectSearchResults $wgCirrusSearchLanguageDetectors $wgCirrusSearchUpdateShardTimeout $wgCirrusSearchEnableCrossProjectSearch $wgCirrusSearchSecondTryProfiles $wgCirrusSearchFullTextQueryBuilderProfiles $wgCirrusSearchCompletionDefaultScore $wgCirrusSearchWriteClusters $wgCirrusSearchCompletionSuggesterHardLimit $wgCirrusSearchRecycleCompletionSuggesterIndex $wgCirrusSearchFullTextQueryBuilderProfile $wgCirrusSearchTextcatConfig $wgCirrusSearchCompletionUseSecondTryProfile $wgCirrusSearchStreamingUpdaterUsername $wgCirrusSearchLogElasticRequests $wgCirrusSearchPreferRecentDefaultDecayPortion $wgCirrusSearchCompletionSuggesterUseAltIndexId $wgCirrusSearchWikiToNameMap $wgCirrusSearchMaxFullTextQueryLength $wgCirrusSearchLogElasticRequestsSecret $wgCirrusSearchLanguageKeywordExtraFields $wgCirrusSearchEnableEventBusWeightedTags $wgCirrusSearchNaturalTitleSort $wgCirrusSearchDeduplicateInMemory $wgCirrusSearchUseEventBusBridge $wgCirrusSearchDeduplicateAnalysis $wgCirrusSearchEnableRegex $wgCirrusSearchClientSideSearchTimeout $wgCirrusSearchIndexFieldsToCleanup $wgCirrusSearchTextcatModel $wgCirrusSearchCategoryMax $wgCirrusSearchExtraBackendLatency $wgCirrusSearchNamespaceMappings $wgCirrusSearchNamespaceResolutionMethod $wgCirrusSearchPreferRecentUnspecifiedDecayPortion $wgCirrusSearchIndexWeightedTagsPrefixMap $wgCirrusSearchDocumentSizeLimiterProfiles $wgCirrusSearchSearchShardTimeout $wgCirrusSearchWeightedTags $wgCirrusSearchRefreshInterval $wgCirrusSearchSimilarityProfiles $wgCirrusSearchCategoryEndpoint $wgCirrusSearchMasterTimeout $wgCirrusSearchPoolCounterKey $wgCirrusSearchCompletionProfiles $wgCirrusSearchMaxShardsPerNode $wgCirrusSearchDefaultCluster $wgCirrusSearchEnableArchive $wgCirrusSearchSimilarityProfile $wgCirrusSearchInterwikiThreshold $wgCirrusSearchIndexDeletes $wgCirrusSearchDocumentSizeLimiterProfile $wgCirrusSearchFiletypeAliases $wgCirrusSearchDevelOptions $wgCirrusSearchPrefixSearchStartsWithAnyWord $wgCirrusSearchUpdateConflictRetryCount $wgCirrusSearchInterwikiHTTPTimeout $wgCirrusSearchFetchConfigFromApi $wgCirrusSearchBoostTemplates $wgCirrusSearchExtraIndexBoostTemplates $wgCirrusSearchDefaultNamespaceWeight $wgCirrusSearchUpdateDelay $wgCirrusSearchIndexedRedirects $wgCirrusSearchMoreLikeThisFields $wgCirrusSearchIndexAllocation $wgCirrusSearchDefaultSemanticProfile $wgCirrusSearchPrefixIds $wgCirrusSearchPhraseSuggestBuildVariant $wgCirrusSearchNamespaceWeights $wgCirrusSearchCrossProjectOrder $wgCirrusSearchStripQuestionMarks $wgCirrusSearchIndexBaseName $wgCirrusSearchMoreAccurateScoringMode $wgCirrusSearchMaxPhraseTokens $wgCirrusSearchCompletionPlainTokenizer $wgCirrusSearchPhraseSuggestUseOpeningText $wgCirrusSearchCategoriesClientCacheTTL $wgCirrusSearchMaxIncategoryOptions $wgCirrusSearchAutomationHeaderRegexes $wgCirrusSearchWikimediaExtraPlugin $wgCirrusSearchCompletionSettings $wgCirrusSearchLinkedArticlesToUpdate $wgCirrusSearchCrossProjectSearchBlockList $wgCirrusSearchPreferRecentDefaultHalfLife $wgCirrusSearchRescoreProfile $wgCirrusSearchFunctionRescoreWindowSize $wgCirrusSearchDisableUpdate $wgCirrusSearchActiveTest $wgCirrusSearchUseExperimentalHighlighter $wgCirrusSearchCrossProjectProfiles $wgCirrusSearchConnectionAttempts $wgCirrusSearchEnableAltLanguage $wgCirrusSearchInterleaveConfig $wgCirrusSearchPhraseRescoreWindowSize $wgCirrusSearchPrivateClusters $wgCirrusSearchCrossClusterSearch $wgCirrusSearchClientSideConnectTimeout $wgCirrusSearchPhraseSuggestUseText $wgCirrusSearchPhraseSuggestProfiles $wgCirrusSearchEnablePhraseSuggest $wgCirrusSearchInterwikiSources $wgCirrusSearchClusters $wgCirrusSearchICUNormalizationUnicodeSetFilter $wgCirrusSearchICUFoldingUnicodeSetFilter $wgCirrusSearchSlowSearch
사용된 훅 APIAfterExecute APIQuerySiteInfoGeneralInfo APIQuerySiteInfoStatisticsInfo ApiBeforeMain ArticleRevisionVisibilitySet BeforeInitialize CirrusSearchAddQueryFeatures CirrusSearchAnalysisConfig CirrusSearchSimilarityConfig GetPreferences LinksUpdateComplete PageDelete PageDeleteComplete PageMoveComplete PageUndeleteComplete PrefixSearchExtractNamespace ResourceLoaderGetConfigVars SearchGetNearMatch SearchIndexFields ShowSearchHitTitle SoftwareInfo SpecialSearchResults SpecialSearchResultsAppend SpecialStatsAddExtra TitleMove UploadComplete UserGetDefaultOptions
훅 제공 CirrusSearchAddQueryFeatures CirrusSearchAnalysisConfig CirrusSearchBuildDocumentFinishBatch CirrusSearchBuildDocumentLinks CirrusSearchBuildDocumentParse CirrusSearchFulltextQueryBuilder CirrusSearchFulltextQueryBuilderComplete CirrusSearchMappingConfig CirrusSearchProfileService CirrusSearchRegisterFullTextQueryClassifiers CirrusSearchScoreBuilder
Licence	GNU General Public License 2.0 or later
다운로드	확장 기능 다운로드 Git [?]: 저장소 보기 (Phabricator · GitHub) Gerrit 코드 리뷰 Git 커밋 기록 Download source tarball README
CirrusSearch 확장 기능 번역 (translatewiki.net에서 가능한 경우)
Vagrant 역할	cirrussearch
이슈	미해결 작업 · 버그 보고

The CirrusSearch extension implements searching for MediaWiki using Elasticsearch.

Elasticsearch is a standalone third-party software you must install as a requirement for this extension. It is a database system that provides search and indexing functionality, where the current text of your wiki pages gets indexed for faster and improved search results. The communication between MediaWiki and Elasticsearch is done through web services.

See also the help page on using this extension.

Goals

• No native dependencies that would make this difficult to install.

The only dependencies are pure-PHP, MediaWiki extensions, and Elasticsearch itself.

• Provide a near-real-time search index for wiki pages that's extendable by other MediaWiki extensions.

• Provide all of the query options MWSearch has given users, and more.

Dependencies

PHP and cURL

In addition to the standard MediaWiki requirements for PHP, CirrusSearch requires PHP to be compiled with cURL support.

Elasticsearch or OpenSearch

You must install Elasticsearch or Opensearch.

Every version of Elasticsearch changes how web services work and causes compatibility problems. You must install the version of Elasticsearch compatible with the version of MediaWiki you are currently using:

MediaWiki 1.39+ require Elasticsearch 7.10.2 (6.8.23+ is possible using a compatibility layer ). See this revision for compatibility information with earlier versions of MediaWiki.

MediaWiki 1.44+ is compatible with OpenSearch 1.3.

Elasticsearch versions before 6.8 are incompatible with PHP 8+.

Take note that a Java installation like OpenJDK is needed in addition. It's best to use the official Elasticsearch Docker image or a self-hosted version. A managed product like Amazon OpenSearch (formerly Amazon Elasticsearch) can work but may require additional configuration depending on its specifics. For example, Amazon OpenSearch only listens for Elasticsearch API requests over HTTPS on port 443 (i.e., it does not expose the default Elasticsearch port 9200), so a TLS-enabled proxy (e.g., Nginx) can enable CirrusSearch to communicate with an Amazon OpenSearch cluster.

Elastica

• Elastica is a PHP library that makes CirrusSearch talk to Elasticsearch. Install Elastica per the instructions below.

Other

• Due to the actual handling of jobs by the CirrusSearch extension, it is advisable to set up jobs in Redis to prevent messages like Notice: unserialize(): Error at offset 64870 of 65535 bytes in JobQueueDB.php and subsequent errors like Unsupported operand types.

See T157759.

설치

Elastica

Even though the instructions below tell you only to run Composer when installing from git, it may be necessary to issue it anyway to install all PHP dependencies.

• 파일을 다운로드하고 Elastica 폴더를 extensions/ 디렉토리에 넣어 주세요.
  개발자와 코딩 기여자는 Git을 이용해 확장기능을 다운받는 것이 좋습니다.

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Elastica
  

• Git에서 설치할 경우, PHP 의존 기능을 설치하려면 Composer를 실행하여 확장 기능 디렉터리에 composer install --no-dev를 발행하십시오. (잠재적인 문제에 대해서는 T173141 을 참고하십시오.)
• 아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.

  wfLoadExtension( 'Elastica' );
  

• 완료 – 위키의 ‘Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.

CirrusSearch

• 파일을 다운로드하고 CirrusSearch 폴더를 extensions/ 디렉토리에 넣어 주세요.
  개발자와 코딩 기여자는 Git을 이용해 확장기능을 다운받는 것이 좋습니다.

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CirrusSearch
  

• Git에서 설치할 경우, PHP 의존 기능을 설치하려면 Composer를 실행하여 확장 기능 디렉터리에 composer install --no-dev를 발행하십시오. (잠재적인 문제에 대해서는 T173141 을 참고하십시오.)
• 아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.

  wfLoadExtension( 'CirrusSearch' );
  

• Now follow the setup instructions in the CirrusSearch README delivered with your extension i.e. $IP/extensions/CirrusSearch/README. Note that all info in it might not apply to your version of the extension, especially the version of Elasticsearch supported.
• Configure as required.
• 완료 – 위키의 ‘Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.

Enable regex queries

This is an optional step. You will need to install the search-extra plugin for this. Do so by following these steps:

1. execute the following command:

   /usr/share/elasticsearch/bin/elasticsearch-plugin/elasticsearch-plugin install org.wikimedia.search:extra:7.10.2-wmf12
   

2. add the following line to your LocalSettings.php file:

   $wgCirrusSearchWikimediaExtraPlugin[ 'regex' ] = [ 'build', 'use', 'max_inspect' => 10000 ];
   

3. restart Elasticsearch with the following command:

   systemctl restart elasticsearch
   

4. recreate the search index by executing the following commands:

   1. php path/to/extensions/CirrusSearch/maintenance/UpdateSearchIndexConfig.php --startOver
      

   2. php path/to/extensions/CirrusSearch/maintenance/ForceSearchIndex.php
      

Upgrading

Please follow the upgrade instructions in the CirrusSearch UPGRADE file.

Configuration

The configuration parameters of CirrusSearch are documented at the "settings.txt" file. See also documentation on CirrusSearch configuration profiles.

Elasticsearch will fail to index for CirrusSearch if one uses a database name for MySQL containing a capital character, e.g., "MyWikiDatabaseName." To mitigate this, CirrusSearch provides the $wgCirrusSearchIndexBaseName configuration parameter, which one needs to set, e.g., $wgCirrusSearchIndexBaseName = 'mywikidatabasename';.

Hooks

CirrusSearch extension defines a number of hooks that other extensions can make use of to extend the core schema and modify documents. The following hooks are available:

• CirrusSearchAnalysisConfig – allows to hook into the configuration for analysis
• CirrusSearchMappingConfig – allows configuration of the mapping of fields
• CirrusSearchBuildDocumentParse – allows extensions to modify Elasticsearch document produced from a page
• CirrusSearchBuildDocumentLinks – allows extensions to process incoming and outgoing links for the document
• CirrusSearchBuildDocumentFinishBatch – called when a batch of pages has been indexed
• CirrusSearchAddQueryFeatures – allows extensions to add query parser features
• CirrusSearchScoreBuilder – allows extensions to define rescore builder functions
• CirrusSearchProfileService – allows extension to declare various search components and configuration

API

CirrusSearch features can be used in API queries. Searching happens via the normal search API, action=query&list=search; you can use CirrusSearch-specific features, such as the morelike: special prefix to find pages related to Marie Curie and radium:

api.php?action=query&list=search&srsearch=morelike:Marie_Curie%7Cradium&srlimit=10&srprop=size&formatversion=2

Custom APIs and parameters are provided for querying CirrusSearch configuration and debug information:

• action=cirrusdump module: 2014?action=cirrusdump
• cirrusDumpQuery parameter to Special:Search or search API queries: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpQuery
• cirrusDumpResult parameter to Special:Search or search API queries: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult
• An additional parameter, cirrusExplain, can be passed with cirrusDumpResult to have the Lucene explanation of the score included with the result dump: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult&cirrusExplain It can also be used to get the explanation in a human-readable format, by giving it one of the values verbose, pretty or hot, such as: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult&cirrusExplain=pretty
• cirrus-config-dump, cirrus-settings-dump, cirrus-mapping-dump, cirrus-profiles-dump modules to obtain dump from the CirrusSearch setup: api.php?action=cirrus-config-dump&formatversion=2

See also

General links

• Usage help page – CirrusSearch usage documentation (needed after the install)
• Project page
• Info about Wikimedia Cirrus/Elastic setup
• Configuration help page – sets of tunable parameters that influence various aspects of the indexing
• Extension:WikiSearch – provides faceted search API for Semantic MediaWiki using Elasticsearch.
• Extension:AdvancedSearch – Enhances Special:Search by providing advanced parameters
• Extension:SearchParserFunction – provides a search parser function that supports Cirrus Search.

Debugging

• How to determine that Cirrus is actually used as the search backend

Local development

Elasticsearch service can be run with the Vagrant role (cirrussearch) and MediaWiki Vagrant.

For Docker, you can use a command like docker run -d --name elasticsearch -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:6.8.2. Then follow the installation and configuration directions. If your web host is in a container, you'll want to make sure the above container is on the same network, and in the LocalSettings.php file, you will want to reference the elasticsearch as the hostname. This will not have the WMF plugins but can be sufficient for basic testing.