ClientStatisticsConfig (Diffusion)

All Superinterfaces:

Config
```
public interface ClientStatisticsConfig
extends Config
```
Client Statistics Configuration.
This specifies configuration relating to client session statistics.
setEnabled(boolean) and setInstanceMonitoringEnabled(boolean) control the granularity of session statistics recorded and published to the console and JMX.
If client session statistics are enabled, a summary of the session statistics will regularly be written to the server log. These reports are published on a schedule controlled by the setOutputFrequency(long) and setResetFrequency(long).
These properties may only be set before a Diffusion Server is started.

Since:

4.4

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getLogName()` Deprecated. since 6.1. This setting is not used and will be removed in a future version of the product. Session statistics are now written to the server log. If separate log files are required or the reports are not desired, use a third-party SLF4J logging back-end such as Log4j 2, and configure it appropriately to partition or filter the server log.
`long`	`getOutputFrequency()` Gets the output frequency for statistics reports to the log.
`long`	`getResetFrequency()` Gets the reset frequency.
`boolean`	`isEnabled()` Deprecated. since 6.2. Aggregate session statistics collection is always enabled. This method is no longer used and will be removed in a future version of the product.
`boolean`	`isInstanceMonitoringEnabled()` Deprecated. since 6.3. Per-client statistics have been replaced by session metric collectors. This method will always return false.
`void`	`setEnabled(boolean enabled)` Deprecated. since 6.2. Aggregated session statistics collection is always enabled. This method is no longer used and will be removed in a future version of the product.
`void`	`setInstanceMonitoringEnabled(boolean enabled)` Deprecated. since 6.3. Per-client statistics have been replaced by session metric collectors. This method now has no effect.
`void`	`setLogName(String logName)` Deprecated. since 6.1. This setting is not used and will be removed in a future version of the product. Session statistics are now written to the server log. If separate log files are required or the reports are not desired, use a third-party SLF4J logging back-end such as Log4j 2, and configure it appropriately to partition or filter the server log.
`void`	`setOutputFrequency(long frequency)` Sets the output frequency for statistics reports to the log.
`void`	`setResetFrequency(long frequency)` Sets the reset frequency

Methods inherited from interface com.pushtechnology.diffusion.api.config.Config
isLocked

- Method Detail
  - isEnabled
```
@Deprecated
boolean isEnabled()
```
    Deprecated. since 6.2. Aggregate session statistics collection is always enabled. This method is no longer used and will be removed in a future version of the product.
    
    Query whether reporting of global client session statistic, is enabled.
    
    Returns:
    
    always true
  - setEnabled
```
@Deprecated
void setEnabled(boolean enabled)
```
    Deprecated. since 6.2. Aggregated session statistics collection is always enabled. This method is no longer used and will be removed in a future version of the product.
    
    Set whether reporting of client session statistics is enabled.
    
    Parameters:
    
    enabled - ignored
  - getLogName
```
@Deprecated
String getLogName()
```
    Deprecated. since 6.1. This setting is not used and will be removed in a future version of the product. Session statistics are now written to the server log. If separate log files are required or the reports are not desired, use a third-party SLF4J logging back-end such as Log4j 2, and configure it appropriately to partition or filter the server log.
    
    Gets the log file name.
    
    Returns:
    
    null
  - setLogName
```
@Deprecated
void setLogName(String logName)
                     throws ConfigException
```
    Deprecated. since 6.1. This setting is not used and will be removed in a future version of the product. Session statistics are now written to the server log. If separate log files are required or the reports are not desired, use a third-party SLF4J logging back-end such as Log4j 2, and configure it appropriately to partition or filter the server log.
    
    Sets the log file name.
    
    Throws:
    
    ConfigException - if unable to set log name
  - getOutputFrequency
```
long getOutputFrequency()
```
    Gets the output frequency for statistics reports to the log.
    
    Returns:
    
    output frequency in milliseconds.
  - setOutputFrequency
```
void setOutputFrequency(long frequency)
                 throws ConfigException
```
    Sets the output frequency for statistics reports to the log. There will be one entry written to the log every interval.
    If this is not explicitly specified, a log entry will be written every hour.
    
    Parameters:
    
    frequency - the output frequency in milliseconds.
    
    Throws:
    
    ConfigException - if unable to set frequency.
  - getResetFrequency
```
long getResetFrequency()
```
    Gets the reset frequency.
    
    Returns:
    
    reset frequency
  - setResetFrequency
```
void setResetFrequency(long frequency)
                throws ConfigException
```
    Sets the reset frequency
    Specifies when the counters are reset. Zero means that the counters are never reset.
    If this is not explicitly set, the counters are reset every hour.
    
    Parameters:
    
    frequency - the frequency in milliseconds
    
    Throws:
    
    ConfigException - if unable to set frequency
  - isInstanceMonitoringEnabled
```
@Deprecated
boolean isInstanceMonitoringEnabled()
```
    Deprecated. since 6.3. Per-client statistics have been replaced by session metric collectors. This method will always return false.
    
    Query whether instance statistics for client sessions are enabled.
    
    Returns:
    
    false
  - setInstanceMonitoringEnabled
```
@Deprecated
void setInstanceMonitoringEnabled(boolean enabled)
```
    Deprecated. since 6.3. Per-client statistics have been replaced by session metric collectors. This method now has no effect.
    
    Set whether instance statistics for client sessions are enabled.
    
    Parameters:
    
    enabled - ignored

Interface ClientStatisticsConfig

Method Summary

Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

Method Detail

isEnabled

setEnabled

getLogName

setLogName

getOutputFrequency

setOutputFrequency

getResetFrequency

setResetFrequency

isInstanceMonitoringEnabled

setInstanceMonitoringEnabled