From b8e2ca694ea244e8d7b96c5f9e6fce59b7298944 Mon Sep 17 00:00:00 2001 From: Robert Butts Date: Thu, 7 Jul 2022 11:04:43 -0600 Subject: [PATCH] Fix doc formatting for plugin remap_stats --- doc/admin-guide/plugins/remap_stats.en.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/admin-guide/plugins/remap_stats.en.rst b/doc/admin-guide/plugins/remap_stats.en.rst index 5bf767151f7..a7eed631482 100644 --- a/doc/admin-guide/plugins/remap_stats.en.rst +++ b/doc/admin-guide/plugins/remap_stats.en.rst @@ -43,18 +43,24 @@ Options Flags and options are: -``--post-remap-host``: Whether to use the post-remap host in the URL, instead of the pristine client URL. -``-P``: shorthand for ``--post-remap-host``. -``--persistent``: Whether to use persistent stats. -``-p``: shorthand for ``--persistent``. +.. option:: --post-remap-host, -P + + Whether to use the post-remap host in the URL, instead of the pristine client URL. + +.. option:: --persistent, -p + + Whether to use persistent stats. Options in the code: -``MAX_STAT_LENGTH`` The maximum length of any stat name. Since stat names include the remap FQDN, this affects the maximum FQDN length that can be included in the stat. + +.. c:macro:: MAX_STAT_LENGTH + + The maximum length of any stat name. Since stat names include the remap FQDN, this affects the maximum FQDN length that can be included in the stat. Stats ===== -The following stats are added to the Traffic Server statistics, for every remap rule. +The following stats are added to the Traffic Server statistics, for every remap rule:: plugin.remap_stats..in_bytes plugin.remap_stats..out_bytes