JVM Metrics #

Available Metrics #

Kamon will automatically detect and start the JVM metrics module when it is in your classpath and the following metrics will become available:

jvm.gc histogram

Tracks the distribution of GC events duration.

Tags included by default:

collector: Name of the garbage collector.
generation: Name of the generation (young or old) on which the GC event happened.
db.vendor: Name of the JDBC driver vendor.

jvm.gc.promotion histogram

Tracks the distribution of promoted bytes to the old generation regions after a GC.

jvm.memory.used histogram

Samples the used space in a memory region.

Tags included by default:

region: Name of the memory region being measured.

jvm.memory.free histogram

Samples the free space in a memory region.

Tags included by default:

region: Name of the memory region being measured.

jvm.memory.committed gauge

Tracks the committed space in a memory region.

Tags included by default:

region: Name of the memory region being measured.

jvm.memory.max gauge

Tracks the max space in a memory region.

Tags included by default:

region: Name of the memory region being measured.

jvm.memory.pool.used histogram

Samples the used space in a memory pool.

Tags included by default:

pool: Name of the memory pool being measured.

jvm.memory.pool.free histogram

Samples the free space in a memory pool.

Tags included by default:

pool: Name of the memory pool being measured.

jvm.memory.pool.committed gauge

Tracks the committed space in a memory pool.

Tags included by default:

pool: Name of the memory pool being measured.

jvm.memory.pool.max gauge

Tracks the max space in a memory pool.

Tags included by default:

pool: Name of the memory pool being measured.

jvm.memory.allocation counter

Tracks the estimated amount of bytes allocated by the JVM.

Disabling the Module #

This module is enabled by default, but you can explicitly enable/disable it by changing the enabled setting in your application configuration:

kamon.modules {
  jvm-metrics {
    enabled = no
  }
}

Kamon will still recognize that the module is available, but will not automatically start it when Kamon.init() or Kamon.loadModules() are called.

Manual Installation #

In case you are not using the Kamon Bundle, add the dependency below to your build (the JVM metrics module is distributed as part of the system metrics module).


libraryDependencies += "io.kamon" %% "kamon-system-metrics" % "2.5.9"


    <dependency>
      <groupId>io.kamon</groupId>
      <artifactId>kamon-system-metrics_2.13</artifactId>
      <version>2.5.9</version>
    </dependency>


implementation 'io.kamon:kamon-system-metrics_2.13:2.5.9'

On this article