Skip to content

Commit 45c404c

Browse files
committed
fix: Rename resource name to resource id.
1 parent ef87008 commit 45c404c

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

gax-java/gax/src/main/java/com/google/api/gax/rpc/ResourceNameExtractor.java

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,13 @@
3030
package com.google.api.gax.rpc;
3131

3232
import com.google.api.core.InternalApi;
33+
import com.google.api.gax.tracing.ObservabilityAttributes;
3334

3435
/**
35-
* A client resource name extractor takes a {@code request} message and extracts the destination
36-
* resource name from it. This value is used primarily for tracing and observability.
36+
* A resource name extractor takes a request message and extracts the resource name from it. This
37+
* value is used primarily for tracing. It is added to spans as an attribute, labeled as
38+
* gcp.resource.destination.id (See {@link
39+
* ObservabilityAttributes#DESTINATION_RESOURCE_ID_ATTRIBUTE}).
3740
*
3841
* <p>Implementations of this interface are expected to be autogenerated.
3942
*
@@ -42,10 +45,10 @@
4245
@InternalApi("For use by transport-specific implementations")
4346
public interface ResourceNameExtractor<RequestT> {
4447
/**
45-
* Extracts the destination resource name from the {@code request}.
48+
* Extracts the resource name from the {@code request}.
4649
*
4750
* @param request request message
48-
* @return the destination resource name extracted from the request
51+
* @return the resource name extracted from the request
4952
*/
5053
String extract(RequestT request);
5154
}

gax-java/gax/src/main/java/com/google/api/gax/tracing/ApiTracerContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ String rpcSystemName() {
164164
@Nullable
165165
public abstract String urlDomain();
166166

167-
/** The destination resource name of the request (e.g. projects/p/locations/l/topics/t). */
167+
/** The destination resource id of the request (e.g. projects/p/locations/l/topics/t). */
168168
@Nullable
169169
public abstract String destinationResourceId();
170170

gax-java/gax/src/main/java/com/google/api/gax/tracing/TracedUnaryCallable.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ public ApiFuture<ResponseT> futureCall(RequestT request, ApiCallContext context)
112112
@VisibleForTesting
113113
ApiTracerContext extractResourceNameToApiTracerContext(RequestT request) {
114114
ApiTracerContext finalContext = apiTracerContext;
115-
// Extract the resource name early
116115
String resourceName =
117116
resourceNameExtractor != null ? resourceNameExtractor.extract(request) : null;
118117
if (!Strings.isNullOrEmpty(resourceName)) {

0 commit comments

Comments
 (0)