Skip to content

Commit b178439

Browse files
trasktrask
authored
Split ratpack into client and server (#12853)
1 parent cb35311 commit b178439

17 files changed

+680
-119
lines changed

‎instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackClientTelemetry.java

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package io.opentelemetry.instrumentation.ratpack.v1_7;
7+
8+
import io.opentelemetry.api.OpenTelemetry;
9+
import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
10+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.OpenTelemetryHttpClient;
11+
import ratpack.http.client.HttpClient;
12+
import ratpack.http.client.HttpResponse;
13+
import ratpack.http.client.RequestSpec;
14+
15+
/**
16+
* Entrypoint for instrumenting Ratpack http client.
17+
*
18+
* <p>To apply OpenTelemetry instrumentation to a http client, wrap the {@link HttpClient} using
19+
* {@link #instrument(HttpClient)}.
20+
*
21+
* <pre>{@code
22+
* RatpackClientTelemetry telemetry = RatpackClientTelemetry.create(OpenTelemetrySdk.builder()
23+
* ...
24+
* .build());
25+
* HttpClient instrumentedHttpClient = telemetry.instrument(httpClient);
26+
* }</pre>
27+
*/
28+
public final class RatpackClientTelemetry {
29+
30+
/**
31+
* Returns a new {@link RatpackClientTelemetry} configured with the given {@link OpenTelemetry}.
32+
*/
33+
public static RatpackClientTelemetry create(OpenTelemetry openTelemetry) {
34+
return builder(openTelemetry).build();
35+
}
36+
37+
/**
38+
* Returns a new {@link RatpackClientTelemetryBuilder} configured with the given {@link
39+
* OpenTelemetry}.
40+
*/
41+
public static RatpackClientTelemetryBuilder builder(OpenTelemetry openTelemetry) {
42+
return new RatpackClientTelemetryBuilder(openTelemetry);
43+
}
44+
45+
private final OpenTelemetryHttpClient httpClientInstrumenter;
46+
47+
RatpackClientTelemetry(Instrumenter<RequestSpec, HttpResponse> clientInstrumenter) {
48+
httpClientInstrumenter = new OpenTelemetryHttpClient(clientInstrumenter);
49+
}
50+
51+
/** Returns instrumented instance of {@link HttpClient} with OpenTelemetry. */
52+
public HttpClient instrument(HttpClient httpClient) throws Exception {
53+
return httpClientInstrumenter.instrument(httpClient);
54+
}
55+
}

‎instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackClientTelemetryBuilder.java

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package io.opentelemetry.instrumentation.ratpack.v1_7;
7+
8+
import com.google.errorprone.annotations.CanIgnoreReturnValue;
9+
import io.opentelemetry.api.OpenTelemetry;
10+
import io.opentelemetry.instrumentation.api.incubator.builder.internal.DefaultHttpClientInstrumenterBuilder;
11+
import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
12+
import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
13+
import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder;
14+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.Experimental;
15+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.RatpackClientInstrumenterBuilderFactory;
16+
import java.util.List;
17+
import java.util.Set;
18+
import java.util.function.Function;
19+
import ratpack.http.client.HttpResponse;
20+
import ratpack.http.client.RequestSpec;
21+
22+
/** A builder for {@link RatpackClientTelemetry}. */
23+
public final class RatpackClientTelemetryBuilder {
24+
25+
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.ratpack-1.7";
26+
27+
private final DefaultHttpClientInstrumenterBuilder<RequestSpec, HttpResponse> builder;
28+
29+
static {
30+
Experimental.setSetEmitExperimentalClientTelemetry(
31+
(builder, emit) -> builder.builder.setEmitExperimentalHttpClientMetrics(emit));
32+
}
33+
34+
RatpackClientTelemetryBuilder(OpenTelemetry openTelemetry) {
35+
builder = RatpackClientInstrumenterBuilderFactory.create(INSTRUMENTATION_NAME, openTelemetry);
36+
}
37+
38+
@CanIgnoreReturnValue
39+
public RatpackClientTelemetryBuilder addAttributesExtractor(
40+
AttributesExtractor<? super RequestSpec, ? super HttpResponse> attributesExtractor) {
41+
builder.addAttributesExtractor(attributesExtractor);
42+
return this;
43+
}
44+
45+
/**
46+
* Configures the HTTP client request headers that will be captured as span attributes.
47+
*
48+
* @param requestHeaders A list of HTTP header names.
49+
*/
50+
@CanIgnoreReturnValue
51+
public RatpackClientTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
52+
builder.setCapturedRequestHeaders(requestHeaders);
53+
return this;
54+
}
55+
56+
/**
57+
* Configures the HTTP client response headers that will be captured as span attributes.
58+
*
59+
* @param responseHeaders A list of HTTP header names.
60+
*/
61+
@CanIgnoreReturnValue
62+
public RatpackClientTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
63+
builder.setCapturedResponseHeaders(responseHeaders);
64+
return this;
65+
}
66+
67+
/**
68+
* Configures the instrumentation to recognize an alternative set of HTTP request methods.
69+
*
70+
* <p>By default, this instrumentation defines "known" methods as the ones listed in <a
71+
* href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH
72+
* method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>.
73+
*
74+
* <p>Note: calling this method <b>overrides</b> the default known method sets completely; it does
75+
* not supplement it.
76+
*
77+
* @param knownMethods A set of recognized HTTP request methods.
78+
* @see HttpClientAttributesExtractorBuilder#setKnownMethods(Set)
79+
*/
80+
@CanIgnoreReturnValue
81+
public RatpackClientTelemetryBuilder setKnownMethods(Set<String> knownMethods) {
82+
builder.setKnownMethods(knownMethods);
83+
return this;
84+
}
85+
86+
/** Sets custom client {@link SpanNameExtractor} via transform function. */
87+
@CanIgnoreReturnValue
88+
public RatpackClientTelemetryBuilder setSpanNameExtractor(
89+
Function<
90+
SpanNameExtractor<? super RequestSpec>,
91+
? extends SpanNameExtractor<? super RequestSpec>>
92+
clientSpanNameExtractor) {
93+
builder.setSpanNameExtractor(clientSpanNameExtractor);
94+
return this;
95+
}
96+
97+
/** Returns a new {@link RatpackClientTelemetry} with the configuration of this builder. */
98+
public RatpackClientTelemetry build() {
99+
return new RatpackClientTelemetry(builder.build());
100+
}
101+
}

‎instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackServerTelemetry.java

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package io.opentelemetry.instrumentation.ratpack.v1_7;
7+
8+
import io.opentelemetry.api.OpenTelemetry;
9+
import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
10+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.OpenTelemetryExecInitializer;
11+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.OpenTelemetryExecInterceptor;
12+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.OpenTelemetryServerHandler;
13+
import ratpack.exec.ExecInitializer;
14+
import ratpack.exec.ExecInterceptor;
15+
import ratpack.handling.Handler;
16+
import ratpack.handling.HandlerDecorator;
17+
import ratpack.http.Request;
18+
import ratpack.http.Response;
19+
import ratpack.registry.RegistrySpec;
20+
21+
/**
22+
* Entrypoint for instrumenting Ratpack server.
23+
*
24+
* <p>To apply OpenTelemetry instrumentation to a server, configure the {@link RegistrySpec} using
25+
* {@link #configureRegistry(RegistrySpec)}.
26+
*
27+
* <pre>{@code
28+
* RatpackServerTelemetry telemetry = RatpackServerTelemetry.create(OpenTelemetrySdk.builder()
29+
* ...
30+
* .build());
31+
* RatpackServer.start(server -> {
32+
* server.registryOf(telemetry::configureRegistry);
33+
* server.handlers(chain -> ...);
34+
* });
35+
* }</pre>
36+
*/
37+
public final class RatpackServerTelemetry {
38+
39+
/**
40+
* Returns a new {@link RatpackServerTelemetry} configured with the given {@link OpenTelemetry}.
41+
*/
42+
public static RatpackServerTelemetry create(OpenTelemetry openTelemetry) {
43+
return builder(openTelemetry).build();
44+
}
45+
46+
/**
47+
* Returns a new {@link RatpackServerTelemetryBuilder} configured with the given {@link
48+
* OpenTelemetry}.
49+
*/
50+
public static RatpackServerTelemetryBuilder builder(OpenTelemetry openTelemetry) {
51+
return new RatpackServerTelemetryBuilder(openTelemetry);
52+
}
53+
54+
private final OpenTelemetryServerHandler serverHandler;
55+
56+
RatpackServerTelemetry(Instrumenter<Request, Response> serverInstrumenter) {
57+
serverHandler = new OpenTelemetryServerHandler(serverInstrumenter);
58+
}
59+
60+
/** Returns a {@link Handler} to support Ratpack Registry binding. */
61+
public Handler getHandler() {
62+
return serverHandler;
63+
}
64+
65+
/** Returns instance of {@link ExecInterceptor} to support Ratpack Registry binding. */
66+
public ExecInterceptor getExecInterceptor() {
67+
return OpenTelemetryExecInterceptor.INSTANCE;
68+
}
69+
70+
/** Returns instance of {@link ExecInitializer} to support Ratpack Registry binding. */
71+
public ExecInitializer getExecInitializer() {
72+
return OpenTelemetryExecInitializer.INSTANCE;
73+
}
74+
75+
/** Configures the {@link RegistrySpec} with OpenTelemetry. */
76+
public void configureRegistry(RegistrySpec registry) {
77+
registry.add(HandlerDecorator.prepend(serverHandler));
78+
registry.add(OpenTelemetryExecInterceptor.INSTANCE);
79+
registry.add(OpenTelemetryExecInitializer.INSTANCE);
80+
}
81+
}

‎instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackServerTelemetryBuilder.java

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package io.opentelemetry.instrumentation.ratpack.v1_7;
7+
8+
import com.google.errorprone.annotations.CanIgnoreReturnValue;
9+
import io.opentelemetry.api.OpenTelemetry;
10+
import io.opentelemetry.instrumentation.api.incubator.builder.internal.DefaultHttpServerInstrumenterBuilder;
11+
import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
12+
import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
13+
import io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesExtractorBuilder;
14+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.Experimental;
15+
import io.opentelemetry.instrumentation.ratpack.v1_7.internal.RatpackServerInstrumenterBuilderFactory;
16+
import java.util.List;
17+
import java.util.Set;
18+
import java.util.function.Function;
19+
import ratpack.http.Request;
20+
import ratpack.http.Response;
21+
22+
/** A builder for {@link RatpackServerTelemetry}. */
23+
public final class RatpackServerTelemetryBuilder {
24+
25+
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.ratpack-1.7";
26+
27+
private final DefaultHttpServerInstrumenterBuilder<Request, Response> builder;
28+
29+
static {
30+
Experimental.setSetEmitExperimentalServerTelemetry(
31+
(builder, emit) -> builder.builder.setEmitExperimentalHttpServerMetrics(emit));
32+
}
33+
34+
RatpackServerTelemetryBuilder(OpenTelemetry openTelemetry) {
35+
builder = RatpackServerInstrumenterBuilderFactory.create(INSTRUMENTATION_NAME, openTelemetry);
36+
}
37+
38+
/**
39+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
40+
* items. The {@link AttributesExtractor} will be executed after all default extractors.
41+
*/
42+
@CanIgnoreReturnValue
43+
public RatpackServerTelemetryBuilder addAttributesExtractor(
44+
AttributesExtractor<? super Request, ? super Response> attributesExtractor) {
45+
builder.addAttributesExtractor(attributesExtractor);
46+
return this;
47+
}
48+
49+
/**
50+
* Configures the HTTP server request headers that will be captured as span attributes.
51+
*
52+
* @param requestHeaders A list of HTTP header names.
53+
*/
54+
@CanIgnoreReturnValue
55+
public RatpackServerTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
56+
builder.setCapturedRequestHeaders(requestHeaders);
57+
return this;
58+
}
59+
60+
/**
61+
* Configures the HTTP server response headers that will be captured as span attributes.
62+
*
63+
* @param responseHeaders A list of HTTP header names.
64+
*/
65+
@CanIgnoreReturnValue
66+
public RatpackServerTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
67+
builder.setCapturedResponseHeaders(responseHeaders);
68+
return this;
69+
}
70+
71+
/**
72+
* Configures the instrumentation to recognize an alternative set of HTTP request methods.
73+
*
74+
* <p>By default, this instrumentation defines "known" methods as the ones listed in <a
75+
* href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH
76+
* method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>.
77+
*
78+
* <p>Note: calling this method <b>overrides</b> the default known method sets completely; it does
79+
* not supplement it.
80+
*
81+
* @param knownMethods A set of recognized HTTP request methods.
82+
* @see HttpServerAttributesExtractorBuilder#setKnownMethods(Set)
83+
*/
84+
@CanIgnoreReturnValue
85+
public RatpackServerTelemetryBuilder setKnownMethods(Set<String> knownMethods) {
86+
builder.setKnownMethods(knownMethods);
87+
return this;
88+
}
89+
90+
/** Sets custom server {@link SpanNameExtractor} via transform function. */
91+
@CanIgnoreReturnValue
92+
public RatpackServerTelemetryBuilder setSpanNameExtractor(
93+
Function<SpanNameExtractor<? super Request>, ? extends SpanNameExtractor<? super Request>>
94+
serverSpanNameExtractor) {
95+
builder.setSpanNameExtractor(serverSpanNameExtractor);
96+
return this;
97+
}
98+
99+
/** Returns a new {@link RatpackServerTelemetry} with the configuration of this builder. */
100+
public RatpackServerTelemetry build() {
101+
return new RatpackServerTelemetry(builder.build());
102+
}
103+
}

0 commit comments

Comments
 (0)