Merge 442f615 into 849e026

Ed-Fi-Exchange-OSS · Jan 19, 2024 · d364915 · d364915
2 parents 849e026 + 442f615
commit d364915
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 64 deletions.
diff --git a/Meadowlark-js/.env.example b/Meadowlark-js/.env.example
@@ -48,4 +48,4 @@ ALLOW__EXT_PROPERTY=true
 ALLOW_OVERPOSTING=true
 
 LOG_TO_FILE=false
-# LOG_FILE_LOCATION=c:/temp/
+# LOG_FILE_LOCATION=/PATH/
diff --git a/Meadowlark-js/docker-compose.yml b/Meadowlark-js/docker-compose.yml
@@ -45,7 +45,8 @@ services:
       POSTGRES_HOST: ${POSTGRES_HOST:-postgres}
       POSTGRES_USER: ${POSTGRES_USER:-postgres}
       POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-abcdefgh1!}
-      LOG_TO_FILE: true
+      LOG_TO_FILE: ${LOG_TO_FILE:-true}
+      LOG_FILE_LOCATION: ${LOG_FILE_LOCATION:-/var/log/}
     restart: unless-stopped
     healthcheck: &ML_HEALTH
       test: curl -s http://localhost:3000/local >/dev/null || exit 1

diff --git a/Meadowlark-js/package-lock.json b/Meadowlark-js/package-lock.json
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
@@ -103,8 +103,8 @@ To create a new key:
 | OAUTH_CLIENT_PROVIDED_TOKEN_CACHE_MAX_ENTRIES    | 1000                             | Control the size of the token cache                                                                      |
 | IS_LOCAL                                         | true                             | When true, prints plain text logs. Else prints structured JSON logs                                      |
 | LOG_LEVEL                                        | info                             | Options: error, warn, info, debug                                                                        |
-| SAVE_LOG_TO_FILE                                 | false                            | When true, save log messages to a file in addition to writing to the console                       |
-| LOG_FILE_LOCATION                                 | /var/log/                           | Location of log file if SAVE_LOG_TO_FILE is enabled                       |
+| LOG_TO_FILE                                 | false                            | When true, save log messages to a file in addition to writing to the console                       |
+| LOG_FILE_LOCATION                                 | /var/log/                           | Location of log file if LOG_TO_FILE is enabled                       |
 | ALLOW_TYPE_COERCION                              | false                            | When true, numbers send as strings (e.g. "1") will be accepted in validation                             |
 | ALLOW__EXT_PROPERTY                              | false                            | When true, a payload may contain the `_ext` property without causing a validation error                  |
 | **BEGIN_ALLOWED_SCHOOL_YEAR**                    | 1900                             | The beginning of the range of valid school years                                                         |

diff --git a/docs/design/performance-benchmarking/SETUP-PERFORMANCE-SUITE.md b/docs/design/performance-benchmarking/SETUP-PERFORMANCE-SUITE.md
@@ -19,9 +19,10 @@ Types of testing that can run with these tools:
 Steps to run against meadowlark:
 
 - Configure Meadowlark and verify that it's running.
-- Load Sample data with the Invoke-LoadGrandBend or Invoke-LoadPartialGrandBend
-  scripts (otherwise, the tests will fail without some expected descriptors and
-  education organization Ids).
+- Load Sample data with the Invoke-LoadSouthridge, which is a smaller set of the
+  Northridge data set that is required by the Suite-3-Performance-Testing (This
+  can be done with the Invoke-LoadGrandBend or Invoke-LoadPartialGrandBend
+  scripts, although some data might be missing).
 - Verify that the data has been loaded correctly through the API or from the
   database.
 - Clone the

diff --git a/docs/design/performance-benchmarking/WRITE-PERFORMANCE.md b/docs/design/performance-benchmarking/WRITE-PERFORMANCE.md
@@ -45,6 +45,11 @@ performance, Pipeclean Tests and Volume Tests.
 > to have the changes required for Meadowlark. Vinaya and/or StephenF can verify when to remove
 > this temporary note and use the `main` branch again.
 
+> [!NOTE]
+> Suite-3-Performance-Tests runs against the Northridge dataset, we have a Southridge dataset script
+> that uses a subset of the Northridge dataset. After running the performance tests, if there are
+> any errors regarding missing data, insert the data into Meadowlark and run again.
+
 - Follow steps to [setup performance suite](./SETUP-PERFORMANCE-SUITE.md).
 - Go to /src/edfi_performance_test folder and run `poetry install`.
 - Create a user in meadowlark with the role of `vendor`. Save key and secret.

diff --git a/docs/performance-testing/load-balancing-API-scale-out.md b/docs/performance-testing/load-balancing-API-scale-out.md
@@ -73,7 +73,7 @@ END_ALLOWED_SCHOOL_YEAR=2035
 ALLOW_TYPE_COERCION=true
 ALLOW__EXT_PROPERTY=true
 
-SAVE_LOG_TO_FILE=true
+LOG_TO_FILE=true
 LOG_FILE_LOCATION=c:/temp/
 ```
 

diff --git a/docs/performance-testing/mongo-connection-pooling.md b/docs/performance-testing/mongo-connection-pooling.md
@@ -82,7 +82,7 @@ END_ALLOWED_SCHOOL_YEAR=2034
 ALLOW_TYPE_COERCION=true
 ALLOW__EXT_PROPERTY=true
 
-SAVE_LOG_TO_FILE=true
+LOG_TO_FILE=true
 LOG_FILE_LOCATION=c:/temp/
 ```
 

diff --git a/docs/performance-testing/two-functionalities-of-kafka-connect-separated.md b/docs/performance-testing/two-functionalities-of-kafka-connect-separated.md
@@ -76,7 +76,7 @@ END_ALLOWED_SCHOOL_YEAR=2035
 ALLOW_TYPE_COERCION=true
 ALLOW__EXT_PROPERTY=true
 
-SAVE_LOG_TO_FILE=true
+LOG_TO_FILE=true
 LOG_FILE_LOCATION=c:/temp/
 ```
 

diff --git a/eng/deploy/azure/README.md b/eng/deploy/azure/README.md
@@ -131,7 +131,7 @@ $signingKey=$(az keyvault secret show --name "SigningKey" --vault-name "meadowla
 ### Enable Logging
 
 To save the logs to a file, for a summarized result, set the flag
-`SAVE_LOG_TO_FILE` to true, which will create a `meadowlark.log` file with the
+`LOG_TO_FILE` to true, which will create a `meadowlark.log` file with the
 logs.
 
 For a production deployment, it's recommended to send the logs to [Log