Skip to content

Commit 0414ac1

Browse files
committed
Merge remote-tracking branch 'mongodb/master'
2 parents cbabf4c + 7d99f22 commit 0414ac1

31 files changed

+159
-161
lines changed

source/administration/backups.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Backup Strategies for MongoDB Systems
55
.. default-domain:: mongodb
66

77
Backups are an important part of any operational disaster recovery
8-
plan. A good backup plan must be able to reproducible capture data in
8+
plan. A good backup plan must be able to capture data in
99
a consistent and usable state, and operators must be able to automate
1010
both the backup and the recovery operations. Also test all components
1111
of the backup system to ensure that you can recover backed up data as
@@ -42,7 +42,7 @@ the following factors:
4242
substantial system resources. It is important to consider the time of
4343
the backup schedule relative to peak usage and maintenance windows.
4444

45-
- System capabilities. Some of the block-level snapshot tools requires
45+
- System capabilities. Some of the block-level snapshot tools require
4646
special support on the operating-system or infrastructure level.
4747

4848
- Database configuration. :term:`Replication` and :term:`sharding
@@ -65,7 +65,7 @@ instances. Creating binary "dumps" of the database using
6565
methodologies have advantages and disadvantages:
6666

6767
- binary database dumps are comparatively small, because they don't
68-
include index content pre-allocated free space, and :ref:`record
68+
include index content or pre-allocated free space, and :ref:`record
6969
padding <write-operations-padding-factor>`. However, it's impossible to
7070
capture a copy of a running system that reflects a single moment in
7171
time using a binary dump.

source/administration/configuration.txt

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ controlling the operation of the database system. This document
1313
provides an overview of common configurations and examples of
1414
best-practice configurations for common use cases.
1515

16-
While both interfaces provide access the same collection of options
16+
While both interfaces provide access to the same collection of options
1717
and settings, this document primarily uses the configuration file
18-
interface. If you run MongoDB using a control script or packaged for
19-
your operating system, you likely already have a configuration file
20-
located at ``/etc/mongodb.conf``. Confirm this by checking the content
21-
of the ``/etc/init.d/mongod`` or ``/etc/rc.d/mongod`` script to
22-
insure that the :term:`control scripts <control script>` start the
23-
:program:`mongod` with the appropriate configuration file (see below.)
18+
interface. If you run MongoDB using a control script or installed from
19+
a package for your operating system, you likely already have a
20+
configuration file located at ``/etc/mongodb.conf``. Confirm this by
21+
checking the content of the ``/etc/init.d/mongod`` or
22+
``/etc/rc.d/mongod`` script to insure that the :term:`control scripts
23+
<control script>` start the :program:`mongod` with the appropriate
24+
configuration file (see below.)
2425

2526
To start MongoDB instance using this configuration issue a command in
2627
the following form:
@@ -99,9 +100,9 @@ following explanation:
99100
following the server start operation.
100101

101102
- :setting:`journal` is ``true``, which enables :term:`journaling <journal>`.
102-
Journaling ensures single instance write-durability. 64-bit builds
103-
of :program:`mongod` enable journaling by default. Thus, this
104-
setting may be redundant.
103+
Journaling ensures single instance write-durability. 64-bit builds
104+
of :program:`mongod` enable journaling by default. Thus, this
105+
setting may be redundant.
105106

106107
Given the default configuration, some of these values may be
107108
redundant. However, in many situations explicitly stating the
@@ -135,13 +136,13 @@ Consider the following explanation for these configuration decisions:
135136
servers. At the same time it's important to limit these interfaces
136137
to interfaces controlled and protected at the network layer.
137138

138-
- ":setting:`nounixsocket`" is ``true`` which disables the
139+
- ":setting:`nounixsocket`" to ``true`` disables the
139140
UNIX Socket, which is otherwise enabled by default. This limits
140141
access on the local system. This is desirable when running MongoDB
141-
on with shared access, but in most situations has minimal impact.
142+
on systems with shared access, but in most situations has minimal impact.
142143

143-
- ":setting:`auth`" is ``true`` which enables the authentication
144-
system within MongoDB. If enabled you will need to log in, by
144+
- ":setting:`auth`" is ``true`` enables the authentication
145+
system within MongoDB. If enabled you will need to log in by
145146
connecting over the ``localhost`` interface for the first time to
146147
create user credentials.
147148

@@ -179,9 +180,9 @@ following option:
179180
file for the replica set member use to when authenticating to each
180181
other. The content of the key file is arbitrary, but must be the same
181182
on all members of the :term:`replica set` and :program:`mongos`
182-
instances that connect to the set. The keyfile must be less one
183+
instances that connect to the set. The keyfile must be less than one
183184
kilobyte in size and may only contain characters in the base64 set and
184-
file must not have group or "world" permissions on UNIX systems.
185+
the file must not have group or "world" permissions on UNIX systems.
185186

186187
.. seealso:: The ":ref:`Replica set Reconfiguration
187188
<replica-set-reconfiguration-usage>`" section for information regarding
@@ -258,7 +259,7 @@ Running Multiple Database Instances on the Same System
258259
------------------------------------------------------
259260

260261
In many cases running multiple instances of :program:`mongod` on a
261-
single system is not recommended, on some types of deployments
262+
single system is not recommended. On some types of deployments
262263
[#multimongod]_ and for testing purposes you may need to run more than
263264
one :program:`mongod` on a single system.
264265

@@ -274,7 +275,7 @@ The :setting:`dbpath` value controls the location of the
274275
:program:`mongod` instance's data directory. Ensure that each database
275276
has a distinct and well labeled data directory. The
276277
:setting:`pidfilepath` controls where :program:`mongod` process
277-
places it's :term:`pid` file. As this tracks the specific
278+
places it's :term:`process id <pid>` file. As this tracks the specific
278279
:program:`mongod` file, it is crucial that file be unique and well
279280
labeled to make it easy to start and stop these processes.
280281

source/administration/import-export.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ with the database itself.
2323
:program:`mongod` instance, they can impact the performance of your
2424
running database.
2525

26-
Not only do these backup processes create traffic for a running
26+
Not only do these processes create traffic for a running
2727
database instance, they also force the database to read all data
2828
through memory. When MongoDB reads infrequently used data, it can
2929
supplant more frequently accessed data, causing a deterioration in
@@ -34,9 +34,9 @@ with the database itself.
3434
a superset of :term:`JSON`. Thus, :program:`mongoimport` and
3535
:program:`mongoexport` cannot represent :term:`BSON` data
3636
accurately in :term:`JSON`. As a result data exported or imported
37-
with these tools may lose some measure of fidelity. See the
38-
":wiki:`MongoDB Extended JSON <Mongo+Extended+JSON>`" wiki page for
39-
more information about Use with care.
37+
with these tools may lose some measure of fidelity. See
38+
:doc:`/reference/mongodb-extended-json` for more information about
39+
MongoDB Extended JSON.
4040

4141
.. seealso:: See the ":doc:`/administration/backups`" document for
4242
more information on backing up MongoDB instances. Additionally,
@@ -48,8 +48,8 @@ with the database itself.
4848
- :doc:`/reference/mongodump`
4949

5050
If you want to transform and process data once you've imported it
51-
in MongoDB consider the topics in :doc:`/aggregation`, including:
52-
51+
in MongoDB consider the topics in :doc:`/aggregation`, including:
52+
5353
- :doc:`/applications/map-reduce` and
5454
- :doc:`/applications/aggregation`.
5555

@@ -135,7 +135,7 @@ JSON.
135135
Data Import and Export and Backups Operations
136136
---------------------------------------------
137137

138-
For resilient and non-disruptive backups,
138+
For resilient and non-disruptive backups,
139139
use a file system or block-level disk snapshot function, such as the
140140
methods described in the ":doc:`/administration/backups`" document. The
141141
tools and operations discussed provide functionality that's useful in
@@ -215,7 +215,7 @@ that it does not interact with your shell environment. The resulting
215215
documents will return on standard output.
216216

217217
By default, :program:`mongoexport` returns one :term:`JSON document`
218-
per MongoDB document. Specify the
218+
per MongoDB document. Specify the
219219
":option:`--jsonArray <mongoexport --jsonArray>`" argument to return
220220
the export as a single :term:`JSON` array. Use the ":option:`--csv
221221
<mongoexport --csv>`" file to return the result in CSV (comma

source/administration/journaling.txt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To enable journaling, start :program:`mongod` with the
4949
:option:`--journal <mongod --journal>` command line option.
5050

5151
If no journal files exist, when :program:`mongod` starts, it must
52-
preallocates new journal files. During this operation, the
52+
preallocate new journal files. During this operation, the
5353
:program:`mongod` is not listening for connections until preallocation
5454
completes: for some systems this may take a several minutes. During
5555
this period your applications and the :program:`mongo` shell are not
@@ -70,13 +70,10 @@ Disable Journaling
7070
To disable journaling, start :program:`mongod` with the
7171
:option:`--nojournal <mongod --nojournal>` command line option.
7272

73-
To disable journaling, shut down :program:`mongod` cleanly and restart
74-
with :option:`--nojournal <mongod --nojournal>`.
75-
7673
Get Commit Acknowledgment
7774
~~~~~~~~~~~~~~~~~~~~~~~~~
7875

79-
You can get commit acknowledgement with the
76+
You can get commit acknowledgment with the
8077
:dbcommand:`getLastError` command and the ``j`` option. For details, see
8178
:ref:`write-concern-operation`.
8279

source/administration/master-slave.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ you start the :setting:`master` instance, by adding the
124124
:program:`mongod`. If you do not specify
125125
:option:`--oplogSize <mongod --oplogSize>`, :program:`mongod` will
126126
allocate 5% of available disk space on start up to the oplog, with a
127-
ominimum of 1GB for 64bit machines and 50MB for 32bit machines.
127+
minimum of 1GB for 64bit machines and 50MB for 32bit machines.
128128

129129
Run time Master-Slave Configuration
130130
-----------------------------------

source/administration/monitoring.txt

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ allow you to diagnose issues as you encounter them, rather than
1212
waiting for a crisis or failure.
1313

1414
This document provides an overview of the available tools and data
15-
provided by MongoDB as well as introduction to diagnostic strategies,
15+
provided by MongoDB as well as an introduction to diagnostic strategies,
1616
and suggestions for monitoring instances in MongoDB's replica sets and
1717
sharded clusters.
1818

@@ -89,7 +89,7 @@ MongoDB provides a number of commands that return
8989
statistics about the state of the MongoDB instance. These data may
9090
provide finer granularity regarding the state of the MongoDB instance
9191
than the tools above. Consider using their output in scripts and
92-
programs to develop custom alerts, or modifying the behavior of your
92+
programs to develop custom alerts, or to modify the behavior of your
9393
application in response to the activity of your instance.
9494

9595
``serverStatus``
@@ -203,7 +203,7 @@ on your own servers, usually open source.
203203
- `mikoomi-mongodb <https://code.google.com/p/mikoomi/wiki/03>`_
204204
- Monitors availability, resource utilization, health, performance and other important metrics.
205205

206-
Also consider `dex <https://github.com/mongolab/dex>`_, and index and
206+
Also consider `dex <https://github.com/mongolab/dex>`_, an index and
207207
query analyzing tool for MongoDB that compares MongoDB log files and
208208
indexes to make indexing recommendations.
209209

@@ -233,10 +233,10 @@ Process Logging
233233
During normal operation, :program:`mongod` and :program:`mongos`
234234
instances report information that reflect current operation to
235235
standard output, or a log file. The following runtime settings
236-
methods to control these options.
236+
control these options.
237237

238238
- :setting:`quiet`. Limits the amount of information written to the
239-
log our output.
239+
log or output.
240240

241241
- :setting:`verbose`. Increases the amount of information written to
242242
the log or output.
@@ -260,6 +260,7 @@ methods to control these options.
260260
</reference/mongos>`
261261

262262
Additionally, the following :term:`database commands <database command>`
263+
affect logging:
263264

264265
- :dbcommand:`getLog`. Displays recent messages from the :program:`mongod` process log.
265266

@@ -270,7 +271,7 @@ Diagnosing Performance Issues
270271
-----------------------------
271272

272273
Degraded performance in MongoDB can be the result of an array of
273-
causes, and is typically a function of the relationship between the
274+
causes, and is typically a function of the relationship among the
274275
quantity of data stored in the database, the amount of system RAM, the
275276
number of connections to the database, and the amount of time the
276277
database spends in a lock state.
@@ -281,19 +282,20 @@ the host system for virtualized environments. Some users also
281282
experience performance limitations as a result of inadequate or
282283
inappropriate indexing strategies, or as a consequence of poor schema
283284
design patterns. In other situations, performance issues may indicate
284-
that the database may be operating at capacity and that it's time to
285+
that the database may be operating at capacity and that it is time to
285286
add additional capacity to the database.
286287

287288
Locks
288289
~~~~~
289290

290-
MongoDB uses a locking system to ensure consistency; however, if
291+
MongoDB uses a locking system to ensure consistency. However, if
291292
certain operations are long-running, or a queue forms, performance
292293
slows as requests and operations wait for the lock. Because lock
293294
related slow downs can be intermittent, look to the data in the
294295
:ref:`globalLock` section of the :dbcommand:`serverStatus` response to
295-
asses if the lock has been a challenge to your performance. If
296-
:data:`globalLock.currentQueue.total <serverStatus.globalLock.currentQueue.total>` is consistently high, then
296+
assess if the lock has been a challenge to your performance. If
297+
:data:`globalLock.currentQueue.total <serverStatus.globalLock.currentQueue.total>`
298+
is consistently high, then
297299
there is a chance that a large number of requests are waiting for a
298300
lock. This indicates a possible concurrency issue that might affect
299301
performance.
@@ -343,6 +345,8 @@ check for page faults, see the :data:`extra_info.page_faults
343345
:dbcommand:`serverStatus` command. This data is only available on
344346
Linux systems.
345347

348+
.. we should reverify the previous statement as the info is appearing on OS X as well
349+
346350
Alone, page faults are minor and complete quickly; however, in
347351
aggregate, large numbers of page fault typically indicate that MongoDB
348352
is reading too much data from disk and can indicate a number of
@@ -355,7 +359,7 @@ this also improves overall throughput.
355359
If possible, increasing the amount of RAM accessible to MongoDB may
356360
help reduce the number of page faults. If this is not possible, you
357361
may want to consider deploying a :term:`sharded cluster` and/or
358-
adding one or more :term:`shards <shard>` to your deployment to
362+
adding one or more :term:`shards <shard>` to your deployment to
359363
distribute load among :program:`mongod` instances.
360364

361365
Number of Connections
@@ -440,7 +444,7 @@ The following profiling levels are available:
440444
=========== ======================================
441445

442446
See the output of the profiler in the ``system.profile`` collection of
443-
your database. You can specify the :setting:`slowms` to set a
447+
your database. You can specify the :setting:`slowms` setting to set a
444448
threshold above which the profiler considers operations "slow" and
445449
thus included in the level ``1`` profiling data. You may configure
446450
:setting:`slowms` at runtime, as an argument to the
@@ -472,7 +476,7 @@ Replication and Monitoring
472476
--------------------------
473477

474478
The primary administrative concern that requires monitoring with
475-
replica sets, beyond the requirements for any MongoDB instance is
479+
replica sets, beyond the requirements for any MongoDB instance, is
476480
"replication lag." This refers to the amount of time that it takes a
477481
write operation on the :term:`primary` to replicate to a
478482
:term:`secondary`. Some very small delay period may be acceptable;
@@ -551,7 +555,7 @@ Balancing and Chunk Distribution
551555
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
552556

553557
The most effective :term:`sharded cluster` deployments require that
554-
:term:`chunks <chunk>` are evenly balanced between the shards. MongoDB
558+
:term:`chunks <chunk>` are evenly balanced among the shards. MongoDB
555559
has a background :term:`balancer` process that distributes data such that
556560
chunks are always optimally distributed among the :term:`shards <shard>`.
557561
Issue the :method:`db.printShardingStatus()` or :method:`sh.status()`

source/administration/operational-segregation.txt

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ MongoDB includes a cluster features that allow database administrators
1111
and developers to segregate application operations to MongoDB
1212
deployments by functional or geographical groupings. This capability
1313
provides "data center awareness," where application operations target
14-
he MongoDB deployment with consideration of the location of
14+
the MongoDB deployment with consideration of the location of
1515
:program:`mongod` instances in multi-data center deployments. In
1616
single data center deployments, users can use these features to
1717
provide "rack awareness," that allows users to control operations
@@ -26,12 +26,12 @@ collection only exist on specific shards.
2626
Specifically, with MongoDB, you can:
2727

2828
- ensure write operations propagate to specific members of a replica
29-
set, or specific members of replica sets.
29+
set, or to specific members of replica sets.
3030

3131
- ensure that specific members of a replica set respond to queries.
3232

3333
- ensure that specific ranges of your :term:`shard key` balance onto and
34-
reside on specific :term:`shard`.
34+
reside on specific :term:`shards <shard>`.
3535

3636
- combine the above features in a single distributed deployment, on a
3737
per-operation (for read and write operations) and collection (for
@@ -41,17 +41,16 @@ For full documentation of these features see the following
4141
documentation in the MongoDB Manual:
4242

4343
- :ref:`Read Preferences <read-preference>`, which controls how drivers
44-
help applications target read operations to members of a replica
45-
set.
44+
help applications target read operations to members of a replica set.
4645

4746
- :ref:`Write Concerns <replica-set-write-concern>`, which controls
4847
how MongoDB ensures that write operations propagate to members of a
4948
replica set.
5049

5150
- :ref:`Replica Set Tags <replica-set-configuration-tag-sets>`, which
52-
controls how applications create and interact with custom groupings
53-
of replica set members to create custom application specific a read
54-
preference and write concerns.
51+
control how applications create and interact with custom groupings
52+
of replica set members to create custom application specific read
53+
preferences and write concerns.
5554

5655
- :ref:`Tag Aware Sharding <tag-aware-sharding>`, which allows MongoDB
5756
administrators to define an application specific balancing policy,

0 commit comments

Comments
 (0)