object EventFilter
Facilities for selectively filtering out expected events from logging so that you can keep your test run’s console output clean and do not miss real error messages.
Also have a look at the akka.testkit
package object’s filterEvents
and
filterException
methods.
The source filters do accept Class[_]
arguments, matching any
object which is an instance of the given class, e.g.
EventFilter.info(source = classOf[MyActor]) // will match Info events from any MyActor instance
The message object will be converted to a string before matching ("null"
if it is null
).
- Source
- TestEventListener.scala
- Alphabetic
- By Inheritance
- EventFilter
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
apply[A <: Throwable](message: String = null, source: String = null, start: String = "", pattern: String = null, occurrences: Int = Int.MaxValue)(implicit arg0: ClassTag[A]): EventFilter
Create a filter for Error events.
Create a filter for Error events. Give up to one of
start
andpattern
:EventFilter[MyException]() // filter only on exception type EventFilter[MyException]("message") // filter on exactly matching message EventFilter[MyException](source = obj) // filter on event source EventFilter[MyException](start = "Expected") // filter on start of message EventFilter[MyException](source = obj, pattern = "weird.*message") // filter on pattern and message
Please note that filtering on the
source
beingnull
does NOT work (passingnull
disables the source filter). -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
custom(test: PartialFunction[LogEvent, Boolean], occurrences: Int = Int.MaxValue): EventFilter
Create a custom event filter.
Create a custom event filter. The filter will affect those events for which the supplied partial function is defined and returns
true
.EventFilter.custom { case Warning(ref, "my warning") if ref == actor || ref == null => true }
-
def
debug(message: String = null, source: String = null, start: String = "", pattern: String = null, occurrences: Int = Int.MaxValue): EventFilter
Create a filter for Debug events.
Create a filter for Debug events. Give up to one of
start
andpattern
:EventFilter.debug() // filter only on debug type EventFilter.debug(source = obj) // filter on event source EventFilter.debug(start = "Expected") // filter on start of message EventFilter.debug(source = obj, pattern = "weird.*message") // filter on pattern and message
Please note that filtering on the
source
beingnull
does NOT work (passingnull
disables the source filter). -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
error(message: String = null, source: String = null, start: String = "", pattern: String = null, occurrences: Int = Int.MaxValue): EventFilter
Create a filter for Error events.
Create a filter for Error events. See apply() for more details.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
info(message: String = null, source: String = null, start: String = "", pattern: String = null, occurrences: Int = Int.MaxValue): EventFilter
Create a filter for Info events.
Create a filter for Info events. Give up to one of
start
andpattern
:EventFilter.info() // filter only on info event EventFilter.info(source = obj) // filter on event source EventFilter.info(start = "Expected") // filter on start of message EventFilter.info(source = obj, pattern = "weird.*message") // filter on pattern and message
Please note that filtering on the
source
beingnull
does NOT work (passingnull
disables the source filter). -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
warning(message: String = null, source: String = null, start: String = "", pattern: String = null, occurrences: Int = Int.MaxValue): EventFilter
Create a filter for Warning events.
Create a filter for Warning events. Give up to one of
start
andpattern
:EventFilter.warning() // filter only on warning event EventFilter.warning(source = obj) // filter on event source EventFilter.warning(start = "Expected") // filter on start of message EventFilter.warning(source = obj, pattern = "weird.*message") // filter on pattern and message
Please note that filtering on the
source
beingnull
does NOT work (passingnull
disables the source filter).