Guidelines for the Responsible Use of Generative AI in the Experience Cloud Community.
Configure logback.xml file AEM 6.5
My understanding is that you can't override org.apache.sling.commons.log.configurationFile property for a custom factory, but I may be mistaken. At least it says so here. https://sling.apache.org/documentation/development/logging.html
I tried and the field wouldn't render in my system console... (http://localhost:4503/system/console/configMgr)
I think you can only set the logback.xml on the Apache Sling Logging Configuration
which points to the following directory to find your logback.xml: C:\Users\XXXXXX\aem\aem\publish\crx-quickstart (${sling.home})
... or wherever you have installed your aem instance for development purposes.
Also, change your root XML node to include the debug attribute as shown below. This will provide more information in the aem console on the bootup of the server with problems with your logback config.
<configuration debug="true">
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>/logs/SampleProject.log</file>
<append>true</append>
<immediateFlush>true</immediateFlush>
....
I tried getting it working with Sentry... but Sentry is not part of the following repo or binding, so it wouldn't work as a custom appender. My error: Caused by: java.lang.ClassNotFoundException: io.sentry.logback.SentryAppender not found by org.apache.sling.commons.log [15].
Logback Core and Logback Classic are part of the apache-sling-commons-log source so they should work.
https://mvnrepository.com/artifact/org.apache.sling/org.apache.sling.commons.log
Refer to the following for more info as well: https://www.baeldung.com/logback
I think I would have to branch off the repo... https://github.com/apache/sling-org-apache-sling-commons-log
and add sentry libraries as maven imports. Here was my logback.xml for reference.
<configuration debug="true">
<!-- Configure the Sentry appender, overriding the logging threshold to the WARN level -->
<appender name="Sentry" class="io.sentry.logback.SentryAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
<options>
<dsn>xxxxx</dsn>
</options>
<minimumEventLevel>WARN</minimumEventLevel>
</appender>
<!-- Enable the Console and Sentry appenders, Console is provided as an example
of a non-Sentry logger that is set to a different logging threshold -->
<root level="WARN">
<appender-ref ref="Sentry" />
</root>
</configuration>
I added Sentry via a servlet filter class and wrapped a chain method in a try-catch instead and configured a high ranking value so it would be executed first. At least we have coverage on our servlets.
package com.example.filters;
import io.sentry.Sentry;
import org.osgi.service.component.annotations.Component;
import javax.servlet.*;
import java.io.IOException;
import org.osgi.framework.Constants;
import com.example.services.SentryConfigService;
import org.osgi.service.component.annotations.Reference;
/**
* This filter will run before every Servlet call and every other Filter
* The objective of this Filter is to catch all unhandled exceptions and log them in sentry
* If adding a new filter ensure it is less than the Sentry Filter Ranking value of 999
*/
@Component(
service = Filter.class,
property = {
"sling.filter.scope=" + SentryFilter.REQUEST_FILTER_SCOPE,
Constants.SERVICE_RANKING + ":Integer=999",
"sling.filter.pattern=" + SentryFilter.CST_SERVLET_FILTER_PATTERN,
})
public class SentryFilter implements Filter {
static final String REQUEST_FILTER_SCOPE = "request";
static final String CST_SERVLET_FILTER_PATTERN = "/bin/example/api/.*";
private SentryConfigService sentryConfigService;
/**
* Init is called at application start up of the AEM package. This method is executed regardless if a servlet call is made.
* In addition, this means changes to the Sentry config values won't reflect at runtime or immediately. A build
* or reboot of the application needs to be performed in order to re-execute the init function to apply the updated config values.
*/
public void init(FilterConfig filterconfig) {
if (sentryConfigService.isActive()) {
Sentry.init(options -> {
options.setDsn(sentryConfigService.getDsnKey());
options.setTracesSampleRate(Double.valueOf(sentryConfigService.getTraceRateKey()));
});
}
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
try {
chain.doFilter(request, response);
} catch (Throwable e) {
Sentry.captureException(e);
throw e;
}
}
public void destroy() {
// Is normal to do nothing
}
}
I just jumped to level 100 in AEM forums on my first post despite being a lowly level one. Booyah!
Caused by: java.lang.ClassNotFoundException: io.sentry.logback.SentryAppender not found by org.apache.sling.commons.log [15]
io.sentry.logback* and io.sentry* must be locally exported libraries within the context of org.apache.sling.commons.log as I previously implemented.
version 5.5.1
version 5.1.10, this is the pom.xml
0. Be sure to check your version of apache.sling.commons.log in aem and download that version from Git Hub and build that. If you get an ant build javascript engine exception you need to install Java 8 a.k.a Java 1.8 SDK and build the source code. My instance of AEM 6.5 has 5.1.10 installed so I had to use Java 8 to compile the souce.
1. Make the changes as shown above.
2. Compile the source code
3. Uninstall the existing bundle for org.apache.sling.commons.log here... (http://localhost:4503/system/console/bundles)
4. Install the newly compiled bundle, set activate and set the bundle start order to 1 (logging should start first)
5. Update the Sling Logging Configuration to point to the new bundle under the binding section. This will now be an input stream since you installed it manually. Before it was probably sling as this was the install at the time of setting up AEM and was installed from the file system.
6. Configure logback.xml with sentry config appropriately to your threshold of logging
7. Reboot AEM and check logs for errors
The major caveat with using logback.xml is that you are now responsible for all logging handling within the file itself. It will override all org.apache.sling.commons.log.LogManager.factory.config files in your aem project and any built-in handlers within AEM. (Workaround in next reply)
Note that if you have multiple projects installed in AEM they will go to the same sentry DSN unless there is a way to filter based on logger configs. I haven't done this yet but in theory, you could configure multiple sentry appenders with various DSN endpoints. I have to test out still, but this is the idea...
Read more about loggers here: https://logback.qos.ch/manual/configuration.html
I believe the logger hierarchy will only manage exceptions or errors within the context of your source package and associated children.
<configuration debug="true">
<!-- Configure the Sentry appender, overriding the logging threshold to the WARN level -->
<appender name="SentryOne" class="io.sentry.logback.SentryAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
<options>
<dsn>xxxxx</dsn>
</options>
<minimumEventLevel>ERROR</minimumEventLevel>
</appender>
<appender name="SentryTwo" class="io.sentry.logback.SentryAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
<options>
<dsn>aaaaaaaa</dsn>
</options>
<minimumEventLevel>ERROR</minimumEventLevel>
</appender>
<logger name="com.example1.test">
<appender-ref ref="SentryOne" />
</logger>
<logger name="com.example2.test">
<appender-ref ref="SentryTwo" />
</logger>
<!-- Enable the Console and Sentry appenders, Console is provided as an example
of a non-Sentry logger that is set to a different logging threshold -->
<root level="INFO">
<appender-ref ref="SentryOne" />
<appender-ref ref="SentryTwo" />
</root>
</configuration>
I found out how to use logback.xml while retaining factory configs and aem default log behavior. I pulled this from global file log manager config in apache.sling.commons.log source. After some experimenting, I realized you need to use the include node which will just add to the existing global config. Adding appenders in the main logback.xml overrides the default logging behavior of aem and corrupts any factory.configs one has implemented.
<configuration debug="true">
<!--
This config file is used when LogBack is being configured from LogbackManager and no
explicit config is provided. It provides global settings which are then merged with the
OSGi config.
-->
<jmxConfigurator />
<newRule pattern="*/configuration/osgi"
actionClass="org.apache.sling.commons.log.logback.OsgiAction"/>
<newRule pattern="*/configuration/appender-ref-osgi"
actionClass="org.apache.sling.commons.log.logback.OsgiAppenderRefAction"/>
<osgi/>
<include file="${sling.home}\sentry.xml"/>
</configuration>
and sentry.xml or any other type of logback appending you want.
<included>
<appender name="Sentry" class="io.sentry.logback.SentryAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
<options>
<dsn>xxxxxx</dsn>
</options>
</appender>
<logger name="com" level="ERROR">
<appender-ref ref="Sentry" />
</logger>
<logger name="org" level="ERROR">
<appender-ref ref="Sentry" />
</logger>
</included>
If you update your logback.xml to include further files or any other changes in any child files you can reload them without turning off the aem server by clicking the update button on the org.apache.sling.commons.log bundle. This triggers a reset event and reloads the logback.xml at runtime via an event.
http://localhost:4503/system/console/bundles
An OSGi event with the org/apache/sling/commons/log/RESET topic resets the Logback at runtime.
I have no idea how to create another global sling config or set the above properties in it directly via a config file unless I modify the org.sling.apache.commons.log source code directly. I believe this is only a config that can manually be set through the user interface. I think you can only override the following as stated in the documentation.
If someone knows how to set those properties via some sort of global config file or bundle config please share. I don't believe the previous comments to be true but I may be incorrect.
@cakayastha Did you find the suggestions helpful? Please let us know if more information is required. Otherwise, please mark the answer as correct for posterity. If you have found out solution yourself, please share it with the community.
Kautuk Sahni
Related Conversations
