Log MongoDB queries with Spring Boot

Question

Is it possible to log all MongoDB queries in my Spring Boot app? I tried this:

logging.level.org.springframework.data.document.mongodb=INFO
log4j.category.org.springframework.data.document.mongodb=INFO

But it didn't work.

Please change the log level to DEBUG and try. Also, please provide which class are you specifically look at? — notionquest
– notionquest, Commented Aug 30, 2016 at 8:33

Herman Bovens · Accepted Answer · 2019-08-01 10:38:23Z

48

The actual queries are logged by the MongoTemplate instance at the DEBUG level.

Setting the log level for org.springframework.data.mongodb.core.MongoTemplate to DEBUG will therefore enable the query logging.

For example, just add this line to your application.propertiese file:

logging.level.org.springframework.data.mongodb.core.MongoTemplate=DEBUG

Of course, you can also change the log level using any of the externalized configuration options that Spring Boot provides.

The log will be :

2018-11-26 19:23:16.574 DEBUG 15668 --- [nio-8081-exec-2]
o.s.data.mongodb.core.MongoTemplate : find using query: { "status" : "ACTIVE", "item._id" : { "$oid" : "5bfbcde45ac3366ad70cdb9f" } } fields: Document{{}}

edited Aug 1, 2019 at 10:38

Herman Bovens

12.5k5 gold badges50 silver badges64 bronze badges

answered Dec 25, 2017 at 8:01

Mojtaba Yeganeh

2,9221 gold badge33 silver badges52 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Brett DeWoody Over a year ago

While this might provide an answer to the question, some explanation is required. Please update the question with some explanation of how and why this solution works.

Rosário P. Fernandes Over a year ago

While this code snippet may solve the question, including an explanation really helps to improve the quality of your post. Remember that you are answering the question for readers in the future, and those people might not know the reasons for your code suggestion.

toolforger Over a year ago

This does not log autogenerated queries (like those from findByXxx()). You see "find using query: {}" and nothing else. I.e. you can't validate that autogeneration is generating the queries you think it generates.

andy · Accepted Answer · 2020-03-06 11:21:16Z

23

If using spring boot reactive mongodb, set logging.level.org.springframework.data.mongodb.core.ReactiveMongoTemplate=DEBUG

edited Mar 6, 2020 at 11:21

andy

1,0951 gold badge15 silver badges38 bronze badges

answered Apr 19, 2018 at 6:44

RJ.Hwang

1,9431 gold badge19 silver badges26 bronze badges

1 Comment

Rafael Biriba Over a year ago

pretty sure this will break my code style checker with line too long #Jokes

Kihats · Accepted Answer · 2018-08-28 06:39:38Z

17

This method is a bit longer but it solves much much more. We are going to use a tool called Spring Boot Admin Server.

First you need to include some dependencies

<!--Dependency for registering your app as a Spring Boot Admin Server-->
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server</artifactId>
    <version>1.3.3</version>
</dependency>

<!--Provide a nice looking ui-->
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server-ui</artifactId>
    <version>1.3.3</version>
</dependency>

<!--Dependency for registering your app as a Spring Boot Admin Client-->
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>1.3.0</version>
</dependency>
<dependency>
        <groupId>org.jolokia</groupId>
        <artifactId>jolokia-core</artifactId>
</dependency>

Enable your app to be a Spring Boot Admin Server using the annotation @EnableAdminServer.

@SpringBootApplication
@EnableAdminServer
public class Application {
   public static void main(String[] args) {
      // ... your code as before ...
   }
}

In your application.properties add the following:

Register your app to the Spring Boot Admin Server which is still your app

spring.boot.admin.url=http://localhost:8031

Instruct Spring Boot Admin Server where to find the client

spring.boot.admin.client.service-url=http://localhost:8031
spring.boot.admin.client.management-url=http://localhost:8031
spring.boot.admin.client.health-url=http://localhost:8031/health

In your logback.xml just add the following line <jmxConfigurator/>. This allows configuration of logback via JMX. More info here

... and voila you are done. Now you can change the debug level for any logger at runtime.

i. Just visit the url for your Spring Boot Admin Server-in our case here (http:/localhost:8031).

ii. A list of applications (clients) registered will be displayed on the home page.

iii. Click Details against the registered clients which will take you to another page.

iv. Click the Logging tab which will list all loggers registered in your application.

v. You can change the log levels it will change your logging level at runtime. Here is a snippet of what you expect

To answer your question, if you want to see the MongoDB queries, just look for MongoTemplate and change the logging level to DEBUG.

For versions 2.*.* of Spring Boot Admin, use the following configurations:

spring.boot.admin.client.url=http://localhost:8031

edited Aug 28, 2018 at 6:39

answered Jan 22, 2017 at 9:45

Kihats

3,5486 gold badges36 silver badges49 bronze badges

3 Comments

Kihats Over a year ago

Hi downvoter, kindly share with the stackoverflow community why you down voted. It could help improve the answer.

toolforger Over a year ago

I didn't downvote, but I guess it was downvoted because it's a bad answer to the question as stated, even if it's useful information to have in general.

asgs Over a year ago

I wonder if it's possible for a log change to be propagated to all the nodes in a multi-node environment without having to visit the admin URL of each node and update it one by one. Thank you for sharing! Admin Server is great to have :-)

José Campos · Accepted Answer · 2022-09-15 09:30:28Z

9

I am new to Spring Framework, but I added the two entries to application config file

logging.level.org.springframework.data.mongodb.core.MongoTemplate=DEBUG
logging.level.org.springframework.data.mongodb.core.ReactiveMongoTemplate=DEBUG

There was no query logged to console.

After that, I enabled DEBUG level for the application and find out log entries for my queries in log output.

2022-09-15 08:55:26.945 DEBUG 4388 --- [           main] 
org.mongodb.driver.protocol.command      : Sending command '{ "find" : "movies", 
"filter" : { "countries" : { "$all" : ["Russia", "Japan"] } },

So I reversed the application log level back to INFO, and enabled DEBUG level for org.mongodb.driver.protocol.command namespace.

logging.level.org.mongodb.driver.protocol.command=DEBUG

Hope this helps someone.

answered Sep 15, 2022 at 9:30

José Campos

911 silver badge1 bronze badge

1 Comment

slsy Over a year ago

answer should be more concise. The way you found out about it is not important for future readers in this case

Collectives™ on Stack Overflow

Log MongoDB queries with Spring Boot

4 Answers 4

3 Comments

1 Comment

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

3 Comments

1 Comment

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related