|
| 1 | +/* |
| 2 | + * SPDX-License-Identifier: Apache-2.0 |
| 3 | + * |
| 4 | + * The OpenSearch Contributors require contributions made to |
| 5 | + * this file be licensed under the Apache-2.0 license or a |
| 6 | + * compatible open source license. |
| 7 | + */ |
| 8 | + |
| 9 | +package org.opensearch.ratelimitting.admissioncontrol; |
| 10 | + |
| 11 | +import org.apache.logging.log4j.LogManager; |
| 12 | +import org.apache.logging.log4j.Logger; |
| 13 | +import org.opensearch.common.settings.ClusterSettings; |
| 14 | +import org.opensearch.common.settings.Settings; |
| 15 | +import org.opensearch.ratelimitting.admissioncontrol.controllers.AdmissionController; |
| 16 | +import org.opensearch.ratelimitting.admissioncontrol.controllers.CPUBasedAdmissionController; |
| 17 | +import org.opensearch.threadpool.ThreadPool; |
| 18 | + |
| 19 | +import java.util.ArrayList; |
| 20 | +import java.util.List; |
| 21 | +import java.util.concurrent.ConcurrentHashMap; |
| 22 | +import java.util.concurrent.ConcurrentMap; |
| 23 | + |
| 24 | +import static org.opensearch.ratelimitting.admissioncontrol.settings.CPUBasedAdmissionControllerSettings.CPU_BASED_ADMISSION_CONTROLLER; |
| 25 | + |
| 26 | +/** |
| 27 | + * Admission control Service that bootstraps and manages all the Admission Controllers in OpenSearch. |
| 28 | + */ |
| 29 | +public class AdmissionControlService { |
| 30 | + private final ThreadPool threadPool; |
| 31 | + public final AdmissionControlSettings admissionControlSettings; |
| 32 | + private final ConcurrentMap<String, AdmissionController> ADMISSION_CONTROLLERS; |
| 33 | + private static final Logger logger = LogManager.getLogger(AdmissionControlService.class); |
| 34 | + private final ClusterSettings clusterSettings; |
| 35 | + private final Settings settings; |
| 36 | + |
| 37 | + /** |
| 38 | + * |
| 39 | + * @param settings Immutable settings instance |
| 40 | + * @param clusterSettings ClusterSettings Instance |
| 41 | + * @param threadPool ThreadPool Instance |
| 42 | + */ |
| 43 | + public AdmissionControlService(Settings settings, ClusterSettings clusterSettings, ThreadPool threadPool) { |
| 44 | + this.threadPool = threadPool; |
| 45 | + this.admissionControlSettings = new AdmissionControlSettings(clusterSettings, settings); |
| 46 | + this.ADMISSION_CONTROLLERS = new ConcurrentHashMap<>(); |
| 47 | + this.clusterSettings = clusterSettings; |
| 48 | + this.settings = settings; |
| 49 | + this.initialise(); |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * Initialise and Register all the admissionControllers |
| 54 | + */ |
| 55 | + private void initialise() { |
| 56 | + // Initialise different type of admission controllers |
| 57 | + registerAdmissionController(CPU_BASED_ADMISSION_CONTROLLER); |
| 58 | + } |
| 59 | + |
| 60 | + /** |
| 61 | + * Handler to trigger registered admissionController |
| 62 | + */ |
| 63 | + public void applyTransportAdmissionControl(String action) { |
| 64 | + this.ADMISSION_CONTROLLERS.forEach((name, admissionController) -> { admissionController.apply(action); }); |
| 65 | + } |
| 66 | + |
| 67 | + /** |
| 68 | + * |
| 69 | + * @param admissionControllerName admissionControllerName to register into the service. |
| 70 | + */ |
| 71 | + public void registerAdmissionController(String admissionControllerName) { |
| 72 | + AdmissionController admissionController = this.controllerFactory(admissionControllerName); |
| 73 | + this.ADMISSION_CONTROLLERS.put(admissionControllerName, admissionController); |
| 74 | + } |
| 75 | + |
| 76 | + /** |
| 77 | + * @return AdmissionController Instance |
| 78 | + */ |
| 79 | + private AdmissionController controllerFactory(String admissionControllerName) { |
| 80 | + switch (admissionControllerName) { |
| 81 | + case CPU_BASED_ADMISSION_CONTROLLER: |
| 82 | + return new CPUBasedAdmissionController(admissionControllerName, this.settings, this.clusterSettings); |
| 83 | + default: |
| 84 | + throw new IllegalArgumentException("Not Supported AdmissionController : " + admissionControllerName); |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + /** |
| 89 | + * |
| 90 | + * @return list of the registered admissionControllers |
| 91 | + */ |
| 92 | + public List<AdmissionController> getAdmissionControllers() { |
| 93 | + return new ArrayList<>(this.ADMISSION_CONTROLLERS.values()); |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + * |
| 98 | + * @param controllerName name of the admissionController |
| 99 | + * @return instance of the AdmissionController Instance |
| 100 | + */ |
| 101 | + public AdmissionController getAdmissionController(String controllerName) { |
| 102 | + return this.ADMISSION_CONTROLLERS.getOrDefault(controllerName, null); |
| 103 | + } |
| 104 | +} |
0 commit comments