feat(profiling): Drop profiler ids from spans no profile covers #6015
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
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
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
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 |
|---|---|---|
|
|
@@ -23,9 +23,11 @@ | |
| import io.sentry.SentryNanotimeDate; | ||
| import io.sentry.SentryOptions; | ||
| import io.sentry.TracesSampler; | ||
| import io.sentry.android.core.internal.profiling.ChunkRecord; | ||
| import io.sentry.android.core.internal.util.SentryFrameMetricsCollector; | ||
| import io.sentry.profilemeasurements.ProfileMeasurement; | ||
| import io.sentry.profilemeasurements.ProfileMeasurementValue; | ||
| import io.sentry.profiling.ProfileRecordingState; | ||
| import io.sentry.protocol.SentryId; | ||
| import io.sentry.transport.RateLimiter; | ||
| import io.sentry.util.AutoClosableReentrantLock; | ||
|
|
@@ -59,18 +61,28 @@ | |
| * <p>Currently, this class doesn't do app-start profiling {@link SentryPerformanceProvider}. It is | ||
| * created during {@code Sentry.init()}. | ||
| * | ||
| * <p>Thread safety: the profiler state is guarded by {@link #lock}. Every public entry point | ||
| * acquires it itself and is thread-safe. Private methods that say {@code Caller must hold} a lock | ||
| * do not, and must only be reached from a frame that already holds it. | ||
| * | ||
| * <p>The chunk history is guarded by its own {@link #chunkHistoryLock}, so that {@link | ||
| * #getProfileRecordingState} — called for every span of a finishing transaction — never waits for a | ||
| * chunk start or a chunk stop. A frame holding {@link #lock} may take {@link #chunkHistoryLock}, | ||
| * never the other way around. Each {@link ChunkRecord} guards its own state, as the profiler writes | ||
| * the outcome of a running chunk into it. | ||
| */ | ||
| @ApiStatus.Internal | ||
| @RequiresApi(api = Build.VERSION_CODES.VANILLA_ICE_CREAM) | ||
| public class PerfettoContinuousProfiler | ||
| implements IContinuousProfiler, RateLimiter.IRateLimitObserver { | ||
| private static final long MAX_CHUNK_DURATION_MILLIS = 60000; | ||
|
|
||
| /** | ||
| * How many chunks we remember the outcome of. Spans only ask about windows they were running in, | ||
| * so a handful of chunks (a minute each) is plenty. | ||
| */ | ||
| @VisibleForTesting static final int MAX_CHUNK_HISTORY_SIZE = 10; | ||
|
|
||
| // Matches the thread name produced by SentryExecutorService's thread factory, used to detect | ||
| // when we are already running on the executor thread. | ||
| private static final String EXECUTOR_THREAD_NAME_PREFIX = "SentryExecutorServiceThreadFactory"; | ||
|
|
@@ -96,6 +108,11 @@ public class PerfettoContinuousProfiler | |
|
|
||
| private final AutoClosableReentrantLock lock = new AutoClosableReentrantLock(); | ||
|
|
||
| private final @NotNull ArrayDeque<ChunkRecord> chunkHistory = | ||
| new ArrayDeque<>(MAX_CHUNK_HISTORY_SIZE); | ||
|
|
||
| private final AutoClosableReentrantLock chunkHistoryLock = new AutoClosableReentrantLock(); | ||
|
|
||
| public PerfettoContinuousProfiler( | ||
| final @NotNull ILogger logger, | ||
| final @NotNull SentryFrameMetricsCollector frameMetricsCollector, | ||
|
|
@@ -188,6 +205,8 @@ public void close(final boolean isTerminating) { | |
| if (isTerminating) { | ||
| stopInternal(false); | ||
| isClosed.set(true); | ||
| // sendChunk drops everything once isClosed is set, so the chunk that just ended is lost | ||
| markLastChunkNotRecordedIfUnknown(); | ||
|
There was a problem hiding this comment. Close marks recorded chunks that never sendMedium Severity
Additional Locations (2)  Reviewed by Cursor Bugbot for commit 07e9b69. Configure here.
Member
There was a problem hiding this comment. Looks like this one's worth fixing. PerfettoContinuousProfiler.close(true) has two jobs: stop the current profiling chunk and mark the profiler as closed so no more chunks are sent. But those two decisions are ordered in a way that lets one callback observe the old state and another step observe the new state, meaning a chunk can be marked as recorded in history even though shutdown guarantees it will never be sent. |
||
| } | ||
| } | ||
| } | ||
|
|
@@ -213,6 +232,78 @@ public boolean isRunning() { | |
| } | ||
| } | ||
|
|
||
| @Override | ||
| public @NotNull ProfileRecordingState getProfileRecordingState( | ||
| final @NotNull SentryId profilerId, | ||
| final @NotNull SentryDate startTime, | ||
| final @NotNull SentryDate endTime) { | ||
| try (final @NotNull ISentryLifecycleToken ignored = chunkHistoryLock.acquire()) { | ||
| if (chunkHistory.isEmpty()) { | ||
| return ProfileRecordingState.UNKNOWN; | ||
| } | ||
|
|
||
| boolean hasUnknownChunk = false; | ||
|
|
||
| for (final @NotNull ChunkRecord chunk : chunkHistory) { | ||
| if (!chunk.getProfilerId().equals(profilerId) || !chunk.overlaps(startTime, endTime)) { | ||
| continue; | ||
| } | ||
| final @NotNull ProfileRecordingState state = chunk.getRecordingState(); | ||
| if (state == ProfileRecordingState.RECORDED) { | ||
| return ProfileRecordingState.RECORDED; | ||
|
markushi marked this conversation as resolved.
|
||
| } | ||
| if (state == ProfileRecordingState.UNKNOWN) { | ||
| hasUnknownChunk = true; | ||
| } | ||
| } | ||
|
|
||
| // A chunk that is still running, or that is still being collected, may yet be recorded | ||
| if (hasUnknownChunk) { | ||
| return ProfileRecordingState.UNKNOWN; | ||
| } | ||
|
|
||
| // Every chunk overlapping the window failed, or no chunk ran during the window at all | ||
| return ProfileRecordingState.NOT_RECORDED; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Gives up on the newest chunk, unless its outcome is already known. Only that one can still be | ||
| * unknown, as a chunk gets its outcome before the next one starts. | ||
| */ | ||
| private void markLastChunkNotRecordedIfUnknown() { | ||
| try (final @NotNull ISentryLifecycleToken ignored = chunkHistoryLock.acquire()) { | ||
| final @Nullable ChunkRecord lastChunk = chunkHistory.peekLast(); | ||
| if (lastChunk != null && lastChunk.getRecordingState() == ProfileRecordingState.UNKNOWN) { | ||
| lastChunk.setRecordingState(ProfileRecordingState.NOT_RECORDED); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void addChunkRecord(final @NotNull ChunkRecord chunk) { | ||
| try (final @NotNull ISentryLifecycleToken ignored = chunkHistoryLock.acquire()) { | ||
| if (chunkHistory.size() == MAX_CHUNK_HISTORY_SIZE) { | ||
| chunkHistory.removeFirst(); | ||
| } | ||
| chunkHistory.addLast(chunk); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Ends the running chunk, which is always the newest one, as a chunk only starts once the one | ||
| * before it ended. Returns null if there is none, or if it already ended. | ||
| */ | ||
| private @Nullable ChunkRecord endChunkRecord(final @NotNull SentryDate endTimestamp) { | ||
| try (final @NotNull ISentryLifecycleToken ignored = chunkHistoryLock.acquire()) { | ||
| final @Nullable ChunkRecord chunk = chunkHistory.peekLast(); | ||
| if (chunk == null || chunk.hasEnded()) { | ||
| return null; | ||
| } | ||
| chunk.setEndTimestamp(endTimestamp); | ||
| return chunk; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Resolves scopes on first call. Since PerfettoContinuousProfiler is created during Sentry.init() | ||
| * and never used for app-start profiling, scopes is guaranteed to be available by the time | ||
|
|
@@ -265,23 +356,27 @@ private void startInternal() { | |
| if (perfettoProfiler == null) { | ||
| return; | ||
| } | ||
| if (SentryId.EMPTY_ID.equals(profilerId)) { | ||
| profilerId = new SentryId(); | ||
| } | ||
|
|
||
| final @Nullable ChunkRecord chunkRecord = | ||
| perfettoProfiler.start(startProfileChunkTimestamp, profilerId, MAX_CHUNK_DURATION_MILLIS); | ||
| if (chunkRecord == null) { | ||
| profilerId = SentryId.EMPTY_ID; | ||
|
markushi marked this conversation as resolved.
|
||
| chunkId = SentryId.EMPTY_ID; | ||
| logger.log( | ||
| SentryLevel.ERROR, | ||
| "Failed to start Perfetto profiling. PerfettoProfiler.start() returned no chunk."); | ||
| return; | ||
| } | ||
|
|
||
| isRunning = true; | ||
| if (chunkId.equals(SentryId.EMPTY_ID)) { | ||
| chunkId = new SentryId(); | ||
| } | ||
|
|
||
| addChunkRecord(chunkRecord); | ||
| chunkMeasurements.start(performanceCollector, chunkId.toString()); | ||
|
|
||
| try { | ||
|
|
@@ -328,6 +423,7 @@ private void stopInternal(final boolean restartProfiler) { | |
| final @NotNull SentryId chunkProfilerId = profilerId; | ||
| final @NotNull SentryId chunkChunkId = chunkId; | ||
| final @NotNull SentryDate chunkTimestamp = startProfileChunkTimestamp; | ||
| final @Nullable ChunkRecord chunkRecord = endChunkRecord(options.getDateProvider().now()); | ||
|
|
||
| isRunning = false; | ||
| perfettoProfiler = null; | ||
|
|
@@ -348,6 +444,7 @@ private void stopInternal(final boolean restartProfiler) { | |
| traceFile, | ||
| chunkProfilerId, | ||
| chunkChunkId, | ||
| chunkRecord, | ||
| measurements, | ||
| chunkTimestamp, | ||
| shouldRestart, | ||
|
|
@@ -359,11 +456,22 @@ private void onChunkCollected( | |
| final @Nullable File traceFile, | ||
| final @NotNull SentryId chunkProfilerId, | ||
| final @NotNull SentryId chunkChunkId, | ||
| final @Nullable ChunkRecord chunkRecord, | ||
| final @NotNull Map<String, ProfileMeasurement> measurements, | ||
| final @NotNull SentryDate chunkTimestamp, | ||
| final boolean shouldRestart, | ||
| final @NotNull IScopes scopes, | ||
| final @NotNull SentryOptions options) { | ||
| // The trace file is the last word on whether the chunk was recorded: the OS may report success | ||
| // and still leave no usable file behind | ||
| if (chunkRecord != null) { | ||
| // Nothing is sent once the profiler is closed, so a collected chunk still covers nothing | ||
| chunkRecord.setRecordingState( | ||
| traceFile != null && !isClosed.get() | ||
| ? ProfileRecordingState.RECORDED | ||
| : ProfileRecordingState.NOT_RECORDED); | ||
| } | ||
|
|
||
| if (traceFile == null) { | ||
| logger.log( | ||
| SentryLevel.ERROR, | ||
|
|
||
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.
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.
Thoughts about replacing with a default method on
IConinuousProfilerthat returnsUNKNOWN(same throughout)?