Module probes
Module probes collect information about the modules (Java and light modules) installed in Magnolia. They can be used to discover what modules are present and their versions.
Module probes are configured in the instrumentation module.
There are two system probes:
-
ModulesProbe
-
ModuleVersionsProbe
Both probes capture the same information - the installed modules and their versions - but in slightly different forms as metric labels. |
The module probes are configured in the Instrumentation module. Module probes should be added in /modules/instrumentation/config/probes and specify the class property (required) and enabled property (optional). Module probes defined in the instrumentation module are created or modified when the instrumentation module is restarted or changed.
ModulesProbe
The ModulesProbe records the installed modules in Magnolia and their versions.
The ModulesProbe records the modules installed in Magnolia like ModuleVersionsProbe. Unlike ModuleVersionsProbe, ModulesProbes records each installed module as a separate measurement with set labels (moduleName and moduleVersion).
Configuration properties
Property | Description | Required |
---|---|---|
|
Should be |
|
|
The metric name stored by Prometheus. Taken as the node name when configured. |
|
|
Default = |
|
|
A description of the metric. |
Metrics
Metric | Description | ||
---|---|---|---|
|
The configured metric name.
|
ModuleVersionsProbe
The ModuleVersionProbe records the modules installed in Magnolia like ModulesProbe. Unlike ModulesProbe, ModuleVersionsProbes records each installed module as a label with the module name as the label name and the module version as the label value.
The modules and versions recorded by ModuleVersionsProbe may be more convenient to work than separate measurements for each module recorded by ModulesProbe.
Configuration properties
Property | Description | Required |
---|---|---|
|
Should be |
|
|
The metric name stored by Prometheus. Taken as the node name when configured. |
|
|
Default = |
|
|
A description of the metric. |