Skip to content

Commit 3f8dc0e

Browse files
committed
Apply to *Telemetry classes
1 parent 5232e07 commit 3f8dc0e

File tree

54 files changed

+142
-193
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+142
-193
lines changed

docs/contributing/style-guide.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,9 @@ immediately after the field to keep initialization logic co-located, even when t
7575
the general method ordering above.
7676

7777
**Static factory entry points**: When a class exposes public static factory methods as its primary
78-
creation API (for example `create*(...)` or `builder(...)`), those methods should be placed below
79-
fields and above constructors.
78+
creation API (for example `create*(...)` or `builder(...)`), place those methods below fields and
79+
immediately above constructors. Treat static factory methods and constructors as a single
80+
construction section.
8081

8182
**Static utility classes**: Place the private constructor (used to prevent instantiation) after all
8283
methods.

instrumentation/alibaba-druid-1.0/library/src/main/java/io/opentelemetry/instrumentation/alibabadruid/v1_0/DruidTelemetry.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@
99
import io.opentelemetry.api.OpenTelemetry;
1010

1111
public final class DruidTelemetry {
12+
private final OpenTelemetry openTelemetry;
1213

1314
public static DruidTelemetry create(OpenTelemetry openTelemetry) {
1415
return new DruidTelemetry(openTelemetry);
1516
}
1617

17-
private final OpenTelemetry openTelemetry;
18-
1918
private DruidTelemetry(OpenTelemetry openTelemetry) {
2019
this.openTelemetry = openTelemetry;
2120
}

instrumentation/apache-dbcp-2.0/library/src/main/java/io/opentelemetry/instrumentation/apachedbcp/v2_0/ApacheDbcpTelemetry.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@
1010

1111
/** Entrypoint for instrumenting Apache DBCP database connection pools. */
1212
public final class ApacheDbcpTelemetry {
13+
private final OpenTelemetry openTelemetry;
1314

1415
/** Returns a new {@link ApacheDbcpTelemetry} configured with the given {@link OpenTelemetry}. */
1516
public static ApacheDbcpTelemetry create(OpenTelemetry openTelemetry) {
1617
return new ApacheDbcpTelemetry(openTelemetry);
1718
}
1819

19-
private final OpenTelemetry openTelemetry;
20-
2120
private ApacheDbcpTelemetry(OpenTelemetry openTelemetry) {
2221
this.openTelemetry = openTelemetry;
2322
}

instrumentation/apache-dubbo-2.7/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/apachedubbo/v2_7/DubboTelemetry.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212

1313
/** Entrypoint for instrumenting Apache Dubbo servers and clients. */
1414
public final class DubboTelemetry {
15-
1615
private final Instrumenter<DubboRequest, Result> serverInstrumenter;
1716
private final Instrumenter<DubboRequest, Result> clientInstrumenter;
1817

instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTelemetry.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
/** Entrypoint for instrumenting Apache HTTP Client. */
1616
public final class ApacheHttpClientTelemetry {
17+
private final Instrumenter<ApacheHttpClientRequest, HttpResponse> instrumenter;
18+
private final ContextPropagators propagators;
1719

1820
/** Returns a new instance configured with the given {@link OpenTelemetry} instance. */
1921
public static ApacheHttpClientTelemetry create(OpenTelemetry openTelemetry) {
@@ -25,9 +27,6 @@ public static ApacheHttpClientTelemetryBuilder builder(OpenTelemetry openTelemet
2527
return new ApacheHttpClientTelemetryBuilder(openTelemetry);
2628
}
2729

28-
private final Instrumenter<ApacheHttpClientRequest, HttpResponse> instrumenter;
29-
private final ContextPropagators propagators;
30-
3130
ApacheHttpClientTelemetry(
3231
Instrumenter<ApacheHttpClientRequest, HttpResponse> instrumenter,
3332
ContextPropagators propagators) {

instrumentation/apache-httpclient/apache-httpclient-5.2/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v5_2/ApacheHttpClientTelemetry.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
/** Entrypoint for instrumenting Apache HTTP Client. */
1717
public final class ApacheHttpClientTelemetry {
18+
private final Instrumenter<ApacheHttpClientRequest, HttpResponse> instrumenter;
19+
private final ContextPropagators propagators;
1820

1921
/** Returns a new instance configured with the given {@link OpenTelemetry} instance. */
2022
public static ApacheHttpClientTelemetry create(OpenTelemetry openTelemetry) {
@@ -26,9 +28,6 @@ public static ApacheHttpClientTelemetryBuilder builder(OpenTelemetry openTelemet
2628
return new ApacheHttpClientTelemetryBuilder(openTelemetry);
2729
}
2830

29-
private final Instrumenter<ApacheHttpClientRequest, HttpResponse> instrumenter;
30-
private final ContextPropagators propagators;
31-
3231
ApacheHttpClientTelemetry(
3332
Instrumenter<ApacheHttpClientRequest, HttpResponse> instrumenter,
3433
ContextPropagators propagators) {

instrumentation/armeria/armeria-1.3/library/src/main/java/io/opentelemetry/instrumentation/armeria/v1_3/ArmeriaClientTelemetry.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
/** Entrypoint for instrumenting Armeria clients. */
1616
public final class ArmeriaClientTelemetry {
17+
private final Instrumenter<ClientRequestContext, RequestLog> instrumenter;
1718

1819
/** Returns a new instance configured with the given {@link OpenTelemetry} instance. */
1920
public static ArmeriaClientTelemetry create(OpenTelemetry openTelemetry) {
@@ -25,8 +26,6 @@ public static ArmeriaClientTelemetryBuilder builder(OpenTelemetry openTelemetry)
2526
return new ArmeriaClientTelemetryBuilder(openTelemetry);
2627
}
2728

28-
private final Instrumenter<ClientRequestContext, RequestLog> instrumenter;
29-
3029
ArmeriaClientTelemetry(Instrumenter<ClientRequestContext, RequestLog> instrumenter) {
3130
this.instrumenter = instrumenter;
3231
}

instrumentation/armeria/armeria-1.3/library/src/main/java/io/opentelemetry/instrumentation/armeria/v1_3/ArmeriaServerTelemetry.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
/** Entrypoint for instrumenting Armeria services. */
1616
public final class ArmeriaServerTelemetry {
17+
private final Instrumenter<ServiceRequestContext, RequestLog> instrumenter;
1718

1819
/** Returns a new instance configured with the given {@link OpenTelemetry} instance. */
1920
public static ArmeriaServerTelemetry create(OpenTelemetry openTelemetry) {
@@ -25,8 +26,6 @@ public static ArmeriaServerTelemetryBuilder builder(OpenTelemetry openTelemetry)
2526
return new ArmeriaServerTelemetryBuilder(openTelemetry);
2627
}
2728

28-
private final Instrumenter<ServiceRequestContext, RequestLog> instrumenter;
29-
3029
ArmeriaServerTelemetry(Instrumenter<ServiceRequestContext, RequestLog> instrumenter) {
3130
this.instrumenter = instrumenter;
3231
}

instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkTelemetry.java

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,11 @@
2323
* witness broken traces.
2424
*/
2525
public class AwsSdkTelemetry {
26-
27-
/**
28-
* Returns the OpenTelemetry {@link Context} stored in the {@link Request}, or {@code null} if
29-
* there is no {@link Context}. This is generally not needed unless you are implementing your own
30-
* instrumentation that delegates to this one.
31-
*/
32-
public static Context getOpenTelemetryContext(Request<?> request) {
33-
return request.getHandlerContext(TracingRequestHandler.CONTEXT);
34-
}
26+
private final Instrumenter<Request<?>, Response<?>> requestInstrumenter;
27+
private final Instrumenter<SqsReceiveRequest, Response<?>> consumerReceiveInstrumenter;
28+
private final Instrumenter<SqsProcessRequest, Response<?>> consumerProcessInstrumenter;
29+
private final Instrumenter<Request<?>, Response<?>> producerInstrumenter;
30+
private final Instrumenter<Request<?>, Response<?>> dynamoDbInstrumenter;
3531

3632
/** Returns a new {@link AwsSdkTelemetry} configured with the given {@link OpenTelemetry}. */
3733
public static AwsSdkTelemetry create(OpenTelemetry openTelemetry) {
@@ -45,12 +41,6 @@ public static AwsSdkTelemetryBuilder builder(OpenTelemetry openTelemetry) {
4541
return new AwsSdkTelemetryBuilder(openTelemetry);
4642
}
4743

48-
private final Instrumenter<Request<?>, Response<?>> requestInstrumenter;
49-
private final Instrumenter<SqsReceiveRequest, Response<?>> consumerReceiveInstrumenter;
50-
private final Instrumenter<SqsProcessRequest, Response<?>> consumerProcessInstrumenter;
51-
private final Instrumenter<Request<?>, Response<?>> producerInstrumenter;
52-
private final Instrumenter<Request<?>, Response<?>> dynamoDbInstrumenter;
53-
5444
AwsSdkTelemetry(
5545
OpenTelemetry openTelemetry,
5646
List<String> capturedHeaders,
@@ -81,4 +71,13 @@ public RequestHandler2 createRequestHandler() {
8171
producerInstrumenter,
8272
dynamoDbInstrumenter);
8373
}
74+
75+
/**
76+
* Returns the OpenTelemetry {@link Context} stored in the {@link Request}, or {@code null} if
77+
* there is no {@link Context}. This is generally not needed unless you are implementing your own
78+
* instrumentation that delegates to this one.
79+
*/
80+
public static Context getOpenTelemetryContext(Request<?> request) {
81+
return request.getHandlerContext(TracingRequestHandler.CONTEXT);
82+
}
8483
}

instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AwsSdkTelemetry.java

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,6 @@
4848
* }</pre>
4949
*/
5050
public class AwsSdkTelemetry {
51-
52-
/** Returns a new {@link AwsSdkTelemetry} configured with the given {@link OpenTelemetry}. */
53-
public static AwsSdkTelemetry create(OpenTelemetry openTelemetry) {
54-
return builder(openTelemetry).build();
55-
}
56-
57-
/**
58-
* Returns a new {@link AwsSdkTelemetryBuilder} configured with the given {@link OpenTelemetry}.
59-
*/
60-
public static AwsSdkTelemetryBuilder builder(OpenTelemetry openTelemetry) {
61-
return new AwsSdkTelemetryBuilder(openTelemetry);
62-
}
63-
6451
private final Instrumenter<ExecutionAttributes, Response> requestInstrumenter;
6552
private final Instrumenter<SqsReceiveRequest, Response> consumerReceiveInstrumenter;
6653
private final Instrumenter<SqsProcessRequest, Response> consumerProcessInstrumenter;
@@ -74,6 +61,18 @@ public static AwsSdkTelemetryBuilder builder(OpenTelemetry openTelemetry) {
7461
private final boolean recordIndividualHttpError;
7562
private final boolean genAiCaptureMessageContent;
7663

64+
/** Returns a new {@link AwsSdkTelemetry} configured with the given {@link OpenTelemetry}. */
65+
public static AwsSdkTelemetry create(OpenTelemetry openTelemetry) {
66+
return builder(openTelemetry).build();
67+
}
68+
69+
/**
70+
* Returns a new {@link AwsSdkTelemetryBuilder} configured with the given {@link OpenTelemetry}.
71+
*/
72+
public static AwsSdkTelemetryBuilder builder(OpenTelemetry openTelemetry) {
73+
return new AwsSdkTelemetryBuilder(openTelemetry);
74+
}
75+
7776
AwsSdkTelemetry(
7877
OpenTelemetry openTelemetry,
7978
List<String> capturedHeaders,

0 commit comments

Comments
 (0)