You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Dawid Wysakowicz (Jira)" <ji...@apache.org> on 2021/10/07 07:12:00 UTC
[jira] [Updated] (FLINK-24465) Wrong javadoc and documentation for
buffer timeout
[ https://issues.apache.org/jira/browse/FLINK-24465?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dawid Wysakowicz updated FLINK-24465:
-------------------------------------
Description:
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. {{0}} behaves as {{-1}} in the above description, at least from what I gathered. There is no way to configure behaviour described above for {{0}}.
was:
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 is illegal (it throws an exception). {{0}} behaves as {{-1}} in the above description, at least from what I gathered. There is no way to configure behaviour described above for {{0}}.
> 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
> Priority: Major
> Fix For: 1.13.3, 1.15.0, 1.14.1
>
>
> 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. {{0}} behaves as {{-1}} in the above description, at least from what I gathered. There is no way to configure behaviour described above for {{0}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)