diff --git a/docs/content/core/logger.mdx b/docs/content/core/logger.mdx index 7cd21c5d4..dcf56cd44 100644 --- a/docs/content/core/logger.mdx +++ b/docs/content/core/logger.mdx @@ -65,8 +65,8 @@ package helloworld; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; -import software.amazon.lambda.logging.PowerLogger; -import software.amazon.lambda.logging.PowerToolsLogging; +import software.amazon.lambda.logging.PowertoolsLogger; +import software.amazon.lambda.logging.PowertoolsLogging; ... /** @@ -76,7 +76,7 @@ public class App implements RequestHandler headers = new HashMap<>(); @@ -39,7 +39,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv headers.put("Content-Type", "application/json"); headers.put("X-Custom-Header", "application/json"); - PowerLogger.appendKey("test", "willBeLogged"); + PowertoolsLogger.appendKey("test", "willBeLogged"); APIGatewayProxyResponseEvent response = new APIGatewayProxyResponseEvent() .withHeaders(headers); diff --git a/example/HelloWorldFunction/src/main/java/helloworld/AppStream.java b/example/HelloWorldFunction/src/main/java/helloworld/AppStream.java index e0f3bda9f..9405eee49 100644 --- a/example/HelloWorldFunction/src/main/java/helloworld/AppStream.java +++ b/example/HelloWorldFunction/src/main/java/helloworld/AppStream.java @@ -1,20 +1,20 @@ package helloworld; +import com.amazonaws.services.lambda.runtime.Context; +import com.amazonaws.services.lambda.runtime.RequestStreamHandler; +import com.fasterxml.jackson.databind.ObjectMapper; +import software.amazon.lambda.powertools.logging.PowertoolsLogging; + import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.Map; -import com.amazonaws.services.lambda.runtime.Context; -import com.amazonaws.services.lambda.runtime.RequestStreamHandler; -import com.fasterxml.jackson.databind.ObjectMapper; -import software.amazon.lambda.powertools.logging.PowerToolsLogging; - public class AppStream implements RequestStreamHandler { private static final ObjectMapper mapper = new ObjectMapper(); @Override - @PowerToolsLogging(logEvent = true) + @PowertoolsLogging(logEvent = true) public void handleRequest(InputStream input, OutputStream output, Context context) throws IOException { Map map = mapper.readValue(input, Map.class); diff --git a/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowerLogger.java b/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowertoolsLogger.java similarity index 93% rename from powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowerLogger.java rename to powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowertoolsLogger.java index a161c7b8e..c947a03b9 100644 --- a/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowerLogger.java +++ b/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowertoolsLogger.java @@ -16,11 +16,11 @@ import org.apache.logging.log4j.ThreadContext; /** - * A class of helper functions to add additional functionality to PowerToolsLogging. + * A class of helper functions to add additional functionality to PowertoolsLogging. * - * {@see PowerToolsLogging} + * {@see PowertoolsLogging} */ -public class PowerLogger { +public class PowertoolsLogger { /** * Appends an additional key and value to each log entry made. Duplicate values diff --git a/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowerToolsLogging.java b/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowertoolsLogging.java similarity index 77% rename from powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowerToolsLogging.java rename to powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowertoolsLogging.java index ca6288d16..a60d5a4c9 100644 --- a/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowerToolsLogging.java +++ b/powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/PowertoolsLogging.java @@ -19,17 +19,17 @@ import java.lang.annotation.Target; /** - * {@code PowerToolsLogging} is used to signal that the annotated method should be - * extended with PowerToolsLogging functionality. + * {@code PowertoolsLogging} is used to signal that the annotated method should be + * extended with PowertoolsLogging functionality. * - *

{@code PowerToolsLogging} provides an opinionated logger with output structured as JSON.

+ *

{@code PowertoolsLogging} provides an opinionated logger with output structured as JSON.

* - *

{@code PowerToolsLogging} should be used with handleRequest method of a class + *

{@code PowertoolsLogging} should be used with handleRequest method of a class * which implements either * {@code com.amazonaws.services.lambda.runtime.RequestHandler} or * {@code com.amazonaws.services.lambda.runtime.RequestStreamHandler}.

* - *

By default {@code PowerToolsLogging} will load the following keys and values from the Lambda + *

By default {@code PowertoolsLogging} will load the following keys and values from the Lambda * {@code com.amazonaws.services.lambda.runtime.Context}

* * * - *

By default {@code PowerToolsLogging} will also create keys for:

+ *

By default {@code PowertoolsLogging} will also create keys for:

* *