zc.z3monitor 0.8.0

Process Information

To get information about the process overall, use the monitor command:

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('help monitor\n')
Help for monitor:
<BLANKLINE>
Get general process info
<BLANKLINE>
    The minimal output has:
<BLANKLINE>
    - The number of open database connections to the main database, which
      is the database registered without a name.
    - The virtual memory size, and
    - The resident memory size.
<BLANKLINE>
    If there are old database connections, they will be listed.  By
    default, connections are considered old if they are greater than 100
    seconds old. You can pass a minimum old connection age in seconds.
    If you pass a value of 0, you'll see all connections.
<BLANKLINE>
    If you pass a name after the integer, this is used as the database name.
    The database name defaults to the empty string ('').
<BLANKLINE>
-> CLOSE

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('monitor\n') #doctest: +NORMALIZE_WHITESPACE
0
VmSize:        35284 kB
VmRSS:         28764 kB
-> CLOSE

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('monitor 100 other\n') #doctest: +NORMALIZE_WHITESPACE
0
VmSize:        35284 kB
VmRSS:         28764 kB
-> CLOSE

Note that, as of this writing, the VmSize and VmRSS lines will only be present on a system with procfs. This generally includes many varieties of Linux, and excludes OS X and Windows.

Let’s create a couple of connections and then call z3monitor again with a value of 0:

>>> conn1 = main.open()
>>> conn2 = main.open()

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('monitor 0\n') #doctest: +NORMALIZE_WHITESPACE
2
VmSize:        36560 kB
VmRSS:         28704 kB
0.0    (0)
0.0    (0)
-> CLOSE

The extra line of output gives connection debug info. If we set some additional input, we’ll see it:

>>> conn1.setDebugInfo('/foo')
>>> conn2.setDebugInfo('/bar')

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('monitor 0\n') #doctest: +NORMALIZE_WHITESPACE
2
VmSize:        13048 kB
VmRSS:         10084 kB
0.0   /bar (0)
0.0   /foo (0)
-> CLOSE

>>> conn1.close()
>>> conn2.close()

Database Information

To get information about a database, use the dbinfo command:

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('help dbinfo\n')
Help for dbinfo:
<BLANKLINE>
Get database statistics
<BLANKLINE>
    By default statistics are returned for the main database.  The
    statistics are returned as a single line consisting of the:
<BLANKLINE>
    - number of database loads
<BLANKLINE>
    - number of database stores
<BLANKLINE>
    - number of connections in the last five minutes
<BLANKLINE>
    - number of objects in the object caches (combined)
<BLANKLINE>
    - number of non-ghost objects in the object caches (combined)
<BLANKLINE>
    You can pass a database name, where "-" is an alias for the main database.
<BLANKLINE>
    By default, the statistics are for a sampling interval of 5
    minutes.  You can request another sampling interval, up to an
    hour, by passing a sampling interval in seconds after the database name.
<BLANKLINE>
-> CLOSE

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('dbinfo\n') #doctest: +NORMALIZE_WHITESPACE
0   0   2   0   0
-> CLOSE

Let’s open a connection and do some work:

>>> conn = main.open()
>>> conn.root()['a'] = 1
>>> import transaction
>>> transaction.commit()
>>> conn.root()['a'] = 1
>>> transaction.commit()
>>> conn.close()

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('dbinfo\n') #doctest: +NORMALIZE_WHITESPACE
1   2   3   1   1
-> CLOSE

You can specify a database name. So, to get statistics for the other database, we’ll specify the name it was registered with:

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('dbinfo other\n')  #doctest: +NORMALIZE_WHITESPACE
0   0   0   0   0
-> CLOSE

You can use ‘-’ to name the main database:

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('dbinfo -\n')  #doctest: +NORMALIZE_WHITESPACE
1   2   3   1   1
-> CLOSE

You can specify a number of seconds to sample. For example, to get data for the last 10 seconds:

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('dbinfo - 10\n') #doctest: +NORMALIZE_WHITESPACE
1   2   3   1   1
-> CLOSE

ZEO Cache Statistics

You can get ZEO cache statistics using the zeocache command.

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('help zeocache\n')
Help for zeocache:
<BLANKLINE>
Get ZEO client cache statistics
<BLANKLINE>
    The command returns data in a single line:
<BLANKLINE>
    - the number of records added to the cache,
<BLANKLINE>
    - the number of bytes added to the cache,
<BLANKLINE>
    - the number of records evicted from the cache,
<BLANKLINE>
    - the number of bytes evicted from the cache,
<BLANKLINE>
    - the number of cache accesses.
<BLANKLINE>
    By default, data for the main database are returned.  To return
    information for another database, pass the database name.
<BLANKLINE>
-> CLOSE

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('zeocache\n') #doctest: +NORMALIZE_WHITESPACE
42 4200 23 2300 1000
-> CLOSE

You can specify a database name:

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('zeocache other\n') #doctest: +NORMALIZE_WHITESPACE
42 4200 23 2300 1000
-> CLOSE

ZEO Connection Status

The zeostatus command lets you get information about ZEO connection status:

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('help zeostatus\n')
Help for zeostatus:
<BLANKLINE>
Get ZEO client status information
<BLANKLINE>
    The command returns True if the client is connected and False otherwise.
<BLANKLINE>
    By default, data for the main database are returned.  To return
    information for another database, pass the database name.
<BLANKLINE>
-> CLOSE

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('zeostatus\n') #doctest: +NORMALIZE_WHITESPACE
True
-> CLOSE

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('zeostatus other\n') #doctest: +NORMALIZE_WHITESPACE
True
-> CLOSE

In this example, we’re using a faux ZEO connection. It has an attribute that determines whether it is connected or not. Id we change it, then the zeocache output will change:

>>> main._storage._is_connected = False

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

>>> connection.test_input('zeostatus\n') #doctest: +NORMALIZE_WHITESPACE
False
-> CLOSE

0.8.0 (2012-02-21)

Features

• New bind product-config option to bind to a specific address/socket Old port still useable.

0.7.0 (2008-09-14)

0.6.0 (2008-09-14)

Features

• The new interactive command makes connections continue through multiple commands until you use the quit command.

• The monitor command takes an optional database argument (after the legacy long argument).

0.5.0 (2008-4-4)

Features

• If the requested monitor port is in use, log and move on, rather than stopping the process with an exception. This lets zopectl debug work with a running instance.

0.4.1 (2008-3-31)

Initial release to PyPI

0.4.0 (2007-11-29)

New Features

• Moved ZEO cache status to the zeostatus command.

0.3.0 (2007-11-29)

New Features

• Commands are now provided as utilities. This means that z3monitor commands can be added by simply implementing simple utilities.

• Added a working help command.

• Added ZEO connection status to the zeocache output.

0.2.0 (2007-11-15)

New Features

• Added a command to get ZEO cache statistics.