public interface ClientStatisticsConfig extends Config
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.
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
|
@Deprecated boolean isEnabled()
@Deprecated void setEnabled(boolean enabled)
enabled
- ignored@Deprecated String getLogName()
@Deprecated void setLogName(String logName) throws ConfigException
ConfigException
- if unable to set log namelong getOutputFrequency()
void setOutputFrequency(long frequency) throws ConfigException
If this is not explicitly specified, a log entry will be written every hour.
frequency
- the output frequency in milliseconds.ConfigException
- if unable to set frequency.long getResetFrequency()
void setResetFrequency(long frequency) throws ConfigException
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.
frequency
- the frequency in millisecondsConfigException
- if unable to set frequency@Deprecated boolean isInstanceMonitoringEnabled()
@Deprecated void setInstanceMonitoringEnabled(boolean enabled)
enabled
- ignoredCopyright © 2020 Push Technology Ltd. All Rights Reserved.