org.apache.flink.runtime.rest.handler.legacy.metrics

Class MetricStore

java.lang.Object

org.apache.flink.runtime.rest.handler.legacy.metrics.MetricStore

@ThreadSafe
public class MetricStore
extends Object

Nested data-structure to store metrics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricStore.ComponentMetricStore Structure containing metrics of a single component.
static class	MetricStore.SubtaskMetricStore Sub-structure containing metrics of a single subtask.
static class	MetricStore.TaskManagerMetricStore Sub-structure containing metrics of a single TaskManager.
static class	MetricStore.TaskMetricStore Sub-structure containing metrics of a single Task.

Constructor Summary

Constructors

Constructor and Description
MetricStore()

Method Summary

Modifier and Type	Method and Description
void	add(MetricDump metric)
MetricStore.ComponentMetricStore	getJobManager() Deprecated. Use semantically equivalent getJobManagerMetricStore().
MetricStore.ComponentMetricStore	getJobManagerMetricStore() Returns the MetricStore.ComponentMetricStore for the JobManager.
MetricStore.ComponentMetricStore	getJobManagerOperatorMetricStore(String jobID, String taskID)
MetricStore.ComponentMetricStore	getJobMetricStore(String jobID) Returns the MetricStore.ComponentMetricStore for the given job ID.
Map<String,org.apache.flink.runtime.rest.handler.legacy.metrics.MetricStore.JobMetricStore>	getJobs()
Map<String,Map<String,Map<Integer,Integer>>>	getRepresentativeAttempts()
MetricStore.ComponentMetricStore	getSubtaskAttemptMetricStore(String jobID, String taskID, int subtaskIndex, int attemptNumber)
MetricStore.ComponentMetricStore	getSubtaskMetricStore(String jobID, String taskID, int subtaskIndex) Returns the MetricStore.ComponentMetricStore for the given job/task ID and subtask index.
MetricStore.TaskManagerMetricStore	getTaskManagerMetricStore(String tmID) Returns the MetricStore.TaskManagerMetricStore for the given taskmanager ID.
Map<String,MetricStore.TaskManagerMetricStore>	getTaskManagers()
MetricStore.TaskMetricStore	getTaskMetricStore(String jobID, String taskID) Returns the MetricStore.ComponentMetricStore for the given job/task ID.
void	updateCurrentExecutionAttempts(Collection<JobDetails> jobs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricStore

public MetricStore()

Method Detail

updateCurrentExecutionAttempts

public void updateCurrentExecutionAttempts(Collection<JobDetails> jobs)

getRepresentativeAttempts

public Map<String,Map<String,Map<Integer,Integer>>> getRepresentativeAttempts()

getJobManagerMetricStore

public MetricStore.ComponentMetricStore getJobManagerMetricStore()

Returns the MetricStore.ComponentMetricStore for the JobManager.

Returns:

ComponentMetricStore for the JobManager

getJobManagerOperatorMetricStore

public MetricStore.ComponentMetricStore getJobManagerOperatorMetricStore(String jobID,
                                                                         String taskID)

getTaskManagerMetricStore

public MetricStore.TaskManagerMetricStore getTaskManagerMetricStore(String tmID)

Returns the MetricStore.TaskManagerMetricStore for the given taskmanager ID.

Parameters:

tmID - taskmanager ID

Returns:

TaskManagerMetricStore for the given ID, or null if no store for the given argument exists

getJobMetricStore

public MetricStore.ComponentMetricStore getJobMetricStore(String jobID)

Returns the MetricStore.ComponentMetricStore for the given job ID.

Parameters:

jobID - job ID

Returns:

ComponentMetricStore for the given ID, or null if no store for the given argument exists

getTaskMetricStore

public MetricStore.TaskMetricStore getTaskMetricStore(String jobID,
                                                      String taskID)

Returns the MetricStore.ComponentMetricStore for the given job/task ID.

Parameters:

jobID - job ID

taskID - task ID

Returns:

ComponentMetricStore for given IDs, or null if no store for the given arguments exists

getSubtaskMetricStore

public MetricStore.ComponentMetricStore getSubtaskMetricStore(String jobID,
                                                              String taskID,
                                                              int subtaskIndex)

Returns the MetricStore.ComponentMetricStore for the given job/task ID and subtask index.

Parameters:

jobID - job ID

taskID - task ID

subtaskIndex - subtask index

Returns:

SubtaskMetricStore for the given IDs and index, or null if no store for the given arguments exists

getSubtaskAttemptMetricStore

public MetricStore.ComponentMetricStore getSubtaskAttemptMetricStore(String jobID,
                                                                     String taskID,
                                                                     int subtaskIndex,
                                                                     int attemptNumber)

getJobs

public Map<String,org.apache.flink.runtime.rest.handler.legacy.metrics.MetricStore.JobMetricStore> getJobs()

getTaskManagers

public Map<String,MetricStore.TaskManagerMetricStore> getTaskManagers()

getJobManager

@Deprecated
public MetricStore.ComponentMetricStore getJobManager()

Deprecated. Use semantically equivalent getJobManagerMetricStore().

add

@VisibleForTesting
public void add(MetricDump metric)