Packages

c

com.twitter.finatra.http.filters

AccessLoggingFilter

class AccessLoggingFilter[R <: Request] extends SimpleFilter[R, Response]

Provides a standard "Access Log" -- a list of all requests through this Filter. Typically, this Filter is provided by the com.twitter.finatra.http.modules.AccessLogModule which provides an implementation for the com.twitter.finagle.filter.LogFormatter param as an instance of com.twitter.finagle.http.filter.CommonLogFormatter.

Usage

To use, configure a logger (with your preferred logging implementation) over this class which writes to a specific file (typically named, access.log).

R

- "Request" type param which must be a subtype of com.twitter.finagle.http.Request.

Annotations
@Singleton()
Note

This Filter should occur as early in the Filter chain as possible such that it is "above" the com.twitter.finatra.http.filters.ExceptionMappingFilter as it is expected that servicing requests with this Filter will always return a com.twitter.finagle.http.Response.

,

This Filter is included in the Finatra com.twitter.finatra.http.filters.CommonFilters.

See also

Common Log Format

com.twitter.finatra.http.filters.CommonFilters

com.twitter.finatra.http.filters.ExceptionMappingFilter

com.twitter.finatra.http.modules.AccessLogModule

com.twitter.finagle.filter.LogFormatter

com.twitter.finagle.http.filter.CommonLogFormatter

Linear Supertypes
SimpleFilter[R, Response], Filter[R, Response, R, Response], (R, Service[R, Response]) => Future[Response], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AccessLoggingFilter
  2. SimpleFilter
  3. Filter
  4. Function2
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AccessLoggingFilter(formatter: LogFormatter[R, Response])

    formatter

    an instance of com.twitter.finagle.filter.LogFormatter which specifies how log lines should be formatted.

    Annotations
    @Inject()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def agnosticAndThen(next: TypeAgnostic): Filter[R, Response, R, Response]
    Definition Classes
    Filter
  5. def andThen(factory: ServiceFactory[R, Response]): ServiceFactory[R, Response]
    Definition Classes
    Filter
  6. def andThen(service: Service[R, Response]): Service[R, Response]
    Definition Classes
    Filter
  7. def andThen[Req2, Rep2](next: Filter[R, Response, Req2, Rep2]): Filter[R, Response, Req2, Rep2]
    Definition Classes
    Filter
  8. def andThenIf[Req2 >: R, Rep2 <: Response](condAndFilter: (Boolean, Filter[R, Response, Req2, Rep2])): Filter[R, Response, Req2, Rep2]
    Definition Classes
    Filter
  9. def andThenIf[Req2 >: R, Rep2 <: Response](conditional: Boolean, filter: Filter[R, Response, Req2, Rep2]): Filter[R, Response, Req2, Rep2]
    Definition Classes
    Filter
  10. def apply(request: R, service: Service[R, Response]): Future[Response]
    Definition Classes
    AccessLoggingFilter → Filter → Function2
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def curried: (R) => (Service[R, Response]) => Future[Response]
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    Filter → Function2 → AnyRef → Any
  25. def tupled: ((R, Service[R, Response])) => Future[Response]
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from SimpleFilter[R, Response]

Inherited from Filter[R, Response, R, Response]

Inherited from (R, Service[R, Response]) => Future[Response]

Inherited from AnyRef

Inherited from Any

Ungrouped