docs(rum): document the axios integration for HarmonyOS - #267
Merged
Conversation
The network section described two integration paths and told everyone else to fall back to getHeaders(), which returns trace headers but no way to report the resource — so axios users, the largest group not covered, had to assemble the resource lifecycle themselves and get the sampling flag, the span id encoding and the first-party gate right on their own. 0.4.0 ships `@flashcatcloud/axios`, and `startTracedResource()` for stacks that do not have a package. The section now opens with a table mapping each network library to its integration, and covers all four. Module versions move to 0.4.0. The `0.3.2` on the advanced-config page stays — it dates a behaviour change rather than naming the current release.
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
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.
The HarmonyOS network section described two integration paths and pointed everyone else at
getHeaders(). That call returns trace headers but no way to report the resource, so axios users — the largest group the two paths do not cover — had to assemble the resource lifecycle themselves and get the sampling flag, the span id encoding and the first-party gate right on their own.SDK
0.4.0ships@flashcatcloud/axios, andFlashcatTrace.startTracedResource()for stacks without a dedicated package.Changes
FlashcatHttp, axios, and anything else.@flashcatcloud/axios, calltrackAxios(instance). Warns that interceptors are per-instance and must be registered exactly once.startTracedResource(), including the two things a caller still owns — passing the full url, and closing the resource on the failure path.FlashcatHttp.data-collectionlists the two new ways a resource can be produced, and separates the four that needsetTrackNetworkRequests(true)from the manual API that does not.0.4.0, with@flashcatcloud/axiosin the install snippet marked as needed only by axios users.The
0.3.2on the advanced-config page is left alone — it dates a behaviour change rather than naming the current release.mint broken-linkspasses. zh and en updated together.Note:
0.4.0is submitted to the registry and awaiting review, so hold this until the packages are live.