Updated Branches: refs/heads/master 039a5de78 -> 9238e2e60
fix links&formatting in monitoring traffic docs notes: *someone* seems to have deleted the traffic_shell docs, I'm suspecting @igalic :program:`traffic_line` has loads of performance variables that need to be documented.. Volunteers? We're missing docs on how to use tstop. @dcarlin volunteered for this Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/9238e2e6 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/9238e2e6 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/9238e2e6 Branch: refs/heads/master Commit: 9238e2e60bfa0bd81b941428f3aa2450b6a26f71 Parents: 039a5de Author: Igor GaliÄ <[email protected]> Authored: Sun Aug 18 22:50:37 2013 +0200 Committer: Igor GaliÄ <[email protected]> Committed: Sun Aug 18 22:50:37 2013 +0200 ---------------------------------------------------------------------- doc/admin/monitoring-traffic.en.rst | 19 +++++++++---------- doc/reference/commands/traffic_line.en.rst | 4 ++++ 2 files changed, 13 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9238e2e6/doc/admin/monitoring-traffic.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/monitoring-traffic.en.rst b/doc/admin/monitoring-traffic.en.rst index 8019391..348aed8 100644 --- a/doc/admin/monitoring-traffic.en.rst +++ b/doc/admin/monitoring-traffic.en.rst @@ -24,8 +24,6 @@ Monitoring Traffic Traffic Server provides several options for monitoring system performance and analyzing network traffic. -This chapter discusses the following topics: - .. toctree:: :maxdepth: 2 @@ -36,16 +34,15 @@ Traffic Server provides the following tools to monitor system performance and analyze network traffic: - Traffic Server can send email that's triggered by alarms that signal - any detected failure conditions; refer to `Working with Traffic - Manager Alarms <#WorkingTrafficManagerAlarms>`_. + any detected failure conditions; refer to `Working with Traffic Manager Alarms`_. - The Traffic Line command-line interface provides an alternative method of viewing Traffic Server performance and network traffic - information; refer to `Viewing Statistics from Traffic - Line <#ViewingStatisticsTrafficLine>`_. + information; refer to `Viewing Statistics from Traffic Line`_. - The Traffic Shell command-line tool provides yet another alternative method of viewing Traffic Server performance and network traffic - information; refer to `Starting Traffic - Shell <../getting-started#StartTrafficShell>`_. + information; refer to `Starting Traffic Shell <../getting-started#StartTrafficShell>`_. + +.. XXX: *someone* seems to have deleted the traffic_shell docs, I'm suspecting igalic, btw. // igalic Working with Traffic Manager Alarms =================================== @@ -91,8 +88,8 @@ see. traffic_line -r variable where ``variable`` is the variable representing the information you -want to view. For a list of variables you can specify, refer to `Traffic -Line Variables <../traffic-line-commands##TrafficLineVariables>`_. +want to view. For a list of variables you can specify, refer to :ref:`Traffic +Line Variables <traffic-line-performance-statistics>`. For example, the following command displays the document hit rate for the Traffic Server node::: @@ -103,3 +100,5 @@ If the Traffic Server ``bin`` directory is not in your path, then prepend the Traffic Line command with ``./`` (for example: :option:`traffic_line -r` ``variable``). + +.. XXX: We're missing docs on how to use tstop here. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9238e2e6/doc/reference/commands/traffic_line.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/commands/traffic_line.en.rst b/doc/reference/commands/traffic_line.en.rst index 5bc0f1f..08683fb 100644 --- a/doc/reference/commands/traffic_line.en.rst +++ b/doc/reference/commands/traffic_line.en.rst @@ -113,9 +113,13 @@ Options Reset performance statistics to zero on the local node. +.. traffic-line-performance-statistics + Performance Statistics ====================== +.. XXX: These variables need to be documented.. Volunteers? //igalic + The :option:`traffic_line -r` option accepts the following variable names:: proxy.node.num_processes
