Skip to content

Commit f3800e1

Browse files
DOCS-9988 - Document new replication heartbeats log component.
1 parent 9fe55d4 commit f3800e1

File tree

3 files changed

+31
-15
lines changed

3 files changed

+31
-15
lines changed

source/includes/options-conf.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,17 @@ replacement:
137137
version: ".. versionadded:: 3.0"
138138
---
139139
program: conf
140+
name: systemLog.component.replication.heartbeats.verbosity
141+
inherit:
142+
name: systemLog.component.name.verbosity
143+
program: _shared
144+
file: options-shared.yaml
145+
replacement:
146+
component_type: "heartbeats"
147+
component_data: ":data:`REPL_HB`"
148+
version: ".. versionadded:: 3.6"
149+
---
150+
program: conf
140151
name: systemLog.component.sharding.verbosity
141152
inherit:
142153
name: systemLog.component.name.verbosity

source/reference/configuration-options.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ Core Options
190190

191191
.. include:: /includes/option/setting-conf-systemLog.component.replication.verbosity.rst
192192

193+
.. include:: /includes/option/setting-conf-systemLog.component.replication.heartbeats.verbosity.rst
194+
193195
.. include:: /includes/option/setting-conf-systemLog.component.sharding.verbosity.rst
194196

195197
.. include:: /includes/option/setting-conf-systemLog.component.storage.verbosity.rst

source/reference/log-messages.txt

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,23 @@ categorization of the messages:
195195

196196
.. data:: REPL
197197

198-
Messages related to replica sets, such as initial sync and
199-
heartbeats. To specify the log level for :data:`REPL`
200-
components, set the
198+
Messages related to replica sets, such as initial sync, heartbeats,
199+
steady state replication, and rollback. To specify the log level for
200+
:data:`REPL` components, set the
201201
:setting:`systemLog.component.replication.verbosity` parameter.
202202

203+
.. data:: REPL_HB
204+
205+
Messages related specifically to replica set heartbeats. To specify
206+
the log level for :data:`REPL_HB` components, set the
207+
:setting:`systemLog.component.replication.heartbeats.verbosity`
208+
parameter.
209+
210+
:data:`REPL` is the parent component of :data:`REPL_HB`. If
211+
:setting:`systemLog.component.replication.heartbeats.verbosity` is
212+
unset, MongoDB uses the :data:`REPL` verbosity level for
213+
:data:`REPL_HB` components.
214+
203215
.. data:: SHARDING
204216

205217
Messages related to sharding activities, such as the startup of
@@ -214,25 +226,16 @@ categorization of the messages:
214226
:data:`STORAGE` components, use the
215227
:setting:`systemLog.component.storage.verbosity` setting.
216228

217-
MongoDB distinguishes :data:`JOURNAL` components from
218-
:data:`STORAGE` components; however, :data:`STORAGE` is the parent
219-
of :data:`JOURNAL`. As such, if
220-
:setting:`systemLog.component.storage.journal.verbosity` setting
221-
is unset, MongoDB uses the :data:`STORAGE` verbosity level for
222-
:data:`JOURNAL` components
223-
224229
.. data:: JOURNAL
225230

226231
Messages related specifically to journaling activities. To specify
227232
the log level for :data:`JOURNAL` components, use the
228233
:setting:`systemLog.component.storage.journal.verbosity` setting.
229234

230-
MongoDB distinguishes :data:`JOURNAL` components from
231-
:data:`STORAGE` components; however, :data:`STORAGE` is the parent
232-
of :data:`JOURNAL`. As such, if
235+
:data:`STORAGE` is the parent component of :data:`JOURNAL`. If
233236
:setting:`systemLog.component.storage.journal.verbosity` is
234-
unset, MongoDB uses the :data:`STORAGE` verbosity level for the
235-
:data:`JOURNAL` components as well.
237+
unset, MongoDB uses the :data:`STORAGE` verbosity level for
238+
:data:`JOURNAL` components.
236239

237240
.. data:: WRITE
238241

0 commit comments

Comments
 (0)