Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

    Definition Classes
    com
  • package finagle

    Finagle is an extensible RPC system.

    Finagle is an extensible RPC system.

    Services are represented by class com.twitter.finagle.Service. Clients make use of com.twitter.finagle.Service objects while servers implement them.

    Finagle contains a number of protocol implementations; each of these implement Client and/or com.twitter.finagle.Server. For example, Finagle's HTTP implementation, com.twitter.finagle.Http (in package finagle-http), exposes both.

    Thus a simple HTTP server is built like this:

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Await, Future}
    
    val service = new Service[Request, Response] {
      def apply(req: Request): Future[Response] =
        Future.value(Response())
    }
    val server = Http.server.serve(":8080", service)
    Await.ready(server)

    We first define a service to which requests are dispatched. In this case, the service returns immediately with a HTTP 200 OK response, and with no content.

    This service is then served via the Http protocol on TCP port 8080. Finally we wait for the server to stop serving.

    We can now query our web server:

    % curl -D - localhost:8080
    HTTP/1.1 200 OK

    Building an HTTP client is also simple. (Note that type annotations are added for illustration.)

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Future, Return, Throw}
    
    val client: Service[Request, Response] = Http.client.newService("localhost:8080")
    val f: Future[Response] = client(Request()).respond {
      case Return(rep) =>
        printf("Got HTTP response %s\n", rep)
      case Throw(exc) =>
        printf("Got error %s\n", exc)
    }

    Http.client.newService("localhost:8080") constructs a new com.twitter.finagle.Service instance connected to localhost TCP port 8080. We then issue a HTTP/1.1 GET request to URI "/". The service returns a com.twitter.util.Future representing the result of the operation. We listen to this future, printing an appropriate message when the response arrives.

    The Finagle homepage contains useful documentation and resources for using Finagle.

    Definition Classes
    twitter
  • package zipkin
    Definition Classes
    finagle
  • package core
    Definition Classes
    zipkin
  • BinaryAnnotation
  • Endpoint
  • RawZipkinTracer
  • Sampler
  • SamplingTracer
  • Span
  • ZipkinAnnotation
c

com.twitter.finagle.zipkin.core

RawZipkinTracer

abstract class RawZipkinTracer extends Tracer

Receives the Finagle generated traces and sends them off to Zipkin

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RawZipkinTracer
  2. Tracer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RawZipkinTracer(statsReceiver: StatsReceiver, timer: Timer = DefaultTimer)

    statsReceiver

    We generate stats to keep track of traces sent, failures and so on

    timer

    A Timer used for timing out spans in the DeadlineSpanMap

Abstract Value Members

  1. abstract def sendSpans(spans: Seq[Span]): Future[Unit]

Concrete 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 annotate(record: Record, value: String): Unit

    Add this record as a time based annotation.

    Add this record as a time based annotation.

    Attributes
    protected
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def binaryAnnotation(record: Record, key: String, value: ByteBuffer, annotationType: AnnotationType): Unit
    Attributes
    protected
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def flush(): Future[Unit]
    Attributes
    protected[com.twitter.finagle.zipkin.core]
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def isActivelyTracing(traceId: TraceId): Boolean

    Is this tracer actively tracing this traceId?

    Is this tracer actively tracing this traceId?

    Return: If TraceId.sampled == None sampleTrace() has not been called yet or the tracer still wants to receive traces but not make the decision for child services. In either case return true so that this tracer is still considered active for this traceId.

    If TraceId.sampled == Some(decision) sampleTrace() has already been called, or a previous service has already made a decision whether to sample this trace or not. So respect that decision and return it.

    Definition Classes
    RawZipkinTracerTracer
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def isNull: Boolean

    Indicates whether or not this tracer instance is NullTracer.

    Indicates whether or not this tracer instance is NullTracer.

    Definition Classes
    Tracer
  17. def mutate(traceId: TraceId)(f: (MutableSpan) ⇒ Unit): Unit

    Mutate the Span with whatever new info we have.

    Mutate the Span with whatever new info we have. If we see an "end" annotation we remove the span and send it off.

    Attributes
    protected
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def record(record: Record): Unit
    Definition Classes
    RawZipkinTracerTracer
  22. def sampleTrace(traceId: TraceId): Option[Boolean]

    Always sample the request.

    Always sample the request.

    Definition Classes
    RawZipkinTracerTracer
  23. def setEndpoint(record: Record, ia: InetSocketAddress): Unit

    Sets the endpoint in the span for any future annotations.

    Sets the endpoint in the span for any future annotations. Also sets the endpoint in any previous annotations that lack one.

    Attributes
    protected
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Tracer

Inherited from AnyRef

Inherited from Any

Ungrouped