Statistics (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

All Known Subinterfaces:

StatisticsImplementor

All Known Implementing Classes:

StatisticsImpl
```
public interface Statistics
```
Exposes statistics for a particular SessionFactory. Beware of milliseconds metrics, they are dependent of the JVM precision: you may then encounter a 10 ms approximation depending on you OS platform. Please refer to the JVM documentation for more information.

Author:

Emmanuel Bernard

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()` reset all statistics
`CacheRegionStatistics`	`getCacheRegionStatistics(String regionName)` Get statistics for either a domain-data or query-result region - this method checks both, preferring domain data region if one.
`long`	`getCloseStatementCount()` The number of prepared statements that were released
`long`	`getCollectionFetchCount()` Global number of collections fetched
`long`	`getCollectionLoadCount()` Global number of collections loaded
`long`	`getCollectionRecreateCount()` Global number of collections recreated
`long`	`getCollectionRemoveCount()` Global number of collections removed
`String[]`	`getCollectionRoleNames()` Get the names of all collection roles
`CollectionStatistics`	`getCollectionStatistics(String role)` Get collection statistics per role
`long`	`getCollectionUpdateCount()` Global number of collections updated
`long`	`getConnectCount()` Get the global number of connections asked by the sessions (the actual number of connections used may be much smaller depending whether you use a connection pool or not)
`CacheRegionStatistics`	`getDomainDataRegionStatistics(String regionName)` Second level cache statistics per domain data (entity, collection, natural-id) region
`long`	`getEntityDeleteCount()` Get global number of entity deletes
`long`	`getEntityFetchCount()` Get global number of entity fetchs
`long`	`getEntityInsertCount()` Get global number of entity inserts
`long`	`getEntityLoadCount()` Get global number of entity loads
`String[]`	`getEntityNames()` Get the names of all entities
`EntityStatistics`	`getEntityStatistics(String entityName)` find entity statistics per name
`long`	`getEntityUpdateCount()` Get global number of entity updates
`long`	`getFlushCount()` Get the global number of flush executed by sessions (either implicit or explicit)
`long`	`getNaturalIdCacheHitCount()` Get the global number of cached naturalId lookups successfully retrieved from cache
`long`	`getNaturalIdCacheMissCount()` Get the global number of cached naturalId lookups not found in cache
`long`	`getNaturalIdCachePutCount()` Get the global number of cacheable naturalId lookups put in cache
`NaturalIdCacheStatistics`	`getNaturalIdCacheStatistics(String regionName)` Deprecated. (since 5.3) Use `getNaturalIdStatistics(java.lang.String)` or `@getDomainDataRegionStatistics` instead depending on need
`long`	`getNaturalIdQueryExecutionCount()` Get the global number of naturalId queries executed against the database
`long`	`getNaturalIdQueryExecutionMaxTime()` Get the global maximum query time for naturalId queries executed against the database
`String`	`getNaturalIdQueryExecutionMaxTimeEntity()`
`String`	`getNaturalIdQueryExecutionMaxTimeRegion()` Get the region for the maximum naturalId query time
`NaturalIdStatistics`	`getNaturalIdStatistics(String entityName)` Natural id resolution query statistics for an entity type
`long`	`getOptimisticFailureCount()` The number of `StaleObjectStateException`s that occurred
`long`	`getPrepareStatementCount()` The number of prepared statements that were acquired
`String[]`	`getQueries()` Get all executed query strings
`long`	`getQueryCacheHitCount()` Get the global number of cached queries successfully retrieved from cache
`long`	`getQueryCacheMissCount()` Get the global number of cached queries not found in cache
`long`	`getQueryCachePutCount()` Get the global number of cacheable queries put in cache
`long`	`getQueryExecutionCount()` Get global number of executed queries
`long`	`getQueryExecutionMaxTime()` Get the time in milliseconds of the slowest query.
`String`	`getQueryExecutionMaxTimeQueryString()` Get the query string for the slowest query.
`CacheRegionStatistics`	`getQueryRegionStatistics(String regionName)` Second level cache statistics per query region
`QueryStatistics`	`getQueryStatistics(String queryString)` Query statistics from query string (HQL or SQL)
`long`	`getSecondLevelCacheHitCount()` Global number of cacheable entities/collections successfully retrieved from the cache
`long`	`getSecondLevelCacheMissCount()` Global number of cacheable entities/collections not found in the cache and loaded from the database.
`long`	`getSecondLevelCachePutCount()` Global number of cacheable entities/collections put in the cache
`String[]`	`getSecondLevelCacheRegionNames()` Get all second-level cache region names.
`SecondLevelCacheStatistics`	`getSecondLevelCacheStatistics(String regionName)` Deprecated. (since 5.3) Use `getDomainDataRegionStatistics(java.lang.String)` instead
`long`	`getSessionCloseCount()` Global number of sessions closed
`long`	`getSessionOpenCount()` Global number of sessions opened
`long`	`getStartTime()` The milliseconds (JVM standard `System.currentTimeMillis()`) from which all statistics accessed since the initial creation of this Statistics instance or the last `clear()`
`long`	`getSuccessfulTransactionCount()` The number of transactions we know to have been successful
`long`	`getTransactionCount()` The number of transactions we know to have completed
`long`	`getUpdateTimestampsCacheHitCount()` Get the global number of timestamps successfully retrieved from cache
`long`	`getUpdateTimestampsCacheMissCount()` Get the global number of tables for which no update timestamps was not found in cache
`long`	`getUpdateTimestampsCachePutCount()` Get the global number of timestamps put in cache
`boolean`	`isStatisticsEnabled()` Are statistics enabled
`void`	`logSummary()` log in info level the main statistics
`void`	`setStatisticsEnabled(boolean b)` Enable statistics logs (this is a dynamic parameter)

- Method Detail
  - isStatisticsEnabled
```
boolean isStatisticsEnabled()
```
    Are statistics enabled
  - setStatisticsEnabled
```
void setStatisticsEnabled(boolean b)
```
    Enable statistics logs (this is a dynamic parameter)
  - clear
```
void clear()
```
    reset all statistics
  - logSummary
```
void logSummary()
```
    log in info level the main statistics
  - getEntityStatistics
```
EntityStatistics getEntityStatistics(String entityName)
```
    find entity statistics per name
    
    Parameters:
    
    entityName - entity name
    
    Returns:
    
    EntityStatistics object
  - getCollectionStatistics
```
CollectionStatistics getCollectionStatistics(String role)
```
    Get collection statistics per role
    
    Parameters:
    
    role - collection role
    
    Returns:
    
    CollectionStatistics
  - getNaturalIdStatistics
```
NaturalIdStatistics getNaturalIdStatistics(String entityName)
```
    Natural id resolution query statistics for an entity type
    
    Parameters:
    
    entityName - The entity name that is the root of the hierarchy containing the natural id
    
    Returns:
    
    NaturalIdCacheStatistics
  - getQueryStatistics
```
QueryStatistics getQueryStatistics(String queryString)
```
    Query statistics from query string (HQL or SQL)
    
    Parameters:
    
    queryString - query string
    
    Returns:
    
    QueryStatistics
  - getDomainDataRegionStatistics
```
CacheRegionStatistics getDomainDataRegionStatistics(String regionName)
```
    Second level cache statistics per domain data (entity, collection, natural-id) region
    
    Parameters:
    
    regionName - The unqualified region name
    
    Returns:
    
    The stats for the named region, or null if the second level cache is not enabled
    
    Throws:
    
    IllegalArgumentException - if the region name could not be resolved
  - getQueryRegionStatistics
```
CacheRegionStatistics getQueryRegionStatistics(String regionName)
```
    Second level cache statistics per query region
    
    Parameters:
    
    regionName - The unqualified region name
    
    Returns:
    
    Stats for the named region, or null if (1) query result caching is not enabled or (2) no query region exists with that name
  - getCacheRegionStatistics
```
CacheRegionStatistics getCacheRegionStatistics(String regionName)
```
    Get statistics for either a domain-data or query-result region - this method checks both, preferring domain data region if one. Think of it as a cascading check to:
    1. getDomainDataRegionStatistics(java.lang.String)
    2. getQueryRegionStatistics(java.lang.String)
    Note that returning null is preferred here over throwing an exception when no region exists with that name.
    Parameters:
    
    regionName - The unqualified region name
    
    Returns:
    
    Stats for the named region, or null if no such region exists
  - getEntityDeleteCount
```
long getEntityDeleteCount()
```
    Get global number of entity deletes
    
    Returns:
    
    entity deletion count
  - getEntityInsertCount
```
long getEntityInsertCount()
```
    Get global number of entity inserts
    
    Returns:
    
    entity insertion count
  - getEntityLoadCount
```
long getEntityLoadCount()
```
    Get global number of entity loads
    
    Returns:
    
    entity load (from DB)
  - getEntityFetchCount
```
long getEntityFetchCount()
```
    Get global number of entity fetchs
    
    Returns:
    
    entity fetch (from DB)
  - getEntityUpdateCount
```
long getEntityUpdateCount()
```
    Get global number of entity updates
    
    Returns:
    
    entity update
  - getQueryExecutionCount
```
long getQueryExecutionCount()
```
    Get global number of executed queries
    
    Returns:
    
    query execution count
  - getQueryExecutionMaxTime
```
long getQueryExecutionMaxTime()
```
    Get the time in milliseconds of the slowest query.
  - getQueryExecutionMaxTimeQueryString
```
String getQueryExecutionMaxTimeQueryString()
```
    Get the query string for the slowest query.
  - getQueryCacheHitCount
```
long getQueryCacheHitCount()
```
    Get the global number of cached queries successfully retrieved from cache
  - getQueryCacheMissCount
```
long getQueryCacheMissCount()
```
    Get the global number of cached queries *not* found in cache
  - getQueryCachePutCount
```
long getQueryCachePutCount()
```
    Get the global number of cacheable queries put in cache
  - getNaturalIdQueryExecutionCount
```
long getNaturalIdQueryExecutionCount()
```
    Get the global number of naturalId queries executed against the database
  - getNaturalIdQueryExecutionMaxTime
```
long getNaturalIdQueryExecutionMaxTime()
```
    Get the global maximum query time for naturalId queries executed against the database
  - getNaturalIdQueryExecutionMaxTimeRegion
```
String getNaturalIdQueryExecutionMaxTimeRegion()
```
    Get the region for the maximum naturalId query time
  - getNaturalIdQueryExecutionMaxTimeEntity
```
String getNaturalIdQueryExecutionMaxTimeEntity()
```
  - getNaturalIdCacheHitCount
```
long getNaturalIdCacheHitCount()
```
    Get the global number of cached naturalId lookups successfully retrieved from cache
  - getNaturalIdCacheMissCount
```
long getNaturalIdCacheMissCount()
```
    Get the global number of cached naturalId lookups *not* found in cache
  - getNaturalIdCachePutCount
```
long getNaturalIdCachePutCount()
```
    Get the global number of cacheable naturalId lookups put in cache
  - getUpdateTimestampsCacheHitCount
```
long getUpdateTimestampsCacheHitCount()
```
    Get the global number of timestamps successfully retrieved from cache
  - getUpdateTimestampsCacheMissCount
```
long getUpdateTimestampsCacheMissCount()
```
    Get the global number of tables for which no update timestamps was *not* found in cache
  - getUpdateTimestampsCachePutCount
```
long getUpdateTimestampsCachePutCount()
```
    Get the global number of timestamps put in cache
  - getFlushCount
```
long getFlushCount()
```
    Get the global number of flush executed by sessions (either implicit or explicit)
  - getConnectCount
```
long getConnectCount()
```
    Get the global number of connections asked by the sessions (the actual number of connections used may be much smaller depending whether you use a connection pool or not)
  - getSecondLevelCacheHitCount
```
long getSecondLevelCacheHitCount()
```
    Global number of cacheable entities/collections successfully retrieved from the cache
  - getSecondLevelCacheMissCount
```
long getSecondLevelCacheMissCount()
```
    Global number of cacheable entities/collections not found in the cache and loaded from the database.
  - getSecondLevelCachePutCount
```
long getSecondLevelCachePutCount()
```
    Global number of cacheable entities/collections put in the cache
  - getSessionCloseCount
```
long getSessionCloseCount()
```
    Global number of sessions closed
  - getSessionOpenCount
```
long getSessionOpenCount()
```
    Global number of sessions opened
  - getCollectionLoadCount
```
long getCollectionLoadCount()
```
    Global number of collections loaded
  - getCollectionFetchCount
```
long getCollectionFetchCount()
```
    Global number of collections fetched
  - getCollectionUpdateCount
```
long getCollectionUpdateCount()
```
    Global number of collections updated
  - getCollectionRemoveCount
```
long getCollectionRemoveCount()
```
    Global number of collections removed
  - getCollectionRecreateCount
```
long getCollectionRecreateCount()
```
    Global number of collections recreated
  - getStartTime
```
long getStartTime()
```
    The milliseconds (JVM standard System.currentTimeMillis()) from which all statistics accessed since the initial creation of this Statistics instance or the last clear()
  - getQueries
```
String[] getQueries()
```
    Get all executed query strings
  - getEntityNames
```
String[] getEntityNames()
```
    Get the names of all entities
  - getCollectionRoleNames
```
String[] getCollectionRoleNames()
```
    Get the names of all collection roles
  - getSecondLevelCacheRegionNames
```
String[] getSecondLevelCacheRegionNames()
```
    Get all second-level cache region names. Note: for backwards compatibility this method returns just the names of regions storing domain data, not query result regions
  - getSuccessfulTransactionCount
```
long getSuccessfulTransactionCount()
```
    The number of transactions we know to have been successful
  - getTransactionCount
```
long getTransactionCount()
```
    The number of transactions we know to have completed
  - getPrepareStatementCount
```
long getPrepareStatementCount()
```
    The number of prepared statements that were acquired
  - getCloseStatementCount
```
long getCloseStatementCount()
```
    The number of prepared statements that were released
  - getOptimisticFailureCount
```
long getOptimisticFailureCount()
```
    The number of StaleObjectStateExceptions that occurred
  - getSecondLevelCacheStatistics
```
@Deprecated
SecondLevelCacheStatistics getSecondLevelCacheStatistics(String regionName)
```
    Deprecated. (since 5.3) Use getDomainDataRegionStatistics(java.lang.String) instead
    
    Second level cache statistics per region
    
    Parameters:
    
    regionName - qualified region name
    
    Returns:
    
    SecondLevelCacheStatistics or null if the second level cache is not enabled
    
    Throws:
    
    IllegalArgumentException - if the region name could not be resolved
  - getNaturalIdCacheStatistics
```
@Deprecated
NaturalIdCacheStatistics getNaturalIdCacheStatistics(String regionName)
```
    Deprecated. (since 5.3) Use getNaturalIdStatistics(java.lang.String) or @getDomainDataRegionStatistics instead depending on need
    
    Natural id cache statistics per region
    
    Parameters:
    
    regionName - region name
    
    Returns:
    
    NaturalIdCacheStatistics

Interface Statistics

Method Summary

Method Detail

isStatisticsEnabled

setStatisticsEnabled

clear

logSummary

getEntityStatistics

getCollectionStatistics

getNaturalIdStatistics

getQueryStatistics

getDomainDataRegionStatistics

getQueryRegionStatistics

getCacheRegionStatistics

getEntityDeleteCount

getEntityInsertCount

getEntityLoadCount

getEntityFetchCount

getEntityUpdateCount

getQueryExecutionCount

getQueryExecutionMaxTime

getQueryExecutionMaxTimeQueryString

getQueryCacheHitCount

getQueryCacheMissCount

getQueryCachePutCount

getNaturalIdQueryExecutionCount

getNaturalIdQueryExecutionMaxTime

getNaturalIdQueryExecutionMaxTimeRegion

getNaturalIdQueryExecutionMaxTimeEntity

getNaturalIdCacheHitCount

getNaturalIdCacheMissCount

getNaturalIdCachePutCount

getUpdateTimestampsCacheHitCount

getUpdateTimestampsCacheMissCount

getUpdateTimestampsCachePutCount

getFlushCount

getConnectCount

getSecondLevelCacheHitCount

getSecondLevelCacheMissCount

getSecondLevelCachePutCount

getSessionCloseCount

getSessionOpenCount

getCollectionLoadCount

getCollectionFetchCount

getCollectionUpdateCount

getCollectionRemoveCount

getCollectionRecreateCount

getStartTime

getQueries

getEntityNames

getCollectionRoleNames

getSecondLevelCacheRegionNames

getSuccessfulTransactionCount

getTransactionCount

getPrepareStatementCount

getCloseStatementCount

getOptimisticFailureCount

getSecondLevelCacheStatistics

getNaturalIdCacheStatistics