src/ceph/doc/rados/configuration/ms-ref.rst

   1 ===========
   2  Messaging
   3 ===========
   4
   5 General Settings
   6 ================
   7
   8 ``ms tcp nodelay``
   9
  10 :Description: Disables nagle's algorithm on messenger tcp sessions.
  11 :Type: Boolean
  12 :Required: No
  13 :Default: ``true``
  14
  15
  16 ``ms initial backoff``
  17
  18 :Description: The initial time to wait before reconnecting on a fault.
  19 :Type: Double
  20 :Required: No
  21 :Default: ``.2``
  22
  23
  24 ``ms max backoff``
  25
  26 :Description: The maximum time to wait before reconnecting on a fault.
  27 :Type: Double
  28 :Required: No
  29 :Default: ``15.0``
  30
  31
  32 ``ms nocrc``
  33
  34 :Description: Disables crc on network messages.  May increase performance if cpu limited.
  35 :Type: Boolean
  36 :Required: No
  37 :Default: ``false``
  38
  39
  40 ``ms die on bad msg``
  41
  42 :Description: Debug option; do not configure.
  43 :Type: Boolean
  44 :Required: No
  45 :Default: ``false``
  46
  47
  48 ``ms dispatch throttle bytes``
  49
  50 :Description: Throttles total size of messages waiting to be dispatched.
  51 :Type: 64-bit Unsigned Integer
  52 :Required: No
  53 :Default: ``100 << 20``
  54
  55
  56 ``ms bind ipv6``
  57
  58 :Description: Enable if you want your daemons to bind to IPv6 address instead of IPv4 ones. (Not required if you specify a daemon or cluster IP.)
  59 :Type: Boolean
  60 :Required: No
  61 :Default: ``false``
  62
  63
  64 ``ms rwthread stack bytes``
  65
  66 :Description: Debug option for stack size; do not configure.
  67 :Type: 64-bit Unsigned Integer
  68 :Required: No
  69 :Default: ``1024 << 10``
  70
  71
  72 ``ms tcp read timeout``
  73
  74 :Description: Controls how long (in seconds) the messenger will wait before closing an idle connection.
  75 :Type: 64-bit Unsigned Integer
  76 :Required: No
  77 :Default: ``900``
  78
  79
  80 ``ms inject socket failures``
  81
  82 :Description: Debug option; do not configure.
  83 :Type: 64-bit Unsigned Integer
  84 :Required: No
  85 :Default: ``0``
  86
  87 Async messenger options
  88 =======================
  89
  90
  91 ``ms async transport type``
  92
  93 :Description: Transport type used by Async Messenger. Can be ``posix``, ``dpdk``
  94               or ``rdma``. Posix uses standard TCP/IP networking and is default.
  95               Other transports may be experimental and support may be limited.
  96 :Type: String
  97 :Required: No
  98 :Default: ``posix``
  99
 100
 101 ``ms async op threads``
 102
 103 :Description: Initial number of worker threads used by each Async Messenger instance.
 104               Should be at least equal to highest number of replicas, but you can
 105               decrease it if you are low on CPU core count and/or you host a lot of
 106               OSDs on single server.
 107 :Type: 64-bit Unsigned Integer
 108 :Required: No
 109 :Default: ``3``
 110
 111
 112 ``ms async max op threads``
 113
 114 :Description: Maximum number of worker threads used by each Async Messenger instance.
 115               Set to lower values when your machine has limited CPU count, and increase
 116               when your CPUs are underutilized (i. e. one or more of CPUs are
 117               constantly on 100% load during I/O operations).
 118 :Type: 64-bit Unsigned Integer
 119 :Required: No
 120 :Default: ``5``
 121
 122
 123 ``ms async set affinity``
 124
 125 :Description: Set to true to bind Async Messenger workers to particular CPU cores.
 126 :Type: Boolean
 127 :Required: No
 128 :Default: ``true``
 129
 130
 131 ``ms async affinity cores``
 132
 133 :Description: When ``ms async set affinity`` is true, this string specifies how Async
 134               Messenger workers are bound to CPU cores. For example, "0,2" will bind
 135               workers #1 and #2 to CPU cores #0 and #2, respectively.
 136               NOTE: when manually setting affinity, make sure to not assign workers to
 137               processors that are virtual CPUs created as an effect of Hyperthreading
 138               or similar technology, because they are slower than regular CPU cores.
 139 :Type: String
 140 :Required: No
 141 :Default: ``(empty)``
 142
 143
 144 ``ms async send inline``
 145
 146 :Description: Send messages directly from the thread that generated them instead of
 147               queuing and sending from Async Messenger thread. This option is known
 148               to decrease performance on systems with a lot of CPU cores, so it's
 149               disabled by default.
 150 :Type: Boolean
 151 :Required: No
 152 :Default: ``false``
 153
 154