From 9f2b786fc9a55bb2133aaf3482b17b54cc991911 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sat, 7 Jan 2023 14:15:17 +0100 Subject: [PATCH] Avoid directly logging error objects Signed-off-by: Patrik Oldsberg --- .changeset/tame-spoons-exercise.md | 16 ++++++++++++++++ .../techdocs-cli/src/commands/serve/serve.ts | 2 +- .../src/providers/AwsS3EntityProvider.ts | 2 +- .../src/providers/AzureDevOpsEntityProvider.ts | 2 +- .../src/BitbucketCloudEntityProvider.ts | 2 +- .../providers/BitbucketServerEntityProvider.ts | 2 +- .../src/providers/GerritEntityProvider.ts | 2 +- .../src/providers/GithubEntityProvider.ts | 2 +- .../src/providers/GithubOrgEntityProvider.ts | 2 +- .../providers/GitlabDiscoveryEntityProvider.ts | 2 +- .../src/engine/IncrementalIngestionEngine.ts | 5 ++++- .../src/processors/LdapOrgEntityProvider.ts | 2 +- .../MicrosoftGraphOrgEntityProvider.ts | 2 +- .../publisher/AwsSqsConsumingEventPublisher.ts | 2 +- 14 files changed, 32 insertions(+), 13 deletions(-) create mode 100644 .changeset/tame-spoons-exercise.md diff --git a/.changeset/tame-spoons-exercise.md b/.changeset/tame-spoons-exercise.md new file mode 100644 index 0000000000..37c489cb32 --- /dev/null +++ b/.changeset/tame-spoons-exercise.md @@ -0,0 +1,16 @@ +--- +'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch +'@backstage/plugin-catalog-backend-module-bitbucket-server': patch +'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch +'@backstage/plugin-catalog-backend-module-msgraph': patch +'@backstage/plugin-catalog-backend-module-gerrit': patch +'@backstage/plugin-catalog-backend-module-github': patch +'@backstage/plugin-catalog-backend-module-gitlab': patch +'@backstage/plugin-events-backend-module-aws-sqs': patch +'@backstage/plugin-catalog-backend-module-azure': patch +'@backstage/plugin-catalog-backend-module-ldap': patch +'@backstage/plugin-catalog-backend-module-aws': patch +'@techdocs/cli': patch +--- + +Provide context for logged errors. diff --git a/packages/techdocs-cli/src/commands/serve/serve.ts b/packages/techdocs-cli/src/commands/serve/serve.ts index 68d0bbb277..fd1febfb6c 100644 --- a/packages/techdocs-cli/src/commands/serve/serve.ts +++ b/packages/techdocs-cli/src/commands/serve/serve.ts @@ -126,7 +126,7 @@ export default async function serve(opts: OptionValues) { httpServer .serve() .catch(err => { - logger.error(err); + logger.error('Failed to start HTTP server', err); mkdocsChildProcess.kill(); process.exit(1); }) diff --git a/plugins/catalog-backend-module-aws/src/providers/AwsS3EntityProvider.ts b/plugins/catalog-backend-module-aws/src/providers/AwsS3EntityProvider.ts index 80bc4d459b..b92fcfc022 100644 --- a/plugins/catalog-backend-module-aws/src/providers/AwsS3EntityProvider.ts +++ b/plugins/catalog-backend-module-aws/src/providers/AwsS3EntityProvider.ts @@ -131,7 +131,7 @@ export class AwsS3EntityProvider implements EntityProvider { try { await this.refresh(logger); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts b/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts index b824d176ee..98b951bd46 100644 --- a/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts +++ b/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts @@ -113,7 +113,7 @@ export class AzureDevOpsEntityProvider implements EntityProvider { try { await this.refresh(logger); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.ts index 83b6f447f2..a139bd7d8d 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/BitbucketCloudEntityProvider.ts @@ -152,7 +152,7 @@ export class BitbucketCloudEntityProvider try { await this.refresh(logger); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-bitbucket-server/src/providers/BitbucketServerEntityProvider.ts b/plugins/catalog-backend-module-bitbucket-server/src/providers/BitbucketServerEntityProvider.ts index 447b71ee58..2ecdd79019 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/providers/BitbucketServerEntityProvider.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/providers/BitbucketServerEntityProvider.ts @@ -130,7 +130,7 @@ export class BitbucketServerEntityProvider implements EntityProvider { try { await this.refresh(logger); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-gerrit/src/providers/GerritEntityProvider.ts b/plugins/catalog-backend-module-gerrit/src/providers/GerritEntityProvider.ts index ec08dbe4be..986f8ae60c 100644 --- a/plugins/catalog-backend-module-gerrit/src/providers/GerritEntityProvider.ts +++ b/plugins/catalog-backend-module-gerrit/src/providers/GerritEntityProvider.ts @@ -129,7 +129,7 @@ export class GerritEntityProvider implements EntityProvider { try { await this.refresh(logger); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts b/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts index 8816d8ee80..e979d733d4 100644 --- a/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts +++ b/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts @@ -156,7 +156,7 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { try { await this.refresh(logger); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts b/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts index 46ad089625..3093c2a897 100644 --- a/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts +++ b/plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts @@ -565,7 +565,7 @@ export class GithubOrgEntityProvider try { await this.read({ logger }); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts index cb4629b820..1cc818c811 100644 --- a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts +++ b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts @@ -133,7 +133,7 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider { try { await this.refresh(logger); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts b/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts index e2000c609e..e94bc9c53f 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts @@ -111,7 +111,10 @@ export class IncrementalIngestionEngine implements IterationEngine { ); const backoffLength = currentBackoff.as('milliseconds'); - this.options.logger.error(error); + this.options.logger.error( + `incremental-engine: Ingestion '${ingestionId}' failed`, + error, + ); const truncatedError = stringifyError(error).substring(0, 700); this.options.logger.error( diff --git a/plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts b/plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts index b38ea51cc0..64d56cc8bc 100644 --- a/plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts +++ b/plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts @@ -225,7 +225,7 @@ export class LdapOrgEntityProvider implements EntityProvider { try { await this.read({ logger }); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts index 32892e7201..5c1a7f9e1c 100644 --- a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts +++ b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts @@ -351,7 +351,7 @@ export class MicrosoftGraphOrgEntityProvider implements EntityProvider { try { await this.read({ logger }); } catch (error) { - logger.error(error); + logger.error(`${this.getProviderName()} refresh failed`, error); } }, }); diff --git a/plugins/events-backend-module-aws-sqs/src/publisher/AwsSqsConsumingEventPublisher.ts b/plugins/events-backend-module-aws-sqs/src/publisher/AwsSqsConsumingEventPublisher.ts index 4638769c45..e649e2ee83 100644 --- a/plugins/events-backend-module-aws-sqs/src/publisher/AwsSqsConsumingEventPublisher.ts +++ b/plugins/events-backend-module-aws-sqs/src/publisher/AwsSqsConsumingEventPublisher.ts @@ -100,7 +100,7 @@ export class AwsSqsConsumingEventPublisher implements EventPublisher { await this.sleep(this.waitTimeAfterEmptyReceiveMs); } } catch (error) { - logger.error(error); + logger.error('Failed to consume AWS SQS messages', error); } }, });