You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@logging.apache.org by "ppkarwasz (via GitHub)" <gi...@apache.org> on 2024/07/26 13:16:31 UTC

[PR] Revamp file and delegating appenders (logging-log4j2)

ppkarwasz opened a new pull request, #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772

   This PR splits the documentation of file appenders and the `Async`, `Failover`, `Rewrite` and `Routing` appenders into their own files.
   
   As in the previous PRs we:
   
   * check and reformat the configuration options,
   * add links to the Plugin Reference,
   * improve the readability of the description by shortening it and reformatting it,
   * remove examples to provide smaller ones that make the same point.
   
   Part of #2528.
   
   


-- 
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: notifications-unsubscribe@logging.apache.org

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


Re: [PR] Revamp file and delegating appenders (logging-log4j2)

Posted by "ppkarwasz (via GitHub)" <gi...@apache.org>.
ppkarwasz merged PR #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772


-- 
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: notifications-unsubscribe@logging.apache.org

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


Re: [PR] Revamp file and delegating appenders (logging-log4j2)

Posted by "ppkarwasz (via GitHub)" <gi...@apache.org>.
ppkarwasz commented on code in PR #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772#discussion_r1699937290


##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########
@@ -134,44 +160,45 @@ The following configuration attributes are also evaluated at runtime, so can con
 |===
 | Component | Parameter | Event type | Evaluation context
 
-| <<HttpAppender,`HttpAppender`>>
+| <<HttpAppender,`Http` appender>>

Review Comment:
   Fixed in https://github.com/apache/logging-log4j2/pull/2772/commits/1ee9841823150e3f02950c95eb3e24df0d95a0ae



-- 
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: notifications-unsubscribe@logging.apache.org

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


Re: [PR] Revamp file and delegating appenders (logging-log4j2)

Posted by "ppkarwasz (via GitHub)" <gi...@apache.org>.
ppkarwasz commented on code in PR #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772#discussion_r1699941740


##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########


Review Comment:
   1. No, because the default of `bufferedIo` is always `true`, regardless of `log4j2.enableDirectEncoders`.
   2. Fixed in https://github.com/apache/logging-log4j2/pull/2772/commits/91286cc75ad18a54dc3355b71fd7b96ca5b22ff8



-- 
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: notifications-unsubscribe@logging.apache.org

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


Re: [PR] Revamp file and delegating appenders (logging-log4j2)

Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on code in PR #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772#discussion_r1693285423


##########
src/site/antora/modules/ROOT/nav.adoc:
##########
@@ -43,7 +43,9 @@
 ** xref:manual/systemproperties.adoc[]
 ** xref:manual/customconfig.adoc[]
 ** xref:manual/appenders.adoc[]
+*** xref:manual/appenders/file.adoc[]

Review Comment:
   Shouldn't we move `rolling-file.adoc` to `appenders` folder to comply with this foldering convention too?



##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########
@@ -134,44 +160,45 @@ The following configuration attributes are also evaluated at runtime, so can con
 |===
 | Component | Parameter | Event type | Evaluation context
 
-| <<HttpAppender,`HttpAppender`>>
+| <<HttpAppender,`Http` appender>>

Review Comment:
   In accordance with our following existing component naming convention
   ```
   Pattern Layout
   JSON Template Layout
   etc.
   ```
   could you rename these to
   ```
   HTTP Appender
   Kafka Appender
   etc.
   ```
   please?



##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########


Review Comment:
   1. Shouldn't the default of `bufferedIo` point to `log4j2.enableDirectEncoders`, just like `bufferSize`?
   2. `can contain escaped $${...} expressions` :arrow_right: Can you rename `expressions` to `property substitution expressions`, please?



##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########
@@ -182,168 +209,6 @@ See xref:manual/configuration.adoc#lazy-property-substitution[runtime property s
 Log4j bundles several predefined appenders to assist in several common deployment use cases.
 Following sections explain all these in detail.
 
-[id=AsyncAppender]
-=== [[asyncappender]] AsyncAppender

Review Comment:
   We remove several appenders from the collection and only provide access to them in `nav.adoc`. IMHO, this incoherent navigation style makes it difficult for users to locate the removed appenders. Can't we instead keep them in the list of collections, but provide a link instead? (This is what we have done in `layouts.adoc` for PL and JTL too.)



-- 
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: notifications-unsubscribe@logging.apache.org

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


Re: [PR] Revamp file and delegating appenders (logging-log4j2)

Posted by "ppkarwasz (via GitHub)" <gi...@apache.org>.
ppkarwasz commented on code in PR #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772#discussion_r1699942093


##########
src/site/antora/modules/ROOT/pages/manual/appenders.adoc:
##########
@@ -182,168 +209,6 @@ See xref:manual/configuration.adoc#lazy-property-substitution[runtime property s
 Log4j bundles several predefined appenders to assist in several common deployment use cases.
 Following sections explain all these in detail.
 
-[id=AsyncAppender]
-=== [[asyncappender]] AsyncAppender

Review Comment:
   Should be fixed in https://github.com/apache/logging-log4j2/pull/2772/commits/0494163acaf10a1efa76e00ece04a24b6c7acc08



-- 
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: notifications-unsubscribe@logging.apache.org

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


Re: [PR] Revamp file and delegating appenders (logging-log4j2)

Posted by "ppkarwasz (via GitHub)" <gi...@apache.org>.
ppkarwasz commented on code in PR #2772:
URL: https://github.com/apache/logging-log4j2/pull/2772#discussion_r1699933649


##########
src/site/antora/modules/ROOT/nav.adoc:
##########
@@ -43,7 +43,9 @@
 ** xref:manual/systemproperties.adoc[]
 ** xref:manual/customconfig.adoc[]
 ** xref:manual/appenders.adoc[]
+*** xref:manual/appenders/file.adoc[]

Review Comment:
   Fixed in https://github.com/apache/logging-log4j2/pull/2772/commits/0494163acaf10a1efa76e00ece04a24b6c7acc08



-- 
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: notifications-unsubscribe@logging.apache.org

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