[ceph.git] / ceph / doc / rados / configuration / ms-ref.rst

===========
 Messaging
===========

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

``ms tcp nodelay``

:Description: Disables nagle's algorithm on messenger tcp sessions.
:Type: Boolean
:Required: No
:Default: ``true``


``ms initial backoff``

:Description: The initial time to wait before reconnecting on a fault.
:Type: Double
:Required: No
:Default: ``.2``


``ms max backoff``

:Description: The maximum time to wait before reconnecting on a fault.
:Type: Double
:Required: No
:Default: ``15.0``


``ms nocrc``

:Description: Disables crc on network messages.  May increase performance if cpu limited.
:Type: Boolean
:Required: No
:Default: ``false``


``ms die on bad msg``

:Description: Debug option; do not configure.
:Type: Boolean
:Required: No
:Default: ``false``


``ms dispatch throttle bytes``

:Description: Throttles total size of messages waiting to be dispatched.
:Type: 64-bit Unsigned Integer
:Required: No
:Default: ``100 << 20``


``ms bind ipv6``

: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.)
:Type: Boolean
:Required: No
:Default: ``false``


``ms rwthread stack bytes``

:Description: Debug option for stack size; do not configure.
:Type: 64-bit Unsigned Integer
:Required: No
:Default: ``1024 << 10``


``ms tcp read timeout``

:Description: Controls how long (in seconds) the messenger will wait before closing an idle connection.
:Type: 64-bit Unsigned Integer
:Required: No
:Default: ``900``


``ms inject socket failures``

:Description: Debug option; do not configure.
: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 are 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 limited 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 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``
Commit	Line	Data
7c673cae FG	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
c07f9fc5	105	decrease it if you are low on CPU core count and/or you host a lot of
7c673cae FG	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
7c673cae FG	123	``ms async send inline``
	124
	125	:Description: Send messages directly from the thread that generated them instead of
	126	queuing and sending from Async Messenger thread. This option is known
	127	to decrease performance on systems with a lot of CPU cores, so it's
	128	disabled by default.
	129	:Type: Boolean
	130	:Required: No
	131	:Default: ``false``
	132
	133