Enable Query Logging

On this page

Overview

Before You Get Started
Enable Logs On a Connection
Additional Information

Overview

In this guide, you can learn how to enable query logging in Laravel MongoDB. Query logging can help you debug your queries and monitor database interactions.

Before You Get Started

To run the code examples in this guide, complete the Quick Start tutorial. This tutorial provides instructions on setting up a MongoDB Atlas instance with sample data and creating the following files in your Laravel web application:

Movie.php file, which contains a Movie model to represent documents in the movies collection
MovieController.php file, which contains a show() function to run database operations
browse_movies.blade.php file, which contains HTML code to display the results of database operations

The following sections describe how to edit the files in your Laravel application to run the find operation code examples and view the expected output.

Enable Logs On a Connection

To enable logs on a connection, you can use the enableQueryLog() method on the DB facade. This method enables MongoDB command logging on any queries that you perform on the database connection.

After you enable query logging, any queries you perform are stored in memory. To retrieve the logs, use one of the following methods:

getQueryLog(): Returns a log of MongoDB queries
getRawQueryLog(): Returns a log of raw MongoDB queries

The following example enables query logging, performs some queries, then prints the query log:

DB::connection('mongodb')->enableQueryLog();
Movie::where('title', 'Carrie')->get();
Movie::where('year', '<', 2005)->get();
Movie::where('imdb.rating', '>', 8.5)->get();
$logs = DB::connection('mongodb')->getQueryLog();
foreach ($logs as $log) {
    echo json_encode($log, JSON_PRETTY_PRINT);
}

{
  "query": "{ \"find\" : \"movies\", \"filter\" : { \"title\" : \"Carrie\" } }",
  "bindings": [],
  "time": 29476
}
{
  "query": "{ \"find\" : \"movies\", \"filter\" : { \"year\" : { \"$lt\" : { \"$numberInt\" : \"2005\" } } } }",
  "bindings": [],
  "time": 29861
}
{
  "query": "{ \"find\" : \"movies\", \"filter\" : { \"imdb.rating\" : { \"$gt\" : { \"$numberDouble\" : \"8.5\" } } } }",
  "bindings": [],
  "time": 27251
}

Additional Information

To learn more about connecting to MongoDB, see the Connection Guide.

To learn how to retrieve data based on filter criteria, see the Retrieve Data guide.

Back

Read Preference

Write Operations