Packages

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

    Start with com.twitter.finagle.

    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
  • DefaultSampler
  • Endpoint
  • RawZipkinTracer
  • Sampler
  • SamplingTracer
  • Span
  • ZipkinAnnotation

class SamplingTracer extends Tracer

Tracer that supports sampling. Will pass through a subset of the records.

Linear Supertypes
Tracer, AnyRef, Any
Known Subclasses
ScribeZipkinTracer, ZipkinTracer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SamplingTracer
  2. Tracer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SamplingTracer(underlyingTracer: Tracer, initialSampleRate: Float)
  2. new SamplingTracer(underlyingTracer: Tracer, sampler: Sampler)

    underlyingTracer

    Underlying tracer that accumulates the traces and sends off to the collector.

    sampler

    Sampler that decides whether to sample a trace

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def getSampleRate: Float

    What is the percentage of traces we're sampling? The sample rate is a float value between 0.0 and 1.0.

    What is the percentage of traces we're sampling? The sample rate is a float value between 0.0 and 1.0. If sampling is decided based on factors other than the sampleRate, this value should NaN

    Definition Classes
    SamplingTracer → Tracer
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. 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
    Tracer
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def isNull: Boolean

    Indicates whether or not this tracer instance is NullTracer.

    Indicates whether or not this tracer instance is NullTracer.

    Definition Classes
    Tracer
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def record(record: Record): Unit
    Definition Classes
    SamplingTracer → Tracer
  19. def sampleTrace(traceId: TraceId): Option[Boolean]

    Makes the sampling decision and records the sampling rate if we're tracing

    Makes the sampling decision and records the sampling rate if we're tracing

    Definition Classes
    SamplingTracer → Tracer
    Note

    sampleTrace should only be called when the tracing decision has not already been made

  20. def setSampleRate(sampleRate: Float): Unit
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Tracer

Inherited from AnyRef

Inherited from Any

Ungrouped