Skip to content

Commit 74aa1be

Browse files
Rename config setting and properties for emiting events
1 parent 60dbca4 commit 74aa1be

File tree

6 files changed

+23
-23
lines changed

6 files changed

+23
-23
lines changed

instrumentation/grpc-1.6/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
| System property | Type | Default | Description |
44
|-------------------------------------------------------------|---------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| `otel.instrumentation.grpc.message-events` | Boolean | `true` | Determines whether to add span event for each individual message received and sent. Set this to false in case of streaming large volumes of messages. |
5+
| `otel.instrumentation.grpc.emit-message-events` | Boolean | `true` | Determines whether to emit span event for each individual message received and sent. |
66
| `otel.instrumentation.grpc.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental span attributes. |
77
| `otel.instrumentation.grpc.capture-metadata.client.request` | String | | A comma-separated list of request metadata keys. gRPC client instrumentation will capture metadata values corresponding to configured keys as span attributes. |
88
| `otel.instrumentation.grpc.capture-metadata.server.request` | String | | A comma-separated list of request metadata keys. gRPC server instrumentation will capture metadata values corresponding to configured keys as span attributes. |

instrumentation/grpc-1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/grpc/v1_6/GrpcSingletons.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ public final class GrpcSingletons {
2727
private static final AtomicReference<Context.Storage> STORAGE_REFERENCE = new AtomicReference<>();
2828

2929
static {
30-
boolean addMessageEvents =
30+
boolean emitMessageEvents =
3131
AgentInstrumentationConfig.get()
32-
.getBoolean("otel.instrumentation.grpc.message-events", true);
32+
.getBoolean("otel.instrumentation.grpc.emit-message-events", true);
3333

3434
boolean experimentalSpanAttributes =
3535
AgentInstrumentationConfig.get()
@@ -44,7 +44,7 @@ public final class GrpcSingletons {
4444

4545
GrpcTelemetry telemetry =
4646
GrpcTelemetry.builder(GlobalOpenTelemetry.get())
47-
.setAddMessageEvents(addMessageEvents)
47+
.setEmitMessageEvents(emitMessageEvents)
4848
.setCaptureExperimentalSpanAttributes(experimentalSpanAttributes)
4949
.setCapturedClientRequestMetadata(clientRequestMetadata)
5050
.setCapturedServerRequestMetadata(serverRequestMetadata)

instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/GrpcTelemetry.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ public static GrpcTelemetryBuilder builder(OpenTelemetry openTelemetry) {
2929
private final Instrumenter<GrpcRequest, Status> clientInstrumenter;
3030
private final ContextPropagators propagators;
3131
private final boolean captureExperimentalSpanAttributes;
32-
private final boolean addMessageEvents;
32+
private final boolean emitMessageEvents;
3333

3434
GrpcTelemetry(
3535
Instrumenter<GrpcRequest, Status> serverInstrumenter,
3636
Instrumenter<GrpcRequest, Status> clientInstrumenter,
3737
ContextPropagators propagators,
3838
boolean captureExperimentalSpanAttributes,
39-
boolean addMessageEvents) {
39+
boolean emitMessageEvents) {
4040
this.serverInstrumenter = serverInstrumenter;
4141
this.clientInstrumenter = clientInstrumenter;
4242
this.propagators = propagators;
4343
this.captureExperimentalSpanAttributes = captureExperimentalSpanAttributes;
44-
this.addMessageEvents = addMessageEvents;
44+
this.emitMessageEvents = emitMessageEvents;
4545
}
4646

4747
/**
@@ -50,7 +50,7 @@ public static GrpcTelemetryBuilder builder(OpenTelemetry openTelemetry) {
5050
*/
5151
public ClientInterceptor newClientInterceptor() {
5252
return new TracingClientInterceptor(
53-
clientInstrumenter, propagators, captureExperimentalSpanAttributes, addMessageEvents);
53+
clientInstrumenter, propagators, captureExperimentalSpanAttributes, emitMessageEvents);
5454
}
5555

5656
/**
@@ -59,6 +59,6 @@ public ClientInterceptor newClientInterceptor() {
5959
*/
6060
public ServerInterceptor newServerInterceptor() {
6161
return new TracingServerInterceptor(
62-
serverInstrumenter, captureExperimentalSpanAttributes, addMessageEvents);
62+
serverInstrumenter, captureExperimentalSpanAttributes, emitMessageEvents);
6363
}
6464
}

instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/GrpcTelemetryBuilder.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public final class GrpcTelemetryBuilder {
4949
additionalServerExtractors = new ArrayList<>();
5050

5151
private boolean captureExperimentalSpanAttributes;
52-
private boolean addMessageEvents = true;
52+
private boolean emitMessageEvents = true;
5353
private List<String> capturedClientRequestMetadata = Collections.emptyList();
5454
private List<String> capturedServerRequestMetadata = Collections.emptyList();
5555

@@ -136,8 +136,8 @@ public GrpcTelemetryBuilder setPeerService(String peerService) {
136136
* is true. Set this to false in case of streaming large volumes of messages.
137137
*/
138138
@CanIgnoreReturnValue
139-
public GrpcTelemetryBuilder setAddMessageEvents(boolean addMessageEvents) {
140-
this.addMessageEvents = addMessageEvents;
139+
public GrpcTelemetryBuilder setEmitMessageEvents(boolean emitMessageEvents) {
140+
this.emitMessageEvents = emitMessageEvents;
141141
return this;
142142
}
143143

@@ -223,6 +223,6 @@ public GrpcTelemetry build() {
223223
clientInstrumenterBuilder.buildInstrumenter(SpanKindExtractor.alwaysClient()),
224224
openTelemetry.getPropagators(),
225225
captureExperimentalSpanAttributes,
226-
addMessageEvents);
226+
emitMessageEvents);
227227
}
228228
}

instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/TracingClientInterceptor.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,17 @@ final class TracingClientInterceptor implements ClientInterceptor {
4444
private final Instrumenter<GrpcRequest, Status> instrumenter;
4545
private final ContextPropagators propagators;
4646
private final boolean captureExperimentalSpanAttributes;
47-
private final boolean addMessageEvents;
47+
private final boolean emitMessageEvents;
4848

4949
TracingClientInterceptor(
5050
Instrumenter<GrpcRequest, Status> instrumenter,
5151
ContextPropagators propagators,
5252
boolean captureExperimentalSpanAttributes,
53-
boolean addMessageEvents) {
53+
boolean emitMessageEvents) {
5454
this.instrumenter = instrumenter;
5555
this.propagators = propagators;
5656
this.captureExperimentalSpanAttributes = captureExperimentalSpanAttributes;
57-
this.addMessageEvents = addMessageEvents;
57+
this.emitMessageEvents = emitMessageEvents;
5858
}
5959

6060
@Override
@@ -129,7 +129,7 @@ public void sendMessage(REQUEST message) {
129129
throw e;
130130
}
131131
long messageId = SENT_MESSAGE_ID_UPDATER.incrementAndGet(this);
132-
if (addMessageEvents) {
132+
if (emitMessageEvents) {
133133
Attributes attributes = Attributes.of(MESSAGE_TYPE, SENT, MESSAGE_ID, messageId);
134134
Span.fromContext(context).addEvent("message", attributes);
135135
}
@@ -156,7 +156,7 @@ final class TracingClientCallListener
156156
@Override
157157
public void onMessage(RESPONSE message) {
158158
long messageId = RECEIVED_MESSAGE_ID_UPDATER.incrementAndGet(TracingClientCall.this);
159-
if (addMessageEvents) {
159+
if (emitMessageEvents) {
160160
Attributes attributes = Attributes.of(MESSAGE_TYPE, RECEIVED, MESSAGE_ID, messageId);
161161
Span.fromContext(context).addEvent("message", attributes);
162162
}

instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/TracingServerInterceptor.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ final class TracingServerInterceptor implements ServerInterceptor {
4545

4646
private final Instrumenter<GrpcRequest, Status> instrumenter;
4747
private final boolean captureExperimentalSpanAttributes;
48-
private final boolean addMessageEvents;
48+
private final boolean emitMessageEvents;
4949

5050
TracingServerInterceptor(
5151
Instrumenter<GrpcRequest, Status> instrumenter,
5252
boolean captureExperimentalSpanAttributes,
53-
boolean addMessageEvents) {
53+
boolean emitMessageEvents) {
5454
this.instrumenter = instrumenter;
5555
this.captureExperimentalSpanAttributes = captureExperimentalSpanAttributes;
56-
this.addMessageEvents = addMessageEvents;
56+
this.emitMessageEvents = emitMessageEvents;
5757
}
5858

5959
@Override
@@ -119,7 +119,7 @@ public void sendMessage(RESPONSE message) {
119119
super.sendMessage(message);
120120
}
121121
long messageId = SENT_MESSAGE_ID_UPDATER.incrementAndGet(this);
122-
if (addMessageEvents) {
122+
if (emitMessageEvents) {
123123
Attributes attributes = Attributes.of(MESSAGE_TYPE, SENT, MESSAGE_ID, messageId);
124124
Span.fromContext(context).addEvent("message", attributes);
125125
}
@@ -164,7 +164,7 @@ private void end(Context context, GrpcRequest request, Status response, Throwabl
164164
@Override
165165
public void onMessage(REQUEST message) {
166166
long messageId = RECEIVED_MESSAGE_ID_UPDATER.incrementAndGet(TracingServerCall.this);
167-
if (addMessageEvents) {
167+
if (emitMessageEvents) {
168168
Attributes attributes = Attributes.of(MESSAGE_TYPE, RECEIVED, MESSAGE_ID, messageId);
169169
Span.fromContext(context).addEvent("message", attributes);
170170
}

0 commit comments

Comments
 (0)