akka.actor.ActorLogMarker.scala Maven / Gradle / Ivy

/*
 * Copyright (C) 2019-2020 Lightbend Inc. 
 */

package akka.actor

import akka.annotation.ApiMayChange
import akka.event.LogMarker

/**
 * This is public with the purpose to document the used markers and properties of log events.
 * No guarantee that it will remain binary compatible, but the marker names and properties
 * are considered public API and will not be changed without notice.
 */
@ApiMayChange
object ActorLogMarker {

  /**
   * Marker "akkaDeadLetter" of log event for dead letter messages.
   *
   * @param messageClass The message class of the DeadLetter. Included as property "akkaMessageClass".
   */
  def deadLetter(messageClass: String): LogMarker =
    LogMarker("akkaDeadLetter", Map(LogMarker.Properties.MessageClass -> messageClass))

}