From 16dc441ac5593e31e74ee7d0a96f5cf696333d72 Mon Sep 17 00:00:00 2001
From: technoddy <mail.technoddy@gmail.com>
Date: Sun, 14 Jan 2024 12:38:26 -0500
Subject: [PATCH] implementation for bael-7192

---
 logging-modules/loki-logback/README.md        |  1 +
 logging-modules/loki-logback/pom.xml          | 65 +++++++++++++++++++
 .../java/com/baeldung/loki/DemoService.java   | 15 +++++
 .../src/main/resources/logback-spring.xml     | 55 ++++++++++++++++
 .../com/baeldung/loki/DemoServiceTest.java    | 49 ++++++++++++++
 5 files changed, 185 insertions(+)
 create mode 100644 logging-modules/loki-logback/README.md
 create mode 100644 logging-modules/loki-logback/pom.xml
 create mode 100644 logging-modules/loki-logback/src/main/java/com/baeldung/loki/DemoService.java
 create mode 100644 logging-modules/loki-logback/src/main/resources/logback-spring.xml
 create mode 100644 logging-modules/loki-logback/src/test/java/com/baeldung/loki/DemoServiceTest.java

diff --git a/logging-modules/loki-logback/README.md b/logging-modules/loki-logback/README.md
new file mode 100644
index 0000000000..e320af31b4
--- /dev/null
+++ b/logging-modules/loki-logback/README.md
@@ -0,0 +1 @@
+### Relevant Articles:
\ No newline at end of file
diff --git a/logging-modules/loki-logback/pom.xml b/logging-modules/loki-logback/pom.xml
new file mode 100644
index 0000000000..7cc052b06f
--- /dev/null
+++ b/logging-modules/loki-logback/pom.xml
@@ -0,0 +1,65 @@
+<?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>
+    <artifactId>logback</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <name>logback</name>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>3.2.0</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.github.loki4j</groupId>
+            <artifactId>loki-logback-appender</artifactId>
+            <version>${loki-logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>${mockito.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit</groupId>
+            <artifactId>junit-bom</artifactId>
+            <version>${junit-jupiter.version}</version>
+            <type>pom</type>
+            <scope>import</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-devtools</artifactId>
+            <scope>runtime</scope>
+            <optional>true</optional>
+        </dependency>
+    </dependencies>
+
+    <properties>
+        <logback.contrib.version>0.1.5</logback.contrib.version>
+        <loki-logback.version>1.4.2</loki-logback.version>
+        <slf4j.version>2.0.4</slf4j.version>
+        <lombok.version>1.18.22</lombok.version>
+        <mockito.version>5.6.0</mockito.version>
+    </properties>
+
+</project>
\ No newline at end of file
diff --git a/logging-modules/loki-logback/src/main/java/com/baeldung/loki/DemoService.java b/logging-modules/loki-logback/src/main/java/com/baeldung/loki/DemoService.java
new file mode 100644
index 0000000000..e9071c0de9
--- /dev/null
+++ b/logging-modules/loki-logback/src/main/java/com/baeldung/loki/DemoService.java
@@ -0,0 +1,15 @@
+package com.baeldung.loki;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+@Service
+public class DemoService {
+
+    private final Logger LOG = LoggerFactory.getLogger(DemoService.class);
+
+    public void log() {
+        LOG.info("DemoService.log invoked");
+    }
+}
diff --git a/logging-modules/loki-logback/src/main/resources/logback-spring.xml b/logging-modules/loki-logback/src/main/resources/logback-spring.xml
new file mode 100644
index 0000000000..fa4b92f2f6
--- /dev/null
+++ b/logging-modules/loki-logback/src/main/resources/logback-spring.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+    <springProperty name="name" source="spring.application.name"/>
+
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>
+                {
+                "level":"%level",
+                "class":"%logger{36}",
+                "thread":"%thread",
+                "message": "%message",
+                "requestId": "%X{X-Request-ID}"
+                }
+            </pattern>
+            <!--            <pattern>-->
+            <!--                %d{HH:mm:ss.SSS} %-5level %logger{36} %X{X-Request-ID} - %msg%n-->
+            <!--            </pattern>-->
+        </encoder>
+    </appender>
+
+    <appender name="LOKI" class="com.github.loki4j.logback.Loki4jAppender">
+        <!-- (1) -->
+        <http>
+            <url>http://localhost:3100/loki/api/v1/push</url>
+        </http>
+        <format>
+            <!-- (2) -->
+            <label>
+                <pattern>app=${name},host=${HOSTNAME},level=%level</pattern>
+                <!-- (3) -->
+                <readMarkers>true</readMarkers>
+            </label>
+            <message>
+                <!-- (4) -->
+                <pattern>
+                    {
+                    "level":"%level",
+                    "class":"%logger{36}",
+                    "thread":"%thread",
+                    "message": "%message",
+                    "requestId": "%X{X-Request-ID}"
+                    }
+                </pattern>
+            </message>
+        </format>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="CONSOLE"/>
+        <appender-ref ref="LOKI"/>
+    </root>
+
+</configuration>
\ No newline at end of file
diff --git a/logging-modules/loki-logback/src/test/java/com/baeldung/loki/DemoServiceTest.java b/logging-modules/loki-logback/src/test/java/com/baeldung/loki/DemoServiceTest.java
new file mode 100644
index 0000000000..be88b80445
--- /dev/null
+++ b/logging-modules/loki-logback/src/test/java/com/baeldung/loki/DemoServiceTest.java
@@ -0,0 +1,49 @@
+package com.baeldung.loki;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.text.ParseException;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
+import org.mockito.Mock;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.Appender;
+
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest(classes = DemoService.class)
+public class DemoServiceTest {
+
+    @Mock
+    Appender<ILoggingEvent> appender;
+
+    @Captor
+    ArgumentCaptor<ILoggingEvent> captor;
+
+    @Test
+    public void givenLokiAppender_whenSampleServiceInvoked_ThenCaptureInfoLog() throws ParseException {
+        ch.qos.logback.classic.Logger logger = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
+        when(appender.getName()).thenReturn("loki-logback-appender");
+        logger.addAppender(appender);
+
+        DemoService service = new DemoService();
+        service.log();
+
+        verify(appender, times(1)).doAppend(captor.capture());
+        List<ILoggingEvent> allValues = captor.getAllValues();
+        assertEquals(1, allValues.size());
+        ILoggingEvent event = allValues.get(0);
+        assertEquals(event.getLevel(), Level.INFO);
+        assertEquals("DemoService.log invoked", event.getFormattedMessage());
+    }
+}