refactor logger into single place

Author: Phil Varner

package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "stac-server",
   "description": "A STAC API running on stac-server",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "repository": "https://github.com/stac-utils/stac-server",
   "author": "Alireza Jazayeri, Matthew Hanson <matt.a.hanson@gmail.com>, Sean Harkins",
   "license": "MIT",

serverless.example.yml

@@ -5,17 +5,12 @@ const createError = require('http-errors')
 const express = require('express')
 const morgan = require('morgan')
 const path = require('path')
-const winston = require('winston')
+const { logger } = require('../../lib/logger')
 const database = require('../../lib/database')
 const api = require('../../lib/api')
 const { readFile } = require('../../lib/fs')
 const { addEndpoint } = require('./middleware/add-endpoint')
 
-const logger = winston.createLogger({
-  level: process.env['LOG_LEVEL'] || 'warn',
-  transports: [new winston.transports.Console()],
-})
-
 /**
  * @typedef {import('express').Request} Request
  * @typedef {import('express').Response} Response

src/lambdas/api/app.js

@@ -9,7 +9,7 @@
 const { z } = require('zod')
 const serverless = require('serverless-http')
 const { Lambda } = require('aws-sdk')
-const winston = require('winston')
+const { logger } = require('../../lib/logger')
 const { app } = require('./app')
 /*eslint-disable */ /* no-unused-vars */
 const {
@@ -21,11 +21,6 @@ const {
 } = require('./types')
 /*eslint-enable */
 
-const logger = winston.createLogger({
-  level: process.env['LOG_LEVEL'] || 'warn',
-  transports: [new winston.transports.Console()],
-})
-
 /**
  * @typedef {import('aws-lambda').APIGatewayProxyEvent} APIGatewayProxyEvent
  * @typedef {import('aws-lambda').APIGatewayProxyResult} APIGatewayProxyResult
@@ -63,7 +58,7 @@ const logZodParseError = (data, error) => {
     errorObj = { data, error }
   }
 
-  logger.error(JSON.stringify(errorObj, undefined, 2))
+  logger.error('zod parsing error: %j', errorObj)
 }
 
 /**
@@ -106,7 +101,7 @@ const invokePreHook = async (lambda, preHook, payload) => {
   }
 
   if ('errorType' in hookResult) {
-    logger.error('Pre-hook failed:', hookResult.trace.join('\n'))
+    logger.error('Pre-hook failed:', hookResult)
     return internalServerError
   }
 
@@ -152,7 +147,7 @@ const invokePostHook = async (lambda, postHook, payload) => {
   }
 
   if ('errorType' in hookResult) {
-    logger.error('Post hook failed:', hookResult.trace.join('\n'))
+    logger.error('Post hook failed:', hookResult)
     return internalServerError
   }
 

src/lambdas/api/index.js

@@ -3,6 +3,9 @@ import { app } from './app'
 
 const logger = winston.createLogger({
   level: process.env['LOG_LEVEL'] || 'warn',
+  format: winston.format.combine(
+    winston.format.splat(), winston.format.errors({ stack: true }), winston.format.json()
+  ),
   transports: [new winston.transports.Console()],
 })
 

src/lambdas/api/local.ts

@@ -1,14 +1,9 @@
 const { default: got } = require('got')
-const winston = require('winston')
 const dbClient = require('../../lib/databaseClient.js')
 const stream = require('../../lib/databaseStream.js')
 const ingest = require('../../lib/ingest.js')
 const s3Utils = require('../../lib/s3-utils')
-
-const logger = winston.createLogger({
-  level: process.env['LOG_LEVEL'] || 'warn',
-  transports: [new winston.transports.Console()],
-})
+const { logger } = require('../../lib/logger')
 
 const isSqsEvent = (event) => 'Records' in event
 
@@ -54,7 +49,7 @@ const stacItemsFromSqsEvent = async (event) => {
 }
 
 module.exports.handler = async function handler(event, _context) {
-  logger.debug(`Event: ${JSON.stringify(event, undefined, 2)}`)
+  logger.debug('Event: %j', event)
 
   if (event.create_indices) {
     await dbClient.createIndex('collections')
@@ -66,7 +61,7 @@ module.exports.handler = async function handler(event, _context) {
 
   try {
     await ingest.ingestItems(stacItems, stream)
-    logger.debug(`Ingested ${stacItems.length} Items: ${JSON.stringify(stacItems)}`)
+    logger.debug('Ingested %d items: %j', stacItems.length, stacItems)
   } catch (error) {
     logger.error(error)
     throw (error)

src/lambdas/ingest/index.js

@@ -1,12 +1,7 @@
-const winston = require('winston')
-
-const logger = winston.createLogger({
-  level: process.env['LOG_LEVEL'] || 'warn',
-  transports: [new winston.transports.Console()],
-})
+const { logger } = require('../../lib/logger')
 
 module.exports.handler = async function handler(event, _context) {
-  logger.debug(`Event: ${JSON.stringify(event, undefined, 2)}`)
+  logger.debug('Event: %j', event)
 
   const result = { ...event }
 

src/lambdas/post-hook/index.js

@@ -1,12 +1,7 @@
-const winston = require('winston')
-
-const logger = winston.createLogger({
-  level: process.env['LOG_LEVEL'] || 'warn',
-  transports: [new winston.transports.Console()],
-})
+const { logger } = require('../../lib/logger')
 
 module.exports.handler = async function handler(event, _context) {
-  logger.debug(`Event: ${JSON.stringify(event, undefined, 2)}`)
+  logger.debug('Event: %j', event)
 
   const authTokenValue = process.env['PRE_HOOK_AUTH_TOKEN']
   const authTokenTxnValue = process.env['PRE_HOOK_AUTH_TOKEN_TXN']