JvmMetrics (avaje-metric-api 7.4.1 API)

All Known Subinterfaces:

SpiMetricManager
```
public interface JvmMetrics
```
Standard JVM metrics built in that we often register.
Typically we want the standard JVM metrics and either Logback or Log4J metrics and this provides a relatively easy way to register those.
```
  MetricManager.jvmMetrics()
    .withReportAlways()
    .registerStandardJvmMetrics()
    .registerLogbackMetrics();
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`JvmMetrics`	`registerJvmGCMetrics()` Register metrics for GC activity.
`JvmMetrics`	`registerJvmMemoryMetrics()` Register metrics for heap and non-heap memory.
`JvmMetrics`	`registerJvmOsLoadMetric()` Register a metric for OS load.
`JvmMetrics`	`registerJvmProcessMemoryMetrics()` Register metrics for VMRSS process memory (if supported on the platform).
`JvmMetrics`	`registerJvmThreadMetrics()` Register metrics for the total number of threads allocated.
`JvmMetrics`	`registerLog4JMetrics()` Register metrics for Log4J error and warning messages.
`JvmMetrics`	`registerLogbackMetrics()` Register metrics for Logback error and warning messages.
`JvmMetrics`	`registerStandardJvmMetrics()` Register all the standard JVM metrics - memory, threads, gc, os load and process memory.
`JvmMetrics`	`withLogMetricName(String errorMetricName, String warnMetricName)` Set the names of the metrics for logging errors and warnings.
`JvmMetrics`	`withReportAlways()` Set to report the metrics irrespective of whether the metric has changed.
`JvmMetrics`	`withReportChangesOnly()` Set to only report when the metrics change.

- Method Detail
  - withReportChangesOnly
```
JvmMetrics withReportChangesOnly()
```
    Set to only report when the metrics change. This is the default and means that metrics that don't change are not reported.
  - withReportAlways
```
JvmMetrics withReportAlways()
```
    Set to report the metrics irrespective of whether the metric has changed.
    For metrics that generally don't change like max memory or don't change as frequently these metrics will be reported every time.
  - registerStandardJvmMetrics
```
JvmMetrics registerStandardJvmMetrics()
```
    Register all the standard JVM metrics - memory, threads, gc, os load and process memory.
  - registerJvmOsLoadMetric
```
JvmMetrics registerJvmOsLoadMetric()
```
    Register a metric for OS load.
  - registerJvmGCMetrics
```
JvmMetrics registerJvmGCMetrics()
```
    Register metrics for GC activity.
  - registerJvmThreadMetrics
```
JvmMetrics registerJvmThreadMetrics()
```
    Register metrics for the total number of threads allocated.
  - registerJvmMemoryMetrics
```
JvmMetrics registerJvmMemoryMetrics()
```
    Register metrics for heap and non-heap memory.
  - registerJvmProcessMemoryMetrics
```
JvmMetrics registerJvmProcessMemoryMetrics()
```
    Register metrics for VMRSS process memory (if supported on the platform).
  - withLogMetricName
```
JvmMetrics withLogMetricName(String errorMetricName,
                             String warnMetricName)
```
    Set the names of the metrics for logging errors and warnings.
    When not set these default to app.log.error and app.log.warn respectively.
  - registerLogbackMetrics
```
JvmMetrics registerLogbackMetrics()
```
    Register metrics for Logback error and warning messages.
  - registerLog4JMetrics
```
JvmMetrics registerLog4JMetrics()
```
    Register metrics for Log4J error and warning messages.

Interface JvmMetrics

Method Summary

Method Detail

withReportChangesOnly

withReportAlways

registerStandardJvmMetrics

registerJvmOsLoadMetric

registerJvmGCMetrics

registerJvmThreadMetrics

registerJvmMemoryMetrics

registerJvmProcessMemoryMetrics

withLogMetricName

registerLogbackMetrics

registerLog4JMetrics