All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.oozie.DagEngine Maven / Gradle / Ivy

/**
 * Copyright (c) 2010 Yahoo! Inc. All rights reserved.
 * Licensed 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. See accompanying LICENSE file.
 */
package org.apache.oozie;

import org.apache.oozie.util.XLogStreamer;
import org.apache.oozie.service.XLogService;
import org.apache.oozie.service.DagXLogInfoService;
import org.apache.hadoop.conf.Configuration;
import org.apache.oozie.client.CoordinatorJob;
import org.apache.oozie.client.WorkflowJob;
import org.apache.oozie.client.OozieClient;
import org.apache.oozie.command.CommandException;
import org.apache.oozie.command.XCommand;
import org.apache.oozie.command.wf.CompletedActionCommand;
import org.apache.oozie.command.wf.CompletedActionXCommand;
import org.apache.oozie.command.wf.DefinitionCommand;
import org.apache.oozie.command.wf.DefinitionXCommand;
import org.apache.oozie.command.wf.ExternalIdCommand;
import org.apache.oozie.command.wf.ExternalIdXCommand;
import org.apache.oozie.command.wf.JobCommand;
import org.apache.oozie.command.wf.JobXCommand;
import org.apache.oozie.command.wf.JobsCommand;
import org.apache.oozie.command.wf.JobsXCommand;
import org.apache.oozie.command.wf.KillCommand;
import org.apache.oozie.command.wf.KillXCommand;
import org.apache.oozie.command.wf.ReRunCommand;
import org.apache.oozie.command.wf.ReRunXCommand;
import org.apache.oozie.command.wf.ResumeCommand;
import org.apache.oozie.command.wf.ResumeXCommand;
import org.apache.oozie.command.wf.StartCommand;
import org.apache.oozie.command.wf.StartXCommand;
import org.apache.oozie.command.wf.SubmitCommand;
import org.apache.oozie.command.wf.SubmitHttpCommand;
import org.apache.oozie.command.wf.SubmitHttpXCommand;
import org.apache.oozie.command.wf.SubmitMRCommand;
import org.apache.oozie.command.wf.SubmitMRXCommand;
import org.apache.oozie.command.wf.SubmitPigCommand;
import org.apache.oozie.command.wf.SubmitPigXCommand;
import org.apache.oozie.command.wf.SubmitXCommand;
import org.apache.oozie.command.wf.SuspendCommand;
import org.apache.oozie.command.wf.SuspendXCommand;
import org.apache.oozie.command.wf.WorkflowActionInfoCommand;
import org.apache.oozie.command.wf.WorkflowActionInfoXCommand;
import org.apache.oozie.service.Services;
import org.apache.oozie.service.CallableQueueService;
import org.apache.oozie.util.ParamChecker;
import org.apache.oozie.util.XCallable;
import org.apache.oozie.util.XLog;

import java.io.Writer;
import java.util.Date;
import java.util.List;
import java.util.Properties;
import java.util.Set;
import java.util.HashSet;
import java.util.StringTokenizer;
import java.util.Map;
import java.util.HashMap;
import java.util.ArrayList;
import java.io.IOException;

/**
 * The DagEngine provides all the DAG engine functionality for WS calls.
 */
public class DagEngine extends BaseEngine {

    private static final int HIGH_PRIORITY = 2;
    private boolean useXCommand = true;
    private static XLog LOG = XLog.getLog(DagEngine.class);

    /**
     * Create a system Dag engine, with no user and no group.
     */
    public DagEngine() {
        if (Services.get().getConf().getBoolean(USE_XCOMMAND, true) == false) {
            useXCommand = false;
            LOG.debug("Oozie DagEngine is not using XCommands.");
        }
        else {
            LOG.debug("Oozie DagEngine is using XCommands.");
        }
    }

    /**
     * Create a Dag engine to perform operations on behave of a user.
     *
     * @param user user name.
     * @param authToken the authentication token.
     */
    public DagEngine(String user, String authToken) {
        this();
        
        this.user = ParamChecker.notEmpty(user, "user");
        this.authToken = ParamChecker.notEmpty(authToken, "authToken");
    }

    /**
     * Submit a workflow job. 

It validates configuration properties. * * @param conf job configuration. * @param startJob indicates if the job should be started or not. * @return the job Id. * @throws DagEngineException thrown if the job could not be created. */ @Override public String submitJob(Configuration conf, boolean startJob) throws DagEngineException { validateSubmitConfiguration(conf); try { String jobId; if (useXCommand) { SubmitXCommand submit = new SubmitXCommand(conf, getAuthToken()); jobId = submit.call(); } else { SubmitCommand submit = new SubmitCommand(conf, getAuthToken()); jobId = submit.call(); } if (startJob) { start(jobId); } return jobId; } catch (CommandException ex) { throw new DagEngineException(ex); } } /** * Submit a pig/mapreduce job through HTTP. *

* It validates configuration properties. * * @param conf job configuration. * @param jobType job type - can be "pig" or "mapreduce". * @return the job Id. * @throws DagEngineException thrown if the job could not be created. */ public String submitHttpJob(Configuration conf, String jobType) throws DagEngineException { validateSubmitConfiguration(conf); try { String jobId; if (useXCommand) { SubmitHttpXCommand submit = null; if (jobType.equals("pig")) { submit = new SubmitPigXCommand(conf, getAuthToken()); } else if (jobType.equals("mapreduce")) { submit = new SubmitMRXCommand(conf, getAuthToken()); } jobId = submit.call(); } else { SubmitHttpCommand submit = null; if (jobType.equals("pig")) { submit = new SubmitPigCommand(conf, getAuthToken()); } else if (jobType.equals("mapreduce")) { submit = new SubmitMRCommand(conf, getAuthToken()); } jobId = submit.call(); } start(jobId); return jobId; } catch (CommandException ex) { throw new DagEngineException(ex); } } private void validateSubmitConfiguration(Configuration conf) throws DagEngineException { if (conf.get(OozieClient.APP_PATH) == null) { throw new DagEngineException(ErrorCode.E0401, OozieClient.APP_PATH); } } /** * Start a job. * * @param jobId job Id. * @throws DagEngineException thrown if the job could not be started. */ @Override public void start(String jobId) throws DagEngineException { // Changing to synchronous call from asynchronous queuing to prevent the // loss of command if the queue is full or the queue is lost in case of // failure. try { if (useXCommand) { new StartXCommand(jobId).call(); } else { new StartCommand(jobId).call(); } } catch (CommandException e) { throw new DagEngineException(e); } } /** * Resume a job. * * @param jobId job Id. * @throws DagEngineException thrown if the job could not be resumed. */ @Override public void resume(String jobId) throws DagEngineException { // Changing to synchronous call from asynchronous queuing to prevent the // loss of command if the queue is full or the queue is lost in case of // failure. try { if (useXCommand) { new ResumeXCommand(jobId).call(); } else { new ResumeCommand(jobId).call(); } } catch (CommandException e) { throw new DagEngineException(e); } } /** * Suspend a job. * * @param jobId job Id. * @throws DagEngineException thrown if the job could not be suspended. */ @Override public void suspend(String jobId) throws DagEngineException { // Changing to synchronous call from asynchronous queuing to prevent the // loss of command if the queue is full or the queue is lost in case of // failure. try { if (useXCommand) { new SuspendXCommand(jobId).call(); } else { new SuspendCommand(jobId).call(); } } catch (CommandException e) { throw new DagEngineException(e); } } /** * Kill a job. * * @param jobId job Id. * @throws DagEngineException thrown if the job could not be killed. */ @Override public void kill(String jobId) throws DagEngineException { // Changing to synchronous call from asynchronous queuing to prevent the // loss of command if the queue is full or the queue is lost in case of // failure. try { if (useXCommand) { new KillXCommand(jobId).call(); } else { new KillCommand(jobId).call(); } LOG.info("User " + user + " killed the WF job " + jobId); } catch (CommandException e) { throw new DagEngineException(e); } } /* (non-Javadoc) * @see org.apache.oozie.BaseEngine#change(java.lang.String, java.lang.String) */ @Override public void change(String jobId, String changeValue) throws DagEngineException { // This code should not be reached. throw new DagEngineException(ErrorCode.E1017); } /** * Rerun a job. * * @param jobId job Id to rerun. * @param conf configuration information for the rerun. * @throws DagEngineException thrown if the job could not be rerun. */ @Override public void reRun(String jobId, Configuration conf) throws DagEngineException { try { validateReRunConfiguration(conf); if (useXCommand) { new ReRunXCommand(jobId, conf, getAuthToken()).call(); } else { new ReRunCommand(jobId, conf, getAuthToken()).call(); } start(jobId); } catch (CommandException ex) { throw new DagEngineException(ex); } } private void validateReRunConfiguration(Configuration conf) throws DagEngineException { if (conf.get(OozieClient.APP_PATH) == null) { throw new DagEngineException(ErrorCode.E0401, OozieClient.APP_PATH); } if (conf.get(OozieClient.RERUN_SKIP_NODES) == null && conf.get(OozieClient.RERUN_FAIL_NODES) == null) { throw new DagEngineException(ErrorCode.E0401, OozieClient.RERUN_SKIP_NODES + " OR " + OozieClient.RERUN_FAIL_NODES); } if (conf.get(OozieClient.RERUN_SKIP_NODES) != null && conf.get(OozieClient.RERUN_FAIL_NODES) != null) { throw new DagEngineException(ErrorCode.E0404, OozieClient.RERUN_SKIP_NODES + " OR " + OozieClient.RERUN_FAIL_NODES); } } /** * Process an action callback. * * @param actionId the action Id. * @param externalStatus the action external status. * @param actionData the action output data, null if none. * @throws DagEngineException thrown if the callback could not be processed. */ public void processCallback(String actionId, String externalStatus, Properties actionData) throws DagEngineException { XLog.Info.get().clearParameter(XLogService.GROUP); XLog.Info.get().clearParameter(XLogService.USER); XCallable command = null; if (useXCommand) { command = new CompletedActionXCommand(actionId, externalStatus, actionData, HIGH_PRIORITY); } else { command = new CompletedActionCommand(actionId, externalStatus, actionData, HIGH_PRIORITY); } if (!Services.get().get(CallableQueueService.class).queue(command)) { LOG.warn(XLog.OPS, "queue is full or system is in SAFEMODE, ignoring callback"); } } /** * Return the info about a job. * * @param jobId job Id. * @return the workflow job info. * @throws DagEngineException thrown if the job info could not be obtained. */ @Override public WorkflowJob getJob(String jobId) throws DagEngineException { try { if (useXCommand) { return new JobXCommand(jobId).call(); } else { return new JobCommand(jobId).call(); } } catch (CommandException ex) { throw new DagEngineException(ex); } } /** * Return the info about a job with actions subset. * * @param jobId job Id * @param start starting from this index in the list of actions belonging to the job * @param length number of actions to be returned * @return the workflow job info. * @throws DagEngineException thrown if the job info could not be obtained. */ @Override public WorkflowJob getJob(String jobId, int start, int length) throws DagEngineException { try { if (useXCommand) { return new JobXCommand(jobId, start, length).call(); } else { return new JobCommand(jobId, start, length).call(); } } catch (CommandException ex) { throw new DagEngineException(ex); } } /** * Return the a job definition. * * @param jobId job Id. * @return the job definition. * @throws DagEngineException thrown if the job definition could no be obtained. */ @Override public String getDefinition(String jobId) throws DagEngineException { try { if (useXCommand) { return new DefinitionXCommand(jobId).call(); } else { return new DefinitionCommand(jobId).call(); } } catch (CommandException ex) { throw new DagEngineException(ex); } } /** * Stream the log of a job. * * @param jobId job Id. * @param writer writer to stream the log to. * @throws IOException thrown if the log cannot be streamed. * @throws DagEngineException thrown if there is error in getting the Workflow Information for jobId. */ @Override public void streamLog(String jobId, Writer writer) throws IOException, DagEngineException { XLogStreamer.Filter filter = new XLogStreamer.Filter(); filter.setParameter(DagXLogInfoService.JOB, jobId); WorkflowJob job = getJob(jobId); Date lastTime = job.getEndTime(); if (lastTime == null) { lastTime = job.getLastModifiedTime(); } Services.get().get(XLogService.class).streamLog(filter, job.getCreatedTime(), lastTime, writer); } private static final Set FILTER_NAMES = new HashSet(); static { FILTER_NAMES.add(OozieClient.FILTER_USER); FILTER_NAMES.add(OozieClient.FILTER_NAME); FILTER_NAMES.add(OozieClient.FILTER_GROUP); FILTER_NAMES.add(OozieClient.FILTER_STATUS); } /** * Validate a jobs filter. * * @param filter filter to validate. * @return the parsed filter. * @throws DagEngineException thrown if the filter is invalid. */ protected Map> parseFilter(String filter) throws DagEngineException { Map> map = new HashMap>(); if (filter != null) { StringTokenizer st = new StringTokenizer(filter, ";"); while (st.hasMoreTokens()) { String token = st.nextToken(); if (token.contains("=")) { String[] pair = token.split("="); if (pair.length != 2) { throw new DagEngineException(ErrorCode.E0420, filter, "elements must be name=value pairs"); } if (!FILTER_NAMES.contains(pair[0])) { throw new DagEngineException(ErrorCode.E0420, filter, XLog .format("invalid name [{0}]", pair[0])); } if (pair[0].equals("status")) { try { WorkflowJob.Status.valueOf(pair[1]); } catch (IllegalArgumentException ex) { throw new DagEngineException(ErrorCode.E0420, filter, XLog.format("invalid status [{0}]", pair[1])); } } List list = map.get(pair[0]); if (list == null) { list = new ArrayList(); map.put(pair[0], list); } list.add(pair[1]); } else { throw new DagEngineException(ErrorCode.E0420, filter, "elements must be name=value pairs"); } } } return map; } /** * Return the info about a set of jobs. * * @param filterStr job filter. Refer to the {@link org.apache.oozie.client.OozieClient} for the filter syntax. * @param start offset, base 1. * @param len number of jobs to return. * @return job info for all matching jobs, the jobs don't contain node action information. * @throws DagEngineException thrown if the jobs info could not be obtained. */ public WorkflowsInfo getJobs(String filterStr, int start, int len) throws DagEngineException { Map> filter = parseFilter(filterStr); try { if (useXCommand) { return new JobsXCommand(filter, start, len).call(); } else { return new JobsCommand(filter, start, len).call(); } } catch (CommandException dce) { throw new DagEngineException(dce); } } /** * Return the workflow Job ID for an external ID.

This is reverse lookup for recovery purposes. * * @param externalId external ID provided at job submission time. * @return the associated workflow job ID if any, null if none. * @throws DagEngineException thrown if the lookup could not be done. */ @Override public String getJobIdForExternalId(String externalId) throws DagEngineException { try { if (useXCommand) { return new ExternalIdXCommand(externalId).call(); } else { return new ExternalIdCommand(externalId).call(); } } catch (CommandException dce) { throw new DagEngineException(dce); } } @Override public CoordinatorJob getCoordJob(String jobId) throws BaseEngineException { throw new BaseEngineException(new XException(ErrorCode.E0301)); } @Override public CoordinatorJob getCoordJob(String jobId, int start, int length) throws BaseEngineException { throw new BaseEngineException(new XException(ErrorCode.E0301)); } public WorkflowActionBean getWorkflowAction(String actionId) throws BaseEngineException { try { if (useXCommand) { return new WorkflowActionInfoXCommand(actionId).call(); } else { return new WorkflowActionInfoCommand(actionId).call(); } } catch (CommandException ex) { throw new BaseEngineException(ex); } } @Override public String dryrunSubmit(Configuration conf, boolean startJob) throws BaseEngineException { return null; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy