apple/foundationdb
1
0
Fork 0
mirror of https://github.com/apple/foundationdb.git synced 2025-06-01 18:56:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add a link to the region configuration in documentation of force_recovery_with_data_loss. Add subheadings for profile subcommands.

Browse Source
This commit is contained in:
A.J. Beamon 2020-05-27 15:48:19 -07:00
parent 12225c0f46
commit 8f2739a54b
1 changed files with 13 additions and 1 deletions

14
documentation/sphinx/source/command-line-interface.rst

@ -158,7 +158,7 @@ force_recovery_with_data_loss
The ``force_recovery_with_data_loss`` command will recover a multi-region database to the specified datacenter. Its syntax is ``force_recovery_with_data_loss <DCID>``. It will likely result in the loss of the most recently committed mutations and is intended to be used if the primary datacenter has been lost.
This command will change the region configuration to have a positive priority for the chosen ``DCID`` and a negative priority for all other ``DCIDs``. It will also set ``usable_regions`` to 1. If the database has already recovered, this command does nothing.
This command will change the :ref:`region configuration <configuration-configuring-regions>` to have a positive priority for the chosen ``DCID`` and a negative priority for all other ``DCIDs``. It will also set ``usable_regions`` to 1. If the database has already recovered, this command does nothing.
get
---
@ -305,18 +305,30 @@ profile
The ``profile`` command is used to control various profiling actions.
client
^^^^^^
``profile client <get|set>``
Reads or sets parameters of client transaction sampling. Use ``get`` to list the current parameters, and ``set <RATE|default> <SIZE|default>`` to set them. ``RATE`` is the fraction of transactions to be sampled, and ``SIZE`` is the amount (in bytes) of sampled data to store in the database.
list
^^^^
``profile list``
Lists the processes that can be profiled using the ``flow`` and ``heap`` subcommands.
flow
^^^^
``profile flow run <DURATION> <FILENAME> <PROCESS...>``
Enables flow profiling on the specifed processes for ``DURATION`` seconds. Profiling output will be stored at the specified filename relative to the fdbserver process's trace log directory. To profile all processes, use ``all`` for the ``PROCESS`` parameter.
heap
^^^^
``profile heap <PROCESS>``
Enables heap profiling for the specified process.