Merge pull request #368 from stac-utils/pv/refactor-logging-to-use-winston

refactor logging to use winston, so log levels will actually work

Author: Phil Varner

.eslintrc.json

@@ -91,10 +91,14 @@
     "class-methods-use-this": "off",
     "no-return-await": "off",
     "no-warning-comments": "off",
-    "no-unused-vars": [
-      "error",
+    // note you must disable the base rule as it can report incorrect errors
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "warn", // or "error"
       {
-        "argsIgnorePattern": "^_"
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_"
       }
     ],
     "no-useless-escape": "off",

CHANGELOG.md

@@ -7,10 +7,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased - TBD
 
+### Fixed
+
+- Log level configuration now has an effect on log levels
+
 ### Changed
 
-- Search query and response body is now logged at level DEBUG rather than INFO
-- Ingested item body is now logged at level DEBUG rather than INFO
+- Log level must be configured with lowercase values error, warn, info, http, verbose, debug, silly instead of uppercase values (this config had no effect before)
+- Default request logging format is now "tiny" instead of "dev". Previously, the "dev" format
+  wrote color codes into CloudWatch logs, which cluttered output, as they were not used in display.
+- Search query and response body is now logged at level "debug" rather than "info"
+- Ingested item body is now logged at level "debug" rather than "info"
 
 ## [0.5.2] - 2023-01-17
 

README.md

@@ -403,7 +403,9 @@ There are some settings that should be reviewed and updated as needeed in the se
 | STAC_DESCRIPTION                 | Description of this catalog                                                                                                                                                                      | A STAC API                                                                           |
 | STAC_DOCS_URL                    | URL to documentation                                                                                                                                                                             | [https://stac-utils.github.io/stac-server](https://stac-utils.github.io/stac-server) |
 | INGEST_BATCH_SIZE                | Number of records to ingest in single batch                                                                                                                                                      | 500                                                                                  |
-| LOG_LEVEL                        | Level for logging (CRITICAL, ERROR, WARN, INFO, DEBUG)                                                                                                                                        | INFO                                                                                 |
+| LOG_LEVEL                        | Level for logging (error, warn, info, http, verbose, debug, silly)                                                                                                                               | INFO                                                                                 |
+| REQUEST_LOGGING_ENABLED                        | Express request logging enabled. String 'false' disables.                                                                                                                               | enabled                                                                                 |
+| REQUEST_LOGGING_FORMAT                        | Express request logging format to use. Any of the [Morgan predefined formats](https://github.com/expressjs/morgan#predefined-formats).                                                                                                                           | tiny                                                                                 |
 | STAC_API_URL                     | The root endpoint of this API                                                                                                                                                                    | Inferred from request                                                                |
 | ENABLE_TRANSACTIONS_EXTENSION    | Boolean specifying if the [Transaction Extension](https://github.com/radiantearth/stac-api-spec/tree/master/ogcapi-features/extensions/transaction) should be activated                          | false                                                                                |
 | STAC_API_ROOTPATH                | The path to append to URLs if this is not deployed at the server root. For example, if the server is deployed without a custom domain name, it will have the stage name (e.g., dev) in the path. | ""                                                                                   |

bin/system-tests.sh

@@ -7,6 +7,7 @@ TEST_PATTERN=${1:-test-*.[jt]s}
 export AWS_ACCESS_KEY_ID='none'
 export AWS_SECRET_ACCESS_KEY='none'
 export ENABLE_TRANSACTIONS_EXTENSION=true
+export REQUEST_LOGGING_ENABLED=false
 
 echo "Running tests"
 set +e