This repository has been archived by the owner on Aug 2, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add settings to disable/enable AD dynamically (#105)
This PR adds settings to disable/enable AD dynamically. AD plugin rejects RESTful requests and stops AD jobs when it is disabled. Testing done: - added tests to verify if AD plugin rejects RESTful requests when it is disabled - manually verified AD jobs are stopped when AD plugin is disabled
- Loading branch information
Showing
15 changed files
with
391 additions
and
19 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
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
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
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
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
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
111 changes: 111 additions & 0 deletions
111
src/main/java/com/amazon/opendistroforelasticsearch/ad/settings/EnabledSetting.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,111 @@ | ||
| /* | ||
| * Copyright 2020 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.ad.settings; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.elasticsearch.cluster.service.ClusterService; | ||
| import org.elasticsearch.common.settings.Setting; | ||
| import org.elasticsearch.common.settings.Settings; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
|
|
||
| import static java.util.Collections.unmodifiableMap; | ||
| import static org.elasticsearch.common.settings.Setting.Property.Dynamic; | ||
| import static org.elasticsearch.common.settings.Setting.Property.NodeScope; | ||
|
|
||
| public class EnabledSetting { | ||
|
|
||
| private static Logger logger = LogManager.getLogger(EnabledSetting.class); | ||
|
|
||
| /** | ||
| * Singleton instance | ||
| */ | ||
| private static EnabledSetting INSTANCE; | ||
|
|
||
| /** | ||
| * Settings name | ||
| */ | ||
| public static final String AD_PLUGIN_ENABLED = "opendistro.anomaly_detection.enabled"; | ||
|
|
||
| private final Map<String, Setting<?>> settings = unmodifiableMap(new HashMap<String, Setting<?>>() { | ||
| { | ||
| /** | ||
| * AD plugin enable/disable setting | ||
| */ | ||
| put(AD_PLUGIN_ENABLED, Setting.boolSetting(AD_PLUGIN_ENABLED, true, NodeScope, Dynamic)); | ||
| } | ||
| }); | ||
|
|
||
| /** Latest setting value for each registered key. Thread-safe is required. */ | ||
| private final Map<String, Object> latestSettings = new ConcurrentHashMap<>(); | ||
|
|
||
| private ClusterService clusterService; | ||
|
|
||
| private EnabledSetting() {} | ||
|
|
||
| public static synchronized EnabledSetting getInstance() { | ||
| if (INSTANCE == null) { | ||
| INSTANCE = new EnabledSetting(); | ||
| } | ||
| return INSTANCE; | ||
| } | ||
|
|
||
| private void setSettingsUpdateConsumers() { | ||
| for (Setting<?> setting : settings.values()) { | ||
| clusterService.getClusterSettings().addSettingsUpdateConsumer(setting, newVal -> { | ||
| logger.info("[AD] The value of setting [{}] changed to [{}]", setting.getKey(), newVal); | ||
| latestSettings.put(setting.getKey(), newVal); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get setting value by key. Return default value if not configured explicitly. | ||
| * | ||
| * @param key setting key. | ||
| * @param <T> Setting type | ||
| * @return T setting value or default | ||
| */ | ||
| @SuppressWarnings("unchecked") | ||
| public <T> T getSettingValue(String key) { | ||
| return (T) latestSettings.getOrDefault(key, getSetting(key).getDefault(Settings.EMPTY)); | ||
| } | ||
|
|
||
| private Setting<?> getSetting(String key) { | ||
| if (settings.containsKey(key)) { | ||
| return settings.get(key); | ||
| } | ||
| throw new IllegalArgumentException("Cannot find setting by key [" + key + "]"); | ||
| } | ||
|
|
||
| public static boolean isADPluginEnabled() { | ||
| return EnabledSetting.getInstance().getSettingValue(EnabledSetting.AD_PLUGIN_ENABLED); | ||
| } | ||
|
|
||
| public void init(ClusterService clusterService) { | ||
| this.clusterService = clusterService; | ||
| setSettingsUpdateConsumers(); | ||
| } | ||
|
|
||
| public List<Setting<?>> getSettings() { | ||
| return new ArrayList<>(settings.values()); | ||
| } | ||
| } |
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.