com.comcast.xfinity.sirius.util.Slf4jEventHandlerWithRemotingSilencer.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sirius_2.12 Show documentation

sirius

The newest version!

/*
 *  Copyright 2012-2014 Comcast Cable Communications Management, LLC
 *
 *  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.comcast.xfinity.sirius.util

import akka.event.Logging._
import akka.event.slf4j.Slf4jLogger

/**
 * Akka Logging event handler for suppressing unnecessarily noisy
 * Remoting errors.
 *
 * Suppresses all Error and Warn level messages that start with
 * "REMOTE: RemoteClient" or "REMOTE: RemoteServer".  Turns out this
 * is a pretty good qualifier.
 *
 * If you want to see remoting errors, register an event handler for
 * them to be handled explicitly.
 *
 * The need for this rises from akka.remote.RemoteTransport line 194,
 * where these errors are logged.
 *
 * Credit to
 * https://groups.google.com/forum/?fromgroups=#!topic/akka-user/hLGkCjnGQZc
 * for pointing out that this had to be done this way
 *
 */
class Slf4jEventHandlerWithRemotingSilencer extends Slf4jLogger {

  override def receive = {
    case Error(_, _, _, msg) if messageIsStupid(msg) => // no-op
    case Warning(_, _, msg) if messageIsStupid(msg) => // no-op
    case other =>
      passThru(other)
  }

  private def messageIsStupid(msg: Any): Boolean = msg match {
    case msgString: String =>
      msgString.startsWith("REMOTE: RemoteClient") || msgString.startsWith("REMOTE: RemoteServer")
    case _ => false
  }

  private[util] def passThru(event: Any) {
    super.receive(event)
  }
}