couchdb-stat-collector
A CLI tool for collecting statistics about a CouchDB node or cluster.
This project is a work in progress. Its interface may change as new features are added.
Usage
You can get this tool via NPM:
npm i -g couchdb-stat-collector
Now the couchdb-stat-collector
command should be on your $PATH. Try it like this:
couchdb-stat-collector http://admin:password@localhost:5984
Replace the first positional parameter with the URL for your CouchDB instance, including admin credentials. Alternatively, you can set the COUCH_URL
environment variable with the correct URL.
Once completed, it should give you a success message like this:
✅ All done!
⚠️ Please send ${host}_${port}_${date}_${time}.gz back to Neighbourhoodie Software GmbH <couchdb@neighbourhood.ie> for analysis.
Development & Testing
Get and build the tool locally with Git:
git clone neighbourhoodie/couchdb-stat-collector
cd couchdb-stat-collector
npm install
Now you can run the test suite like this:
npm test
You can run the tool like this:
npm start
License
Proprietary. Use only with permission of Neighbourhoodie Software GmbH.