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

Update plugin-related output in reference docs (#25897) 

The example output for node info and cluster stats was outdated w.r.t.
to the information that is shown for plugins. With this commit we
updated the example output and update the explanation of the respective
fields.
This commit is contained in:
Daniel Mitterdorfer 2017-07-28 11:27:54 +02:00 committed by GitHub
parent 1a01514081
commit db90455afd
2 changed files with 53 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
docs/reference/cluster/nodes-info.asciidoc
View File

@ -113,45 +113,46 @@ the current running process:
[[plugins-info]] [[plugins-info]]
==== Plugins information ==== Plugins information
`plugins` - if set, the result will contain details about the loaded `plugins` - if set, the result will contain details about the installed plugins
plugins per node: per node:
* `name`: plugin name * `name`: plugin name
* `description`: plugin description if any * `version`: version of Elasticsearch the plugin was built for
* `site`: `true` if the plugin is a site plugin * `description`: short description of the plugin's purpose
* `jvm`: `true` if the plugin is a plugin running in the JVM * `classname`: fully-qualified class name of the plugin's entry point
* `url`: URL if the plugin is a site plugin * `has_native_controller`: whether or not the plugin has a native controller process
The result will look similar to: The result will look similar to:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
{ {
"cluster_name" : "test-cluster-MacBook-Air-de-David.local", "cluster_name": "elasticsearch",
"nodes" : { "nodes": {
"hJLXmY_NTrCytiIMbX4_1g" : { "O70_wBv6S9aPPcAKdSUBtw": {
"name" : "node4", "plugins": [
"transport_address" : "inet[/172.18.58.139:9303]", {
"hostname" : "MacBook-Air-de-David.local", "name": "analysis-icu",
"version" : "0.90.0.Beta2-SNAPSHOT", "version": "{version}",
"http_address" : "inet[/172.18.58.139:9203]", "description": "The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.",
"plugins" : [ { "classname": "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
"name" : "test-plugin", "has_native_controller": false
"description" : "test-plugin description", },
"site" : true, {
"jvm" : false "name": "ingest-geoip",
}, { "version": "{version}",
"name" : "test-no-version-plugin", "description": "Ingest processor that uses looksup geo data based on ip adresses using the Maxmind geo database",
"description" : "test-no-version-plugin description", "classname": "org.elasticsearch.ingest.geoip.IngestGeoIpPlugin",
"site" : true, "has_native_controller": false
"jvm" : false },
}, { {
"name" : "dummy", "name": "ingest-user-agent",
"description" : "No description found for dummy.", "version": "{version}",
"url" : "/_plugin/dummy/", "description": "Ingest processor that extracts information from a user agent",
"site" : false, "classname": "org.elasticsearch.ingest.useragent.IngestUserAgentPlugin",
"jvm" : true "has_native_controller": false
} ] }
]
} }
} }
} }

28
docs/reference/cluster/stats.asciidoc
View File

@ -167,13 +167,27 @@ Will return, for example:
"available_in_bytes": 34802409472 "available_in_bytes": 34802409472
}, },
"plugins": [ "plugins": [
// all plugins installed on nodes {
{ "name": "analysis-icu",
"name": "analysis-stempel", "version": "{version}",
"version": "{version}", "description": "The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.",
"description": "The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.", "classname": "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
"classname": "org.elasticsearch.plugin.analysis.stempel.AnalysisStempelPlugin" "has_native_controller": false
} },
{
"name": "ingest-geoip",
"version": "{version}",
"description": "Ingest processor that uses looksup geo data based on ip adresses using the Maxmind geo database",
"classname": "org.elasticsearch.ingest.geoip.IngestGeoIpPlugin",
"has_native_controller": false
},
{
"name": "ingest-user-agent",
"version": "{version}",
"description": "Ingest processor that extracts information from a user agent",
"classname": "org.elasticsearch.ingest.useragent.IngestUserAgentPlugin",
"has_native_controller": false
}
] ]
} }
} }