Avoid directly logging error objects

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-01-07 14:15:17 +01:00
parent ab43f12359
commit 9f2b786fc9
14 changed files with 32 additions and 13 deletions
+16
View File
@@ -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.
@@ -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);
})
@@ -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);
}
},
});
@@ -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);
}
},
});
@@ -152,7 +152,7 @@ export class BitbucketCloudEntityProvider
try {
await this.refresh(logger);
} catch (error) {
logger.error(error);
logger.error(`${this.getProviderName()} refresh failed`, error);
}
},
});
@@ -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);
}
},
});
@@ -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);
}
},
});
@@ -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);
}
},
});
@@ -565,7 +565,7 @@ export class GithubOrgEntityProvider
try {
await this.read({ logger });
} catch (error) {
logger.error(error);
logger.error(`${this.getProviderName()} refresh failed`, error);
}
},
});
@@ -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);
}
},
});
@@ -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(
@@ -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);
}
},
});
@@ -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);
}
},
});
@@ -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);
}
},
});