io.tsdb.services.framework.common.instrumentation.metricsets

Class FileSystemMetricSet

java.lang.Object

io.tsdb.services.framework.common.instrumentation.metricsets.FileSystemMetricSet

All Implemented Interfaces:

com.codahale.metrics.Metric, com.codahale.metrics.MetricSet

public class FileSystemMetricSet
extends java.lang.Object
implements com.codahale.metrics.MetricSet

A set of gauges for basic properties of file systems visible to the JVM.

For each FS, gauges for the following properties are reported:

• total_bytes - total number of bytes
• used_bytes - number of bytes used
• used_pc - percentage used
• free_bytes - number of bytes free
• free_pc - percentage free

Note that filesystem names are highly implementation-specific. Override getFSName(FileStore) with an implementation that works on your platform, for example getFSNameByToStringPath(FileStore)

Constructor Summary

Constructors

Constructor and Description
FileSystemMetricSet() Get metrics about default filesystems as returned by FileSystems.getDefault(), skipping those with no usable space.
FileSystemMetricSet(java.nio.file.FileSystem fs, boolean skipZeroAvail)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFSNameByName(java.nio.file.FileStore store) FileStore names are highly implementation specific.
java.util.Map<java.lang.String,com.codahale.metrics.Metric>	getMetrics()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemMetricSet

public FileSystemMetricSet()

Get metrics about default filesystems as returned by FileSystems.getDefault(), skipping those with no usable space.

FileSystemMetricSet

public FileSystemMetricSet(java.nio.file.FileSystem fs,
                           boolean skipZeroAvail)

Parameters:

fs - the Filesystem to use

skipZeroAvail - Flag about whether or not to include FileStores that show no usable space

Method Detail

getMetrics

public java.util.Map<java.lang.String,com.codahale.metrics.Metric> getMetrics()

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet

getFSNameByName

public java.lang.String getFSNameByName(java.nio.file.FileStore store)

FileStore names are highly implementation specific. This function simply escapes the name returned by name().

Parameters:

store - the FileStore to get name of

Returns:

an escaped version of FileStore.name()