You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Ruguo Yu (Jira)" <ji...@apache.org> on 2021/01/15 09:56:00 UTC
[jira] [Commented] (FLINK-20914) Format the description of
'security.ssl.internal.session-cache-size' option
[ https://issues.apache.org/jira/browse/FLINK-20914?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17265864#comment-17265864 ]
Ruguo Yu commented on FLINK-20914:
----------------------------------
Hi [~rmetzger], do we consider standardizing the description of this configurationoption? If it's ok, please assign it to me, THX!
> Format the description of 'security.ssl.internal.session-cache-size' option
> ---------------------------------------------------------------------------
>
> Key: FLINK-20914
> URL: https://issues.apache.org/jira/browse/FLINK-20914
> Project: Flink
> Issue Type: Improvement
> Components: API / Core
> Affects Versions: 1.12.0
> Reporter: Ruguo Yu
> Priority: Minor
> Labels: pull-request-available
> Fix For: 1.13.0
>
>
> The description of ConfigOption 'security.ssl.internal.session-cache-size' has a URL link, as follows:
> {code:java}
> public static final ConfigOption<Integer> SSL_INTERNAL_SESSION_CACHE_SIZE =
> key("security.ssl.internal.session-cache-size")
> .intType()
> .defaultValue(-1)
> .withDescription(
> "The size of the cache used for storing SSL session objects. "
> + "According to https://github.com/netty/netty/issues/832, you should always set "
> + "this to an appropriate number to not run into a bug with stalling IO threads "
> + "during garbage collection. (-1 = use system default).")
> .withDeprecatedKeys("security.ssl.session-cache-size");
> {code}
> so the most reasonable way is to use *Text Description* with *Link,* as follows:
> {code:java}
> public static final ConfigOption<Integer> SSL_INTERNAL_SESSION_CACHE_SIZE =
> key("security.ssl.internal.session-cache-size")
> .intType()
> .defaultValue(-1)
> .withDescription(
> Description.builder()
> .text(
> "The size of the cache used for storing SSL session objects. "
> + "According to %s, you should always set "
> + "this to an appropriate number to not run into a bug with stalling IO threads "
> + "during garbage collection. (-1 = use system default).",
> link(
> "https://github.com/netty/netty/issues/832",
> "here"))
> .build())
> .withDeprecatedKeys("security.ssl.session-cache-size");
> {code}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)