Skip to content

Commit 930cc7d

Browse files
committed
Minor documentation improvements
1 parent 28c33b6 commit 930cc7d

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

docs/about.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ It adds the following features:
99
* Asynchronous transport of log events
1010
* Store log events temporarily in a cache until transport
1111
to the Logstash server has been successful
12-
* Transport of events via TCP, UDP the Beats protocol
12+
* Transport of events via TCP, UDP and the Beats protocol
1313
* TCP transport optionally SSL-encrypted
1414
* Special formatter ready to be used in Django projects
1515
* Special formatter ready to be used in Flask projects

docs/config.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ Options for configuring the log handler
2828
To use an in-memory cache instead of a SQLite database,
2929
simply pass ``None``. See :doc:`persistence` for details.
3030

31+
This setting is only relevant for `AsynchronousLogstashHandler`.
32+
3133
.. note::
3234
Using multiple instances of `AsynchronousLogstashHandler` with
3335
different `database_path` settings won't work because there is only one
@@ -136,6 +138,8 @@ Options for configuring the log handler
136138
If a message is beyond it's TTL, it will be deleted from the cache
137139
and will not be published to logstash.
138140

141+
This setting is only relevant for `AsynchronousLogstashHandler`.
142+
139143
*Type*: ``integer``
140144

141145
*Default*: None

docs/usage.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ Usage
22
-----
33

44
`AsynchronousLogstashHandler` is a custom logging handler which
5-
sends Logstash messages using UDP and TCP. (`SynchronousLogstashHandler` is
6-
a synchronous alternative) For example:
5+
sends Logstash messages using UDP and TCP.
6+
Use `SynchronousLogstashHandler` for a synchronous alternative.
7+
8+
For example:
79

810
.. code-block:: python
911
@@ -69,6 +71,7 @@ configured extra prefix, e.g.:
6971
7072
Usage with HttpTransport
7173
========================
74+
7275
The `AsynchronousLogstashHandler` and `SynchronousLogstashHandler` support also
7376
the logstash `http input plugin <https://www.elastic.co/guide/en/logstash/current/plugins-inputs-http.html>`_.
7477

0 commit comments

Comments
 (0)