Skip to content

Commit cce6366

Browse files
authored
Switch to winston splat-style logging (printf-style) (#1108)
1 parent 3ebe98b commit cce6366

39 files changed

+98
-122
lines changed

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,15 @@
104104
"error",
105105
"warn",
106106
"info",
107-
"verbose"
107+
"verbose",
108+
"debug"
108109
],
109110
"enumDescriptions": [
110111
"Errors Only",
111112
"Errors and Warnings",
112113
"Errors, Warnings, and Info",
113-
"Errors, Warnings, Info, and Verbose"
114+
"Errors, Warnings, Info, and Verbose",
115+
"Errors, Warnings, Info, Verbose, and Debug"
114116
],
115117
"markdownDescription": "%AWS.configuration.description.logLevel%"
116118
},

src/awsexplorer/awsExplorer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export class AwsExplorer implements vscode.TreeDataProvider<AWSTreeNodeBase>, Re
8181
}
8282
} catch (err) {
8383
const error = err as Error
84-
this.logger.error(`Error getting children for node ${element?.label ?? 'Root Node'}`, error)
84+
this.logger.error(`Error getting children for node ${element?.label ?? 'Root Node'}: %O`, error)
8585

8686
childNodes.splice(
8787
0,

src/cdk/explorer/detectCdkProjects.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,6 @@ async function* detectCdkProjectsInFolder(folder: string): AsyncIterableIterator
7272
yield vscode.Uri.file(cdkJsonPath)
7373
} catch (err) {
7474
// This is usually because the file doesn't exist, but could also be a permissions issue.
75-
getLogger().debug(`Error detecting CDK apps in ${folder}`, err as Error)
75+
getLogger().debug(`Error detecting CDK apps in ${folder}: %O`, err as Error)
7676
}
7777
}

src/cdk/explorer/nodes/appNode.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export class AppNode extends AWSTreeNodeBase {
7777

7878
return constructs
7979
} catch (error) {
80-
getLogger().error(`Could not load the construct tree located at '${this.id}'`, error as Error)
80+
getLogger().error(`Could not load the construct tree located at '${this.id}': %O`, error as Error)
8181

8282
return [
8383
new PlaceholderNode(

src/credentials/loginManager.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export class LoginManager {
6161
getLogger().error(
6262
`Error trying to connect to AWS with Credentials Provider ${asString(
6363
credentialsProviderId
64-
)}. Toolkit will now disconnect from AWS.`,
64+
)}. Toolkit will now disconnect from AWS. %O`,
6565
err as Error
6666
)
6767
this.credentialsStore.invalidateCredentials(credentialsProviderId)

src/eventSchemas/commands/downloadSchemaItemCode.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export async function downloadSchemaItemCode(node: SchemaItemNode, outputChannel
8888
errorMessage = error.message
8989
}
9090
vscode.window.showErrorMessage(errorMessage)
91-
logger.error('Error downloading schema', error)
91+
logger.error('Error downloading schema: %O', error)
9292
} finally {
9393
recordSchemasDownload({ result: downloadResult })
9494
}

src/eventSchemas/commands/searchSchemas.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export async function createSearchSchemasWebView(params: {
9393
} catch (err) {
9494
webviewResult = 'Failed'
9595
const error = err as Error
96-
logger.error('Error searching schemas', error)
96+
logger.error('Error searching schemas: %O', error)
9797
} finally {
9898
// TODO make this telemetry actually record failures
9999
recordSchemasSearch({ result: webviewResult })

src/eventSchemas/commands/viewSchemaItem.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export async function viewSchemaItem(node: SchemaItemNode) {
2929
node.schemaName
3030
)
3131
)
32-
logger.error('Error on schema preview', error)
32+
logger.error('Error on schema preview: %O', error)
3333
} finally {
3434
recordSchemasView({ result: viewResult })
3535
}

src/eventSchemas/providers/schemasDataProvider.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export class SchemasDataProvider {
5555
}
5656
} catch (err) {
5757
const error = err as Error
58-
this.logger.error('Error retrieving registries', error)
58+
this.logger.error('Error retrieving registries: %O', error)
5959

6060
return undefined
6161
}
@@ -86,7 +86,7 @@ export class SchemasDataProvider {
8686
}
8787
} catch (err) {
8888
const error = err as Error
89-
this.logger.error('Error retrieving schemas', error)
89+
this.logger.error('Error retrieving schemas: %O', error)
9090

9191
return undefined
9292
}

src/extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ function makeEndpointsProvider(): EndpointsProvider {
249249
const provider = new EndpointsProvider(localManifestFetcher, remoteManifestFetcher)
250250
// tslint:disable-next-line:no-floating-promises -- start the load without waiting. It raises events as fetchers retrieve data.
251251
provider.load().catch((err: Error) => {
252-
getLogger().error('Failure while loading Endpoints Manifest', err)
252+
getLogger().error('Failure while loading Endpoints Manifest: %O', err)
253253

254254
vscode.window.showErrorMessage(
255255
localize(

0 commit comments

Comments
 (0)