Merge branch 'slf4j-2' into 'main'

SLF4J 2

Closes #12 and #13

See merge request bot-by/slf4j-aws-lambda!11

Author: vitalijr2

changelog.md

@@ -4,7 +4,8 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 2.1.1 - 2022-08-14
+## 3.0.0 - 2022-08-21
+- **Add a module**
 - Update dependencies
 - Update documentation
 

pom.xml

@@ -66,7 +66,7 @@
 
   <properties>
     <!-- version -->
-    <revision>2.1.2</revision>
+    <revision>3.0.0</revision>
     <changelist>-SNAPSHOT</changelist>
     <sha1/>
     <!-- java and maven -->
@@ -100,7 +100,7 @@
     <commons-text.version>1.9</commons-text.version>
     <!-- dependencies -->
     <jetbrains-annotations.version>23.0.0</jetbrains-annotations.version>
-    <slf4j.version>2.0.0-beta1</slf4j.version>
+    <slf4j.version>2.0.0</slf4j.version>
   </properties>
 
   <dependencies>
@@ -256,6 +256,15 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-jar-plugin</artifactId>
         <version>${jar-plugin.version}</version>
+        <configuration>
+          <archive>
+            <manifestEntries>
+              <Automatic-Module-Name>org.slf4j.aws_lambda</Automatic-Module-Name>
+              <Add-Exports>uk.bot_by.aws_lambda.slf4j</Add-Exports>
+              <Add-Exports>org.slf4j.impl</Add-Exports>
+            </manifestEntries>
+          </archive>
+        </configuration>
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>

readme.md

@@ -43,7 +43,8 @@ END RequestId: cc4eb5aa-66b4-42fc-b27a-138bd672b38a
 ```
 
 The footprint of **slf4j-aws-lambda** (68K) is same size as **slf4j-simple** (64K) and much smaller
-than **logback** (716K).
+than **logback** (716K). Other AWS centric loggers are [SLF4J/Logback Appender][awslambda-logback],
+Logback's [CloudWatch appender][cloudwatch-appender] and [CloudWatchLogs Java appender][cloudwatchlogs-java-appender].
 
 There is a great original [manual][manual].
 
@@ -119,3 +120,9 @@ limitations under the License.
 [slf4j-simple]: https://www.slf4j.org/api/org/slf4j/simple/SimpleLogger.html
 
 [SimpleDateFormat]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/SimpleDateFormat.html
+
+[awslambda-logback]: https://github.com/jlib-framework/jlib-awslambda-logback
+
+[cloudwatch-appender]: https://github.com/sndyuk/logback-more-appenders
+
+[cloudwatchlogs-java-appender]: https://github.com/boxfuse/cloudwatchlogs-java-appender

src/main/java/uk/bot_by/aws_lambda/slf4j/AWSLambdaServiceProvider.java

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2022 Witalij Berdinskich
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package uk.bot_by.aws_lambda.slf4j;
 
 import org.slf4j.ILoggerFactory;
@@ -7,6 +22,13 @@
 import org.slf4j.spi.MDCAdapter;
 import org.slf4j.spi.SLF4JServiceProvider;
 
+/**
+ * Responsible for binding the {@link LambdaLoggerFactory}, the {@link BasicMarkerFactory} and the
+ * {@link BasicMDCAdapter}. This is used by the SLF4J API.
+ *
+ * @author Witalij Berdinskich
+ * @since 2.2.0
+ */
 public class AWSLambdaServiceProvider implements SLF4JServiceProvider {
 
   /**

src/site/markdown/index.md

@@ -41,10 +41,17 @@ END RequestId: cc4eb5aa-66b4-42fc-b27a-138bd672b38a
 ```
 
 The footprint of **slf4j-aws-lambda** (68K) is same size as **slf4j-simple** (64K) and much smaller
-than **logback** (716K).
+than **logback** (716K). Other AWS centric loggers are [jlib-framework/jlib-awslambda-logback][awslambda-logback],
+Logback's [CloudWatch appender][cloudwatch-appender] and [CloudWatchLogs Java appender][cloudwatchlogs-appender].
 
 [SLF4J]: https://www.slf4j.org/
 
 [lambda]: https://aws.amazon.com/lambda/
 
 [example]: https://gitlab.com/bot-by/slf4j-aws-lambda/-/tree/main/example "SLF4J for AWS Lambda Demo"
+
+[awslambda-logback]: https://github.com/jlib-framework/jlib-awslambda-logback
+
+[cloudwatch-appender]: https://github.com/sndyuk/logback-more-appenders
+
+[cloudwatchlogs-java-appender]: https://github.com/boxfuse/cloudwatchlogs-java-appender