svn commit: r1740643 - in /uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2: cli/ducc-submit.tex job-errors.tex

[de...@apache.org]

Author: degenaro
Date: Sat Apr 23 10:43:18 2016
New Revision: 1740643

URL: http://svn.apache.org/viewvc?rev=1740643&view=rev
Log:
UIMA-4902 DUCC Job Driver (JD) add programmability feature to built-in error handler

Modified:
    uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex
    uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/job-errors.tex

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex?rev=1740643&r1=1740642&r2=1740643&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-submit.tex Sat Apr 23 10:43:18 2016
@@ -85,19 +85,24 @@
            \item[$--$driver\_exception\_handler {[classname]}] 
              This specifies a developer-supplied exception handler for the Job Driver.  
              It must implement {\em org.apache.uima.ducc.IErrorHandler} or extend
-             {\em org.apache.uima.ducc.ErrorHandler}.  A default handler is provided.
+             {\em org.apache.uima.ducc.ErrorHandler}.  A built-in default exception handler is provided.
            
            \item[$--$driver\_exception\_handler\_arguments {[argument-string]}] This is a string
              containing arguments for the exception handler.  The contents of
-             the string is entirely a function of the specified handler.  If not specified,
+             the string is entirely a function of the specified exception handler.  If not specified,
              a {\em null} is passed in.
              \\The built-in default exception handler supports an argument string of the following form
              (with NO embedded blanks):
              \begin{verbatim}
-     max_job_errors=15
+     max_job_errors=15 max_timeout_retrys_per_workitem=0
              \end{verbatim}
              Note: When used as a CLI option, the string must usually be
              quoted to protect it from the shell, if it contains blanks.
+             The built-in default exception handler supports two arguments, whose
+             default values are shown above.  The max_job_errors limit specifies the number
+             of work item errors allowed before forcibly terminating the job.  The
+             max_timeout_retrys_per_workitem limit specifies the number of times each
+             work item is retried in the event of a time-out.
 
            \item[$--$driver\_jvm\_args {[list]} ]
              This specifies extra JVM arguments to be provided to the Job Driver process. It is a blank-delimited 

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/job-errors.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/job-errors.tex?rev=1740643&r1=1740642&r2=1740643&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/job-errors.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/job-errors.tex Sat Apr 23 10:43:18 2016
@@ -24,8 +24,7 @@
 \chapter{Job Error Handler}
 \label{chap:job-error-handler}
 
-\begin{sloppypar}
-\paragraph {Overview} The {\em ErrorHandler} allows for the per job customized handling of runtime anomalies.
+\paragraph {Overview} The {\em ErrorHandler} allows for the per Job customized handling of runtime anomalies.
 
 \paragraph {Operation} The Job Driver comes with a built-in {\em ErrorHandler}.  Its purpose is to 
 instruct the Job Driver on what action(s) to take when a work item error is encountered.
@@ -52,18 +51,18 @@ By default, the {\em ErrorHandler} retur
 \item returns isKillWorkItem == true
 \end{enumerate}
 
-\paragraph {Programmability} The Job Driver built-in {\em ErrorHandler} behavior can be modified
-according to the {\em driver\_jvm\_args} in the Job Specification:
+\paragraph {Programmability} The Job Driver built-in (or custom) {\em ErrorHandler} behavior can be modified
+according to the {\em driver\_exception\_handler\_arguments} string in the Job Specification.  
+Currently recognized are:
 
 \begin{description}
-\item[-DJobDriverErrorHandlerMaximumNumberOfTimeoutRetrysPerWorkItem=N], where N is the maximum
-number of timeout retrys for each work item before that work item is considered in error.
+\item[max\_job\_errors=E], where E is the maximum number of work item errors tolerated before terminating the Job.  Default is 15.
+\item[max\_timeout\_retrys\_per\_workitem=R], where R is the maximum number of work item timeouts tolerated before the work item is considered an error.  Default is 0.
 \end{description}
 
 \paragraph {Replacement} The {\em ErrorHandler} can be replaced.  The steps necessary are:
 \begin{enumerate}
-\item Create a new ErrorHandler.class that implements {\em org.apache.uima.ducc.IErrorHandler}, which is located in the uima-ducc-user.jar.
-\item Put your replacement class in a jar file and modify ducc.properties file to include your jar file as part of ducc.local.jars variable.
+\item Create a new org.myOrg.myProject.MyErrorHandler.class that implements {\em org.apache.uima.ducc.IErrorHandler}, which is located in the uima-ducc-user.jar.
+\item Put your replacement class in your Job Specification classpath.
+\item Put your replacement class name as the value for your Job Specification driver\_exception\_handler.
 \end{enumerate}
-
-\end{sloppypar}