com.mongodb.tools

Class ConnectionPoolStat

java.lang.Object

com.mongodb.tools.ConnectionPoolStat

Deprecated.

This class will be removed in 3.x versions of the driver, so please remove it from your compile time dependencies.

@Deprecated
public class ConnectionPoolStat
extends java.lang.Object

A simple class that formats Mongo Java driver connection pool statistics in an easily-accessible JSON format. It can be used to get statistics on connection pool in the same VM by using the no-args constructor, or in any VM by using the constructor that takes an MBeanServerConnection.

This class also exposes a command line interface modeled after mongostat. For usage, run:

   java -cp mongo.jar com.mongodb.util.tools.ConnectionPoolStat --help}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ConnectionPoolStat.Position Deprecated.
(package private) static class	ConnectionPoolStat.StringType Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.management.MBeanServerConnection	mBeanConnection Deprecated.

Constructor Summary

Constructors

Constructor and Description
ConnectionPoolStat() Deprecated. Use the platform MBean server.
ConnectionPoolStat(javax.management.MBeanServerConnection mBeanConnection) Deprecated. Use the given MBean server connection to access statistics for connection pools.

Method Summary

Modifier and Type	Method and Description
private static int	getIntegerArg(java.lang.String arg, java.lang.String argName) Deprecated.
private java.lang.String	getKeyString(java.lang.String key) Deprecated.
java.lang.String	getStats() Deprecated. Gets the statistics for all Mongo connection pools registered with the MBean server used by this instance.
private java.lang.String	getValueString(java.lang.Object value, ConnectionPoolStat.StringType stringType) Deprecated.
static void	main(java.lang.String[] args) Deprecated. Command line interface for displaying connection pool stats.
private void	print(java.io.PrintWriter pw) Deprecated.
private void	printAttribute(java.lang.String key, javax.management.ObjectName objectName, java.io.PrintWriter pw) Deprecated.
private void	printAttribute(java.lang.String key, java.lang.Object value, java.io.PrintWriter pw) Deprecated.
private void	printAttribute(java.lang.String key, java.lang.Object value, java.io.PrintWriter pw, ConnectionPoolStat.Position position, ConnectionPoolStat.StringType stringType) Deprecated.
private void	printCompositeDataAttribute(java.lang.String key, javax.management.openmbean.CompositeData compositeData, java.io.PrintWriter pw) Deprecated.
private void	printCompositeDataAttribute(java.lang.String key, javax.management.openmbean.CompositeData compositeData, java.io.PrintWriter pw, ConnectionPoolStat.Position position) Deprecated.
private void	printCompositeDataAttribute(java.lang.String key, javax.management.openmbean.CompositeData compositeData, java.io.PrintWriter pw, ConnectionPoolStat.Position position, ConnectionPoolStat.StringType stringType) Deprecated.
private void	printCompositeDataAttribute(java.lang.String key, javax.management.openmbean.CompositeData compositeData, java.io.PrintWriter pw, ConnectionPoolStat.StringType stringType) Deprecated.
private static void	printErrorAndUsageAndExit(java.lang.String error) Deprecated.
private void	printInUseConnections(javax.management.openmbean.CompositeData statistics, java.io.PrintWriter pw) Deprecated.
private void	printSimpleStatistics(java.io.PrintWriter pw, javax.management.openmbean.CompositeData statistics) Deprecated.
private void	printStatistics(java.io.PrintWriter pw, javax.management.ObjectName objectName) Deprecated.
private static void	printUsage() Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mBeanConnection

private final javax.management.MBeanServerConnection mBeanConnection

Deprecated.

Constructor Detail

ConnectionPoolStat

public ConnectionPoolStat(javax.management.MBeanServerConnection mBeanConnection)

Deprecated.

Use the given MBean server connection to access statistics for connection pools.

Parameters:

mBeanConnection - the MBean server to connect to

ConnectionPoolStat

public ConnectionPoolStat()

Deprecated.

Use the platform MBean server. This is useful if you want to access statistics for connection pools in the same virtual machine.

See Also:

ManagementFactory.getPlatformMBeanServer()

Method Detail

getStats

public java.lang.String getStats()
                          throws javax.management.JMException,
                                 java.io.IOException

Deprecated.

Gets the statistics for all Mongo connection pools registered with the MBean server used by this instance. The format will always be JSON, but the specific JSON fields may change in a future release. An example of the output, which should not be taken as a specification:

   { pools : [
     { objectName: 'com.mongodb:type=ConnectionPool,host=localhost/127.0.0.1,port=27018,instance=1',
       host: 'localhost', port: 27018, maxSize: 10, total: 10, inUse: 3,
       inUseConnections: [
         { namespace: 'FindContention.test', opCode: 'OP_QUERY', query: { }, numDocuments: 1, threadName: 'pool-2-thread-19', durationMS: 843, localPort: 64062 },
         { namespace: 'FindContention.test', opCode: 'OP_QUERY', query: { }, numDocuments: 1, threadName: 'pool-2-thread-1', durationMS: 4331, localPort: 64095 },
         { namespace: 'FindContention.test', opCode: 'OP_QUERY', query: { }, numDocuments: 1, threadName: 'pool-2-thread-16', durationMS: 4343, localPort: 64087 }
       ]
     },
     { objectName: 'com.mongodb:type=ConnectionPool,host=localhost/127.0.0.1,port=27017,instance=1',
       host: 'localhost', port: 27017, maxSize: 10, total: 10, inUse: 2,
       inUseConnections: [
         { namespace: 'FindContention.test', opCode: 'OP_QUERY', query: { }, numDocuments: 1, threadName: 'pool-2-thread-5', durationMS: 920, localPort: 64093 },
         { namespace: 'FindContention.test', opCode: 'OP_QUERY', query: { }, numDocuments: 1, threadName: 'pool-2-thread-11', durationMS: 1468, localPort: 64068 },
       ]
     }
    ]
   }

Returns:

JSON-formatted stats for all connection pools registered in JMX

Throws:

javax.management.JMException - for any JMX-related exceptions

java.io.IOException - for any I/O exceptions

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Deprecated.

Command line interface for displaying connection pool stats. In order to connect to a remote JMX server to get these stats, currently you must set com.sun.management.jmxremote.port system property on the remote server and specify that port using the --port argument.

Parameters:

args - program arguments

Throws:

java.lang.Exception - JMX-related exceptions

See Also:

printUsage()

getIntegerArg

private static int getIntegerArg(java.lang.String arg,
                                 java.lang.String argName)

Deprecated.

printErrorAndUsageAndExit

private static void printErrorAndUsageAndExit(java.lang.String error)

Deprecated.

printUsage

private static void printUsage()

Deprecated.

print

private void print(java.io.PrintWriter pw)
            throws javax.management.JMException,
                   java.io.IOException

Deprecated.

Throws:

javax.management.JMException

java.io.IOException

printStatistics

private void printStatistics(java.io.PrintWriter pw,
                             javax.management.ObjectName objectName)
                      throws javax.management.InstanceNotFoundException,
                             java.io.IOException,
                             javax.management.ReflectionException,
                             javax.management.AttributeNotFoundException,
                             javax.management.MBeanException

Deprecated.

Throws:

javax.management.InstanceNotFoundException

java.io.IOException

javax.management.ReflectionException

javax.management.AttributeNotFoundException

javax.management.MBeanException

printSimpleStatistics

private void printSimpleStatistics(java.io.PrintWriter pw,
                                   javax.management.openmbean.CompositeData statistics)
                            throws javax.management.InstanceNotFoundException,
                                   java.io.IOException,
                                   javax.management.ReflectionException,
                                   javax.management.AttributeNotFoundException,
                                   javax.management.MBeanException

Deprecated.

Throws:

javax.management.InstanceNotFoundException

java.io.IOException

javax.management.ReflectionException

javax.management.AttributeNotFoundException

javax.management.MBeanException

printInUseConnections

private void printInUseConnections(javax.management.openmbean.CompositeData statistics,
                                   java.io.PrintWriter pw)
                            throws javax.management.InstanceNotFoundException,
                                   java.io.IOException,
                                   javax.management.ReflectionException,
                                   javax.management.AttributeNotFoundException,
                                   javax.management.MBeanException

Deprecated.

Throws:

javax.management.InstanceNotFoundException

java.io.IOException

javax.management.ReflectionException

javax.management.AttributeNotFoundException

javax.management.MBeanException

printCompositeDataAttribute

private void printCompositeDataAttribute(java.lang.String key,
                                         javax.management.openmbean.CompositeData compositeData,
                                         java.io.PrintWriter pw)

Deprecated.

printCompositeDataAttribute

private void printCompositeDataAttribute(java.lang.String key,
                                         javax.management.openmbean.CompositeData compositeData,
                                         java.io.PrintWriter pw,
                                         ConnectionPoolStat.Position position)

Deprecated.

printCompositeDataAttribute

private void printCompositeDataAttribute(java.lang.String key,
                                         javax.management.openmbean.CompositeData compositeData,
                                         java.io.PrintWriter pw,
                                         ConnectionPoolStat.StringType stringType)

Deprecated.

printCompositeDataAttribute

private void printCompositeDataAttribute(java.lang.String key,
                                         javax.management.openmbean.CompositeData compositeData,
                                         java.io.PrintWriter pw,
                                         ConnectionPoolStat.Position position,
                                         ConnectionPoolStat.StringType stringType)

Deprecated.

printAttribute

private void printAttribute(java.lang.String key,
                            javax.management.ObjectName objectName,
                            java.io.PrintWriter pw)
                     throws javax.management.InstanceNotFoundException,
                            java.io.IOException,
                            javax.management.ReflectionException,
                            javax.management.AttributeNotFoundException,
                            javax.management.MBeanException

Deprecated.

Throws:

javax.management.InstanceNotFoundException

java.io.IOException

javax.management.ReflectionException

javax.management.AttributeNotFoundException

javax.management.MBeanException

printAttribute

private void printAttribute(java.lang.String key,
                            java.lang.Object value,
                            java.io.PrintWriter pw)

Deprecated.

printAttribute

private void printAttribute(java.lang.String key,
                            java.lang.Object value,
                            java.io.PrintWriter pw,
                            ConnectionPoolStat.Position position,
                            ConnectionPoolStat.StringType stringType)

Deprecated.

getKeyString

private java.lang.String getKeyString(java.lang.String key)

Deprecated.

getValueString

private java.lang.String getValueString(java.lang.Object value,
                                        ConnectionPoolStat.StringType stringType)

Deprecated.