feat(outbound): TCP/TLS route metrics #3355
Merged
Conversation
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
Signed-off-by: Zahari Dichev <[email protected]>
Signed-off-by: Zahari Dichev <[email protected]>
Signed-off-by: Zahari Dichev <[email protected]>
Signed-off-by: Zahari Dichev <[email protected]>
Because the opaq route mocks its selection logic, the first route returned by the API will always be used. This means that all subsequent routes are incoherent and cannot be selected. There's no value in preserving incoherent states in the proxy, so it's preferable to initially require that the control plane only returns one opaq route. This change removes some of the unused matching types and simplifies the opaq router to only handle one route.
Signed-off-by: Zahari Dichev <[email protected]>
Signed-off-by: Zahari Dichev <[email protected]>
olix0r
commented
Nov 12, 2024
There was a problem hiding this comment.
My general sense is:
- We don't want the errno changes, or anything to do with errno in the short term.
- We should use a simple 'Error' enum with expected errors ('Forbidden', 'I/O', 'Invalid', 'Unexpected', '')--we can expand this with additional variants matching against IO error codes, but we can use a bounded set rather than one that takes a numeric code.
- If we have a constrained set of errors, we should eagerly register them rather than lazily.
- I.e. we have a TcpRouteMetricsFamily that is registered against route labels in a NewService, which produces a TcpRouteMetrics with various error counters.
- My sense is that we don't gain much from the current factoring/reusability of InstrumentConnection--we may be better off having all of the metrics and labels defined in the outbound crate. I'm not sure that the middleware portion of this is particularly resusable. Given that errors are defined in the outbound crate, it probably makes sense for all of the middleware to be bound in the outbound crate. If we do want a reusable middleware, it probabably need not be prom::Counter-oriented (i.e. it could hold a trait that calls a function on
Result<(), &Error>).
This is all to try to avoid being generic in places that are not really advantageous.
Comment on lines
39
to
92
| impl<T, N, L> NewService<T> for NewInstrumentConnection<N, L> | ||
| where | ||
| N: Clone, | ||
| L: Clone, | ||
| { | ||
| type Service = InstrumentConnection<T, N, L>; | ||
|
|
||
| fn new_service(&self, target: T) -> Self::Service { | ||
| InstrumentConnection::new(target, self.inner.clone(), self.params.clone()) | ||
| } | ||
| } | ||
|
|
||
| // === impl InstrumentConnection === | ||
|
|
||
| impl<T, N, L: Clone> InstrumentConnection<T, N, L> { | ||
| fn new(target: T, inner: N, params: TcpMetricsParams<L>) -> Self { | ||
| Self { | ||
| target, | ||
| inner, | ||
| params, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<T, I, N, S, L> Service<I> for InstrumentConnection<T, N, L> | ||
| where | ||
| L: Clone + Hash + Eq + EncodeLabelSetMut + Debug + Send + Sync + 'static, | ||
| T: Clone + Send + Sync + 'static, | ||
| T: Param<L>, | ||
| I: io::AsyncRead + io::AsyncWrite + Debug + Send + Unpin + 'static, | ||
| N: NewService<T, Service = S> + Clone + Send + 'static, | ||
| S: Service<I> + Send, | ||
| S::Error: Into<Error>, | ||
| S::Future: Send, | ||
| { | ||
| type Response = S::Response; | ||
| type Error = Error; | ||
| type Future = Pin<Box<dyn Future<Output = Result<S::Response, Error>> + Send + 'static>>; | ||
|
|
||
| #[inline] | ||
| fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> { | ||
| Poll::Ready(Ok(())) | ||
| } | ||
|
|
||
| fn call(&mut self, io: I) -> Self::Future { | ||
| const ERRNO_UNKNOWN: i32 = 0; | ||
| let target = self.target.clone(); | ||
| let new_accept = self.inner.clone(); | ||
| let labels: L = target.param(); | ||
| let params = self.params.clone(); | ||
|
|
||
| Box::pin(async move { | ||
| let metrics_open = params.metrics_open(labels.clone()); | ||
| let svc = new_accept.new_service(target); |
There was a problem hiding this comment.
This should be structured such that we don't "break" the stacking--the NewService should eagerly do as much work as possible and this future should only handle registering completion metrics.
Signed-off-by: Zahari Dichev <[email protected]>
olix0r
commented
Nov 12, 2024
| let metrics = self.metrics.clone(); | ||
|
|
||
| Box::pin(async move { | ||
| let svc = new_accept.new_service(target); |
There was a problem hiding this comment.
Can't this happen in the NewService impl so that this middleware can properly proxy poll_ready()?
Signed-off-by: Zahari Dichev <[email protected]>
olix0r
commented
Nov 13, 2024
Comment on lines
219
to
223
| let inner = self.inner.clone(); | ||
|
|
||
| Box::pin(async move { | ||
| metrics.inc_open(); | ||
| match inner.oneshot(io).await.map_err(Into::into) { |
There was a problem hiding this comment.
Suggested change
| let inner = self.inner.clone(); | |
| Box::pin(async move { | |
| metrics.inc_open(); | |
| match inner.oneshot(io).await.map_err(Into::into) { | |
| metrics.inc_open(); | |
| let call = self.inner.call(io); | |
| Box::pin(async move { | |
| match call.await.map_err(Into::into) { |
The clone/oneshot invalidates the prior poll_ready -- poll_ready "reserves" us the ability to send a request. We want to use that reservation. When we clone, we invalidate that reservation. Oneshot combines waiting for a reservation and dispatching the request.
|
LGTM once we fix the service middleware. |
Signed-off-by: Zahari Dichev <[email protected]>
zaharidichev
approved these changes
Nov 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds transport level route metrics for TCP and TLS. The metrics added are:
Signed-off-by: Zahari Dichev [email protected]