Skip to content

Commit e03e83c

Browse files
trasktrask
committed
Split ratpack into client and server
1 parent 4af0dd5 commit e03e83c

15 files changed

+611
-72
lines changed

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

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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.OpenTelemetryHttpClient;
12+
import ratpack.http.client.HttpClient;
13+
import ratpack.http.client.HttpResponse;
14+
import ratpack.http.client.RequestSpec;
15+
import ratpack.registry.RegistrySpec;
16+
17+
/**
18+
* Entrypoint for instrumenting Ratpack http client.
19+
*
20+
* <p>To apply OpenTelemetry instrumentation to a http client, wrap the {@link HttpClient} using
21+
* {@link #instrument(HttpClient)}.
22+
*
23+
* <pre>{@code
24+
* RatpackClientTelemetry telemetry = RatpackClientTelemetry.create(OpenTelemetrySdk.builder()
25+
* ...
26+
* .build());
27+
* HttpClient instrumentedHttpClient = telemetry.instrument(httpClient);
28+
* }</pre>
29+
*/
30+
public final class RatpackClientTelemetry {
31+
32+
/**
33+
* Returns a new {@link RatpackClientTelemetry} configured with the given {@link OpenTelemetry}.
34+
*/
35+
public static RatpackClientTelemetry create(OpenTelemetry openTelemetry) {
36+
return builder(openTelemetry).build();
37+
}
38+
39+
/**
40+
* Returns a new {@link RatpackClientTelemetryBuilder} configured with the given {@link
41+
* OpenTelemetry}.
42+
*/
43+
public static RatpackClientTelemetryBuilder builder(OpenTelemetry openTelemetry) {
44+
return new RatpackClientTelemetryBuilder(openTelemetry);
45+
}
46+
47+
private final OpenTelemetryHttpClient httpClientInstrumenter;
48+
49+
RatpackClientTelemetry(Instrumenter<RequestSpec, HttpResponse> clientInstrumenter) {
50+
httpClientInstrumenter = new OpenTelemetryHttpClient(clientInstrumenter);
51+
}
52+
53+
/** Returns instrumented instance of {@link HttpClient} with OpenTelemetry. */
54+
public HttpClient instrument(HttpClient httpClient) throws Exception {
55+
return httpClientInstrumenter.instrument(httpClient);
56+
}
57+
58+
/** Configures the {@link RegistrySpec} with OpenTelemetry. */
59+
public void configureRegistry(RegistrySpec registry) {
60+
registry.add(OpenTelemetryExecInitializer.INSTANCE);
61+
}
62+
}

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

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
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> clientBuilder;
28+
29+
RatpackClientTelemetryBuilder(OpenTelemetry openTelemetry) {
30+
clientBuilder =
31+
RatpackClientInstrumenterBuilderFactory.create(INSTRUMENTATION_NAME, openTelemetry);
32+
}
33+
34+
@CanIgnoreReturnValue
35+
public RatpackClientTelemetryBuilder addAttributeExtractor(
36+
AttributesExtractor<? super RequestSpec, ? super HttpResponse> attributesExtractor) {
37+
clientBuilder.addAttributeExtractor(attributesExtractor);
38+
return this;
39+
}
40+
41+
/**
42+
* Configures the HTTP client request headers that will be captured as span attributes.
43+
*
44+
* @param requestHeaders A list of HTTP header names.
45+
*/
46+
@CanIgnoreReturnValue
47+
public RatpackClientTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
48+
clientBuilder.setCapturedRequestHeaders(requestHeaders);
49+
return this;
50+
}
51+
52+
/**
53+
* Configures the HTTP client response headers that will be captured as span attributes.
54+
*
55+
* @param responseHeaders A list of HTTP header names.
56+
*/
57+
@CanIgnoreReturnValue
58+
public RatpackClientTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
59+
clientBuilder.setCapturedResponseHeaders(responseHeaders);
60+
return this;
61+
}
62+
63+
/**
64+
* Configures the instrumentation to recognize an alternative set of HTTP request methods.
65+
*
66+
* <p>By default, this instrumentation defines "known" methods as the ones listed in <a
67+
* href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH
68+
* method defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>.
69+
*
70+
* <p>Note: calling this method <b>overrides</b> the default known method sets completely; it does
71+
* not supplement it.
72+
*
73+
* @param knownMethods A set of recognized HTTP request methods.
74+
* @see HttpClientAttributesExtractorBuilder#setKnownMethods(Set)
75+
*/
76+
@CanIgnoreReturnValue
77+
public RatpackClientTelemetryBuilder setKnownMethods(Set<String> knownMethods) {
78+
clientBuilder.setKnownMethods(knownMethods);
79+
return this;
80+
}
81+
82+
/** Sets custom client {@link SpanNameExtractor} via transform function. */
83+
@CanIgnoreReturnValue
84+
public RatpackClientTelemetryBuilder setSpanNameExtractor(
85+
Function<
86+
SpanNameExtractor<? super RequestSpec>,
87+
? extends SpanNameExtractor<? super RequestSpec>>
88+
clientSpanNameExtractor) {
89+
clientBuilder.setSpanNameExtractor(clientSpanNameExtractor);
90+
return this;
91+
}
92+
93+
/**
94+
* Can be used via the unstable method {@link
95+
* Experimental#setEmitExperimentalHttpClientMetrics(RatpackClientTelemetryBuilder, boolean)}.
96+
*/
97+
void setEmitExperimentalHttpClientMetrics(boolean emitExperimentalHttpClientMetrics) {
98+
clientBuilder.setEmitExperimentalHttpClientMetrics(emitExperimentalHttpClientMetrics);
99+
}
100+
101+
/** Returns a new {@link RatpackClientTelemetry} with the configuration of this builder. */
102+
public RatpackClientTelemetry build() {
103+
return new RatpackClientTelemetry(clientBuilder.build());
104+
}
105+
}

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

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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+
}
80+
}

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

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
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> serverBuilder;
28+
29+
RatpackServerTelemetryBuilder(OpenTelemetry openTelemetry) {
30+
serverBuilder =
31+
RatpackServerInstrumenterBuilderFactory.create(INSTRUMENTATION_NAME, openTelemetry);
32+
}
33+
34+
/**
35+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
36+
* items. The {@link AttributesExtractor} will be executed after all default extractors.
37+
*/
38+
@CanIgnoreReturnValue
39+
public RatpackServerTelemetryBuilder addAttributeExtractor(
40+
AttributesExtractor<? super Request, ? super Response> attributesExtractor) {
41+
serverBuilder.addAttributesExtractor(attributesExtractor);
42+
return this;
43+
}
44+
45+
/**
46+
* Configures the HTTP server request headers that will be captured as span attributes.
47+
*
48+
* @param requestHeaders A list of HTTP header names.
49+
*/
50+
@CanIgnoreReturnValue
51+
public RatpackServerTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
52+
serverBuilder.setCapturedRequestHeaders(requestHeaders);
53+
return this;
54+
}
55+
56+
/**
57+
* Configures the HTTP server response headers that will be captured as span attributes.
58+
*
59+
* @param responseHeaders A list of HTTP header names.
60+
*/
61+
@CanIgnoreReturnValue
62+
public RatpackServerTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
63+
serverBuilder.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 HttpServerAttributesExtractorBuilder#setKnownMethods(Set)
79+
*/
80+
@CanIgnoreReturnValue
81+
public RatpackServerTelemetryBuilder setKnownMethods(Set<String> knownMethods) {
82+
serverBuilder.setKnownMethods(knownMethods);
83+
return this;
84+
}
85+
86+
/** Sets custom server {@link SpanNameExtractor} via transform function. */
87+
@CanIgnoreReturnValue
88+
public RatpackServerTelemetryBuilder setSpanNameExtractor(
89+
Function<SpanNameExtractor<? super Request>, ? extends SpanNameExtractor<? super Request>>
90+
serverSpanNameExtractor) {
91+
serverBuilder.setSpanNameExtractor(serverSpanNameExtractor);
92+
return this;
93+
}
94+
95+
/**
96+
* Can be used via the unstable method {@link
97+
* Experimental#setEmitExperimentalHttpServerMetrics(RatpackServerTelemetryBuilder, boolean)}.
98+
*/
99+
void setEmitExperimentalHttpServerMetrics(boolean emitExperimentalHttpServerMetrics) {
100+
serverBuilder.setEmitExperimentalHttpServerMetrics(emitExperimentalHttpServerMetrics);
101+
}
102+
103+
/** Returns a new {@link RatpackServerTelemetry} with the configuration of this builder. */
104+
public RatpackServerTelemetry build() {
105+
return new RatpackServerTelemetry(serverBuilder.build());
106+
}
107+
}

0 commit comments

Comments
 (0)