diff --git a/pom.xml b/pom.xml index 23d647724..e1ddfe053 100644 --- a/pom.xml +++ b/pom.xml @@ -21,7 +21,6 @@ spring-data-mongodb spring-data-mongodb-cross-store - spring-data-mongodb-log4j spring-data-mongodb-distribution diff --git a/spring-data-mongodb-log4j/README.md b/spring-data-mongodb-log4j/README.md deleted file mode 100644 index 9e4d04caf..000000000 --- a/spring-data-mongodb-log4j/README.md +++ /dev/null @@ -1,54 +0,0 @@ -# MongoDB Log4J Appender - -:warning: Deprecated. About to be removed for 2.0.0.RC1. - -This module sets up a Log4J appender that puts logging events in MongoDB. It is fully configurable -and connects directly to the MongoDB server using the driver. It has no dependency on any Spring package. - -To use it, configure a host, port, (optionally) applicationId, and database property in your Log4J configuration: - - log4j.appender.stdout=org.springframework.data.mongodb.log4j.MongoLog4jAppender - log4j.appender.stdout.layout=org.apache.log4j.PatternLayout - log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - <%m>%n - log4j.appender.stdout.host = localhost - log4j.appender.stdout.port = 27017 - log4j.appender.stdout.database = logs - log4j.appender.stdout.collectionPattern = %c - log4j.appender.stdout.applicationId = my.application - log4j.appender.stdout.warnOrHigherWriteConcern = FSYNC_SAFE - -It will even support properties in your MDC (so long as they're Strings or support .toString()). - -The collection name is configurable as well. If you don't specify anything, it will use the Category name. -If you want to specify a collection name, you can give it a Log4J pattern layout format string which will have -the following additional MDC variables in the context when the collection name is rendered: - - "year" = Calendar.YEAR - "month" = Calendar.MONTH + 1 - "day" = Calendar.DAY_OF_MONTH - "hour" = Calendar.HOUR_OF_DAY - "applicationId" = configured applicationId - -An example log entry might look like: - - { - "_id" : ObjectId("4d89341a8ef397e06940d5cd"), - "applicationId" : "my.application", - "name" : "org.springframework.data.mongodb.log4j.MongoLog4jAppenderIntegrationTests", - "level" : "DEBUG", - "timestamp" : ISODate("2011-03-23T16:53:46.778Z"), - "properties" : { - "property" : "one" - }, - "message" : "DEBUG message" - } - -To set WriteConcern levels for WARN or higher messages, set warnOrHigherWriteConcern to one of the following: - -* FSYNC_SAFE -* NONE -* NORMAL -* REPLICAS_SAFE -* SAFE - -[http://api.mongodb.org/java/2.5-pre-/com/mongodb/WriteConcern.html#field_detail](http://api.mongodb.org/java/2.5-pre-/com/mongodb/WriteConcern.html#field_detail) \ No newline at end of file diff --git a/spring-data-mongodb-log4j/pom.xml b/spring-data-mongodb-log4j/pom.xml deleted file mode 100644 index 50d0a6454..000000000 --- a/spring-data-mongodb-log4j/pom.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - 4.0.0 - - - org.springframework.data - spring-data-mongodb-parent - 2.0.0.BUILD-SNAPSHOT - ../pom.xml - - - spring-data-mongodb-log4j - Spring Data MongoDB - Log4J Appender - - - 1.2.16 - - - - - - - log4j - log4j - ${log4j} - - - - - diff --git a/spring-data-mongodb-log4j/src/main/java/org/springframework/data/mongodb/log4j/MongoLog4jAppender.java b/spring-data-mongodb-log4j/src/main/java/org/springframework/data/mongodb/log4j/MongoLog4jAppender.java deleted file mode 100644 index f3c9c1b7c..000000000 --- a/spring-data-mongodb-log4j/src/main/java/org/springframework/data/mongodb/log4j/MongoLog4jAppender.java +++ /dev/null @@ -1,300 +0,0 @@ -/* - * Copyright 2011-2016 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.springframework.data.mongodb.log4j; - -import java.net.UnknownHostException; -import java.util.Arrays; -import java.util.Calendar; -import java.util.Collections; -import java.util.List; -import java.util.Map; - -import org.apache.log4j.AppenderSkeleton; -import org.apache.log4j.Level; -import org.apache.log4j.MDC; -import org.apache.log4j.PatternLayout; -import org.apache.log4j.spi.LoggingEvent; - -import com.mongodb.BasicDBList; -import com.mongodb.BasicDBObject; -import com.mongodb.DB; -import com.mongodb.Mongo; -import com.mongodb.MongoClient; -import com.mongodb.MongoCredential; -import com.mongodb.ServerAddress; -import com.mongodb.WriteConcern; - -/** - * Log4j appender writing log entries into a MongoDB instance. - * - * @author Jon Brisbin - * @author Oliver Gierke - * @author Christoph Strobl - * @author Ricardo Espirito Santo - * @deprecated since 2.0.0.M4. About to be removed for 2.0.0.RC1. - */ -@Deprecated -public class MongoLog4jAppender extends AppenderSkeleton { - - public static final String LEVEL = "level"; - public static final String NAME = "name"; - public static final String APP_ID = "applicationId"; - public static final String TIMESTAMP = "timestamp"; - public static final String PROPERTIES = "properties"; - public static final String TRACEBACK = "traceback"; - public static final String MESSAGE = "message"; - public static final String YEAR = "year"; - public static final String MONTH = "month"; - public static final String DAY = "day"; - public static final String HOUR = "hour"; - - protected String host = "localhost"; - protected int port = 27017; - protected String username; - protected String password; - protected String authenticationDatabase; - protected String database = "logs"; - protected String collectionPattern = "%c"; - protected PatternLayout collectionLayout = new PatternLayout(collectionPattern); - protected String applicationId = System.getProperty("APPLICATION_ID", null); - protected WriteConcern warnOrHigherWriteConcern = WriteConcern.ACKNOWLEDGED; - protected WriteConcern infoOrLowerWriteConcern = WriteConcern.UNACKNOWLEDGED; - protected Mongo mongo; - protected DB db; - - public MongoLog4jAppender() {} - - public MongoLog4jAppender(boolean isActive) { - super(isActive); - } - - public String getHost() { - return host; - } - - public void setHost(String host) { - this.host = host; - } - - public int getPort() { - return port; - } - - public void setPort(int port) { - this.port = port; - } - - /** - * @return - * @since 1.10 - */ - public String getUsername() { - return username; - } - - /** - * @param username may be {@literal null} for unauthenticated access. - * @since 1.10 - */ - public void setUsername(String username) { - this.username = username; - } - - /** - * @return - * @since 1.10 - */ - public String getPassword() { - return password; - } - - /** - * @param password may be {@literal null} for unauthenticated access. - * @since 1.10 - */ - public void setPassword(String password) { - this.password = password; - } - - /** - * @return - */ - public String getAuthenticationDatabase() { - return authenticationDatabase; - } - - /** - * @param authenticationDatabase may be {@literal null} to use {@link #getDatabase()} as authentication database. - * @since 1.10 - */ - public void setAuthenticationDatabase(String authenticationDatabase) { - this.authenticationDatabase = authenticationDatabase; - } - - public String getDatabase() { - return database; - } - - public void setDatabase(String database) { - this.database = database; - } - - public String getCollectionPattern() { - return collectionPattern; - } - - public void setCollectionPattern(String collectionPattern) { - this.collectionPattern = collectionPattern; - this.collectionLayout = new PatternLayout(collectionPattern); - } - - public String getApplicationId() { - return applicationId; - } - - public void setApplicationId(String applicationId) { - this.applicationId = applicationId; - } - - public String getWarnOrHigherWriteConcern() { - return warnOrHigherWriteConcern.toString(); - } - - public void setWarnOrHigherWriteConcern(String wc) { - this.warnOrHigherWriteConcern = WriteConcern.valueOf(wc); - } - - public String getInfoOrLowerWriteConcern() { - return infoOrLowerWriteConcern.toString(); - } - - public void setInfoOrLowerWriteConcern(String wc) { - this.infoOrLowerWriteConcern = WriteConcern.valueOf(wc); - } - - protected void connectToMongo() throws UnknownHostException { - - this.mongo = createMongoClient(); - this.db = mongo.getDB(database); - } - - private MongoClient createMongoClient() throws UnknownHostException { - - ServerAddress serverAddress = new ServerAddress(host, port); - - if (null == password || null == username) { - return new MongoClient(serverAddress); - } - - String authenticationDatabaseToUse = authenticationDatabase == null ? this.database : authenticationDatabase; - MongoCredential mongoCredential = MongoCredential.createCredential(username, - authenticationDatabaseToUse, password.toCharArray()); - List credentials = Collections.singletonList(mongoCredential); - return new MongoClient(serverAddress, credentials); - } - - /* - * (non-Javadoc) - * @see org.apache.log4j.AppenderSkeleton#append(org.apache.log4j.spi.LoggingEvent) - */ - @Override - @SuppressWarnings({ "unchecked" }) - protected void append(final LoggingEvent event) { - if (null == db) { - try { - connectToMongo(); - } catch (UnknownHostException e) { - throw new RuntimeException(e.getMessage(), e); - } - } - - BasicDBObject dbo = new BasicDBObject(); - if (null != applicationId) { - dbo.put(APP_ID, applicationId); - MDC.put(APP_ID, applicationId); - } - dbo.put(NAME, event.getLogger().getName()); - dbo.put(LEVEL, event.getLevel().toString()); - Calendar tstamp = Calendar.getInstance(); - tstamp.setTimeInMillis(event.getTimeStamp()); - dbo.put(TIMESTAMP, tstamp.getTime()); - - // Copy properties into document - Map props = event.getProperties(); - if (null != props && !props.isEmpty()) { - BasicDBObject propsDbo = new BasicDBObject(); - for (Map.Entry entry : props.entrySet()) { - propsDbo.put(entry.getKey().toString(), entry.getValue().toString()); - } - dbo.put(PROPERTIES, propsDbo); - } - - // Copy traceback info (if there is any) into the document - String[] traceback = event.getThrowableStrRep(); - if (null != traceback && traceback.length > 0) { - BasicDBList tbDbo = new BasicDBList(); - tbDbo.addAll(Arrays.asList(traceback)); - dbo.put(TRACEBACK, tbDbo); - } - - // Put the rendered message into the document - dbo.put(MESSAGE, event.getRenderedMessage()); - - // Insert the document - Calendar now = Calendar.getInstance(); - MDC.put(YEAR, now.get(Calendar.YEAR)); - MDC.put(MONTH, String.format("%1$02d", now.get(Calendar.MONTH) + 1)); - MDC.put(DAY, String.format("%1$02d", now.get(Calendar.DAY_OF_MONTH))); - MDC.put(HOUR, String.format("%1$02d", now.get(Calendar.HOUR_OF_DAY))); - - String coll = collectionLayout.format(event); - - MDC.remove(YEAR); - MDC.remove(MONTH); - MDC.remove(DAY); - MDC.remove(HOUR); - if (null != applicationId) { - MDC.remove(APP_ID); - } - - WriteConcern wc; - if (event.getLevel().isGreaterOrEqual(Level.WARN)) { - wc = warnOrHigherWriteConcern; - } else { - wc = infoOrLowerWriteConcern; - } - db.getCollection(coll).insert(dbo, wc); - } - - /* - * (non-Javadoc) - * @see org.apache.log4j.AppenderSkeleton#close() - */ - public void close() { - - if (mongo != null) { - mongo.close(); - } - } - - /* - * (non-Javadoc) - * @see org.apache.log4j.AppenderSkeleton#requiresLayout() - */ - public boolean requiresLayout() { - return true; - } -} diff --git a/spring-data-mongodb-log4j/src/main/java/org/springframework/data/mongodb/log4j/package-info.java b/spring-data-mongodb-log4j/src/main/java/org/springframework/data/mongodb/log4j/package-info.java deleted file mode 100644 index 5c57b5475..000000000 --- a/spring-data-mongodb-log4j/src/main/java/org/springframework/data/mongodb/log4j/package-info.java +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Infrastructure for to use MongoDB as a logging sink. - * - * @deprecated since 2.0.0.M4. About to be removed for 2.0.0.RC1. - */ -package org.springframework.data.mongodb.log4j; diff --git a/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderAuthenticationIntegrationTests.java b/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderAuthenticationIntegrationTests.java deleted file mode 100644 index 6cf2818de..000000000 --- a/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderAuthenticationIntegrationTests.java +++ /dev/null @@ -1,114 +0,0 @@ -/* - * Copyright 2016 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.springframework.data.mongodb.log4j; - -import static org.hamcrest.Matchers.*; -import static org.junit.Assert.*; - -import java.util.Calendar; -import java.util.Collections; - -import org.apache.log4j.LogManager; -import org.apache.log4j.Logger; -import org.apache.log4j.MDC; -import org.apache.log4j.PropertyConfigurator; -import org.junit.After; -import org.junit.Before; -import org.junit.Test; - -import com.mongodb.BasicDBList; -import com.mongodb.BasicDBObject; -import com.mongodb.BasicDBObjectBuilder; -import com.mongodb.DB; -import com.mongodb.DBCursor; -import com.mongodb.MongoClient; -import com.mongodb.MongoCredential; -import com.mongodb.ServerAddress; - -/** - * Integration tests for {@link MongoLog4jAppender} using authentication. - * - * @author Mark Paluch - */ -public class MongoLog4jAppenderAuthenticationIntegrationTests { - - private final static String username = "admin"; - private final static String password = "test"; - private final static String authenticationDatabase = "logs"; - - MongoClient mongo; - DB db; - String collection; - ServerAddress serverLocation; - - Logger log; - - @Before - public void setUp() throws Exception { - - serverLocation = new ServerAddress("localhost", 27017); - - mongo = new MongoClient(serverLocation); - db = mongo.getDB("logs"); - - BasicDBList roles = new BasicDBList(); - roles.add("dbOwner"); - db.command(new BasicDBObjectBuilder().add("createUser", username).add("pwd", password).add("roles", roles).get()); - mongo.close(); - - mongo = new MongoClient(serverLocation, Collections - .singletonList(MongoCredential.createCredential(username, authenticationDatabase, password.toCharArray()))); - db = mongo.getDB("logs"); - - Calendar now = Calendar.getInstance(); - collection = String.valueOf(now.get(Calendar.YEAR)) + String.format("%1$02d", now.get(Calendar.MONTH) + 1); - - LogManager.resetConfiguration(); - PropertyConfigurator.configure(getClass().getResource("/log4j-with-authentication.properties")); - - log = Logger.getLogger(MongoLog4jAppenderIntegrationTests.class.getName()); - } - - @After - public void tearDown() { - - if (db != null) { - db.getCollection(collection).remove(new BasicDBObject()); - db.command(new BasicDBObject("dropUser", username)); - } - - LogManager.resetConfiguration(); - PropertyConfigurator.configure(getClass().getResource("/log4j.properties")); - } - - @Test - public void testLogging() { - - log.debug("DEBUG message"); - log.info("INFO message"); - log.warn("WARN message"); - log.error("ERROR message"); - - DBCursor msgs = db.getCollection(collection).find(); - assertThat(msgs.count(), is(4)); - } - - @Test - public void testProperties() { - MDC.put("property", "one"); - log.debug("DEBUG message"); - } -} diff --git a/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderIntegrationTests.java b/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderIntegrationTests.java deleted file mode 100644 index 0271d47cd..000000000 --- a/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderIntegrationTests.java +++ /dev/null @@ -1,87 +0,0 @@ -/* - * Copyright 2011-2016 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.springframework.data.mongodb.log4j; - -import static org.hamcrest.Matchers.*; -import static org.junit.Assert.*; - -import java.util.Calendar; - -import org.apache.log4j.LogManager; -import org.apache.log4j.Logger; -import org.apache.log4j.MDC; -import org.apache.log4j.PropertyConfigurator; -import org.junit.After; -import org.junit.Before; -import org.junit.Test; - -import com.mongodb.BasicDBObject; -import com.mongodb.DB; -import com.mongodb.DBCursor; -import com.mongodb.MongoClient; -import com.mongodb.ServerAddress; - -/** - * Integration tests for {@link MongoLog4jAppender}. - * - * @author Jon Brisbin - * @author Oliver Gierke - * @author Christoph Strobl - */ -public class MongoLog4jAppenderIntegrationTests { - - MongoClient mongo; - DB db; - String collection; - ServerAddress serverLocation; - Logger log; - - @Before - public void setUp() throws Exception { - serverLocation = new ServerAddress("localhost", 27017); - - mongo = new MongoClient(serverLocation); - db = mongo.getDB("logs"); - - Calendar now = Calendar.getInstance(); - collection = String.valueOf(now.get(Calendar.YEAR)) + String.format("%1$02d", now.get(Calendar.MONTH) + 1); - - log = Logger.getLogger(MongoLog4jAppenderIntegrationTests.class.getName()); - } - - @After - public void tearDown() { - db.getCollection(collection).remove(new BasicDBObject()); - } - - @Test - public void testLogging() { - - log.debug("DEBUG message"); - log.info("INFO message"); - log.warn("WARN message"); - log.error("ERROR message"); - - DBCursor msgs = db.getCollection(collection).find(); - assertThat(msgs.count(), is(4)); - } - - @Test - public void testProperties() { - MDC.put("property", "one"); - log.debug("DEBUG message"); - } -} diff --git a/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderUnitTests.java b/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderUnitTests.java deleted file mode 100644 index e192fffc3..000000000 --- a/spring-data-mongodb-log4j/src/test/java/org/springframework/data/mongodb/log4j/MongoLog4jAppenderUnitTests.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright 2013-2017 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.springframework.data.mongodb.log4j; - -import org.junit.Test; - -/** - * Unit tests for {@link MongoLog4jAppender}. - * - * @author Oliver Gierke - */ -public class MongoLog4jAppenderUnitTests { - - @Test // DATAMONGO-641 - public void closesWithoutMongoInstancePresent() { - new MongoLog4jAppender().close(); - } -} diff --git a/spring-data-mongodb-log4j/src/test/resources/log4j-with-authentication.properties b/spring-data-mongodb-log4j/src/test/resources/log4j-with-authentication.properties deleted file mode 100644 index d83684463..000000000 --- a/spring-data-mongodb-log4j/src/test/resources/log4j-with-authentication.properties +++ /dev/null @@ -1,16 +0,0 @@ -log4j.rootCategory=INFO, mongo - -log4j.appender.mongo=org.springframework.data.mongodb.log4j.MongoLog4jAppender -log4j.appender.mongo.layout=org.apache.log4j.PatternLayout -log4j.appender.mongo.layout.ConversionPattern=%d %p [%c] - <%m>%n -log4j.appender.mongo.host = localhost -log4j.appender.mongo.port = 27017 -log4j.appender.mongo.database = logs -log4j.appender.mongo.username = admin -log4j.appender.mongo.password = test -log4j.appender.mongo.authenticationDatabase = logs -log4j.appender.mongo.collectionPattern = %X{year}%X{month} -log4j.appender.mongo.applicationId = my.application -log4j.appender.mongo.warnOrHigherWriteConcern = FSYNC_SAFE - -log4j.category.org.springframework.data.mongodb=DEBUG diff --git a/spring-data-mongodb-log4j/src/test/resources/log4j.properties b/spring-data-mongodb-log4j/src/test/resources/log4j.properties deleted file mode 100644 index 75136af0a..000000000 --- a/spring-data-mongodb-log4j/src/test/resources/log4j.properties +++ /dev/null @@ -1,13 +0,0 @@ -log4j.rootCategory=INFO, mongo - -log4j.appender.mongo=org.springframework.data.mongodb.log4j.MongoLog4jAppender -log4j.appender.mongo.layout=org.apache.log4j.PatternLayout -log4j.appender.mongo.layout.ConversionPattern=%d %p [%c] - <%m>%n -log4j.appender.mongo.host = localhost -log4j.appender.mongo.port = 27017 -log4j.appender.mongo.database = logs -log4j.appender.mongo.collectionPattern = %X{year}%X{month} -log4j.appender.mongo.applicationId = my.application -log4j.appender.mongo.warnOrHigherWriteConcern = FSYNC_SAFE - -log4j.category.org.springframework.data.mongodb=DEBUG diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index 583437b95..71258e377 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -33,7 +33,6 @@ include::{spring-data-commons-docs}/auditing.adoc[] include::reference/mongo-auditing.adoc[] include::reference/mapping.adoc[] include::reference/cross-store.adoc[] -include::reference/logging.adoc[] include::reference/jmx.adoc[] include::reference/mongo-3.adoc[] :leveloffset: -1 diff --git a/src/main/asciidoc/reference/logging.adoc b/src/main/asciidoc/reference/logging.adoc deleted file mode 100644 index d1cdbe05a..000000000 --- a/src/main/asciidoc/reference/logging.adoc +++ /dev/null @@ -1,50 +0,0 @@ -[[mongo.logging]] -= Logging support - -An appender for Log4j is provided in the maven module "spring-data-mongodb-log4j". Note, there is no dependency on other Spring Mongo modules, only the MongoDB driver. - -[[mongodb:logging-configuration]] -== MongoDB Log4j Configuration - -Here is an example configuration - -[source] ----- -log4j.rootCategory=INFO, mongo - -log4j.appender.mongo=org.springframework.data.document.mongodb.log4j.MongoLog4jAppender -log4j.appender.mongo.layout=org.apache.log4j.PatternLayout -log4j.appender.mongo.layout.ConversionPattern=%d %p [%c] - <%m>%n -log4j.appender.mongo.host = localhost -log4j.appender.mongo.port = 27017 -log4j.appender.mongo.database = logs -log4j.appender.mongo.collectionPattern = %X{year}%X{month} -log4j.appender.mongo.applicationId = my.application -log4j.appender.mongo.warnOrHigherWriteConcern = FSYNC_SAFE - -log4j.category.org.apache.activemq=ERROR -log4j.category.org.springframework.batch=DEBUG -log4j.category.org.springframework.data.document.mongodb=DEBUG -log4j.category.org.springframework.transaction=INFO ----- - -The important configuration to look at aside from host and port is the database and `collectionPattern`. The variables `year`, `month`, `day` and `hour` are available for you to use in forming a collection name. This is to support the common convention of grouping log information in a collection that corresponds to a specific time period, for example a collection per day. - -There is also an `applicationId` which is put into the stored message. The document stored from logging as the following keys: `level`, `name`, `applicationId`, `timestamp`, `properties`, `traceback`, and `message`. - -[[mongodb:logging-configuration:authentication]] -=== Using authentication - -The MongoDB Log4j appender can be configured to use username/password authentication. -Authentication is performed using the specified database. A different `authenticationDatabase` can be specified to override the default behavior. - -[source] ----- -# ... -log4j.appender.mongo.username = admin -log4j.appender.mongo.password = test -log4j.appender.mongo.authenticationDatabase = logs -# ... ----- - -NOTE: Authentication failures lead to exceptions during logging and are propagated to the caller of the logging method. diff --git a/src/main/asciidoc/reference/mongodb.adoc b/src/main/asciidoc/reference/mongodb.adoc index 8cb9813e3..0b08a03fe 100644 --- a/src/main/asciidoc/reference/mongodb.adoc +++ b/src/main/asciidoc/reference/mongodb.adoc @@ -13,7 +13,6 @@ The MongoDB support contains a wide range of features which are summarized below * Automatic implementation of Repository interfaces including support for custom finder methods. * QueryDSL integration to support type-safe queries. * Cross-store persistence - support for JPA Entities with fields transparently persisted/retrieved using MongoDB -* Log4j log appender * GeoSpatial integration For most tasks you will find yourself using `MongoTemplate` or the Repository support that both leverage the rich mapping functionality. `MongoTemplate` is the place to look for accessing functionality such as incrementing counters or ad-hoc CRUD operations. `MongoTemplate` also provides callback methods so that it is easy for you to get a hold of the low level API artifacts such as `com.mongo.DB` to communicate directly with MongoDB. The goal with naming conventions on various API artifacts is to copy those in the base MongoDB Java driver so you can easily map your existing knowledge onto the Spring APIs.