Merge pull request #643 from US-EPA-CAMD/fix/#6620-v2-statement-timeout

Add Additional database connection Settings #6620

Author: mark-hayward-erg

manifest-vars.beta.yml

@@ -2,4 +2,13 @@ instances: 2
 environment: beta
 host: api-easey-beta.app.cloud.gov
 apiHost: api.epa.gov/easey/beta
-matsImportBucket: cg-4e77a460-aab1-4070-a67c-9debdc58a516
+matsImportBucket: cg-4e77a460-aab1-4070-a67c-9debdc58a516
+maxConnectionPool: 15
+idleTimeout: 30000
+connectionTimeout: 10000
+acquireConnectionFromPoolTimeout: 15000
+statementTimeout: 300000
+idleInTransactionSessionTimeout: 300000
+maxUsesBeforeRecreatingConnection: 500
+sqlLogging: "error"
+maxQueryExecutionTime: 30000

manifest-vars.perf.yml

@@ -2,4 +2,13 @@ instances: 2
 environment: performance
 host: api-easey-perf.app.cloud.gov
 apiHost: api.epa.gov/easey/perf
-matsImportBucket: cg-313e2894-003b-4eda-88ca-ce57b954a57d
+matsImportBucket: cg-313e2894-003b-4eda-88ca-ce57b954a57d
+maxConnectionPool: 15
+idleTimeout: 30000
+connectionTimeout: 10000
+acquireConnectionFromPoolTimeout: 15000
+statementTimeout: 300000
+idleInTransactionSessionTimeout: 300000
+maxUsesBeforeRecreatingConnection: 500
+sqlLogging: "error"
+maxQueryExecutionTime: 30000

manifest-vars.prod.yml

@@ -2,4 +2,13 @@ instances: 2
 environment: production
 host: api-easey.app.cloud.gov
 apiHost: api.epa.gov/easey
-matsImportBucket: 
+matsImportBucket:
+maxConnectionPool: 15
+idleTimeout: 30000
+connectionTimeout: 10000
+acquireConnectionFromPoolTimeout: 15000
+statementTimeout: 300000
+idleInTransactionSessionTimeout: 300000
+maxUsesBeforeRecreatingConnection: 500
+sqlLogging: "error"
+maxQueryExecutionTime: 30000

manifest-vars.staging.yml

@@ -2,4 +2,13 @@ instances: 2
 environment: staging
 host: api-easey-stg.app.cloud.gov
 apiHost: api.epa.gov/easey/staging
-matsImportBucket: 
+matsImportBucket:
+maxConnectionPool: 5
+idleTimeout: 5000
+connectionTimeout: 5000
+acquireConnectionFromPoolTimeout: 3000
+statementTimeout: 200000
+idleInTransactionSessionTimeout: 60000
+maxUsesBeforeRecreatingConnection: 500
+sqlLogging: "error"
+maxQueryExecutionTime: 5000

manifest-vars.test.yml

@@ -2,4 +2,13 @@ instances: 1
 environment: testing
 host: api-easey-tst.app.cloud.gov
 apiHost: api.epa.gov/easey/test
-matsImportBucket: cg-4f56c44b-64ff-45e7-b346-87ee77ca1dad
+matsImportBucket: cg-4f56c44b-64ff-45e7-b346-87ee77ca1dad
+maxConnectionPool: 5
+idleTimeout: 5000
+connectionTimeout: 5000
+acquireConnectionFromPoolTimeout: 3000
+statementTimeout: 200000
+idleInTransactionSessionTimeout: 60000
+maxUsesBeforeRecreatingConnection: 500
+sqlLogging: "error"
+maxQueryExecutionTime: 5000

manifest-vars.yml

@@ -13,3 +13,12 @@ apiHost: api.epa.gov/easey/dev
 dbSvc: camd-pg-db
 awsRegion: us-gov-west-1
 matsImportBucket: cg-a5287c70-6f5f-4b41-acd4-a82bbb633f55
+maxConnectionPool: 15
+idleTimeout: 30000
+connectionTimeout: 10000
+acquireConnectionFromPoolTimeout: 15000
+statementTimeout: 300000
+idleInTransactionSessionTimeout: 300000
+maxUsesBeforeRecreatingConnection: 500
+sqlLogging: "error"
+maxQueryExecutionTime: 30000

manifest.yml

@@ -26,6 +26,15 @@ applications:
       EASEY_API_GATEWAY_HOST: ((apiHost))
       EASEY_AUTH_API: https://((apiHost))/auth-mgmt
       TZ: America/New_York
+      EASEY_DB_MAX_CONNECTION_POOL: ((maxConnectionPool))
+      EASEY_DB_IDLE_TIMEOUT: ((idleTimeout))
+      EASEY_DB_CONNECTION_TIMEOUT: ((connectionTimeout))
+      EASEY_DB_IDLE_CONNECTION_TIMEOUT: ((acquireConnectionFromPoolTimeout))
+      EASEY_DB_STATEMENT_TIMEOUT: ((statementTimeout))
+      EASEY_DB_IDLE_TRANS_SESSION_TIMEOUT: ((idleInTransactionSessionTimeout))
+      EASEY_DB_MAX_USES_BEFORE_CONN_RECREATE: ((maxUsesBeforeRecreatingConnection))
+      EASEY_DB_SQL_LOGGING: ((sqlLogging))
+      EASEY_DB_MAX_QUERY_EXECUTION_TIMEOUT: ((maxQueryExecutionTime))
     routes:
       - route: ((host))/((path))
     services:

src/config/app.config.ts

@@ -110,4 +110,14 @@ export default registerAs('app', () => ({
   matsImportBucketSecretAccessKey: getConfigValue(
     'EASEY_MATS_BULK_FILES_IMPORT_AWS_SECRET_ACCESS_KEY',
   ),
+
+  maxConnectionPool: getConfigValueNumber('EASEY_DB_MAX_CONNECTION_POOL',15),
+  idleTimeout: getConfigValueNumber( 'EASEY_DB_IDLE_TIMEOUT', 30000, ),
+  connectionTimeout: getConfigValueNumber('EASEY_DB_CONNECTION_TIMEOUT',10000),
+  acquireConnectionFromPoolTimeout: getConfigValueNumber('EASEY_DB_IDLE_CONNECTION_TIMEOUT',15000),
+  statementTimeout: getConfigValueNumber('EASEY_DB_STATEMENT_TIMEOUT',300000),
+  idleInTransactionSessionTimeout: getConfigValueNumber('EASEY_DB_IDLE_TRANS_SESSION_TIMEOUT',300000),
+  sqlLogging: getConfigValue('EASEY_DB_SQL_LOGGING', "error"),
+  maxQueryExecutionTime: getConfigValueNumber('EASEY_DB_MAX_QUERY_EXECUTION_TIMEOUT',30000),
+  maxUsesBeforeRecreatingConnection: getConfigValueNumber('EASEY_DB_MAX_USES_BEFORE_CONN_RECREATE',500),
 }));

src/config/typeorm.config.ts

@@ -1,3 +1,5 @@
+import { LoggerOptions } from 'typeorm';
+
 require('dotenv').config();
 import { TlsOptions } from 'tls';
 import { readFileSync } from 'fs';
@@ -24,6 +26,12 @@ export class TypeOrmConfigService implements TypeOrmOptionsFactory {
   }
 
   createTypeOrmOptions(): TypeOrmModuleOptions {
+    // Values are: true | false | 'all' | 'query', 'error', 'schema', 'warn', 'info', 'log'
+    const rawLogging = this.configService.get<string>('app.sqlLogging');
+    const sqlLogging: LoggerOptions = rawLogging === 'false'
+      ? false
+      : rawLogging.split(',').map(level => level.trim()) as LoggerOptions;
+
     return {
       type: 'postgres',
       applicationName: this.configService.get<string>('app.name'),
@@ -35,6 +43,21 @@ export class TypeOrmConfigService implements TypeOrmOptionsFactory {
       entities: [__dirname + '/../**/*.entity.{js,ts}'],
       synchronize: false,
       ssl: this.tlsOptions,
+
+      // Database specific (Postgres) settings.
+      extra: {
+        max: this.configService.get<number>('app.maxConnectionPool'),                                 // Max connections in pool
+        idleTimeoutMillis: this.configService.get<number>('app.idleTimeout'),                         // Close idle connections
+        connectionTimeoutMillis: this.configService.get<number>('app.connectionTimeout'),             // Maximum time (ms) to wait for a new connection before timing out.
+        acquireTimeoutMillis: this.configService.get<number>('app.acquireConnectionFromPoolTimeout'), // Fail if a connection is not acquired from the pool within timeframe
+        statement_timeout: this.configService.get<number>('app.statementTimeout'),                    // Terminates queries that exceed the timeout (in ms).
+        idle_in_transaction_session_timeout: this.configService.get<number>('app.idleInTransactionSessionTimeout'), // Terminates idle transactions after the specified time (in ms).
+        maxUses: this.configService.get<number>('app.maxUsesBeforeRecreatingConnection'), //Recreate connections after 'n' uses
+      },
+      logging: sqlLogging,
+      // Logs queries exceeding this limit (does not terminate, 'statement_timeout' terminates them).
+      maxQueryExecutionTime: this.configService.get<number>('app.maxQueryExecutionTime'),
+
     };
   }
 }