Skip to content
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

Fix doc formatting for plugin remap_stats #8942

Merged
merged 1 commit into from
Jul 7, 2022
Merged

Fix doc formatting for plugin remap_stats #8942

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
18 changes: 12 additions & 6 deletions doc/admin-guide/plugins/remap_stats.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.<fqdn>.in_bytes
plugin.remap_stats.<fqdn>.out_bytes
Expand Down