Reference doc update for logging (#4593)

micrometer-metrics · Jan 19, 2024 · 7f0d479 · 7f0d479
1 parent d959d9b
commit 7f0d479
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 0 deletions.
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -42,6 +42,7 @@
 ** xref:reference/httpcomponents.adoc[HttpComponents Client]
 ** xref:reference/jetty.adoc[Jetty and Jersey]
 ** xref:reference/jvm.adoc[JVM]
+** xref:reference/logging.adoc[Logging]
 ** xref:reference/mongodb.adoc[MongoDB]
 ** xref:reference/netty.adoc[Netty]
 ** xref:reference/okhttpclient.adoc[OkHttpClient]

diff --git a/docs/modules/ROOT/pages/reference/logging.adoc b/docs/modules/ROOT/pages/reference/logging.adoc
@@ -0,0 +1,31 @@
+[[overview]]
+= Logging Metrics Instrumentation
+
+Micrometer can add metrics to different loggers
+
+* <<logging-log4j, Log4j>>
+* <<logging-logback, Logback>>
+
+[[logging-log4j]]
+== Log4j Instrumentation
+
+[source,java,subs=+attributes]
+-----
+// Setting up instrumentation
+include::{include-core-test-java}/io/micrometer/core/instrument/binder/logging/Log4j2MetricsTest.java[tags=setup, indent=0]
+
+// Usage example
+include::{include-core-test-java}/io/micrometer/core/instrument/binder/logging/Log4j2MetricsTest.java[tags=example, indent=0]
+-----
+
+[[logging-logback]]
+== Logback Instrumentation
+
+[source,java,subs=+attributes]
+-----
+// Setting up instrumentation
+include::{include-core-test-java}/io/micrometer/core/instrument/binder/logging/LogbackMetricsTest.java[tags=setup, indent=0]
+
+// Usage example
+include::{include-core-test-java}/io/micrometer/core/instrument/binder/logging/LogbackMetricsTest.java[tags=example, indent=0]
+-----
diff --git a/...er-core/src/test/java/io/micrometer/core/instrument/binder/logging/Log4j2MetricsTest.java b/...er-core/src/test/java/io/micrometer/core/instrument/binder/logging/Log4j2MetricsTest.java
@@ -61,10 +61,13 @@ static void cleanUpAfterAll() {
 
     @Test
     void log4j2LevelMetrics() {
+        // tag::setup[]
         new Log4j2Metrics().bindTo(registry);
+        // end::setup[]
 
         assertThat(registry.get("log4j2.events").counter().count()).isEqualTo(0.0);
 
+        // tag::example[]
         Logger logger = LogManager.getLogger(Log4j2MetricsTest.class);
         Configurator.setLevel(Log4j2MetricsTest.class.getName(), Level.INFO);
         logger.info("info");
@@ -80,6 +83,7 @@ void log4j2LevelMetrics() {
         assertThat(registry.get("log4j2.events").tags("level", "error").counter().count()).isEqualTo(1.0);
         assertThat(registry.get("log4j2.events").tags("level", "debug").counter().count()).isEqualTo(0.0);
         assertThat(registry.get("log4j2.events").tags("level", "trace").counter().count()).isEqualTo(0.0);
+        // end::example[]
     }
 
     @Test

diff --git a/...r-core/src/test/java/io/micrometer/core/instrument/binder/logging/LogbackMetricsTest.java b/...r-core/src/test/java/io/micrometer/core/instrument/binder/logging/LogbackMetricsTest.java
@@ -47,8 +47,10 @@ class LogbackMetricsTest {
 
     @BeforeEach
     void bindLogbackMetrics() {
+        // tag::setup[]
         logbackMetrics = new LogbackMetrics();
         logbackMetrics.bindTo(registry);
+        // end::setup[]
     }
 
     @AfterEach
@@ -62,6 +64,7 @@ void closeLogbackMetrics() {
     void logbackLevelMetrics() {
         assertThat(registry.get("logback.events").counter().count()).isEqualTo(0.0);
 
+        // tag::example[]
         logger.setLevel(Level.INFO);
 
         logger.warn("warn");
@@ -70,6 +73,7 @@ void logbackLevelMetrics() {
 
         assertThat(registry.get("logback.events").tags("level", "warn").counter().count()).isEqualTo(1.0);
         assertThat(registry.get("logback.events").tags("level", "debug").counter().count()).isEqualTo(0.0);
+        // end::example[]
     }
 
     @Issue("#183")