{"id":732,"date":"2018-03-23T15:08:19","date_gmt":"2018-03-23T15:08:19","guid":{"rendered":"http:\/\/www.andreagirardi.it\/blog\/?p=732"},"modified":"2018-04-13T13:54:14","modified_gmt":"2018-04-13T13:54:14","slug":"how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender","status":"publish","type":"post","link":"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/","title":{"rendered":"How to use Spring DataSource bean as data source for Log4j 2 JDBC appender"},"content":{"rendered":"<p>I would like to log log4j2 messages into a relational database using the datasource defined on application context and initialized using spring using <strong>log4j 2.10<\/strong>.<br \/>\n<br \/>\nOne possibility is to add a JDBC appender inside log4j2 xml configuration but, Log4j is initialized before Spring so, dataSource won&#8217;t be available at runtime so the only solution is to add an appender programmatically. Of course, it is possible to use a log4j2 jdbc appender but, this approach allow to have the possibility to use spring.properties file to override the spring application context with proper environment settings in according to my profile.<\/p>\n<p>This is the datasource defined on application context xml:<\/p>\n<pre lang=\"xml\">\r\n<!-- \u00a0############ SQLSERVER DATABASE SECTION ############ -->\r\n<bean id=\"dataSourceMSSqlServer\" class=\"org.springframework.jdbc.datasource.DriverManagerDataSource\">\r\n\u00a0 \u00a0 <property name=\"driverClassName\" value=\"com.microsoft.sqlserver.jdbc.SQLServerDriver\" \/>\r\n\u00a0 \u00a0 <property name=\"url\" value=\"jdbc:sqlserver:\/\/${sqlserver.hostname};databaseName=${sqlserver.database};\" \/>\r\n\u00a0 \u00a0 <property name=\"username\" value=\"${sqlserver.user}\" \/>\r\n\u00a0 \u00a0 <property name=\"password\" value=\"${sqlserver.pass}\" \/>\r\n<\/bean>\r\n<\/pre>\n<p>this allow me to configure different database for every environment.<br \/>\nThis is the table on which I want to log the entries:<\/p>\n<pre lang=\"sql\">\r\n[Id] [int] IDENTITY(1,1) NOT NULL,\r\n[CreatedTimeStamp] [datetimeoffset](7) NOT NULL,\r\n[Level] [int] NOT NULL,\r\n[Source] [nvarchar](max) NULL,\r\n[Message] [nvarchar](max) NULL,\r\n[Content] [nvarchar](max) NULL,\r\n[ProductName] [nvarchar](max) NULL,\r\n[Version] [nvarchar](max) NULL,\r\n[LogType] [int] NOT NULL DEFAULT ((0)),\r\n[AuditEventType] [int] NULL,\r\n[UserId] [nvarchar](128) NULL,\r\n<\/pre>\n<p>The plan is to create a spring bean, inject the DataSource bean, and add JDBC Appender configuration dynamically in <b>@PostConstruct<\/b> method.<\/p>\n<pre lang=\"java\">\r\npackage com.afm.web.utility;\r\n\r\nimport java.sql.Connection;\r\nimport java.sql.SQLException;\r\n\r\nimport javax.annotation.PostConstruct;\r\nimport javax.sql.DataSource;\r\n\r\nimport org.apache.logging.log4j.Level;\r\nimport org.apache.logging.log4j.LogManager;\r\nimport org.apache.logging.log4j.core.Appender;\r\nimport org.apache.logging.log4j.core.LoggerContext;\r\nimport org.apache.logging.log4j.core.appender.db.ColumnMapping;\r\nimport org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig;\r\nimport org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource;\r\nimport org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender;\r\nimport org.apache.logging.log4j.core.config.AppenderRef;\r\nimport org.apache.logging.log4j.core.config.Configuration;\r\nimport org.apache.logging.log4j.core.config.LoggerConfig;\r\nimport org.springframework.beans.factory.annotation.Autowired;\r\nimport org.springframework.stereotype.Component;\r\n\r\n@Component\r\npublic class JDBCLog {\r\n\r\n    @Autowired\r\n    private DataSource dataSourceMSSqlServer;\r\n\t\r\n    \/\/ Inner class\r\n    class Connect implements ConnectionSource {\r\n\t  \r\n\tprivate DataSource dsource;\r\n\t  \r\n\tpublic Connect(DataSource dsource) {\r\n\t    this.dsource = dsource;\r\n\t}\r\n    \r\n\t@Override\r\n\tpublic Connection getConnection() throws SQLException {\r\n\t    return this.dsource.getConnection();\r\n\t}\r\n\r\n    }\r\n\t\r\n    public JDBCLog() {}\r\n\t\r\n    @PostConstruct\r\n    private void init(){\r\n\t\t  \r\n\tSystem.out.println(\"####### JDBCLog init() ########\");      \r\n\tfinal LoggerContext ctx = (LoggerContext) LogManager.getContext(false); \r\n\tfinal Configuration config = ctx.getConfiguration();\r\n\t\r\n\t\/\/ Here I define the columns I want to log. \r\n\tColumnConfig[] columnConfigs = new ColumnConfig[] {\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"CreatedTimeStamp\")\r\n                .setPattern(null)\r\n                .setLiteral(null)\r\n                .setEventTimestamp(true)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"Source\")\r\n                .setPattern(\"%K{className}\")\r\n                .setLiteral(null)\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"Level\")\r\n                .setPattern(\"%level\")\r\n                .setLiteral(null)\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"Message\")\r\n                .setPattern(\"%K{message}\")\r\n                .setLiteral(null)\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"Content\")\r\n                .setPattern(\"%K{exception}\")\r\n                .setLiteral(null)\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"ProductName\")\r\n                .setPattern(null)\r\n                .setLiteral(\"'DHC'\")\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"Version\")\r\n                .setPattern(null)\r\n                .setLiteral(\"'1.0'\")\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"AuditEventType\")\r\n                .setPattern(\"%K{eventId}\")\r\n                .setLiteral(null)\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"UserId\"\r\n                .setPattern(\"%K{userId}\")\r\n                .setLiteral(null)\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build(),\r\n\t    ColumnConfig.newBuilder()\r\n                .setName(\"LogType\")\r\n                .setPattern(\"%K{logType}\")\r\n                .setLiteral(null)\r\n                .setEventTimestamp(false)\r\n                .setUnicode(false)\r\n                .setClob(false).build()\r\n        };\r\n\t\t\r\n\tAppender jdbcAppender = JdbcAppender.newBuilder()\r\n\t\t.setBufferSize(0)\r\n                .setColumnConfigs(columnConfigs)\r\n                .setColumnMappings(new ColumnMapping[]{})\r\n                .setConnectionSource(new Connect(dataSourceMSSqlServer))\r\n                .setTableName(\"dhc.LogItems\")\r\n                .withName(\"databaseAppender\")\r\n                .withIgnoreExceptions(true)\r\n                .withFilter(null)\r\n                .build();\r\n\t\t  \r\n\tjdbcAppender.start();\r\n\tconfig.addAppender(jdbcAppender);\r\n\r\n\t\/\/ Create an Appender reference.\r\n\t\/\/ @param ref The name of the Appender.\r\n\t\/\/ @param level The Level to filter against.\r\n\t\/\/ @param filter The filter(s) to use.\r\n\t\/\/ @return The name of the Appender.\r\n\tAppenderRef ref= AppenderRef.createAppenderRef(\"JDBC_Appender\", null, null);\r\n        AppenderRef[] refs = new AppenderRef[] {ref};\r\n        \r\n        \/*\r\n         * Factory method to create a LoggerConfig.\r\n         *\r\n         * @param additivity true if additive, false otherwise.\r\n         * @param level The Level to be associated with the Logger.\r\n         * @param loggerName The name of the Logger.\r\n         * @param includeLocation whether location should be passed downstream\r\n         * @param refs An array of Appender names.\r\n         * @param properties Properties to pass to the Logger.\r\n         * @param config The Configuration.\r\n         * @param filter A Filter.\r\n         * @return A new LoggerConfig.\r\n         * @since 2.6\r\n         *\/\r\n        LoggerConfig loggerConfig = LoggerConfig.createLogger(\r\n                false, Level.DEBUG, \"JDBC_Logger\", null, refs, null, config, null);        \r\n        loggerConfig.addAppender(jdbcAppender, null, null);\r\n        \r\n        config.addLogger(\"JDBC_Logger\", loggerConfig);       \r\n        ctx.updateLoggers();  \r\n                \r\n        System.out.println(\"####### JDBCLog init() - DONE ########\");  \r\n\r\n    }\r\n\r\n    public DataSource getDataSource() {\r\n\treturn dataSourceMSSqlServer;\r\n    }\r\n\r\n    public void setDataSource(DataSource dataSourceMSSqlServer) {\r\n\tthis.dataSourceMSSqlServer = dataSourceMSSqlServer;\r\n    }\t  \r\n\t  \r\n}\r\n<\/pre>\n<p>At this point, is possible to call the logger from the code in this way:<\/p>\n<pre lang=\"java\">\r\nLogger jdbcLogger = LogManager.getContext(false).getLogger(\"JDBC_Logger\"); \r\njdbcLogger.info(new StringMapMessage()\r\n    .with(\"eventId\", AuditEventType.Logger_General.toString())\r\n    .with(\"exception\", \"\")\r\n    .with(\"userId\", \"TESTUSER\")\r\n    .with(\"message\", \"TEST!!\")\r\n    .with(\"className\", \r\n        this.getClass().getPackage().toString().replaceAll(\"package \", \"\") \r\n        + \".\" + this.getClass().getSimpleName() \r\n        + \".\" + new Object() {}.getClass().getEnclosingMethod().getName())\r\n);  \r\n<\/pre>\n<p>If you are using Log4j in a Servlet 2.5 web application, or if you have disabled auto-initialization with the isLog4jAutoInitializationDisabled context parameter, you must configure the <strong>Log4jServletContextListener<\/strong> and <strong>Log4jServletFilter<\/strong> in the deployment descriptor or programmatically. The filter should match all requests of any type. The listener should be the very first listener defined in your application, and the filter should be the very first filter defined and mapped in your application. This is easily accomplished using the following web.xml code:<\/p>\n<pre lang=\"xml\">\r\n<listener>\r\n    <listener-class>\r\n        org.apache.logging.log4j.web.Log4jServletContextListener\r\n    <\/listener-class>\r\n<\/listener>\r\n\r\n<filter>\r\n    <filter-name>log4jServletFilter<\/filter-name>\r\n    <filter-class>\r\n        org.apache.logging.log4j.web.Log4jServletFilter\r\n    <\/filter-class>\r\n<\/filter>\r\n<filter-mapping>\r\n    <filter-name>log4jServletFilter<\/filter-name>\r\n    <url-pattern>\/*<\/url-pattern>\r\n    <dispatcher>REQUEST<\/dispatcher>\r\n    <dispatcher>FORWARD<\/dispatcher>\r\n    <dispatcher>INCLUDE<\/dispatcher>\r\n    <dispatcher>ERROR<\/dispatcher>\r\n    <!-- \r\n        Servlet 3.0 w\/ disabled auto-initialization only; \r\n        not supported in 2.5 \r\n    -->\r\n    <dispatcher>ASYNC<\/dispatcher>\r\n<\/filter-mapping>\r\n<\/pre>\n<p>This dependency must be added to pom.xml:<\/p>\n<pre lang=\"xml\">\r\n<dependency>\r\n    <groupId>org.apache.logging.log4j<\/groupId>\r\n    <artifactId>log4j-web<\/artifactId>\r\n    <version>2.10.0<\/version>\r\n<\/dependency>\r\n<\/pre>\n<p>Of course, if you are not already included, add it to the component-scan into Spring application-context:<\/p>\n<pre lang=\"xml\">\r\n<context:component-scan base-package=\"com.afm.web.utility\" \/>\r\n<\/pre>\n<p>PS: if you like it please, click on the banner :)<\/p>\n<p>[AdSense-A]<\/p>\n<div class=\"sharedaddy sd-sharing-enabled\"><div class=\"robots-nocontent sd-block sd-social sd-social-icon-text sd-sharing\"><h3 class=\"sd-title\">Share this:<\/h3><div class=\"sd-content\"><ul><li class=\"share-linkedin\"><a rel=\"nofollow\" data-shared=\"sharing-linkedin-732\" class=\"share-linkedin sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=linkedin\" target=\"_blank\" title=\"Click to share on LinkedIn\"><span>LinkedIn<\/span><\/a><\/li><li class=\"share-reddit\"><a rel=\"nofollow\" data-shared=\"\" class=\"share-reddit sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=reddit\" target=\"_blank\" title=\"Click to share on Reddit\"><span>Reddit<\/span><\/a><\/li><li class=\"share-twitter\"><a rel=\"nofollow\" data-shared=\"sharing-twitter-732\" class=\"share-twitter sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=twitter\" target=\"_blank\" title=\"Click to share on Twitter\"><span>Twitter<\/span><\/a><\/li><li class=\"share-facebook\"><a rel=\"nofollow\" data-shared=\"sharing-facebook-732\" class=\"share-facebook sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=facebook\" target=\"_blank\" title=\"Click to share on Facebook\"><span>Facebook<\/span><\/a><\/li><li class=\"share-skype\"><a rel=\"nofollow\" data-shared=\"sharing-skype-732\" class=\"share-skype sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=skype\" target=\"_blank\" title=\"Share on Skype\"><span>Skype<\/span><\/a><\/li><li class=\"share-pocket\"><a rel=\"nofollow\" data-shared=\"\" class=\"share-pocket sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=pocket\" target=\"_blank\" title=\"Click to share on Pocket\"><span>Pocket<\/span><\/a><\/li><li class=\"share-end\"><\/li><\/ul><\/div><\/div><\/div>","protected":false},"excerpt":{"rendered":"<p>I would like to log log4j2 messages into a relational database using the datasource defined on application context and initialized using spring using log4j 2.10. One possibility is to add a JDBC appender inside log4j2 xml configuration but, Log4j is initialized before Spring so, dataSource won&#8217;t be available at runtime so the only solution is [&hellip;]<\/p>\n<div class=\"sharedaddy sd-sharing-enabled\"><div class=\"robots-nocontent sd-block sd-social sd-social-icon-text sd-sharing\"><h3 class=\"sd-title\">Share this:<\/h3><div class=\"sd-content\"><ul><li class=\"share-linkedin\"><a rel=\"nofollow\" data-shared=\"sharing-linkedin-732\" class=\"share-linkedin sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=linkedin\" target=\"_blank\" title=\"Click to share on LinkedIn\"><span>LinkedIn<\/span><\/a><\/li><li class=\"share-reddit\"><a rel=\"nofollow\" data-shared=\"\" class=\"share-reddit sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=reddit\" target=\"_blank\" title=\"Click to share on Reddit\"><span>Reddit<\/span><\/a><\/li><li class=\"share-twitter\"><a rel=\"nofollow\" data-shared=\"sharing-twitter-732\" class=\"share-twitter sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=twitter\" target=\"_blank\" title=\"Click to share on Twitter\"><span>Twitter<\/span><\/a><\/li><li class=\"share-facebook\"><a rel=\"nofollow\" data-shared=\"sharing-facebook-732\" class=\"share-facebook sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=facebook\" target=\"_blank\" title=\"Click to share on Facebook\"><span>Facebook<\/span><\/a><\/li><li class=\"share-skype\"><a rel=\"nofollow\" data-shared=\"sharing-skype-732\" class=\"share-skype sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=skype\" target=\"_blank\" title=\"Share on Skype\"><span>Skype<\/span><\/a><\/li><li class=\"share-pocket\"><a rel=\"nofollow\" data-shared=\"\" class=\"share-pocket sd-button share-icon\" href=\"https:\/\/www.andreagirardi.it\/blog\/how-to-use-spring-datasource-bean-as-data-source-for-log4j-2-jdbc-appender\/?share=pocket\" target=\"_blank\" title=\"Click to share on Pocket\"><span>Pocket<\/span><\/a><\/li><li class=\"share-end\"><\/li><\/ul><\/div><\/div><\/div>","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"footnotes":""},"categories":[14],"tags":[4,61,45],"_links":{"self":[{"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/posts\/732"}],"collection":[{"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/comments?post=732"}],"version-history":[{"count":24,"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/posts\/732\/revisions"}],"predecessor-version":[{"id":773,"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/posts\/732\/revisions\/773"}],"wp:attachment":[{"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/media?parent=732"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/categories?post=732"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.andreagirardi.it\/blog\/wp-json\/wp\/v2\/tags?post=732"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}