docs(rum): document the HarmonyOS batching configuration - #278
Merged
Conversation
The HarmonyOS SDK expressed upload pacing as a millisecond setter while the Android, iOS and Flutter SDKs used three enums, so this page taught a vocabulary readers could not carry to the other platforms. SDK 0.5.0 adopted the shared enums and removed the millisecond setter, leaving the page documenting a method that no longer exists. Replace it with UploadFrequency, BatchSize and BatchProcessingLevel, and record the two defaults that moved so readers upgrading from 0.4.0 can see them without diffing the changelog. BatchProcessingLevel is new; the table says what it is for, since bounding an upload burst is the reason to reach for it.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Why
HarmonyOS SDK 0.5.0 replaced
setBatchUploadFrequencyMswith the three batchingenums the Android, iOS and Flutter SDKs already use. This page still documented
the removed method in 6 places, across
zhanden.What changed
zh/rum/sdk/harmony/advanced-config.mdxanden/rum/sdk/harmony/advanced-config.mdx:UploadFrequency,BatchSizeandBatchProcessingLevel.value so readers do not have to look them up in the SDK.
setUploadFrequency().5 s → 2 s, batch window 5 s → 10 s), both to match the other platforms.
setBatchProcessingLevelis new in 0.5.0 and had no documentation. It bounds howmany batches go out back-to-back, so the table says when to lower it: an app with
latency-sensitive requests of its own on a narrow uplink.
Verification
No references to the removed method remain outside the migration note itself.