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

case class Span(traceId: TraceId, _serviceName: Option[String], _name: Option[String], annotations: Seq[ZipkinAnnotation], bAnnotations: Seq[BinaryAnnotation], endpoint: Endpoint) extends Product with Serializable

The span itself is an immutable datastructure. Mutations are done through copying & updating span references elsewhere.

traceId

Contains the Trace id (same for whole trace), Span id (same for just one rpc call) and parent id (links to the parent span in this trace, if None this is the root span)

_serviceName

The name of the service handling the RPC

_name

The name of the RPC method

annotations

A sequence of annotations made in this span

bAnnotations

Key-Value annotations, used to attach non timestamped data

endpoint

This is the local endpoint the span was created on.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Span
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Span(traceId: TraceId, _serviceName: Option[String], _name: Option[String], annotations: Seq[ZipkinAnnotation], bAnnotations: Seq[BinaryAnnotation], endpoint: Endpoint)

    traceId

    Contains the Trace id (same for whole trace), Span id (same for just one rpc call) and parent id (links to the parent span in this trace, if None this is the root span)

    _serviceName

    The name of the service handling the RPC

    _name

    The name of the RPC method

    annotations

    A sequence of annotations made in this span

    bAnnotations

    Key-Value annotations, used to attach non timestamped data

    endpoint

    This is the local endpoint the span was created on.

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. val _name: Option[String]
  5. val _serviceName: Option[String]
  6. val annotations: Seq[ZipkinAnnotation]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val bAnnotations: Seq[BinaryAnnotation]
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. val endpoint: Endpoint
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def idString: String

    returns

    a pretty string for this span ID.

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val name: String
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val serviceName: String
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toThrift: thrift.thrift.Span
  23. val traceId: TraceId
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped