https://github.com/puentesarrin/mongodb-log

MongoDB Python logging handler, Centralized logging made simple using MongoDB.
https://github.com/puentesarrin/mongodb-log

Last synced: about 1 month ago
JSON representation

MongoDB Python logging handler, Centralized logging made simple using MongoDB.

• Host: GitHub
• URL: https://github.com/puentesarrin/mongodb-log
• Owner: puentesarrin
• License: bsd-2-clause
• Fork: true (andreisavu/mongodb-log)
• Created: 2012-12-29T03:16:02.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2019-06-08T02:23:47.000Z (over 5 years ago)
• Last Synced: 2024-10-13T10:52:37.247Z (2 months ago)
• Language: Python
• Homepage: http://www.mongodb.org/
• Size: 135 KB
• Stars: 135
• Watchers: 15
• Forks: 23
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-mongodb - MongoLog - MongoDB logging handler (Libraries / Python)
• awesome-mongodb - MongoLog - MongoDB logging handler (Libraries / Python)

README

        
MongoLog: Centralized logging made simple using MongoDB

=======================================================

.. image:: https://travis-ci.org/puentesarrin/mongodb-log.png

    :target: https://travis-ci.org/puentesarrin/mongodb-log

    :alt: Travis CI status

.. image:: https://pypip.in/v/mongolog/badge.png

    :target: https://pypi.python.org/pypi/mongolog

    :alt: Latest PyPI version

.. image:: https://pypip.in/d/mongolog/badge.png

    :target: https://pypi.python.org/pypi/mongolog

    :alt: Number of PyPI downloads

:Info: MongoDB python logging handler. Python centralized logging made easy.

:Author: `Andrei Savu`_

:Maintainer: `Jorge Puente Sarrín`_

Setup

-----

Before using this handler for logging you will need to create a capped

collection on the MongoDB server.

You can do this using the following commands in the MongoDB shell::

   > use mongolog

   > db.createCollection('log', {capped:true, size:100000})

... and you are ready. Running ``stats()`` function on ``log`` collection

should show something like this::

   > db.log.stats()

   {

           "ns" : "mongolog.log",

           "count" : 0,

           "size" : 0,

           "storageSize" : 102400,

           "numExtents" : 1,

           "nindexes" : 1,

           "lastExtentSize" : 102400,

           "paddingFactor" : 1,

           "systemFlags" : 1,

           "userFlags" : 0,

           "totalIndexSize" : 8176,

           "indexSizes" : {

                   "_id_" : 8176

           },

           "capped" : true,

           "max" : 2147483647,

           "ok" : 1

   }

Usage

-----

>>> import logging

>>> from mongolog.handlers import MongoHandler

>>>

>>> log = logging.getLogger('demo')

>>> log.setLevel(logging.DEBUG)

>>> log.addHandler(MongoHandler.to(db='mongolog', collection='log'))

>>>

>>> log.debug('Some message')

Check the samples folder for more details.

Why centralized logging?

------------------------

* Easy troubleshouting:

    * Having the answers to why? quickly and accurately.

    * For troubleshouting while the system is down.

    * Removed risk of loss of log information.

* Resource tracking.

* Security.

What is MongoDB?

----------------

"MongoDB is a high-performance, open source, schema-free document-oriented

database."

It can eficiently store arbitrary JSON objects. You can read more at

`MongoDB website`_.

Why MongoDB is great for logging?

---------------------------------

* MongoDB inserts can be done asynchronously.

* Old log data automatically LRU's out thanks to capped collections.

* It's fast enough for the problem.

* Document-oriented / JSON is a great format for log information.

Read more about this subject on the `MongoDB blog`_.

Have fun!

.. _Andrei Savu: https://github.com/andreisavu

.. _Jorge Puente Sarrín: https://github.com/puentesarrin

.. _MongoDB website: http://www.mongodb.org

.. _MongoDB blog: http://blog.mongodb.org/post/172254834/mongodb-is-fantastic-for-logging