Apache9 commented on a change in pull request #4024: URL: https://github.com/apache/hbase/pull/4024#discussion_r788294747
########## File path: hbase-client/src/main/java/org/apache/hadoop/hbase/client/trace/IpcClientSpanBuilder.java ########## @@ -0,0 +1,103 @@ +/* + * 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.hadoop.hbase.client.trace; + +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.NET_PEER_NAME; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.NET_PEER_PORT; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_METHOD; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_SERVICE; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_SYSTEM; +import io.opentelemetry.api.common.AttributeKey; +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanBuilder; +import io.opentelemetry.api.trace.SpanKind; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Supplier; +import org.apache.hadoop.hbase.net.Address; +import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RpcSystem; +import org.apache.hadoop.hbase.trace.TraceUtil; +import org.apache.yetus.audience.InterfaceAudience; +import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors; + +/** + * Construct {@link Span} instances originating from the client side of an IPC. + */ [email protected] +public class IpcClientSpanBuilder implements Supplier<Span> { + + private String name; + private final Map<AttributeKey<?>, Object> attributes = new HashMap<>(); + + @Override + public Span get() { + return build(); + } + + public IpcClientSpanBuilder setMethodDescriptor(final Descriptors.MethodDescriptor md) { + final String packageAndService = getRpcPackageAndService(md); + final String method = getRpcName(md); + this.name = packageAndService + "/" + method; + populateMethodDescriptorAttributes(attributes, md); + return this; + } + + public IpcClientSpanBuilder setRemoteAddress(final Address remoteAddress) { + attributes.put(NET_PEER_NAME, remoteAddress.getHostName()); + attributes.put(NET_PEER_PORT, (long) remoteAddress.getPort()); + return this; + } + + @SuppressWarnings("unchecked") + public Span build() { + final SpanBuilder builder = TraceUtil.getGlobalTracer() + .spanBuilder(name) + // TODO: what about clients embedded in Master/RegionServer/Gateways/&c? + .setSpanKind(SpanKind.CLIENT); + attributes.forEach((k, v) -> builder.setAttribute((AttributeKey<? super Object>) k, v)); + return builder.startSpan(); + } + + /** + * Static utility method that performs the primary logic of this builder. It is visible to other + * classes in this package so that other builders can use this functionality as a mix-in. + * @param attributes the attributes map to be populated. + * @param md the source of the RPC attribute values. + */ + static void populateMethodDescriptorAttributes( + final Map<AttributeKey<?>, Object> attributes, + final Descriptors.MethodDescriptor md + ) { + final String packageAndService = getRpcPackageAndService(md); + final String method = getRpcName(md); + attributes.put(RPC_SYSTEM, RpcSystem.HBASE_RPC.name()); + attributes.put(RPC_SERVICE, packageAndService); + attributes.put(RPC_METHOD, method); + } + + private static String getRpcPackageAndService(final Descriptors.MethodDescriptor md) { Review comment: We could move this method to a util class and also let the IpcServerSpanBuilder to call this method too? So in the future if we want to change the implementation, we could fix them both at the same time. ########## File path: hbase-client/src/main/java/org/apache/hadoop/hbase/client/trace/IpcClientSpanBuilder.java ########## @@ -0,0 +1,103 @@ +/* + * 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.hadoop.hbase.client.trace; + +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.NET_PEER_NAME; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.NET_PEER_PORT; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_METHOD; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_SERVICE; +import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RPC_SYSTEM; +import io.opentelemetry.api.common.AttributeKey; +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanBuilder; +import io.opentelemetry.api.trace.SpanKind; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Supplier; +import org.apache.hadoop.hbase.net.Address; +import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.RpcSystem; +import org.apache.hadoop.hbase.trace.TraceUtil; +import org.apache.yetus.audience.InterfaceAudience; +import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors; + +/** + * Construct {@link Span} instances originating from the client side of an IPC. + */ [email protected] +public class IpcClientSpanBuilder implements Supplier<Span> { + + private String name; + private final Map<AttributeKey<?>, Object> attributes = new HashMap<>(); + + @Override + public Span get() { + return build(); + } + + public IpcClientSpanBuilder setMethodDescriptor(final Descriptors.MethodDescriptor md) { + final String packageAndService = getRpcPackageAndService(md); + final String method = getRpcName(md); + this.name = packageAndService + "/" + method; + populateMethodDescriptorAttributes(attributes, md); + return this; + } + + public IpcClientSpanBuilder setRemoteAddress(final Address remoteAddress) { + attributes.put(NET_PEER_NAME, remoteAddress.getHostName()); + attributes.put(NET_PEER_PORT, (long) remoteAddress.getPort()); + return this; + } + + @SuppressWarnings("unchecked") + public Span build() { + final SpanBuilder builder = TraceUtil.getGlobalTracer() + .spanBuilder(name) + // TODO: what about clients embedded in Master/RegionServer/Gateways/&c? + .setSpanKind(SpanKind.CLIENT); + attributes.forEach((k, v) -> builder.setAttribute((AttributeKey<? super Object>) k, v)); + return builder.startSpan(); + } + + /** + * Static utility method that performs the primary logic of this builder. It is visible to other + * classes in this package so that other builders can use this functionality as a mix-in. + * @param attributes the attributes map to be populated. + * @param md the source of the RPC attribute values. + */ + static void populateMethodDescriptorAttributes( + final Map<AttributeKey<?>, Object> attributes, + final Descriptors.MethodDescriptor md + ) { + final String packageAndService = getRpcPackageAndService(md); + final String method = getRpcName(md); + attributes.put(RPC_SYSTEM, RpcSystem.HBASE_RPC.name()); + attributes.put(RPC_SERVICE, packageAndService); + attributes.put(RPC_METHOD, method); + } + + private static String getRpcPackageAndService(final Descriptors.MethodDescriptor md) { + // it happens that `getFullName` returns a string in the $package.$service format required by + // the otel RPC specification. Use it for now; might have to parse the value in the future. + return md.getService().getFullName(); + } + + private static String getRpcName(final Descriptors.MethodDescriptor md) { Review comment: Ditto. ########## File path: hbase-common/src/main/java/org/apache/hadoop/hbase/trace/HBaseSemanticAttributes.java ########## @@ -38,14 +38,13 @@ public static final AttributeKey<String> TABLE_KEY = AttributeKey.stringKey("db.hbase.table"); public static final AttributeKey<List<String>> REGION_NAMES_KEY = AttributeKey.stringArrayKey("db.hbase.regions"); - public static final AttributeKey<String> RPC_SERVICE_KEY = - AttributeKey.stringKey("db.hbase.rpc.service"); - public static final AttributeKey<String> RPC_METHOD_KEY = - AttributeKey.stringKey("db.hbase.rpc.method"); + public static final AttributeKey<String> RPC_SYSTEM = SemanticAttributes.RPC_SYSTEM; Review comment: Do we still need to maintain this alias in HBaseSemanticAttributes? I'm neutral， just asking... ########## File path: hbase-client/src/test/java/org/apache/hadoop/hbase/client/trace/hamcrest/SpanDataMatchers.java ########## @@ -46,6 +48,18 @@ private SpanDataMatchers() { } }; } + public static <T extends Comparable<T> & TemporalAmount> Matcher<SpanData> hasDuration( + Matcher<T> matcher + ) { + return new FeatureMatcher<SpanData, T>(matcher, "SpanData having duration that ", "duration") { + @Override + @SuppressWarnings("unchecked") + protected T featureValueOf(SpanData item) { Review comment: Looking at the implementation of java.time.Duration, it seems that it can only be compared with another Duration, so do we need to introduce a generic type here? Just use Duration directly? -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
