Package org.apache.hadoop.resourceestimator.service

Class ResourceEstimatorService

java.lang.Object

org.apache.hadoop.resourceestimator.service.ResourceEstimatorService

@Singleton
public class ResourceEstimatorService
extends java.lang.Object

Resource Estimator Service which provides a set of REST APIs for users to use the estimation service.

Constructor Summary

Constructors

Constructor	Description
ResourceEstimatorService()

Method Summary

Modifier and Type	Method	Description
void	deleteHistoryResourceSkyline(java.lang.String pipelineId, java.lang.String runId)	Delete history ResourceSkylines from SkylineStore.
java.lang.String	getEstimatedResourceAllocation(java.lang.String pipelineId)	Get estimated {code Resource} allocation for the pipeline.
java.lang.String	getHistoryResourceSkyline(java.lang.String pipelineId, java.lang.String runId)	Get history ResourceSkyline from SkylineStore.
java.lang.String	getPrediction(java.lang.String pipelineId)	Get predicted {code Resource} allocation for the pipeline.
void	parseFile(java.lang.String logFile)	Parse the log file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceEstimatorService

public ResourceEstimatorService()
                         throws ResourceEstimatorException

Throws:

ResourceEstimatorException

Method Detail

parseFile

public void parseFile(java.lang.String logFile)
               throws java.io.IOException,
                      SkylineStoreException,
                      ResourceEstimatorException

Parse the log file. See also LogParser.parseStream(InputStream).

Parameters:

logFile - file/directory of the log to be parsed.

Throws:

java.io.IOException - if fails to parse the log.

SkylineStoreException - if fails to addHistory to SkylineStore.

ResourceEstimatorException - if the LogParser is not initialized.

getPrediction

public java.lang.String getPrediction(java.lang.String pipelineId)
                               throws SolverException,
                                      SkylineStoreException

Get predicted {code Resource} allocation for the pipeline. If the prediction for the pipeline already exists in the SkylineStore, it will directly get the prediction from SkylineStore, otherwise it will call the Solver to make prediction, and store the predicted {code Resource} allocation to the SkylineStore. Note that invoking Solver could be a time-consuming operation.

Parameters:

pipelineId - the id of the pipeline.

Returns:

Json format of RLESparseResourceAllocation.

Throws:

SolverException - if Solver fails;

SkylineStoreException - if fails to get history ResourceSkyline or predicted {code Resource} allocation from SkylineStore.

getHistoryResourceSkyline

public java.lang.String getHistoryResourceSkyline(java.lang.String pipelineId,
                                                  java.lang.String runId)
                                           throws SkylineStoreException

Get history ResourceSkyline from SkylineStore. This function supports the following special wildcard operations regarding RecurrenceId: If the pipelineId is "*", it will return all entries in the store; else, if the runId is "*", it will return all ResourceSkylines belonging to the pipelineId; else, it will return all ResourceSkylines belonging to the {pipelineId, runId}. If the RecurrenceId does not exist, it will not do anything.

Parameters:

pipelineId - pipelineId of the history run.

runId - runId of the history run.

Returns:

Json format of history ResourceSkylines.

Throws:

SkylineStoreException - if fails to getHistory ResourceSkyline from SkylineStore.

getEstimatedResourceAllocation

public java.lang.String getEstimatedResourceAllocation(java.lang.String pipelineId)
                                                throws SkylineStoreException

Get estimated {code Resource} allocation for the pipeline.

Parameters:

pipelineId - id of the pipeline.

Returns:

Json format of RLESparseResourceAllocation.

Throws:

SkylineStoreException - if fails to get estimated {code Resource} allocation from SkylineStore.

deleteHistoryResourceSkyline

public void deleteHistoryResourceSkyline(java.lang.String pipelineId,
                                         java.lang.String runId)
                                  throws SkylineStoreException

Delete history ResourceSkylines from SkylineStore.

Note that for safety considerations, we only allow users to delete history ResourceSkylines of one job run.

Parameters:

pipelineId - pipelineId of the history run.

runId - runId runId of the history run.

Throws:

SkylineStoreException - if fails to deleteHistory ResourceSkylines.