[ 
https://issues.apache.org/jira/browse/FLINK-9682?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16642850#comment-16642850
 ] 

ASF GitHub Bot commented on FLINK-9682:
---------------------------------------

yanghua commented on a change in pull request #6266: [FLINK-9682] Add 
setDescription to execution environment and provide description field for the 
rest api
URL: https://github.com/apache/flink/pull/6266#discussion_r223569543
 
 

 ##########
 File path: 
flink-java/src/main/java/org/apache/flink/api/java/ExecutionEnvironment.java
 ##########
 @@ -823,12 +823,29 @@ public JobExecutionResult execute() throws Exception {
         * {@link 
DataSet#write(org.apache.flink.api.common.io.FileOutputFormat, String)}, or 
other generic
         * data sinks created with {@link 
DataSet#output(org.apache.flink.api.common.io.OutputFormat)}.
         *
-        * <p>The program execution will be logged and displayed with the given 
job name.
+        * <p>The program execution will be logged and displayed with the given 
job name and a generated
+        * default description.
         *
         * @return The result of the job execution, containing elapsed time and 
accumulators.
         * @throws Exception Thrown, if the program executions fails.
         */
-       public abstract JobExecutionResult execute(String jobName) throws 
Exception;
+       public JobExecutionResult execute(String jobName) throws Exception {
+               return execute(jobName, "");
+       }
+
+       /**
+        * Triggers the program execution. The environment will execute all 
parts of the program that have
+        * resulted in a "sink" operation. Sink operations are for example 
printing results ({@link DataSet#print()},
+        * writing results (e.g. {@link DataSet#writeAsText(String)},
+        * {@link 
DataSet#write(org.apache.flink.api.common.io.FileOutputFormat, String)}, or 
other generic
+        * data sinks created with {@link 
DataSet#output(org.apache.flink.api.common.io.OutputFormat)}.
+        *
+        * <p>The program execution will be logged and displayed with the given 
job name and description.
+        *
+        * @return The result of the job execution, containing elapsed time and 
accumulators.
+        * @throws Exception Thrown, if the program executions fails.
+        */
+       public abstract JobExecutionResult execute(String jobName, String 
jobDescription) throws Exception;
 
 Review comment:
   Solved some compatibility issues, and now only this fundamental problem 
remains. cc @dawidwys and @tillrohrmann @aljoscha 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


> Add setDescription to execution environment and provide description field for 
> the rest api
> ------------------------------------------------------------------------------------------
>
>                 Key: FLINK-9682
>                 URL: https://issues.apache.org/jira/browse/FLINK-9682
>             Project: Flink
>          Issue Type: Improvement
>          Components: DataStream API, Webfrontend
>    Affects Versions: 1.5.0
>            Reporter: Elias Levy
>            Assignee: vinoyang
>            Priority: Major
>              Labels: pull-request-available
>
> Currently you can provide a job name to {{execute}} in the execution 
> environment.  In an environment where many version of a job may be executing, 
> such as a development or test environment, identifying which running job is 
> of a specific version via the UI can be difficult unless the version is 
> embedded into the job name given the {{execute}}.  But the job name is uses 
> for other purposes, such as for namespacing metrics.  Thus, it is not ideal 
> to modify the job name, as that could require modifying metric dashboards and 
> monitors each time versions change.
> I propose a new method be added to the execution environment, 
> {{setDescription}}, that would allow a user to pass in an arbitrary 
> description that would be displayed in the dashboard, allowing users to 
> distinguish jobs.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to