aboutsummaryrefslogtreecommitdiff
path: root/kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala
diff options
context:
space:
mode:
Diffstat (limited to 'kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala')
-rw-r--r--kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala4
1 files changed, 4 insertions, 0 deletions
diff --git a/kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala b/kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala
index d059727f..cd2e3e8e 100644
--- a/kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala
+++ b/kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala
@@ -21,6 +21,10 @@ import java.lang.management.ManagementFactory
import kamon.metric.GenericEntityRecorder
import kamon.metric.instrument.{ Memory, InstrumentFactory }
+/**
+ * Heap Memory metrics, as reported by JMX:
+ * - @see [[http://docs.oracle.com/javase/7/docs/api/java/lang/management/MemoryMXBean.html "MemoryMXBean"]]
+ */
class HeapMemoryMetrics(instrumentFactory: InstrumentFactory) extends GenericEntityRecorder(instrumentFactory) {
val memoryBean = ManagementFactory.getMemoryMXBean
def nonHeapUsage = memoryBean.getHeapMemoryUsage