zipkin

Class Endpoint

java.lang.Object

zipkin.Endpoint

public final class Endpoint
extends Object

Indicates the network context of a service recording an annotation with two exceptions.

When a BinaryAnnotation, and key is Constants.CLIENT_ADDR or Constants.SERVER_ADDR, the endpoint indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Endpoint.Builder

Field Summary

Fields

Modifier and Type	Field and Description
int	ipv4 IPv4 endpoint address packed into 4 bytes or zero if unknown.
byte[]	ipv6 IPv6 endpoint address packed into 16 bytes or null if unknown.
Short	port Port of the IP's socket or null, if not known.
String	serviceName Classifier of a source or destination in lowercase, such as "zipkin-server".

Method Summary

Modifier and Type	Method and Description
static Endpoint.Builder	builder()
static Endpoint	create(String serviceName, int ipv4)
static Endpoint	create(String serviceName, int ipv4, int port)
boolean	equals(Object o)
int	hashCode()
Endpoint.Builder	toBuilder()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serviceName

public final 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

public final 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

@Nullable
public final byte[] ipv6

IPv6 endpoint address packed into 16 bytes or null if unknown.

Since:

Zipkin 1.4

See Also:

Inet6Address.getAddress()

port

@Nullable
public final 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.

See Also:

InetSocketAddress.getPort()

Method Detail

create

public static Endpoint create(String serviceName,
                              int ipv4,
                              int port)

create

public static Endpoint create(String serviceName,
                              int ipv4)

toBuilder

public Endpoint.Builder toBuilder()

builder

public static Endpoint.Builder builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object