docs: Initial javadocs for PowerLogger class. (#43)

* docs: Initial javadocs for our logging annotation.

* docs: Initial javadocs for PowerLogger class.

Author: msailes

docs/content/core/logger.mdx

@@ -114,7 +114,7 @@ public class App implements RequestHandler<APIGatewayProxyRequestEvent, APIGatew
 
 ## Appending additional keys
 
-You can append your own keys to your existing Logger via `customKey`.
+You can append your own keys to your existing Logger via `appendKey`.
 
 ```java:title=App.java
 package helloworld;
@@ -135,7 +135,7 @@ public class App implements RequestHandler<APIGatewayProxyRequestEvent, APIGatew
     @PowerToolsLogging(logEvent = true)
     public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEvent input, final Context context) {
         ...
-        PowerLogger.customKey("test", "willBeLogged");
+        PowerLogger.appendKey("test", "willBeLogged");
         ...
     }
 }

example/HelloWorldFunction/src/main/java/helloworld/App.java

@@ -39,7 +39,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
         headers.put("Content-Type", "application/json");
         headers.put("X-Custom-Header", "application/json");
 
-        PowerLogger.customKey("test", "willBeLogged");
+        PowerLogger.appendKey("test", "willBeLogged");
 
         APIGatewayProxyResponseEvent response = new APIGatewayProxyResponseEvent()
                 .withHeaders(headers);

src/main/java/software/amazon/lambda/logging/PowerLogger.java

@@ -2,9 +2,21 @@
 
 import org.apache.logging.log4j.ThreadContext;
 
+/**
+ * A class of helper functions to add additional functionality to PowerToolsLogging.
+ *
+ * {@see PowerToolsLogging}
+ */
 public class PowerLogger {
 
-    public static void customKey(String key, String value) {
+    /**
+     * Appends an additional key and value to each log entry made. Duplicate values
+     * for the same key will be replaced with the latest.
+     *
+     * @param key The name of the key to be logged
+     * @param value The value to be logged
+     */
+    public static void appendKey(String key, String value) {
         ThreadContext.put(key, value);
     }
 }

src/main/java/software/amazon/lambda/logging/PowerToolsLogging.java

@@ -40,7 +40,7 @@
  * <p>By default {@code PowerToolsLogging} will not log the event which has trigger the invoke of the Lambda function.
  * This can be enabled using {@code @PowerToolsLogging(logEvent = true)}.</p>
  *
- * <p>To append additional keys to each log entry you can use {@link software.amazon.lambda.logging.PowerLogger#customKey(String, String)}</p>
+ * <p>To append additional keys to each log entry you can use {@link software.amazon.lambda.logging.PowerLogger#appendKey(String, String)}</p>
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)

src/test/java/org/apache/logging/log4j/core/layout/LambdaJsonLayoutTest.java

@@ -25,7 +25,7 @@
 
 class LambdaJsonLayoutTest {
 
-    private RequestHandler<Object, Object> handler = new PowerLogToolEnabled();
+    private final RequestHandler<Object, Object> handler = new PowerLogToolEnabled();
 
     @Mock
     private Context context;

src/test/java/software/amazon/lambda/logging/PowerLoggerTest.java

@@ -16,7 +16,7 @@ void setUp() {
 
     @Test
     void shouldSetCustomKeyOnThreadContext() {
-        PowerLogger.customKey("test", "value");
+        PowerLogger.appendKey("test", "value");
 
         assertThat(ThreadContext.getImmutableContext())
                 .hasSize(1)