org.htrace.zipkin.HTraceToZipkinConverter Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.htrace.zipkin;
import com.twitter.zipkin.gen.Annotation;
import com.twitter.zipkin.gen.AnnotationType;
import com.twitter.zipkin.gen.BinaryAnnotation;
import com.twitter.zipkin.gen.Endpoint;
import com.twitter.zipkin.gen.Span;
import com.twitter.zipkin.gen.zipkinCoreConstants;
import org.htrace.TimelineAnnotation;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* This class is responsible for converting a HTrace.Span to a Zipkin.Span object. To use the Zipkin
* infrastructure (collector, front end), we need to store the Span information in a zipkin specific
* format. This class transforms a HTrace:Span object to a Zipkin:Span object.
*
* This is how both Span objects are related:
*
*
* HTrace:Span
* Zipkin:Span
*
*
*
* TraceId
* TraceId
*
*
* ParentId
* ParentId
*
*
* SpanId
* id
*
*
* Description
* Name
*
*
* startTime, stopTime
* Annotations (cs, cr, sr, ss)
*
*
* Other annotations
* Annotations
*
*
*
*
*/
public class HTraceToZipkinConverter {
private final int ipv4Address;
private final short port;
private static final Map DEFAULT_PORTS = new HashMap();
static {
DEFAULT_PORTS.put("hmaster", 60000);
DEFAULT_PORTS.put("hregionserver", 60020);
DEFAULT_PORTS.put("namenode", 8020);
DEFAULT_PORTS.put("datanode", 50010);
}
public HTraceToZipkinConverter(int ipv4Address, short port) {
this.ipv4Address = ipv4Address;
this.port = port;
}
/**
* Converts a given HTrace span to a Zipkin Span.
*
* - First set the start annotation. [CS, SR], depending whether it is a client service or not.
*
- Set other id's, etc [TraceId's etc]
*
- Create binary annotations based on data from HTrace Span object.
*
- Set the last annotation. [SS, CR]
*
*/
public Span convert(org.htrace.Span hTraceSpan) {
Span zipkinSpan = new Span();
String serviceName = hTraceSpan.getProcessId().toLowerCase();
Endpoint ep = new Endpoint(ipv4Address, (short) getPort(serviceName), serviceName);
List annotationList = createZipkinAnnotations(hTraceSpan, ep);
List binaryAnnotationList = createZipkinBinaryAnnotations(hTraceSpan, ep);
zipkinSpan.setTrace_id(hTraceSpan.getTraceId());
if (hTraceSpan.getParentId() != org.htrace.Span.ROOT_SPAN_ID) {
zipkinSpan.setParent_id(hTraceSpan.getParentId());
}
zipkinSpan.setId(hTraceSpan.getSpanId());
zipkinSpan.setName(hTraceSpan.getDescription());
zipkinSpan.setAnnotations(annotationList);
zipkinSpan.setBinary_annotations(binaryAnnotationList);
return zipkinSpan;
}
/**
* Add annotations from the htrace Span.
*/
private List createZipkinAnnotations(org.htrace.Span hTraceSpan,
Endpoint ep) {
List annotationList = new ArrayList();
// add first zipkin annotation.
annotationList.add(createZipkinAnnotation(zipkinCoreConstants.CLIENT_SEND, hTraceSpan.getStartTimeMillis(), ep, true));
annotationList.add(createZipkinAnnotation(zipkinCoreConstants.SERVER_RECV, hTraceSpan.getStartTimeMillis(), ep, true));
// add HTrace time annotation
for (TimelineAnnotation ta : hTraceSpan.getTimelineAnnotations()) {
annotationList.add(createZipkinAnnotation(ta.getMessage(), ta.getTime(), ep, true));
}
// add last zipkin annotation
annotationList.add(createZipkinAnnotation(zipkinCoreConstants.SERVER_SEND, hTraceSpan.getStopTimeMillis(), ep, false));
annotationList.add(createZipkinAnnotation(zipkinCoreConstants.CLIENT_RECV, hTraceSpan.getStopTimeMillis(), ep, false));
return annotationList;
}
/**
* Creates a list of Annotations that are present in HTrace Span object.
*
* @return list of Annotations that could be added to Zipkin Span.
*/
private List createZipkinBinaryAnnotations(org.htrace.Span span,
Endpoint ep) {
List l = new ArrayList();
for (Map.Entry e : span.getKVAnnotations().entrySet()) {
BinaryAnnotation binaryAnn = new BinaryAnnotation();
binaryAnn.setAnnotation_type(AnnotationType.BYTES);
binaryAnn.setKey(new String(e.getKey()));
binaryAnn.setValue(e.getValue());
binaryAnn.setHost(ep);
l.add(binaryAnn);
}
return l;
}
/**
* Create an annotation with the correct times and endpoint.
*
* @param value Annotation value
* @param time timestamp will be extracted
* @param ep the endopint this annotation will be associated with.
* @param sendRequest use the first or last timestamp.
*/
private static Annotation createZipkinAnnotation(String value, long time,
Endpoint ep, boolean sendRequest) {
Annotation annotation = new Annotation();
annotation.setHost(ep);
// Zipkin is in microseconds
if (sendRequest) {
annotation.setTimestamp(time * 1000);
} else {
annotation.setTimestamp(time * 1000);
}
annotation.setDuration(1);
annotation.setValue(value);
return annotation;
}
private int getPort(String serviceName) {
if (port != -1) {
return port;
}
Integer p = DEFAULT_PORTS.get(serviceName);
if (p != null) {
return p;
}
return 80;
}
}