honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/cat/plugins.asciidoc

38 lines
2.9 KiB
Plaintext
Raw Normal View History

Add _cat/plugins endpoint If we want to have a full picture of versions running in a cluster, we need to add a `_cat/plugins` endpoint. Response could look like: ```sh % curl es2:9200/_cat/plugins?v node component version type url desc es1 mapper-attachments 1.7.0 j Adds the attachment type allowing to parse difference attachment formats es1 lang-javascript 1.4.0 j JavaScript plugin allowing to add javascript scripting support es1 analysis-smartcn 1.9.0 j Smart Chinese analysis support es1 marvel 1.1.0 j/s http://localhost:9200/_plugins/marvel Elasticsearch Management & Monitoring es1 kopf 0.5.3 s http://localhost:9200/_plugins/kopf kopf - simple web administration tool for ElasticSearch es2 mapper-attachments 2.0.0.RC1 j Adds the attachment type allowing to parse difference attachment formats es2 lang-javascript 2.0.0.RC1 j JavaScript plugin allowing to add javascript scripting support es2 analysis-smartcn 2.0.0.RC1 j Smart Chinese analysis support ``` Closes #4824.
2014-03-16 07:14:44 -04:00
[[cat-plugins]]
[DOCS] Renamed the "cat" chapters to be more searchable
2014-05-16 15:43:35 -04:00
== cat plugins
Add _cat/plugins endpoint If we want to have a full picture of versions running in a cluster, we need to add a `_cat/plugins` endpoint. Response could look like: ```sh % curl es2:9200/_cat/plugins?v node component version type url desc es1 mapper-attachments 1.7.0 j Adds the attachment type allowing to parse difference attachment formats es1 lang-javascript 1.4.0 j JavaScript plugin allowing to add javascript scripting support es1 analysis-smartcn 1.9.0 j Smart Chinese analysis support es1 marvel 1.1.0 j/s http://localhost:9200/_plugins/marvel Elasticsearch Management & Monitoring es1 kopf 0.5.3 s http://localhost:9200/_plugins/kopf kopf - simple web administration tool for ElasticSearch es2 mapper-attachments 2.0.0.RC1 j Adds the attachment type allowing to parse difference attachment formats es2 lang-javascript 2.0.0.RC1 j JavaScript plugin allowing to add javascript scripting support es2 analysis-smartcn 2.0.0.RC1 j Smart Chinese analysis support ``` Closes #4824.
2014-03-16 07:14:44 -04:00
The `plugins` command provides a view per node of running plugins. This information *spans nodes*.
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
[source,js]
Add _cat/plugins endpoint If we want to have a full picture of versions running in a cluster, we need to add a `_cat/plugins` endpoint. Response could look like: ```sh % curl es2:9200/_cat/plugins?v node component version type url desc es1 mapper-attachments 1.7.0 j Adds the attachment type allowing to parse difference attachment formats es1 lang-javascript 1.4.0 j JavaScript plugin allowing to add javascript scripting support es1 analysis-smartcn 1.9.0 j Smart Chinese analysis support es1 marvel 1.1.0 j/s http://localhost:9200/_plugins/marvel Elasticsearch Management & Monitoring es1 kopf 0.5.3 s http://localhost:9200/_plugins/kopf kopf - simple web administration tool for ElasticSearch es2 mapper-attachments 2.0.0.RC1 j Adds the attachment type allowing to parse difference attachment formats es2 lang-javascript 2.0.0.RC1 j JavaScript plugin allowing to add javascript scripting support es2 analysis-smartcn 2.0.0.RC1 j Smart Chinese analysis support ``` Closes #4824.
2014-03-16 07:14:44 -04:00
------------------------------------------------------------------------------
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
GET /_cat/plugins?v&s=component&h=name,component,version,description
------------------------------------------------------------------------------
// CONSOLE
Might look like:
["source","txt",subs="attributes,callouts"]
------------------------------------------------------------------------------
name component version description
U7321H6 analysis-icu {version} The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.
U7321H6 analysis-kuromoji {version} The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.
U7321H6 analysis-phonetic {version} The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.
U7321H6 analysis-smartcn {version} Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.
U7321H6 analysis-stempel {version} The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.
Docs: Adding Ukrainian analyzer
2016-10-28 11:19:33 -04:00
U7321H6 analysis-ukrainian {version} The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
U7321H6 discovery-azure-classic {version} The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism
U7321H6 discovery-ec2 {version} The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.
U7321H6 discovery-file {version} Discovery file plugin enables unicast discovery from hosts stored in a file.
U7321H6 discovery-gce {version} The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.
U7321H6 ingest-attachment {version} Ingest processor that uses Apache Tika to extract contents
U7321H6 ingest-geoip {version} Ingest processor that uses looksup geo data based on ip adresses using the Maxmind geo database
U7321H6 ingest-user-agent {version} Ingest processor that extracts information from a user agent
U7321H6 mapper-murmur3 {version} The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.
U7321H6 mapper-size {version} The Mapper Size plugin allows document to record their uncompressed size at index time.
U7321H6 store-smb {version} The Store SMB plugin adds support for SMB stores.
Replace jvm-example by two plugin examples (#28339) This pull request replaces the jvm-example plugin (from the jvm/site plugins era) by two new plugins: a custom-settings that shows how to register and use custom settings (including secured settings) in a plugin, and rest-handler plugin that shows how to register a rest handler. The two plugins now reside in the plugins/examples project. They can serve as sample plugins for users, a special attention has been put on documentation. The packaging tests have been adapted to use the custom-settings plugin.
2018-01-26 11:34:24 -05:00
U7321H6 transport-nio {version} The nio transport.
Made the same length of opening and closing lines (#23583)
2017-06-09 03:50:43 -04:00
------------------------------------------------------------------------------
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
// TESTRESPONSE[s/([.()])/\\$1/ s/U7321H6/.+/ _cat]
Add _cat/plugins endpoint If we want to have a full picture of versions running in a cluster, we need to add a `_cat/plugins` endpoint. Response could look like: ```sh % curl es2:9200/_cat/plugins?v node component version type url desc es1 mapper-attachments 1.7.0 j Adds the attachment type allowing to parse difference attachment formats es1 lang-javascript 1.4.0 j JavaScript plugin allowing to add javascript scripting support es1 analysis-smartcn 1.9.0 j Smart Chinese analysis support es1 marvel 1.1.0 j/s http://localhost:9200/_plugins/marvel Elasticsearch Management & Monitoring es1 kopf 0.5.3 s http://localhost:9200/_plugins/kopf kopf - simple web administration tool for ElasticSearch es2 mapper-attachments 2.0.0.RC1 j Adds the attachment type allowing to parse difference attachment formats es2 lang-javascript 2.0.0.RC1 j JavaScript plugin allowing to add javascript scripting support es2 analysis-smartcn 2.0.0.RC1 j Smart Chinese analysis support ``` Closes #4824.
2014-03-16 07:14:44 -04:00
We can tell quickly how many plugins per node we have and which versions.