org.apache.flink.runtime.rest.handler.legacy.metrics.MetricStore 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.rest.handler.legacy.metrics;

import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.runtime.metrics.MetricNames;
import org.apache.flink.runtime.metrics.dump.MetricDump;
import org.apache.flink.runtime.metrics.dump.QueryScopeInfo;

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

import javax.annotation.concurrent.ThreadSafe;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

import static java.util.Collections.unmodifiableMap;
import static java.util.Collections.unmodifiableSet;
import static org.apache.flink.runtime.metrics.dump.MetricDump.METRIC_CATEGORY_COUNTER;
import static org.apache.flink.runtime.metrics.dump.MetricDump.METRIC_CATEGORY_GAUGE;
import static org.apache.flink.runtime.metrics.dump.MetricDump.METRIC_CATEGORY_HISTOGRAM;
import static org.apache.flink.runtime.metrics.dump.MetricDump.METRIC_CATEGORY_METER;
import static org.apache.flink.runtime.metrics.dump.QueryScopeInfo.INFO_CATEGORY_JM;
import static org.apache.flink.runtime.metrics.dump.QueryScopeInfo.INFO_CATEGORY_JOB;
import static org.apache.flink.runtime.metrics.dump.QueryScopeInfo.INFO_CATEGORY_OPERATOR;
import static org.apache.flink.runtime.metrics.dump.QueryScopeInfo.INFO_CATEGORY_TASK;
import static org.apache.flink.runtime.metrics.dump.QueryScopeInfo.INFO_CATEGORY_TM;
import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Nested data-structure to store metrics.
 */
@ThreadSafe
public class MetricStore {
	private static final Logger LOG = LoggerFactory.getLogger(MetricStore.class);

	private final ComponentMetricStore jobManager = new ComponentMetricStore();
	private final Map taskManagers = new ConcurrentHashMap<>();
	private final Map jobs = new ConcurrentHashMap<>();
	private long timestamp;

	/**
	 * Remove inactive task managers.
	 *
	 * @param activeTaskManagers to retain.
	 */
	synchronized void retainTaskManagers(List activeTaskManagers) {
		taskManagers.keySet().retainAll(activeTaskManagers);
	}

	/**
	 * Remove inactive jobs..
	 *
	 * @param activeJobs to retain.
	 */
	synchronized void retainJobs(List activeJobs) {
		jobs.keySet().retainAll(activeJobs);
	}

	/**
	 * Add metric dumps to the store.
	 *
	 * @param timestamp2Metrics to add.
	 */
	synchronized void addAll(Tuple2> timestamp2Metrics) {
		this.timestamp = timestamp2Metrics.f0;
		for (MetricDump metric : timestamp2Metrics.f1) {
			add(metric);
		}
	}

	// -----------------------------------------------------------------------------------------------------------------
	// Accessors for sub MetricStores
	// -----------------------------------------------------------------------------------------------------------------

	/**
	 * Returns the {@link ComponentMetricStore} for the JobManager.
	 *
	 * @return ComponentMetricStore for the JobManager
	 */
	public synchronized ComponentMetricStore getJobManagerMetricStore() {
		return ComponentMetricStore.unmodifiable(jobManager);
	}

	/**
	 * Returns the {@link TaskManagerMetricStore} for the given taskmanager ID.
	 *
	 * @param tmID taskmanager ID
	 * @return TaskManagerMetricStore for the given ID, or null if no store for the given argument exists
	 */
	public synchronized TaskManagerMetricStore getTaskManagerMetricStore(String tmID) {
		return tmID == null ? null : TaskManagerMetricStore.unmodifiable(taskManagers.get(tmID));
	}

	/**
	 * Returns the {@link ComponentMetricStore} for the given job ID.
	 *
	 * @param jobID job ID
	 * @return ComponentMetricStore for the given ID, or null if no store for the given argument exists
	 */
	public synchronized ComponentMetricStore getJobMetricStore(String jobID) {
		return jobID == null ? null : ComponentMetricStore.unmodifiable(jobs.get(jobID));
	}

	/**
	 * Returns the {@link ComponentMetricStore} for the given job/task ID.
	 *
	 * @param jobID  job ID
	 * @param taskID task ID
	 * @return ComponentMetricStore for given IDs, or null if no store for the given arguments exists
	 */
	public synchronized TaskMetricStore getTaskMetricStore(String jobID, String taskID) {
		JobMetricStore job = jobID == null ? null : jobs.get(jobID);
		if (job == null || taskID == null) {
			return null;
		}
		return TaskMetricStore.unmodifiable(job.getTaskMetricStore(taskID));
	}

	/**
	 * Returns the {@link ComponentMetricStore} for the given job/task ID and subtask index.
	 *
	 * @param jobID        job ID
	 * @param taskID       task ID
	 * @param subtaskIndex subtask index
	 * @return SubtaskMetricStore for the given IDs and index, or null if no store for the given arguments exists
	 */
	public synchronized ComponentMetricStore getSubtaskMetricStore(String jobID, String taskID, int subtaskIndex) {
		JobMetricStore job = jobID == null ? null : jobs.get(jobID);
		if (job == null) {
			return null;
		}
		TaskMetricStore task = job.getTaskMetricStore(taskID);
		if (task == null) {
			return null;
		}
		return ComponentMetricStore.unmodifiable(task.getSubtaskMetricStore(subtaskIndex));
	}

	public synchronized Map getJobs() {
		return unmodifiableMap(jobs);
	}

	public synchronized Map getTaskManagers() {
		return unmodifiableMap(taskManagers);
	}

	public long getTimestamp() {
		return timestamp;
	}

	/**
	 * @deprecated Use semantically equivalent {@link #getJobManagerMetricStore()}.
	 */
	@Deprecated
	public synchronized ComponentMetricStore getJobManager() {
		return ComponentMetricStore.unmodifiable(jobManager);
	}

	@VisibleForTesting
	public void add(MetricDump metric) {
		try {
			QueryScopeInfo info = metric.scopeInfo;
			TaskManagerMetricStore tm;
			JobMetricStore job;
			TaskMetricStore task;
			ComponentMetricStore subtask;

			String name = info.scope.isEmpty()
				? metric.name
				: info.scope + "." + metric.name;

			if (name.isEmpty()) { // malformed transmission
				return;
			}

			switch (info.getCategory()) {
				case INFO_CATEGORY_JM:
					addMetric(jobManager.metrics, name, metric);
					break;
				case INFO_CATEGORY_TM:
					String tmID = ((QueryScopeInfo.TaskManagerQueryScopeInfo) info).taskManagerID;
					tm = taskManagers.computeIfAbsent(tmID, k -> new TaskManagerMetricStore());
					if (name.contains("GarbageCollector")) {
						String gcName = name.substring("Status.JVM.GarbageCollector.".length(), name.lastIndexOf('.'));
						tm.addGarbageCollectorName(gcName);
					}
					addMetric(tm.metrics, name, metric);
					break;
				case INFO_CATEGORY_JOB:
					QueryScopeInfo.JobQueryScopeInfo jobInfo = (QueryScopeInfo.JobQueryScopeInfo) info;
					job = jobs.computeIfAbsent(jobInfo.jobID, k -> new JobMetricStore());
					addMetric(job.metrics, name, metric);
					break;
				case INFO_CATEGORY_TASK:
					QueryScopeInfo.TaskQueryScopeInfo taskInfo = (QueryScopeInfo.TaskQueryScopeInfo) info;
					job = jobs.computeIfAbsent(taskInfo.jobID, k -> new JobMetricStore());
					task = job.tasks.computeIfAbsent(taskInfo.vertexID, k -> new TaskMetricStore());
					subtask = task.subtasks.computeIfAbsent(taskInfo.subtaskIndex, k -> new ComponentMetricStore());
					/**
					 * The duplication is intended. Metrics scoped by subtask are useful for several job/task handlers,
					 * while the WebInterface task metric queries currently do not account for subtasks, so we don't
					 * divide by subtask and instead use the concatenation of subtask index and metric name as the name
					 * for those.
					 */
					addMetric(subtask.metrics, name, metric);
					addMetric(task.metrics, taskInfo.subtaskIndex + "." + name, metric);
					break;
				case INFO_CATEGORY_OPERATOR:
					QueryScopeInfo.OperatorQueryScopeInfo operatorInfo = (QueryScopeInfo.OperatorQueryScopeInfo) info;
					job = jobs.computeIfAbsent(operatorInfo.jobID, k -> new JobMetricStore());
					task = job.tasks.computeIfAbsent(operatorInfo.vertexID, k -> new TaskMetricStore());
					subtask = task.subtasks.computeIfAbsent(operatorInfo.subtaskIndex, k -> new ComponentMetricStore());
					/**
					 * As the WebInterface does not account for operators (because it can't) we don't
					 * divide by operator and instead use the concatenation of subtask index, operator name and metric name
					 * as the name.
					 */
					addMetric(subtask.metrics, operatorInfo.operatorId + "." + name, metric);
					addMetric(task.metrics, operatorInfo.subtaskIndex + "." + operatorInfo.operatorName + "." + name, metric);

					// Expose some source metrics directly for auto scaling
					// Warning: If there are multiple sources in one task, these metrics may cause conflict
					if (MetricNames.SOURCE_FRAMEWORK_METRICS.contains(name) ||
						(!info.scope.isEmpty() && MetricNames.SOURCE_FRAMEWORK_METRIC_SCOPE.contains(info.scope))) {

						addMetric(subtask.metrics, name, metric);
					}

					break;
				default:
					LOG.debug("Invalid metric dump category: " + info.getCategory());
			}
		} catch (Exception e) {
			LOG.debug("Malformed metric dump.", e);
		}
	}

	private void addMetric(Map target, String name, MetricDump metric) {
		switch (metric.getCategory()) {
			case METRIC_CATEGORY_COUNTER:
				MetricDump.CounterDump counter = (MetricDump.CounterDump) metric;
				target.put(name, String.valueOf(counter.count));
				break;
			case METRIC_CATEGORY_GAUGE:
				MetricDump.GaugeDump gauge = (MetricDump.GaugeDump) metric;
				target.put(name, gauge.value);
				break;
			case METRIC_CATEGORY_HISTOGRAM:
				MetricDump.HistogramDump histogram = (MetricDump.HistogramDump) metric;
				target.put(name + "_min", String.valueOf(histogram.min));
				target.put(name + "_max", String.valueOf(histogram.max));
				target.put(name + "_mean", String.valueOf(histogram.mean));
				target.put(name + "_median", String.valueOf(histogram.median));
				target.put(name + "_stddev", String.valueOf(histogram.stddev));
				target.put(name + "_p75", String.valueOf(histogram.p75));
				target.put(name + "_p90", String.valueOf(histogram.p90));
				target.put(name + "_p95", String.valueOf(histogram.p95));
				target.put(name + "_p98", String.valueOf(histogram.p98));
				target.put(name + "_p99", String.valueOf(histogram.p99));
				target.put(name + "_p999", String.valueOf(histogram.p999));
				break;
			case METRIC_CATEGORY_METER:
				MetricDump.MeterDump meter = (MetricDump.MeterDump) metric;
				target.put(name, String.valueOf(meter.rate));
				break;
		}
	}

	// -----------------------------------------------------------------------------------------------------------------
	// sub MetricStore classes
	// -----------------------------------------------------------------------------------------------------------------

	/**
	 * Structure containing metrics of a single component.
	 */
	@ThreadSafe
	public static class ComponentMetricStore {
		public final Map metrics;

		private ComponentMetricStore() {
			this(new ConcurrentHashMap<>());
		}

		private ComponentMetricStore(Map metrics) {
			this.metrics = checkNotNull(metrics);
		}

		public String getMetric(String name) {
			return this.metrics.get(name);
		}

		public String getMetric(String name, String defaultValue) {
			String value = this.metrics.get(name);
			return value != null
				? value
				: defaultValue;
		}

		public Map getMetrics() {
			return this.metrics;
		}

		private static ComponentMetricStore unmodifiable(ComponentMetricStore source) {
			if (source == null) {
				return null;
			}
			return new ComponentMetricStore(unmodifiableMap(source.metrics));
		}
	}

	/**
	 * Sub-structure containing metrics of a single TaskManager.
	 */
	@ThreadSafe
	public static class TaskManagerMetricStore extends ComponentMetricStore {
		public final Set garbageCollectorNames;

		private TaskManagerMetricStore() {
			this(new ConcurrentHashMap<>(), ConcurrentHashMap.newKeySet());
		}

		private TaskManagerMetricStore(Map metrics, Set garbageCollectorNames) {
			super(metrics);
			this.garbageCollectorNames = checkNotNull(garbageCollectorNames);
		}

		private void addGarbageCollectorName(String name) {
			garbageCollectorNames.add(name);
		}

		private static TaskManagerMetricStore unmodifiable(TaskManagerMetricStore source) {
			if (source == null) {
				return null;
			}
			return new TaskManagerMetricStore(
				unmodifiableMap(source.metrics),
				unmodifiableSet(source.garbageCollectorNames));
		}
	}

	/**
	 * Sub-structure containing metrics of a single Job.
	 */
	@ThreadSafe
	private static class JobMetricStore extends ComponentMetricStore {
		private final Map tasks = new ConcurrentHashMap<>();

		public TaskMetricStore getTaskMetricStore(String taskID) {
			return taskID == null ? null : tasks.get(taskID);
		}
	}

	/**
	 * Sub-structure containing metrics of a single Task.
	 */
	@ThreadSafe
	public static class TaskMetricStore extends ComponentMetricStore {
		private final Map subtasks;

		private TaskMetricStore() {
			this(new ConcurrentHashMap<>(), new ConcurrentHashMap<>());
		}

		private TaskMetricStore(Map metrics, Map subtasks) {
			super(metrics);
			this.subtasks = checkNotNull(subtasks);
		}

		public ComponentMetricStore getSubtaskMetricStore(int subtaskIndex) {
			return subtasks.get(subtaskIndex);
		}

		public Collection getAllSubtaskMetricStores() {
			return subtasks.values();
		}

		private static TaskMetricStore unmodifiable(TaskMetricStore source) {
			if (source == null) {
				return null;
			}
			return new TaskMetricStore(
				unmodifiableMap(source.metrics),
				unmodifiableMap(source.subtasks));
		}
	}
}