ServerStatistics (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.server.ServerStatistics

```
public class ServerStatistics
extends java.lang.Object
```
Wrapper class to provide server statistics information. This can be obtained calling Server.getStatistics().

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ServerStatistics.CatalogStatistics`
`static class`	`ServerStatistics.SetsStatistics`
`static class`	`ServerStatistics.SetType`

Constructor Summary

Constructors
Constructor and Description

ServerStatistics(JPack statisticsPack)

Constructors
Constructor and Description
`ServerStatistics(JPack statisticsPack)`

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Date`	`getCaptureDate()`
`long`	`getCatalogsCacheSizeAllocated()`
`java.util.Set<ServerStatistics.CatalogStatistics>`	`getCatalogStatistics()`
`long`	`getConnectionMemoryUsed()`
`long`	`getCumulusToolsProcessMemoryUsed()`
`java.util.List<java.lang.Long>`	`getHourlyCacheLimitHits()`
`long`	`getJavaVMMemoryUsed()`
`int`	`getNumberOfClientConnections()`
`int`	`getNumberOfCumulusToolProcesses()`
`int`	`getNumberOfSessions()`
`int`	`getNumberOfUsersCached()`
`ServerStatistics.SetsStatistics`	`getPrivateSetsStatistics()`
`long`	`getProcessMemoryUsed()`
`long`	`getProcessVirtualMemoryUsed()`
`long`	`getSessionTempFileCacheSize()`
`long`	`getSessionTempFileSize()`
`ServerStatistics.SetsStatistics`	`getSharedSetsStatistics()`
`long`	`getUserCacheMemoryUsed()`
`java.lang.String`	`toJSON()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServerStatistics
```
public ServerStatistics(JPack statisticsPack)
```
- Method Detail
  - toJSON
```
public java.lang.String toJSON()
                        throws JSONException
```
    Throws:
    
    JSONException
  - getCaptureDate
```
public java.util.Date getCaptureDate()
```
    Returns:
    The date and time the statistics information was captured on the server (in UTC as seen by the server)
  - getProcessMemoryUsed
```
public long getProcessMemoryUsed()
```
    Returns:
    The total amount of physical memory used by this server process
  - getProcessVirtualMemoryUsed
```
public long getProcessVirtualMemoryUsed()
```
    Returns:
    The total amount of virtual memory occupied by this server.
  - getNumberOfCumulusToolProcesses
```
public int getNumberOfCumulusToolProcesses()
```
    Returns:
    The number of running CumulusTool processes that were started by this server.
  - getCumulusToolsProcessMemoryUsed
```
public long getCumulusToolsProcessMemoryUsed()
```
    Returns:
    The total amount of memory occupied by CumulusTool processes started by this server.
  - getNumberOfClientConnections
```
public int getNumberOfClientConnections()
```
    Returns:
    The number of client connections to this server
  - getUserCacheMemoryUsed
```
public long getUserCacheMemoryUsed()
```
    Returns:
    The total memory used for cached user data
  - getNumberOfUsersCached
```
public int getNumberOfUsersCached()
```
    Returns:
    the number of user data records cached.
  - getNumberOfSessions
```
public int getNumberOfSessions()
```
    Returns:
    the number of user data records cached.
  - getSessionTempFileSize
```
public long getSessionTempFileSize()
```
    Returns:
    The total amount of disk space occupied by session-related temporary files.
  - getSessionTempFileCacheSize
```
public long getSessionTempFileCacheSize()
```
    Returns:
    The total amount of cache memory occupied by session-related temporary files.
  - getConnectionMemoryUsed
```
public long getConnectionMemoryUsed()
```
    Returns:
    The total amount of memory occupied by TCP/IP connection buffers.
  - getJavaVMMemoryUsed
```
public long getJavaVMMemoryUsed()
```
    Returns:
    The total amount of memory occupied by the Java VM running inside this server.
  - getSharedSetsStatistics
```
public ServerStatistics.SetsStatistics getSharedSetsStatistics()
```
    Returns:
    The statistics for all shared server-side sets.
  - getPrivateSetsStatistics
```
public ServerStatistics.SetsStatistics getPrivateSetsStatistics()
```
    Returns:
    The statistics for all private server-side sets loaded into memory.
  - getCatalogStatistics
```
public java.util.Set<ServerStatistics.CatalogStatistics> getCatalogStatistics()
```
    Returns:
    The statistics for all catalogs.
  - getHourlyCacheLimitHits
```
public java.util.List<java.lang.Long> getHourlyCacheLimitHits()
```
    Returns:
    A list of cache limit hits for the last hours. The highest number is the current hour.
  - getCatalogsCacheSizeAllocated
```
public long getCatalogsCacheSizeAllocated()
```
    Returns:
    The total amount of cache allocated for catalogs.
    Since:
    
    11.0.2

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class ServerStatistics

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerStatistics

Method Detail

toJSON

getCaptureDate

getProcessMemoryUsed

getProcessVirtualMemoryUsed

getNumberOfCumulusToolProcesses

getCumulusToolsProcessMemoryUsed

getNumberOfClientConnections

getUserCacheMemoryUsed

getNumberOfUsersCached

getNumberOfSessions

getSessionTempFileSize

getSessionTempFileCacheSize

getConnectionMemoryUsed

getJavaVMMemoryUsed

getSharedSetsStatistics

getPrivateSetsStatistics

getCatalogStatistics

getHourlyCacheLimitHits

getCatalogsCacheSizeAllocated