twitter/finagle

Add com.twitter.finagle.zipkin.core.Endpoint.ipv6

Open

#526 opened on Jul 13, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Scala (8,864 stars) (1,435 forks)batch import
good first issue

Description

We currently support logging of only IPv4 addresses. Starting with Zipkin 1.4, endpoints can omit IPv4 (by setting Endpoint.ipv4 to 0), and optionally log Endpoint.ipv6 as the raw 16byte address. https://github.com/openzipkin/zipkin-api/blob/master/thrift/zipkinCore.thrift#L276

It looks like the most pivotal change is updating com.twitter.finagle.zipkin.core.Endpoint.ipv6

cc @sveinnfannar

Contributor guide

Tech stack
scala
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scala knowledgeFamiliarity with ThriftUnderstanding of Zipkin endpoint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue is to add IPv6 support to the Endpoint class in Finagle's Zipkin integration. The key change is in the com.twitter.finagle.zipkin.core.Endpoint class, which currently only supports IPv4. The Zipkin API specification (https://github.com/openzipkin/zipkin api/blob/master/thrift/zipkinCore.thrift#L276) shows that endpoints can now optionally include an ipv6 field as a 16 byte address. To implement this, you'll need to modify the Endpoint Scala class to add an ipv6 field, update its serialization/deserialization to handle the new field, and ensure backwards compatibility with IPv4 only endpoints. The issue also mentions a contributor (@sveinnfannar) who may have further context. Review the existing codebase to understand the current Endpoint implementation and the Thrift binding, then add the ipv6 support accordingly.