Expand Collapse
Just a second...

Statistics.xml

This file specifies the schema for the properties defining statistics collection. The statistics are broken into sections: client, topic, server and publisher.

statistics

Properties defining statistics collection.

The following table lists the attributes that an element of type statistics can have:
Name Type Description Required
enabled push:boolean DEPRECATED: since 6.2. Statistics collection is always enabled. This setting is no longer used and will be removed in a future version of the product. false
The following table lists the elements that an element of type statistics can contain:
Name Type Description Min occurs Max occurs
client-statistics client-statistics Control over session statistics. Summary reports will regularly be written to the server log. The log message gives a count of all of the different client types. Each counter is reset according to the configured frequency. Per-instance statistics can be enabled. 0 1
topic-statistics topic-statistics Control over topic statistics. 0 1
publisher-statistics publisher-statistics Control over publisher statistics. DEPRECATED: since 6.2. All settings that control publisher statistics have been deprecated. This element will be removed in a future version of the product. 0 1
reporters reporters Optional set of StatisticsReporters to be loaded with Diffusion, which are registered with the internal StatisticsService and used to generate output. 0 1

client-statistics

The following table lists the attributes that an element of type client-statistics can have:
Name Type Description Required
enabled push:boolean DEPRECATED: since 6.2. Aggregate session statistics collection is always enabled. This setting is no longer used and will be removed in a future version of the product. false
The following table lists the elements that an element of type client-statistics can contain:
Name Type Description Min occurs Max occurs
log-name push:string DEPRECATED: since 6.1. This setting is no longer 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. 0 1
output-frequency push:millis Specifies the output frequency of the log. There is one entry per specified interval. If this is not specified, a default of 1h is used. 0 1
reset-frequency push:millis Specifies when the counters are reset. The reset interval must be a multiple of the output frequency. Zero specifies that the counters are never reset. If this is not specified, a default of 1h is used. 0 1
monitor-instances push:boolean Specifies if individual client statistics are enabled. This also enables the regular reports of the session statistics summaries to the server log. 0 1

topic-statistics

The following table lists the attributes that an element of type topic-statistics can have:
Name Type Description Required
enabled push:boolean DEPRECATED: since 6.2. Aggregate topic statistics collection is always enabled. This setting is no longer used and will be removed in a future version of the product. false
The following table lists the elements that an element of type topic-statistics can contain:
Name Type Description Min occurs Max occurs
monitor-instances push:boolean Specifies if individual topic statistics are enabled. 0 1

publisher-statistics

The following table lists the attributes that an element of type publisher-statistics can have:
Name Type Description Required
enabled push:boolean DEPRECATED: since 6.2. Aggregate publisher statistics collection is always enabled. This setting is no longer used and will be removed in a future version of the product. false
The following table lists the elements that an element of type publisher-statistics can contain:
Name Type Description Min occurs Max occurs
monitor-instances push:boolean Specifies if individual publisher statistics are enabled. DEPRECATED: since 6.1. To simplify the statistics model and reduce the cost of reporting, per-publisher statistics are being retired in favour of server-scoped statistics. 0 1

reporters

The set of StatisticsReporters that the Diffusion server is aware of at startup. Used to output the statistics gathered for clients, publishers, or topics.

The following table lists the elements that an element of type reporters can contain:
Name Type Description Min occurs Max occurs
reporter reporter A reporter definition. 0 unbounded

reporter

A StatisticsReporter definition.

The following table lists the attributes that an element of type reporter can have:
Name Type Description Required
name push:string The reporter name. true
enabled push:boolean Whether the reporter is enabled. If this is set to true, the reporter is automatically loaded when Diffusion starts. Otherwise, you must manually load the reporter config at run-time using the statistics API. true
The following table lists the elements that an element of type reporter can contain:
Name Type Description Min occurs Max occurs
type push:string The type of reporter to be used. Currently options are: TOPIC - exposes metrics in the Diffusion topic tree; JMX - exposes metrics on the local JMX server. 1 1
property property A property available to the reporter. This can be used to configure reporter-specific variables or parameters. 0 unbounded

property

A StatisticsReporter property. Currently accepted values: 'interval' - used by the topic reporter. Specifies an integer value, in seconds, used to set the period of update publishing.

The following table lists the attributes that an element of type property can have:
Name Type Description Required
name push:string The property value true
type push:string An optional property type. Usage of this is implementation specific. false

propertyValue

This value must be a push:string.