Skip to content

DOCS-9988 - Document new replication heartbeats log component. #3020

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2017
Merged

DOCS-9988 - Document new replication heartbeats log component. #3020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions source/includes/options-conf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,17 @@ replacement:
version: ".. versionadded:: 3.0"
---
program: conf
name: systemLog.component.replication.heartbeats.verbosity
inherit:
name: systemLog.component.name.verbosity
program: _shared
file: options-shared.yaml
replacement:
component_type: "heartbeats"
component_data: ":data:`REPL_HB`"
version: ".. versionadded:: 3.6"
---
program: conf
name: systemLog.component.sharding.verbosity
inherit:
name: systemLog.component.name.verbosity
Expand Down
2 changes: 2 additions & 0 deletions source/reference/configuration-options.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,8 @@ Core Options

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

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

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

.. include:: /includes/option/setting-conf-systemLog.component.storage.verbosity.rst
Expand Down
33 changes: 18 additions & 15 deletions source/reference/log-messages.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,11 +195,23 @@ categorization of the messages:

.. data:: REPL

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

.. data:: REPL_HB

Messages related specifically to replica set heartbeats. To specify
the log level for :data:`REPL_HB` components, set the
:setting:`systemLog.component.replication.heartbeats.verbosity`
parameter.

:data:`REPL` is the parent component of :data:`REPL_HB`. If
:setting:`systemLog.component.replication.heartbeats.verbosity` is
unset, MongoDB uses the :data:`REPL` verbosity level for
:data:`REPL_HB` components.

.. data:: SHARDING

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

MongoDB distinguishes :data:`JOURNAL` components from
:data:`STORAGE` components; however, :data:`STORAGE` is the parent
of :data:`JOURNAL`. As such, if
:setting:`systemLog.component.storage.journal.verbosity` setting
is unset, MongoDB uses the :data:`STORAGE` verbosity level for
:data:`JOURNAL` components

.. data:: JOURNAL

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

MongoDB distinguishes :data:`JOURNAL` components from
:data:`STORAGE` components; however, :data:`STORAGE` is the parent
of :data:`JOURNAL`. As such, if
:data:`STORAGE` is the parent component of :data:`JOURNAL`. If
:setting:`systemLog.component.storage.journal.verbosity` is
unset, MongoDB uses the :data:`STORAGE` verbosity level for the
:data:`JOURNAL` components as well.
unset, MongoDB uses the :data:`STORAGE` verbosity level for
:data:`JOURNAL` components.

.. data:: WRITE

Expand Down