org.apache.flink.runtime.healthmanager.plugins.detectors.HighDelayDetector Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.5.1
/*
 * 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.healthmanager.plugins.detectors;

import org.apache.flink.api.common.JobID;
import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.configuration.ConfigOptions;
import org.apache.flink.runtime.healthmanager.HealthMonitor;
import org.apache.flink.runtime.healthmanager.metrics.MetricAggType;
import org.apache.flink.runtime.healthmanager.metrics.MetricProvider;
import org.apache.flink.runtime.healthmanager.metrics.TaskMetricSubscription;
import org.apache.flink.runtime.healthmanager.metrics.timeline.TimelineAggType;
import org.apache.flink.runtime.healthmanager.plugins.Detector;
import org.apache.flink.runtime.healthmanager.plugins.Symptom;
import org.apache.flink.runtime.healthmanager.plugins.symptoms.JobVertexHighDelay;
import org.apache.flink.runtime.healthmanager.plugins.utils.HealthMonitorOptions;
import org.apache.flink.runtime.healthmanager.plugins.utils.MetricUtils;
import org.apache.flink.runtime.jobgraph.JobVertexID;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.apache.flink.runtime.healthmanager.plugins.utils.MetricNames.SOURCE_DELAY;

/**
 * HighDelayDetector detects high delay of a job.
 * Detects {@link JobVertexHighDelay} if the max avg delay of tasks
 * of the same vertex is higher then the threshold.
 */
public class HighDelayDetector implements Detector {

	private static final Logger LOGGER = LoggerFactory.getLogger(HighDelayDetector.class);

	public static final ConfigOption HIGH_DELAY_THRESHOLD =
		ConfigOptions.key("healthmonitor.high-delay.threshold.ms").defaultValue(10 * 60 * 1000L);
	public static final ConfigOption SEVERE_DELAY_THRESHOLD =
			ConfigOptions.key("healthmonitor.severe-delay.threshold.ms").defaultValue(60 * 60 * 1000L);

	private JobID jobID;
	private HealthMonitor healthMonitor;
	private MetricProvider metricProvider;

	private long highDelayCheckInterval;
	private long highDelayThreshold;
	private long severeDelayThreshold;

	private Map delaySubs;

	@Override
	public void open(HealthMonitor monitor) {
		healthMonitor = monitor;
		jobID = monitor.getJobID();
		metricProvider = monitor.getMetricProvider();

		highDelayCheckInterval = monitor.getConfig().getLong(HealthMonitorOptions.PARALLELISM_SCALE_INTERVAL);
		highDelayThreshold = monitor.getConfig().getLong(HIGH_DELAY_THRESHOLD);
		severeDelayThreshold = monitor.getConfig().getLong(SEVERE_DELAY_THRESHOLD);

		delaySubs = new HashMap<>();
		for (JobVertexID vertexId : monitor.getJobConfig().getVertexConfigs().keySet()) {
			if (monitor.getJobConfig().getInputNodes().get(vertexId).size() == 0) {
				TaskMetricSubscription delaySub = metricProvider.subscribeTaskMetric(
						jobID, vertexId, SOURCE_DELAY, MetricAggType.MAX, highDelayCheckInterval, TimelineAggType.LATEST);
				delaySubs.put(vertexId, delaySub);
			}
		}
	}

	@Override
	public void close() {
		if (metricProvider != null && delaySubs != null) {
			for (TaskMetricSubscription delaySub : delaySubs.values()) {
				if (delaySub != null) {
					metricProvider.unsubscribe(delaySub);
				}
			}
		}
	}

	@Override
	public Symptom detect() throws Exception {
		LOGGER.debug("Start detecting.");

		List jobVertexIDs = new ArrayList<>();
		List severeJobVertexIDs = new ArrayList<>();
		for (JobVertexID vertexId : delaySubs.keySet()) {
			TaskMetricSubscription delaySub = delaySubs.get(vertexId);

			if (!MetricUtils.validateTaskMetric(healthMonitor, highDelayCheckInterval * 2, delaySub)) {
				LOGGER.debug("Skip vertex {}, metrics missing.", vertexId);
				continue;
			}

			if (delaySub.getValue().f1 > highDelayThreshold) {
				jobVertexIDs.add(vertexId);
			}

			if (delaySub.getValue().f1 > severeDelayThreshold) {
				severeJobVertexIDs.add(vertexId);
			}
		}

		if (!jobVertexIDs.isEmpty()) {
			LOGGER.info("High delay detected for high delay vertices {} severe delay vertices {}.", jobVertexIDs, severeJobVertexIDs);
			return new JobVertexHighDelay(jobID, jobVertexIDs, severeJobVertexIDs);
		}
		return null;
	}
}