aboutsummaryrefslogtreecommitdiff
path: root/kamon-system-metrics/src/main/scala/kamon/system/jmx/MemoryPoolMetrics.scala
blob: 8c2d2293a790d8012f4b0c71e9bdfdcf48597f21 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
 * =========================================================================================
 * 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, MemoryPoolMXBean }

import kamon.metric.GenericEntityRecorder
import kamon.metric.instrument.{ InstrumentFactory, Memory }

import scala.collection.convert.WrapAsScala

/**
 * Generic memory pool stat recorder.
 * Records the amount of used, max, and committed memory in bytes for each passed MemoryPoolMXBean.
 * @param instrumentFactory Helpers for metric recording.
 * @param beansWithNames Data sources with metric name prefixes.
 */
class MemoryPoolMetrics(instrumentFactory: InstrumentFactory,
    beansWithNames: Iterable[MemoryBeanWithMetricName]) extends GenericEntityRecorder(instrumentFactory) {
  beansWithNames.foreach {
    case MemoryBeanWithMetricName(name, bean) 
      gauge(name + "-used", Memory.Bytes, ()  {
        bean.getUsage.getUsed
      })

      gauge(name + "-max", Memory.Bytes, ()  {
        val max = bean.getUsage.getMax

        // .getMax can return -1 if the max is not defined.
        if (max >= 0) max
        else 0
      })

      gauge(name + "-committed", Memory.Bytes, ()  {
        bean.getUsage.getCommitted
      })
  }
}

/**
 * Objects of this kind may be passed to [[MemoryPoolMetrics]] for data collection.
 * @param metricName The sanitized name of a [[MemoryPoolMXBean]].
 * @param bean The data source for metrics.
 */
private[jmx] final case class MemoryBeanWithMetricName(metricName: String, bean: MemoryPoolMXBean)

/**
 *  Memory Pool metrics, as reported by JMX:
 *    - @see [[http://docs.oracle.com/javase/7/docs/api/java/lang/management/MemoryMXBean.html "MemoryMXBean"]]
 *  Pools in HotSpot Java 8:
 *  code-cache, metaspace, compressed-class-space, ps-eden-space, ps-survivor-space, ps-old-gen
 */
object MemoryPoolMetrics extends JmxSystemMetricRecorderCompanion("memory-pool") with WrapAsScala {

  private val invalidChars = """[^a-z0-9]""".r

  private def sanitizedName(memoryPoolMXBean: MemoryPoolMXBean) =
    invalidChars.replaceAllIn(memoryPoolMXBean.getName.toLowerCase, "-")

  private val beansWithNames = ManagementFactory.getMemoryPoolMXBeans.toIterable.map { bean 
    MemoryBeanWithMetricName(sanitizedName(bean), bean)
  }

  def apply(instrumentFactory: InstrumentFactory): MemoryPoolMetrics =
    new MemoryPoolMetrics(instrumentFactory, beansWithNames)
}