[jira] [Closed] (FLINK-24465) Wrong javadoc and documentation for buffer timeout

["Dawid Wysakowicz (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/FLINK-24465?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dawid Wysakowicz closed FLINK-24465.
------------------------------------
    Release Note: Configuring buffer timeout to be equal to `-1` to flush only when buffers were full was broken in FLINK-18832. In Stream execution mode it was overwritten with 100ms. Fortunately it should not have had a visible impact as `100ms` should still be enough time to fill in buffers before sending them downstream.
        Assignee: Dawid Wysakowicz
      Resolution: Fixed

Fixed in:
* master
** da9e1831e755a3b98588cf7954c2ca2901d2a2a6
* 1.14.1
** c337fff9d59142fd76fc67f75df7c4f50ea243bc
* 1.13.4
** 3209129b676605b573cc1fa67ef649cabb158807

> Wrong javadoc and documentation for buffer timeout
> --------------------------------------------------
>
>                 Key: FLINK-24465
>                 URL: https://issues.apache.org/jira/browse/FLINK-24465
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation, Runtime / Configuration, Runtime / Network
>    Affects Versions: 1.14.0, 1.13.2
>            Reporter: Dawid Wysakowicz
>            Assignee: Dawid Wysakowicz
>            Priority: Major
>              Labels: pull-request-available
>             Fix For: 1.15.0, 1.14.1, 1.13.4
>
>
> The javadoc for {{setBufferTimeout}} and similarly the documentation for {{execution.buffer-timeout}} claims:
> {code}
>     /**
>      * Sets the maximum time frequency (milliseconds) for the flushing of the output buffers. By
>      * default the output buffers flush frequently to provide low latency and to aid smooth
>      * developer experience. Setting the parameter can result in three logical modes:
>      *
>      * <ul>
>      *   <li>A positive integer triggers flushing periodically by that integer
>      *   <li>0 triggers flushing after every record thus minimizing latency
>      *   <li>-1 triggers flushing only when the output buffer is full thus maximizing throughput
>      * </ul>
>      *
>      * @param timeoutMillis The maximum time between two output flushes.
>      */
> {code}
> which is not true.
> The {{-1}} value translates to 100ms. See {{org.apache.flink.streaming.api.graph.StreamingJobGraphGenerator#checkAndResetBufferTimeout}}



--
This message was sent by Atlassian Jira
(v8.3.4#803005)