npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mongoarchive

v0.2.0

Published

Archive data in Amazon S3 from Mongo

Downloads

28

Readme

mongoarchive

Archive data in Amazon S3 from MongoDB.

IMPORTANT: BETA version.

Install and run

  • npm install mongoarchive -g
  • (optional) change user
  • mongoarchive --config
  • npm install pm2 -g
  • Edit the file ~/.mongoarchive/conf.json and set your Amazon S3 and MongoDB security params
  • mongoarchive --start

The conf.json file

  • amazonS3: Object where configure the parameters of the Amazon S3 buckets. A key of this object is used in the collections property
    • key
    • secret
    • region
    • bucketName
  • mongodbConnectionUri: a MongoDB connection URI https://docs.mongodb.com/manual/reference/connection-string/
  • collections: MongoDB collections to archive in Amazon S3. Each one has 5 params:
    • name: name of the collection
    • offset: the process archives the data from the oldest to a number of days ago. The offset is this number of days
    • field: collection date field to control the offset param (sure, you have something like 'createdAt' in you collection)
    • s3: key of the amazonS3 object with the configuration the Amazon S3 bucket to use
    • remove: control if you want to remove or not from MongoDB, the data archived in S3 from this collection
  • tmpExportFilePath: File where mongoexport data is saved temporally

Mongoarchive creates a default configuration file for you with this data, but sure, you will need to edit it with your Amazon S3 and MongoDB security params.

How it works

Collection by collection and day by day:

  • Read data from Mongo
  • Upload it to Amazon S3 (look for the 'mongoarchive' folder in your bucket)
  • Remove it from Mongo (optional. See the "remove" param in conf.json)

Before use it

  • For now, this is a beta version. We are using it, but try first in a safe environment
  • Create an index in the collection date field

Recover from S3 backups

  • Download from Amazon S3
  • Uncompress it
  • mongoimport (example: mongoimport -h localhost:27017 -d db -c collection --file file)

Changelog

Releases are documented in the changelog file

Bugs

No bugs reported currently

TODOS

Confirmed

  • Tests

Requests

  • Add collection fields for each collection
  • Save as csv and json files
  • Automatic recover from S3 backups