You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "huyuanfeng2018 (via GitHub)" <gi...@apache.org> on 2024/02/29 07:26:38 UTC

[PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

huyuanfeng2018 opened a new pull request, #24411:
URL: https://github.com/apache/flink/pull/24411

   <!--
   *Thank you very much for contributing to Apache Flink - we are happy that you want to help us improve Flink. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
   
   *Please understand that we do not do this to make contributions to Flink a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
   
   ## Contribution Checklist
   
     - Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
     
     - Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you are unsure about which is the best component.
     Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
   
     - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
     
     - Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes. You can set up Azure Pipelines CI to do that following [this guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
   
     - Each pull request should address only one issue, not mix up code from multiple issues.
     
     - Each commit in the pull request has a meaningful commit message (including the JIRA id)
   
     - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
   
   
   **(The sections below can be removed for hotfixes of typos)**
   -->
   
   ## What is the purpose of the change
   
   This PR is used to display the job json plan information of the task when flinksql explain is supported
   
   ## Brief change log
   
   *(for example:)*
     - Add an enum JSON_JOB_PLAN to ExplainDetail
     - Update all implementations of Planner#explain including streaming and batch
     - Append the job plan in json format to the result when Planner#explain execute with parameter ExplainDetail.JSON_JOB_PLAN.
    
   
   ## Verifying this change
   
   Please make sure both new and modified tests in this PR follows the conventions defined in our code quality guide: https://flink.apache.org/contributing/code-style-and-quality-common.html#testing
   
   *(Please pick either of the following options)*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This change is already covered by existing tests, such as *(please describe tests)*.
   
   *(or)*
   
   This change added tests and can be verified as follows:
   
   *(example:)*
     - *Added integration tests for end-to-end deployment with large payloads (100MB)*
     - *Extended integration test for recovery after master (JobManager) failure*
     - *Added test that validates that TaskInfo is transferred only once across recoveries*
     - *Manually verified the change by running a 4 node cluster with 2 JobManagers and 4 TaskManagers, a stateful streaming program, and killing one JobManager and two TaskManagers during the execution, verifying that recovery happens correctly.*
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): (yes / no)
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (yes / no)
     - The serializers: (yes / no / don't know)
     - The runtime per-record code paths (performance sensitive): (yes / no / don't know)
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / no / don't know)
     - The S3 file system connector: (yes / no / don't know)
   
   ## Documentation
   
     - Does this pull request introduce a new feature? (yes / no)
     - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #24411: [FLINK-34535] Support JobPlanInfo for the explain result
URL: https://github.com/apache/flink/pull/24411


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "huyuanfeng2018 (via GitHub)" <gi...@apache.org>.
huyuanfeng2018 commented on PR #24411:
URL: https://github.com/apache/flink/pull/24411#issuecomment-1970794201

   @flinkbot run azure


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24411:
URL: https://github.com/apache/flink/pull/24411#issuecomment-2777669720

   This PR is being marked as stale since it has not had any activity in the last 90 days. 
   If you would like to keep this PR alive, please leave a comment asking for a review. 
   If the PR has merge conflicts, update it with the latest from the base branch.
   
   If you are having difficulty finding a reviewer, please reach out to the 
   community, contact details can be found here: https://flink.apache.org/what-is-flink/community/
   
   If this PR is no longer valid or desired, please feel free to close it. 
   If no activity occurs in the next 30 days, it will be automatically closed.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24411:
URL: https://github.com/apache/flink/pull/24411#issuecomment-2850027405

   This PR has been closed since it has not had any activity in 120 days. 
   If you feel like this was a mistake, or you would like to continue working on it, 
   please feel free to re-open the PR and ask for a review.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "huyuanfeng2018 (via GitHub)" <gi...@apache.org>.
huyuanfeng2018 commented on PR #24411:
URL: https://github.com/apache/flink/pull/24411#issuecomment-1972635698

   > Hi @huyuanfeng2018 thanks for the PR. I have a few comments:
   > 
   > * Please add `JSON_JOB_PLAN `  to the `python` API (e.g.,  to the `basic_operations.py`) and test it there as well (e.g., in `test_table_environment.py`)
   > * Why the `JSON_JOB_PLAN` keyword didn't end up in our parser (`Parser.tdd`, `Parser.jj`)?
   > * The main motivation behind this PR "' combine it with the parameter `pipeline.jobvertex-parallelism-overrides` to set up my task parallelism'" is not clear to me and is missing in this PR tests
   > * Add the necessary documentation to the `explain.md`
   > * Please add test with `Hive` as well (e.g., see `HiveTableSinkITCase::testHiveTableSinkWithParallelismBase`
   > * Add `JSON_JOB_PLAN ` to the `FlinkSqlParserImplConstants`
   > * Update `TableTestBase::doVerifyExplain` to support `JSON_JOB_PLAN` as well
   > * Tests with table API are missing
   
   Thank you very much for your review. There is still a lot of work to be done on this PR. I will mark it as a draft first.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "jeyhunkarimov (via GitHub)" <gi...@apache.org>.
jeyhunkarimov commented on code in PR #24411:
URL: https://github.com/apache/flink/pull/24411#discussion_r1508294826


##########
flink-table/flink-table-planner/src/test/scala/org/apache/flink/table/planner/utils/TableTestBase.scala:
##########
@@ -1824,6 +1826,11 @@ object TableTestUtil {
     s.replaceAll("\"id\"\\s*:\\s*\\d+", "\"id\" : ").trim
   }
 
+  /** JobJson {jid} is ignored. */
+  def replaceJobId(s: String): String = {
+    s.replaceAll("\"jid\"\\s*:\\s*\"[\\w.-]*\"", "\"jid\":\"\"").trim

Review Comment:
   This might also replace a string literal having `"jid..."` pattern. We should make sure that only field values are targeted in this case



##########
flink-table/flink-table-planner/src/test/scala/org/apache/flink/table/planner/utils/TableTestBase.scala:
##########
@@ -1093,6 +1093,8 @@ abstract class TableTestUtilBase(test: TableTestBase, isStreamingMode: Boolean)
         case ExplainDetail.ESTIMATED_COST => replaceEstimatedCost(result)
         case ExplainDetail.JSON_EXECUTION_PLAN =>
           replaceNodeIdInOperator(replaceStreamNodeId(replaceStageId(result)))
+        case ExplainDetail.JSON_JOB_PLAN =>

Review Comment:
   I would leave the old test as it is, and add your cases in another test.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #24411:
URL: https://github.com/apache/flink/pull/24411#issuecomment-1970559712

   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "267b77b225bf82d8aa69a93a99627e337638ea66",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "267b77b225bf82d8aa69a93a99627e337638ea66",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 267b77b225bf82d8aa69a93a99627e337638ea66 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-34535] Support JobPlanInfo for the explain result [flink]

Posted by "huyuanfeng2018 (via GitHub)" <gi...@apache.org>.
huyuanfeng2018 commented on PR #24411:
URL: https://github.com/apache/flink/pull/24411#issuecomment-1970681134

   @flinkbot run azure


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org