Serialized Form (Zipkin 2.6.0 API)

Package zipkin
- Class zipkin.Annotation extends Object implements Serializable
  
  serialVersionUID:
  
  0L
  - Serialized Fields
    - timestamp
```
long timestamp
```
      Microseconds from epoch.
      This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or multiplying System.currentTimeMillis() by 1000.
    - value
```
String value
```
      Usually a short tag indicating an event, like "sr". or "error"
    - endpoint
```
Endpoint endpoint
```
      The host that recorded Annotation.value, primarily for query by service name.
- Class zipkin.DependencyLink extends Object implements Serializable
  
  serialVersionUID:
  
  0L
  - Serialization Methods
    - writeReplace
```
final Object writeReplace()
                   throws ObjectStreamException
```
      Throws:
      
      ObjectStreamException
  - Serialized Fields
    - parent
```
String parent
```
      parent service name (caller)
    - child
```
String child
```
      child service name (callee)
    - callCount
```
long callCount
```
      total traced calls made from DependencyLink.parent to DependencyLink.child
    - errorCount
```
long errorCount
```
      How many calls are known to be errors
- Class zipkin.Endpoint extends Object implements Serializable
  
  serialVersionUID:
  
  0L
  - Serialized Fields
    - serviceName
```
String serviceName
```
      Classifier of a source or destination in lowercase, such as "zipkin-server".
      This is the primary parameter for trace lookup, so should be intuitive as possible, for example, matching names in service discovery.
      Conventionally, when the service name isn't known, service_name = "unknown". However, it is also permissible to set service_name = "" (empty string). The difference in the latter usage is that the span will not be queryable by service name unless more information is added to the span with non-empty service name, e.g. an additional annotation from the server.
      Particularly clients may not have a reliable service name at ingest. One approach is to set service_name to "" at ingest, and later assign a better label based on binary annotations, such as user agent.
    - ipv4
```
int ipv4
```
      IPv4 endpoint address packed into 4 bytes or zero if unknown.
      Ex for the IP 1.2.3.4, it would be (1 << 24) | (2 << 16) | (3 << 8) | 4
      
      See Also:
      
      Inet4Address.getAddress()
    - ipv6
```
byte[] ipv6
```
      IPv6 endpoint address packed into 16 bytes or null if unknown.
      
      Since:
      
      Zipkin 1.4
      
      See Also:
      
      Inet6Address.getAddress()
    - port
```
Short port
```
      Port of the IP's socket or null, if not known.
      Note: this is to be treated as an unsigned integer, so watch for negatives.
      Ex.
      Integer unsignedPort = endpoint.port == null ? null : endpoint.port & 0xffff;
      See Also:
      
      InetSocketAddress.getPort()
- Class zipkin.Span extends Object implements Serializable
  
  serialVersionUID:
  
  0L
  - Serialization Methods
    - writeReplace
```
final Object writeReplace()
                   throws ObjectStreamException
```
      Throws:
      
      ObjectStreamException
  - Serialized Fields
    - traceIdHigh
```
long traceIdHigh
```
      When non-zero, the trace containing this span uses 128-bit trace identifiers.
      traceIdHigh corresponds to the high bits in big-endian format and Span.traceId corresponds to the low bits.
      Ex. to convert the two fields to a 128bit opaque id array, you'd use code like below.
      ByteBuffer traceId128 = ByteBuffer.allocate(16); traceId128.putLong(span.traceIdHigh); traceId128.putLong(span.traceId); traceBytes = traceId128.array();
      See Also:
      
      StorageComponent.Builder#strictTraceId(boolean)
    - traceId
```
long traceId
```
      Unique 8-byte identifier for a trace, set on all spans within it.
      
      See Also:
      
      for notes about 128-bit trace identifiers
    - name
```
String name
```
      Span name in lowercase, rpc method for example.
      Conventionally, when the span name isn't known, name = "unknown".
    - id
```
long id
```
      Unique 8-byte identifier of this span within a trace.
      A span is uniquely identified in storage by (Span.traceId, #id).
    - parentId
```
Long parentId
```
      The parent's Span.id or null if this the root span in a trace.
    - timestamp
```
Long timestamp
```
      Epoch microseconds of the start of this span, possibly absent if this an incomplete span.
      This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or multiplying System.currentTimeMillis() by 1000.
      For compatibility with instrumentation that precede this field, collectors or span stores can derive this via Annotation.timestamp. For example, Constants.SERVER_RECV.timestamp or Constants.CLIENT_SEND.timestamp.
      Timestamp is nullable for input only. Spans without a timestamp cannot be presented in a timeline: Span stores should not output spans missing a timestamp.
      There are two known edge-cases where this could be absent: both cases exist when a collector receives a span in parts and a binary annotation precedes a timestamp. This is possible when..
      
      The span is in-flight (ex not yet received a timestamp)
      
      The span's start event was lost
    - duration
```
Long duration
```
      Measurement in microseconds of the critical path, if known. Durations of less than one microsecond must be rounded up to 1 microsecond.
      This value should be set directly, as opposed to implicitly via annotation timestamps. Doing so encourages precision decoupled from problems of clocks, such as skew or NTP updates causing time to move backwards.
      For compatibility with instrumentation that precede this field, collectors or span stores can derive this by subtracting Annotation.timestamp. For example, Constants.SERVER_SEND.timestamp - Constants.SERVER_RECV.timestamp.
      If this field is persisted as unset, zipkin will continue to work, except duration query support will be implementation-specific. Similarly, setting this field non-atomically is implementation-specific.
      This field is i64 vs i32 to support spans longer than 35 minutes.
    - annotations
```
List<E> annotations
```
      Associates events that explain latency with a timestamp.
      Unlike log statements, annotations are often codes: for example Constants.SERVER_RECV. Annotations are sorted ascending by timestamp.
    - binaryAnnotations
```
List<E> binaryAnnotations
```
      Tags a span with context, usually to support query or aggregation.
      example, a binary annotation key could be "http.path".
    - debug
```
Boolean debug
```
      True is a request to store this span even if it overrides sampling policy.

Serialized Form

Package zipkin

Class zipkin.Annotation extends Object implements Serializable

Serialized Fields

timestamp

value

endpoint

Class zipkin.DependencyLink extends Object implements Serializable

Serialization Methods

writeReplace

Serialized Fields

parent

child

callCount

errorCount

Class zipkin.Endpoint extends Object implements Serializable

Serialized Fields

serviceName

ipv4

ipv6

port

Class zipkin.Span extends Object implements Serializable

Serialization Methods

writeReplace

Serialized Fields

traceIdHigh

traceId

name

id

parentId

timestamp

duration

annotations

binaryAnnotations

debug