docs: add analytics migration guidance for web and JavaScript platforms - #8617
Open
soberm wants to merge 1 commit into
Open
docs: add analytics migration guidance for web and JavaScript platforms#8617soberm wants to merge 1 commit into
soberm wants to merge 1 commit into
Conversation
Extend the Pinpoint migration guide's analytics section to cover the JavaScript, React, Angular, Next.js, Vue, and React Native platforms. These platforms reach the Kinesis and Firehose analytics providers through different pages than the mobile libraries (streaming-data and storing-data), so the section links those and shows the amplify-js migration steps: moving record and flushEvents to the aws-amplify/analytics/kinesis and aws-amplify/analytics/kinesis-firehose subpaths, mapping the Pinpoint event name, attributes, and metrics into the stream data blob, supplying stream coordinates to configureAutoTrack, and directing identifyUser to Amazon Connect Customer Profiles.
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.
Description of changes
The analytics portion of the Pinpoint migration guide now covers the web and JavaScript platforms:
javascript,react,angular,nextjs,vue, andreact-native.The guide's
## Migrate analytics event recordingheading applies to every platform inmeta.platforms, but its body was scoped to['android', 'flutter', 'swift']. The mobile libraries document the Kinesis and Firehose providers atanalytics/kinesis/andanalytics/firehose/, which are mobile-only pages, so the links could not be shared with the web platforms. As a result the heading rendered with no body on the web platforms — for example on the react page.This adds a sibling
<InlineFilter>block with the equivalent guidance for the JavaScript library, which reaches the same two services through different pages:The new section walks through the amplify-js specifics:
recordandflushEventsto theaws-amplify/analytics/kinesisandaws-amplify/analytics/kinesis-firehosesubpaths.name,attributes, andmetricsinto thedatablob written to the stream, with the KinesisstreamNameandpartitionKey. Firehose records takestreamNameonly.configureAutoTrackoptions, since automatically tracked events need a destination.identifyUserto Amazon Connect Customer Profiles, because the streaming providers record events only and do not expose anidentifyUserAPI.The API surface and input shapes were verified against the
aws-amplify/analyticsprovider exports and theirRecordInput/ConfigureAutoTrackinput types, and the prose and examples follow the existing web analytics pages in this repo. The mobile block is unchanged.Validation
yarn buildpasses; all 9 platform routes forpinpoint-migrationprerender.yarn spellcheckpasses: 3023 files, 0 issues..prettierignoreexcludes; no other files touched.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.