org.springframework.data.gemfire.config.annotation

Annotation Type EnableStatistics

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Import(value=StatisticsConfiguration.class)
 @UsesGemFireProperties
public @interface EnableStatistics

The EnableStatistics annotation marks a Spring @Configuration annotated Class to configure and enable statistics and runtime metrics of a running Pivotal GemFire/Apache Geode system. Sets statistic-sampling-enabled to true.

Since:

1.9.0

Author:

John Blum

See Also:

Annotation, Import, StatisticsConfiguration

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	archiveDiskSpaceLimit Maximum size (in megabytes) of all inactive statistic archive files combined.
String	archiveFile The file to which the running system member writes statistic samples.
int	archiveFileSizeLimit The maximum size (in megabytes) of a single statistic archive file.
boolean	enableTimeStatistics Boolean instructing the system to track time-based statistics for the distributed system and caching.
long	sampleRate How often to sample statistics, in milliseconds.

Element Detail

archiveDiskSpaceLimit

public abstract int archiveDiskSpaceLimit

Maximum size (in megabytes) of all inactive statistic archive files combined. If this limit is exceeded, inactive archive files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. Defaults to 0 MB. Use the spring.data.gemfire.stats.archive-disk-space-limit property in application.properties.

Default:

0

archiveFile

public abstract String archiveFile

The file to which the running system member writes statistic samples. For example: “StatisticsArchiveFile.gfs”. An empty string disables archiving. Adding .gz suffix to the file name causes it to be compressed. Defaults to unset. Use the spring.data.gemfire.stats.archive-file property in application.properties.

Default:

""

archiveFileSizeLimit

public abstract int archiveFileSizeLimit

The maximum size (in megabytes) of a single statistic archive file. Once this limit is exceeded, a new statistic archive file is created, and the current archive file becomes inactive. If set to zero, file size is unlimited. Defaults to 0 MB. Use the spring.data.gemfire.stats.archive-file-size-limit property in application.properties.

Default:

0

enableTimeStatistics

public abstract boolean enableTimeStatistics

Boolean instructing the system to track time-based statistics for the distributed system and caching. Disabled by default for performance reasons and not recommended for production environments. Defaults to false. Use the spring.data.gemfire.stats.enable-time-statistics property in application.properties.

Default:

false

sampleRate

public abstract long sampleRate

How often to sample statistics, in milliseconds. Valid values are in the range 100..60000. Defaults to 1000 milliseconds. Use the spring.data.gemfire.stats.sample-rate property in application.properties.

Default:

1000L