Updated references of logback.groovy to logback-spring.xml #936

gsartori · 2024-12-20T08:52:20Z

matrei · 2024-12-20T09:04:20Z

src/en/guide/conf/config/logging.adoc

@@ -1,4 +1,4 @@
-Since Grails 3.0, logging is handled by the http://logback.qos.ch[Logback logging framework] and can be configured with the `grails-app/conf/logback.xml` file.
+Since Grails 3.0, logging is handled by the http://logback.qos.ch[Logback logging framework] and can be configured with the `grails-app/conf/logback-spring.xml` file.


Should we mention that logback.xml still works?
For example: '... and can be configured with the grails-app/conf/logback-spring.xml or grails-app/conf/logback.xml files.'

If we are moving to logback-spring.xml my opinion is to not document it. logback.xml will work for applications that are ported to Grails 7, but I would not make it an "official" feature documenting it.

I've documented logback-spring.xml with a link to the Spring documentation for all the other options. Let me know if that convinces you

matrei · 2024-12-20T09:05:45Z

src/en/guide/conf/config/logging.adoc

@@ -1,4 +1,4 @@
-Since Grails 3.0, logging is handled by the http://logback.qos.ch[Logback logging framework] and can be configured with the `grails-app/conf/logback.xml` file.
+Since Grails 3.0, logging is handled by the http://logback.qos.ch[Logback logging framework] and can be configured with the `grails-app/conf/logback-spring.xml` file.

 NOTE: Since Grails 5.1.2 support for groovy configuration (`grails-app/conf/logback.groovy`) has been removed (by logback 1.2.9). It is possible to add back groovy configuration by adding the https://github.com/virtualdogbert/logback-groovy-config[logback-groovy-config] library to your project.


I think we need this library updated to Groovy 4 in order to make this claim for Grails 7.

We may wait to see if something moves here:
virtualdogbert/logback-groovy-config#15

And we can have grails-forge generate an exclude to make it work with 7, in the interim.

src/en/guide/conf/config/logging/externalLoggingConfiguration.adoc

matrei · 2024-12-20T09:11:38Z

src/en/guide/plugins/creatingAndInstallingPlugins.adoc

@@ -276,7 +276,7 @@ Although the link:../ref/Command%20Line/create-plugin.html[create-plugin] comman
 * `grails-app/build.gradle` (although it is used to generate `dependencies.groovy`)
 * `grails-app/conf/application.yml` (renamed to plugin.yml)
 * `grails-app/conf/spring/resources.groovy`
-* `grails-app/conf/logback.groovy`
+* `grails-app/conf/logback-spring.xml`


logback.xml and application.groovy are also be excluded

To your knowledge will application.groovy be renamed to plugin.groovy as well?

Also, my opinion is to not document logback.xml if we decided to go with logback-spring.xml

To your knowledge will application.groovy be renamed to plugin.groovy as well?

To my knowledge, it does not get automatically renamed. That comment is a bit cryptic. To my knowledge, if a plugin author wants config from the plugin to be included in consuming applications, he/she should put it in a file named plugin.yml.

Also, my opinion is to not document logback.xml if we decided to go with logback-spring.xml

My opinion is to document both, for the time being. Otherwise, people might think they have to switch.

Cheking the Spring Boot docs, both names can be used (preferring logback-spring.yml) https://docs.spring.io/spring-boot/reference/features/logging.html#features.logging.custom-log-configuration

Why not just documenting logback-spring.xml adding a link to the Spring documentation letting people see all the quirks and quarks of configuring the logs?

On a side note, I just found out that we can also configure the logs directly in the application.yml it may be a good option so we can remove the logback-spring.xml file altogether (I'll give this a try and maybe open a feature request).

src/en/guide/plugins/creatingAndInstallingPlugins.adoc

src/en/guide/plugins/providingBasicArtefacts.adoc

src/en/guide/theWebLayer/interceptors/interceptorOrdering.adoc

matrei · 2024-12-20T14:13:31Z

src/en/guide/plugins/creatingAndInstallingPlugins.adoc

+- `grails-app/conf/plugin.yml`
+- `grails-app/conf/plugin.groovy`
+
+These files are the equivalent of `application.yml` or `application.groovy` in a Grails application.


@gsartori This is not entirely correct. You can have an application.yml or application.groovy in a plugin project. These configs will just not make it into the consuming application. Examples of config settings that could be in a plugins application.yml file:

grails: profile: web-plugin codegen: defaultPackage: my.groovy.plugin

What about:

A Grails plugin can be configured in one of the following files:

grails-app/conf/plugin.yml

grails-app/conf/plugin.groovy

These files will be included in the plugin package while the application.yml file is used when the plugin is run as an application. See Notes on excluded Artefacts.

jamesfredley · 2024-12-23T12:56:00Z

src/en/guide/conf/config/logging.adoc


-NOTE: Since Grails 5.1.2 support for groovy configuration (`grails-app/conf/logback.groovy`) has been removed (by logback 1.2.9). It is possible to add back groovy configuration by adding the https://github.com/virtualdogbert/logback-groovy-config[logback-groovy-config] library to your project.
+- See the https://docs.spring.io/spring-boot/reference/features/logging.html[Spring Boot Logging] for all the available configuration options.


I think we should use the following links, since they go directly to the logback based configuration that we use.

https://docs.spring.io/spring-boot/how-to/logging.html
https://docs.spring.io/spring-boot/reference/features/logging.html#features.logging.logback-extensions

jamesfredley · 2024-12-23T12:58:01Z

src/en/guide/conf/config/logging/externalLoggingConfiguration.adoc

@@ -4,18 +4,18 @@ If you set the configuration property `logging.config`, you can instruct `Logbac
 .grails-app/conf/application.yml
 ----
 logging:
-    config: /Users/me/config/logback.groovy
+    config: /Users/me/config/logback.xml


Should these 3 be logback-spring.xml?

jamesfredley · 2024-12-23T13:05:05Z

src/en/guide/conf/config/logging.adoc

+//
+// NOTE: Since Grails 5.1.2 support for groovy configuration (`grails-app/conf/logback.groovy`) has been removed (by logback 1.2.9). It is possible to add back groovy configuration by adding the https://github.com/virtualdogbert/logback-groovy-config[logback-groovy-config] library to your project.
+


I think it would be beneficial to include an example logback-spring.xml file in this section and explain <springProfile name="development">, since that is the main advantage.

<?xml version="1.0" encoding="UTF-8"?> <configuration> <include resource="org/springframework/boot/logging/logback/defaults.xml"/> <include resource="org/springframework/boot/logging/logback/console-appender.xml"/> <root level="ERROR"> <appender-ref ref="CONSOLE"/> </root> <springProfile name="development"> <logger name="StackTrace" level="ERROR" additivity="false"/> <logger name="your.package" level="DEBUG"/> <logger name="org.hibernate.orm.deprecation" level="OFF"/> <root level="WARN"/> </springProfile> </configuration>

jamesfredley

Thank you, I added a few things in comments.

Updated references of logback.groovy to logback-spring.xml

801283d

gsartori mentioned this pull request Dec 20, 2024

Removing deprecated logback.groovy logics and docs from Grails 7 grails/grails-core#13927

Open

matrei reviewed Dec 20, 2024

View reviewed changes

Updating logback references & plugin configuration/packaging

17e24b0

matrei reviewed Dec 20, 2024

View reviewed changes

Plugin configuration files cleanups

0ecfc1c

jamesfredley reviewed Dec 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated references of logback.groovy to logback-spring.xml #936

Updated references of logback.groovy to logback-spring.xml #936

gsartori commented Dec 20, 2024

matrei Dec 20, 2024

gsartori Dec 20, 2024 •

edited

Loading

gsartori Dec 20, 2024

matrei Dec 20, 2024

gsartori Dec 20, 2024

jamesfredley Dec 20, 2024

matrei Dec 20, 2024

gsartori Dec 20, 2024

gsartori Dec 20, 2024

matrei Dec 20, 2024

gsartori Dec 20, 2024

matrei Dec 20, 2024

gsartori Dec 20, 2024

jamesfredley Dec 23, 2024

jamesfredley Dec 23, 2024

jamesfredley Dec 23, 2024

jamesfredley left a comment

		@@ -1,4 +1,4 @@
		Since Grails 3.0, logging is handled by the http://logback.qos.ch[Logback logging framework] and can be configured with the `grails-app/conf/logback.xml` file.
		Since Grails 3.0, logging is handled by the http://logback.qos.ch[Logback logging framework] and can be configured with the `grails-app/conf/logback-spring.xml` file.


		NOTE: Since Grails 5.1.2 support for groovy configuration (`grails-app/conf/logback.groovy`) has been removed (by logback 1.2.9). It is possible to add back groovy configuration by adding the https://github.com/virtualdogbert/logback-groovy-config[logback-groovy-config] library to your project.
		- See the https://docs.spring.io/spring-boot/reference/features/logging.html[Spring Boot Logging] for all the available configuration options.

		//
		// NOTE: Since Grails 5.1.2 support for groovy configuration (`grails-app/conf/logback.groovy`) has been removed (by logback 1.2.9). It is possible to add back groovy configuration by adding the https://github.com/virtualdogbert/logback-groovy-config[logback-groovy-config] library to your project.

Updated references of logback.groovy to logback-spring.xml #936

Are you sure you want to change the base?

Updated references of logback.groovy to logback-spring.xml #936

Conversation

gsartori commented Dec 20, 2024

Choose a reason for hiding this comment

gsartori Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jamesfredley left a comment

Choose a reason for hiding this comment

gsartori Dec 20, 2024 •

edited

Loading