Skip to content
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

Add ability to throttle exports when reading from disk. #663

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Victorsesan
Copy link

Added an implementation which provides a flexible way to manage bandwidth usage when exporting spans, allowing for smoother data flow and preventing resource hogging. It can further refine the size estimation logic based on a specific use case.
Relate to #638

Victorsesan and others added 3 commits October 27, 2024 03:16
…idth usage when exporting spans, allowing for smoother data flow and preventing resource hogging. It can further refine the size estimation logic based on a specific use case.
…idth usage when exporting spans, allowing for smoother data flow and preventing resource hogging. It can further refine the size estimation logic based on a specific use case.

Relate to Add ability to throttle exports when reading from disk. open-telemetry#638
@Victorsesan Victorsesan requested a review from a team as a code owner October 27, 2024 02:57
Comment on lines 90 to 92
Function<SpanData, String> categoryFunction = span -> "default";
long maxBytesPerSecond = 1024; // Default to 1 KB/s
Duration timeWindow = Duration.ofSeconds(1); // Default to 1 second
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function and Duration require newer APIs (24 and 26), most likely not a problem tho since we require desugaring right?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right! Thank you for pointing it out, I had figured we already had desugaring configured which is why i added them. However i think they're very essential to use and we should have desugaring configured regardless to make them work as expected. I have opened another PR with the needed config and changes, let me know what you think. Thanks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

desugaring has to be configured in the hosting app, see note in the readme
I think if its fine if we are using the Duration and Function elsewhere in the SDK, are we?

Copy link
Member

@marandaneto marandaneto Nov 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my comment relates to #682

core/build.gradle.kts Outdated Show resolved Hide resolved
…nterface and Duration with a plain long value for timeWindowInMillis

 ref open-telemetry#638
@@ -0,0 +1,3 @@
{
"java.configuration.updateBuildConfiguration": "automatic"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep the IDE specific configurations out of the repo please.

import java.util.List;
import java.util.function.Function;

class BandwidthThrottlingExporter implements SpanExporter {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we would also need to see a unit test for this class.

Ref: Add ability to throttle exports when reading from disk. open-telemetry#638
}

private boolean canExport(long spanSize) {
long currentTime = System.currentTimeMillis();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should use SystemTime.get().getCurrentTimeMillis(); as well

Comment on lines 89 to 92
final SpanExporter delegate;
CategoryFunction categoryFunction = span -> "default";
long maxBytesPerSecond = 1024; // Default to 1 KB/s
long timeWindowInMillis = 1000; // Default to 1 second
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should they be private since they have a setter anyway (using the builder pattern)?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the fields are intended to be set only through the builder methods i have tried to add and make them private so they can only be modified through it's provided builder methods. I'm sure it will help enhance encapsulation and help maintain the integrity of it's object's state.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants