| /* |
| * 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.apache.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.apache.commons.logging.Log; |
| import org.apache.commons.logging.LogFactory; |
| import org.apache.htrace.TimelineAnnotation; |
| |
| import java.io.UnsupportedEncodingException; |
| 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. |
| * <p/> |
| * This is how both Span objects are related: |
| * <table> |
| * <col width="50%"/> <col width="50%"/> <thead> |
| * <tr> |
| * <th>HTrace:Span</th> |
| * <th>Zipkin:Span</th> |
| * </tr> |
| * <thead> <tbody> |
| * <tr> |
| * <td>TraceId</td> |
| * <td>TraceId</td> |
| * </tr> |
| * <tr> |
| * <td>ParentId</td> |
| * <td>ParentId</td> |
| * </tr> |
| * <tr> |
| * <td>SpanId</td> |
| * <td>id</td> |
| * </tr> |
| * <tr> |
| * <td>Description</td> |
| * <td>Name</td> |
| * </tr> |
| * <tr> |
| * <td>startTime, stopTime</td> |
| * <td>Annotations (cs, cr, sr, ss)</td> |
| * </tr> |
| * <tr> |
| * <td>Other annotations</td> |
| * <td>Annotations</td> |
| * </tr> |
| * </tbody> |
| * </table> |
| * <p/> |
| */ |
| public class HTraceToZipkinConverter { |
| private static final Log LOG = LogFactory.getLog(HTraceToZipkinConverter.class); |
| |
| private final int ipv4Address; |
| private final short port; |
| |
| |
| private static final Map<String, Integer> DEFAULT_PORTS = new HashMap<String, Integer>(); |
| |
| 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. |
| * <ul> |
| * <li>First set the start annotation. [CS, SR], depending whether it is a client service or not. |
| * <li>Set other id's, etc [TraceId's etc] |
| * <li>Create binary annotations based on data from HTrace Span object. |
| * <li>Set the last annotation. [SS, CR] |
| * </ul> |
| */ |
| public Span convert(org.apache.htrace.Span hTraceSpan) { |
| Span zipkinSpan = new Span(); |
| String serviceName = hTraceSpan.getTracerId().toLowerCase(); |
| Endpoint ep = new Endpoint(ipv4Address, (short) getPort(serviceName), serviceName); |
| List<Annotation> annotationList = createZipkinAnnotations(hTraceSpan, ep); |
| List<BinaryAnnotation> binaryAnnotationList = createZipkinBinaryAnnotations(hTraceSpan, ep); |
| zipkinSpan.setTrace_id(hTraceSpan.getSpanId().getHigh()); |
| if (hTraceSpan.getParents().length > 0) { |
| if (hTraceSpan.getParents().length > 1) { |
| LOG.error("zipkin doesn't support spans with multiple parents. Omitting " + |
| "other parents for " + hTraceSpan); |
| } |
| zipkinSpan.setParent_id(hTraceSpan.getParents()[0].getLow()); |
| } |
| zipkinSpan.setId(hTraceSpan.getSpanId().getLow()); |
| zipkinSpan.setName(hTraceSpan.getDescription()); |
| zipkinSpan.setAnnotations(annotationList); |
| zipkinSpan.setBinary_annotations(binaryAnnotationList); |
| return zipkinSpan; |
| } |
| |
| /** |
| * Add annotations from the htrace Span. |
| */ |
| private List<Annotation> createZipkinAnnotations(org.apache.htrace.Span hTraceSpan, |
| Endpoint ep) { |
| List<Annotation> annotationList = new ArrayList<Annotation>(); |
| |
| // 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<BinaryAnnotation> createZipkinBinaryAnnotations(org.apache.htrace.Span span, |
| Endpoint ep) { |
| List<BinaryAnnotation> l = new ArrayList<BinaryAnnotation>(); |
| for (Map.Entry<String, String> e : span.getKVAnnotations().entrySet()) { |
| BinaryAnnotation binaryAnn = new BinaryAnnotation(); |
| binaryAnn.setAnnotation_type(AnnotationType.BYTES); |
| binaryAnn.setKey(e.getKey()); |
| try { |
| binaryAnn.setValue(e.getValue().getBytes("UTF-8")); |
| } catch (UnsupportedEncodingException ex) { |
| LOG.error("Error encoding string as UTF-8", ex); |
| } |
| 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; |
| } |
| } |