Elasticsearch:Plugin configuration

The following tables describe the built-in plug-ins and provide the Elasticsearch versions in which the plug-ins are available.

• Self-developed plug-ins

  Name	Description	Supported versions	Supported operation
  analysis-aliws	The analysis plug-in. This plug-in integrates an analyzer and a tokenizer into Elasticsearch. This lets you search for and analyze documents.	Versions 6.x and 7.x	Install, Remove, and Dictionary Configuration
  aliyun-sql	The SQL plug-in that is used to parse SQL statements. This plug-in lets you execute SQL statements to query data in Elasticsearch using the same way you query data in common databases.	V6.7 clusters created before April 2024, V6.8 clusters, and V7.7 clusters	Install and Remove
  apack	The plug-in that provides the physical replication and vector search features. The physical replication feature improves the write performance of clusters. The vector search feature implements image searches.	Versions 6.7 and 7.10	Install
  aliyun-knn	The vector search engine. This plug-in lets you use vector spaces in different search scenarios, such as image searching, video fingerprinting, facial and speech recognition, and commodity recommendation, based on your preferences.	V6.7 clusters with a kernel version of V1.2.0 or later, and V7.10 clusters. For these clusters, this plug-in is integrated into the apack plug-in by default. 6.7.0 (for Milvus versions earlier than 1.2.0), 6.8, and 7.7: Standalone installation	Install and Remove
  faster-bulk	The plug-in that aggregates bulk write requests in batches. This plug-in implements the aggregation based on specific maximum request size and aggregation interval. This plug-in improves write throughput and reduces write request rejections.	Versions 6.7, 7.10, and 7.16	Install and Remove
  codec-compression	The index compression plug-in. This plug-in supports the Brotli and zstd compression algorithms and provides a higher index compression ratio. This significantly reduces the storage costs of indexes.	V6.7 clusters created before April 2024	Install and Remove
  aliyun-qos	The throttling plug-in. This plug-in implements node-level read and write throttling and reduces the priority of specific indexes when required.	Versions 6.x and 7.x Note You can upgrade the aliyun-qos plug-in to rc4 only for an Alibaba Cloud Elasticsearch cluster of V6.7.0 or later.	Install
  gig	The plug-in that implements throttling for client nodes in an Elasticsearch cluster. This plug-in performs a switchover within seconds to address query jitters, and detects traffic to handle the surges in query latency caused by enabled warm nodes.	Version 7.10 is integrated into the aliyun-qos plugin by default.	Install and Remove

• Open source plug-ins

  Name	Description	Applicable versions	Supported operation
  analysis-ik	The IK analysis plug-in. This plug-in integrates the IK analyzer of Apache Lucene into Elasticsearch and supports custom dictionaries.	All	Cold and Hot Updates Important Elasticsearch clusters of V7.16 or later and Elasticsearch V7.10 clusters deployed based on the new cloud-native control architecture in some regions do not allow you to perform the Standard Update operation for the analysis-ik plug-in.
  analysis-icu	The ICU analysis plugin integrates the ICU module and provides ICU analysis components.	All	Install and Remove
  analysis-kuromoji	The Japanese (Kuromoji) analysis plug-in. This plug-in integrates the Lucene Kuromoji analysis module into Elasticsearch.	All	Install and Remove
  analysis-phonetic	The Phonetic Analysis plugin includes a token filter.	All	Install and Remove
  analysis-pinyin	The Pinyin analysis plug-in.	All	Install and Remove
  analysis-smartcn	The smart Chinese analysis plug-in. This plug-in integrates the Lucene smart Chinese analysis module into Elasticsearch.	All	Install and Remove
  elasticsearch-repository-oss	The plug-in that stores snapshots. This plug-in lets you use Alibaba Cloud Object Storage Service (OSS) to store Elasticsearch snapshots.	5.x	None
  ingest-attachment	The preprocessor uses Apache Tika to extract content.	All	Install and Remove
  ingest-geoip	The ingest geoip processor. This plug-in queries geographic data in MaxMind databases based on IP addresses.	5.x	Install and Remove
  ingest-user-agent	The preprocessor can extract information from the User-Agent.	5.x	Install and Remove
  analysis-stconvert	The STConvert plugin converts between Simplified Chinese and Traditional Chinese.	Clusters of a version earlier than V7.10	Install and Remove
  mapper-attachments	The plug-in that lets you use Apache Tika to add attachments of more than 1,000 types of formats, such as PPT, XLS, and PDF, when you create indexes.	5.x	Install and Remove
  mapper-murmur3	The plug-in that computes the hash values of field values when you create an index and stores the hash values in the index.	All	Install and Remove
  mapper-size	The plug-in that lets you record the size of documents before they are compressed when you create an index.	All	Install and Remove
  repository-hdfs	The plug-in that provides full support for Hadoop Distributed File System (HDFS) repositories.	All	Install and Remove
  sql	The SQL query plug-in.	5.5.3	Install and Remove
  x-pack	An Elasticsearch extension that provides security, alerting, monitoring, reporting, and graph capabilities in an all-in-one easy-to-install package. X-Pack is integrated into Kibana to provide capabilities, such as authorization and authentication, role-based access control, real-time monitoring, visual reporting, and machine learning.	5.x	None
  analysis-vietnamese	The Vietnamese analysis plug-in. Important This plug-in can be installed only for Elasticsearch clusters in the China (Hangzhou), China (Shanghai), China (Beijing), and China (Shenzhen) regions.	V7.10 clusters with a kernel version of V1.8.0	Install and Remove

  Note

  • As the rapid iteration of open source Elasticsearch, open source plug-ins may not be provided on the Built-in Plug-ins tab of the Alibaba Cloud Elasticsearch console in a timely manner for Alibaba Cloud Elasticsearch clusters of later versions. You can view the actual system plug-ins supported by an Alibaba Cloud Elasticsearch cluster in the console.

  • When you upload a tokenizer plug-in, each dictionary file must be at least 10 bytes in size.