From 8f2739a54b94759d82216ea39e51cab2a927aee9 Mon Sep 17 00:00:00 2001 From: "A.J. Beamon" Date: Wed, 27 May 2020 15:48:19 -0700 Subject: [PATCH] Add a link to the region configuration in documentation of force_recovery_with_data_loss. Add subheadings for profile subcommands. --- .../sphinx/source/command-line-interface.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/documentation/sphinx/source/command-line-interface.rst b/documentation/sphinx/source/command-line-interface.rst index b4830a8956..8430a43367 100644 --- a/documentation/sphinx/source/command-line-interface.rst +++ b/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 ``. 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 ` 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 `` Reads or sets parameters of client transaction sampling. Use ``get`` to list the current parameters, and ``set `` 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 `` 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 `` Enables heap profiling for the specified process.