Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rushi/mongo-query-top
Watch MongoDB queries happening on your server in real-time. Beautified version of `db.currentOp`
https://github.com/rushi/mongo-query-top
mongodb mongodb-query node nodejs top
Last synced: about 2 months ago
JSON representation
Watch MongoDB queries happening on your server in real-time. Beautified version of `db.currentOp`
- Host: GitHub
- URL: https://github.com/rushi/mongo-query-top
- Owner: rushi
- Created: 2017-07-16T15:19:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T07:07:33.000Z (10 months ago)
- Last Synced: 2024-03-25T08:28:04.824Z (10 months ago)
- Topics: mongodb, mongodb-query, node, nodejs, top
- Language: JavaScript
- Homepage:
- Size: 187 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MongoDB Query "Top"
This app aims to be a unix-like "top" experience for MongoDB's running queries. The app presents the results of `db.currentOp();` in a tabular fashion for your MongoDB instances. This is built using NodeJS, so it's got it's share of quirks and isn't as slick as top but it is easily hackable for any dev who knows JavaScript.
## Why?
You could read the output of `db.currentOp()`, but:
- The output is in JSON, and while it is programmer friendly, it's long vertical output isn't easily readable for human eyes.
- The output is literred with system & replication queries which you may have to ignore.
- There is no way to auto-refresh it every X seconds and present a summary.
Other reasons for a dev ops engineer or a developer:
- Figure out quickly who is behind that long running query
- Who or what is doing un-indexed collection scans.
- How many queries are running on the server and what's their source
## How To
This will start the app against the `localhost` server configured in `config/default.json`.
- `npm install`
- `./app.js` (same as `node -r esm app.js -c localhost`)
To run this against your own set of servers:
- Create a file `config/local.json` and define servers in it as indicated in `config/default.json`. You just need the URIs.
- Start the app using `node -r esm app.js -c `
More details can be obtained by passing the `-h` flag.
```
§ node -r esm app.js -h
Show the current operations on a MongoDB instance in an easy to read table
Usage: app.js --interval=[num]
Options:
--version Show version number [boolean]
-h, --help Show help [boolean]
--uri MongoDB instance uri
--once Run once and quit [boolean]
--ip Only show requests from this IP
-c, --config Name of the configuration to use from the config folder
-i, --interval Refresh data every X seconds
-t, --minTime Only show queries with a run time longer than this value
```
### Commands
While the app is running you can press the following keys to execute special functions:
- `p` - Pause fetching and rendering of queries
- `r` - Reverse the sorting of the queries (Default: Longest running at the bottom for easy diagnosis)
- `s` - Save a JSON snapshot of the current queries to disk as `.json` file for later review
## Requirements
- NodeJS >= 12
- MongoDB version > 3.6
## Author
- [Rushi Vishavadia](https://github.com/rushi)
## License
MIT