Elasticsearch plugin custom settings

jiboxiv · October 26, 2018, 11:35pm

Hi,

I wish to create an Elasticsearch plugin, this plugin requires some settings to be stored and to be mutable. I have found in some threads using the onModule() function. But this does not seem to exist in the 6.2 plugin.

Could someone provide me with more information about how to add settings to cluster / make them mutable, or even better provide me with an example?

Thanks!

dadoonet · October 27, 2018, 12:44am

Not sure if this is what you want but look at

github.com

elastic/elasticsearch/blob/master/plugins/repository-gcs/src/main/java/org/elasticsearch/repositories/gcs/GoogleCloudStorageClientSettings.java

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.elasticsearch.repositories.gcs;

This file has been truncated. show original

And

github.com

elastic/elasticsearch/blob/master/plugins/repository-gcs/src/main/java/org/elasticsearch/repositories/gcs/GoogleCloudStoragePlugin.java

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.repositories.gcs;

This file has been truncated. show original

jiboxiv · October 29, 2018, 8:35pm

Hi David,

This looks helpful, but I don't see / understand how these settings will become mutable?

A basic example is foo.bar.baz.enabled = true

I want to be able to set this flag to false. I don't see anywhere in your code where you allow for such a thing?

Thanks!

rjernst · October 29, 2018, 9:15pm

Take a look at the example custom settings plugin. In particular, you want a Setting object created with the Property.Dynamic. You will also most likely want to have your plugin depend on the ClusterService, and call clusterService.getClusterSettings().addSettingsUpdateConsumer to get notified when the setting changes (assuming the setting is cluster wide).

system · November 26, 2018, 9:15pm

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.