Add client request size metric channel #2023
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| type: feature | ||
| feature: | ||
| description: Add a request size metric channel, which records the size of payloads | ||
| written by the client. | ||
| links: | ||
| - https://github.com/palantir/dialogue/pull/2023 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| * (c) Copyright 2023 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.palantir.dialogue.core; | ||
|
|
||
| import com.codahale.metrics.Histogram; | ||
| import com.google.common.base.Suppliers; | ||
| import com.google.common.io.CountingOutputStream; | ||
| import com.google.common.util.concurrent.ListenableFuture; | ||
| import com.palantir.conjure.java.client.config.ClientConfiguration; | ||
| import com.palantir.dialogue.Endpoint; | ||
| import com.palantir.dialogue.EndpointChannel; | ||
| import com.palantir.dialogue.Request; | ||
| import com.palantir.dialogue.RequestBody; | ||
| import com.palantir.dialogue.Response; | ||
| import com.palantir.dialogue.core.DialogueClientMetrics.RequestsSize_Repeatable; | ||
| import com.palantir.logsafe.logger.SafeLogger; | ||
| import com.palantir.logsafe.logger.SafeLoggerFactory; | ||
| import com.palantir.tritium.metrics.registry.TaggedMetricRegistry; | ||
| import java.io.IOException; | ||
| import java.io.OutputStream; | ||
| import java.util.Optional; | ||
| import java.util.OptionalLong; | ||
| import java.util.function.Supplier; | ||
|
|
||
| final class RequestSizeMetricsChannel implements EndpointChannel { | ||
| private static final SafeLogger log = SafeLoggerFactory.get(RequestSizeMetricsChannel.class); | ||
| // MIN_REPORTED_REQUEST_SIZE filters recording small requests to reduce metric cardinality | ||
| private static final long MIN_REPORTED_REQUEST_SIZE = 1 << 20; | ||
| private final EndpointChannel delegate; | ||
| private final Supplier<Histogram> repeatableRequestSize; | ||
| private final Supplier<Histogram> unrepeatableRequestSize; | ||
|
|
||
| static EndpointChannel create(Config cf, EndpointChannel channel, Endpoint endpoint) { | ||
|
There was a problem hiding this comment. We'll need to wire this up from There was a problem hiding this comment. Yep! wasn't sure if we'd want to do that separately or not, and also wasn't sure where in the chain to add this... maybe alongside the timing endpoint channel? There was a problem hiding this comment. Hmm, the timing endpoint channel is in a conditional to protect against an edge case where clients may arbitrarily build new We'll need to restructure a bit of the code to avoid creating a histogram until we've seen a large request for the first time (which is impossible-ish on GET endpoints, and many PUTs/POSTs will never reach it) by creating a memoized supplier for the histogram rather than passing the histogram directly. Setting a threshold improves the probability of capturing maximums as well, since we use a sampling reservoir, we only hold ~1024 samples at a given time (with heavy recency bias), so reducing small and uninteresting samples will increase the probability we capture outliers. |
||
| ClientConfiguration clientConf = cf.clientConf(); | ||
| return new RequestSizeMetricsChannel(channel, cf.channelName(), endpoint, clientConf.taggedMetricRegistry()); | ||
| } | ||
|
|
||
| RequestSizeMetricsChannel( | ||
| EndpointChannel delegate, String channelName, Endpoint endpoint, TaggedMetricRegistry registry) { | ||
| this.delegate = delegate; | ||
| DialogueClientMetrics dialogueClientMetrics = DialogueClientMetrics.of(registry); | ||
| this.repeatableRequestSize = Suppliers.memoize(() -> dialogueClientMetrics | ||
| .requestsSize() | ||
| .repeatable(RequestsSize_Repeatable.TRUE) | ||
| .channelName(channelName) | ||
| .serviceName(endpoint.serviceName()) | ||
| .endpoint(endpoint.endpointName()) | ||
| .build()); | ||
| this.unrepeatableRequestSize = Suppliers.memoize(() -> dialogueClientMetrics | ||
| .requestsSize() | ||
| .repeatable(RequestsSize_Repeatable.FALSE) | ||
| .channelName(channelName) | ||
| .serviceName(endpoint.serviceName()) | ||
| .endpoint(endpoint.endpointName()) | ||
| .build()); | ||
| } | ||
|
|
||
| @Override | ||
| public ListenableFuture<Response> execute(Request request) { | ||
| Request augmentedRequest = wrap(request); | ||
| return delegate.execute(augmentedRequest); | ||
| } | ||
|
|
||
| private Request wrap(Request request) { | ||
| Optional<RequestBody> body = request.body(); | ||
| if (body.isEmpty()) { | ||
| // No need to record empty bodies | ||
| return request; | ||
| } | ||
|
Comment on lines
+80
to
+83
There was a problem hiding this comment. Currently this will record metrics for both requests which can and cannot be retried, without distinction. Should we tag metrics based on whether or not retires are allowed? (we could hold two histograms and pass the correct one to |
||
| Supplier<Histogram> requestSizeHistogram = | ||
| body.get().repeatable() ? this.repeatableRequestSize : this.unrepeatableRequestSize; | ||
|
|
||
| return Request.builder() | ||
| .from(request) | ||
| .body(new RequestSizeRecordingRequestBody(body.get(), requestSizeHistogram)) | ||
| .build(); | ||
| } | ||
|
|
||
| private static class RequestSizeRecordingRequestBody implements RequestBody { | ||
| private final RequestBody delegate; | ||
| private final Supplier<Histogram> size; | ||
|
|
||
| RequestSizeRecordingRequestBody(RequestBody requestBody, Supplier<Histogram> size) { | ||
| this.delegate = requestBody; | ||
| this.size = size; | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(OutputStream output) throws IOException { | ||
| CountingOutputStream countingOut = new CountingOutputStream(output); | ||
| delegate.writeTo(countingOut); | ||
| if (countingOut.getCount() > MIN_REPORTED_REQUEST_SIZE) { | ||
| size.get().update(countingOut.getCount()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
|
There was a problem hiding this comment. We need to override and pass through the |
||
| public String contentType() { | ||
| return delegate.contentType(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean repeatable() { | ||
| return delegate.repeatable(); | ||
| } | ||
|
|
||
| @Override | ||
| public OptionalLong contentLength() { | ||
| return delegate.contentLength(); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| delegate.close(); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /* | ||
| * (c) Copyright 2023 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.palantir.dialogue.core; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import com.codahale.metrics.Snapshot; | ||
| import com.google.common.io.ByteStreams; | ||
| import com.google.common.util.concurrent.Futures; | ||
| import com.google.common.util.concurrent.ListenableFuture; | ||
| import com.palantir.conjure.java.client.config.ClientConfiguration; | ||
| import com.palantir.dialogue.EndpointChannel; | ||
| import com.palantir.dialogue.Request; | ||
| import com.palantir.dialogue.RequestBody; | ||
| import com.palantir.dialogue.Response; | ||
| import com.palantir.dialogue.TestConfigurations; | ||
| import com.palantir.dialogue.TestEndpoint; | ||
| import com.palantir.dialogue.TestResponse; | ||
| import com.palantir.dialogue.core.DialogueClientMetrics.RequestsSize_Repeatable; | ||
| import com.palantir.tritium.metrics.registry.DefaultTaggedMetricRegistry; | ||
| import com.palantir.tritium.metrics.registry.MetricName; | ||
| import com.palantir.tritium.metrics.registry.TaggedMetricRegistry; | ||
| import java.io.IOException; | ||
| import java.io.OutputStream; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.OptionalLong; | ||
| import java.util.concurrent.ExecutionException; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class RequestSizeMetricsChannelTest { | ||
|
|
||
| private static final DialogueChannelFactory STUB_FACTORY = _ignored -> { | ||
| throw new AssertionError("DialogueChannelFactory should not be used"); | ||
| }; | ||
|
|
||
| @Test | ||
| public void records_request_size_metrics() throws ExecutionException, InterruptedException { | ||
| TaggedMetricRegistry registry = new DefaultTaggedMetricRegistry(); | ||
|
|
||
| int recordableRequestSize = 2 << 20; | ||
| byte[] expected = "a".repeat(recordableRequestSize).getBytes(StandardCharsets.UTF_8); | ||
| Request request = Request.builder() | ||
| .body(new RequestBody() { | ||
| @Override | ||
| public void writeTo(OutputStream output) throws IOException { | ||
| output.write(expected); | ||
| } | ||
|
|
||
| @Override | ||
| public String contentType() { | ||
| return "text/plain"; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean repeatable() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public OptionalLong contentLength() { | ||
| return OptionalLong.of(expected.length); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() {} | ||
| }) | ||
| .build(); | ||
|
|
||
| EndpointChannel channel = RequestSizeMetricsChannel.create( | ||
| ImmutableConfig.builder() | ||
| .channelName("channelName") | ||
| .channelFactory(STUB_FACTORY) | ||
| .rawConfig(ClientConfiguration.builder() | ||
| .from(TestConfigurations.create("https://foo:10001")) | ||
| .taggedMetricRegistry(registry) | ||
| .build()) | ||
| .build(), | ||
| r -> { | ||
| try (RequestBody body = r.body().get()) { | ||
| body.writeTo(ByteStreams.nullOutputStream()); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| return Futures.immediateFuture(new TestResponse().code(200)); | ||
| }, | ||
| TestEndpoint.GET); | ||
| ListenableFuture<Response> response = channel.execute(request); | ||
|
|
||
| assertThat(response.get().code()).isEqualTo(200); | ||
| Snapshot snapshot = DialogueClientMetrics.of(registry) | ||
| .requestsSize() | ||
| .repeatable(RequestsSize_Repeatable.TRUE) | ||
| .channelName("channelName") | ||
| .serviceName("service") | ||
| .endpoint("endpoint") | ||
| .build() | ||
| .getSnapshot(); | ||
| assertThat(snapshot.size()).isEqualTo(1); | ||
| assertThat(snapshot.get99thPercentile()).isEqualTo(expected.length); | ||
| } | ||
|
|
||
| @Test | ||
| public void small_request_not_recorded() throws ExecutionException, InterruptedException { | ||
| TaggedMetricRegistry registry = new DefaultTaggedMetricRegistry(); | ||
|
|
||
| byte[] expected = "test request body".getBytes(StandardCharsets.UTF_8); | ||
| Request request = Request.builder() | ||
| .body(new RequestBody() { | ||
| @Override | ||
| public void writeTo(OutputStream output) throws IOException { | ||
| output.write(expected); | ||
| } | ||
|
|
||
| @Override | ||
| public String contentType() { | ||
| return "text/plain"; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean repeatable() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public OptionalLong contentLength() { | ||
| return OptionalLong.of(expected.length); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() {} | ||
| }) | ||
| .build(); | ||
|
|
||
| EndpointChannel channel = RequestSizeMetricsChannel.create( | ||
| ImmutableConfig.builder() | ||
| .channelName("smallRequestChannelName") | ||
| .channelFactory(STUB_FACTORY) | ||
| .rawConfig(ClientConfiguration.builder() | ||
| .from(TestConfigurations.create("https://foo:10001")) | ||
| .taggedMetricRegistry(registry) | ||
| .build()) | ||
| .build(), | ||
| r -> { | ||
| try (RequestBody body = r.body().get()) { | ||
| body.writeTo(ByteStreams.nullOutputStream()); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
andybradshaw marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return Futures.immediateFuture(new TestResponse().code(200)); | ||
| }, | ||
| TestEndpoint.GET); | ||
| ListenableFuture<Response> response = channel.execute(request); | ||
|
|
||
| assertThat(response.get().code()).isEqualTo(200); | ||
| MetricName metricName = DialogueClientMetrics.of(registry) | ||
| .requestsSize() | ||
| .repeatable(RequestsSize_Repeatable.TRUE) | ||
| .channelName("smallRequestChannelName") | ||
| .serviceName("service") | ||
| .endpoint("endpoint") | ||
| .buildMetricName(); | ||
| assertThat(registry.remove(metricName)).isEmpty(); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We may want to describe the reporting size threshold in this metric description (though I suppose it doesn't claim to report the size of every request ;-)
Can update the the metric-schema/docs later if needs be.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated! Yeah, good to call this out... might even be worth renaming the metric to
large_requestsor something to explicitly call out that there's some distinction/threshold that's used for it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the current name gives us flexibility if we want to change thresholds later on, I don't mind it as is if you're happy with it. Thanks for updating!