org.apache.flink.runtime.resourcemanager.autoscale.plugins.ResourceDetector Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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.apache.flink.runtime.resourcemanager.autoscale.plugins;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.runtime.clusterframework.types.ResourceProfile;
import org.apache.flink.runtime.resourcemanager.autoscale.ResourceAutoScaler;
import org.apache.flink.runtime.resourcemanager.autoscale.utils.SlotManagerInfo;
import java.util.Collection;
/**
* the Symptom Detector.
*/
public interface ResourceDetector {
/**
* Init the ResourceDetector, which may subscribe some metric from metric provider.
*/
void open(ResourceAutoScaler resourceAutoScaler);
/**
* Close the ResourceDetector.
*/
void close();
/**
* Update the metrics from slotManager information and taskExecutors' resource profile.
*/
void update(SlotManagerInfo slotManagerInfo, Collection> taskManagersProfiles);
/**
* Detect the symptom, return null if not abnormal symptom detected.
* @return
*/
ResourceSymptom detect() throws Exception;
}