Letztens haben wir versucht einen Java agent auszuliefernden. Dieser wird dann in eine andere ‚beliebige‘ Java Applikation eingebaut.<\/p>\n\n\n\n
Wie es so mit Java Applikationen ist, gibt es ja einen bunten Blumenstrau\u00df an Logging Frameworks mit noch mehr Versionen. Unser Java Agent soll aber unabh\u00e4ngig von der Applikation loggen k\u00f6nnen und das am Besten mit eigener Konfiguration. Auch soll die instrumentalisierte Java Applikation nicht durch das Logging des Agents beeinflusst werden.<\/p>\n\n\n\n
Das Erste, was mir dazu einf\u00e4llt, um dieses Problem zu l\u00f6sen ist das maven shading plugin. Damit bekomme ich ‚mein‘ logging Framework in den Agent UND kann verhindern, dass das logging der Java Applikation benutzt wird. <\/p>\n\n\n\n
<plugin>\n <groupId>org.apache.maven.plugins<\/groupId>\n <artifactId>maven-shade-plugin<\/artifactId>\n <executions>\n <execution>\n <phase>package<\/phase>\n <goals>\n <goal>shade<\/goal>\n <\/goals>\n <\/execution>\n <\/executions>\n <configuration>\n <finalName>agent-shaded<\/finalName>\n <shadedArtifactAttached>true<\/shadedArtifactAttached>\n <shadedClassifierName>shaded<\/shadedClassifierName>\n <createDependencyReducedPom>true<\/createDependencyReducedPom>\n <relocations>\n <relocation>\n <pattern>org.slf4j<\/pattern>\n <shadedPattern>my.package.org.slf4j<\/shadedPattern>\n <\/relocation>\n <relocation>\n <pattern>ch.qos.logback<\/pattern>\n <shadedPattern>my.package.ch.qos.logback<\/shadedPattern>\n <\/relocation>\n <\/relocations>\n <transformers>\n <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">\n <manifestEntries>\n <Premain-Class>my.package.instrumentation.InstrumentationAgent<\/Premain-Class>\n <Can-Redefine-Classes>true<\/Can-Redefine-Classes>\n <Can-Retransform-Classes>true<\/Can-Retransform-Classes>\n <\/manifestEntries>\n <\/transformer>\n <\/transformers>\n <\/configuration>\n <\/plugin><\/code><\/pre><\/div>\n\n\n\nDas mit der Relocation klappt schon ganz gut. Das Logback, dass im Agent ist, kann jetzt nicht mehr von der Java Applikation angesprochen werden, da es ja jetzt unter my.package.ch.qos.logback<\/em> liegt und nicht mehr unter ch.qos.logback<\/em>. Das Selbe gilt f\u00fcr slf4j.<\/p>\n\n\n\nAber jetzt kommt die B\u00d6SE Konfiguration:
Wenn die Java Anwendung mit den Agent gestartet wird und die Java Anwendung kein<\/strong> logback benutzt, dann ist alles ganz einfach. Mann benutzt die normale Logback Konfiguration und passt die Pfade auf das Relocation an:<\/p>\n\n\n\n<?xml version="1.0" encoding="UTF-8"?>\n<configuration>\n <appender name="OPS_FILE" class="my.package.ch.qos.logback.core.rolling.RollingFileAppender">\n <file>agent.log<\/file>\n <rollingPolicy class="my.package.ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">\n <fileNamePattern>agent.%d{yyyy-MM-dd}.%i.gz<\/fileNamePattern>\n <maxFileSize>20MB<\/maxFileSize>\n <maxHistory>30<\/maxHistory>\n <totalSizeCap>1GB<\/totalSizeCap>\n <\/rollingPolicy>\n <append>true<\/append>\n <immediateFlush>true<\/immediateFlush>\n <encoder>\n <pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} %-5level %thread [%c{15}] %msg%ex%n<\/pattern>\n <\/encoder>\n <\/appender>\n <root level="DEBUG">\n <appender-ref ref="OPS_FILE"\/>\n <\/root>\n<\/configuration>\n<\/code><\/pre><\/div>\n\n\n\nBenutzt die Java Applikation aber jetzt selber logback, dann bekommt man mit der Konfigurationsaufl\u00f6sung von logback Probleme:
Benutzt die Anwendung z.B. eine logback.xml<\/em> auf dem Classpath, dann bekommt das auch logback im Agent mit.
Da die Klassen durch das shading anders hei\u00dfen fliegen beim Aufl\u00f6sen der Konfiguration im Agent Fehlermeldungen, die unsch\u00f6n sind.<\/p>\n\n\n\nDas Problem<\/em> bzw. die L\u00f6sung liegt in der Auto Konfiguration in der Methode ch.qos.logback.classic.util.ContextInitializer. Man kann hier leider nicht eingreifen, da hier alles \u00fcber Konvention automatisch l\u00e4uft. Siehe auch http:\/\/logback.qos.ch\/manual\/configuration.html.<\/p>\n\n\n\nJetzt k\u00f6nnte man sich die logback forken, die Klasse anpassen und sein eigenes logback benutzten. Aber wenn man schon Java Agent benutzt, kann man auch f\u00fcr dieses Problem anpassen.<\/p>\n\n\n\n
import java.lang.instrument.ClassFileTransformer;\nimport java.lang.instrument.IllegalClassFormatException;\nimport java.security.ProtectionDomain;\n\nimport javassist.ClassPool;\nimport javassist.CtClass;\nimport javassist.CtMethod;\n\npublic class LoggingTransformer implements ClassFileTransformer {\n\n @Override\n public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,\n ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {\n byte[] byteCode = classfileBuffer;\n\n if (className.equals("my\/package\/ch\/qos\/logback\/classic\/util\/ContextInitializer")) {\n try {\n ClassPool cp = ClassPool.getDefault();\n CtClass cc = cp.get("my.package.ch.qos.logback.classic.util.ContextInitializer");\n CtMethod m = cc.getDeclaredMethod("autoConfig");\n \/\/ If we return null here we skip the default configuration file resolution.\n \/\/ Thus we have the BasicConfigurator.\n m.setBody("{return null;}");\n byteCode = cc.toBytecode();\n cc.detach();\n } catch (Exception ex) {\n ex.printStackTrace();\n }\n }\n return byteCode;\n }\n}<\/code><\/pre><\/div>\n\n\n\nSomit hat man die komplette Autokonfiguration von logback zerst\u00f6rt und man kann seine eigene Konfiguration \u00fcbergeben. z.B. \u00fcber ein Konfigurationsfile:<\/p>\n\n\n\n
JoranConfigurator configurator = new JoranConfigurator();\n\n LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();\n configurator.setContext(context);\n\n String pathToLogbackConfig = System.getProperty("agent.logback.configurationFile");\n if (pathToLogbackConfig == null) {\n System.out.println("There was no configuration for logging of the agent provided.");\n return;\n }\n\n try {\n File file = new File(pathToLogbackConfig);\n if (file.exists()) {\n context.reset();\n configurator.doConfigure(file);\n } else {\n System.err.println(\n "There was no 'agent-logback.xml' logging-configuration provided. This means all logging of the agent is lost!");\n }\n } catch (JoranException e) {\n System.err.println("There was an error during building the agent logging configuration.");\n System.out.println(e);\n }<\/code><\/pre><\/div>\n\n\n\nJetzt kann man den Agent nach Belieben Konfigurieren und das logging der Java Applikation und des Agent ist komplett getrennt.<\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Letztens haben wir versucht einen Java agent auszuliefernden. Dieser wird dann in eine andere ‚beliebige‘ Java Applikation eingebaut. Wie es so mit Java Applikationen ist, gibt es ja einen bunten Blumenstrau\u00df an Logging Frameworks mit noch mehr Versionen. Unser Java Agent soll aber unabh\u00e4ngig von der Applikation loggen k\u00f6nnen und das am Besten mit eigener […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5,3,4,6],"tags":[],"class_list":["post-9","post","type-post","status-publish","format-standard","hentry","category-agent","category-informatics","category-java","category-logging","post-preview"],"_links":{"self":[{"href":"https:\/\/the-bug.de\/index.php?rest_route=\/wp\/v2\/posts\/9","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/the-bug.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/the-bug.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/the-bug.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/the-bug.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=9"}],"version-history":[{"count":10,"href":"https:\/\/the-bug.de\/index.php?rest_route=\/wp\/v2\/posts\/9\/revisions"}],"predecessor-version":[{"id":34,"href":"https:\/\/the-bug.de\/index.php?rest_route=\/wp\/v2\/posts\/9\/revisions\/34"}],"wp:attachment":[{"href":"https:\/\/the-bug.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=9"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/the-bug.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=9"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/the-bug.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=9"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}