-
Notifications
You must be signed in to change notification settings - Fork 1
add ability to observe deadline expiration counts #94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bjlaub
wants to merge
2
commits into
develop
Choose a base branch
from
blaub/observe-expirations
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
174 changes: 174 additions & 0 deletions
174
deadlines/src/main/java/com/palantir/deadlines/ExpirationObservation.java
This file contains hidden or 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,174 @@ | ||
| /* | ||
| * (c) Copyright 2025 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.deadlines; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.palantir.deadlines.DeadlineMetrics.Expired_Cause; | ||
| import com.palantir.deadlines.DeadlineMetrics.Expired_Intent; | ||
| import com.palantir.tritium.metrics.registry.SharedTaggedMetricRegistries; | ||
|
|
||
| /** | ||
| * Provides the ability to observe the number of deadline expirations that happen between points in time. | ||
| * <p/> | ||
| * Usage example: | ||
| * <pre> | ||
| * ExpirationObservation start = ExpirationObservation.start(); | ||
| * // ... operation that may cause deadline expiration ... | ||
| * ExpirationObservation end = start.observeFrom(); | ||
| * if (end.totalExpirations() > 0) { | ||
| * // at least one deadline expiration happened | ||
| * } | ||
| * </pre> | ||
| * | ||
| * Calling {@link #start()} will create a new observation with no recorded expirations. | ||
| * | ||
| * Calling {@link #observeFrom()} will return an observation comparing the current point in time to the count of | ||
| * expirations when the original observation was created. | ||
| * | ||
| * Calling {@link #totalExpirations()} will return the number of deadline expirations that occurred | ||
| * between two observations. | ||
| */ | ||
| public final class ExpirationObservation { | ||
|
|
||
| private static final DeadlineMetrics metrics = DeadlineMetrics.of(SharedTaggedMetricRegistries.getSingleton()); | ||
|
|
||
| private final MeterValues start; | ||
| private final MeterValues end; | ||
|
|
||
| private ExpirationObservation(MeterValues start, MeterValues end) { | ||
| this.start = start; | ||
| this.end = end; | ||
| } | ||
|
|
||
| /** | ||
| * Begin a new observation. | ||
| */ | ||
| public static ExpirationObservation start() { | ||
| MeterValues now = readMeters(); | ||
| return new ExpirationObservation(now, now); | ||
| } | ||
|
|
||
| /** | ||
| * Return a new observation with the number of deadline expirations that have occurred since this observation was | ||
| * initialized. | ||
| * | ||
| * The current observation should have been previously initialized either via a call to this method, or | ||
| * a call to {@link #start()}, | ||
| */ | ||
| public ExpirationObservation observeFrom() { | ||
| MeterValues now = readMeters(); | ||
| return new ExpirationObservation(end, now); | ||
| } | ||
|
|
||
| /** | ||
| * Return the total number of expirations that have occurred since this observation was initialized. | ||
| */ | ||
| public long totalExpirations() { | ||
| return nExternalPropagate() | ||
| + nExternalPropagateAlreadyExpired() | ||
| + nExternalIgnore() | ||
| + nInternalPropagate() | ||
| + nInternalPropagateAlreadyExpired() | ||
| + nInternalIgnore(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long totalWithExternalCause() { | ||
| return nExternalPropagate() + nExternalPropagateAlreadyExpired() + nExternalIgnore(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long totalWithInternalCause() { | ||
| return nInternalPropagate() + nInternalPropagateAlreadyExpired() + nInternalIgnore(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long totalWithPropagateIntent() { | ||
| return nExternalPropagate() + nInternalPropagate(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long totalWithPropagateAlreadyExpiredIntent() { | ||
| return nExternalPropagateAlreadyExpired() + nInternalPropagateAlreadyExpired(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long totalWithIgnoreIntent() { | ||
| return nExternalIgnore() + nInternalIgnore(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long nExternalPropagate() { | ||
| return end.externalPropagate - start.externalPropagate; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long nExternalPropagateAlreadyExpired() { | ||
| return end.externalPropagateAlreadyExpired - start.externalPropagateAlreadyExpired; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long nExternalIgnore() { | ||
| return end.externalIgnore - start.externalIgnore; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long nInternalPropagate() { | ||
| return end.internalPropagate - start.internalPropagate; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long nInternalPropagateAlreadyExpired() { | ||
| return end.internalPropagateAlreadyExpired - start.internalPropagateAlreadyExpired; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| long nInternalIgnore() { | ||
| return end.internalIgnore - start.internalIgnore; | ||
| } | ||
|
|
||
| private static MeterValues readMeters() { | ||
| long externalPropagate = getCountFor(Expired_Cause.EXTERNAL, Expired_Intent.PROPAGATE); | ||
| long externalPropagateAlreadyExpired = | ||
| getCountFor(Expired_Cause.EXTERNAL, Expired_Intent.PROPAGATE_ALREADY_EXPIRED); | ||
| long externalIgnore = getCountFor(Expired_Cause.EXTERNAL, Expired_Intent.IGNORE); | ||
| long internalPropagate = getCountFor(Expired_Cause.INTERNAL, Expired_Intent.PROPAGATE); | ||
| long internalPropagateAlreadyExpired = | ||
| getCountFor(Expired_Cause.INTERNAL, Expired_Intent.PROPAGATE_ALREADY_EXPIRED); | ||
| long internalIgnore = getCountFor(Expired_Cause.INTERNAL, Expired_Intent.IGNORE); | ||
|
|
||
| return new MeterValues( | ||
| externalPropagate, | ||
| externalPropagateAlreadyExpired, | ||
| externalIgnore, | ||
| internalPropagate, | ||
| internalPropagateAlreadyExpired, | ||
| internalIgnore); | ||
| } | ||
|
|
||
| private static long getCountFor(Expired_Cause cause, Expired_Intent intent) { | ||
| return metrics.expired().cause(cause).intent(intent).build().getCount(); | ||
| } | ||
|
|
||
| private record MeterValues( | ||
| long externalPropagate, | ||
| long externalPropagateAlreadyExpired, | ||
| long externalIgnore, | ||
| long internalPropagate, | ||
| long internalPropagateAlreadyExpired, | ||
| long internalIgnore) {} | ||
| } | ||
This file contains hidden or 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
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 could make this (or all of these) public to allow consumers to e.g. observe when a deadline expiration would throw an exception if enforcement is enabled.
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.
What are your thoughts on something like #95? I think it's a bit simpler: I'm proposing we just expose the deadline metric values and provide a small utility to compute diffs between the metric value observations.