-
Notifications
You must be signed in to change notification settings - Fork 257
Enable Customer SDK Stats #2707
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JacksonWeber
wants to merge
11
commits into
microsoft:main
Choose a base branch
from
JacksonWeber:jacksonweber/enable-customer-sdk-stats
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
21e0853
Enable customer sdk stats.
JacksonWeber 122843e
Delete customer_facing_sdk_stats_spec.md
JacksonWeber 5b75594
Delete customer_sdk_stats_implementation.md
JacksonWeber 407adf4
Update flush of sdk stats.
JacksonWeber 7af6493
Fix possible prototype pollution bug.
JacksonWeber c9d1d98
Update to resolve prototype pollution issue.
JacksonWeber 14ef500
Add tests.
JacksonWeber 58a56d2
Resolve prototype-polluting assignment issues.
JacksonWeber 7eaafe0
Address github comments.
JacksonWeber 1325688
Update SdkStatsNotificationCbk.ts
JacksonWeber 3321b4c
Update Sender.ts
JacksonWeber File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -511,7 +511,8 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| _checkMaxSize(payload); | ||
| let payloadItem = { | ||
| item: payload, | ||
| cnt: 0 // inital cnt will always be 0 | ||
| cnt: 0, // inital cnt will always be 0 | ||
| bT: telemetryItem.baseType // store baseType for SDK stats telemetry_type mapping | ||
| } as IInternalStorageItem; | ||
|
|
||
| // enqueue the payload | ||
|
|
@@ -626,12 +627,12 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| /** | ||
| * error handler | ||
| */ | ||
| _self._onError = (payload: IInternalStorageItem[] | string[], message: string, event?: ErrorEvent) => { | ||
| _self._onError = (payload: IInternalStorageItem[] | string[], message: string, event?: ErrorEvent, statusCode?: number) => { | ||
|
||
| // since version 3.1.3, string[] is no-op | ||
| if (_isStringArr(payload)) { | ||
| return; | ||
| } | ||
| return _onError(payload as IInternalStorageItem[], message, event); | ||
| return _onError(payload as IInternalStorageItem[], message, event, statusCode); | ||
| }; | ||
|
|
||
| /** | ||
|
|
@@ -799,14 +800,23 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| /** | ||
| * error handler | ||
| */ | ||
| function _onError(payload: IInternalStorageItem[], message: string, event?: ErrorEvent) { | ||
| function _onError(payload: IInternalStorageItem[], message: string, event?: ErrorEvent, statusCode?: number) { | ||
| _throwInternal(_self.diagLog(), | ||
| eLoggingSeverity.WARNING, | ||
| _eInternalMessageId.OnError, | ||
| "Failed to send telemetry.", | ||
| { message }); | ||
|
|
||
| _self._buffer && _self._buffer.clearSent(payload); | ||
|
|
||
| // Notify listeners of discarded events | ||
| let mgr = _getNotifyMgr(); | ||
| if (mgr) { | ||
| let items = _extractTelemetryItems(payload); | ||
| if (items) { | ||
| mgr.eventsDiscarded(items, 1 /* NonRetryableStatus */, statusCode); | ||
| } | ||
| } | ||
| } | ||
| /** | ||
| * partial success handler | ||
|
|
@@ -852,6 +862,15 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| */ | ||
| function _onSuccess(payload: IInternalStorageItem[], countOfItemsInPayload: number) { | ||
| _self._buffer && _self._buffer.clearSent(payload); | ||
|
|
||
| // Notify listeners of successful send | ||
| let mgr = _getNotifyMgr(); | ||
| if (mgr) { | ||
| let items = _extractTelemetryItems(payload); | ||
| if (items) { | ||
| mgr.eventsSent(items); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
|
|
@@ -1114,7 +1133,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| // Updates the end point url before retry | ||
| if(status === 301 || status === 307 || status === 308) { | ||
| if(!_checkAndUpdateEndPointUrl(responseUrl)) { | ||
| _self._onError(payload, errorMessage); | ||
| _self._onError(payload, errorMessage, undefined, status); | ||
| return; | ||
| } | ||
| } | ||
|
|
@@ -1124,6 +1143,9 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| if (!_isRetryDisabled) { | ||
| const offlineBackOffMultiplier = 10; // arbritrary number | ||
| _resendPayload(payload, offlineBackOffMultiplier); | ||
|
|
||
| // Notify listeners of retry | ||
| _notifyRetry(payload, status); | ||
|
|
||
| _throwInternal(_self.diagLog(), | ||
| eLoggingSeverity.WARNING, | ||
|
|
@@ -1133,12 +1155,16 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| } | ||
| if (!_isRetryDisabled && _isRetriable(status)) { | ||
| _resendPayload(payload); | ||
|
|
||
| // Notify listeners of retry | ||
| _notifyRetry(payload, status); | ||
|
|
||
| _throwInternal(_self.diagLog(), | ||
| eLoggingSeverity.WARNING, | ||
| _eInternalMessageId.TransmissionFailed, ". " + | ||
| "Response code " + status + ". Will retry to send " + payload.length + " items."); | ||
| } else { | ||
| _self._onError(payload, errorMessage); | ||
| _self._onError(payload, errorMessage, undefined, status); | ||
| } | ||
| } else { | ||
| // check if the xhr's responseURL or fetch's response.url is same as endpoint url | ||
|
|
@@ -1153,7 +1179,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| if (response && !_isRetryDisabled) { | ||
| _self._onPartialSuccess(payload, response); | ||
| } else { | ||
| _self._onError(payload, errorMessage); | ||
| _self._onError(payload, errorMessage, undefined, status); | ||
| } | ||
| } else { | ||
| _consecutiveErrors = 0; | ||
|
|
@@ -1388,6 +1414,37 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * Extracts minimal ITelemetryItem objects from IInternalStorageItem[] for notification dispatch. | ||
| * Uses the stored baseType (bT) to reconstruct telemetry items. | ||
| */ | ||
| function _extractTelemetryItems(payload: IInternalStorageItem[]): ITelemetryItem[] { | ||
| if (payload && payload.length) { | ||
| let items: ITelemetryItem[] = []; | ||
| arrForEach(payload, (p) => { | ||
| if (p) { | ||
| let baseType = p.bT || "EventData"; | ||
| items.push({ name: baseType, baseType: baseType } as ITelemetryItem); | ||
|
Comment on lines
+1421
to
+1427
|
||
| } | ||
| }); | ||
| return items.length ? items : null; | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Notify listeners of retry events. | ||
| */ | ||
| function _notifyRetry(payload: IInternalStorageItem[], statusCode: number) { | ||
| let mgr = _getNotifyMgr(); | ||
| if (mgr && mgr.eventsRetry) { | ||
| let items = _extractTelemetryItems(payload); | ||
| if (items) { | ||
| mgr.eventsRetry(items, statusCode); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
|
|
||
| /** | ||
|
|
@@ -1534,7 +1591,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls { | |
| * @internal | ||
| * since version 3.2.0, if the payload is string[], this function is no-op (string[] is only used for backwards Compatibility) | ||
| */ | ||
| public _onError(payload: string[] | IInternalStorageItem[], message: string, event?: ErrorEvent) { | ||
| public _onError(payload: string[] | IInternalStorageItem[], message: string, event?: ErrorEvent, statusCode?: number) { | ||
| // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
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.