-
Notifications
You must be signed in to change notification settings - Fork 73
Add ability to throttle exports when reading from disk. #663
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
Victorsesan
wants to merge
8
commits into
open-telemetry:main
Choose a base branch
from
Victorsesan:main
base: main
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 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ec58878
Added an implementation which provides a flexible way to manage bandw…
Victorsesan d6b4d5c
Added an implementation which provides a flexible way to manage bandw…
Victorsesan 42a434a
Merge branch 'open-telemetry:main' into main
Victorsesan ffcdf3c
Fix comments
Victorsesan 6493988
replaced Function<SpanData, String> with a custom CategoryFunction i…
Victorsesan 8a7a07f
JUnit4 test for BandwidthThrottlingExporter
Victorsesan adadd52
Fix comments
Victorsesan 0837057
Fix comments
Victorsesan 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
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 |
---|---|---|
|
@@ -4,3 +4,4 @@ | |
demo-app/local.properties | ||
.DS_Store | ||
**/build/ | ||
|
112 changes: 112 additions & 0 deletions
112
core/src/main/java/io/opentelemetry/android/export/RateLimitedExporter.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,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.
Outdated
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(); | ||||||
marandaneto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
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; | ||||||
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.
Suggested change
|
||||||
Function<SpanData, String> categoryFunction = span -> "default"; | ||||||
long maxBytesPerSecond = 1024; // Default to 1 KB/s | ||||||
Duration timeWindow = Duration.ofSeconds(1); // Default to 1 second | ||||||
marandaneto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
||||||
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); | ||||||
} | ||||||
} | ||||||
} |
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.
Uh oh!
There was an error while loading. Please reload this page.