sentry/docs/index.rst

Sentry
======

Sentry is a realtime event logging and aggregation platform. At its core it
specializes in monitoring errors and extracting all the information needed
to do a proper post-mortem without any of the hassle of the standard user
feedback loop.

It's important to note that Sentry should not be thought of as a log stream,
but as an event aggregator. It fits somewhere in-between a simple metrics
solution (such as `Graphite <http://graphite.wikidot.com/>`_) and a full-on
log stream aggregator (like `Logstash <http://logstash.net/>`_).

Users Guide
-----------

.. toctree::
   :maxdepth: 2

   quickstart/index
   quickstart/nginx
   upgrading/index
   config/index
   queue/index
   buffer/index
   nodestore/index
   udp_server/index
   throttling/index
   performance/index
   cli/index
   client/index
   plugins/index
   faq/index

Developers
----------

.. toctree::
   :maxdepth: 2

   contributing/index
   developer/client/index
   developer/plugins/index
   developer/interfaces/index

Reference
---------

.. toctree::
   :maxdepth: 1

   changelog/index
   license/index

Resources
---------

* `Transifex <https://www.transifex.com/projects/p/sentry/>`_ (Translate Sentry!)
* `Bug Tracker <http://github.com/getsentry/sentry/issues>`_
* `Code <http://github.com/getsentry/sentry>`_
* `Mailing List <https://groups.google.com/group/getsentry>`_
* `IRC <irc://irc.freenode.net/sentry>`_  (irc.freenode.net, #sentry)

Screenshots
-----------

Aggregated Events
`````````````````

.. image:: images/group_list.png
   :alt: aggregated events

Event Details
`````````````
.. image:: images/event.png
   :alt: event details

Deprecation Notes
-----------------

Milestones releases are 1.3 or 1.4, and our deprecation policy is to a two version step. For example,
a feature will be deprecated in 1.3, and completely removed in 1.4.