Some brief docs on transports

dcramer · dcramer · commit 5a7a253521f2 · 2014-03-31T21:18:16.000-07:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ Users Guide
    install/index
    config/index
    usage
+   transports/index
 
 Developers
 ----------
diff --git a/docs/transports/index.rst b/docs/transports/index.rst
@@ -0,0 +1,76 @@
+Transports
+==========
+
+A transport is the mechanism in which Raven sends the HTTP request to the Sentry server. By default, Raven uses a threaded asynchronous transport, but you can easily adjust this by modifying your ``SENTRY_DSN`` value.
+
+Transport registration is done via the URL prefix, so for example, a synchronous transport is as simple as prefixing your ``SENTRY_DSN`` with the ``sync+`` value.
+
+Eventlet
+--------
+
+Should only be used within an Eventlet IO loop.
+
+::
+
+    SENTRY_DSN = 'eventlet+http://public:secret@example.com/1'
+
+
+Gevent
+------
+
+Should only be used within a Gevent IO loop.
+
+::
+
+    SENTRY_DSN = 'gevent+http://public:secret@example.com/1'
+
+
+Requests
+--------
+
+Requires the ``requests`` library. Synchronous.
+
+::
+
+    SENTRY_DSN = 'gevent+http://public:secret@example.com/1'
+
+
+Sync
+----
+
+A synchronous blocking transport.
+
+::
+
+    SENTRY_DSN = 'sync+http://public:secret@example.com/1'
+
+
+Threaded (Default)
+------------------
+
+Spawns a async worked for processing messages.
+
+::
+
+    SENTRY_DSN = 'threaded+http://public:secret@example.com/1'
+
+
+Tornado
+-------
+
+Should only be used within a Tornado IO loop.
+
+::
+
+    SENTRY_DSN = 'tornado+http://public:secret@example.com/1'
+
+
+Twisted
+-------
+
+Should only be used within a Twisted event loop.
+
+::
+
+    SENTRY_DSN = 'twisted+http://public:secret@example.com/1'
+
