-
Notifications
You must be signed in to change notification settings - Fork 749
telemetry(auth): debounce aws_loadCredentials and add debugging information
#6499
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a3d47a9
telemetry: add withTelemetryContext decorators to upstream callers
Hweinstock ee019a9
feat: implement debounce on spammed emission
Hweinstock 8ba2ae6
refactor: add metadata inline
Hweinstock b9c0066
fix: decrease debounce timer
Hweinstock 3d48fe6
Merge branch 'master' into auth/telemetryDebugging
Hweinstock 390e8ee
test: add techdebt test to remove extra telemetry metric
Hweinstock 7a77aec
refactor: make class name const consistent
Hweinstock 8036f4a
fix: avoid recreating function on each call
Hweinstock 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 |
|---|---|---|
|
|
@@ -4,7 +4,9 @@ | |
| */ | ||
|
|
||
| import { getLogger } from '../../shared/logger' | ||
| import { telemetry } from '../../shared/telemetry/telemetry' | ||
| import { AwsLoadCredentials, telemetry } from '../../shared/telemetry/telemetry' | ||
| import { withTelemetryContext } from '../../shared/telemetry/util' | ||
| import { cancellableDebounce } from '../../shared/utilities/functionUtils' | ||
| import { | ||
| asString, | ||
| CredentialsProvider, | ||
|
|
@@ -14,6 +16,7 @@ import { | |
| } from './credentials' | ||
| import { CredentialsProviderFactory } from './credentialsProviderFactory' | ||
|
|
||
| const credentialsProviderManagerClassName = 'CredentialsProviderManager' | ||
| /** | ||
| * Responsible for providing the Toolkit with all available CredentialsProviders. | ||
| * Providers may be registered directly or created with supplied CredentialsProviderFactories. | ||
|
|
@@ -23,13 +26,18 @@ export class CredentialsProviderManager { | |
| private readonly providerFactories: CredentialsProviderFactory[] = [] | ||
| private readonly providers: CredentialsProvider[] = [] | ||
|
|
||
| @withTelemetryContext({ name: 'getAllCredentialsProvider', class: credentialsProviderManagerClassName, emit: true }) | ||
| public async getAllCredentialsProviders(): Promise<CredentialsProvider[]> { | ||
| let providers: CredentialsProvider[] = [] | ||
|
|
||
| for (const provider of this.providers) { | ||
| if (await provider.isAvailable()) { | ||
| const telemType = credentialsProviderToTelemetryType(provider.getCredentialsId().credentialSource) | ||
| telemetry.aws_loadCredentials.emit({ credentialSourceId: telemType, value: 1 }) | ||
| telemetry.aws_loadCredentials.emit({ | ||
| credentialSourceId: credentialsProviderToTelemetryType( | ||
| provider.getCredentialsId().credentialSource | ||
| ), | ||
| value: 1, | ||
| }) | ||
| providers = providers.concat(provider) | ||
| } else { | ||
| getLogger().verbose('auth: "%s" provider unavailable', provider.getCredentialsId().credentialTypeId) | ||
|
|
@@ -43,8 +51,14 @@ export class CredentialsProviderManager { | |
| if (!providerType) { | ||
| continue | ||
| } | ||
| const telemType = credentialsProviderToTelemetryType(providerType) | ||
| telemetry.aws_loadCredentials.emit({ credentialSourceId: telemType, value: refreshed.length }) | ||
| const emitWithDebounce = cancellableDebounce( | ||
|
||
| (m: AwsLoadCredentials) => telemetry.aws_loadCredentials.emit(m), | ||
| 100 | ||
| ).promise | ||
| void emitWithDebounce({ | ||
| credentialSourceId: credentialsProviderToTelemetryType(providerType), | ||
| value: refreshed.length, | ||
| }) | ||
| providers = providers.concat(refreshed) | ||
| } | ||
|
|
||
|
|
@@ -55,6 +69,7 @@ export class CredentialsProviderManager { | |
| * Returns a map of `CredentialsProviderId` string-forms to object-forms, | ||
| * from all credential sources. Only available providers are returned. | ||
| */ | ||
| @withTelemetryContext({ name: 'getCredentialProviderNames', class: credentialsProviderManagerClassName }) | ||
| public async getCredentialProviderNames(): Promise<{ [key: string]: CredentialsId }> { | ||
| const m: { [key: string]: CredentialsId } = {} | ||
| for (const o of await this.getAllCredentialsProviders()) { | ||
|
|
||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And this emits every call, possible chance this will be noisy. But it should hopefully not break anything before we remove it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I added a techdebt test to ensure we remove this.