Skip to content

Commit af10a9e

Browse files
lqiu96lqiu96
authored
fix: Update default Otel Attribute from method_name to method (#2833)
Fixes #2832
1 parent c0b5646 commit af10a9e

File tree

5 files changed

+25
-19
lines changed

5 files changed

+25
-19
lines changed

‎gax-java/gax/clirr-ignored-differences.xml

+6
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,10 @@
4747
<className>com/google/api/gax/rpc/StubSettings</className>
4848
<method>* getServiceName()</method>
4949
</difference>
50+
<!-- Ignore all field name changes as MetricsTracer is InternalApi -->
51+
<difference>
52+
<differenceType>6011</differenceType>
53+
<className>com/google/api/gax/tracing/MetricsTracer</className>
54+
<field>*</field>
55+
</difference>
5056
</differences>

‎gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
@BetaApi
5454
@InternalApi
5555
public class MetricsTracer implements ApiTracer {
56-
public static final String METHOD_NAME_ATTRIBUTE = "method_name";
56+
public static final String METHOD_ATTRIBUTE = "method";
5757
public static final String LANGUAGE_ATTRIBUTE = "language";
5858
public static final String STATUS_ATTRIBUTE = "status";
5959
public static final String DEFAULT_LANGUAGE = "Java";
@@ -67,7 +67,7 @@ public class MetricsTracer implements ApiTracer {
6767
private final AtomicBoolean operationFinished;
6868

6969
public MetricsTracer(MethodName methodName, MetricsRecorder metricsRecorder) {
70-
this.attributes.put(METHOD_NAME_ATTRIBUTE, methodName.toString());
70+
this.attributes.put(METHOD_ATTRIBUTE, methodName.toString());
7171
this.attributes.put(LANGUAGE_ATTRIBUTE, DEFAULT_LANGUAGE);
7272
this.metricsRecorder = metricsRecorder;
7373
this.operationFinished = new AtomicBoolean();

‎gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerFactoryTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ void testNewTracer_hasCorrectNumberAttributes_hasDefaultAttributes() {
7474
(MetricsTracer) metricsTracerFactory.newTracer(parent, spanName, OperationType.Unary);
7575
Map<String, String> attributes = metricsTracer.getAttributes();
7676
Truth.assertThat(attributes.size()).isEqualTo(DEFAULT_ATTRIBUTES_COUNT);
77-
Truth.assertThat(attributes.get(MetricsTracer.METHOD_NAME_ATTRIBUTE))
77+
Truth.assertThat(attributes.get(MetricsTracer.METHOD_ATTRIBUTE))
7878
.isEqualTo("testService.testMethod");
7979
Truth.assertThat(attributes.get(MetricsTracer.LANGUAGE_ATTRIBUTE))
8080
.isEqualTo(MetricsTracer.DEFAULT_LANGUAGE);

‎gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsTracerTest.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ void setUp() {
6565

6666
private ImmutableMap<String, String> getAttributes(Code statusCode) {
6767
return ImmutableMap.of(
68-
"status",
68+
MetricsTracer.STATUS_ATTRIBUTE,
6969
statusCode.toString(),
70-
"method_name",
70+
MetricsTracer.METHOD_ATTRIBUTE,
7171
DEFAULT_METHOD_NAME,
72-
"language",
72+
MetricsTracer.LANGUAGE_ATTRIBUTE,
7373
MetricsTracer.DEFAULT_LANGUAGE);
7474
}
7575

‎showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java

+13-13
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ void testGrpc_operationSucceeded_recordsMetrics() throws InterruptedException {
310310

311311
Map<String, String> expectedAttributes =
312312
ImmutableMap.of(
313-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
313+
MetricsTracer.METHOD_ATTRIBUTE,
314314
"Echo.Echo",
315315
MetricsTracer.LANGUAGE_ATTRIBUTE,
316316
MetricsTracer.DEFAULT_LANGUAGE);
@@ -333,7 +333,7 @@ void testHttpJson_operationSucceeded_recordsMetrics() throws InterruptedExceptio
333333

334334
Map<String, String> expectedAttributes =
335335
ImmutableMap.of(
336-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
336+
MetricsTracer.METHOD_ATTRIBUTE,
337337
"google.showcase.v1beta1.Echo/Echo",
338338
MetricsTracer.LANGUAGE_ATTRIBUTE,
339339
MetricsTracer.DEFAULT_LANGUAGE);
@@ -363,7 +363,7 @@ void testGrpc_operationCancelled_recordsMetrics() throws Exception {
363363

364364
Map<String, String> expectedAttributes =
365365
ImmutableMap.of(
366-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
366+
MetricsTracer.METHOD_ATTRIBUTE,
367367
"Echo.Block",
368368
MetricsTracer.LANGUAGE_ATTRIBUTE,
369369
MetricsTracer.DEFAULT_LANGUAGE);
@@ -391,7 +391,7 @@ void testHttpJson_operationCancelled_recordsMetrics() throws Exception {
391391

392392
Map<String, String> expectedAttributes =
393393
ImmutableMap.of(
394-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
394+
MetricsTracer.METHOD_ATTRIBUTE,
395395
"google.showcase.v1beta1.Echo/Block",
396396
MetricsTracer.LANGUAGE_ATTRIBUTE,
397397
MetricsTracer.DEFAULT_LANGUAGE);
@@ -420,7 +420,7 @@ void testGrpc_operationFailed_recordsMetrics() throws InterruptedException {
420420

421421
Map<String, String> expectedAttributes =
422422
ImmutableMap.of(
423-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
423+
MetricsTracer.METHOD_ATTRIBUTE,
424424
"Echo.Block",
425425
MetricsTracer.LANGUAGE_ATTRIBUTE,
426426
MetricsTracer.DEFAULT_LANGUAGE);
@@ -450,7 +450,7 @@ void testHttpJson_operationFailed_recordsMetrics() throws InterruptedException {
450450

451451
Map<String, String> expectedAttributes =
452452
ImmutableMap.of(
453-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
453+
MetricsTracer.METHOD_ATTRIBUTE,
454454
"google.showcase.v1beta1.Echo/Block",
455455
MetricsTracer.LANGUAGE_ATTRIBUTE,
456456
MetricsTracer.DEFAULT_LANGUAGE);
@@ -513,7 +513,7 @@ void testGrpc_attemptFailedRetriesExhausted_recordsMetrics() throws Exception {
513513

514514
Map<String, String> expectedAttributes =
515515
ImmutableMap.of(
516-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
516+
MetricsTracer.METHOD_ATTRIBUTE,
517517
"Echo.Echo",
518518
MetricsTracer.LANGUAGE_ATTRIBUTE,
519519
MetricsTracer.DEFAULT_LANGUAGE);
@@ -581,7 +581,7 @@ void testHttpJson_attemptFailedRetriesExhausted_recordsMetrics() throws Exceptio
581581

582582
Map<String, String> expectedAttributes =
583583
ImmutableMap.of(
584-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
584+
MetricsTracer.METHOD_ATTRIBUTE,
585585
"google.showcase.v1beta1.Echo/Echo",
586586
MetricsTracer.LANGUAGE_ATTRIBUTE,
587587
MetricsTracer.DEFAULT_LANGUAGE);
@@ -611,7 +611,7 @@ void testGrpc_attemptPermanentFailure_recordsMetrics() throws InterruptedExcepti
611611

612612
Map<String, String> expectedAttributes =
613613
ImmutableMap.of(
614-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
614+
MetricsTracer.METHOD_ATTRIBUTE,
615615
"Echo.Block",
616616
MetricsTracer.LANGUAGE_ATTRIBUTE,
617617
MetricsTracer.DEFAULT_LANGUAGE);
@@ -639,7 +639,7 @@ void testHttpJson_attemptPermanentFailure_recordsMetrics() throws InterruptedExc
639639

640640
Map<String, String> expectedAttributes =
641641
ImmutableMap.of(
642-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
642+
MetricsTracer.METHOD_ATTRIBUTE,
643643
"google.showcase.v1beta1.Echo/Block",
644644
MetricsTracer.LANGUAGE_ATTRIBUTE,
645645
MetricsTracer.DEFAULT_LANGUAGE);
@@ -708,7 +708,7 @@ void testGrpc_multipleFailedAttempts_successfulOperation() throws Exception {
708708

709709
Map<String, String> expectedAttributes =
710710
ImmutableMap.of(
711-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
711+
MetricsTracer.METHOD_ATTRIBUTE,
712712
"Echo.Block",
713713
MetricsTracer.LANGUAGE_ATTRIBUTE,
714714
MetricsTracer.DEFAULT_LANGUAGE);
@@ -778,7 +778,7 @@ void testHttpJson_multipleFailedAttempts_successfulOperation() throws Exception
778778

779779
Map<String, String> expectedAttributes =
780780
ImmutableMap.of(
781-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
781+
MetricsTracer.METHOD_ATTRIBUTE,
782782
"google.showcase.v1beta1.Echo/Block",
783783
MetricsTracer.LANGUAGE_ATTRIBUTE,
784784
MetricsTracer.DEFAULT_LANGUAGE);
@@ -839,7 +839,7 @@ void recordsCustomAttributes() throws InterruptedException, IOException {
839839
List<MetricData> actualMetricDataList = getMetricDataList(inMemoryMetricReader);
840840
Map<String, String> expectedAttributes =
841841
ImmutableMap.of(
842-
MetricsTracer.METHOD_NAME_ATTRIBUTE,
842+
MetricsTracer.METHOD_ATTRIBUTE,
843843
"Echo.Echo",
844844
MetricsTracer.LANGUAGE_ATTRIBUTE,
845845
MetricsTracer.DEFAULT_LANGUAGE,

0 commit comments

Comments
 (0)