Merge 03998e4 into 4b7c2fe

TreeGateway · Mar 23, 2018 · 7f05bc9 · 7f05bc9
2 parents 4b7c2fe + 03998e4
commit 7f05bc9
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 24 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -57,7 +57,6 @@
     "bcryptjs": "^2.4.3",
     "body-parser": "^1.18.2",
     "bson": "^2.0.0",
-    "chai": "^4.1.2",
     "chalk": "^2.3.2",
     "cluster": "^0.7.7",
     "compare-versions": "^3.1.0",
@@ -142,6 +141,7 @@
     "@types/winston": "0.0.28",
     "@types/xml2js": "^0.4.0",
     "@types/yamljs": "^0.2.30",
+    "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "copyfiles": "^1.2.0",
     "coveralls": "^2.13.3",

diff --git a/src/config/api.ts b/src/config/api.ts
@@ -137,9 +137,9 @@ export interface ApiConfig {
      */
     errorHandler?: MiddlewareConfig;
     /**
-     * Disable all stats recording for this API
+     * Disable all request log recording for this API
      */
-    disableStats?: boolean;
+    disableAnalytics?: boolean;
     /**
      * Allows you to control when to parse the request body. Just enable it if you need to access the ```request.body```
      * inside a proxy middleware, like a ```filter``` or ```interceptor```. You can inform the expected
@@ -207,7 +207,7 @@ export let apiConfigValidatorSchema = Joi.object().keys({
     circuitBreaker: Joi.alternatives([Joi.array().items(apiCircuitBreakerConfigValidatorSchema), apiCircuitBreakerConfigValidatorSchema]),
     cors: Joi.alternatives([Joi.array().items(apiCorsConfigSchema), apiCorsConfigSchema]),
     description: Joi.string(),
-    disableStats: Joi.boolean(),
+    disableAnalytics: Joi.boolean(),
     errorHandler: middlewareConfigValidatorSchema,
     filter: Joi.alternatives([Joi.array().items(apiFilterSchema), apiFilterSchema]),
     group: Joi.alternatives([Joi.array().items(groupValidatorSchema), groupValidatorSchema]),

diff --git a/src/config/gateway.ts b/src/config/gateway.ts
@@ -119,10 +119,6 @@ export interface GatewayConfig {
      * Configure features globally, to be imported by api configureations
      */
     config?: ApiFeaturesConfig;
-    /**
-     * Disable all stats recording for the gateway
-     */
-    disableStats?: boolean;
     /**
      * Inform how request analytics should be stored by the gateway
      */
@@ -133,10 +129,14 @@ export interface GatewayConfig {
  * Inform how request analytics should be stored by the gateway
  */
 export interface RequestAnalyticsConfig {
+    /**
+     * Enable log recording for the gateway requests
+     */
+    enabled?: boolean;
     /**
      * The logger middleware
      */
-    logger: MiddlewareConfig;
+    logger?: MiddlewareConfig;
 }
 
 /**
@@ -179,7 +179,8 @@ const apiFeaturesConfigSchema = Joi.object().keys({
 });
 
 export const requestAnalyticsConfigSchema = Joi.object().keys({
-    logger: middlewareConfigValidatorSchema.required()
+    enabled: Joi.boolean(),
+    logger: middlewareConfigValidatorSchema
 });
 
 export const gatewayConfigValidatorSchema = Joi.object().keys({
@@ -190,7 +191,6 @@ export const gatewayConfigValidatorSchema = Joi.object().keys({
     cors: corsConfigSchema,
     disableApiIdValidation: Joi.boolean(),
     disableCompression: Joi.boolean(),
-    disableStats: Joi.boolean(),
     errorHandler: middlewareConfigValidatorSchema,
     filter: Joi.alternatives([Joi.array().items(middlewareConfigValidatorSchema), middlewareConfigValidatorSchema]),
     healthcheck: Joi.string(),

diff --git a/src/gateway.ts b/src/gateway.ts
@@ -261,7 +261,9 @@ export class Gateway extends EventEmitter {
                 .on(ConfigEvents.CIRCUIT_CHANGED, (id: string, state: string) => this.apiPipeline.circuitChanged(id, state))
                 .subscribeEvents();
             await this.configureAdminServer();
-            this.requestLogger.initialize();
+            if (this.requestLogger.isGatewayRequestLogEnabled()) {
+                this.requestLogger.initialize();
+            }
         } catch (err) {
             this.logger.error(`Error configuring gateway server. Config File:\n${JSON.stringify(this.config.gateway)}`);
             this.logger.inspectObject(err);

diff --git a/src/pipeline/stats/request.ts b/src/pipeline/stats/request.ts
@@ -38,7 +38,11 @@ export class RequestLogger {
     }
 
     isRequestLogEnabled(api: ApiConfig): boolean {
-        return (!this.config.gateway.disableStats && !api.disableStats);
+        return (this.isGatewayRequestLogEnabled() && !api.disableAnalytics);
+    }
+
+    isGatewayRequestLogEnabled() {
+        return this.config.gateway.analytics && this.config.gateway.analytics.enabled;
     }
 
     getRequestLog(req: Request): RequestLog {
@@ -61,7 +65,7 @@ export class RequestLogger {
     }
 
     private getRequestLogMiddleware() {
-        if (this.config.gateway.analytics) {
+        if (this.config.gateway.analytics && this.config.gateway.analytics.logger) {
             return this.config.gateway.analytics.logger;
         }
         return {

diff --git a/src/utils/upgrade.ts b/src/utils/upgrade.ts
@@ -42,12 +42,15 @@ export class VersionUpgrades {
             if (pac && pac.gateway) {
                 console.info(chalk.magenta('An older configuration was found. Updating it to the newer format. '
                                                 + 'Check tree-gateway migration guide for more info.'));
-                pac.gateway = <GatewayConfig>_.omit(pac.gateway, 'statsConfig', 'monitor');
+                if (!(<any>pac.gateway)['disableStats']) {
+                    pac.gateway.analytics = { enabled: true, logger: { name: 'redis' } };
+                }
+                pac.gateway = <GatewayConfig>_.omit(pac.gateway, 'statsConfig', 'monitor', 'disableStats');
             }
             if (pac.apis) {
                 pac.apis = pac.apis.map(api => {
                     if (_.has(api, 'proxy.disableStats')) {
-                        api.disableStats = _.get(api.proxy, 'disableStats');
+                        api.disableAnalytics = _.get(api.proxy, 'disableStats');
                     }
                     if (_.has(api, 'proxy.parseReqBody')) {
                         api.parseReqBody = _.get(api.proxy, 'parseReqBody');

diff --git a/test/data/apis/benchmarkHello.json b/test/data/apis/benchmarkHello.json
@@ -14,5 +14,5 @@
         "timeout": "five seconds"
     },
     "parseReqBody": false,
-    "disableStats": true
+    "disableAnalytics": true
 }
diff --git a/test/data/tree-gateway.json b/test/data/tree-gateway.json
@@ -10,7 +10,6 @@
     },
     "gateway": {
         "underProxy": false,
-        "disableStats": true,
         "disableCompression": true,
         "protocol": {
             "http": {
@@ -73,6 +72,9 @@
                 "prettyPrint": true,
                 "outputDir": "./logs"
             }
+        },
+        "analytics": {
+            "enabled": false
         }
     } 
 }
diff --git a/tree-gateway-test.yml b/tree-gateway-test.yml
@@ -69,7 +69,8 @@ gateway:
             message: IP Filtered
             database:
                 checkInterval: 1 second
-
+    analytics:
+        enabled: true
     serviceDiscovery:
         provider:
             name: consul