steffan-westcott.clj-otel.instrumentation.runtime-telemetry-java17
Functions for registering measurements about the JVM runtime on Java 17+.
Functions for registering measurements about the JVM runtime on Java 17+.
close!clj
(close! runtime-metrics)Stops generation of JVM metrics. Takes runtime-metrics returned by
register!.
Stops generation of JVM metrics. Takes `runtime-metrics` returned by [[register!]].
register!clj
(register!)(register! opts)(register! open-telemetry {:keys [jmx jfr] :or {jmx true}})Registers measurements that generate all JVM runtime metrics, using some
combination of JMX and JFR, and returns a RuntimeMetrics instance that may
be used to stop generation (see close!). open-telemetry is an
OpenTelemetry instance where to register the metrics. See
io.opentelemetry.instrumentation.runtimemetrics.java17.JfrFeature for more
details on JFR features that may be enabled.
By default, all JMX and some JFR features are enabled to register a maximal
selection of measurements. For a finer level of control, use the option map
opts as follows:
| key | description |
|---|---|
:jmx | If true, include all JMX measurements, otherwise do not include any JMX measurements (default: true) |
:jfr | Either a map or boolean value. If a map, the map keys are JfrFeature enum values, and the map boolean values determine if the feature should be enabled (true) or disabled (false). If not a map, the value determines if all JFR features should be enabled (true) or disabled (false) (default: See JfrFeature for each JFR feature default). |
Registers measurements that generate all JVM runtime metrics, using some combination of JMX and JFR, and returns a `RuntimeMetrics` instance that may be used to stop generation (see [[close!]]). `open-telemetry` is an `OpenTelemetry` instance where to register the metrics. See `io.opentelemetry.instrumentation.runtimemetrics.java17.JfrFeature` for more details on JFR features that may be enabled. By default, all JMX and some JFR features are enabled to register a maximal selection of measurements. For a finer level of control, use the option map `opts` as follows: | key | description | |------|-------------| |`:jmx`| If true, include all JMX measurements, otherwise do not include any JMX measurements (default: true) |`:jfr`| Either a map or boolean value. If a map, the map keys are `JfrFeature` enum values, and the map boolean values determine if the feature should be enabled (true) or disabled (false). If not a map, the value determines if all JFR features should be enabled (true) or disabled (false) (default: See JfrFeature for each JFR feature default).
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close