Run time probes

You have two options for collecting run time metrics:

Use RuntimeProbe (info.magnolia.services.instrumentation.probes.environment.RuntimeProbe) to collect run time metrics. RuntimeProbe will create separate metrics for each system usage characteristic. OSProbe is configured as an instrumentation module probe and the metrics will be measured when Prometheus collects all metrics from Magnolia.

Use RuntimeProbeCommand (info.magnolia.services.instrumentation.probes.commands.RuntimeProbeCommand) to collect run time metrics. RuntimeProbeCommand is a Magnolia command that collects the configured metrics when executed.

Executions of RuntimeProbeCommand can be scheduled with the Scheduler module. You can also execute the OSProbeCommand through the command REST endpoint, see the REST module.

RuntimeProbeCommand will store its measurements as a single metric with the metric labels identifying what was measured.

The RuntimeProbe records when the JVM was started and how long it has been running.

RuntimeProbe is an instrumentation module probe and is configured in the instrumentation module.

The RuntimeProbeCommand records when the JVM started or how long it has been running, along with details about the Java Virtual Machine running Magnolia.

RuntimeProbeCommand can collect two metrics:

Along with the measured metric, RuntimeProbeCommand adds the details about the JVM as labels.

Unlike other probes, RuntimeProbeCommand is a Magnolia command. RuntimeProbeCommand only measures its metrics when executed as a command. You will have to arrange for the execution of RuntimeProbeCommand in order to measure its metrics, say with the Scheduler module or the REST command endpoint.

The RuntimeProbeCommand properties metric, probeName and probeDescription can be specified in the command parameters passed during execution and will override the configured values of the properties.