Add module for Logback 1.5.x

metrics-bom/pom.xml

@@ -155,6 +155,11 @@
                 <artifactId>metrics-logback14</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.dropwizard.metrics5</groupId>
+                <artifactId>metrics-logback15</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>io.dropwizard.metrics5</groupId>
                 <artifactId>metrics-servlet</artifactId>

metrics-logback15/pom.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>io.dropwizard.metrics5</groupId>
+        <artifactId>metrics-parent</artifactId>
+        <version>5.0.0-rc21-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>metrics-logback15</artifactId>
+    <name>Metrics Integration for Logback 1.5.x</name>
+    <packaging>bundle</packaging>
+    <description>
+        An instrumented appender for Logback 1.5.x.
+    </description>
+
+    <properties>
+        <javaModuleName>io.dropwizard.metrics5.logback15</javaModuleName>
+        <logback15.version>1.5.0</logback15.version>
+
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>io.dropwizard.metrics5</groupId>
+                <artifactId>metrics-bom</artifactId>
+                <version>${project.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+            <dependency>
+                <groupId>net.bytebuddy</groupId>
+                <artifactId>byte-buddy</artifactId>
+                <version>${byte-buddy.version}</version>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.dropwizard.metrics5</groupId>
+            <artifactId>metrics-core</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-api</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-core</artifactId>
+            <version>${logback15.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback15.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>${assertj.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>${junit5.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>${junit5.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>${mockito.version}</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>

metrics-logback15/src/main/java/io/dropwizard/metrics5/logback15/InstrumentedAppender.java

@@ -0,0 +1,91 @@
+package io.dropwizard.metrics5.logback15;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.Appender;
+import ch.qos.logback.core.UnsynchronizedAppenderBase;
+import io.dropwizard.metrics5.Meter;
+import io.dropwizard.metrics5.MetricRegistry;
+import io.dropwizard.metrics5.SharedMetricRegistries;
+
+import static io.dropwizard.metrics5.MetricRegistry.name;
+
+/**
+ * A Logback {@link Appender} which has six meters, one for each logging level and one for the total
+ * number of statements being logged. The meter names are the logging level names appended to the
+ * name of the appender.
+ */
+public class InstrumentedAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
+    private final MetricRegistry registry;
+    public static final String DEFAULT_REGISTRY = "logback-metrics";
+    public static final String REGISTRY_PROPERTY_NAME = "metrics.logback.registry";
+
+    private Meter all;
+    private Meter trace;
+    private Meter debug;
+    private Meter info;
+    private Meter warn;
+    private Meter error;
+
+
+    /**
+     * Create a new instrumented appender using the given registry name.
+     */
+    public InstrumentedAppender() {
+        this(System.getProperty(REGISTRY_PROPERTY_NAME, DEFAULT_REGISTRY));
+    }
+
+    /**
+     * Create a new instrumented appender using the given registry name.
+     *
+     * @param registryName the name of the registry in {@link SharedMetricRegistries}
+     */
+    public InstrumentedAppender(String registryName) {
+        this(SharedMetricRegistries.getOrCreate(registryName));
+    }
+
+    /**
+     * Create a new instrumented appender using the given registry.
+     *
+     * @param registry the metric registry
+     */
+    public InstrumentedAppender(MetricRegistry registry) {
+        this.registry = registry;
+        setName(Appender.class.getName());
+    }
+
+    @Override
+    public void start() {
+        this.all = registry.meter(name(getName(), "all"));
+        this.trace = registry.meter(name(getName(), "trace"));
+        this.debug = registry.meter(name(getName(), "debug"));
+        this.info = registry.meter(name(getName(), "info"));
+        this.warn = registry.meter(name(getName(), "warn"));
+        this.error = registry.meter(name(getName(), "error"));
+        super.start();
+    }
+
+    @Override
+    protected void append(ILoggingEvent event) {
+        all.mark();
+        switch (event.getLevel().toInt()) {
+            case Level.TRACE_INT:
+                trace.mark();
+                break;
+            case Level.DEBUG_INT:
+                debug.mark();
+                break;
+            case Level.INFO_INT:
+                info.mark();
+                break;
+            case Level.WARN_INT:
+                warn.mark();
+                break;
+            case Level.ERROR_INT:
+                error.mark();
+                break;
+            default:
+                break;
+        }
+    }
+}

metrics-logback15/src/test/java/io/dropwizard/metrics5/logback15/InstrumentedAppenderTest.java

@@ -0,0 +1,142 @@
+package io.dropwizard.metrics5.logback15;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import io.dropwizard.metrics5.MetricRegistry;
+import io.dropwizard.metrics5.SharedMetricRegistries;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class InstrumentedAppenderTest {
+
+    public static final String METRIC_NAME_PREFIX = "ch.qos.logback.core.Appender";
+
+    private final MetricRegistry registry = new MetricRegistry();
+    private final InstrumentedAppender appender = new InstrumentedAppender(registry);
+    private final ILoggingEvent event = mock(ILoggingEvent.class);
+
+    @BeforeEach
+    void setUp() {
+        appender.start();
+    }
+
+    @AfterEach
+    void tearDown() {
+        SharedMetricRegistries.clear();
+    }
+
+    @Test
+    void metersTraceEvents() {
+        when(event.getLevel()).thenReturn(Level.TRACE);
+
+        appender.doAppend(event);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".all").getCount())
+                .isEqualTo(1);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".trace").getCount())
+                .isEqualTo(1);
+    }
+
+    @Test
+    void metersDebugEvents() {
+        when(event.getLevel()).thenReturn(Level.DEBUG);
+
+        appender.doAppend(event);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".all").getCount())
+                .isEqualTo(1);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".debug").getCount())
+                .isEqualTo(1);
+    }
+
+    @Test
+    void metersInfoEvents() {
+        when(event.getLevel()).thenReturn(Level.INFO);
+
+        appender.doAppend(event);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".all").getCount())
+                .isEqualTo(1);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".info").getCount())
+                .isEqualTo(1);
+    }
+
+    @Test
+    void metersWarnEvents() {
+        when(event.getLevel()).thenReturn(Level.WARN);
+
+        appender.doAppend(event);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".all").getCount())
+                .isEqualTo(1);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".warn").getCount())
+                .isEqualTo(1);
+    }
+
+    @Test
+    void metersErrorEvents() {
+        when(event.getLevel()).thenReturn(Level.ERROR);
+
+        appender.doAppend(event);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".all").getCount())
+                .isEqualTo(1);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".error").getCount())
+                .isEqualTo(1);
+    }
+
+    @Test
+    void usesSharedRegistries() {
+
+        String registryName = "registry";
+
+        SharedMetricRegistries.add(registryName, registry);
+        final InstrumentedAppender shared = new InstrumentedAppender(registryName);
+        shared.start();
+
+        when(event.getLevel()).thenReturn(Level.INFO);
+
+        shared.doAppend(event);
+
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".info").getCount())
+                .isEqualTo(1);
+    }
+
+    @Test
+    void usesDefaultRegistry() {
+        SharedMetricRegistries.add(InstrumentedAppender.DEFAULT_REGISTRY, registry);
+        final InstrumentedAppender shared = new InstrumentedAppender();
+        shared.start();
+        when(event.getLevel()).thenReturn(Level.INFO);
+        shared.doAppend(event);
+
+        assertThat(SharedMetricRegistries.names()).contains(InstrumentedAppender.DEFAULT_REGISTRY);
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".info").getCount())
+                .isEqualTo(1);
+    }
+
+    @Test
+    void usesRegistryFromProperty() {
+        SharedMetricRegistries.add("something_else", registry);
+        System.setProperty(InstrumentedAppender.REGISTRY_PROPERTY_NAME, "something_else");
+        final InstrumentedAppender shared = new InstrumentedAppender();
+        shared.start();
+        when(event.getLevel()).thenReturn(Level.INFO);
+        shared.doAppend(event);
+
+        assertThat(SharedMetricRegistries.names()).contains("something_else");
+        assertThat(registry.meter(METRIC_NAME_PREFIX + ".info").getCount())
+                .isEqualTo(1);
+    }
+
+}

pom.xml

@@ -42,6 +42,7 @@
         <module>metrics-log4j2</module>
         <module>metrics-logback13</module>
         <module>metrics-logback14</module>
+        <module>metrics-logback15</module>
         <module>metrics-servlet</module>
         <module>metrics-servlets</module>
         <module>metrics-jcstress</module>