Skip to content

Support for custom keys in the logs #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions example/HelloWorldFunction/src/main/java/helloworld/App.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import software.aws.lambda.logging.PowerLogger;
import software.aws.lambda.logging.PowerToolsLogging;

/**
Expand All @@ -29,6 +30,8 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
headers.put("Content-Type", "application/json");
headers.put("X-Custom-Header", "application/json");

PowerLogger.customKey("test", "willBeLogged");

APIGatewayProxyResponseEvent response = new APIGatewayProxyResponseEvent()
.withHeaders(headers);
try {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
package org.apache.logging.log4j.core.layout;

import java.io.IOException;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonRootName;
Expand All @@ -18,22 +28,11 @@
import org.apache.logging.log4j.core.util.KeyValuePair;
import org.apache.logging.log4j.util.Strings;

import java.io.IOException;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;

import static java.time.Instant.ofEpochMilli;
import static java.time.format.DateTimeFormatter.ISO_ZONED_DATE_TIME;

@Plugin(name = "LambdaJsonLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)
public class LambdaJsonLayout extends AbstractJacksonLayout {

private static final String DEFAULT_FOOTER = "]";

private static final String DEFAULT_HEADER = "[";
Expand Down
10 changes: 10 additions & 0 deletions src/main/java/software/aws/lambda/logging/PowerLogger.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package software.aws.lambda.logging;

import org.apache.logging.log4j.ThreadContext;

public class PowerLogger {

public static void customKey(String key, String value) {
ThreadContext.put(key, value);
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import com.amazonaws.services.lambda.runtime.Context;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
Expand All @@ -21,6 +21,7 @@
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import software.aws.lambda.logging.PowerToolsLogging;

import static java.util.Optional.empty;
import static java.util.Optional.of;
Expand Down
26 changes: 26 additions & 0 deletions src/test/java/software/aws/lambda/logging/PowerLoggerTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package software.aws.lambda.logging;

import org.apache.logging.log4j.ThreadContext;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import software.aws.lambda.logging.PowerLogger;

import static org.assertj.core.api.Assertions.assertThat;


class PowerLoggerTest {

@BeforeEach
void setUp() {
ThreadContext.clearAll();
}

@Test
void shouldSetCustomKeyOnThreadContext() {
PowerLogger.customKey("test", "value");

assertThat(ThreadContext.getImmutableContext())
.hasSize(1)
.containsEntry("test", "value");
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestHandler;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import java.io.InputStream;
import java.io.OutputStream;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestHandler;
import software.aws.lambda.logging.PowerToolsLogging;

public class PowerLogToolEnabled implements RequestHandler<Object, Object> {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import java.io.InputStream;
import java.io.OutputStream;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
import software.aws.lambda.logging.PowerToolsLogging;

public class PowerLogToolEnabledForStream implements RequestStreamHandler {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestHandler;
import software.aws.lambda.logging.PowerToolsLogging;

public class PowerToolLogEventEnabled implements RequestHandler<Object, Object> {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package software.aws.lambda.logging;
package software.aws.lambda.logging.internal;

import java.io.IOException;
import java.io.InputStream;
Expand All @@ -8,6 +8,7 @@
import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
import com.fasterxml.jackson.databind.ObjectMapper;
import software.aws.lambda.logging.PowerToolsLogging;

public class PowerToolLogEventEnabledForStream implements RequestStreamHandler {

Expand Down