Skip to content
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.

Sign up for GitHub

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

fix(logging): user-input issues should not be logged as error level #3935

Merged
merged 2 commits into from
Feb 5, 2025
Merged

fix(logging): user-input issues should not be logged as error level #3935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4477b1
fix(logging): reduce user-input issues being logged as error
iainsproat Feb 5, 2025
2ce3e6b
error logging middleware should better handle caught errors
iainsproat Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion packages/preview-service/src/server/routes/objects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,14 @@ const objectsRouterFactory = () => {
res,
(err) => {
if (err) {
boundLogger.error(err, 'Error downloading object from stream')
switch (err.code) {
case 'ERR_STREAM_PREMATURE_CLOSE':
boundLogger.info({ err }, 'Client closed connection early')
break
default:
boundLogger.error({ err }, 'Error downloading object from stream')
break
}
} else {
boundLogger.info(
{ megaBytesWritten: gzipStream.bytesWritten / 1000000 },
Expand Down
12 changes: 11 additions & 1 deletion packages/server/logging/errorLogging.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,17 @@ export const errorLoggingMiddleware: express.ErrorRequestHandler = (
})
}

logger.error(err, `Error when handling ${req.originalUrl} from ${req.ip}`)
if (!('statusCode' in err) || err.statusCode >= 500) {
logger.error({ err }, `Error when handling ${req.originalUrl} from ${req.ip}`)
} else if (err.statusCode >= 400) {
logger.info({ err }, `Error when handling ${req.originalUrl} from ${req.ip}`)
} else {
logger.warn(
{ err },
`Error when handling ${req.originalUrl} from ${req.ip}. Error has a statusCode but it is not 4xx or 5xx.`
)
}

let route = 'unknown'
if (req.route && req.route.path) route = req.route.path
metricErrorCount.labels(route).inc()
Expand Down
9 changes: 8 additions & 1 deletion packages/server/modules/core/rest/download.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,14 @@ export default (app: express.Express) => {
res,
(err) => {
if (err) {
boundLogger.error(err, 'Error downloading object.')
switch (err.code) {
case 'ERR_STREAM_PREMATURE_CLOSE':
boundLogger.info({ err }, 'Client closed connection early')
break
default:
boundLogger.error({ err }, 'Error downloading object from stream')
break
}
} else {
boundLogger.info(
{ megaBytesWritten: gzipStream.bytesWritten / 1000000 },
Expand Down
2 changes: 1 addition & 1 deletion packages/server/modules/core/rest/upload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ export default (app: Router, { executeHooks }: { executeHooks: ExecuteHooks }) =
try {
objs = JSON.parse(gunzippedBuffer)
} catch {
req.log.error(
req.log.info(
calculateLogMetadata({
batchSizeMb: gunzippedBufferMegabyteSize,
start,
Expand Down
Loading