ramkrish86 commented on a change in pull request #1210: HBASE-23757.
[OpenTracing] Migrate from HTrace to OpenTracing (Java code)
URL: https://github.com/apache/hbase/pull/1210#discussion_r385635251
##########
File path:
hbase-common/src/main/java/org/apache/hadoop/hbase/trace/TraceUtil.java
##########
@@ -17,103 +17,169 @@
*/
package org.apache.hadoop.hbase.trace;
+import io.opentracing.Scope;
+import io.opentracing.SpanContext;
+import io.opentracing.mock.MockTracer;
+import io.opentracing.propagation.Format;
+import io.opentracing.propagation.TextMapExtractAdapter;
+import io.opentracing.propagation.TextMapInjectAdapter;
+import io.opentracing.Span;
+import io.opentracing.SpanContext;
+import io.opentracing.Tracer;
+import io.opentracing.propagation.Format;
+import io.opentracing.propagation.TextMapExtractAdapter;
+import io.opentracing.propagation.TextMapInjectAdapter;
+import io.opentracing.util.GlobalTracer;
+import org.apache.commons.codec.binary.Hex;
import org.apache.hadoop.conf.Configuration;
import org.apache.htrace.core.HTraceConfiguration;
import org.apache.htrace.core.Sampler;
-import org.apache.htrace.core.Span;
import org.apache.htrace.core.SpanReceiver;
import org.apache.htrace.core.TraceScope;
-import org.apache.htrace.core.Tracer;
+import io.jaegertracing.Configuration.SamplerConfiguration;
+
+import org.apache.hadoop.tracing.TraceUtils;
+import
org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;
import org.apache.yetus.audience.InterfaceAudience;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.util.HashMap;
+import java.util.Map;
/**
* This wrapper class provides functions for accessing htrace 4+ functionality
in a simplified way.
*/
@InterfaceAudience.Private
public final class TraceUtil {
- private static HTraceConfiguration conf;
- private static Tracer tracer;
+ static final Logger LOG = LoggerFactory.getLogger(TraceUtils.class);
+
+ private static io.jaegertracing.Configuration conf;
+ private static io.opentracing.Tracer tracer;
+
+ public static final String HBASE_OPENTRACING_TRACER =
"hbase.opentracing.tracer";
+ public static final String HBASE_OPENTRACING_TRACER_DEFAULT = "jaeger";
+ public static final String HBASE_OPENTRACING_MOCKTRACER = "mock";
private TraceUtil() {
}
- public static void initTracer(Configuration c) {
- if (c != null) {
- conf = new HBaseHTraceConfiguration(c);
+ public static void initTracer(Configuration c, String serviceName) {
+ if (GlobalTracer.isRegistered()) {
+ LOG.info("A tracer is already registered.");
+ return;
}
- if (tracer == null && conf != null) {
- tracer = new Tracer.Builder("Tracer").conf(conf).build();
+ switch(c.get(HBASE_OPENTRACING_TRACER, HBASE_OPENTRACING_TRACER_DEFAULT)) {
+ case HBASE_OPENTRACING_TRACER_DEFAULT:
+ io.jaegertracing.Configuration conf =
io.jaegertracing.Configuration.fromEnv(serviceName);
+ tracer = conf.getTracerBuilder().build();
+ break;
+ case HBASE_OPENTRACING_MOCKTRACER:
+ tracer = new MockTracer();
+ break;
+ default:
+ throw new RuntimeException("Unexpected tracer");
}
+
+
+ GlobalTracer.register(tracer);
+
+ }
+
+ /*@VisibleForTesting
+ public static void registerTracerForTest(Tracer tracer) {
+ TraceUtil.tracer = tracer;
+ GlobalTracer.register(tracer);
+ }*/
+
+ public static Tracer getTracer() {
+ return tracer;
}
/**
- * Wrapper method to create new TraceScope with the given description
- * @return TraceScope or null when not tracing
+ * Wrapper method to create new Scope with the given description
+ * @return Scope or null when not tracing
*/
- public static TraceScope createTrace(String description) {
- return (tracer == null) ? null : tracer.newScope(description);
+ public static Scope createTrace(String description) {
+ return (tracer == null) ? null :
+ tracer.buildSpan(description).startActive(true);
}
/**
- * Wrapper method to create new child TraceScope with the given description
+ * Wrapper method to create new child Scope with the given description
* and parent scope's spanId
* @param span parent span
- * @return TraceScope or null when not tracing
+ * @return Scope or null when not tracing
*/
- public static TraceScope createTrace(String description, Span span) {
- if (span == null) {
- return createTrace(description);
- }
+ public static Scope createTrace(String description, Span span) {
+ if(span == null) return createTrace(description);
+
+ return (tracer == null) ? null : tracer.buildSpan(description).
+ asChildOf(span).startActive(true);
+ }
+
+ public static Scope createTrace(String description, SpanContext spanContext)
{
+ if(spanContext == null) return createTrace(description);
- return (tracer == null) ? null : tracer.newScope(description,
span.getSpanId());
+ return (tracer == null) ? null : tracer.buildSpan(description).
+ asChildOf(spanContext).startActive(true);
}
/**
* Wrapper method to add new sampler to the default tracer
* @return true if added, false if it was already added
*/
- public static boolean addSampler(Sampler sampler) {
+ public static boolean addSampler(SamplerConfiguration sampler) {
if (sampler == null) {
return false;
}
- return (tracer == null) ? false : tracer.addSampler(sampler);
+ conf = conf.withSampler(sampler);
Review comment:
@jojochuang - I have one more question. Say I have already started my
region server and in this case it is Jaegar tracing. But while I start I don
want any real tracing to happen. For eg I need to have the NoopScopeManager.
But now by default the Region Server will initiliaze with
ThreadLocalScopeManager.
`private ScopeManager scopeManager = new ThreadLocalScopeManager();`
The above is from JaegerTracer.Builder.
Now if I really want a tracer but with the scope doing nothing - is it
possible? Next say if I want to dynamically enable tracing and then disable it
how is that possible.
The config file that you had pointed out to is mainly to define per service
what is the sampling type I want. But that again is predefined and there is no
changing it. My requirement is if the RS needs to run with minimum friction and
only on demand do my trace and again go back to minimum friction is it possible?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
