org.apache.flink.runtime.healthmanager.metrics.MetricProvider 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.healthmanager.metrics;

import org.apache.flink.api.common.JobID;
import org.apache.flink.runtime.healthmanager.metrics.timeline.TimelineAggType;
import org.apache.flink.runtime.jobgraph.JobVertexID;

/**
 * Metric provider will accept subscription request from plugins and fetch metric subscribed periodically.
 */
public interface MetricProvider {

	/**
	 * Start service of the metric provider.
	 */
	void open();

	/**
	 * Stop service of the metric provider.
	 */
	void close();

	/**
	 * Subscribe metric of all task manager belong a job.
	 * @param metricName   metric name to subscribe
	 * @param timeInterval timeline interval for agg
	 * @param timeAggType  agg type of timeline
	 *
	 * @return  a JobTMMetricSubscription containing the all agg result.
	 */
	JobTMMetricSubscription subscribeAllTMMetric(
			JobID jobID,
			String metricName,
			long timeInterval,
			TimelineAggType timeAggType);

	/**
	 * Subscribe metric of the given task manager.
	 * @param tmId           id of the task manager
	 * @param metricName     metric name to subscribe
	 * @param timeInterval   timeline interval for agg
	 * @param timeAggType    agg type of timeline
	 */
	TaskManagerMetricSubscription subscribeTaskManagerMetric(
			String tmId,
			String metricName,
			long timeInterval,
			TimelineAggType timeAggType);

	/**
	 * Subscribe task metric. Aggregates values of every subtask in given time interval
	 * and then aggregates values of timeline aggregation of different subtask.
	 * @param jobId           id of the job
	 * @param vertexId        id of the vertex
	 * @param metricName      metric name to subscribe
	 * @param subtaskAggType  subtask agg type
	 * @param timeInterval    timeline agg interval
	 * @param timeAggType     timeline agg type
	 */
	TaskMetricSubscription subscribeTaskMetric(
			JobID jobId,
			JobVertexID vertexId,
			String metricName,
			MetricAggType subtaskAggType,
			long timeInterval,
			TimelineAggType timeAggType);

	/**
	 * Subscribe task metrics.
	 * 1. aggregates values of metric per subtask in given sub timeline interval with subTimelineAgg
	 * 2. aggregates values from 1 in given timeline interval with timeline Agg
	 * 3. aggregates values from 2 with subtask Agg
	 * @param jobId                id of the job.
	 * @param vertexID             id of the vertex.
	 * @param metricName           metric name to subscribe
	 * @param subtaskAggType
	 * @param timelineInterval
	 * @param timelineAggType
	 * @param subTimelineInterval
	 * @param subTimelineAggType
	 * @return
	 */
	TaskMetricSubscription subscribeTaskMetric(
			JobID jobId,
			JobVertexID vertexID,
			String metricName,
			MetricAggType subtaskAggType,
			long timelineInterval,
			TimelineAggType timelineAggType,
			long subTimelineInterval,
			TimelineAggType subTimelineAggType
	);

	/**
	 * Unsubscribe a metric.
	 * @param subscription
	 */
	void unsubscribe(MetricSubscription subscription);

}