-
Notifications
You must be signed in to change notification settings - Fork 24.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
List of existing plugins with Node Info API #2668
Comments
hey @dadoonet what is the status of this? |
didn't we say that next the the node info api we'll have a |
Would it be possible to get also JSON output? |
Yes, the idea is that plugins will return as part of nodes info, not using this endpoint at the end. |
@dadoonet is it possible to rename the plugin type 'java" to something like 'jvm' or 'classpath', since plugins can be written not only in Java but in any JVM language? |
@jprante Agree. Done. |
Plugin developpers can now add a version number to their es-plugin.properties file: ```properties plugin=org.elasticsearch.test.integration.nodesinfo.TestPlugin version=0.0.7-SNAPSHOT ``` Also, for site plugins, it's recommended to add a `es-plugin.properties` file in root site directory with `description` and `version` properties: ```properties description=This is a description for a dummy test site plugin. version=0.0.7-BOND-SITE ``` When running Nodes Info API, you will get information on versions: ```sh $ curl 'http://localhost:9200/_nodes?plugin=true&pretty' ``` ```javascript { "ok" : true, "cluster_name" : "test-cluster-MacBook-Air-de-David.local", "nodes" : { "RHMsToxiRcCXwHiS6mEaFw" : { "name" : "node2", "transport_address" : "inet[/192.168.0.15:9301]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9201]", "plugins" : [ { "name" : "dummy", "version" : "0.0.7-BOND-SITE", "description" : "This is a description for a dummy test site plugin.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] }, "IKiUOo-LSCq1Km1GUhBwPg" : { "name" : "node3", "transport_address" : "inet[/192.168.0.15:9302]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9202]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true } ] }, "H64dcSF2R_GNWh6XRCYZJA" : { "name" : "node1", "transport_address" : "inet[/192.168.0.15:9300]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9200]", "plugins" : [ ] }, "mGEZcYl8Tye0Rm5AACBhPA" : { "name" : "node4", "transport_address" : "inet[/192.168.0.15:9303]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9203]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true }, { "name" : "test-no-version-plugin", "version" : "NA", "description" : "test-no-version-plugin description", "site" : false, "jvm" : true }, { "name" : "dummy", "version" : "NA", "description" : "No description found for dummy.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] } } } ``` Relative to elastic#2668. Closes elastic#2784.
Plugin developpers can now add a version number to their es-plugin.properties file: ```properties plugin=org.elasticsearch.test.integration.nodesinfo.TestPlugin version=0.0.7-SNAPSHOT ``` Also, for site plugins, it's recommended to add a `es-plugin.properties` file in root site directory with `description` and `version` properties: ```properties description=This is a description for a dummy test site plugin. version=0.0.7-BOND-SITE ``` When running Nodes Info API, you will get information on versions: ```sh $ curl 'http://localhost:9200/_nodes?plugin=true&pretty' ``` ```javascript { "ok" : true, "cluster_name" : "test-cluster-MacBook-Air-de-David.local", "nodes" : { "RHMsToxiRcCXwHiS6mEaFw" : { "name" : "node2", "transport_address" : "inet[/192.168.0.15:9301]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9201]", "plugins" : [ { "name" : "dummy", "version" : "0.0.7-BOND-SITE", "description" : "This is a description for a dummy test site plugin.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] }, "IKiUOo-LSCq1Km1GUhBwPg" : { "name" : "node3", "transport_address" : "inet[/192.168.0.15:9302]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9202]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true } ] }, "H64dcSF2R_GNWh6XRCYZJA" : { "name" : "node1", "transport_address" : "inet[/192.168.0.15:9300]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9200]", "plugins" : [ ] }, "mGEZcYl8Tye0Rm5AACBhPA" : { "name" : "node4", "transport_address" : "inet[/192.168.0.15:9303]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9203]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true }, { "name" : "test-no-version-plugin", "version" : "NA", "description" : "test-no-version-plugin description", "site" : false, "jvm" : true }, { "name" : "dummy", "version" : "NA", "description" : "No description found for dummy.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] } } } ``` Relative to #2668. Closes #2784.
Plugin developpers can now add a version number to their es-plugin.properties file: ```properties plugin=org.elasticsearch.test.integration.nodesinfo.TestPlugin version=0.0.7-SNAPSHOT ``` Also, for site plugins, it's recommended to add a `es-plugin.properties` file in root site directory with `description` and `version` properties: ```properties description=This is a description for a dummy test site plugin. version=0.0.7-BOND-SITE ``` When running Nodes Info API, you will get information on versions: ```sh $ curl 'http://localhost:9200/_nodes?plugin=true&pretty' ``` ```javascript { "ok" : true, "cluster_name" : "test-cluster-MacBook-Air-de-David.local", "nodes" : { "RHMsToxiRcCXwHiS6mEaFw" : { "name" : "node2", "transport_address" : "inet[/192.168.0.15:9301]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9201]", "plugins" : [ { "name" : "dummy", "version" : "0.0.7-BOND-SITE", "description" : "This is a description for a dummy test site plugin.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] }, "IKiUOo-LSCq1Km1GUhBwPg" : { "name" : "node3", "transport_address" : "inet[/192.168.0.15:9302]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9202]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true } ] }, "H64dcSF2R_GNWh6XRCYZJA" : { "name" : "node1", "transport_address" : "inet[/192.168.0.15:9300]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9200]", "plugins" : [ ] }, "mGEZcYl8Tye0Rm5AACBhPA" : { "name" : "node4", "transport_address" : "inet[/192.168.0.15:9303]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9203]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true }, { "name" : "test-no-version-plugin", "version" : "NA", "description" : "test-no-version-plugin description", "site" : false, "jvm" : true }, { "name" : "dummy", "version" : "NA", "description" : "No description found for dummy.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] } } } ``` Relative to #2668. Closes #2784.
Plugin developpers can now add a version number to their es-plugin.properties file: ```properties plugin=org.elasticsearch.test.integration.nodesinfo.TestPlugin version=0.0.7-SNAPSHOT ``` Also, for site plugins, it's recommended to add a `es-plugin.properties` file in root site directory with `description` and `version` properties: ```properties description=This is a description for a dummy test site plugin. version=0.0.7-BOND-SITE ``` When running Nodes Info API, you will get information on versions: ```sh $ curl 'http://localhost:9200/_nodes?plugin=true&pretty' ``` ```javascript { "ok" : true, "cluster_name" : "test-cluster-MacBook-Air-de-David.local", "nodes" : { "RHMsToxiRcCXwHiS6mEaFw" : { "name" : "node2", "transport_address" : "inet[/192.168.0.15:9301]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9201]", "plugins" : [ { "name" : "dummy", "version" : "0.0.7-BOND-SITE", "description" : "This is a description for a dummy test site plugin.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] }, "IKiUOo-LSCq1Km1GUhBwPg" : { "name" : "node3", "transport_address" : "inet[/192.168.0.15:9302]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9202]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true } ] }, "H64dcSF2R_GNWh6XRCYZJA" : { "name" : "node1", "transport_address" : "inet[/192.168.0.15:9300]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9200]", "plugins" : [ ] }, "mGEZcYl8Tye0Rm5AACBhPA" : { "name" : "node4", "transport_address" : "inet[/192.168.0.15:9303]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9203]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true }, { "name" : "test-no-version-plugin", "version" : "NA", "description" : "test-no-version-plugin description", "site" : false, "jvm" : true }, { "name" : "dummy", "version" : "NA", "description" : "No description found for dummy.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] } } } ``` Relative to #2668. Closes #2784.
Plugin developpers can now add a version number to their es-plugin.properties file: ```properties plugin=org.elasticsearch.test.integration.nodesinfo.TestPlugin version=0.0.7-SNAPSHOT ``` Also, for site plugins, it's recommended to add a `es-plugin.properties` file in root site directory with `description` and `version` properties: ```properties description=This is a description for a dummy test site plugin. version=0.0.7-BOND-SITE ``` When running Nodes Info API, you will get information on versions: ```sh $ curl 'http://localhost:9200/_nodes?plugin=true&pretty' ``` ```javascript { "ok" : true, "cluster_name" : "test-cluster-MacBook-Air-de-David.local", "nodes" : { "RHMsToxiRcCXwHiS6mEaFw" : { "name" : "node2", "transport_address" : "inet[/192.168.0.15:9301]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9201]", "plugins" : [ { "name" : "dummy", "version" : "0.0.7-BOND-SITE", "description" : "This is a description for a dummy test site plugin.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] }, "IKiUOo-LSCq1Km1GUhBwPg" : { "name" : "node3", "transport_address" : "inet[/192.168.0.15:9302]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9202]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true } ] }, "H64dcSF2R_GNWh6XRCYZJA" : { "name" : "node1", "transport_address" : "inet[/192.168.0.15:9300]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9200]", "plugins" : [ ] }, "mGEZcYl8Tye0Rm5AACBhPA" : { "name" : "node4", "transport_address" : "inet[/192.168.0.15:9303]", "hostname" : "MacBook-Air-de-David.local", "version" : "0.90.0.Beta2-SNAPSHOT", "http_address" : "inet[/192.168.0.15:9203]", "plugins" : [ { "name" : "test-plugin", "version" : "0.0.7-SNAPSHOT", "description" : "test-plugin description", "site" : false, "jvm" : true }, { "name" : "test-no-version-plugin", "version" : "NA", "description" : "test-no-version-plugin description", "site" : false, "jvm" : true }, { "name" : "dummy", "version" : "NA", "description" : "No description found for dummy.", "url" : "/_plugin/dummy/", "site" : true, "jvm" : false } ] } } } ``` Relative to elastic#2668. Closes elastic#2784.
We want to display information about loaded plugins in Node Info API using plugin option:
curl http://localhost:9200/_nodes?plugin=true
For example, on a 4 nodes cluster, it could provide the following output:
Information are cached for 10 seconds by default. Modify
plugins.info_refresh_interval
property if needed.Setting
plugins.info_refresh_interval
to-1
will cause infinite caching.Setting
plugins.info_refresh_interval
to0
will disable caching.The text was updated successfully, but these errors were encountered: