diff --git a/docs/configuration.rst b/docs/configuration.rst index 0aab9b395..5bd89eec9 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -911,11 +911,6 @@ This section describes these other files. This file is used to construct an introducer, and is created by the "``tahoe create-introducer``" command. -``tahoe-stats-gatherer.tac`` - - This file is used to construct a statistics gatherer, and is created by the - "``tahoe create-stats-gatherer``" command. - ``private/control.furl`` This file contains a FURL that provides access to a control port on the diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 index 23162af63..113f6a311 100644 --- a/docs/man/man1/tahoe.1 +++ b/docs/man/man1/tahoe.1 @@ -45,9 +45,6 @@ Create a client node (with storage initially disabled). .TP .B \f[B]create-introducer\f[] Create an introducer node. -.TP -.B \f[B]create-stats-gatherer\f[] -Create a stats-gatherer service. .SS OPTIONS .TP .B \f[B]-C,\ --basedir=\f[] diff --git a/docs/stats.rst b/docs/stats.rst index 8fbc8647a..200523d07 100644 --- a/docs/stats.rst +++ b/docs/stats.rst @@ -6,8 +6,7 @@ Tahoe Statistics 1. `Overview`_ 2. `Statistics Categories`_ -3. `Running a Tahoe Stats-Gatherer Service`_ -4. `Using Munin To Graph Stats Values`_ +3. `Using Munin To Graph Stats Values`_ Overview ======== @@ -257,79 +256,6 @@ The currently available stats (as of release 1.6.0 or so) are described here: maximum "load" value over the last minute -Running a Tahoe Stats-Gatherer Service -====================================== - -The "stats-gatherer" is a simple daemon that periodically collects stats from -several tahoe nodes. It could be useful, e.g., in a production environment, -where you want to monitor dozens of storage servers from a central management -host. It merely gatherers statistics from many nodes into a single place: it -does not do any actual analysis. - -The stats gatherer listens on a network port using the same Foolscap_ -connection library that Tahoe clients use to connect to storage servers. -Tahoe nodes can be configured to connect to the stats gatherer and publish -their stats on a periodic basis. (In fact, what happens is that nodes connect -to the gatherer and offer it a second FURL which points back to the node's -"stats port", which the gatherer then uses to pull stats on a periodic basis. -The initial connection is flipped to allow the nodes to live behind NAT -boxes, as long as the stats-gatherer has a reachable IP address.) - -.. _Foolscap: https://foolscap.lothar.com/trac - -The stats-gatherer is created in the same fashion as regular tahoe client -nodes and introducer nodes. Choose a base directory for the gatherer to live -in (but do not create the directory). Choose the hostname that should be -advertised in the gatherer's FURL. Then run: - -:: - - tahoe create-stats-gatherer --hostname=HOSTNAME $BASEDIR - -and start it with "tahoe start $BASEDIR". Once running, the gatherer will -write a FURL into $BASEDIR/stats_gatherer.furl . - -To configure a Tahoe client/server node to contact the stats gatherer, copy -this FURL into the node's tahoe.cfg file, in a section named "[client]", -under a key named "stats_gatherer.furl", like so: - -:: - - [client] - stats_gatherer.furl = pb://qbo4ktl667zmtiuou6lwbjryli2brv6t@HOSTNAME:PORTNUM/wxycb4kaexzskubjnauxeoptympyf45y - -or simply copy the stats_gatherer.furl file into the node's base directory -(next to the tahoe.cfg file): it will be interpreted in the same way. - -When the gatherer is created, it will allocate a random unused TCP port, so -it should not conflict with anything else that you have running on that host -at that time. To explicitly control which port it uses, run the creation -command with ``--location=`` and ``--port=`` instead of ``--hostname=``. If -you use a hostname of ``example.org`` and a port number of ``1234``, then -run:: - - tahoe create-stats-gatherer --location=tcp:example.org:1234 --port=tcp:1234 - -``--location=`` is a Foolscap FURL hints string (so it can be a -comma-separated list of connection hints), and ``--port=`` is a Twisted -"server endpoint specification string", as described in :doc:`configuration`. - -Once running, the stats gatherer will create a standard JSON file in -``$BASEDIR/stats.json``. Once a minute, the gatherer will pull stats -information from every connected node and write them into the file. The file -will contain a dictionary, in which node identifiers (known as "tubid" -strings) are the keys, and the values are a dict with 'timestamp', -'nickname', and 'stats' keys. d[tubid][stats] will contain the stats -dictionary as made available at http://localhost:3456/statistics?t=json . The -file will only contain the most recent update from each node. - -Other tools can be built to examine these stats and render them into -something useful. For example, a tool could sum the -"storage_server.disk_avail' values from all servers to compute a -total-disk-available number for the entire grid (however, the "disk watcher" -daemon, in misc/operations_helpers/spacetime/, is better suited for this -specific task). - Using Munin To Graph Stats Values =================================