https://github.com/marcosfede/mongoose-query-logger
Mongoose plugin for query execution logging and explaining
https://github.com/marcosfede/mongoose-query-logger
explain mongo mongodb mongoose mongoose-queries nodejs schemas
Last synced: 8 months ago
JSON representation
Mongoose plugin for query execution logging and explaining
- Host: GitHub
- URL: https://github.com/marcosfede/mongoose-query-logger
- Owner: marcosfede
- License: mit
- Created: 2020-10-12T16:19:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-28T09:21:27.000Z (over 4 years ago)
- Last Synced: 2025-03-28T00:41:18.446Z (8 months ago)
- Topics: explain, mongo, mongodb, mongoose, mongoose-queries, nodejs, schemas
- Language: TypeScript
- Homepage:
- Size: 1.69 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mongoose Query Logger
Mongoose middleware to log your mongoose queries and execution timings.
Optionally, it also logs index usage and warns you about full collection scans
## Screenshots
### Query logging and execution timing
### Query Explain
## Installation
```
npm install --save-dev mongoose-query-logger
```
## Usage
Apply the plugin to all schemas:
```typescript
import { MongooseQueryLogger } from 'mongoose-query-logger';
export const queryLogger = new MongooseQueryLogger();
// optionally add custom configuration eg:
// queryLogger
// .setExplain(true)
// .setAdditionalLogProperties(true)
// .setQueryLogger(myCustomQueryLogger)
// .setExplainLogger(myCustomExplainLogger);
mongoose.plugin(queryLogger.getPlugin());
```
Apply the plugin to specific schemas:
```typescript
import { MongooseQueryLogger } from 'mongoose-query-logger';
export const queryLogger = new MongooseQueryLogger();
// optionally add custom configuration eg:
// queryLogger
// .setExplain(true)
// .setAdditionalLogProperties(true)
// .setQueryLogger(myCustomQueryLogger)
// .setExplainLogger(myCustomExplainLogger);
const schema = new mongoose.Schema({
/* schema definition */
});
schema.plugin(queryLogger.getPlugin());
// compile the model AFTER registering plugins
const User = mongoose.model('User', schema);
```
## Explain logging
This is turned off by default. It will fire an explain query for supported operations.
Turn this on by calling:
```plugin.setExplain(true)```
warning: don't use `explain` in production, it will run each query twice.
## Supported query logging methods
The following methods are supported for query logging
| method | supported |
| --------------- | --------------- |
| count | :heavy_check_mark: |
| countDocuments | :heavy_check_mark: |
| estimatedDocumentCount | :heavy_check_mark: |
| find | :heavy_check_mark: |
| findOne | :heavy_check_mark: |
| findOneAndUpdate | :heavy_check_mark: |
| findOneAndRemove | :heavy_check_mark: |
| findOneAndDelete | :heavy_check_mark: |
| findOneAndRemove | :heavy_check_mark: |
| update | :heavy_check_mark: |
| updateOne | :heavy_check_mark: |
| updateMany | :heavy_check_mark: |
| deleteOne | :heavy_check_mark: |
| deleteMany | :heavy_check_mark: |
| aggregate | :heavy_check_mark: |
| remove | |
| insertMany | |
| distinct | |
If you want only a subset of these to be logged, you can provide an array of supported methods like so:
```
plugin.setQueryMethods({targetMethods: ['find', 'aggregate']})
```
## Supported explain logging methods
The following methods are supported for query explaining
| method | supported |
| --------------- | --------------- |
| find | :heavy_check_mark: |
| findOne | :heavy_check_mark: |
| aggregate | :heavy_check_mark: |
If you want only a subset of these to be logged, you can provide an array of supported methods like so:
```
plugin.setQueryMethods({explainMethods: ['find', 'aggregate']})
```
## Custom query logger
You can provide a custom logging function by calling `plugin.setQueryLogger(myCustomLogger)`
The logger should be a function that accepts a single argument of type object with the following keys:
| key | type | description | example |
| --------------- | --------------- | --------------- | --------------- |
| operation | string | executed operation | find, aggregate |
| collectionName | string | collection name | tasks |
| executionTimeMS | number | query execution time in ms | 320ms |
| filter | Object or null | filter object provided to the query | {"name": "john"} |
| fields | Object or null | projection fields | {"name": 1} |
| options | any | query options | {"sort": "name"} |
| update | Object or null | | |
| additionalLogProperties | any | additional log options | |
## Custom explain logger
You can provide a custom explain logging function by calling `plugin.setExplainLogger(myCustomExplainLogger)`
The logger should be a function that accepts a single argument of type object with the following keys:
| key | type | description |
| --------------- | --------------- | --------------- |
| queryPlanners | any[] | array of query execution plans as returned from mongodb |
## Additional log properties
You can include additional metadata in your queries by turning this on with
```plugin.setAdditionalLogProperties(true)```
and using it like `await User.find({"name": "john"}).additionalLogProperties('something')`
## Supported versions
This was tested under mongoose 4.4 and node.js >= 12
## License
MIT © [Federico Marcos](http://github.com/marcosfede)