Serialized Form

  • Package zipkin2

  • Package zipkin2.proto3

    • Class zipkin2.proto3.Annotation extends com.squareup.wire.Message<Annotation,​Annotation.Builder> implements Serializable

      serialVersionUID:
      0L

      • Serialized Fields

        • timestamp
          Long timestamp
          Epoch microseconds of this event. For example, 1502787600000000 corresponds to 2017-08-15 09:00 UTC This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or multiplying epoch millis by 1000.
        • value
          String value
          Usually a short tag indicating an event, like "error" While possible to add larger data, such as garbage collection details, low cardinality event names both keep the size of spans down and also are easy to search against.

    • Class zipkin2.proto3.Endpoint extends com.squareup.wire.Message<Endpoint,​Endpoint.Builder> implements Serializable

      serialVersionUID:
      0L

      • Serialized Fields

        • ipv4
          okio.ByteString ipv4
          4 byte representation of the primary IPv4 address associated with this connection. Absent if unknown.
        • ipv6
          okio.ByteString ipv6
          16 byte representation of the primary IPv6 address associated with this connection. Absent if unknown. Prefer using the ipv4 field for mapped addresses.
        • port
          Integer port
          Depending on context, this could be a listen port or the client-side of a socket. Absent if unknown.
        • service_name
          String service_name
          Lower-case label of this node in the service graph, such as "favstar". Leave absent if unknown. This is a primary label for trace lookup and aggregation, so it should be intuitive and consistent. Many use a name from service discovery.

    • Class zipkin2.proto3.ListOfSpans extends com.squareup.wire.Message<ListOfSpans,​ListOfSpans.Builder> implements Serializable

      serialVersionUID:
      0L

      • Serialized Fields

    • Class zipkin2.proto3.ReportResponse extends com.squareup.wire.Message<ReportResponse,​ReportResponse.Builder> implements Serializable

      serialVersionUID:
      0L

    • Class zipkin2.proto3.Span extends com.squareup.wire.Message<Span,​Span.Builder> implements Serializable

      serialVersionUID:
      0L

      • Serialized Fields

        • annotations
          List<Annotation> annotations
          Associates events that explain latency with the time they happened.
        • debug
          Boolean debug
          True is a request to store this span even if it overrides sampling policy. This is true when the "X-B3-Flags" header has a value of 1.
        • duration
          Long duration
          Duration in microseconds of the critical path, if known. Durations of less than one are rounded up. Duration of children can be longer than their parents due to asynchronous operations. For example 150 milliseconds is 150000 microseconds.
        • id
          okio.ByteString id
          Unique identifier for this operation within the trace. This field is required and encoded as 8 opaque bytes.
        • kind
          Span.Kind kind
          When present, used to interpret remote_endpoint
        • local_endpoint
          Endpoint local_endpoint
          The host that recorded this span, primarily for query by service name. Instrumentation should always record this. Usually, absent implies late data. The IP address corresponding to this is usually the site local or advertised service address. When present, the port indicates the listen port.
        • name
          String name
          The logical operation this span represents in lowercase (e.g. rpc method). Leave absent if unknown. As these are lookup labels, take care to ensure names are low cardinality. For example, do not embed variables into the name.
        • parent_id
          okio.ByteString parent_id
          The parent span ID or absent if this the root span in a trace.
        • remote_endpoint
          Endpoint remote_endpoint
          When an RPC (or messaging) span, indicates the other side of the connection. By recording the remote endpoint, your trace will contain network context even if the peer is not tracing. For example, you can record the IP from the "X-Forwarded-For" header or the service name and socket of a remote peer.
        • shared
          Boolean shared
          True if we are contributing to a span started by another tracer (ex on a different host).
        • tags
          Map<String,​String> tags
          Tags give your span context for search, viewing and analysis. For example, a key "your_app.version" would let you lookup traces by version. A tag "sql.query" isn't searchable, but it can help in debugging when viewing a trace.
        • timestamp
          Long timestamp
          Epoch microseconds of the start of this span, possibly absent if incomplete. For example, 1502787600000000 corresponds to 2017-08-15 09:00 UTC This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or multiplying epoch millis by 1000. There are three known edge-cases where this could be reported absent. - A span was allocated but never started (ex not yet received a timestamp) - The span's start event was lost - Data about a completed span (ex tags) were sent after the fact
        • trace_id
          okio.ByteString trace_id
          Randomly generated, unique identifier for a trace, set on all spans within it. This field is required and encoded as 8 or 16 bytes, in big endian byte order.