Skip to content

Commit

Permalink
doc/rados/configuration/ms-ref.rst: document a few async msgr options
Browse files Browse the repository at this point in the history
Documentation of a few of Async Messenger configuration options.

Signed-off-by: Piotr Dałek <git@predictor.org.pl>
  • Loading branch information
branch-predictor committed Nov 23, 2016
1 parent 69c2996 commit 05fa916
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions doc/rados/configuration/ms-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Messaging
===========

General Settings
================

``ms tcp nodelay``

Expand Down Expand Up @@ -81,3 +83,72 @@
:Type: 64-bit Unsigned Integer
:Required: No
:Default: ``0``

Async messenger options
=======================


``ms async transport type``

:Description: Transport type used by Async Messenger. Can be ``posix``, ``dpdk``
or ``rdma``. Posix uses standard TCP/IP networking and is default.
Other transports may be experimental and support may be limited.
:Type: String
:Required: No
:Default: ``posix``


``ms async op threads``

:Description: Initial number of worker threads used by each Async Messenger instance.
Should be at least equal to highest number of replicas, but you can
decrease it if you're low on CPU core count and/or you host a lot of
OSDs on single server.
:Type: 64-bit Unsigned Integer
:Required: No
:Default: ``3``


``ms async max op threads``

:Description: Maximum number of worker threads used by each Async Messenger instance.
Set to lower values when your machine has imited CPU count, and increase
when your CPUs are underutilized (i. e. one or more of CPUs are
constantly on 100% load during I/O operations).
:Type: 64-bit Unsigned Integer
:Required: No
:Default: ``5``


``ms async set affinity``

:Description: Set to true to bind Async Messenger workers to particular CPU cores.
:Type: Boolean
:Required: No
:Default: ``true``


``ms async affinity cores``

:Description: When ``ms async set affinity`` is true, this string specifies how Async
Messenger workers are bound to CPU cores. For example, "0,2" will bind
workers #1 and #2 to CPU cores #0 and #2, respectively.
NOTE: when manually setting affinity, make sure to not assign workers to
processors that are virtual CPUs created as an effect of Hyperthreading
or similar technology, because they're slower than regular CPU cores.
:Type: String
:Required: No
:Default: ``(empty)``


``ms async send inline``

:Description: Send messages directly from the thread that generated them instead of
queuing and sending from Async Messenger thread. This option is known
to decrease performance on systems with a lot of CPU cores, so it's
disabled by default.
:Type: Boolean
:Required: No
:Default: ``false``


0 comments on commit 05fa916

Please sign in to comment.