aboutsummaryrefslogtreecommitdiff
path: root/kamon-system-metrics/src/main/scala/kamon/system/jmx/HeapMemoryMetrics.scala
blob: cd2e3e8e1d4db166dbc855a21e7d5bac26fd5042 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*
 * =========================================================================================
 * Copyright © 2013-2015 the kamon project <http://kamon.io/>
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 * =========================================================================================
 */

package kamon.system.jmx

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

  gauge("heap-used", Memory.Bytes, ()  {
    nonHeapUsage.getUsed
  })

  gauge("heap-max", Memory.Bytes, ()  {
    nonHeapUsage.getMax
  })

  gauge("heap-committed", Memory.Bytes, ()  {
    nonHeapUsage.getCommitted
  })

}

object HeapMemoryMetrics extends JmxSystemMetricRecorderCompanion("heap-memory") {
  def apply(instrumentFactory: InstrumentFactory): HeapMemoryMetrics =
    new HeapMemoryMetrics(instrumentFactory)
}