-
Notifications
You must be signed in to change notification settings - Fork 42
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
base: main
Are you sure you want to change the base?
Changes from 3 commits
ec58878
d6b4d5c
42a434a
ffcdf3c
6493988
8a7a07f
adadd52
0837057
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,4 @@ | |
demo-app/local.properties | ||
.DS_Store | ||
**/build/ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
/* | ||
* Copyright The OpenTelemetry Authors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
package com.opentelemetry.android; | ||
|
||
import android.util.Log; | ||
import io.opentelemetry.sdk.common.CompletableResultCode; | ||
import io.opentelemetry.sdk.trace.data.SpanData; | ||
import io.opentelemetry.sdk.trace.export.SpanExporter; | ||
import java.time.Duration; | ||
import java.util.ArrayList; | ||
import java.util.Collection; | ||
import java.util.List; | ||
import java.util.function.Function; | ||
|
||
class BandwidthThrottlingExporter implements SpanExporter { | ||
private final SpanExporter delegate; | ||
private final Function<SpanData, String> categoryFunction; | ||
private final long maxBytesPerSecond; | ||
private final long timeWindowInMillis; | ||
private long lastExportTime; | ||
private long bytesExportedInWindow; | ||
|
||
private BandwidthThrottlingExporter(Builder builder) { | ||
this.delegate = builder.delegate; | ||
this.categoryFunction = builder.categoryFunction; | ||
this.maxBytesPerSecond = builder.maxBytesPerSecond; | ||
this.timeWindowInMillis = builder.timeWindow.toMillis(); | ||
this.lastExportTime = System.currentTimeMillis(); | ||
marandaneto marked this conversation as resolved.
Show resolved
Hide resolved
|
||
this.bytesExportedInWindow = 0; | ||
} | ||
|
||
static Builder newBuilder(SpanExporter delegate) { | ||
return new Builder(delegate); | ||
} | ||
|
||
@Override | ||
public CompletableResultCode export(Collection<SpanData> spans) { | ||
List<SpanData> spansToExport = new ArrayList<>(); | ||
long totalBytes = 0; | ||
|
||
for (SpanData span : spans) { | ||
// Estimate the size of the span (this can be adjusted based on actual size) | ||
long spanSize = estimateSpanSize(span); | ||
totalBytes += spanSize; | ||
|
||
// Check if we can export this span based on the current bandwidth limit | ||
if (canExport(spanSize)) { | ||
spansToExport.add(span); | ||
bytesExportedInWindow += spanSize; | ||
} else { | ||
Log.d("BandwidthThrottlingExporter", "Throttled span: " + span.getName()); | ||
} | ||
} | ||
|
||
return delegate.export(spansToExport); | ||
} | ||
|
||
private boolean canExport(long spanSize) { | ||
long currentTime = System.currentTimeMillis(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should use |
||
if (currentTime - lastExportTime > timeWindowInMillis) { | ||
// Reset the window | ||
bytesExportedInWindow = 0; | ||
lastExportTime = currentTime; | ||
} | ||
|
||
return (bytesExportedInWindow + spanSize) | ||
<= maxBytesPerSecond * (timeWindowInMillis / 1000); | ||
} | ||
|
||
private long estimateSpanSize(SpanData span) { | ||
// This is a placeholder for actual size estimation logic | ||
return span.getAttributes().size() * 8; // Example: 8 bytes per attribute | ||
} | ||
|
||
@Override | ||
public CompletableResultCode flush() { | ||
return delegate.flush(); | ||
} | ||
|
||
@Override | ||
public CompletableResultCode shutdown() { | ||
return delegate.shutdown(); | ||
} | ||
|
||
static class Builder { | ||
final SpanExporter delegate; | ||
Function<SpanData, String> categoryFunction = span -> "default"; | ||
long maxBytesPerSecond = 1024; // Default to 1 KB/s | ||
Duration timeWindow = Duration.ofSeconds(1); // Default to 1 second | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. my comment relates to #682 |
||
|
||
private Builder(SpanExporter delegate) { | ||
this.delegate = delegate; | ||
} | ||
|
||
Builder maxBytesPerSecond(long maxBytesPerSecond) { | ||
this.maxBytesPerSecond = maxBytesPerSecond; | ||
return this; | ||
} | ||
|
||
Builder timeWindow(Duration timeWindow) { | ||
this.timeWindow = timeWindow; | ||
return this; | ||
} | ||
|
||
BandwidthThrottlingExporter build() { | ||
return new BandwidthThrottlingExporter(this); | ||
} | ||
} | ||
} |
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 we would also need to see a unit test for this class.