You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/01/17 10:04:04 UTC

[GitHub] [flink] dianfu opened a new pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

dianfu opened a new pull request #18380:
URL: https://github.com/apache/flink/pull/18380


   
   ## What is the purpose of the change
   
   *This pull request add support of set_description in DataStream API*
   
   
   
   ## Verifying this change
   
   This change is a trivial rework without any test coverage.
   
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): (no)
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (no)
     - The serializers: (no)
     - The runtime per-record code paths (performance sensitive): (no)
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
     - The S3 file system connector: ( no)
   
   ## Documentation
   
     - Does this pull request introduce a new feature? (yes)
     - If yes, how is the feature documented? (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



[GitHub] [flink] flinkbot edited a comment on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1014348700


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548",
       "triggerID" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "triggerType" : "PUSH"
     }, {
       "hash" : "5e49df6104317779a59d57e2e4ecf08d7e36eff4",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29600",
       "triggerID" : "5e49df6104317779a59d57e2e4ecf08d7e36eff4",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 5e49df6104317779a59d57e2e4ecf08d7e36eff4 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29600) 
   
   <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



[GitHub] [flink] dianfu closed pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
dianfu closed pull request #18380:
URL: https://github.com/apache/flink/pull/18380


   


-- 
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



[GitHub] [flink] flinkbot edited a comment on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1014348700


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "status" : "FAILURE",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548",
       "triggerID" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "triggerType" : "PUSH"
     }, {
       "hash" : "5e49df6104317779a59d57e2e4ecf08d7e36eff4",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "5e49df6104317779a59d57e2e4ecf08d7e36eff4",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 8567524e525600f37c4bfab1100c9f95c721b194 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548) 
   * 5e49df6104317779a59d57e2e4ecf08d7e36eff4 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



[GitHub] [flink] flinkbot edited a comment on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1014348700


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "status" : "FAILURE",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548",
       "triggerID" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 8567524e525600f37c4bfab1100c9f95c721b194 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548) 
   
   <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



[GitHub] [flink] dianfu commented on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
dianfu commented on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1015993054


   @HuangXingBo Thanks for the review. Will address the comments during merging the PR.


-- 
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



[GitHub] [flink] flinkbot edited a comment on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1014348700


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "status" : "FAILURE",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548",
       "triggerID" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "triggerType" : "PUSH"
     }, {
       "hash" : "5e49df6104317779a59d57e2e4ecf08d7e36eff4",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29600",
       "triggerID" : "5e49df6104317779a59d57e2e4ecf08d7e36eff4",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 8567524e525600f37c4bfab1100c9f95c721b194 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548) 
   * 5e49df6104317779a59d57e2e4ecf08d7e36eff4 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29600) 
   
   <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



[GitHub] [flink] HuangXingBo commented on a change in pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
HuangXingBo commented on a change in pull request #18380:
URL: https://github.com/apache/flink/pull/18380#discussion_r786496796



##########
File path: flink-python/pyflink/datastream/data_stream.py
##########
@@ -231,6 +231,24 @@ def slot_sharing_group(self, slot_sharing_group: Union[str, SlotSharingGroup]) -
             self._j_data_stream.slotSharingGroup(slot_sharing_group)
         return self
 
+    def set_description(self, description: str):

Review comment:
       ```suggestion
       def set_description(self, description: str) -> 'DataStream':
   ```

##########
File path: flink-python/pyflink/datastream/data_stream.py
##########
@@ -231,6 +231,24 @@ def slot_sharing_group(self, slot_sharing_group: Union[str, SlotSharingGroup]) -
             self._j_data_stream.slotSharingGroup(slot_sharing_group)
         return self
 
+    def set_description(self, description: str):
+        """
+        Sets the description for this operator.
+
+        Description is used in json plan and web ui, but not in logging and metrics where only
+        name is available. Description is expected to provide detailed information about the
+        operator, while name is expected to be more simple, providing summary information only,
+        so that we can have more user-friendly logging messages and metric tags without losing
+        useful messages for debugging.
+
+        :param description: The description for this operator.
+        :return: The sink with new description.

Review comment:
       ```suggestion
           :return: The operation with new description.
   ```




-- 
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



[GitHub] [flink] flinkbot commented on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1014348332


   Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
   to review your pull request. We will use this comment to track the progress of the review.
   
   
   ## Automated Checks
   Last check on commit 8567524e525600f37c4bfab1100c9f95c721b194 (Mon Jan 17 10:09:23 UTC 2022)
   
   **Warnings:**
    * No documentation files were touched! Remember to keep the Flink docs up to date!
   
   
   <sub>Mention the bot in a comment to re-run the automated checks.</sub>
   ## Review Progress
   
   * ❓ 1. The [description] looks good.
   * ❓ 2. There is [consensus] that the contribution should go into to Flink.
   * ❓ 3. Needs [attention] from.
   * ❓ 4. The change fits into the overall [architecture].
   * ❓ 5. Overall code [quality] is good.
   
   Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
    The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
    - `@flinkbot approve all` to approve all aspects
    - `@flinkbot approve-until architecture` to approve everything until `architecture`
    - `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
    - `@flinkbot disapprove architecture` to remove an approval you gave earlier
   </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



[GitHub] [flink] flinkbot edited a comment on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1014348700


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548",
       "triggerID" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 8567524e525600f37c4bfab1100c9f95c721b194 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29548) 
   
   <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



[GitHub] [flink] flinkbot commented on pull request #18380: [FLINK-25676][python] Support set_description in DataStream API

Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #18380:
URL: https://github.com/apache/flink/pull/18380#issuecomment-1014348700


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "8567524e525600f37c4bfab1100c9f95c721b194",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 8567524e525600f37c4bfab1100c9f95c721b194 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