feat: add diagnostic #568

Mercy811 · 2023-08-25T22:44:38Z

Summary

https://amplitude.atlassian.net/browse/AMP-81179

Send diagnostic events when the SDK drops events

This feature is enabled by default and can be disabled by setting config.diagnosticProvider to undefined

Checklist

Does your PR title have the correct title format?
Does your PR have a breaking change?:

packages/analytics-browser/src/browser-client.ts

packages/analytics-browser/src/plugins/destination.ts

packages/analytics-browser/src/plugins/diagnostic.ts

packages/analytics-core/src/plugins/diagnostic.ts

packages/analytics-browser/src/config.ts

packages/analytics-types/src/diagnostic-event.ts

packages/analytics-core/src/plugins/diagnostic.ts

justin-fiedler

Thanks @Mercy811. See comments. Since we only need to hook into "flush" configuring this as a Plugin is probably not needed, instead we can mostly treat it like the other providers.

We can probably use the config.transportProvider to send the diagnotics but should be careful with the storage (config.storageProvider) so these events aren't mixed with "real" events.

packages/analytics-browser/src/browser-client.ts

packages/analytics-core/src/plugins/diagnostic.ts

packages/analytics-browser/src/plugins/destination.ts

packages/analytics-core/src/plugins/diagnostic.ts

packages/analytics-types/src/diagnostic-event.ts

packages/analytics-browser/test/plugins/diagnostic.test.ts

packages/analytics-core/src/diagnostic.ts

packages/analytics-core/src/diagnostics/diagnostic.ts

packages/analytics-browser/src/diagnostics/diagnostic.ts

packages/analytics-browser/test/diagnostic.test.ts

packages/analytics-browser/test/helpers/mock.ts

packages/analytics-core/src/config.ts

packages/analytics-core/src/diagnostics/diagnostic.ts

packages/analytics-core/src/diagnostics/typings.ts

packages/analytics-browser/src/config.ts

packages/analytics-browser/test/browser-client.test.ts

packages/analytics-core/test/helpers/default.ts

packages/analytics-core/src/index.ts

packages/analytics-browser/test/browser-client.test.ts

packages/analytics-core/src/config.ts

packages/analytics-core/test/diagnostic.test.ts

packages/analytics-core/src/diagnostics/diagnostic.ts

packages/analytics-types/src/diagnostic.ts

packages/analytics-core/src/config.ts

packages/analytics-core/src/plugins/destination.ts

packages/analytics-core/src/diagnostics/diagnostic.ts

packages/analytics-browser/test/browser-client.test.ts

packages/analytics-core/src/diagnostics/diagnostic.ts

packages/analytics-core/src/plugins/destination.ts

Co-authored-by: Justin Fiedler <[email protected]>

1. account time in minutes 2. browser diagnostic default apiKey

Co-authored-by: Justin Fiedler <[email protected]>

- @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected]

Mercy811 force-pushed the feat-add-diagnostics branch from 18f63df to 51a5ff1 Compare August 26, 2023 00:04

Mercy811 requested review from kevinpagtakhan, justin-fiedler, yuhao900914, nehabhambhani and shweta-amplitude August 28, 2023 17:01

Mercy811 marked this pull request as ready for review August 28, 2023 17:07

kevinpagtakhan reviewed Aug 28, 2023

View reviewed changes

packages/analytics-browser/src/browser-client.ts Outdated Show resolved Hide resolved

kevinpagtakhan reviewed Aug 28, 2023

View reviewed changes

packages/analytics-browser/src/plugins/destination.ts Outdated Show resolved Hide resolved

kevinpagtakhan reviewed Aug 28, 2023

View reviewed changes

packages/analytics-browser/src/plugins/diagnostic.ts Outdated Show resolved Hide resolved

kevinpagtakhan reviewed Aug 28, 2023

View reviewed changes

packages/analytics-core/src/plugins/diagnostic.ts Outdated Show resolved Hide resolved

yuhao900914 reviewed Aug 28, 2023

View reviewed changes

packages/analytics-browser/src/config.ts Outdated Show resolved Hide resolved

packages/analytics-types/src/diagnostic-event.ts Outdated Show resolved Hide resolved

packages/analytics-core/src/plugins/diagnostic.ts Outdated Show resolved Hide resolved

justin-fiedler suggested changes Sep 6, 2023

View reviewed changes

justin-fiedler reviewed Sep 7, 2023

View reviewed changes

packages/analytics-browser/test/plugins/diagnostic.test.ts Outdated Show resolved Hide resolved

justin-fiedler reviewed Sep 7, 2023

View reviewed changes

packages/analytics-core/src/diagnostic.ts Outdated Show resolved Hide resolved

justin-fiedler reviewed Sep 7, 2023

View reviewed changes

packages/analytics-core/src/diagnostic.ts Outdated Show resolved Hide resolved

justin-fiedler reviewed Oct 11, 2023

View reviewed changes

packages/analytics-browser/test/browser-client.test.ts Show resolved Hide resolved

justin-fiedler reviewed Oct 11, 2023

View reviewed changes

packages/analytics-core/test/helpers/default.ts Outdated Show resolved Hide resolved

Mercy811 force-pushed the feat-add-diagnostics branch from c7bf5fa to 417eed4 Compare October 11, 2023 21:52

Mercy811 commented Oct 12, 2023

View reviewed changes

packages/analytics-core/src/index.ts Outdated Show resolved Hide resolved

packages/analytics-browser/test/browser-client.test.ts Show resolved Hide resolved

Mercy811 requested a review from justin-fiedler October 12, 2023 17:48

justin-fiedler reviewed Oct 12, 2023

View reviewed changes

Mercy811 commented Oct 12, 2023

View reviewed changes

packages/analytics-core/src/diagnostics/diagnostic.ts Outdated Show resolved Hide resolved

Mercy811 force-pushed the feat-add-diagnostics branch from 80a8114 to 4a8f99d Compare October 12, 2023 22:41

justin-fiedler self-requested a review October 27, 2023 22:19

justin-fiedler suggested changes Oct 27, 2023

View reviewed changes

shweta-amplitude removed their request for review November 7, 2023 18:41

justin-fiedler self-requested a review November 8, 2023 23:15

justin-fiedler approved these changes Nov 8, 2023

View reviewed changes

Mercy811 and others added 28 commits November 16, 2023 09:41

test: add more tests for core destination

b5b8a48

refactor: move to diagnostics folder

56c8af6

feat: change event structure

9492638

test: client level tests

3df9ac5

test: apikey

2b4c1f7

fix: delete duplicate diagnostic track

bef4da7

test: more client level tests

da7baf2

fix: empty commit

6975d5b

fix: update endpoint url

7d7a33c

refactor: rename

4723f6b

fix: payload and test

d6bac4c

refactor: rename to DiagnosticRequest

7cc0639

feat: diagnostic provider only accepts Diagnostic

6cb202b

test: mock diagnosticProvider

ef5706f

refactor: extract DIAGNOSTIC_MESSAGES

1d252d2

Update packages/analytics-core/src/config.ts

f72cf0e

Co-authored-by: Justin Fiedler <[email protected]>

Update packages/analytics-core/test/diagnostic.test.ts

3db01cd

Co-authored-by: Justin Fiedler <[email protected]>

fix: change api only when it's not set

1586520

fix: diagnostic not extend options

11dcde7

fix: disable BaseDiagnostic

eb6d095

fix: recover fulfillRequest

e733169

fix: should set default api key for diagnostic

85cf273

fix: time should be in minutes

546b5b0

fix: should diagnostic track only when api key is valid

9dfbe7a

test: apply recent changes

2e373dc

1. account time in minutes 2. browser diagnostic default apiKey

chore: update dropList with retryList

a6c34f5

chore: use nullish coalescing

d960c18

Co-authored-by: Justin Fiedler <[email protected]>

refactor: extract track diagnostic when not useRetry

d2bbc02

Mercy811 force-pushed the feat-add-diagnostics branch from fa718e9 to d2bbc02 Compare November 16, 2023 17:42

chore(release): publish

62aaa6f

- @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected] - @amplitude/[email protected]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add diagnostic #568

feat: add diagnostic #568

Mercy811 commented Aug 25, 2023

justin-fiedler left a comment

feat: add diagnostic #568

Are you sure you want to change the base?

feat: add diagnostic #568

Conversation

Mercy811 commented Aug 25, 2023

Summary

Checklist

justin-fiedler left a comment

Choose a reason for hiding this comment