Dead letter logging improvements (#531)

* add serialization for actorrefs

* handle timer messages

* update jvm version in docker container

Author: BrandonArp

src/main/docker/mad/Dockerfile

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM eclipse-temurin:17-jre
+FROM eclipse-temurin:21-jre
 
 MAINTAINER arpnetworking
 

src/main/java/com/arpnetworking/configuration/jackson/module/pekko/ActorRefDeserializer.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2015 Groupon.com
+ *
+ * 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 com.arpnetworking.configuration.jackson.module.pekko;
+
+import com.arpnetworking.logback.annotations.LogValue;
+import com.arpnetworking.steno.LogValueMapFactory;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import org.apache.pekko.actor.ActorRef;
+import org.apache.pekko.actor.ActorSystem;
+
+import java.io.IOException;
+
+/**
+ * Deserializer for an Pekko ActorRef.
+ *
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public final class ActorRefDeserializer extends JsonDeserializer<ActorRef> {
+    /**
+     * Public constructor.
+     *
+     * @param system actor system used to resolve references
+     */
+    public ActorRefDeserializer(final ActorSystem system) {
+        _system = system;
+    }
+
+    @Override
+    public ActorRef deserialize(final JsonParser p, final DeserializationContext ctxt) throws IOException {
+        return _system.provider().resolveActorRef(p.getValueAsString());
+    }
+
+    /**
+     * Generate a Steno log compatible representation.
+     *
+     * @return Steno log compatible representation.
+     */
+    @LogValue
+    public Object toLogValue() {
+        return LogValueMapFactory.builder(this)
+                .put("actorSystem", _system)
+                .build();
+    }
+
+    @Override
+    public String toString() {
+        return toLogValue().toString();
+    }
+
+    private final ActorSystem _system;
+}

src/main/java/com/arpnetworking/configuration/jackson/module/pekko/ActorRefLoggingSerializer.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2015 Groupon.com
+ *
+ * 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 com.arpnetworking.configuration.jackson.module.pekko;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import org.apache.pekko.actor.ActorRef;
+
+import java.io.IOException;
+
+/**
+ * Serializer for an Pekko ActorRef.
+ *
+ * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
+ */
+public final class ActorRefLoggingSerializer extends JsonSerializer<ActorRef> {
+
+    /**
+     * Public constructor.
+     */
+    public ActorRefLoggingSerializer() { }
+
+    @Override
+    public void serialize(
+            final ActorRef value,
+            final JsonGenerator gen,
+            final SerializerProvider serializers) throws IOException {
+        gen.writeString(value.toString());
+    }
+}

src/main/java/com/arpnetworking/configuration/jackson/module/pekko/ActorRefSerializer.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2015 Groupon.com
+ *
+ * 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 com.arpnetworking.configuration.jackson.module.pekko;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import org.apache.pekko.actor.ActorRef;
+import org.apache.pekko.serialization.Serialization;
+
+import java.io.IOException;
+
+/**
+ * Serializer for an Pekko ActorRef.
+ *
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public final class ActorRefSerializer extends JsonSerializer<ActorRef> {
+
+    @Override
+    public void serialize(
+            final ActorRef value,
+            final JsonGenerator gen,
+            final SerializerProvider serializers) throws IOException {
+        gen.writeString(Serialization.serializedActorPath(value));
+    }
+}

src/main/java/com/arpnetworking/configuration/jackson/module/pekko/PekkoLoggingModule.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2015 Groupon.com
+ *
+ * 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 com.arpnetworking.configuration.jackson.module.pekko;
+
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import org.apache.pekko.actor.ActorRef;
+import org.apache.pekko.actor.TimerSchedulerImpl;
+
+/**
+ * Jackson module for serializing Pekko objects for use in JSON/Jackson based
+ * logger serializers(e.g. logback-steno).
+ *
+ * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
+ */
+public final class PekkoLoggingModule extends SimpleModule {
+
+    /**
+     * Public constructor.
+     */
+    public PekkoLoggingModule() { }
+
+    @Override
+    public void setupModule(final SetupContext context) {
+        addSerializer(ActorRef.class, new ActorRefLoggingSerializer());
+        addSerializer(TimerSchedulerImpl.TimerMsg.class, new TimerMessageSerializer());
+        super.setupModule(context);
+    }
+
+    private static final long serialVersionUID = 6984539942087839964L;
+}

src/main/java/com/arpnetworking/configuration/jackson/module/pekko/PekkoModule.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2015 Groupon.com
+ *
+ * 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 com.arpnetworking.configuration.jackson.module.pekko;
+
+import com.arpnetworking.logback.annotations.LogValue;
+import com.arpnetworking.steno.LogValueMapFactory;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import org.apache.pekko.actor.ActorRef;
+import org.apache.pekko.actor.ActorSystem;
+
+import java.io.Serial;
+
+/**
+ * Jackson module for serializing and deserializing Pekko objects.
+ *
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public final class PekkoModule extends SimpleModule {
+
+    /**
+     * Public constructor.
+     *
+     * @param system the actor system to resolve references
+     */
+    public PekkoModule(final ActorSystem system) {
+        _system = system;
+    }
+
+    @Override
+    public void setupModule(final SetupContext context) {
+        addSerializer(ActorRef.class, new ActorRefSerializer());
+        addDeserializer(ActorRef.class, new ActorRefDeserializer(_system));
+        super.setupModule(context);
+    }
+
+    /**
+     * Generate a Steno log compatible representation.
+     *
+     * @return Steno log compatible representation.
+     */
+    @LogValue
+    public Object toLogValue() {
+        return LogValueMapFactory.builder(this)
+                .put("actorSystem", _system)
+                .build();
+    }
+
+    @Override
+    public String toString() {
+        return toLogValue().toString();
+    }
+
+    @SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
+    private final transient ActorSystem _system;
+
+    @Serial
+    private static final long serialVersionUID = 4294591813352245070L;
+}

src/main/java/com/arpnetworking/configuration/jackson/module/pekko/TimerMessageSerializer.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2025 Brandon Arp
+ *
+ * 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 com.arpnetworking.configuration.jackson.module.pekko;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import org.apache.pekko.actor.TimerSchedulerImpl;
+
+import java.io.IOException;
+
+/**
+ * Serializer for a Pekko timer message.
+ *
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public final class TimerMessageSerializer extends JsonSerializer<TimerSchedulerImpl.TimerMsg> {
+    @Override
+    public void serialize(
+            final TimerSchedulerImpl.TimerMsg timerMsg,
+            final JsonGenerator jsonGenerator,
+            final SerializerProvider serializerProvider)
+            throws IOException {
+        jsonGenerator.writeStartObject();
+        jsonGenerator.writeObjectField("type", timerMsg.getClass().getTypeName());
+        jsonGenerator.writeObjectField("key", timerMsg.key());
+        jsonGenerator.writeObjectField("generation", timerMsg.generation());
+        jsonGenerator.writeObjectField("owner", timerMsg.owner());
+        jsonGenerator.writeEndObject();
+    }
+}

src/main/java/com/arpnetworking/configuration/jackson/module/pekko/package-info.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019 Dropbox
+ *
+ * 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.
+ */
+
+@ParametersAreNonnullByDefault
+@ReturnValuesAreNonnullByDefault
+package com.arpnetworking.configuration.jackson.module.pekko;
+
+import com.arpnetworking.commons.javax.annotation.ReturnValuesAreNonnullByDefault;
+
+import javax.annotation.ParametersAreNonnullByDefault;

src/main/java/com/arpnetworking/metrics/mad/Main.java

@@ -17,11 +17,13 @@
 
 import ch.qos.logback.classic.LoggerContext;
 import com.arpnetworking.commons.builder.Builder;
+import com.arpnetworking.commons.jackson.databind.ImmutableObjectMapper;
 import com.arpnetworking.commons.jackson.databind.ObjectMapperFactory;
 import com.arpnetworking.configuration.jackson.DynamicConfiguration;
 import com.arpnetworking.configuration.jackson.HoconFileSource;
 import com.arpnetworking.configuration.jackson.JsonNodeFileSource;
 import com.arpnetworking.configuration.jackson.JsonNodeSource;
+import com.arpnetworking.configuration.jackson.module.pekko.PekkoLoggingModule;
 import com.arpnetworking.configuration.triggers.FileTrigger;
 import com.arpnetworking.http.Routes;
 import com.arpnetworking.http.SupplementalRoutes;
@@ -533,6 +535,12 @@ private static Builder<? extends JsonNodeSource> getFileSourceBuilder(final File
                 .setFile(configurationFile);
     }
 
+    private static ObjectMapper createMadObjectMapper() {
+        final ObjectMapper instance = ObjectMapperFactory.createInstance();
+        instance.registerModule(new PekkoLoggingModule());
+        return ImmutableObjectMapper.of(instance);
+    }
+
     private final AggregatorConfiguration _configuration;
 
     private volatile PipelinesLaunchable _pipelinesLaunchable;
@@ -543,7 +551,7 @@ private static Builder<? extends JsonNodeSource> getFileSourceBuilder(final File
 
     private static final Long INITIAL_DELAY_IN_MILLIS = 0L;
     private static final TimeUnit TIME_UNIT = TimeUnit.MILLISECONDS;
-    private static final ObjectMapper OBJECT_MAPPER = ObjectMapperFactory.getInstance();
+    private static final ObjectMapper OBJECT_MAPPER = createMadObjectMapper();
     private static final Logger LOGGER = LoggerFactory.getLogger(Main.class);
     private static final Duration SHUTDOWN_TIMEOUT = Duration.create(30, TimeUnit.SECONDS);
     private static final Semaphore SHUTDOWN_SEMAPHORE = new Semaphore(0);