forked from opendistro-for-elasticsearch/sql
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New SQL cluster settings endpoint (opendistro-for-elasticsearch#400)
* Add new _sql/settings endpoint, and logic to only affect opendistro.sql settings * Add integration tests * Change endpoint HTTP method to PUT * Update Settings doc
- Loading branch information
Showing
6 changed files
with
530 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
src/main/java/com/amazon/opendistroforelasticsearch/sql/plugin/RestSqlSettingsAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| /* | ||
| * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 com.amazon.opendistroforelasticsearch.sql.plugin; | ||
|
|
||
| import com.amazon.opendistroforelasticsearch.sql.executor.format.ErrorMessageFactory; | ||
|
|
||
| import com.amazon.opendistroforelasticsearch.sql.utils.LogUtils; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.elasticsearch.ElasticsearchGenerationException; | ||
| import org.elasticsearch.action.admin.cluster.settings.ClusterUpdateSettingsRequest; | ||
| import org.elasticsearch.client.Requests; | ||
| import org.elasticsearch.client.node.NodeClient; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentFactory; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.common.xcontent.XContentType; | ||
| import org.elasticsearch.rest.BaseRestHandler; | ||
| import org.elasticsearch.rest.BytesRestResponse; | ||
| import org.elasticsearch.rest.RestController; | ||
| import org.elasticsearch.rest.RestRequest; | ||
| import org.elasticsearch.rest.action.RestToXContentListener; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| import static org.elasticsearch.rest.RestStatus.INTERNAL_SERVER_ERROR; | ||
|
|
||
| /** | ||
| * Interface to manage opendistro.sql.* cluster settings | ||
| * All non-sql settings are ignored. | ||
| * Any non-transient and non-persistent settings are ignored. | ||
| */ | ||
| public class RestSqlSettingsAction extends BaseRestHandler { | ||
| private static final Logger LOG = LogManager.getLogger(RestSqlSettingsAction.class); | ||
|
|
||
| private static final String PERSISTENT = "persistent"; | ||
| private static final String TRANSIENT = "transient"; | ||
| private static final String SQL_SETTINGS_PREFIX = "opendistro.sql."; | ||
|
|
||
| /** | ||
| * API endpoint path | ||
| */ | ||
| public static final String SETTINGS_API_ENDPOINT = "/_opendistro/_sql/settings"; | ||
|
|
||
| public RestSqlSettingsAction(Settings settings, RestController restController) { | ||
| super(); | ||
| restController.registerHandler(RestRequest.Method.PUT, SETTINGS_API_ENDPOINT, this); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return "sql_settings_action"; | ||
| } | ||
|
|
||
| /** | ||
| * @see org.elasticsearch.rest.action.admin.cluster.RestClusterUpdateSettingsAction | ||
| */ | ||
| @Override | ||
| protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException { | ||
| LogUtils.addRequestId(); | ||
| final ClusterUpdateSettingsRequest clusterUpdateSettingsRequest = Requests.clusterUpdateSettingsRequest(); | ||
| clusterUpdateSettingsRequest.timeout(request.paramAsTime("timeout", clusterUpdateSettingsRequest.timeout())); | ||
| clusterUpdateSettingsRequest.masterNodeTimeout( | ||
| request.paramAsTime("master_timeout", clusterUpdateSettingsRequest.masterNodeTimeout())); | ||
| Map<String, Object> source; | ||
| try (XContentParser parser = request.contentParser()) { | ||
| source = parser.map(); | ||
| } | ||
|
|
||
| try { | ||
| if (source.containsKey(TRANSIENT)) { | ||
| clusterUpdateSettingsRequest.transientSettings(getAndFilterSettings((Map) source.get(TRANSIENT))); | ||
| } | ||
| if (source.containsKey(PERSISTENT)) { | ||
| clusterUpdateSettingsRequest.persistentSettings(getAndFilterSettings((Map) source.get(PERSISTENT))); | ||
| } | ||
|
|
||
| return channel -> client.admin().cluster().updateSettings( | ||
| clusterUpdateSettingsRequest, new RestToXContentListener<>(channel)); | ||
| } catch (Exception e) { | ||
| LOG.error("Error changing OpenDistro SQL plugin cluster settings", e); | ||
| return channel -> channel.sendResponse(new BytesRestResponse(INTERNAL_SERVER_ERROR, | ||
| ErrorMessageFactory.createErrorMessage(e, INTERNAL_SERVER_ERROR.getStatus()).toString())); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected Set<String> responseParams() { | ||
| Set<String> responseParams = new HashSet<>(super.responseParams()); | ||
| responseParams.addAll(Arrays.asList("sql", "flat", "separator", "_score", "_type", "_id", "newLine", "format")); | ||
| return responseParams; | ||
| } | ||
|
|
||
| private Settings getAndFilterSettings(Map<String, ?> source) { | ||
| try { | ||
| XContentBuilder builder = XContentFactory.contentBuilder(XContentType.JSON); | ||
| builder.map(source); | ||
| Settings.Builder settingsBuilder = Settings.builder(). | ||
| loadFromSource(Strings.toString(builder), builder.contentType()); | ||
| settingsBuilder.keys().removeIf(key -> !key.startsWith(SQL_SETTINGS_PREFIX)); | ||
| return settingsBuilder.build(); | ||
| } catch (IOException e) { | ||
| throw new ElasticsearchGenerationException("Failed to generate [" + source + "]", e); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.