Activating base and vendor metrics
Base and vendor metrics are registered at deployment time by the io.smallrye.metrics.setup.JmxRegistrar
class. It is necessary to instantiate it and invoke jmxRegistrar.init(). The definitions of base and vendor
metrics are read from the file base-metrics.properties and vendor-metrics.properties, which should be available
as a resource under the path /io/smallrye/metrics/*-metrics.properties for either the classloader that
loaded the JmxRegistrar class (higher precedence) or the thread context class loader (lower precedence).
These files reference management MBeans as the sources of metric values, so they can only be used for metrics that are obtained from MBeans, and only in cases when JMX is available at runtime. Furthermore, only Counters and Gauges are currently supported through this file. In other cases, a different approach must be devised to register base and vendor metrics (but the specification does not require any base metrics of different types).
Note that JAX-RS metrics are a bit special and use a different mechanism. For info, see JAX-RS Metrics.
base-metrics.properties and vendor-metrics.properties file schema
These files list all base and vendor metrics through usage of a regular Java properties file. The schema is as following:
For simple metrics (where one MBean property corresponds to one metric), you will need these properties:
Property key |
Property meaning |
METRIC_NAME.displayName |
The display name of the metric |
METRIC_NAME.type |
The type of the metric (can be |
METRIC_NAME.unit |
The unit of the metric as a string (you can use |
METRIC_NAME.description |
The description of the metric |
METRIC_NAME.mbean |
Reference to a JMX property including the |